1. Epic GamesDeveloper
  3. FGenericPlatformStackWalk

FGenericPlatformStackWalk

Generic implementation for most platforms

API > API/Runtime > API/Runtime/Core

Generic implementation for most platforms

   
Name FGenericPlatformStackWalk
Type struct
Header File /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformStackWalk.h
Include Path #include "GenericPlatform/GenericPlatformStackWalk.h"

Syntax

struct FGenericPlatformStackWalk

Derived Classes

Structs

Name Remarks
EStackWalkFlags  

Typedefs

Name Type Remarks Include Path
Base FGenericPlatformStackWalk   GenericPlatform/GenericPlatformStackWalk.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static uint32 CaptureStackBackTrace ( uint64* BackTrace,
uint32 MaxDepth,
void* Context
)

 Capture a stack backtrace and optionally use the passed in exception pointers. GenericPlatform/GenericPlatformStackWalk.h  

static uint32 CaptureThreadStackBackTrace ( uint64 ThreadId,
uint64* BackTrace,
uint32 MaxDepth,
void* Context
)

 Capture a stack backtrace for a specific thread. GenericPlatform/GenericPlatformStackWalk.h  

static void CopyVirtualPathToLocal ( char* Dest,
int32 DestCapacity,
const char* Source
)

 Converts virtual path to local and write local path to Dest. GenericPlatform/GenericPlatformStackWalk.h  

static int32 GetProcessModuleCount()

 Returns the number of modules loaded by the currently running process. GenericPlatform/GenericPlatformStackWalk.h  

static int32 GetProcessModuleSignatures ( FStackWalkModuleInfo* ModuleSignatures,
const int32 ModuleSignaturesSize
)

 Gets the signature for every module loaded by the currently running process. GenericPlatform/GenericPlatformStackWalk.h  

static TArray< FProgramCounterSymbolInfo > 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. GenericPlatform/GenericPlatformStackWalk.h  
Gets the meta-data associated with all symbols of this target. GenericPlatform/GenericPlatformStackWalk.h  

static void Init()

 Initializes options related to stack walking from ini, i.e. how detailed the stack walking should be, performance settings etc. GenericPlatform/GenericPlatformStackWalk.h  

static bool InitStackWalking ()

 Initializes stack traversal and symbol. GenericPlatform/GenericPlatformStackWalk.h  

static bool InitStackWalkingForProcess ( const FProcHandle& Process
)

 Like InitStackWalking but initializes stack walking for another process. GenericPlatform/GenericPlatformStackWalk.h  

static 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. GenericPlatform/GenericPlatformStackWalk.h  

static void ProgramCounterToSymbolInfo ( uint64 ProgramCounter,
FProgramCounterSymbolInfo& out_SymbolInfo
)

 Converts the passed in program counter address to a symbol info struct, filling in module and filename, line number and displacement. GenericPlatform/GenericPlatformStackWalk.h  

static void ProgramCounterToSymbolInfoEx ( uint64 ProgramCounter,
FProgramCounterSymbolInfoEx& out_SymbolInfo
)

 Same as above, but can be used with external applications since it doesn't re-initialize the active process. GenericPlatform/GenericPlatformStackWalk.h  

static 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. GenericPlatform/GenericPlatformStackWalk.h  

static void StackWalkAndDump ( ANSICHAR* HumanReadableString,
SIZE_T HumanReadableStringSize,
void* ProgramCounter,
void* Context
)

 Walks the stack and appends the human readable string to the passed in one. GenericPlatform/GenericPlatformStackWalk.h  

static 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. GenericPlatform/GenericPlatformStackWalk.h  

static void StackWalkAndDumpEx ( ANSICHAR* HumanReadableString,
SIZE_T HumanReadableStringSize,
void* ProgramCounter,
uint32 Flags,
void* Context
)

 Walks the stack and appends the human readable string to the passed in one. GenericPlatform/GenericPlatformStackWalk.h  

static bool SymbolInfoToHumanReadableString ( const FProgramCounterSymbolInfo& SymbolInfo,
ANSICHAR* HumanReadableString,
SIZE_T HumanReadableStringSize
)

 Converts the passed in symbol information to a human readable string and appends it to the passed in one. GenericPlatform/GenericPlatformStackWalk.h  

static bool SymbolInfoToHumanReadableStringEx ( const FProgramCounterSymbolInfoEx& SymbolInfo,
FString& out_HumanReadableString
)

 Same as above, but can be used with external applications. GenericPlatform/GenericPlatformStackWalk.h  

static 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. GenericPlatform/GenericPlatformStackWalk.h  

static bool WantsDetailedCallstacksInNonMonolithicBuilds()

 Returns true if non-monolithic builds should produce full callstacks in the log (and load all debug symbols) GenericPlatform/GenericPlatformStackWalk.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page