DkmFailedEvaluationResult.Create Method

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Evaluation

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Overloads

Create(DkmInspectionContext, DkmStackWalkFrame, String, String, String, DkmEvaluationResultFlags, DkmDataItem)	Create a new DkmFailedEvaluationResult object instance.
Create(DkmInspectionContext, DkmStackWalkFrame, String, String, String, DkmEvaluationResultFlags, String, DkmDataItem)	Create a new DkmFailedEvaluationResult object instance. This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).
Create(DkmInspectionContext, DkmStackWalkFrame, String, String, String, DkmEvaluationResultFlags, String, DkmEvaluationResultCategory, DkmDataItem)	Create a new DkmFailedEvaluationResult object instance. This API was introduced in Visual Studio 14 Update 2 (DkmApiVersion.VS14Update2).

Create(DkmInspectionContext, DkmStackWalkFrame, String, String, String, DkmEvaluationResultFlags, DkmDataItem)

Create a new DkmFailedEvaluationResult object instance.

public:
 static Microsoft::VisualStudio::Debugger::Evaluation::DkmFailedEvaluationResult ^ Create(Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionContext ^ InspectionContext, Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ StackFrame, System::String ^ Name, System::String ^ FullName, System::String ^ ErrorMessage, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultFlags Flags, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Evaluation.DkmFailedEvaluationResult Create (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext InspectionContext, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame StackFrame, string Name, string? FullName, string ErrorMessage, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultFlags Flags, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);

static member Create : Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext * Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame * string * string * string * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultFlags * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Evaluation.DkmFailedEvaluationResult

Public Shared Function Create (InspectionContext As DkmInspectionContext, StackFrame As DkmStackWalkFrame, Name As String, FullName As String, ErrorMessage As String, Flags As DkmEvaluationResultFlags, DataItem As DkmDataItem) As DkmFailedEvaluationResult

Parameters

InspectionContext

DkmInspectionContext

[In] Inspection context used to create this evaluation result.

StackFrame

DkmStackWalkFrame

[In] The stack frame this expression result was created on.

Name

String

[In] The name of the expression this result applies to.

FullName

String

[In,Optional] The full name of the expression this result applies to. This value is used to allow child elements to be added to the watch window (Add Watch from the context menu), and to refresh parts of the evaluation tree. As an example of how FullName differs from name, the name of the 0th element of an array in C++ is '[0]' while the full name would by 'myArrayVariable[0]'. For Visual Studio 14 and later it's possible to calculate the full name later if needed. To do this, the expression evaluator should create the DkmEvaluationResult with a null full name and implement IDkmFullNameProvider. Concord will then call IDkmFullNameProvider.CalculateFullName to get the full name when needed in the UI.

ErrorMessage

String

[In] Specifies the error message to display to the user.

Flags

DkmEvaluationResultFlags

[In] Flags which indicate attributes of an expression evaluation result.

DataItem

DkmDataItem

[In,Optional] Data object to add to the new DkmFailedEvaluationResult instance. Pass 'null' in the case that the caller doesn't need to add a data item.

Returns

DkmFailedEvaluationResult

[Out] Result of this method call.

Create(DkmInspectionContext, DkmStackWalkFrame, String, String, String, DkmEvaluationResultFlags, String, DkmDataItem)

Create a new DkmFailedEvaluationResult object instance.

This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).

