Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > GenericPlatform > FGenericCrashContext

Light Theme

Dark Theme

FGenericCrashContext

Contains a runtime crash's properties that are common for all platforms.

Windows

MacOS

Linux

Inheritance Hierarchy

FGenericCrashContext

FUnixCrashContext

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformCrashContext.h
Include	#include "GenericPlatform/GenericPlatformCrashContext.h"

Syntax

struct FGenericCrashContext

Remarks

Contains a runtime crash's properties that are common for all platforms. This may change in the future.

Variables

		Name	Description
	TArray< FCrashS...	CallStack
	uint32	CrashedThreadId
	const TCHAR ...	ErrorMessage
	int	NumMinidumpFramesToIgnore
	FProcHandle	ProcessHandle
	TArray< FThread...	ThreadCallStacks
	ECrashContextTy...	Type

Constructors

	Name	Description
	FGenericCrashContext ( ECrashContextType InType, const TCHAR* ErrorMessage )	Default constructor.

Destructors

	Name	Description
	~FGenericCrashContext()

Functions

	Name	Description
void	AddCrashProperty ( const TCHAR* PropertyName, const Type& Value )
void	AddPlugin ( const FString& PluginDesc )	Adds a plugin descriptor string to the enabled plugins list in the crash context
void	AddPortableThreadCallStack ( uint32 ThreadId, const TCHAR* ThreadName, const uint64* StackFrames, int32 NumStackFrames )	Adds a portable callstack for a thread
void	AppendEscapedXMLString ( FString& OutBuffer, const TCHAR* Text )	Escapes and appends specified text to XML string
void	CapturePortableCallStack ( int32 NumStackFramesToIgnore, void* Context )	Generate raw call stack for crash report (image base + offset)
void	CleanupPlatformSpecificFiles()	Cleanup platform specific files - called on startup, implemented per platform
void	CopyPlatformSpecificFiles ( const TCHAR* OutputDirectory, void* Context )	Allows platform implementations to copy files to report directory.
void	CopySharedCrashContext ( FSharedCrashContext& Dst )	Initializes a shared crash context from current state. Will not set all fields in Dst.
bool	CreateCrashReportDirectory ( const TCHAR* CrashGUIDRoot, int32 CrashIndex, FString& OutCrashDirectoryAbsolute )	Attempts to create the output report directory.
void	DumpAdditionalContext ( const TCHAR* CrashFolderAbsolu... )	Collects additional crash context providers. See FAdditionalCrashContextStack.
void	DumpLog ( const FString& CrashFolderAbsolute )	Flushes the logs. In the case of in memory logs is used on this configuration, dumps them to file.
const FStrin...	GetBuffer()
const TCHAR ...	GetCallstackProperty()	Allow platform implementations to provide a callstack property.
const TCHAR ...	GetCrashConfigFilePath()	Helper to get the crash report client config filepath saved by this instance and copied to each crash report folder.
const TCHAR ...	GetCrashConfigFolder()	Helper to get the crash report client config folder used by GetCrashConfigFilePath().
FString	GetCrashGameName()	Get the Game Name of the crash
const TCHAR ...	GetCrashTypeString ( ECrashContextType Type )	Helper to get the standard string for the crash type based on crash event bool values.
TOptional< i...	GetOutOfProcessCrashReporterExitCode()	Return the out-of-process crash reporter exit code if available.
uint32	GetOutOfProcessCrashReporterProcessId()
bool	GetPlatformAllThreadContextsString ( FString& OutStr )	a stream of Thread XML elements containing info (e.g. callstack) specific to an active thread
void	GetPortableCallStack ( const uint64* StackFrames, int32 NumStackFrames, TArray< FCrashStackFrame >& OutCal... )	Gets the portable callstack to a specified stack and puts it into OutCallStack
FString	GetTempSessionContextFilePath ( uint64 ProcessID )	Get the file path to the temporary session context file that we create for the given process.
ECrashContex...	GetType()
void	GetUniqueCrashName ( TCHAR* GUIDBuffer, int32 BufferSize )
void	Initialize()	Initializes crash context related platform specific data that can be impossible to obtain after a crash.
void	InitializeFromContext ( const FSessionContext& Context, const TCHAR* EnabledPlugins, const TCHAR* EngineData, const TCHAR* GameData )	Initialized crash context, using a crash context (e.g. shared from another process).
const bool	IsFullCrashDump()
bool	IsInitalized()
bool	IsOutOfProcessCrashReporter()
void	PurgeOldCrashConfig()	Helper to clean out old files in the crash report client config folder.
void	ResetEngineData()	Clears the engine data dictionary
void	ResetGameData()	Clears the game data dictionary
void	SerializeAsXML ( const TCHAR* Filename )	Serializes crash's informations to the specified filename.
void	SerializeContentToBuffer()	Serializes all data to the buffer.
void	SerializeSessionContext ( FString& Buffer )	Serializes session context to the given buffer.
void	SetCrashedProcess ( const FProcHandle& Process )	Sets the process id to that has crashed.
void	SetCrashedThreadId ( uint32 InId )	Stores crashing thread id.
void	SetCrashTrigger ( ECrashTrigger Type )	Sets the type of crash triggered. Used to distinguish crashes caused for debugging purposes.
void	SetDeploymentName ( const FString& EpicApp )	Set the current deployment name (ie. EpicApp)
void	SetEngineData ( const FString& Key, const FString& Value )	Updates (or adds if not already present) arbitrary engine data to the crash context (will remove the key if passed an empty string)
void	SetEngineExit ( bool bIsRequestExit )	Notify the crash context exit has been requested.
void	SetGameData ( const FString& Key, const FString& Value )	Updates (or adds if not already present) arbitrary game data to the crash context (will remove the key if passed an empty string)
void	SetMemoryStats ( const FPlatformMemoryStats& Memory... )	We can't gather memory stats in crash handling function, so we gather them just before raising exception and use in crash reporting.
void	SetNumMinidumpFramesToIgnore ( int32 InNumMinidumpFramesToIgnore )	Sets the number of stack frames to ignore when symbolicating from a minidump
void	SetOutOfProcessCrashReporterExitCode ( int32 ExitCode )	Set the out of process crash reporter exit code if known.
void	SetOutOfProcessCrashReporterPid ( uint32 ProcessId )	Set whether or not the out-of-process crash reporter is running.
void	SetPortableCallStack ( const uint64* StackFrames, int32 NumStackFrames )	Sets the portable callstack to a specified stack
FString	UnescapeXMLString ( const FString& Text )	Unescapes a specified XML string, naive implementation.

Constants

Name	Description
bIsInitialized	Whether the Initialize() has been called
ConfigSectionName
CrashConfigExtension
CrashConfigFileNameA
CrashConfigFileNameW
CrashConfigPurgeDays
CrashContextExtension
CrashContextRuntimeXMLNameA
CrashContextRuntimeXMLNameW
CrashGUIDLength
CrashGUIDRootPrefix
CrashTypeAbnormalShutdown
CrashTypeAssert
CrashTypeCrash
CrashTypeEnsure
CrashTypeGPU
CrashTypeHang
EnabledPluginsTag
EngineDataTag
EngineModeExDirty
EngineModeExUnknown
EngineModeExVanilla
ExecutionGuid	A guid that identifies this particular execution. Allows multiple crash reports from the same run of the project to be tied together.
GameDataTag
NewLineTag
OutOfProcessCrashReporterExitCode	The out of process crash reporter exit code, if available.
OutOfProcessCrashReporterPid	The ID of the external process reporting crashes if the platform supports it and was configured to use it, zero otherwise (0 is a reserved system process ID, invalid for the out of process reporter).
PlatformPropertiesTag
RuntimePropertiesTag
StaticCrashContextIndex	Static counter records how many crash contexts have been constructed
UE4MinidumpName

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss