DkmTaskSynchronizationObject Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Debugger.ParallelTasks

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.

Represents a synchronization object.

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

[System.Runtime.InteropServices.Guid("ceeeb968-317e-47e7-f0e7-42d12f5bb406")]
public class DkmTaskSynchronizationObject : Microsoft.VisualStudio.Debugger.DkmDataContainer, IDisposable

[<System.Runtime.InteropServices.Guid("ceeeb968-317e-47e7-f0e7-42d12f5bb406")>]
type DkmTaskSynchronizationObject = class
    inherit DkmDataContainer
    interface IDisposable

Public Class DkmTaskSynchronizationObject
Inherits DkmDataContainer
Implements IDisposable

Inheritance: MarshalByRefObject

DkmDataContainer
DkmTaskSynchronizationObject

Inheritance: Object

DkmDataContainer
DkmTaskSynchronizationObject

Attributes: GuidAttribute

Implements: IDisposable

Properties

DecimalName	[Optional] Name of the object, in base 10.
HexidecimalName	[Optional] Name of the object, in base 16.
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)
OwningTaskId	The id of the awaited task referred to by this synchronization object. This API was introduced in Visual Studio 15 Update 8 (DkmApiVersion.VS15Update8).
OwningThread	[Optional] The owning thread.
Task	Represents either a managed TPL task or a native Concurrency Runtime task.
Timeout	TODO.
Type	[Optional] The type/kind of synchronization object.
UniqueId	Identifier for this particular instance.
WaitTime	TODO.

Methods

Close()	Closes a DkmTaskSynchronizationObject object instance. This will release any resources associated with this object across all components. This includes resources across computer or managed/native marshalling boundaries. DkmTaskSynchronizationObject objects are automatically closed when their associated DkmTask object is closed.
Create(DkmTask, DkmThread, String, String, String, Int32, Int32, DkmDataItem)	Create a new DkmTaskSynchronizationObject object instance.
Create(DkmTask, DkmThread, String, String, String, Int32, Int32, Int32, DkmDataItem)	Create a new DkmTaskSynchronizationObject object instance. This API was introduced in Visual Studio 15 Update 8 (DkmApiVersion.VS15Update8).
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)

Explicit Interface Implementations

IDisposable.Dispose()

Applies to