1. Epic GamesDeveloper
  3. FPrimaryCrashProperties

FPrimaryCrashProperties

Primary crash properties required by the crash report system.

API > API/Runtime > API/Runtime/CrashReportCore

Inheritance Hierarchy

References

   
Module CrashReportCore
Header /Engine/Source/Runtime/CrashReportCore/Public/CrashDescription.h
Include #include "CrashDescription.h"

Syntax

struct FPrimaryCrashProperties

Remarks

Primary crash properties required by the crash report system.

Variables

  Type Name Description
Public variable FString AppDefaultLocale The language ID the application that crashed.
Public variable FCrashProperty bAllowToBeContacted Whether the user allowed us to be contacted.
Public variable FString BaseDir The base directory where the app was running. @BaseDir varchar(512)

FPlatformProcess::BaseDir() |

Public variable bool bHasLogFile Whether this crash has a log file. @HasLogFile bit
Public variable bool bHasMiniDumpFile Whether this crash has a minidump file. @HasMiniDumpFile bit
Public variable bool bHasPrimaryData Whether this crash contains primary usable data.
Public variable bool bInBackground Whether we were in the background when the crash happened
Public variable bool bIsEnsure Whether the report comes from a non-fatal event such as an ensure
Public variable bool bIsOOM Whether it was an OOM or not
Public variable bool bIsRequestingExit Whether we crashed during shutdown
Public variable bool bLowMemoryWarning Whether we got a low memory warning or not
Public variable FCrashProperty CallStack An array of FStrings representing the callstack of the crash. @RawCallStack varchar(MAX)
Public variable FCrashProperty CommandLine The command line of the application that crashed.
Public variable FCrashProperty CPUBrand The cpu brand of the device, e.g. Intel, iPhone6, etc.
Public variable ECrashDumpMode CrashDumpMode Crash dump mode.
Public variable FString CrashGUID An unique report name that this crash belongs to. Folder name.
Public variable FCrashProperty CrashReportClientVersion CRC sets this to the current version of the software.
Public variable FCrashProperty CrashReporterMessage 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.
Public variable int32 CrashSignal The signal that was raised to enter the crash handler
Public variable FString CrashType The type of crash being reported, e.g. Assert, Ensure, Hang
Public variable ECrashDescVersions CrashVersion Version.
Public variable FString DeploymentName Deployment (also known as "EpicApp"), e.g. DevPlaytest, PublicTest, Live @DeploymentName varchar(64)
Public variable FString EngineMode The mode the game was in e.g. editor. @EngineMode varchar(64)

FPlatformMisc::GetEngineMode() |

Public variable FCrashProperty EngineModeEx EngineModeEx e.g. Unset, Dirty, Vanilla @DeploymentName varchar(64)
Public variable FEngineVersion EngineVersion Encoded engine version.
Public variable FCrashProperty EpicAccountId The Epic account ID for the user who last used the Launcher.
Public variable FCrashProperty ErrorMessage The error message, can be assertion message, ensure message or message from the fatal error.
Public variable FString ExecutableName The name of the exe that crashed. (AppID) @GameName varchar(64)
Public variable FCrashProperty FullCrashDumpLocation Location of full crash dump. Displayed in the crash report frontend.
Public variable FString GameName The name of the game that crashed.
Public variable FCrashProperty GameSessionID The last game session id set by the application.
Public variable FCrashProperty LoginId The unique ID used to identify the machine the crash occurred on.
Public variable FCrashProperty Modules An array of module's name used by the game that crashed.
Public variable int32 NumMinidumpFramesToIgnore Specifies the number of stack frames in the callstack to ignore when symbolicating from a minidump.
Public variable FCrashProperty PCallStack An array of FStrings representing the portable callstack of the crash.
Public variable FString PCallStackHash A hash representing a unique id for a portable callstack.
Public variable FCrashProperty PCallStackHashProperty The hash of PCallStack
Public variable FCrashProperty PlatformCallbackResult Platform-specific UE Core value (integer).
Public variable FCrashProperty PlatformFullName The platform that crashed e.g. Win64. @PlatformName varchar(64)

Last path of the directory |

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

Constructors

  Type Name Description
Protected function   Default constructor.

Destructors

  Type Name Description
Protected function   Destructor.

Functions

  Type Name Description
Protected function Const FString

EncodeArrayStringAsXMLString ( const TArray< FString >& ArrayString
)

 Encodes multi line property to be saved as single line.
Public function Static FPrimaryCrashProperties *

Get ()

  
Protected function Const void

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

 Gets a crash property from the XML file.
Public function Const bool Whether this crash contains callstack, error message and source context thus it means that crash is complete.
Public function Static bool

IsValid ()

  
Protected function void  
Protected function void

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

 Reads previously set XML file.
Public function void

Save ()

 Saves the data.
Public function 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.
Public function void Sends this crash for analytics (before upload).
Public function Static void

Set ( FPrimaryCrashProperties* NewInstance
)

 Sets new instance as the global.
Protected function void

SetCrashGUID ( const FString& Filepath
)

 Sets the CrasgGUID based on the report's path.
Protected function void

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

 Sets a crash property to a new value.
Protected function void

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

 Sets a crash property to a new value.
Protected function void

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

 Sets a crash property to a new value.
Public function Static void Shutdowns the global instance.
Public function void Updates following properties: UserName, LoginID and EpicAccountID.

Constants

Name Description
Singleton Global instance.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page