Skip to content

Latest commit

 

History

History
108 lines (78 loc) · 3.85 KB

nf-dbghelp-mapdebuginformation.md

File metadata and controls

108 lines (78 loc) · 3.85 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:dbghelp.MapDebugInformation
MapDebugInformation function (dbghelp.h)
Obtains access to the debugging information for an image.
MapDebugInformation
MapDebugInformation function
_win32_mapdebuginformation
base.mapdebuginformation
dbghelp/MapDebugInformation
base\mapdebuginformation.htm
Debug
749a2a99-f6c4-4af3-aa0b-8a7bb5c690da
12/05/2018
MapDebugInformation, MapDebugInformation function, _win32_mapdebuginformation, base.mapdebuginformation, dbghelp/MapDebugInformation
dbghelp.h
Windows
Dbghelp.lib
Dbghelp.dll
Windows
DbgHelp.dll 5.1 or later
19H1
MapDebugInformation
dbghelp/MapDebugInformation
c++
APIRef
kbSyntax
DllExport
Dbghelp.dll
MapDebugInformation

MapDebugInformation function

-description

Obtains access to the debugging information for an image.

Note  This function is provided only for backward compatibility. It does not return reliable information. New applications should use the SymGetModuleInfo64 and SymLoadModule64 functions.
 

-parameters

-param FileHandle [in, optional]

A handle to an open executable image or NULL.

-param FileName [in]

The name of an executable image file or NULL.

-param SymbolPath [in, optional]

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.

-param ImageBase [in]

The base address for the image or zero.

-returns

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.

-see-also

DbgHelp Functions

IMAGE_DEBUG_INFORMATION

SymGetSearchPath

UnmapDebugInformation