MapDebugInformation function (dbghelp.h)

Obtains access to the debugging information for an image.

Syntax

PIMAGE_DEBUG_INFORMATION IMAGEAPI MapDebugInformation(
  [in, optional] HANDLE FileHandle,
  [in]           PCSTR  FileName,
  [in, optional] PCSTR  SymbolPath,
  [in]           ULONG  ImageBase
);

Parameters

[in, optional] FileHandle

A handle to an open executable image or NULL.

[in] FileName

The name of an executable image file or NULL.

[in, optional] SymbolPath

The path where symbol files are located. The path can be multiple paths separated by semicolons. To retrieve the symbol path, use the SymGetSearchPath function.

[in] ImageBase

The base address for the image or zero.

Return value

If the function succeeds, the return value is a pointer to an IMAGE_DEBUG_INFORMATION structure.

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

Remarks

The MapDebugInformation function is used to obtain access to an image's debugging information. The debugging information is extracted from the image or the symbol file and placed into the IMAGE_DEBUG_INFORMATION structure. This structure is allocated by the library and must be deallocated by using the UnmapDebugInformation function. The memory for the structure is not in the process's default heap, so attempts to free it with a memory deallocation routine will fail.

All DbgHelp functions, such as this one, are single threaded. Therefore, calls from more than one thread to this function will likely result in unexpected behavior or memory corruption. To avoid this, you must synchronize all concurrent calls from more than one thread to this function.

Requirements

See also

DbgHelp Functions

IMAGE_DEBUG_INFORMATION

SymGetSearchPath

UnmapDebugInformation