nf-dbgeng-idebugsymbols3-addsyntheticsymbol.md

UID	title	description	old-location	tech.root	ms.date	keywords	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	f1_keywords	topic_type	api_type	api_location	api_name
NF:dbgeng.IDebugSymbols3.AddSyntheticSymbol	IDebugSymbols3::AddSyntheticSymbol (dbgeng.h)	The AddSyntheticSymbol method adds a synthetic symbol to a module in the current process.	debugger\addsyntheticsymbol.htm	debugger	05/03/2018	IDebugSymbols3::AddSyntheticSymbol	AddSyntheticSymbol, AddSyntheticSymbol method [Windows Debugging], AddSyntheticSymbol method [Windows Debugging],IDebugSymbols3 interface, IDebugSymbols3 interface [Windows Debugging],AddSyntheticSymbol method, IDebugSymbols3.AddSyntheticSymbol, IDebugSymbols3::AddSyntheticSymbol, IDebugSymbols_8dcf97a7-eb9c-44aa-a2a7-1ad74cb396c1.xml, dbgeng/IDebugSymbols3::AddSyntheticSymbol, debugger.addsyntheticsymbol	dbgeng.h	Dbgeng.h	Desktop															Windows		IDebugSymbols3::AddSyntheticSymbol dbgeng/IDebugSymbols3::AddSyntheticSymbol	APIRef kbSyntax	COM	Dbgeng.h	IDebugSymbols3::AddSyntheticSymbol

IDebugSymbols3::AddSyntheticSymbol

-description

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

-parameters

-param Offset [in]

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

-param Size [in]

Specifies the size in bytes of the synthetic symbol.

-param Name [in]

Specifies the name of the synthetic symbol.

-param Flags [in]

Set to DEBUG_ADDSYNTHSYM_DEFAULT.

-param Id [out, optional]

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

-returns

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.

-see-also

AddSyntheticModule

IDebugSymbols3

RemoveSyntheticSymbol