UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FCrashReportCoreConfig Struct Reference

#include <CrashReportCoreConfig.h>

Public Member Functions

 FCrashReportCoreConfig ()
 
const FString & GetVersion () const
 
const FString & GetReceiverAddress () const
 
const FString & GetDataRouterURL () const
 
const FString & GetDataRouterUnixSocket () const
 
const FString & GetDiagnosticsFilename () const
 
bool GetAllowToBeContacted () const
 
bool GetHideAllowToBeContactedOption () const
 
bool GetSendLogFile () const
 
bool GetHideLogFilesOption () const
 
bool GetHideRestartOption () const
 
bool IsAllowedToCloseWithoutSending () const
 
bool IsAllowedToSendWithoutDetailedInfo () const
 
bool GetShowEndpointInTooltip () const
 
const FString & GetCompanyName () const
 
int GetUserCommentSizeLimit () const
 
void SetAllowToBeContacted (bool bNewValue)
 
void SetSendLogFile (bool bNewValue)
 
void ApplyProjectOverrides (const FString &ConfigFilePath)
 
void SetProjectConfigOverrides (const FConfigFile &InConfigFile)
 
FString GetFullCrashDumpLocationForBranch (const FString &BranchName) const
 
void PrintSettingsToLog () const
 

Static Public Member Functions

static FCrashReportCoreConfig & Get ()
 

Protected Member Functions

void ReadFullCrashDumpConfigurations ()
 

Protected Attributes

FString CrashReportClientVersion
 
FString CrashReportReceiverIP
 
FString DataRouterUrl
 
FString DataRouterUnixSocket
 
FString DiagnosticsFilename
 
FString SectionName
 
TArray< FFullCrashDumpEntry > FullCrashDumpConfigurations
 
bool bAllowToBeContacted
 
bool bHideAllowToBeContactedOption
 
bool bSendLogFile
 
bool bHideLogFilesOption
 
bool bHideRestartOption
 
bool bIsAllowedToCloseWithoutSending
 
bool bIsAllowedToSendWithoutDetailedInfo
 
FString CompanyName
 
bool bShowEndpointInTooltip
 
int UserCommentSizeLimit
 

Detailed Description

Holds basic configuration for the crash report client.

Constructor & Destructor Documentation

◆ FCrashReportCoreConfig()

FCrashReportCoreConfig::FCrashReportCoreConfig ( )

Initialization constructor.

Member Function Documentation

◆ ApplyProjectOverrides()

void FCrashReportCoreConfig::ApplyProjectOverrides ( const FString &  ConfigFilePath)

◆ Get()

static FCrashReportCoreConfig & FCrashReportCoreConfig::Get ( )
inlinestatic

Accesses the singleton.

◆ GetAllowToBeContacted()

bool FCrashReportCoreConfig::GetAllowToBeContacted ( ) const
inline

◆ GetCompanyName()

const FString & FCrashReportCoreConfig::GetCompanyName ( ) const
inline

◆ GetDataRouterUnixSocket()

const FString & FCrashReportCoreConfig::GetDataRouterUnixSocket ( ) const
inline

◆ GetDataRouterURL()

const FString & FCrashReportCoreConfig::GetDataRouterURL ( ) const
inline

◆ GetDiagnosticsFilename()

const FString & FCrashReportCoreConfig::GetDiagnosticsFilename ( ) const
inline

◆ GetFullCrashDumpLocationForBranch()

FString FCrashReportCoreConfig::GetFullCrashDumpLocationForBranch ( const FString &  BranchName) const
Returns
location for full crash dump for the specified branch.

◆ GetHideAllowToBeContactedOption()

bool FCrashReportCoreConfig::GetHideAllowToBeContactedOption ( ) const
inline

◆ GetHideLogFilesOption()

bool FCrashReportCoreConfig::GetHideLogFilesOption ( ) const
inline

◆ GetHideRestartOption()

bool FCrashReportCoreConfig::GetHideRestartOption ( ) const
inline

◆ GetReceiverAddress()

const FString & FCrashReportCoreConfig::GetReceiverAddress ( ) const
inline

◆ GetSendLogFile()

bool FCrashReportCoreConfig::GetSendLogFile ( ) const
inline

◆ GetShowEndpointInTooltip()

bool FCrashReportCoreConfig::GetShowEndpointInTooltip ( ) const
inline

