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

#include <CrashDescription.h>

+ Inheritance diagram for FCrashContext:

Public Member Functions

 FCrashContext (const FString &CrashContextFilepath)
 
 FCrashContext (const FString &CrashContextFilepath, const TCHAR *Buffer)
 
- Public Member Functions inherited from FPrimaryCrashProperties
bool HasProcessedData () const
 
void UpdateIDs ()
 
void SendPreUploadAnalytics ()
 
void SendPostUploadAnalytics (double Duration, bool bResult, int32 ResponseCode, uint32 PayloadSize, uint32 ReportCount)
 
void Save ()
 

Additional Inherited Members

- Static Public Member Functions inherited from FPrimaryCrashProperties
static void Set (FPrimaryCrashProperties *NewInstance)
 
static FPrimaryCrashProperties * Get ()
 
static bool IsValid ()
 
static void Shutdown ()
 
- Public Attributes inherited from FPrimaryCrashProperties
ECrashDescVersions CrashVersion
 
ECrashDumpMode CrashDumpMode
 
FString CrashGUID
 
FString GameName
 
FString ExecutableName
 
FString EngineMode
 
FString DeploymentName
 
FCrashProperty EngineModeEx
 
FCrashProperty PlatformFullName
 
FEngineVersion EngineVersion
 
FCrashProperty CommandLine
 
FString BaseDir
 
FString AppDefaultLocale
 
FCrashProperty UserName
 
FCrashProperty LoginId
 
FCrashProperty EpicAccountId
 
FCrashProperty GameSessionID
 
FString PCallStackHash
 
int32 CrashSignal
 
int32 NumMinidumpFramesToIgnore
 
FCrashProperty CallStack
 
FCrashProperty PCallStack
 
FCrashProperty PCallStackHashProperty
 
FCrashProperty SourceContext
 
FCrashProperty Modules
 
FCrashProperty UserDescription
 
FCrashProperty UserActivityHint
 
FCrashProperty ErrorMessage
 
FCrashProperty FullCrashDumpLocation
 
FCrashProperty TimeOfCrash
 
FCrashProperty bAllowToBeContacted
 
FCrashProperty CrashReporterMessage
 
FCrashProperty PlatformCallbackResult
 
FCrashProperty CrashReportClientVersion
 
bool bHasMiniDumpFile
 
bool bHasLogFile
 
bool bHasPrimaryData
 
FString RestartCommandLine
 
bool bIsEnsure
 
FString CrashType
 
FCrashProperty CPUBrand
 
FCrashPropertyXmlNode Threads
 
FCrashPropertyXmlNode PlatformPropertiesExtras
 
bool bIsOOM
 
bool bLowMemoryWarning
 
bool bInBackground
 
bool bIsRequestingExit
 
uint32 CrashScreenshotWidth = 0
 
uint32 CrashScreenshotHeight = 0
 
- Protected Member Functions inherited from FPrimaryCrashProperties
 FPrimaryCrashProperties ()
 
 ~FPrimaryCrashProperties ()
 
void ReadXML (const FString &CrashContextFilepath, const TCHAR *Buffer=nullptr)
 
void SetCrashGUID (const FString &Filepath)
 
template<typename Type >
void GetCrashProperty (Type &out_ReadValue, const FString &MainCategory, const FString &SecondCategory) const
 
template<typename Type >
void SetCrashProperty (const FString &MainCategory, const FString &SecondCategory, const Type &Value)
 
void SetCrashProperty (const FString &MainCategory, const FString &SecondCategory, const FString &NewValue)
 
void SetCrashProperty (const FString &MainCategory, const FString &SecondCategory, const FXmlNode *NewNode)
 
FString EncodeArrayStringAsXMLString (const TArray< FString > &ArrayString) const
 
void MakeCrashEventAttributes (TArray< FAnalyticsEventAttribute > &OutCrashAttributes)
 
- Protected Attributes inherited from FPrimaryCrashProperties
FXmlFile * XmlFile
 
FString XmlFilepath
 
- Static Protected Attributes inherited from FPrimaryCrashProperties
static FPrimaryCrashProperties * Singleton = nullptr
 

Detailed Description

Describes a unified crash, should be used by all platforms. Based on FGenericCrashContext, reads all saved properties, accessed by looking into read XML. Still lacks some of the properties, they will be added later. Must contain the same properties as ...\CrashReportServer\CrashReportCommon\CrashDescription.cs. Contains all usable information about the crash.

Constructor & Destructor Documentation

◆ FCrashContext() [1/2]

FCrashContext::FCrashContext ( const FString &  CrashContextFilepath)
explicit

Initializes instance based on specified Crash Context filepath.

◆ FCrashContext() [2/2]

FCrashContext::FCrashContext ( const FString &  CrashContextFilepath,
const TCHAR *  Buffer 
)

Initializes an instance based on a in memory buffer.

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