SymUnloadModule function (dbghelp.h)

Article
02/22/2024

Unloads the symbol table.

Syntax

BOOL IMAGEAPI SymUnloadModule(
  [in] HANDLE hProcess,
  [in] DWORD  BaseOfDll
);

Parameters

[in] hProcess

A handle to the process that was originally passed to the SymInitialize function.

[in] BaseOfDll

The base address of the module that is to be unloaded.

Return value

If the function succeeds, the return value is TRUE.

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

Remarks

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.

This function supersedes the SymUnloadedModule function. For more information, see Updated Platform Support. SymUnloadedModule is defined as follows in Dbghelp.h.

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymUnloadModule SymUnloadModule64
#else
BOOL
IMAGEAPI
SymUnloadModule(
    __in HANDLE hProcess,
    __in DWORD BaseOfDll
    );
#endif

Examples

For an example, see Unloading a Symbol Module.

Requirements

Requirement	Value
Target Platform	Windows
Header	dbghelp.h
Library	Dbghelp.lib
DLL	Dbghelp.dll
Redistributable	DbgHelp.dll 5.1 or later