DkmSuccessEvaluationResult.Create 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
| Create(DkmInspectionContext, DkmStackWalkFrame, String, String, DkmEvaluationResultFlags, String, String, String, DkmEvaluationResultCategory, DkmEvaluationResultAccessType, DkmEvaluationResultStorageType, DkmEvaluationResultTypeModifierFlags, DkmDataAddress, ReadOnlyCollection<DkmCustomUIVisualizerInfo>, ReadOnlyCollection<DkmModuleInstance>, DkmDataItem) |
Create a new DkmSuccessEvaluationResult object instance. |
| Create(DkmInspectionContext, DkmStackWalkFrame, String, String, DkmEvaluationResultFlags, String, String, String, DkmEvaluationResultCategory, DkmEvaluationResultAccessType, DkmEvaluationResultStorageType, DkmEvaluationResultTypeModifierFlags, DkmDataAddress, ReadOnlyCollection<DkmCustomUIVisualizerInfo>, ReadOnlyCollection<DkmModuleInstance>, String, DkmDataItem) |
Create a new DkmSuccessEvaluationResult object instance. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM). |
Create(DkmInspectionContext, DkmStackWalkFrame, String, String, DkmEvaluationResultFlags, String, String, String, DkmEvaluationResultCategory, DkmEvaluationResultAccessType, DkmEvaluationResultStorageType, DkmEvaluationResultTypeModifierFlags, DkmDataAddress, ReadOnlyCollection<DkmCustomUIVisualizerInfo>, ReadOnlyCollection<DkmModuleInstance>, DkmDataItem)
Create a new DkmSuccessEvaluationResult object instance.
public:
static Microsoft::VisualStudio::Debugger::Evaluation::DkmSuccessEvaluationResult ^ Create(Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionContext ^ InspectionContext, Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ StackFrame, System::String ^ Name, System::String ^ FullName, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultFlags Flags, System::String ^ Value, System::String ^ EditableValue, System::String ^ Type, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultCategory Category, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultAccessType Access, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultStorageType StorageType, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultTypeModifierFlags TypeModifierFlags, Microsoft::VisualStudio::Debugger::Evaluation::DkmDataAddress ^ Address, System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::VisualStudio::Debugger::Evaluation::DkmCustomUIVisualizerInfo ^> ^ CustomUIVisualizers, System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::VisualStudio::Debugger::DkmModuleInstance ^> ^ ExternalModules, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);public static Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult Create (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext InspectionContext, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame StackFrame, string Name, string FullName, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultFlags Flags, string Value, string EditableValue, string Type, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultCategory Category, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultAccessType Access, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultStorageType StorageType, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultTypeModifierFlags TypeModifierFlags, Microsoft.VisualStudio.Debugger.Evaluation.DkmDataAddress Address, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Evaluation.DkmCustomUIVisualizerInfo> CustomUIVisualizers, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.DkmModuleInstance> ExternalModules, Microsoft.VisualStudio.Debugger.DkmDataItem DataItem);public static Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult Create (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext InspectionContext, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame StackFrame, string Name, string? FullName, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultFlags Flags, string? Value, string? EditableValue, string? Type, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultCategory Category, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultAccessType Access, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultStorageType StorageType, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultTypeModifierFlags TypeModifierFlags, Microsoft.VisualStudio.Debugger.Evaluation.DkmDataAddress? Address, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Evaluation.DkmCustomUIVisualizerInfo>? CustomUIVisualizers, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.DkmModuleInstance>? ExternalModules, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);static member Create : Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext * Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame * string * string * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultFlags * string * string * string * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultCategory * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultAccessType * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultStorageType * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultTypeModifierFlags * Microsoft.VisualStudio.Debugger.Evaluation.DkmDataAddress * System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Evaluation.DkmCustomUIVisualizerInfo> * System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.DkmModuleInstance> * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResultPublic Shared Function Create (InspectionContext As DkmInspectionContext, StackFrame As DkmStackWalkFrame, Name As String, FullName As String, Flags As DkmEvaluationResultFlags, Value As String, EditableValue As String, Type As String, Category As DkmEvaluationResultCategory, Access As DkmEvaluationResultAccessType, StorageType As DkmEvaluationResultStorageType, TypeModifierFlags As DkmEvaluationResultTypeModifierFlags, Address As DkmDataAddress, CustomUIVisualizers As ReadOnlyCollection(Of DkmCustomUIVisualizerInfo), ExternalModules As ReadOnlyCollection(Of DkmModuleInstance), DataItem As DkmDataItem) As DkmSuccessEvaluationResultParameters
- 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.
- Flags
- DkmEvaluationResultFlags
[In] Flags which indicate attributes of an expression evaluation result.
- Value
- String
[In,Optional] String that describes the value.
- EditableValue
- String
[In,Optional] If the value is writable, specifies the default string to be used when you double-click on the value to edit it. The EE should be able to parse and evaluate this string and get back the current evaluation result. If the value is read-only, the editable value is ignored and should be null.
- Type
- String
[In,Optional] A string that describes the type of the value.
- Category
- DkmEvaluationResultCategory
[In] The category (ex: Data, Method, etc) of this evaluation result.
[In] The access control level (public, private, etc) of the evaluation result.
- StorageType
- DkmEvaluationResultStorageType
[In] The storage type (ex: static) of the evaluation result.
- TypeModifierFlags
- DkmEvaluationResultTypeModifierFlags
[In] Type modifier flags (ex: const) of the evaluation result.
- Address
- DkmDataAddress
[In,Optional] If the result is an address (i.e. the address flag is set in Flags), specifies the location of the backing value. This is used when the evaluation result is used as the input to the memory window or disassembly window. If it is an instruction address then it must have the CPUInstruction address set.
- CustomUIVisualizers
- ReadOnlyCollection<DkmCustomUIVisualizerInfo>
[In,Optional] A list of custom viewers for this object.
- ExternalModules
- ReadOnlyCollection<DkmModuleInstance>
[In,Optional] If available, a list of external modules, not including the current module, that are used for the inspection of the object. Loading symbols for as many modules in this list as possible will enhance the display of the object.
- DataItem
- DkmDataItem
[In,Optional] Data object to add to the new DkmSuccessEvaluationResult instance. Pass 'null' in the case that the caller doesn't need to add a data item.
Returns
[Out] Result of this method call.
Applies to
Create(DkmInspectionContext, DkmStackWalkFrame, String, String, DkmEvaluationResultFlags, String, String, String, DkmEvaluationResultCategory, DkmEvaluationResultAccessType, DkmEvaluationResultStorageType, DkmEvaluationResultTypeModifierFlags, DkmDataAddress, ReadOnlyCollection<DkmCustomUIVisualizerInfo>, ReadOnlyCollection<DkmModuleInstance>, String, DkmDataItem)
Create a new DkmSuccessEvaluationResult object instance.
This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
public:
static Microsoft::VisualStudio::Debugger::Evaluation::DkmSuccessEvaluationResult ^ Create(Microsoft::VisualStudio::Debugger::Evaluation::DkmInspectionContext ^ InspectionContext, Microsoft::VisualStudio::Debugger::CallStack::DkmStackWalkFrame ^ StackFrame, System::String ^ Name, System::String ^ FullName, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultFlags Flags, System::String ^ Value, System::String ^ EditableValue, System::String ^ Type, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultCategory Category, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultAccessType Access, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultStorageType StorageType, Microsoft::VisualStudio::Debugger::Evaluation::DkmEvaluationResultTypeModifierFlags TypeModifierFlags, Microsoft::VisualStudio::Debugger::Evaluation::DkmDataAddress ^ Address, System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::VisualStudio::Debugger::Evaluation::DkmCustomUIVisualizerInfo ^> ^ CustomUIVisualizers, System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::VisualStudio::Debugger::DkmModuleInstance ^> ^ ExternalModules, System::String ^ RefreshButtonText, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);public static Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult Create (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext InspectionContext, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame StackFrame, string Name, string FullName, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultFlags Flags, string Value, string EditableValue, string Type, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultCategory Category, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultAccessType Access, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultStorageType StorageType, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultTypeModifierFlags TypeModifierFlags, Microsoft.VisualStudio.Debugger.Evaluation.DkmDataAddress Address, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Evaluation.DkmCustomUIVisualizerInfo> CustomUIVisualizers, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.DkmModuleInstance> ExternalModules, string RefreshButtonText, Microsoft.VisualStudio.Debugger.DkmDataItem DataItem);public static Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResult Create (Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext InspectionContext, Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame StackFrame, string Name, string? FullName, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultFlags Flags, string? Value, string? EditableValue, string? Type, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultCategory Category, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultAccessType Access, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultStorageType StorageType, Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultTypeModifierFlags TypeModifierFlags, Microsoft.VisualStudio.Debugger.Evaluation.DkmDataAddress? Address, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Evaluation.DkmCustomUIVisualizerInfo>? CustomUIVisualizers, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.DkmModuleInstance>? ExternalModules, string? RefreshButtonText, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);static member Create : Microsoft.VisualStudio.Debugger.Evaluation.DkmInspectionContext * Microsoft.VisualStudio.Debugger.CallStack.DkmStackWalkFrame * string * string * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultFlags * string * string * string * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultCategory * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultAccessType * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultStorageType * Microsoft.VisualStudio.Debugger.Evaluation.DkmEvaluationResultTypeModifierFlags * Microsoft.VisualStudio.Debugger.Evaluation.DkmDataAddress * System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Evaluation.DkmCustomUIVisualizerInfo> * System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.DkmModuleInstance> * string * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Evaluation.DkmSuccessEvaluationResultPublic Shared Function Create (InspectionContext As DkmInspectionContext, StackFrame As DkmStackWalkFrame, Name As String, FullName As String, Flags As DkmEvaluationResultFlags, Value As String, EditableValue As String, Type As String, Category As DkmEvaluationResultCategory, Access As DkmEvaluationResultAccessType, StorageType As DkmEvaluationResultStorageType, TypeModifierFlags As DkmEvaluationResultTypeModifierFlags, Address As DkmDataAddress, CustomUIVisualizers As ReadOnlyCollection(Of DkmCustomUIVisualizerInfo), ExternalModules As ReadOnlyCollection(Of DkmModuleInstance), RefreshButtonText As String, DataItem As DkmDataItem) As DkmSuccessEvaluationResultParameters
- 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.
- Flags
- DkmEvaluationResultFlags
[In] Flags which indicate attributes of an expression evaluation result.
- Value
- String
[In,Optional] String that describes the value.
- EditableValue
- String
[In,Optional] If the value is writable, specifies the default string to be used when you double-click on the value to edit it. The EE should be able to parse and evaluate this string and get back the current evaluation result. If the value is read-only, the editable value is ignored and should be null.
- Type
- String
[In,Optional] A string that describes the type of the value.
- Category
- DkmEvaluationResultCategory
[In] The category (ex: Data, Method, etc) of this evaluation result.
[In] The access control level (public, private, etc) of the evaluation result.
- StorageType
- DkmEvaluationResultStorageType
[In] The storage type (ex: static) of the evaluation result.
- TypeModifierFlags
- DkmEvaluationResultTypeModifierFlags
[In] Type modifier flags (ex: const) of the evaluation result.
- Address
- DkmDataAddress
[In,Optional] If the result is an address (i.e. the address flag is set in Flags), specifies the location of the backing value. This is used when the evaluation result is used as the input to the memory window or disassembly window. If it is an instruction address then it must have the CPUInstruction address set.
- CustomUIVisualizers
- ReadOnlyCollection<DkmCustomUIVisualizerInfo>
[In,Optional] A list of custom viewers for this object.
- ExternalModules
- ReadOnlyCollection<DkmModuleInstance>
[In,Optional] If available, a list of external modules, not including the current module, that are used for the inspection of the object. Loading symbols for as many modules in this list as possible will enhance the display of the object.
- RefreshButtonText
- String
[In,Optional] When DkmEvaluationResultFlags::CanEvaluateNow is set, specifies the text to display as a tooltip when the user hovers over the refresh button. If this value is null, a default message will be used.
- DataItem
- DkmDataItem
[In,Optional] Data object to add to the new DkmSuccessEvaluationResult instance. Pass 'null' in the case that the caller doesn't need to add a data item.
Returns
[Out] Result of this method call.