DkmClrValue.EvaluateDebuggerDisplayString 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.
Gets the string to display in the debugger UI for a CLR value given a DebuggerDisplay attribute string.
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).
This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).
public:
void EvaluateDebuggerDisplayString(Microsoft::VisualStudio::Debugger::DkmWorkList ^ WorkList, Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionContext ^ InspectionContext, Microsoft::VisualStudio::Debugger::Clr::DkmClrType ^ TargetType, System::String ^ FormatString, Microsoft::VisualStudio::Debugger::DkmCompletionRoutine<Microsoft::VisualStudio::Debugger::Evaluation::ClrCompilation::DkmEvaluateDebuggerDisplayStringAsyncResult> ^ CompletionRoutine);public void EvaluateDebuggerDisplayString (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext InspectionContext, Microsoft.VisualStudio.Debugger.Clr.DkmClrType TargetType, string FormatString, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Evaluation.ClrCompilation.DkmEvaluateDebuggerDisplayStringAsyncResult> CompletionRoutine);member this.EvaluateDebuggerDisplayString : Microsoft.VisualStudio.Debugger.DkmWorkList * Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext * Microsoft.VisualStudio.Debugger.Clr.DkmClrType * string * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Evaluation.ClrCompilation.DkmEvaluateDebuggerDisplayStringAsyncResult> -> unitPublic Sub EvaluateDebuggerDisplayString (WorkList As DkmWorkList, InspectionContext As DkmInspectionContext, TargetType As DkmClrType, FormatString As String, CompletionRoutine As DkmCompletionRoutine(Of DkmEvaluateDebuggerDisplayStringAsyncResult))Parameters
- WorkList
- DkmWorkList
WorkList to append the new work item to.
- InspectionContext
- DkmInspectionContext
[In] The inspection context for this evaluation.
- TargetType
- DkmClrType
[In] The type to use when evaluating debugger display attributes.
- FormatString
- String
[In] The format string to be evaluated by the debugger. For example "Count = {Count}".
- CompletionRoutine
- DkmCompletionRoutine<DkmEvaluateDebuggerDisplayStringAsyncResult>
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.