IDebugSymbols3::AddSyntheticSymbol method (dbgeng.h)

Article
02/22/2024

The AddSyntheticSymbol method adds a synthetic symbol to a module in the current process.

Syntax

HRESULT AddSyntheticSymbol(
  [in]            ULONG64              Offset,
  [in]            ULONG                Size,
  [in]            PCSTR                Name,
  [in]            ULONG                Flags,
  [out, optional] PDEBUG_MODULE_AND_ID Id
);

Parameters

[in] Offset

Specifies the location in the process's virtual address space of the synthetic symbol.

[in] Size

Specifies the size in bytes of the synthetic symbol.

[in] Name

Specifies the name of the synthetic symbol.

[in] Flags

Set to DEBUG_ADDSYNTHSYM_DEFAULT.

[out, optional] Id

Receives the DEBUG_MODULE_AND_ID structure that identifies the synthetic symbol. If Id is NULL, this information is not returned.

Return value

Return code	Description
S_OK	The method was successful.

This method may also return error values. See Return Values for more details.

Remarks

The location of the synthetic symbol must not be the same as the location of another symbol.

If the module containing a synthetic symbol is reloaded - for example, by calling Reload with the Module parameter set to the name of the module - the synthetic symbol will be discarded.

For more information about synthetic symbols, see Synthetic Symbols.

Requirements

Requirement	Value
Target Platform	Desktop
Header	dbgeng.h (include Dbgeng.h)