IVMGuestOS::Shutdown method

Article
12/11/2020

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

Shuts down the guest operating system in the virtual machine (VM).

Syntax

HRESULT Shutdown(
  [in]          VARIANT_BOOL isForced,
  [out, retval] IVMTask      **outShutdownTask
);

Parameters

isForced [in]: VARIANT_TRUE if the shutdown is to be forced, VARIANT_FALSE otherwise.
outShutdownTask [out, retval]: An IVMTask object that is used to track the completion of the shutdown process.

Return value

This method can return one of these values.

Return code/value	Description
S_OK 0	The operation was successful.
E_POINTER 0x80004003	The outShutdownTask parameter is NULL.
VM_E_TIMED_OUT 0xA0040202	The operation did not complete in a timely manner.
VM_E_VM_UNKNOWN 0xA0040207	The VM could not be found.
VM_E_VM_NOT_RUNNING 0xA0040206	The VM must be running for this operation.
HRESULT_FROM_WIN32(ERROR_ACCESS_DENIED) 0x80070005	The caller must have execute access permissions for this VM.
VM_E_ADDITIONS_FEATURE_NOT_AVAIL 0xA0040505	The integration components feature is not installed in this VM.
DISP_E_EXCEPTION 0x80020009	An unexpected error has occurred.

Remarks

The VM must be running and integration components feature must be installed when this method is invoked. This method is only supported for Windows-based guest operating systems.

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.

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