DkmStackWalkFrameAnnotation.GetAnnotationText Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetAnnotationText(DkmStackWalkFrame, DkmFrameFormatOptions, String) |
Gets formatted text associated with the annotation. This is prefixed to the frame name. Location constraint: API must be called from an IDE component (component level > 100,000). This API was introduced in Visual Studio 15 Update 8 (DkmApiVersion.VS15Update8). |
| GetAnnotationText(DkmWorkList, DkmStackWalkFrame, DkmFrameFormatOptions, DkmCompletionRoutine<DkmGetAnnotationTextAsyncResult>) |
Gets formatted text associated with the annotation. This is prefixed to the frame name. 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). This API was introduced in Visual Studio 15 Update 8 (DkmApiVersion.VS15Update8). |
GetAnnotationText(DkmStackWalkFrame, DkmFrameFormatOptions, String)
Gets formatted text associated with the annotation. This is prefixed to the frame name.
Location constraint: API must be called from an IDE component (component level > 100,000).
This API was introduced in Visual Studio 15 Update 8 (DkmApiVersion.VS15Update8).
public:
void GetAnnotationText(Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ Frame, Microsoft::VisualStudio::Debugger::CallStack::DkmFrameFormatOptions Options, [Runtime::InteropServices::Out] System::String ^ % AnnotationText);public void GetAnnotationText (Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame Frame, Microsoft.VisualStudio.Debugger.CallStack.DkmFrameFormatOptions Options, out string AnnotationText);public void GetAnnotationText (Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame Frame, Microsoft.VisualStudio.Debugger.CallStack.DkmFrameFormatOptions Options, out string? AnnotationText);member this.GetAnnotationText : Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame * Microsoft.VisualStudio.Debugger.CallStack.DkmFrameFormatOptions * string -> unitPublic Sub GetAnnotationText (Frame As DkmStackWalkFrame, Options As DkmFrameFormatOptions, ByRef AnnotationText As String)Parameters
- Frame
- DkmStackWalkFrame
[In] The frame containing the annotation.
- Options
- DkmFrameFormatOptions
[In] The options specifying the format of the frame.
- AnnotationText
- String
[Out,Optional] The annotation text.
Applies to
GetAnnotationText(DkmWorkList, DkmStackWalkFrame, DkmFrameFormatOptions, DkmCompletionRoutine<DkmGetAnnotationTextAsyncResult>)
Gets formatted text associated with the annotation. This is prefixed to the frame name.
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).
This API was introduced in Visual Studio 15 Update 8 (DkmApiVersion.VS15Update8).
public:
void GetAnnotationText(Microsoft::VisualStudio::Debugger::DkmWorkList ^ WorkList, Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ Frame, Microsoft::VisualStudio::Debugger::CallStack::DkmFrameFormatOptions Options, Microsoft::VisualStudio::Debugger::DkmCompletionRoutine<Microsoft::VisualStudio::Debugger::CallStack::DkmGetAnnotationTextAsyncResult> ^ CompletionRoutine);public void GetAnnotationText (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame Frame, Microsoft.VisualStudio.Debugger.CallStack.DkmFrameFormatOptions Options, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.CallStack.DkmGetAnnotationTextAsyncResult> CompletionRoutine);member this.GetAnnotationText : Microsoft.VisualStudio.Debugger.DkmWorkList * Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame * Microsoft.VisualStudio.Debugger.CallStack.DkmFrameFormatOptions * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.CallStack.DkmGetAnnotationTextAsyncResult> -> unitPublic Sub GetAnnotationText (WorkList As DkmWorkList, Frame As DkmStackWalkFrame, Options As DkmFrameFormatOptions, CompletionRoutine As DkmCompletionRoutine(Of DkmGetAnnotationTextAsyncResult))Parameters
- WorkList
- DkmWorkList
WorkList to append the new work item to.
- Frame
- DkmStackWalkFrame
[In] The frame containing the annotation.
- Options
- DkmFrameFormatOptions
[In] The options specifying the format of the frame.
- CompletionRoutine
- DkmCompletionRoutine<DkmGetAnnotationTextAsyncResult>
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.