Share via

DkmProcessSnapshot Class

  • Reference

Definition

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

DkmProcessSnapshot represents a snapshot that's captured about a running process.

This API was introduced in Visual Studio 15 Update 3 (DkmApiVersion.VS15Update3).

public ref class DkmProcessSnapshot : Microsoft::VisualStudio::Debugger::DkmDataContainer
[System.Runtime.InteropServices.Guid("12cfe50c-ecfe-dae1-def2-9521596c8635")]
public class DkmProcessSnapshot : Microsoft.VisualStudio.Debugger.DkmDataContainer
[<System.Runtime.InteropServices.Guid("12cfe50c-ecfe-dae1-def2-9521596c8635")>]
type DkmProcessSnapshot = class
    inherit DkmDataContainer
Public Class DkmProcessSnapshot
Inherits DkmDataContainer
Inheritance
MarshalByRefObject
DkmDataContainer
DkmProcessSnapshot
Inheritance
Object
DkmDataContainer
DkmProcessSnapshot
Attributes
GuidAttribute

Properties

Id

An increasing number to identify the snapshot within a process.

This API was introduced in Visual Studio 15 Update 3 (DkmApiVersion.VS15Update3).
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)
OriginalProcess

The process that this snapshot is associate with.

This API was introduced in Visual Studio 15 Update 3 (DkmApiVersion.VS15Update3).
ProcessId

Process Id assigned to the Snapshot by the operating system.

This API was introduced in Visual Studio 15 Update 3 (DkmApiVersion.VS15Update3).
StoppingThreadId

The id of the stopping thread. It usually is used to set the UI when we attach to a snapshot.

This API was introduced in Visual Studio 15 Update 3 (DkmApiVersion.VS15Update3).
TimeStamp

The timestamp of the debug event for which the snapshot is taken. Typically, it's obtained via QueryPerformanceCounter when the debug event occurs.

This API was introduced in Visual Studio 15 Update 3 (DkmApiVersion.VS15Update3).

Methods

Create(UInt32, Int32, DkmProcess, UInt64, Int32, DkmDataItem)

Creates a new process snapshot object. This method is called from the base debug monitor on the event thread as part of processing of TakeSnapshot.

Location constraint: API must be called from a Monitor component (component level < 100,000).

This API was introduced in Visual Studio 15 Update 3 (DkmApiVersion.VS15Update3).
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