DkmRawReturnValueContainer Class

Definition

Reference object that can be used to attach data items to a DkmRawReturnValue.

This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).

public ref class DkmRawReturnValueContainer : Microsoft::VisualStudio::Debugger::DkmDataContainer
[System.Runtime.InteropServices.Guid("b7478b79-2e9f-083d-2757-f1b2f20df1f5")]
public class DkmRawReturnValueContainer : Microsoft.VisualStudio.Debugger.DkmDataContainer
[<System.Runtime.InteropServices.Guid("b7478b79-2e9f-083d-2757-f1b2f20df1f5")>]
type DkmRawReturnValueContainer = class
    inherit DkmDataContainer
Public Class DkmRawReturnValueContainer
Inherits DkmDataContainer
Inheritance
DkmRawReturnValueContainer
Attributes

Properties

Id

Unique identifier of this return value. The first return value is zero, then one, etc. Return value id's are unique only within a particular DkmInspectionSession.

This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).

InspectionSession

The inspection session that owns this frame data object.

This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).

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)
RawReturnValue

The DkmRawReturnValue object that this container refers to.

This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).

Methods

Create(DkmInspectionSession, Int32, DkmRawReturnValue, DkmDataItem)

Create a new DkmRawReturnValueContainer object instance.

This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).

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)
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)

Applies to