|
Classes |
interface | IVirtualBoxErrorInfo |
| The IVirtualBoxErrorInfo interface represents extended error information. More...
|
interface | IVirtualBoxCallback |
interface | IDHCPServer |
| The IDHCPServer interface represents the vbox dhcp server configuration. More...
|
interface | IVirtualBox |
| The IVirtualBox interface represents the main interface exposed by the product that provides virtual machine management. More...
|
interface | IAppliance |
| Represents a platform-independent appliance in OVF format. More...
|
interface | IVirtualSystemDescription |
| This interface is used in the IAppliance::virtualSystemDescriptions array. More...
|
interface | IInternalMachineControl |
interface | IBIOSSettings |
| The IBIOSSettings interface represents BIOS settings of the virtual machine. More...
|
interface | IMachine |
| The IMachine interface represents a virtual machine, or guest, created in VirtualBox. More...
|
interface | IConsoleCallback |
interface | IRemoteDisplayInfo |
| Contains information about the remote display (VRDP) capabilities and status. More...
|
interface | IConsole |
| The IConsole interface represents an interface to control virtual machine execution. More...
|
interface | IHostDVDDrive |
| The IHostDVDDrive interface represents the physical CD/DVD drive hardware on the host. More...
|
interface | IHostFloppyDrive |
| The IHostFloppyDrive interface represents the physical floppy drive hardware on the host. More...
|
interface | IHostNetworkInterface |
| Reprents one of host's network interfaces. More...
|
interface | IHost |
| The IHost interface represents the physical machine that this VirtualBox installation runs on. More...
|
interface | ISystemProperties |
| The ISystemProperties interface represents global properties of the given VirtualBox installation. More...
|
interface | IGuestOSType |
interface | IGuest |
| The IGuest interface represents information about the operating system running inside the virtual machine. More...
|
interface | IProgress |
| The IProgress interface is used to track and control asynchronous tasks within VirtualBox. More...
|
interface | ISnapshot |
| The ISnapshot interface represents a snapshot of the virtual machine. More...
|
interface | IMedium |
| The IMedium interface is a common interface for all objects representing virtual media such as hard disks, CD/DVD images and floppy images. More...
|
interface | IHardDiskAttachment |
| The IHardDiskAttachment interface represents a hard disk attachment of a virtual machine. More...
|
interface | IHardDisk |
| The IHardDisk interface represents a virtual hard disk drive used by a virtual machine. More...
|
interface | IHardDiskFormat |
| The IHardDiskFormat interface represents a virtual hard disk format. More...
|
interface | IFloppyImage |
| The IFloppyImage interface represents a medium containing the image of a floppy disk. More...
|
interface | IDVDImage |
| The IDVDImage interface represents a medium containing the image of a CD or DVD disk in the ISO format. More...
|
interface | IDVDDrive |
| The IDVDDrive interface represents the virtual CD/DVD drive of the virtual machine. More...
|
interface | IFloppyDrive |
| The IFloppyDrive interface represents the virtual floppy drive of the virtual machine. More...
|
interface | IKeyboard |
| The IKeyboard interface represents the virtual machine's keyboard. More...
|
interface | IMouse |
| The IMouse interface represents the virtual machine's mouse. More...
|
interface | IFramebuffer |
interface | IFramebufferOverlay |
| The IFramebufferOverlay interface represents an alpha blended overlay for displaying status icons above an IFramebuffer. More...
|
interface | IDisplay |
| The IDisplay interface represents the virtual machine's display. More...
|
interface | INetworkAdapter |
| Represents a virtual network adapter that is attached to a virtual machine. More...
|
interface | ISerialPort |
| The ISerialPort interface represents the virtual serial port device. More...
|
interface | IParallelPort |
| The IParallelPort interface represents the virtual parallel port device. More...
|
interface | IMachineDebugger |
interface | IUSBController |
interface | IUSBDevice |
| The IUSBDevice interface represents a virtual USB device attached to the virtual machine. More...
|
interface | IUSBDeviceFilter |
| The IUSBDeviceFilter interface represents an USB device filter used to perform actions on a group of USB devices. More...
|
interface | IHostUSBDevice |
| The IHostUSBDevice interface represents a physical USB device attached to the host computer. More...
|
interface | IHostUSBDeviceFilter |
| The IHostUSBDeviceFilter interface represents a global filter for a physical USB device used by the host computer. More...
|
interface | IAudioAdapter |
| The IAudioAdapter interface represents the virtual audio adapter of the virtual machine. More...
|
interface | IVRDPServer |
interface | ISharedFolder |
| The ISharedFolder interface represents a folder in the host computer's file system accessible from the guest OS running inside a virtual machine using an associated logical name. More...
|
interface | IInternalSessionControl |
interface | ISession |
| The ISession interface represents a serialization primitive for virtual machines. More...
|
interface | IStorageController |
| Represents a storage controller that is attached to a virtual machine (IMachine). More...
|
interface | IManagedObjectRef |
| Managed object reference. More...
|
interface | IWebsessionManager |
| Websession manager. More...
|
interface | IPerformanceMetric |
| The IPerformanceMetric interface represents parameters of the given performance metric. More...
|
interface | IPerformanceCollector |
| The IPerformanceCollector interface represents a service that collects and stores performance metrics data. More...
|
Enumerations |
enum | TSBool { TSBool_False = 0,
TSBool_True = 1,
TSBool_Default = 2
} |
| Boolean variable having a third state, default. More...
|
enum | AccessMode { AccessMode_ReadOnly = 1,
AccessMode_ReadWrite = 2
} |
| Access mode for opening files. More...
|
enum | MachineState {
MachineState_Null = 0,
MachineState_PoweredOff = 1,
MachineState_Saved = 2,
MachineState_Aborted = 3,
MachineState_Running = 4,
MachineState_Paused = 5,
MachineState_Stuck = 6,
MachineState_Starting = 7,
MachineState_Stopping = 8,
MachineState_Saving = 9,
MachineState_Restoring = 10,
MachineState_Discarding = 11,
MachineState_SettingUp = 12,
MachineState_FirstOnline = 4,
MachineState_LastOnline = 10,
MachineState_FirstTransient = 7,
MachineState_LastTransient = 12
} |
| Virtual machine execution state. More...
|
enum | SessionState {
SessionState_Null = 0,
SessionState_Closed = 1,
SessionState_Open = 2,
SessionState_Spawning = 3,
SessionState_Closing = 4
} |
| Session state. More...
|
enum | SessionType { SessionType_Null = 0,
SessionType_Direct = 1,
SessionType_Remote = 2,
SessionType_Existing = 3
} |
| Session type. More...
|
enum | DeviceType {
DeviceType_Null = 0,
DeviceType_Floppy = 1,
DeviceType_DVD = 2,
DeviceType_HardDisk = 3,
DeviceType_Network = 4,
DeviceType_USB = 5,
DeviceType_SharedFolder = 6
} |
| Device type. More...
|
enum | DeviceActivity { DeviceActivity_Null = 0,
DeviceActivity_Idle = 1,
DeviceActivity_Reading = 2,
DeviceActivity_Writing = 3
} |
| Device activity for IConsole::getDeviceActivity. More...
|
enum | ClipboardMode { ClipboardMode_Disabled = 0,
ClipboardMode_HostToGuest = 1,
ClipboardMode_GuestToHost = 2,
ClipboardMode_Bidirectional = 3
} |
| Host-Guest clipboard interchange mode. More...
|
enum | Scope { Scope_Global = 0,
Scope_Machine = 1,
Scope_Session = 2
} |
| Scope of the operation. More...
|
enum | GuestStatisticType {
GuestStatisticType_CPULoad_Idle = 0,
GuestStatisticType_CPULoad_Kernel = 1,
GuestStatisticType_CPULoad_User = 2,
GuestStatisticType_Threads = 3,
GuestStatisticType_Processes = 4,
GuestStatisticType_Handles = 5,
GuestStatisticType_MemoryLoad = 6,
GuestStatisticType_PhysMemTotal = 7,
GuestStatisticType_PhysMemAvailable = 8,
GuestStatisticType_PhysMemBalloon = 9,
GuestStatisticType_MemCommitTotal = 10,
GuestStatisticType_MemKernelTotal = 11,
GuestStatisticType_MemKernelPaged = 12,
GuestStatisticType_MemKernelNonpaged = 13,
GuestStatisticType_MemSystemCache = 14,
GuestStatisticType_PageFileSize = 15,
GuestStatisticType_SampleNumber = 16,
GuestStatisticType_MaxVal = 17
} |
| Statistics type for IGuest::getStatistic. More...
|
enum | BIOSBootMenuMode { BIOSBootMenuMode_Disabled = 0,
BIOSBootMenuMode_MenuOnly = 1,
BIOSBootMenuMode_MessageAndMenu = 2
} |
| BIOS boot menu mode. More...
|
enum | DriveState { DriveState_Null = 0,
DriveState_NotMounted = 1,
DriveState_ImageMounted = 2,
DriveState_HostDriveCaptured = 3
} |
enum | ProcessorFeature { ProcessorFeature_HWVirtEx = 0,
ProcessorFeature_PAE = 1,
ProcessorFeature_LongMode = 2
} |
| CPU features. More...
|
enum | CIMOSType {
CIMOSType_CIMOS_Unknown = 0,
CIMOSType_CIMOS_Other = 1,
CIMOSType_CIMOS_MACOS = 2,
CIMOSType_CIMOS_ATTUNIX = 3,
CIMOSType_CIMOS_DGUX = 4,
CIMOSType_CIMOS_DECNT = 5,
CIMOSType_CIMOS_Tru64UNIX = 6,
CIMOSType_CIMOS_OpenVMS = 7,
CIMOSType_CIMOS_HPUX = 8,
CIMOSType_CIMOS_AIX = 9,
CIMOSType_CIMOS_MVS = 10,
CIMOSType_CIMOS_OS400 = 11,
CIMOSType_CIMOS_OS2 = 12,
CIMOSType_CIMOS_JavaVM = 13,
CIMOSType_CIMOS_MSDOS = 14,
CIMOSType_CIMOS_WIN3x = 15,
CIMOSType_CIMOS_WIN95 = 16,
CIMOSType_CIMOS_WIN98 = 17,
CIMOSType_CIMOS_WINNT = 18,
CIMOSType_CIMOS_WINCE = 19,
CIMOSType_CIMOS_NCR3000 = 20,
CIMOSType_CIMOS_NetWare = 21,
CIMOSType_CIMOS_OSF = 22,
CIMOSType_CIMOS_DCOS = 23,
CIMOSType_CIMOS_ReliantUNIX = 24,
CIMOSType_CIMOS_SCOUnixWare = 25,
CIMOSType_CIMOS_SCOOpenServer = 26,
CIMOSType_CIMOS_Sequent = 27,
CIMOSType_CIMOS_IRIX = 28,
CIMOSType_CIMOS_Solaris = 29,
CIMOSType_CIMOS_SunOS = 30,
CIMOSType_CIMOS_U6000 = 31,
CIMOSType_CIMOS_ASERIES = 32,
CIMOSType_CIMOS_HPNonStopOS = 33,
CIMOSType_CIMOS_HPNonStopOSS = 34,
CIMOSType_CIMOS_BS2000 = 35,
CIMOSType_CIMOS_LINUX = 36,
CIMOSType_CIMOS_Lynx = 37,
CIMOSType_CIMOS_XENIX = 38,
CIMOSType_CIMOS_VM = 39,
CIMOSType_CIMOS_InteractiveUNIX = 40,
CIMOSType_CIMOS_BSDUNIX = 41,
CIMOSType_CIMOS_FreeBSD = 42,
CIMOSType_CIMOS_NetBSD = 43,
CIMOSType_CIMOS_GNUHurd = 44,
CIMOSType_CIMOS_OS9 = 45,
CIMOSType_CIMOS_MACHKernel = 46,
CIMOSType_CIMOS_Inferno = 47,
CIMOSType_CIMOS_QNX = 48,
CIMOSType_CIMOS_EPOC = 49,
CIMOSType_CIMOS_IxWorks = 50,
CIMOSType_CIMOS_VxWorks = 51,
CIMOSType_CIMOS_MiNT = 52,
CIMOSType_CIMOS_BeOS = 53,
CIMOSType_CIMOS_HPMPE = 54,
CIMOSType_CIMOS_NextStep = 55,
CIMOSType_CIMOS_PalmPilot = 56,
CIMOSType_CIMOS_Rhapsody = 57,
CIMOSType_CIMOS_Windows2000 = 58,
CIMOSType_CIMOS_Dedicated = 59,
CIMOSType_CIMOS_OS390 = 60,
CIMOSType_CIMOS_VSE = 61,
CIMOSType_CIMOS_TPF = 62,
CIMOSType_CIMOS_WindowsMe = 63,
CIMOSType_CIMOS_CalderaOpenUNIX = 64,
CIMOSType_CIMOS_OpenBSD = 65,
CIMOSType_CIMOS_NotApplicable = 66,
CIMOSType_CIMOS_WindowsXP = 67,
CIMOSType_CIMOS_zOS = 68,
CIMOSType_CIMOS_MicrosoftWindowsServer2003 = 69,
CIMOSType_CIMOS_MicrosoftWindowsServer2003_64 = 70,
CIMOSType_CIMOS_WindowsXP_64 = 71,
CIMOSType_CIMOS_WindowsXPEmbedded = 72,
CIMOSType_CIMOS_WindowsVista = 73,
CIMOSType_CIMOS_WindowsVista_64 = 74,
CIMOSType_CIMOS_WindowsEmbeddedforPointofService = 75,
CIMOSType_CIMOS_MicrosoftWindowsServer2008 = 76,
CIMOSType_CIMOS_MicrosoftWindowsServer2008_64 = 77,
CIMOSType_CIMOS_FreeBSD_64 = 78,
CIMOSType_CIMOS_RedHatEnterpriseLinux = 79,
CIMOSType_CIMOS_RedHatEnterpriseLinux_64 = 80,
CIMOSType_CIMOS_Solaris_64 = 81,
CIMOSType_CIMOS_SUSE = 82,
CIMOSType_CIMOS_SUSE_64 = 83,
CIMOSType_CIMOS_SLES = 84,
CIMOSType_CIMOS_SLES_64 = 85,
CIMOSType_CIMOS_NovellOES = 86,
CIMOSType_CIMOS_NovellLinuxDesktop = 87,
CIMOSType_CIMOS_SunJavaDesktopSystem = 88,
CIMOSType_CIMOS_Mandriva = 89,
CIMOSType_CIMOS_Mandriva_64 = 90,
CIMOSType_CIMOS_TurboLinux = 91,
CIMOSType_CIMOS_TurboLinux_64 = 92,
CIMOSType_CIMOS_Ubuntu = 93,
CIMOSType_CIMOS_Ubuntu_64 = 94,
CIMOSType_CIMOS_Debian = 95,
CIMOSType_CIMOS_Debian_64 = 96,
CIMOSType_CIMOS_Linux_2_4_x = 97,
CIMOSType_CIMOS_Linux_2_4_x_64 = 98,
CIMOSType_CIMOS_Linux_2_6_x = 99,
CIMOSType_CIMOS_Linux_2_6_x_64 = 100,
CIMOSType_CIMOS_Linux_64 = 101,
CIMOSType_CIMOS_Other_64 = 102
} |
| OVF operating system values according to CIM V2.20 (as of Nov 2008); http://www.dmtf.org/standards/cim/cim_schema_v220. More...
|
enum | OVFResourceType {
OVFResourceType_Other = 1,
OVFResourceType_ComputerSystem = 2,
OVFResourceType_Processor = 3,
OVFResourceType_Memory = 4,
OVFResourceType_IDEController = 5,
OVFResourceType_ParallelSCSIHBA = 6,
OVFResourceType_FCHBA = 7,
OVFResourceType_iSCSIHBA = 8,
OVFResourceType_IBHCA = 9,
OVFResourceType_EthernetAdapter = 10,
OVFResourceType_OtherNetworkAdapter = 11,
OVFResourceType_IOSlot = 12,
OVFResourceType_IODevice = 13,
OVFResourceType_FloppyDrive = 14,
OVFResourceType_CDDrive = 15,
OVFResourceType_DVDDrive = 16,
OVFResourceType_HardDisk = 17,
OVFResourceType_OtherStorageDevice = 20,
OVFResourceType_USBController = 23,
OVFResourceType_SoundCard = 35
} |
| OVF resource type (as listed with CIM_ResourceAllocationSettingData; see for example http://msdn.microsoft.com/en-us/library/cc136877(VS.85).aspx). More...
|
enum | VirtualSystemDescriptionType {
VirtualSystemDescriptionType_Ignore = 1,
VirtualSystemDescriptionType_OS = 2,
VirtualSystemDescriptionType_Name = 3,
VirtualSystemDescriptionType_Product = 4,
VirtualSystemDescriptionType_Vendor = 5,
VirtualSystemDescriptionType_Version = 6,
VirtualSystemDescriptionType_ProductUrl = 7,
VirtualSystemDescriptionType_VendorUrl = 8,
VirtualSystemDescriptionType_Description = 9,
VirtualSystemDescriptionType_License = 10,
VirtualSystemDescriptionType_Miscellaneous = 11,
VirtualSystemDescriptionType_CPU = 12,
VirtualSystemDescriptionType_Memory = 13,
VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
VirtualSystemDescriptionType_HardDiskImage = 17,
VirtualSystemDescriptionType_Floppy = 18,
VirtualSystemDescriptionType_CDROM = 19,
VirtualSystemDescriptionType_NetworkAdapter = 20,
VirtualSystemDescriptionType_USBController = 21,
VirtualSystemDescriptionType_SoundCard = 22
} |
| Used with IVirtualSystemDescription to describe the type of a configuration value. More...
|
enum | VirtualSystemDescriptionValueType { VirtualSystemDescriptionValueType_Reference = 1,
VirtualSystemDescriptionValueType_Original = 2,
VirtualSystemDescriptionValueType_Auto = 3,
VirtualSystemDescriptionValueType_ExtraConfig = 4
} |
| Used with IVirtualSystemDescription::getValuesByType to describe the value type to fetch. More...
|
enum | HostNetworkInterfaceMediumType { HostNetworkInterfaceMediumType_Unknown = 0,
HostNetworkInterfaceMediumType_Ethernet = 1,
HostNetworkInterfaceMediumType_PPP = 2,
HostNetworkInterfaceMediumType_SLIP = 3
} |
| Type of encapsulation. More...
|
enum | HostNetworkInterfaceStatus { HostNetworkInterfaceStatus_Unknown = 0,
HostNetworkInterfaceStatus_Up = 1,
HostNetworkInterfaceStatus_Down = 2
} |
| Current status of the interface. More...
|
enum | HostNetworkInterfaceType { HostNetworkInterfaceType_Bridged = 1,
HostNetworkInterfaceType_HostOnly = 2
} |
| Network interface type. More...
|
enum | MediaState {
MediaState_NotCreated = 0,
MediaState_Created = 1,
MediaState_LockedRead = 2,
MediaState_LockedWrite = 3,
MediaState_Inaccessible = 4,
MediaState_Creating = 5,
MediaState_Deleting = 6
} |
| Virtual media state. More...
|
enum | HardDiskType { HardDiskType_Normal = 0,
HardDiskType_Immutable = 1,
HardDiskType_Writethrough = 2
} |
| Virtual hard disk type. More...
|
enum | HardDiskVariant {
HardDiskVariant_Standard = 0,
HardDiskVariant_VmdkSplit2G = 0x01,
HardDiskVariant_VmdkStreamOptimized = 0x04,
HardDiskVariant_VmdkESX = 0x08,
HardDiskVariant_Fixed = 0x10000,
HardDiskVariant_Diff = 0x20000
} |
| Virtual hard disk image variant. More...
|
enum | DataType { DataType_Int32 = 0,
DataType_Int8 = 1,
DataType_String = 2
} |
enum | DataFlags {
DataFlags_None = 0x00,
DataFlags_Mandatory = 0x01,
DataFlags_Expert = 0x02,
DataFlags_Array = 0x04,
DataFlags_FlagMask = 0x07
} |
enum | HardDiskFormatCapabilities {
HardDiskFormatCapabilities_Uuid = 0x01,
HardDiskFormatCapabilities_CreateFixed = 0x02,
HardDiskFormatCapabilities_CreateDynamic = 0x04,
HardDiskFormatCapabilities_CreateSplit2G = 0x08,
HardDiskFormatCapabilities_Differencing = 0x10,
HardDiskFormatCapabilities_Asynchronous = 0x20,
HardDiskFormatCapabilities_File = 0x40,
HardDiskFormatCapabilities_Properties = 0x80,
HardDiskFormatCapabilities_CapabilityMask = 0xFF
} |
| Hard disk format capability flags. More...
|
enum | MouseButtonState {
MouseButtonState_LeftButton = 0x01,
MouseButtonState_RightButton = 0x02,
MouseButtonState_MiddleButton = 0x04,
MouseButtonState_WheelUp = 0x08,
MouseButtonState_WheelDown = 0x10,
MouseButtonState_MouseStateMask = 0x1F
} |
| Mouse button state. More...
|
enum | FramebufferAccelerationOperation { FramebufferAccelerationOperation_SolidFillAcceleration = 1,
FramebufferAccelerationOperation_ScreenCopyAcceleration = 2
} |
| Frame buffer acceleration operation. More...
|
enum | FramebufferPixelFormat { FramebufferPixelFormat_Opaque = 0,
FramebufferPixelFormat_FOURCC_RGB = 0x32424752
} |
| Format of the video memory buffer. More...
|
enum | NetworkAttachmentType {
NetworkAttachmentType_Null = 0,
NetworkAttachmentType_NAT = 1,
NetworkAttachmentType_Bridged = 2,
NetworkAttachmentType_Internal = 3,
NetworkAttachmentType_HostOnly = 4
} |
| Network attachment type. More...
|
enum | NetworkAdapterType {
NetworkAdapterType_Null = 0,
NetworkAdapterType_Am79C970A = 1,
NetworkAdapterType_Am79C973 = 2,
NetworkAdapterType_I82540EM = 3,
NetworkAdapterType_I82543GC = 4,
NetworkAdapterType_I82545EM = 5
} |
| Network adapter type. More...
|
enum | PortMode { PortMode_Disconnected = 0,
PortMode_HostPipe = 1,
PortMode_HostDevice = 2
} |
| The PortMode enumeration represents possible communication modes for the virtual serial port device. More...
|
enum | USBDeviceState {
USBDeviceState_NotSupported = 0,
USBDeviceState_Unavailable = 1,
USBDeviceState_Busy = 2,
USBDeviceState_Available = 3,
USBDeviceState_Held = 4,
USBDeviceState_Captured = 5
} |
| USB device state. More...
|
enum | USBDeviceFilterAction { USBDeviceFilterAction_Null = 0,
USBDeviceFilterAction_Ignore = 1,
USBDeviceFilterAction_Hold = 2
} |
| Actions for host USB device filters. More...
|
enum | AudioDriverType {
AudioDriverType_Null = 0,
AudioDriverType_WinMM = 1,
AudioDriverType_OSS = 2,
AudioDriverType_ALSA = 3,
AudioDriverType_DirectSound = 4,
AudioDriverType_CoreAudio = 5,
AudioDriverType_MMPM = 6,
AudioDriverType_Pulse = 7,
AudioDriverType_SolAudio = 8
} |
| Host audio driver type. More...
|
enum | AudioControllerType { AudioControllerType_AC97 = 0,
AudioControllerType_SB16 = 1
} |
| Virtual audio controller type. More...
|
enum | VRDPAuthType { VRDPAuthType_Null = 0,
VRDPAuthType_External = 1,
VRDPAuthType_Guest = 2
} |
| VRDP authentication type. More...
|
enum | StorageBus { StorageBus_Null = 0,
StorageBus_IDE = 1,
StorageBus_SATA = 2,
StorageBus_SCSI = 3
} |
| The connection type of the storage controller. More...
|
enum | StorageControllerType {
StorageControllerType_Null = 0,
StorageControllerType_LsiLogic = 1,
StorageControllerType_BusLogic = 2,
StorageControllerType_IntelAhci = 3,
StorageControllerType_PIIX3 = 4,
StorageControllerType_PIIX4 = 5,
StorageControllerType_ICH6 = 6
} |
| Storage controller type. More...
|
Variables |
const HRESULT | VBOX_E_OBJECT_NOT_FOUND = 0x80BB0001 |
| Object corresponding to the supplied arguments does not exist.
|
const HRESULT | VBOX_E_INVALID_VM_STATE = 0x80BB0002 |
| Current virtual machine state prevents the operation.
|
const HRESULT | VBOX_E_VM_ERROR = 0x80BB0003 |
| Virtual machine error occurred attempting the operation.
|
const HRESULT | VBOX_E_FILE_ERROR = 0x80BB0004 |
| File not accessible or erroneous file contents.
|
const HRESULT | VBOX_E_IPRT_ERROR = 0x80BB0005 |
| Runtime subsystem error.
|
const HRESULT | VBOX_E_PDM_ERROR = 0x80BB0006 |
| Pluggable Device Manager error.
|
const HRESULT | VBOX_E_INVALID_OBJECT_STATE = 0x80BB0007 |
| Current object state prohibits operation.
|
const HRESULT | VBOX_E_HOST_ERROR = 0x80BB0008 |
| Host operating system related error.
|
const HRESULT | VBOX_E_NOT_SUPPORTED = 0x80BB0009 |
| Requested operation is not supported.
|
const HRESULT | VBOX_E_XML_ERROR = 0x80BB000A |
| Invalid XML found.
|
const HRESULT | VBOX_E_INVALID_SESSION_STATE = 0x80BB000B |
| Current session state prohibits operation.
|
const HRESULT | VBOX_E_OBJECT_IN_USE = 0x80BB000C |
| Object being in use prohibits operation.
|
Virtual machine execution state.
This enumeration represents possible values of the IMachine::state attribute.
Below is the basic virtual machine state diagram. It shows how the state changes during virtual machine execution. The text in square braces shows a method of the IConsole interface that performs the given state transition.
+---------[powerDown()] <- Stuck <--[failure]-+
V |
+-> PoweredOff --+-->[powerUp()]--> Starting --+ | +-----[resume()]-----+
| | | | V |
| Aborted -----+ +--> Running --[pause()]--> Paused
| | ^ | ^ |
| Saved -----------[powerUp()]--> Restoring -+ | | | |
| ^ | | | |
| | +-----------------------------------------+-|-------------------+ +
| | | | |
| | +-- Saving <--------[takeSnapshot()]<-------+---------------------+
| | | |
| +-------- Saving <--------[saveState()]<----------+---------------------+
| | |
+-------------- Stopping -------[powerDown()]<----------+---------------------+
Note that states to the right from PoweredOff, Aborted and Saved in the above diagram are called online VM states. These states represent the virtual machine which is being executed in a dedicated process (usually with a GUI window attached to it where you can see the activity of the virtual machine and interact with it). There are two special pseudo-states, FirstOnline and LastOnline, that can be used in relational expressions to detect if the given machine state is online or not:
if (machine.GetState() >= MachineState_FirstOnline &&
machine.GetState() <= MachineState_LastOnline)
{
...the machine is being executed...
}
When the virtual machine is in one of the online VM states (that is, being executed), only a few machine settings can be modified. Methods working with such settings contain an explicit note about that. An attempt to change any oter setting or perform a modifying operation during this time will result in the VBOX_E_INVALID_VM_STATE error.
All online states except Running, Paused and Stuck are transitional: they represent temporary conditions of the virtual machine that will last as long as the operation that initiated such a condition.
The Stuck state is a special case. It means that execution of the machine has reached the "Guru Meditation" condition. This condition indicates an internal VMM (virtual machine manager) failure which may happen as a result of either an unhandled low-level virtual hardware exception or one of the recompiler exceptions (such as the too-many-traps condition).
Note also that any online VM state may transit to the Aborted state. This happens if the process that is executing the virtual machine terminates unexpectedly (for example, crashes). Other than that, the Aborted state is equivalent to PoweredOff.
There are also a few additional state diagrams that do not deal with virtual machine execution and therefore are shown separately. The states shown on these diagrams are called offline VM states (this includes PoweredOff, Aborted and Saved too).
The first diagram shows what happens when a lengthy setup operation is being executed (such as IMachine::attachHardDisk).
+----------------------------------(same state as before the call)------+
| |
+-> PoweredOff --+ |
| | |
|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
| |
+-> Saved -------+
The next two diagrams demonstrate the process of taking a snapshot of a powered off virtual machine and performing one of the "discard..." operations, respectively.
+----------------------------------(same state as before the call)------+
| |
+-> PoweredOff --+ |
| +-->[takeSnapshot()] -------------------> Saving ------+
+-> Aborted -----+
+-> PoweredOff --+
| |
| Aborted -----+-->[discardSnapshot() ]-------------> Discarding --+
| | [discardCurrentState()] |
+-> Saved -------+ [discardCurrentSnapshotAndState()] |
| |
+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
Note that the Saving state is present in both the offline state group and online state group. Currently, the only way to determine what group is assumed in a particular case is to remember the previous machine state: if it was Running or Paused, then Saving is an online state, otherwise it is an offline state. This inconsistency may be removed in one of the future versions of VirtualBox by adding a new state.
- Interface ID:
{73BF04D0-7C4F-4684-9ABF-D65A9AD74343}
- Enumerator:
-
MachineState_Null |
Null value (never used by the API). |
MachineState_PoweredOff |
The machine is not running. |
MachineState_Saved |
The machine is not currently running, but the execution state of the machine has been saved to an external file when it was running. |
MachineState_Aborted |
The process running the machine has terminated abnormally. |
MachineState_Running |
The machine is currently being executed. |
MachineState_Paused |
Execution of the machine has been paused. |
MachineState_Stuck |
Execution of the machine has reached the "Guru Meditation" condition. |
MachineState_Starting |
Machine is being started after powering it on from a zero execution state. |
MachineState_Stopping |
Machine is being normally stopped powering it off, or after the guest OS has initiated a shutdown sequence. |
MachineState_Saving |
Machine is saving its execution state to a file or an online snapshot of the machine is being taken. |
MachineState_Restoring |
Execution state of the machine is being restored from a file after powering it on from the saved execution state. |
MachineState_Discarding |
Snapshot of the machine is being discarded. |
MachineState_SettingUp |
Lengthy setup operation is in progress. |
MachineState_FirstOnline |
Pseudo-state: first online state (for use in relational expressions). |
MachineState_LastOnline |
Pseudo-state: last online state (for use in relational expressions). |
MachineState_FirstTransient |
Pseudo-state: first transient state (for use in relational expressions). |
MachineState_LastTransient |
Pseudo-state: last transient state (for use in relational expressions). |