Share via


IVMTask interface

The IVMTask interface provides a method for managing tasks which are asynchronous to the COM method invoked.

When to use

Use the IVMTask interface to monitor and control asynchronous tasks for COM methods.

Inheritance

The IVMTask interface has been extended by the following interface:

Members

The IVMTask interface inherits from the IDispatch interface. IVMTask also has these types of members:

Methods

The IVMTask interface has these methods.

Method Description
Cancel Cancels the task.
WaitForCompletion Waits for the task to complete or until the specified timeout expires.
(Inherited from IVMTaskVMTaskIVMTask2VMTask2)

Properties

The IVMTask interface has these properties.

Property Access type Description
Description
Read-only
The description of the task.
(Inherited from IVMTaskVMTaskIVMTask2VMTask2)
ID
Read-only
The unique ID for the task.
(Inherited from IVMTaskVMTaskIVMTask2VMTask2)
IsCancelable
Read-only
Indicates whether the task can be canceled before completion.
(Inherited from IVMTaskVMTaskIVMTask2VMTask2)
IsComplete
Read-only
Indicates whether the task has completed.
(Inherited from IVMTaskVMTaskIVMTask2VMTask2)
PercentCompleted
Read-only
The completion percentage of the task.
(Inherited from IVMTaskVMTaskIVMTask2VMTask2)
Result
Read-only
The result of the task.
(Inherited from IVMTaskVMTaskIVMTask2VMTask2)

Remarks

An IVMTask object is returned by methods which could potentially require a significant amount of time to complete. This allows the user program to monitor the progress of the desired operation without forcing the program to block further execution while waiting for the completion of the operation.

The following methods return an IVMTask object:

Requirements

Product
Microsoft Virtual Server 2005 onWindows Server 2003
Download
Microsoft Virtual Server 2005 R2 SP1 Update onWindows Server 2008orWindows Server 2003
Header
VsComInterfaces.h

See also

IDispatch