Edit

IVMTask::WaitForCompletion method

  • Article

[Windows Virtual PC is no longer available for use as of Windows 8. Instead, use the Hyper-V WMI provider (V2).]

Waits for the task to complete or for the specified time-out interval to elapse.

Syntax

HRESULT WaitForCompletion(
  [in] long timeout
);

Parameters

timeout [in]

The time, in milliseconds, that this method will wait for task completion before returning control to the caller. A value of -1 specifies that method will wait until the task completes without timing out. Other valid timeout values range from 0 to 4,000,000 milliseconds.

Return value

This method can return one of these values.

Return code/value Description
S_OK
0
 The operation was successful.
E_INVALIDARG
0x80000003
 The timeout parameter is not valid.
DISP_E_EXCEPTION
0x80020009
 An unexpected error has occurred.

Remarks

The WaitForCompletion method puts the current execution thread to sleep until it returns. Specifying an infinite wait (timeout = -1) is not recommended unless it is absolutely critical that the task completes under any circumstance.

Requirements

Requirement Value
Minimum supported client
 Windows 7 [desktop apps only]
Minimum supported server
 None supported
End of client support
 Windows 7
Product
 Windows Virtual PC
Header
VPCCOMInterfaces.h
IID
 IID_IVMTask is defined as ab72b222-6e9c-48ae-aa54-85e3e635767c

See also

IVMTask