DkmExceptionTriggerHit.Create Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Debugger.Exceptions
Assembly:
Microsoft.VisualStudio.Debugger.Engine.dll
Package:
Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Overloads

Create(DkmExceptionInformation, String, String, String, String, String, Guid)

Create a new DkmExceptionTriggerHit object instance.
Create(DkmExceptionInformation, String, String, String, String, String, Guid, ReadOnlyCollection<DkmInstructionAddress>)

Create a new DkmExceptionTriggerHit object instance.

This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).
Create(DkmExceptionInformation, String, String, String, String, String, Guid, ReadOnlyCollection<DkmInstructionAddress>, ReadOnlyCollection<DkmExceptionConditionInfo>)

Create a new DkmExceptionTriggerHit object instance.

This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).

Create(DkmExceptionInformation, String, String, String, String, String, Guid)

Create a new DkmExceptionTriggerHit object instance.

public:
 static Microsoft::VisualStudio::Debugger::Exceptions::DkmExceptionTriggerHit ^ Create(Microsoft::VisualStudio::Debugger::Exceptions::DkmExceptionInformation ^ Exception, System::String ^ Description, System::String ^ RestrictedErrorDescription, System::String ^ CapabilitySid, System::String ^ RestrictedReference, System::String ^ AdditionalInformation, Guid SourceId);
public static Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionTriggerHit Create (Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionInformation Exception, string Description, string RestrictedErrorDescription, string CapabilitySid, string RestrictedReference, string AdditionalInformation, Guid SourceId);
public static Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionTriggerHit Create (Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionInformation Exception, string Description, string? RestrictedErrorDescription, string? CapabilitySid, string? RestrictedReference, string? AdditionalInformation, Guid SourceId);
static member Create : Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionInformation * string * string * string * string * string * Guid -> Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionTriggerHit
Public Shared Function Create (Exception As DkmExceptionInformation, Description As String, RestrictedErrorDescription As String, CapabilitySid As String, RestrictedReference As String, AdditionalInformation As String, SourceId As Guid) As DkmExceptionTriggerHit

Parameters

Exception
DkmExceptionInformation

[In] Provides information about an exception which was raised in the target process. This information includes details of what exception was raised and the current stage of exception processing.

Description
String

[In] Description string for the exception. This is obtained from IDkmExceptionFormatter.GetDescription.

RestrictedErrorDescription
String

[In,Optional] Optional WinRT Restricted Description for the error, obtained from the IDkmExceptionFormatterCallback.GetRestrictedErrorInfo.

CapabilitySid
String

[In,Optional] Specifies the missing capability if there is one which resulted in a runtime exception.

RestrictedReference
String

[In,Optional] Specifies the restricted reference. This is provided instead of the RestrictedDescription and any CapabilitySid. A scenario for this is when the debuggee process is not running in same session as debugger process. Components above will need to use this to work out the restricted description and any missing capability.

AdditionalInformation
String

[In,Optional] Optional additional information about this exception. For CLR exceptions, this contains the 'Message' property from the System.Exception which was thrown. This information is obtained from IDkmExceptionFormatter.GetAdditionalInformation.

SourceId
Guid

[In] Identifies the source of an object. SourceIds are used to enable filtering in scenarios when multiple components may be creating instances of a class. For example, source ids can be used to determine if a breakpoint comes from the AD7 AL (ex: user breakpoint, or other breakpoint visible at the SDM level) instead of a breakpoint which may be created by another component (for example an internal breakpoint used for stepping).

Returns

DkmExceptionTriggerHit

[Out] Result of this method call.

Applies to

Create(DkmExceptionInformation, String, String, String, String, String, Guid, ReadOnlyCollection<DkmInstructionAddress>)

Create a new DkmExceptionTriggerHit object instance.

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

public:
 static Microsoft::VisualStudio::Debugger::Exceptions::DkmExceptionTriggerHit ^ Create(Microsoft::VisualStudio::Debugger::Exceptions::DkmExceptionInformation ^ Exception, System::String ^ Description, System::String ^ RestrictedErrorDescription, System::String ^ CapabilitySid, System::String ^ RestrictedReference, System::String ^ AdditionalInformation, Guid SourceId, System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::VisualStudio::Debugger::DkmInstructionAddress ^> ^ StackTrace);
public static Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionTriggerHit Create (Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionInformation Exception, string Description, string RestrictedErrorDescription, string CapabilitySid, string RestrictedReference, string AdditionalInformation, Guid SourceId, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.DkmInstructionAddress> StackTrace);
public static Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionTriggerHit Create (Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionInformation Exception, string Description, string? RestrictedErrorDescription, string? CapabilitySid, string? RestrictedReference, string? AdditionalInformation, Guid SourceId, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.DkmInstructionAddress>? StackTrace);
static member Create : Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionInformation * string * string * string * string * string * Guid * System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.DkmInstructionAddress> -> Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionTriggerHit
Public Shared Function Create (Exception As DkmExceptionInformation, Description As String, RestrictedErrorDescription As String, CapabilitySid As String, RestrictedReference As String, AdditionalInformation As String, SourceId As Guid, StackTrace As ReadOnlyCollection(Of DkmInstructionAddress)) As DkmExceptionTriggerHit

Parameters

Exception
DkmExceptionInformation

[In] Provides information about an exception which was raised in the target process. This information includes details of what exception was raised and the current stage of exception processing.

Description
String

