IVMVirtualMachine::State property

  • Article

The State property contains the current state of the virtual machine.

This property is read-only.

Syntax

HRESULT get_State(
  [out] VMVMState *virtualMachineState
);

VB 
VMVirtualMachine.State( _
  ByRef virtualMachineState _
)

Property value

The current state of the virtual machine.

This property value is read-only.

Error codes

Name Meaning
S_OK
 The operation was successful.
E_POINTER
 The virtualMachineState parameter is NULL.
VM_E_VM_UNKNOWN
 The configuration is unknown.
DISP_E_EXCEPTION
 An unexpected error has occurred.

Examples

The following example displays the State property value of a VMVirtualMachine object.

Set objVS = CreateObject("VirtualServer.Application")
Set objVM = objVS.FindVirtualMachine("Windows Server 2003")

Wscript.Echo "VM Name: " & objVM.Name
WScript.Echo "State: " & objVM.State

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

VMVMState