DkmInstructionSymbol.GetSourcePosition Method

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Symbols

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Overloads

GetSourcePosition(DkmWorkList, DkmSourcePositionFlags, DkmInspectionSession, DkmCompletionRoutine<DkmGetSourcePositionAsyncResult>)

Returns the source file position (ex: example.cs, line 12) of this instruction symbol. If this instruction symbol is not associated with a source file then null is returned (S_FALSE return code in native). This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine. Location constraint: API must be called from an IDE component (component level > 100,000).

GetSourcePosition(DkmSourcePositionFlags, DkmInspectionSession, Boolean)

Returns the source file position (ex: example.cs, line 12) of this instruction symbol. If this instruction symbol is not associated with a source file then null is returned (S_FALSE return code in native). Location constraint: API must be called from an IDE component (component level > 100,000).

GetSourcePosition(DkmWorkList, DkmSourcePositionFlags, DkmInspectionSession, DkmCompletionRoutine<DkmGetSourcePositionAsyncResult>)

Returns the source file position (ex: example.cs, line 12) of this instruction symbol. If this instruction symbol is not associated with a source file then null is returned (S_FALSE return code in native).

This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.

Location constraint: API must be called from an IDE component (component level > 100,000).

public:
 void GetSourcePosition(Microsoft::VisualStudio::Debugger::DkmWorkList ^ WorkList, Microsoft::VisualStudio::Debugger::Symbols::DkmSourcePositionFlags Flags, Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionSession ^ InspectionSession, Microsoft::VisualStudio::Debugger::DkmCompletionRoutine<Microsoft::VisualStudio::Debugger::Symbols::DkmGetSourcePositionAsyncResult> ^ CompletionRoutine);

public void GetSourcePosition (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, Microsoft.VisualStudio.Debugger.Symbols.DkmSourcePositionFlags Flags, Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession? InspectionSession, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Symbols.DkmGetSourcePositionAsyncResult> CompletionRoutine);

member this.GetSourcePosition : Microsoft.VisualStudio.Debugger.DkmWorkList * Microsoft.VisualStudio.Debugger.Symbols.DkmSourcePositionFlags * Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Symbols.DkmGetSourcePositionAsyncResult> -> unit

Public Sub GetSourcePosition (WorkList As DkmWorkList, Flags As DkmSourcePositionFlags, InspectionSession As DkmInspectionSession, CompletionRoutine As DkmCompletionRoutine(Of DkmGetSourcePositionAsyncResult))

Parameters

WorkList

DkmWorkList

WorkList to append the new work item to.

Flags

DkmSourcePositionFlags

[In] Flags which affect the behavior of 'GetSourcePosition'.

InspectionSession

DkmInspectionSession

[In,Optional] A reference object describing the current inspection session. Common usage is for symbol providers to cache lookups using its data container.

CompletionRoutine

DkmCompletionRoutine<DkmGetSourcePositionAsyncResult>

Routine to fire when the request is complete. If the request is successfully appended to the work list, this will always fire (including when the operation is canceled). This will never fire if appending the work item fails.

GetSourcePosition(DkmSourcePositionFlags, DkmInspectionSession, Boolean)

Returns the source file position (ex: example.cs, line 12) of this instruction symbol. If this instruction symbol is not associated with a source file then null is returned (S_FALSE return code in native).

Location constraint: API must be called from an IDE component (component level > 100,000).

public:
 Microsoft::VisualStudio::Debugger::Symbols::DkmSourcePosition ^ GetSourcePosition(Microsoft::VisualStudio::Debugger::Symbols::DkmSourcePositionFlags Flags, Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionSession ^ InspectionSession, [Runtime::InteropServices::Out] bool % StartOfLine);

public Microsoft.VisualStudio.Debugger.Symbols.DkmSourcePosition? GetSourcePosition (Microsoft.VisualStudio.Debugger.Symbols.DkmSourcePositionFlags Flags, Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession? InspectionSession, out bool StartOfLine);

member this.GetSourcePosition : Microsoft.VisualStudio.Debugger.Symbols.DkmSourcePositionFlags * Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession * bool -> Microsoft.VisualStudio.Debugger.Symbols.DkmSourcePosition

Public Function GetSourcePosition (Flags As DkmSourcePositionFlags, InspectionSession As DkmInspectionSession, ByRef StartOfLine As Boolean) As DkmSourcePosition

Parameters

Flags

DkmSourcePositionFlags

[In] Flags which affect the behavior of 'GetSourcePosition'.

InspectionSession

DkmInspectionSession

[In,Optional] A reference object describing the current inspection session. Common usage is for symbol providers to cache lookups using its data container.

StartOfLine

Boolean

[Out] True if this address is the first address in the line's range. False otherwise.

Returns

DkmSourcePosition

[Out,Optional] Source code position which corresponds to a code element. The could represent a location which has been extracted from a symbol (PDB) file, or it could be the location of a breakpoint in the IDE.