IVMGuestOS::Shutdown method

The Shutdown method tells the guest operating system to shut down.

Syntax

HRESULT Shutdown(
  [out] IVMTask **shutdownTask
);

Parameters

shutdownTask [out]

Retrieves the task which is used to track the completion of the guest operating system's shutdown process. See IVMTask.

Return value

This method supports standard return values, as well as the following. For information on Virtual Server specific return values not listed below, see HRESULT Codes Specific to the Virtual Server.

Return code	Description
S_OK	The operation was successful.
E_POINTER	The shutdownTask parameter is NULL.
VM_E_VM_UNKNOWN	The virtual machine could not be found.
VM_E_VM_NOT_RUNNING	The virtual machine is not running.
E_ACCESSDENIED	The caller must have execute access permissions for this virtual machine.
VM_E_ADDITIONS_FEATURE_NOT_AVAIL	Additions are not installed in this virtual machine.
DISP_E_EXCEPTION	An unexpected error occurred.

Remarks

The virtual machine must be running and Additions must be installed when this method is invoked. This method is only supported for Windows-based guest operating systems.

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

IVMGuestOS