Share via


IDebugCanStopEvent2::GetDocumentContext

Note

This article applies to Visual Studio 2015. 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

Gets the document context that describes the location of this event.

Syntax

HRESULT GetDocumentContext (   
   IDebugDocumentContext2** ppDocCxt  
);  
int GetDocumentContext (   
   out IDebugDocumentContext2 ppDocCxt  
);  

Parameters

ppDocCxt
[out] Returns the IDebugDocumentContext2 interface that represents a position in a source file document corresponding to the current code location.

Return Value

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

Remarks

Generally, the document context can be thought of as a position in a source file.

To get the code context, which is oriented towards code instructions, call the GetCodeContext method.

See Also

IDebugCanStopEvent2
IDebugDocumentContext2
GetCodeContext