StackWalk - Win32 Programmer's Reference

Custom Search

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
No
Import Library
imagehlp.lib
Header File
imagehlp.h
Unicode
No
Platform Notes
Windows 95: IMAGEHLP is available as a redistributable.

StackWalk

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

BOOL StackWalk(

IN DWORD MachineType,
IN HANDLE hProcess,
IN HANDLE hThread,
IN OUT LPSTACKFRAME StackFrame,
IN OUT LPVOID ContextRecord,
IN PREAD_PROCESS_MEMORY_ROUTINE ReadMemoryRoutine,
IN PFUNCTION_TABLE_ACCESS_ROUTINE FunctionTableAccessRoutine,
IN PGET_MODULE_BASE_ROUTINE GetModuleBaseRoutine,
IN PTRANSLATE_ADDRESS_ROUTINE TranslateAddress
);

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.

Last news from Greatis Software

    Nostalgia .Net     .Net is powerful, but not all-powerful, so sometimes we need to use Win32 API for our .Net applications. It's simple enough with Platform Invoke if you have Win32 skill, but we do not always have time to dig the ancient documentation, declare the special types that are compatible with Win32, find the values of the Win32's constants and so on. Nostalgia .Net offers several simple-to-use classes, and components that will allow you to forget about the headache of Win32 and just use the power of Win32 in your application the same way as you use the native. Net classes. More »

Recommended software for developers

    Ultimate Pack     Component pack for Delphi and C++ Builder that contains runtime form designer, runtime object inspector, print suite and much more for the very special price. More »

    Form Designer .Net     Unique runtime form design solution that allows to edit any form in .Net WinForms application at runtime with full source codes for only 300 euro! More »

    Print Suite .Net     Print Suite .Net is a set of components for easy printing texts, images and grids from your WinForms applications. Full C# source codes are available More »

    Gradient Controls .Net     Gradient Controls .Net offers controls with gradient background feature. Labels, panels and so on... Full C# source codes are available More »

    Greatis iGrid     iGrid plots drawing grid right over your desktop, so you can use it everywhere, with any drawing application without any special plugins for different graphic editors. More »

All the contacts and projects

Dmitry Vasiliev (just.dmitry)

More Online Helps

Win32 Programmer's Reference
Win32 Multimedia Programmer's Reference
OLE Programmer's Reference
Microsoft Windows Pen API Programmer's Reference
Microsoft Windows Sockets 2 Reference
Microsoft Windows Telephony API (TAPI) Programmer's Reference
Unix Manual Pages

greatis just4fun network