public:
 static Microsoft::VisualStudio::Debugger::Evaluation::DkmFailedEvaluationResult ^ Create(Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionContext ^ InspectionContext, Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ StackFrame, System::String ^ Name, System::String ^ FullName, System::String ^ ErrorMessage, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultFlags Flags, System::String ^ Type, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Evaluation.DkmFailedEvaluationResult Create (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext InspectionContext, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame StackFrame, string Name, string? FullName, string ErrorMessage, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultFlags Flags, string? Type, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);

static member Create : Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext * Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame * string * string * string * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultFlags * string * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Evaluation.DkmFailedEvaluationResult

Public Shared Function Create (InspectionContext As DkmInspectionContext, StackFrame As DkmStackWalkFrame, Name As String, FullName As String, ErrorMessage As String, Flags As DkmEvaluationResultFlags, Type As String, DataItem As DkmDataItem) As DkmFailedEvaluationResult

Parameters

InspectionContext

DkmInspectionContext

[In] Inspection context used to create this evaluation result.

StackFrame

DkmStackWalkFrame

[In] The stack frame this expression result was created on.

Name

String

[In] The name of the expression this result applies to.

FullName

String

[In,Optional] The full name of the expression this result applies to. This value is used to allow child elements to be added to the watch window (Add Watch from the context menu), and to refresh parts of the evaluation tree. As an example of how FullName differs from name, the name of the 0th element of an array in C++ is '[0]' while the full name would by 'myArrayVariable[0]'. For Visual Studio 14 and later it's possible to calculate the full name later if needed. To do this, the expression evaluator should create the DkmEvaluationResult with a null full name and implement IDkmFullNameProvider. Concord will then call IDkmFullNameProvider.CalculateFullName to get the full name when needed in the UI.

ErrorMessage

String

[In] Specifies the error message to display to the user.

Flags

DkmEvaluationResultFlags

[In] Flags which indicate attributes of an expression evaluation result.

Type

String

[In,Optional] A string that describes the type of the value.

DataItem

DkmDataItem

[In,Optional] Data object to add to the new DkmFailedEvaluationResult instance. Pass 'null' in the case that the caller doesn't need to add a data item.

Returns

DkmFailedEvaluationResult

[Out] Result of this method call.

Create(DkmInspectionContext, DkmStackWalkFrame, String, String, String, DkmEvaluationResultFlags, String, DkmEvaluationResultCategory, DkmDataItem)

Create a new DkmFailedEvaluationResult object instance.

This API was introduced in Visual Studio 14 Update 2 (DkmApiVersion.VS14Update2).

public:
 static Microsoft::VisualStudio::Debugger::Evaluation::DkmFailedEvaluationResult ^ Create(Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionContext ^ InspectionContext, Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ StackFrame, System::String ^ Name, System::String ^ FullName, System::String ^ ErrorMessage, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultFlags Flags, System::String ^ Type, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultCategory Category, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Evaluation.DkmFailedEvaluationResult Create (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext InspectionContext, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame StackFrame, string Name, string? FullName, string ErrorMessage, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultFlags Flags, string? Type, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultCategory Category, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);

static member Create : Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext * Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame * string * string * string * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultFlags * string * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultCategory * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Evaluation.DkmFailedEvaluationResult

Public Shared Function Create (InspectionContext As DkmInspectionContext, StackFrame As DkmStackWalkFrame, Name As String, FullName As String, ErrorMessage As String, Flags As DkmEvaluationResultFlags, Type As String, Category As DkmEvaluationResultCategory, DataItem As DkmDataItem) As DkmFailedEvaluationResult

Parameters

InspectionContext

DkmInspectionContext

[In] Inspection context used to create this evaluation result.

StackFrame

DkmStackWalkFrame

[In] The stack frame this expression result was created on.

Name

String

[In] The name of the expression this result applies to.

FullName

String

[In,Optional] The full name of the expression this result applies to. This value is used to allow child elements to be added to the watch window (Add Watch from the context menu), and to refresh parts of the evaluation tree. As an example of how FullName differs from name, the name of the 0th element of an array in C++ is '[0]' while the full name would by 'myArrayVariable[0]'. For Visual Studio 14 and later it's possible to calculate the full name later if needed. To do this, the expression evaluator should create the DkmEvaluationResult with a null full name and implement IDkmFullNameProvider. Concord will then call IDkmFullNameProvider.CalculateFullName to get the full name when needed in the UI.

ErrorMessage

String

[In] Specifies the error message to display to the user.

Flags

DkmEvaluationResultFlags

[In] Flags which indicate attributes of an expression evaluation result.

Type

String

[In,Optional] A string that describes the type of the value.

Category

DkmEvaluationResultCategory

[In] The category (ex: Data, Method, etc) of the underlying value represented by this evaluation result. This is principally used by the debugger UI to select icons in the watch and other expression evaluation windows.

DataItem

DkmDataItem

[In,Optional] Data object to add to the new DkmFailedEvaluationResult instance. Pass 'null' in the case that the caller doesn't need to add a data item.

Returns

DkmFailedEvaluationResult

[Out] Result of this method call.