1. Epic GamesDeveloper
  3. FPrimaryCrashProperties

FPrimaryCrashProperties

Primary crash properties required by the crash report system.

API > API/Runtime > API/Runtime/CrashReportCore

Primary crash properties required by the crash report system.

   
Name FPrimaryCrashProperties
Type struct
Header File /Engine/Source/Runtime/CrashReportCore/Public/CrashDescription.h
Include Path #include "CrashDescription.h"

Syntax

struct FPrimaryCrashProperties

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FPrimaryCrashProperties()

 Default constructor. CrashDescription.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FPrimaryCrashProperties()

 Destructor. CrashDescription.h  

Constants

Name Type Remarks Include Path
Singleton FPrimaryCrashProperties * Global instance. CrashDescription.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AppDefaultLocale FString The language ID the application that crashed. CrashDescription.h  
bAllowToBeContacted FCrashProperty Whether the user allowed us to be contacted. CrashDescription.h  
BaseDir FString The base directory where the app was running. @BaseDir varchar(512)    

FPlatformProcess::BaseDir() | CrashDescription.h | |

bHasLogFile bool Whether this crash has a log file. @HasLogFile bit CrashDescription.h  
bHasMiniDumpFile bool Whether this crash has a minidump file. @HasMiniDumpFile bit CrashDescription.h  
bHasPrimaryData bool Whether this crash contains primary usable data. CrashDescription.h  
bInBackground bool Whether we were in the background when the crash happened CrashDescription.h  
bIsEnsure bool Whether the report comes from a non-fatal event such as an ensure CrashDescription.h  
bIsOOM bool Whether it was an OOM or not CrashDescription.h  
bIsRequestingExit bool Whether we crashed during shutdown CrashDescription.h  
bLowMemoryWarning bool Whether we got a low memory warning or not CrashDescription.h  
CallStack FCrashProperty An array of FStrings representing the callstack of the crash. @RawCallStack varchar(MAX) CrashDescription.h  
CommandLine FCrashProperty The command line of the application that crashed. @CommandLine varchar(512)    

FCommandLine::Get() | CrashDescription.h | |

CPUBrand FCrashProperty The cpu brand of the device, e.g. Intel, iPhone6, etc. CrashDescription.h  
CrashDumpMode ECrashDumpMode Crash dump mode. CrashDescription.h  
CrashGUID FString An unique report name that this crash belongs to. Folder name. CrashDescription.h  
CrashReportClientVersion FCrashProperty CRC sets this to the current version of the software. CrashDescription.h  
CrashReporterMessage FCrashProperty Rich text string (should be localized by the crashing application) that will be displayed in the main CRC dialog Can be empty and the CRC's default text will be shown. CrashDescription.h  
CrashScreenshotHeight uint32   CrashDescription.h  
CrashScreenshotWidth uint32 Width and height of the crash screenshot, if present CrashDescription.h  
CrashSignal int32 The signal that was raised to enter the crash handler CrashDescription.h  
CrashType FString The type of crash being reported, e.g. Assert, Ensure, Hang CrashDescription.h  
CrashVersion ECrashDescVersions Version. CrashDescription.h  
DeploymentName FString Deployment (also known as "EpicApp"), e.g. DevPlaytest, PublicTest, Live @DeploymentName varchar(64) CrashDescription.h  
EngineMode FString The mode the game was in e.g. editor. @EngineMode varchar(64)    

FPlatformMisc::GetEngineMode() | CrashDescription.h | |

EngineModeEx FCrashProperty EngineModeEx e.g. Unset, Dirty, Vanilla @DeploymentName varchar(64) CrashDescription.h  
EngineVersion FEngineVersion Encoded engine version. CrashDescription.h  
EpicAccountId FCrashProperty The Epic account ID for the user who last used the Launcher. CrashDescription.h  
ErrorMessage FCrashProperty The error message, can be assertion message, ensure message or message from the fatal error. CrashDescription.h  
ExecutableName FString The name of the exe that crashed. (AppID) @GameName varchar(64) CrashDescription.h  
FullCrashDumpLocation FCrashProperty Location of full crash dump. Displayed in the crash report frontend. CrashDescription.h  
GameName FString The name of the game that crashed. (AppID) @GameName varchar(64)    

