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 > FGenericPlatformStackWalk

Light Theme

Dark Theme

FGenericPlatformStackWalk

Generic implementation for most platforms

Windows

MacOS

Linux

Inheritance Hierarchy

FGenericPlatformStackWalk

	FHololensPlatformStackWalk
	FUnixPlatformStackWalk

References

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

Syntax

struct FGenericPlatformStackWalk

Remarks

Generic implementation for most platforms

Functions

	Name	Description
uint32	CaptureStackBackTrace ( uint64* BackTrace, uint32 MaxDepth, void* Context )	Capture a stack backtrace and optionally use the passed in exception pointers.
uint32	CaptureThreadStackBackTrace ( uint64 ThreadId, uint64* BackTrace, uint32 MaxDepth )	Capture a stack backtrace for a specific thread.
int32	GetProcessModuleCount()	Returns the number of modules loaded by the currently running process.
int32	GetProcessModuleSignatures ( FStackWalkModuleInfo* ModuleSi..., const int32 ModuleSignaturesSize )	Gets the signature for every module loaded by the currently running process.
TArray< FPro...	GetStack ( int32 IgnoreCount, int32 MaxDepth, void* Context )	Walks the stack and updates the Stack array with the symbol information for each line in the stack.
TMap< FName,...	GetSymbolMetaData()	Gets the meta-data associated with all symbols of this target.
void	Init()	Initializes options related to stack walking from ini, i.e. how detailed the stack walking should be, performance settings etc.
bool	InitStackWalking()	Initializes stack traversal and symbol.
bool	InitStackWalkingForProcess ( const FProcHandle& Process )	Like InitStackWalking but initializes stack walking for another process.
bool	ProgramCounterToHumanReadableString ( int32 CurrentCallDepth, uint64 ProgramCounter, ANSICHAR* HumanReadableString, SIZE_T HumanReadableStringSize, FGenericCrashContext* Context )	Converts the passed in program counter address to a human readable string and appends it to the passed in one.
void	ProgramCounterToSymbolInfo ( uint64 ProgramCounter, FProgramCounterSymbolInfo& out_Sym... )	Converts the passed in program counter address to a symbol info struct, filling in module and filename, line number and displacement.
void	ProgramCounterToSymbolInfoEx ( uint64 ProgramCounter, FProgramCounterSymbolInfoEx& out_S... )	Same as above, but can be used with external applications since it doesn't re-initialize the active process.
void	StackWalkAndDump ( ANSICHAR* HumanReadableString, SIZE_T HumanReadableStringSize, int32 IgnoreCount, void* Context )	Walks the stack and appends the human readable string to the passed in one.
void	StackWalkAndDumpEx ( ANSICHAR* HumanReadableString, SIZE_T HumanReadableStringSize, int32 IgnoreCount, uint32 Flags, void* Context )	Walks the stack and appends the human readable string to the passed in one.
bool	SymbolInfoToHumanReadableString ( const FProgramCounterSymbolInfo& S..., ANSICHAR* HumanReadableString, SIZE_T HumanReadableStringSize )	Converts the passed in symbol information to a human readable string and appends it to the passed in one.
bool	SymbolInfoToHumanReadableStringEx ( const FProgramCounterSymbolInfoEx&..., FString& out_HumanReadableString )	Same as above, but can be used with external applications.
void	ThreadStackWalkAndDump ( ANSICHAR* HumanReadableString, SIZE_T HumanReadableStringSize, int32 IgnoreCount, uint32 ThreadId )	Walks the stack for the specified thread and appends the human readable string to the passed in one.
bool	WantsDetailedCallstacksInNonMonolithicBuilds()	Returns true if non-monolithic builds should produce full callstacks in the log (and load all debug symbols)

Classes

	Name	Description
	EStackWalkFlags

Typedefs

Name	Description
Base

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

Take our survey

Dismiss