DkmExceptionDetails Class

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Exceptions

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Contains details about an exception or inner exception object.

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

public ref class DkmExceptionDetails : Microsoft::VisualStudio::Debugger::DkmDataContainer, IDisposable

[System.Runtime.InteropServices.Guid("38b85e91-94f6-2dcb-12a0-e937f0e9cee9")]
public class DkmExceptionDetails : Microsoft.VisualStudio.Debugger.DkmDataContainer, IDisposable

[<System.Runtime.InteropServices.Guid("38b85e91-94f6-2dcb-12a0-e937f0e9cee9")>]
type DkmExceptionDetails = class
    inherit DkmDataContainer
    interface IDisposable

Public Class DkmExceptionDetails
Inherits DkmDataContainer
Implements IDisposable

Inheritance

Object

DkmDataContainer

DkmExceptionDetails

Attributes

GuidAttribute

Implements

IDisposable

Properties

Exception	The original exception object. This is always for the original raised exception. If this DkmExceptionDetails came from GetInnerException, this value still represents the containing exception. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
ExceptionCategory	Indicates the type of exception. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
InspectionSession	The inspection session used to track the lifetime of this instance. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
IsUnloaded	Returns true if a 'unloaded' event has been raised for this object (example: DkmThread::Unload is called) or if the object has been closed. Note that care must be used when checking this status as, without synchronization, the returned status may no longer be accurate the instruction after it is read. (Inherited from DkmDataContainer)
RuntimeInstance	The DkmRuntimeInstance class represents an execution environment which is loaded into a DkmProcess and which contains code to be debugged. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
UniqueId	Guid which uniquely identifies this exception details object. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).

Methods

Close()	Closes the exception details object and the resources associated with it. DkmExceptionDetails objects are automatically closed when their associated DkmInspectionSession object is closed. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
Create(DkmInspectionSession, DkmExceptionInformation, DkmDataItem)	Create a new DkmExceptionDetails object instance. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
GetCorException()	Get the ICorDebugValue for the exception object. Location constraint: API must be called from a Monitor component (component level < 100,000). This API was introduced in Visual Studio 15 Update 7 (DkmApiVersion.VS15Update7).
GetDataItem<T>()	Gets the instance of 'T' which has been added to this container instance. If this container does not contain a 'T', this function will return null. (Inherited from DkmDataContainer)
GetExceptionMessage()	Gets the message associated with the exception. The message is not formatted. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
GetExceptionObjectExpression()	Gets the expression that represents the exception object. If no such object is available, this method returns null. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
GetFormattedDescription()	Gets a description for this message that can be formatted to contain bold/italic text. Text can be made bold by wrapping in "**" blocks or made italic by wrapping in "*" blocks. For example "Bold Text: Non-bold text - Italic". This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
GetHResult()	Gets the HResult code of this exception. If no stack trace is available, this method returns null. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
GetInnerException()	Gets the inner exception if available. If there is no inner exception, this method returns null. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
GetRethrownCallStack(Boolean, DkmVariableInfoFlags, DkmCallStackFilterOptions, DkmInstructionAddress[])	Gets the text of where an exception was thrown, similar to StackTrace property of a .NET Exception. This API is used by the Visual Studio exception UI. This will return an empty string in scenarios where the implementation doesn't want a call stack to be displayed, such as if all of the frames are already present in the call stack window. This API was introduced in Visual Studio 16 Update 4 (DkmApiVersion.VS16Update4).
GetSource()	Gets the source for this exception. If no source is available, this method returns null. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
GetStackTrace()	Gets the stack trace for this exception. If no stack trace is available, this method returns null. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
GetStackTraceInstructionAddresses()	Gets the instruction addresses of the original call stack where this exception was thrown. This API was introduced in Visual Studio 16 Update 4 (DkmApiVersion.VS16Update4).
GetTypeName(Boolean)	Gets the type name of the exception. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
RemoveDataItem<T>()	Remove the instance of 'T' from this container. It is usually unnecessary to call this method as a data container will automatically be emptied when the object is closed. (Inherited from DkmDataContainer)
SetDataItem<T>(DkmDataCreationDisposition, T)	Place a new item in the data container. (Inherited from DkmDataContainer)

Explicit Interface Implementations

IDisposable.Dispose()

To be added.