FApp::GetProjectName() | CrashDescription.h | |

GameSessionID FCrashProperty The last game session id set by the application. CrashDescription.h  
LoginId FCrashProperty The unique ID used to identify the machine the crash occurred on. CrashDescription.h  
Modules FCrashProperty An array of module's name used by the game that crashed. CrashDescription.h  
NumMinidumpFramesToIgnore int32 Specifies the number of stack frames in the callstack to ignore when symbolicating from a minidump. CrashDescription.h  
PCallStack FCrashProperty An array of FStrings representing the portable callstack of the crash. CrashDescription.h  
PCallStackHash FString A hash representing a unique id for a portable callstack. CrashDescription.h  
PCallStackHashProperty FCrashProperty The hash of PCallStack CrashDescription.h  
PlatformCallbackResult FCrashProperty Platform-specific UE Core value (integer). CrashDescription.h  
PlatformFullName FCrashProperty The platform that crashed e.g. Win64. @PlatformName varchar(64)    

Last path of the directory | CrashDescription.h | |

PlatformPropertiesExtras FCrashPropertyXmlNode Optional additional data for platform properties CrashDescription.h  
RestartCommandLine FString Copy of CommandLine that isn't anonymized so it can be used to restart the process CrashDescription.h  
SourceContext FCrashProperty An array of FStrings showing the source code around the crash. @SourceContext varchar(max) CrashDescription.h  
Threads FCrashPropertyXmlNode Thread contexts, XML elements containing info specific to an active thread, e.g. callstacks CrashDescription.h  
TimeOfCrash FCrashProperty The UTC time the crash occurred. CrashDescription.h  
UserActivityHint FCrashProperty An FString representing the user activity, if known, when the error occurred. CrashDescription.h  
UserDescription FCrashProperty An array of FStrings representing the user description of the crash. @Description varchar(512) CrashDescription.h  
UserName FCrashProperty The name of the user that caused this crash. CrashDescription.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool HasProcessedData()

 Whether this crash contains callstack, error message and source context thus it means that crash is complete. CrashDescription.h  

void Save()

 Saves the data. CrashDescription.h  

void SendPostUploadAnalytics ( double Duration,
bool bResult,
int32 ResponseCode,
uint32 PayloadSize,
uint32 ReportCount
)

 Sends this crash for analytics (after upload) with additional stats about the upload. CrashDescription.h  

void SendPreUploadAnalytics()

 Sends this crash for analytics (before upload). CrashDescription.h  

void UpdateIDs()

 Updates following properties: UserName, LoginID and EpicAccountID. CrashDescription.h  

Protected

Name Remarks Include Path Unreal Specifiers

FString EncodeArrayStringAsXMLString ( const TArray< FString >& ArrayString
) const

 Encodes multi line property to be saved as single line. CrashDescription.h  

void GetCrashProperty ( Type& out_ReadValue,
const FString& MainCategory,
const FString& SecondCategory
) const

 Gets a crash property from the XML file. CrashDescription.h  

void MakeCrashEventAttributes ( TArray< FAnalyticsEventAttribute >& OutCrashAttributes
)

   CrashDescription.h  

void ReadXML ( const FString& CrashContextFilepath,
const TCHAR* Buffer
)

 Reads previously set XML file. CrashDescription.h  

void SetCrashGUID ( const FString& Filepath
)

 Sets the CrasgGUID based on the report's path. CrashDescription.h  

void SetCrashProperty ( const FString& MainCategory,
const FString& SecondCategory,
const Type& Value
)

 Sets a crash property to a new value. CrashDescription.h  

void SetCrashProperty ( const FString& MainCategory,
const FString& SecondCategory,
const FString& NewValue
)

 Sets a crash property to a new value. CrashDescription.h  

void SetCrashProperty ( const FString& MainCategory,
const FString& SecondCategory,
const FXmlNode* NewNode
)

 Sets a crash property to a new value. CrashDescription.h  

Static

Name Remarks Include Path Unreal Specifiers

static FPrimaryCrashProperties * Get()

   CrashDescription.h  

static bool IsValid()

   CrashDescription.h  

static void Set ( FPrimaryCrashProperties* NewInstance
)

 Sets new instance as the global. CrashDescription.h  

static void Shutdown()

 Shutdowns the global instance. CrashDescription.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page