IDiaSymbol::get_registerId

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Retrieves the register designator of the location when the LocationType Enumeration is set to LocIsEnregistered.

Syntax

HRESULT get_registerId ( 
   DWORD* pRetVal
);

Parameters

pRetVal

[out] Returns the register designator of the location.

Return Value

If successful, returns S_OK; otherwise, returns S_FALSE or an error code.

Note

A return value of S_FALSE means that the property is not available for the symbol.

Remarks

If the symbol is relative to a register, that is, if the symbol's LocationType Enumeration is set to LocIsRegRel, use the get_registerId method followed by a call to the IDiaSymbol::get_offset method to get the offset from the register where the symbol is located.

See also