◆ GetUserCommentSizeLimit()

int FCrashReportCoreConfig::GetUserCommentSizeLimit ( ) const
inline

◆ GetVersion()

const FString & FCrashReportCoreConfig::GetVersion ( ) const
inline

◆ IsAllowedToCloseWithoutSending()

bool FCrashReportCoreConfig::IsAllowedToCloseWithoutSending ( ) const
inline

◆ IsAllowedToSendWithoutDetailedInfo()

bool FCrashReportCoreConfig::IsAllowedToSendWithoutDetailedInfo ( ) const
inline

◆ PrintSettingsToLog()

void FCrashReportCoreConfig::PrintSettingsToLog ( ) const

Prints the current settings to the log. Call once all applicable overrides has been applied.

◆ ReadFullCrashDumpConfigurations()

void FCrashReportCoreConfig::ReadFullCrashDumpConfigurations ( )
protected

Reads FFullCrashDumpEntry config entries.

◆ SetAllowToBeContacted()

void FCrashReportCoreConfig::SetAllowToBeContacted ( bool  bNewValue)

◆ SetProjectConfigOverrides()

void FCrashReportCoreConfig::SetProjectConfigOverrides ( const FConfigFile &  InConfigFile)

Set config values that are determined by the crashing application saving a config file to the crash folder

◆ SetSendLogFile()

void FCrashReportCoreConfig::SetSendLogFile ( bool  bNewValue)

Member Data Documentation

◆ bAllowToBeContacted

bool FCrashReportCoreConfig::bAllowToBeContacted
protected

Whether the user allowed us to be contacted. If true the following properties are retrieved from the system: UserName (for non-launcher build) and EpicAccountID. Otherwise they will be empty.

◆ bHideAllowToBeContactedOption

bool FCrashReportCoreConfig::bHideAllowToBeContactedOption
protected

Whether the user is shown the option to be contacted.

◆ bHideLogFilesOption

bool FCrashReportCoreConfig::bHideLogFilesOption
protected

Whether the user is shown the option to enable/disable sending the log file.

◆ bHideRestartOption

bool FCrashReportCoreConfig::bHideRestartOption
protected

Whether the user is shown the option to restart the crashed application

◆ bIsAllowedToCloseWithoutSending

bool FCrashReportCoreConfig::bIsAllowedToCloseWithoutSending
protected

Whether the user is allowed to close the crash reporter without sending a report

◆ bIsAllowedToSendWithoutDetailedInfo

bool FCrashReportCoreConfig::bIsAllowedToSendWithoutDetailedInfo
protected

Whether the user is allowed to send the crash without providing detailed information about the crash

◆ bSendLogFile

bool FCrashReportCoreConfig::bSendLogFile
protected

Whether the user allowed us to send the log file.

◆ bShowEndpointInTooltip

bool FCrashReportCoreConfig::bShowEndpointInTooltip
protected

Whether to show the endpoint (reciever or datarouter url)

◆ CompanyName

FString FCrashReportCoreConfig::CompanyName
protected

Optional string displayed in the "allow to be contacted" text.

◆ CrashReportClientVersion

FString FCrashReportCoreConfig::CrashReportClientVersion
protected

Client version (two digit licensee built e.g. "1.0" - three digits for Epic builds e.g. "1.0.0")

◆ CrashReportReceiverIP

FString FCrashReportCoreConfig::CrashReportReceiverIP
protected

IP address of crash report receiver.

◆ DataRouterUnixSocket

FString FCrashReportCoreConfig::DataRouterUnixSocket
protected

Local Unix Socket to use for Data Router service

◆ DataRouterUrl

FString FCrashReportCoreConfig::DataRouterUrl
protected

URL of Data Router service

◆ DiagnosticsFilename

FString FCrashReportCoreConfig::DiagnosticsFilename
protected

Filename to use when saving diagnostics report, if generated locally.

◆ FullCrashDumpConfigurations

TArray<FFullCrashDumpEntry> FCrashReportCoreConfig::FullCrashDumpConfigurations
protected

Configuration used for copying full dump crashes.

◆ SectionName

FString FCrashReportCoreConfig::SectionName
protected

Section for crash report client configuration.

◆ UserCommentSizeLimit

int FCrashReportCoreConfig::UserCommentSizeLimit
protected

Size limit for the description of multi-line text

The documentation for this struct was generated from the following files: