DkmWaitUIOperation Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Debugger

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 an operation which is happening on the debugger backend, and which may be slow, so the user should be informed if it winds up taking longer the specified delay.

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

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

[System.Runtime.InteropServices.Guid("b549d20f-fc68-1764-6ba0-35fb22f6a960")]
public class DkmWaitUIOperation : Microsoft.VisualStudio.Debugger.DkmDataContainer, IDisposable

[<System.Runtime.InteropServices.Guid("b549d20f-fc68-1764-6ba0-35fb22f6a960")>]
type DkmWaitUIOperation = class
    inherit DkmDataContainer
    interface IDisposable

Public Class DkmWaitUIOperation
Inherits DkmDataContainer
Implements IDisposable

Inheritance: MarshalByRefObject

DkmDataContainer
DkmWaitUIOperation

Inheritance: Object

DkmDataContainer
DkmWaitUIOperation

Attributes: GuidAttribute

Implements: IDisposable

Properties

Description	Description of the operation to show to the user. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
Flags	Flags for a DkmWaitUIOperation. 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)
SourceId	Identifies the source of an object. SourceIds are used to enable filtering in scenarios when multiple components may be creating instances of a class. For example, source ids can be used to determine if a breakpoint comes from the AD7 AL (ex: user breakpoint, or other breakpoint visible at the SDM level) instead of a breakpoint which may be created by another component (for example an internal breakpoint used for stepping). This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
UniqueId	Guid which uniquely identifies this operation. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).

Methods

Close()	Closes a DkmWaitUIOperation object instance. This will shutdown the wait UI if it is open. Code that calls DkmWaitUIOperation.Create should always call this method to indicate the operation is done. This method may only be called by the component which created the object. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
Create(Guid, String, DkmWaitUIOperationFlags, DkmDataItem)	Creates a new DkmWaitUIOperation object. Call 'OnStart' to indicate that the operation has actually started. The caller is responsible for closing the created object after they are done. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
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)
OnStart(Int32)	Indicates that the operation has begun. UI will pop up from the IDE if it is still in progress after the delay has expired. The implementation of this method is async and this function will immediately return. The caller make sure to Close the DkmWaitUIOperation to indicate that the operation is complete. This method may only be called by the component which created the object. 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.

Applies to