SymAddSymbol function (dbghelp.h)

Article
08/09/2022

Adds a virtual symbol to the specified module.

Syntax

BOOL IMAGEAPI SymAddSymbol(
  [in] HANDLE  hProcess,
  [in] ULONG64 BaseOfDll,
  [in] PCSTR   Name,
  [in] DWORD64 Address,
  [in] DWORD   Size,
  [in] DWORD   Flags
);

Parameters

[in] hProcess

A handle to a process. This handle must have been previously passed to the SymInitialize function.

[in] BaseOfDll

The base address of the module.

[in] Name

The name of the symbol. The maximum size of a symbol name is MAX_SYM_NAME characters.

[in] Address

The address of the symbol. This address must be within the address range of the specified module.

[in] Size

The size of the symbol, in bytes. This parameter is optional.

[in] Flags

This parameter is unused.

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.

To call the Unicode version of this function, define DBGHELP_TRANSLATE_TCHAR.

Requirements

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