IDebugSymbols3::RemoveSyntheticSymbol method (dbgeng.h)

Article
02/22/2024

The RemoveSyntheticSymbol method removes a synthetic symbol from a module in the current process.

Syntax

HRESULT RemoveSyntheticSymbol(
  [in] PDEBUG_MODULE_AND_ID Id
);

Parameters

[in] Id

Specifies the synthetic symbol to remove. This must be the same value returned in the Id parameter of AddSyntheticSymbol. See DEBUG_MODULE_AND_ID for details about the type of this parameter.

Return value

Return code	Description
S_OK	The method was successful.
E_INVALIDARG	No synthetic symbol was found at the specified location. This is returned if a synthetic symbol at this location was previously removed or discarded.

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

Remarks

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)