SymAddSymbol Function

Adds a virtual symbol to the specified module.

BOOL WINAPI SymAddSymbol(
  __in          HANDLE hProcess,
  __in          ULONG64 BaseOfDll,
  __in          PCTSTR Name,
  __in          DWORD64 Address,
  __in          DWORD Size,
  __in          DWORD Flags
);

Parameters

hProcess

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

BaseOfDll

The base address of the module.

Name

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

Address

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

Size

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

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

Redistributable	Requires DbgHelp.dll 6.0 or later.
Header	Declared in Dbghelp.h.
Library	Use Dbghelp.lib.
DLL	Requires Dbghelp.dll.
Unicode	Implemented as SymAddSymbolW (Unicode) and SymAddSymbol (ANSI).

See Also

DbgHelp FunctionsSymDeleteSymbol

Send comments about this topic to Microsoft

Build date: 9/25/2007