Edit

DbgHelp Functions

  • Article

The following are the DbgHelp functions.

General

The following are general helper functions:

EnumDirTree
ImagehlpApiVersion
ImagehlpApiVersionEx
MakeSureDirectoryPathExists
SearchTreeForFile

Debugger

The debugging service functions are the functions most suited for use by a debugger or the debugging code in an application. These functions can be used in concert with the symbol handler functions for easier use.

EnumerateLoadedModules64
EnumerateLoadedModulesEx
FindDebugInfoFile
FindDebugInfoFileEx
FindExecutableImage
FindExecutableImageEx
StackWalk64
SymSetParentWindow
UnDecorateSymbolName

Image Access

The image access functions access the data in an executable image. The functions provide high-level access to the base of images and very specific access to the most common parts of an image's data.

GetTimestampForLoadedLibrary
ImageDirectoryEntryToData
ImageDirectoryEntryToDataEx
ImageNtHeader
ImageRvaToSection
ImageRvaToVa

Symbol Handler

The symbol handler functions give applications easy and portable access to the symbolic debugging information of an image. These functions should be used exclusively to ensure access to symbolic information. This is necessary because these functions isolate the application from the symbol format.

SymAddSourceStream
SymAddSymbol
SymCleanup
SymDeleteSymbol
SymEnumerateModules64
SymEnumLines
SymEnumProcesses
SymEnumSourceFiles
SymEnumSourceLines
SymEnumSymbols
SymEnumSymbolsForAddr
SymEnumTypes
SymEnumTypesByName
SymFindDebugInfoFile
SymFindExecutableImage
SymFindFileInPath
SymFromAddr
SymFromIndex
SymFromName
SymFromToken
SymFunctionTableAccess64
SymGetFileLineOffsets64
SymGetHomeDirectory
SymGetLineFromAddr64
SymGetLineFromName64
SymGetLineNext64
SymGetLinePrev64
SymGetModuleBase64
SymGetModuleInfo64
SymGetOmaps
SymGetOptions
SymGetScope
SymGetSearchPath
SymGetSymbolFile
SymGetTypeFromName
SymGetTypeInfo
SymGetTypeInfoEx
SymInitialize
SymLoadModule64
SymLoadModuleEx
SymMatchFileName
SymMatchString
SymNext
SymPrev
SymRefreshModuleList
SymRegisterCallback64
SymRegisterFunctionEntryCallback64
SymSearch
SymSetContext
SymSetHomeDirectory
SymSetOptions
SymSetScopeFromAddr
SymSetScopeFromIndex
SymSetSearchPath
SymUnDName64
SymUnloadModule64

Symbol Server

The symbol server enables debuggers to automatically retrieve the correct symbol files without product names, releases, or build numbers. The following functions are used with the symbol server.

SymSrvDeltaName
SymSrvGetFileIndexes
SymSrvGetFileIndexInfo
SymSrvGetFileIndexString
SymSrvGetSupplement
SymSrvIsStore
SymSrvStoreFile
SymSrvStoreSupplement

User-mode Minidump Files

The minidump functions provide a way for applications to produce crashdump files that contain a useful subset of the entire process context; this is known as a minidump file. The following functions are used with minidump files.

MiniDumpCallback
MiniDumpReadDumpStream
MiniDumpWriteDump

Source Server

Source server enables a client to retrieve the exact version of the source files that were used to build an application. The following functions are used with source server.

Obsolete Functions

MapDebugInformation
SymEnumerateSymbols64
SymGetSymFromAddr64
SymGetSymFromName64
SymGetSymNext64
SymGetSymPrev64
UnMapDebugInformation