IDebugCodeContext2::GetDocumentContext

Gets the document context that corresponds to this code context. The document context represents a position in the source file that corresponds to the source code that generated this instruction.

Syntax

int GetDocumentContext( 
   out IDebugDocumentContext2 ppSrcCxt
);

HRESULT GetDocumentContext( 
   IDebugDocumentContext2** ppSrcCxt
);

Parameters

ppSrcCxt
[out] Returns the IDebugDocumentContext2 object that corresponds to the code context. If S_OK is returned, this should be non-null.

Return Value

If successful, returns S_OK; otherwise, returns an error code. A debug engine should return a failure code such as E_FAIL when the out parameter is null such as when the code context has no associated source position.

Remarks

Generally, the document context can be thought of as a position in a source file while the code context is a position of a code instruction in an execution stream.

See also

• IDebugCodeContext2
• IDebugDocumentContext2