[In] Description string for the exception. This is obtained from IDkmExceptionFormatter.GetDescription.

RestrictedErrorDescription
String

[In,Optional] Optional WinRT Restricted Description for the error, obtained from the IDkmExceptionFormatterCallback.GetRestrictedErrorInfo.

CapabilitySid
String

[In,Optional] Specifies the missing capability if there is one which resulted in a runtime exception.

RestrictedReference
String

[In,Optional] Specifies the restricted reference. This is provided instead of the RestrictedDescription and any CapabilitySid. A scenario for this is when the debuggee process is not running in same session as debugger process. Components above will need to use this to work out the restricted description and any missing capability.

AdditionalInformation
String

[In,Optional] Optional additional information about this exception. For CLR exceptions, this contains the 'Message' property from the System.Exception which was thrown. This information is obtained from IDkmExceptionFormatter.GetAdditionalInformation.

SourceId
Guid

[In] Identifies the source of an object. SourceIds are used to enable filtering in scenarios when multiple components may be creating instances of a class. For example, source ids can be used to determine if a breakpoint comes from the AD7 AL (ex: user breakpoint, or other breakpoint visible at the SDM level) instead of a breakpoint which may be created by another component (for example an internal breakpoint used for stepping).

StackTrace
ReadOnlyCollection<DkmInstructionAddress>

[In,Optional] The stack trace of the exception, if available.

Returns

DkmExceptionTriggerHit

[Out] Result of this method call.

Applies to

Create(DkmExceptionInformation, String, String, String, String, String, Guid, ReadOnlyCollection<DkmInstructionAddress>, ReadOnlyCollection<DkmExceptionConditionInfo>)

Create a new DkmExceptionTriggerHit object instance.

This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).

public:
 static Microsoft::VisualStudio::Debugger::Exceptions::DkmExceptionTriggerHit ^ Create(Microsoft::VisualStudio::Debugger::Exceptions::DkmExceptionInformation ^ Exception, System::String ^ Description, System::String ^ RestrictedErrorDescription, System::String ^ CapabilitySid, System::String ^ RestrictedReference, System::String ^ AdditionalInformation, Guid SourceId, System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::VisualStudio::Debugger::DkmInstructionAddress ^> ^ StackTrace, System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::VisualStudio::Debugger::Exceptions::DkmExceptionConditionInfo ^> ^ ExceptionConditionInfo);
public static Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionTriggerHit Create (Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionInformation Exception, string Description, string RestrictedErrorDescription, string CapabilitySid, string RestrictedReference, string AdditionalInformation, Guid SourceId, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.DkmInstructionAddress> StackTrace, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionConditionInfo> ExceptionConditionInfo);
public static Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionTriggerHit Create (Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionInformation Exception, string Description, string? RestrictedErrorDescription, string? CapabilitySid, string? RestrictedReference, string? AdditionalInformation, Guid SourceId, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.DkmInstructionAddress>? StackTrace, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionConditionInfo>? ExceptionConditionInfo);
static member Create : Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionInformation * string * string * string * string * string * Guid * System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.DkmInstructionAddress> * System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionConditionInfo> -> Microsoft.VisualStudio.Debugger.Exceptions.DkmExceptionTriggerHit
Public Shared Function Create (Exception As DkmExceptionInformation, Description As String, RestrictedErrorDescription As String, CapabilitySid As String, RestrictedReference As String, AdditionalInformation As String, SourceId As Guid, StackTrace As ReadOnlyCollection(Of DkmInstructionAddress), ExceptionConditionInfo As ReadOnlyCollection(Of DkmExceptionConditionInfo)) As DkmExceptionTriggerHit

Parameters

Exception
DkmExceptionInformation

[In] Provides information about an exception which was raised in the target process. This information includes details of what exception was raised and the current stage of exception processing.

Description
String

[In] Description string for the exception. This is obtained from IDkmExceptionFormatter.GetDescription.

RestrictedErrorDescription
String

[In,Optional] Optional WinRT Restricted Description for the error, obtained from the IDkmExceptionFormatterCallback.GetRestrictedErrorInfo.

CapabilitySid
String

[In,Optional] Specifies the missing capability if there is one which resulted in a runtime exception.

RestrictedReference
String

[In,Optional] Specifies the restricted reference. This is provided instead of the RestrictedDescription and any CapabilitySid. A scenario for this is when the debuggee process is not running in same session as debugger process. Components above will need to use this to work out the restricted description and any missing capability.

AdditionalInformation
String

[In,Optional] Optional additional information about this exception. For CLR exceptions, this contains the 'Message' property from the System.Exception which was thrown. This information is obtained from IDkmExceptionFormatter.GetAdditionalInformation.

SourceId
Guid

[In] Identifies the source of an object. SourceIds are used to enable filtering in scenarios when multiple components may be creating instances of a class. For example, source ids can be used to determine if a breakpoint comes from the AD7 AL (ex: user breakpoint, or other breakpoint visible at the SDM level) instead of a breakpoint which may be created by another component (for example an internal breakpoint used for stepping).

StackTrace
ReadOnlyCollection<DkmInstructionAddress>

[In,Optional] The stack trace of the exception, if available.

ExceptionConditionInfo
ReadOnlyCollection<DkmExceptionConditionInfo>

[In,Optional] Exception condition information.

Returns

DkmExceptionTriggerHit

[Out] Result of this method call.

Applies to