Share via

IDebugSymbolProvider::GetAddressesFromContext

  • Article

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

This method maps a document context into an array of debug addresses.

Syntax

HRESULT GetAddressesFromContext( 
   IDebugDocumentContext2* pDocContext,
   BOOL                    fStatmentOnly,
   IEnumDebugAddresses**   ppEnumBegAddresses,
   IEnumDebugAddresses**   ppEnumEndAddresses
);

int GetAddressesFromContext(
   IDebugDocumentContext2  pDocContext,
   bool                    fStatmentOnly,
   out IEnumDebugAddresses ppEnumBegAddresses,
   out IEnumDebugAddresses ppEnumEndAddresses
);

Parameters

pDocContext
[in] The document context.

fStatmentOnly
[in] If TRUE, limits the debug addresses to a single statement.

ppEnumBegAddresses
[out] Returns an enumerator for the starting debug addresses associated with this statement or line.

ppEnumEndAddresses
[out] Returns an IEnumDebugAddresses enumerator for the ending debug addresses associated with this statement or line.

Return Value

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

Remarks

A document context typically indicates a range of source lines. This method provides the starting and ending debug addresses associated with these lines. Some languages allow statements that span multiple lines, or lines that contains more than one statement. This method provides a flag to limit the debug addresses to a single statement.

It is possible for a single statement to have multiple debug addresses, as in the case of templates.

See also