Skip to content

Commit a8617ea

Browse files
Merge pull request #3344 from pieandcakes/patch-2
Update idebugcodecontext2-getdocumentcontext.md
2 parents 9d4c733 + a6d18a1 commit a8617ea

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/extensibility/debugger/reference/idebugcodecontext2-getdocumentcontext.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,14 @@ int GetDocumentContext( 
3535

3636
## Parameters
3737
`ppSrcCxt`\
38-
[out] Returns the [IDebugDocumentContext2](../../../extensibility/debugger/reference/idebugdocumentcontext2.md) object that corresponds to the code context.
38+
[out] Returns the [IDebugDocumentContext2](../../../extensibility/debugger/reference/idebugdocumentcontext2.md) object that corresponds to the code context. If `S_OK` is returned, ths should be non-`null`.
3939

4040
## Return Value
41-
If successful, returns `S_OK`; otherwise, returns an error code.
41+
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.
4242

4343
## Remarks
4444
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.
4545

4646
## See also
4747
- [IDebugCodeContext2](../../../extensibility/debugger/reference/idebugcodecontext2.md)
48-
- [IDebugDocumentContext2](../../../extensibility/debugger/reference/idebugdocumentcontext2.md)
48+
- [IDebugDocumentContext2](../../../extensibility/debugger/reference/idebugdocumentcontext2.md)

0 commit comments

Comments
 (0)