IVMVirtualMachine::TurnOff method

The TurnOff method turns off the virtual machine.

Syntax

HRESULT TurnOff(
  [out] IVMTask **turnOffTask
);

Parameters

turnOffTask [out]

A task that is used to track the completion progress of the virtual machine's turnoff sequence.

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 turnOffTask parameter is NULL.
E_ACCESSDENIED
The caller must have execute access permissions to turn off this virtual machine.
VM_E_VM_NOT_RUNNING
The virtual machine is not running.
DISP_E_EXCEPTION
An unexpected error has occurred.

Remarks

This method turns off the virtual machine in the same manner as turning the power off on a real machine.

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

IVMVirtualMachine