IVMGuestOS::Restart method

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

Restarts the guest operating system.

Syntax

HRESULT Restart(
  [in]          VARIANT_BOOL inForced,
  [out, retval] IVMTask      **outRestartTask
);

inForced [in]: VARIANT_TRUE if a forced restart is required and VARIANT_FALSE otherwise.
outRestartTask [out, retval]: An IVMTask object that is used to track the completion progress of the restart sequence.

This method can return one of these values.

Return code/value	Description
S_OK 0	The operation was successful.
E_POINTER 0x80004003	The outRestartTask parameter is NULL.
DISP_E_EXCEPTION 0x80020009	An unexpected error has occurred.
VM_E_TIMED_OUT 0xA0040202	The operation did not complete in a timely manner.
VM_E_VM_NOT_RUNNING 0xA0040206	The virtual machine (VM) must be running for this operation.
VM_E_VM_UNKNOWN 0xA0040207	The configuration is unknown.
VM_E_ADDITIONS_FEATURE_NOT_AVAIL 0xA0040505	The integration components feature is not installed in this VM.

The following values can be returned through the Error property of the returned IVMTask object.

Error code/Value	Description
`HRESULT_FROM_WIN32(ERROR_ACCESS_DENIED)` (0x80070005)	The caller must have execute access permissions for this VM.
`HRESULT_FROM_WIN32(ERROR_MACHINE_LOCKED)` (0x800704f7)	The computer is locked and cannot be shut down without the force option.
`HRESULT_FROM_WIN32(ERROR_NOT_READY)` (0x80070015)	The device is not ready.
`HRESULT_FROM_WIN32(ERROR_SHUTDOWN_IN_PROGRESS)` (0x8007045b)	A system shutdown is in progress.

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_IVMGuestOS is defined as 99fea0db-4880-499a-b6d8-73dff9bc91be