DkmRawStackContext Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Debugger.CallStack

Assembly:: Microsoft.VisualStudio.Debugger.Engine.dll

Package:: Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

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.

DkmRawStackContext objects are created by components that wish to request the raw (unfiltered and unformatted) stack from the stack provider. A component needs to close the context after they have completed the stack walk. To obtain the stack a component should create this object and then call GetNextRawFrames.

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

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

[System.Runtime.InteropServices.Guid("c12730ac-9236-41e0-ce9d-fa6abc141118")]
public class DkmRawStackContext : Microsoft.VisualStudio.Debugger.DkmDataContainer, IDisposable

[<System.Runtime.InteropServices.Guid("c12730ac-9236-41e0-ce9d-fa6abc141118")>]
type DkmRawStackContext = class
    inherit DkmDataContainer
    interface IDisposable

Public Class DkmRawStackContext
Inherits DkmDataContainer
Implements IDisposable

Inheritance: MarshalByRefObject

DkmDataContainer
DkmRawStackContext

Inheritance: Object

DkmDataContainer
DkmRawStackContext

Attributes: GuidAttribute

Implements: IDisposable

Properties

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)
Thread	DkmThread represents a thread running in the target process. This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).
ThreadContext	[Optional] The initial thread context to use when performing the stack walk. This value is normally 'null' but can be set in order to view another call stack (ex: .cxr). This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).
UniqueId	Guid which uniquely identifies this DkmRawStackContext. This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).

Methods

Close()	Closes a DkmRawStackContext object instance. This will release any resources associated with this object across all components. This includes resources across computer or managed/native marshalling boundaries. DkmRawStackContext objects are automatically closed when their associated DkmThread object is closed. This method may only be called by the component which created the object. Location constraint: API must be called from an IDE component (component level > 100,000). This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).
Create(DkmThread, ReadOnlyCollection<Byte>, DkmDataItem)	Create a new DkmRawStackContext object instance. The caller is responsible for closing the created object after they are done. Location constraint: API must be called from an IDE component (component level > 100,000). 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)
GetNextRawFrames(DkmWorkList, Int32, DkmCompletionRoutine<DkmGetNextRawFramesAsyncResult>)	Obtain the next raw frames from the call stack. If this is the first call on a particular DkmRawStackContext then this will return the first frames. This method is the recommended way to obtain the call stack because the stack provider maintains a cache of the physical stack. This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine. Location constraint: API must be called from an IDE component (component level > 100,000). This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).
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.

Applies to

Share via