StackWalk

The StackWalk function provides a portable method for obtaining a stack trace.

BOOL StackWalk(

Parameters

MachineType

The architecture type of the machine for which the stack trace is generated. This can be one of the following values:

·IMAGE_FILE_MACHINE_I386

·IMAGE_FILE_MACHINE_R4000

·IMAGE_FILE_MACHINE_R10000

·IMAGE_FILE_MACHINE_ALPHA

·IMAGE_FILE_MACHINE_POWERPC

hProcess

The process handle for which the stack trace is generated. If the caller supplies a valid callback pointer for ReadMemoryRoutine, then this value does not have to be a valid Win32 process handle. It can be a token that is unique and consistently the same for all calls to the StackWalk function. If IMAGEHLP's symbol handler is used with StackWalk, the process handles used should be the same for the calls to each function.

hThread

The thread handle for which the stack trace is generated. If the caller supplies a valid callback pointer for ReadMemoryRoutine, then this value does not have to be a valid Win32 thread handle. It can be a token that is unique and consistently the same for all calls to the StackWalk function.

StackFrame

A pointer to a STACKFRAME structure. This structure is filled with the next frame's information, if the function call succeeds.

ContextRecord

A pointer to a CONTEXT record. This parameter is required only when MachineType is not equal to IMAGE_FILE_MACHINE_I386.

ReadMemoryRoutine

A pointer to a callback routine that provides memory read services. When the StackWalk function needs to read memory from the process's address space, this callback is used. If NULL is passed, then the Win32 ReadProcessMemory function is used. In this case, the hProcess parameter must be a valid Win32 process handle.

FunctionTableAccessRoutine

A pointer to a callback routine that provides access to the run-time function table for the process. For RISC machines, this function accesses the pdata table, while on X86 machines this function accesses the fpo table. This parameter is required because the StackWalk function does not have access to the process's run-time function table.

The symbol handler in IMAGEHLP provides functions that load and access the run-time table. If these functions are used, then SymFunctionTableAccess can be passed as a valid parameter.

GetModuleBaseRoutine

A pointer to a callback routine that provides a module base for any given virtual address. This parameter is required. The symbol handler in IMAGEHLP provides functions that load and maintain module information. If these functions are used, then SymGetModuleBase can be passed as a valid parameter.

TranslateAddress

A pointer to a callback routine that provides address translation for 16-bit addresses. Most, if not all, callers of StackWalk can safely pass NULL for this parameter.

Return Values

If the function succeeds, the return value is TRUE.

If the function fails, then the return value is FALSE. To retrieve extended error information, call GetLastError.

Remarks

The StackWalk function provides a portable method for obtaining a stack trace. This function is used by all Microsoft Win32 debuggers and tools that require stack trace facilities. Using IMAGEHLP's StackWalk function is recommended over writing your own function because of all the complexities associated with stack walking on the various Win32 platforms. In addition, the various compiler options that cause the stack to appear differently, depending on how the module is compiled, complicate the problem even more. By using this function, your application has a portable stack trace that continues to work when the compiler and operating system change.