Share via


DkmInstructionSymbol.GetUserCodeSourcePositionCallback Method

Definition

Overloads

GetUserCodeSourcePositionCallback(DkmInspectionSession)

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 or not in user code then null is returned (E_INSTRUCTION_NO_SOURCE return code).

Location constraint: API must be called from a Monitor component (component level < 100,000).

GetUserCodeSourcePositionCallback(DkmWorkList, DkmInspectionSession, DkmCompletionRoutine<DkmGetUserCodeSourcePositionCallbackAsyncResult>)

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 or not in user code then null is returned (E_INSTRUCTION_NO_SOURCE return code).

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 a Monitor component (component level < 100,000).

GetUserCodeSourcePositionCallback(DkmInspectionSession)

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 or not in user code then null is returned (E_INSTRUCTION_NO_SOURCE return code).

Location constraint: API must be called from a Monitor component (component level < 100,000).

public:
 Microsoft::VisualStudio::Debugger::Symbols::DkmSourcePosition ^ GetUserCodeSourcePositionCallback(Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionSession ^ InspectionSession);
public Microsoft.VisualStudio.Debugger.Symbols.DkmSourcePosition GetUserCodeSourcePositionCallback (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession InspectionSession);
public Microsoft.VisualStudio.Debugger.Symbols.DkmSourcePosition? GetUserCodeSourcePositionCallback (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession? InspectionSession);
member this.GetUserCodeSourcePositionCallback : Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession -> Microsoft.VisualStudio.Debugger.Symbols.DkmSourcePosition
Public Function GetUserCodeSourcePositionCallback (InspectionSession As DkmInspectionSession) As DkmSourcePosition

Parameters

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.

Returns

[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.

Applies to

GetUserCodeSourcePositionCallback(DkmWorkList, DkmInspectionSession, DkmCompletionRoutine<DkmGetUserCodeSourcePositionCallbackAsyncResult>)

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 or not in user code then null is returned (E_INSTRUCTION_NO_SOURCE return code).

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 a Monitor component (component level < 100,000).

public:
 void GetUserCodeSourcePositionCallback(Microsoft::VisualStudio::Debugger::DkmWorkList ^ WorkList, Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionSession ^ InspectionSession, Microsoft::VisualStudio::Debugger::DkmCompletionRoutine<Microsoft::VisualStudio::Debugger::Symbols::DkmGetUserCodeSourcePositionCallbackAsyncResult> ^ CompletionRoutine);
public void GetUserCodeSourcePositionCallback (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession InspectionSession, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Symbols.DkmGetUserCodeSourcePositionCallbackAsyncResult> CompletionRoutine);
public void GetUserCodeSourcePositionCallback (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession? InspectionSession, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Symbols.DkmGetUserCodeSourcePositionCallbackAsyncResult> CompletionRoutine);
member this.GetUserCodeSourcePositionCallback : Microsoft.VisualStudio.Debugger.DkmWorkList * Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionSession * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Symbols.DkmGetUserCodeSourcePositionCallbackAsyncResult> -> unit
Public Sub GetUserCodeSourcePositionCallback (WorkList As DkmWorkList, InspectionSession As DkmInspectionSession, CompletionRoutine As DkmCompletionRoutine(Of DkmGetUserCodeSourcePositionCallbackAsyncResult))

Parameters

WorkList
DkmWorkList

WorkList to append the new work item to.

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<DkmGetUserCodeSourcePositionCallbackAsyncResult>

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.

Applies to