VirtualBox Main API
|
Go to the source code of this file.
Classes | |
interface | IVirtualBoxErrorInfo |
The IVirtualBoxErrorInfo interface represents extended error information. More... | |
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 | IVFSExplorer |
The VFSExplorer interface unifies access to different file system types. More... | |
interface | IAppliance |
Represents a platform-independent appliance in OVF format. More... | |
interface | IVirtualSystemDescription |
Represents one virtual system (machine) in an appliance. More... | |
interface | IInternalMachineControl |
interface | IBIOSSettings |
The IBIOSSettings interface represents BIOS settings of the virtual machine. More... | |
interface | IPCIAddress |
Address on the PCI bus. More... | |
interface | IPCIDeviceAttachment |
Information about PCI attachments. More... | |
interface | IMachine |
The IMachine interface represents a virtual machine, or guest, created in VirtualBox. More... | |
interface | IVRDEServerInfo |
Contains information about the remote desktop (VRDE) server capabilities and status. More... | |
interface | IConsole |
The IConsole interface represents an interface to control virtual machine execution. More... | |
interface | IHostNetworkInterface |
Represents 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 | IAdditionsFacility |
Structure representing a Guest Additions facility. More... | |
interface | IGuestSession |
A guest session represents one impersonated user account on the guest, so every operation will use the same credentials specified when creating the session object via IGuest::createSession. More... | |
interface | IProcess |
Abstract parent interface for processes handled by VirtualBox. More... | |
interface | IGuestProcess |
Implementation of the IProcess object for processes on the guest. More... | |
interface | IDirectory |
Abstract parent interface for directories handled by VirtualBox. More... | |
interface | IGuestDirectory |
Implementation of the IDirectory object for directories on the guest. More... | |
interface | IFile |
Abstract parent interface for files handled by VirtualBox. More... | |
interface | IGuestFile |
Implementation of the IFile object for files on the guest. More... | |
interface | IFsObjInfo |
Abstract parent interface for VirtualBox file system object information. More... | |
interface | IGuestFsObjInfo |
Represents the guest implementation of the IFsObjInfo object. More... | |
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 | IMediumAttachment |
The IMediumAttachment interface links storage media to virtual machines. More... | |
interface | IMedium |
The IMedium interface represents virtual storage for a machine's hard disks, CD/DVD or floppy drives. More... | |
interface | IMediumFormat |
The IMediumFormat interface represents a medium format. 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 | IVRDEServer |
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 client process and allows for locking virtual machines (represented by IMachine objects) to prevent conflicting changes to the machine. 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... | |
interface | INATEngine |
Interface for managing a NAT engine which is used with a virtual machine. More... | |
interface | IExtPackPlugIn |
Interface for keeping information about a plug-in that ships with an extension pack. More... | |
interface | IExtPackBase |
Interface for querying information about an extension pack as well as accessing COM objects within it. More... | |
interface | IExtPack |
Interface for querying information about an extension pack as well as accessing COM objects within it. More... | |
interface | IExtPackFile |
Extension pack file (aka tarball, .vbox-extpack) representation returned by IExtPackManager::openExtPackFile. More... | |
interface | IExtPackManager |
Interface for managing VirtualBox Extension Packs. More... | |
interface | IBandwidthGroup |
Represents one bandwidth group. More... | |
interface | IBandwidthControl |
Controls the bandwidth groups of one machine used to cap I/O done by a VM. More... | |
interface | IVirtualBoxClient |
Convenience interface for client applications. More... | |
interface | IEventSource |
Event source. More... | |
interface | IEventListener |
Event listener. More... | |
interface | IEvent |
Abstract parent interface for VirtualBox events. More... | |
interface | IReusableEvent |
Base abstract interface for all reusable events. More... | |
interface | IMachineEvent |
Base abstract interface for all machine events. More... | |
interface | IMachineStateChangedEvent |
Machine state change event. More... | |
interface | IMachineDataChangedEvent |
Any of the settings of the given machine has changed. More... | |
interface | IMediumRegisteredEvent |
The given medium was registered or unregistered within this VirtualBox installation. More... | |
interface | IMachineRegisteredEvent |
The given machine was registered or unregistered within this VirtualBox installation. More... | |
interface | ISessionStateChangedEvent |
The state of the session for the given machine was changed. More... | |
interface | IGuestPropertyChangedEvent |
Notification when a guest property has changed. More... | |
interface | ISnapshotEvent |
Base interface for all snapshot events. More... | |
interface | ISnapshotTakenEvent |
A new snapshot of the machine has been taken. More... | |
interface | ISnapshotDeletedEvent |
Snapshot of the given machine has been deleted. More... | |
interface | ISnapshotChangedEvent |
Snapshot properties (name and/or description) have been changed. More... | |
interface | IMousePointerShapeChangedEvent |
Notification when the guest mouse pointer shape has changed. More... | |
interface | IMouseCapabilityChangedEvent |
Notification when the mouse capabilities reported by the guest have changed. More... | |
interface | IKeyboardLedsChangedEvent |
Notification when the guest OS executes the KBD_CMD_SET_LEDS command to alter the state of the keyboard LEDs. More... | |
interface | IStateChangedEvent |
Notification when the execution state of the machine has changed. More... | |
interface | IAdditionsStateChangedEvent |
Notification when a Guest Additions property changes. More... | |
interface | INetworkAdapterChangedEvent |
Notification when a property of one of the virtual network adapters changes. More... | |
interface | ISerialPortChangedEvent |
Notification when a property of one of the virtual serial ports changes. More... | |
interface | IParallelPortChangedEvent |
Notification when a property of one of the virtual parallel ports changes. More... | |
interface | IStorageControllerChangedEvent |
Notification when a medium attachment changes. More... | |
interface | IMediumChangedEvent |
Notification when a medium attachment changes. More... | |
interface | IClipboardModeChangedEvent |
Notification when the shared clipboard mode changes. More... | |
interface | IDragAndDropModeChangedEvent |
Notification when the drag'n'drop mode changes. More... | |
interface | ICPUChangedEvent |
Notification when a CPU changes. More... | |
interface | ICPUExecutionCapChangedEvent |
Notification when the CPU execution cap changes. More... | |
interface | IGuestKeyboardEvent |
Notification when guest keyboard event happens. More... | |
interface | IGuestMouseEvent |
Notification when guest mouse event happens. More... | |
interface | IVRDEServerChangedEvent |
Notification when a property of the VRDE server changes. More... | |
interface | IVRDEServerInfoChangedEvent |
Notification when the status of the VRDE server changes. More... | |
interface | IUSBControllerChangedEvent |
Notification when a property of the virtual USB controller changes. More... | |
interface | IUSBDeviceStateChangedEvent |
Notification when a USB device is attached to or detached from the virtual USB controller. More... | |
interface | ISharedFolderChangedEvent |
Notification when a shared folder is added or removed. More... | |
interface | IRuntimeErrorEvent |
Notification when an error happens during the virtual machine execution. More... | |
interface | IEventSourceChangedEvent |
Notification when an event source state changes (listener added or removed). More... | |
interface | IExtraDataChangedEvent |
Notification when machine specific or global extra data has changed. More... | |
interface | IVetoEvent |
Base abstract interface for veto events. More... | |
interface | IExtraDataCanChangeEvent |
Notification when someone tries to change extra data for either the given machine or (if null ) global extra data. More... | |
interface | ICanShowWindowEvent |
Notification when a call to IMachine::canShowConsoleWindow is made by a front-end to check if a subsequent call to IMachine::showConsoleWindow can succeed. More... | |
interface | IShowWindowEvent |
Notification when a call to IMachine::showConsoleWindow requests the console window to be activated and brought to foreground on the desktop of the host PC. More... | |
interface | INATRedirectEvent |
Notification when NAT redirect rule added or removed. More... | |
interface | IHostPCIDevicePlugEvent |
Notification when host PCI device is plugged/unplugged. More... | |
interface | IVBoxSVCAvailabilityChangedEvent |
Notification when VBoxSVC becomes unavailable (due to a crash or similar unexpected circumstances) or available again. More... | |
interface | IBandwidthGroupChangedEvent |
Notification when one of the bandwidth groups changed. More... | |
interface | IGuestMonitorChangedEvent |
Notification when the guest enables one of its monitors. More... | |
interface | IStorageDeviceChangedEvent |
Notification when a storage device is attached or removed. 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. |
enum SettingsVersion |
Settings version of VirtualBox settings files.
This is written to the "version" attribute of the root "VirtualBox" element in the settings file XML and indicates which VirtualBox version wrote the file.
{52BD6F5F-1ADB-4493-975D-581A9C4B803F}
enum AccessMode |
enum MachineState |
Virtual machine execution state.
This enumeration represents possible values of the @link IMachine::state IMachine::state@endlink<b></b> 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. <pre> +---------[powerDown()] <- Stuck <--[failure]-+ V | +-> PoweredOff --+-->[powerUp()]--> Starting --+ | +-----[resume()]-----+ | | | | V | | Aborted -----+ +--> Running --[pause()]--> Paused | | ^ | ^ | | Saved -----------[powerUp()]--> Restoring -+ | | | | | ^ | | | | | | +-----------------------------------------+-|-------------------+ + | | | | | | | +-- Saving <--------[takeSnapshot()]<-------+---------------------+ | | | | | +-------- Saving <--------[saveState()]<----------+---------------------+ | | | +-------------- Stopping -------[powerDown()]<----------+---------------------+ </pre> Note that states to the right from PoweredOff, Aborted and Saved in the above diagram are called <i>online VM states</i>. 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: <pre> if (machine.GetState() >= MachineState_FirstOnline && machine.GetState() <= MachineState_LastOnline) { ...the machine is being executed... } </pre> 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 other setting or perform a modifying operation during this time will result in the @c 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 <i>too-many-traps</i> 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 <i>offline VM states</i> (this includes PoweredOff, Aborted and Saved too). The first diagram shows what happens when a lengthy setup operation is being executed (such as @link IMachine::attachDevice IMachine::attachDevice@endlink<b></b>). <pre> +----------------------------------(same state as before the call)------+ | | +-> PoweredOff --+ | | | | |-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+ | | +-> Saved -------+ </pre> The next two diagrams demonstrate the process of taking a snapshot of a powered off virtual machine, restoring the state to that as of a snapshot or deleting a snapshot, respectively. <pre> +----------------------------------(same state as before the call)------+ | | +-> PoweredOff --+ | | +-->[takeSnapshot()] -------------------> Saving ------+ +-> Aborted -----+ +-> PoweredOff --+ | | | Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+ | | [deleteSnapshot() ]-------> DeletingSnapshot --+ +-> Saved -------+ | | | +---(Saved if restored from an online snapshot, PoweredOff otherwise)---+ </pre> 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.
{EC6C6A9E-113D-4FF4-B44F-0B69F21C97FE}
enum SessionState |
Session state.
This enumeration represents possible values of IMachine::sessionState and ISession::state attributes.
{CF2700C0-EA4B-47AE-9725-7810114B94D8}
SessionState_Null |
Null value (never used by the API). |
SessionState_Unlocked |
In IMachine::sessionState, this means that the machine is not locked for any sessions. In ISession::state, this means that no machine is currently locked for this session. |
SessionState_Locked |
In IMachine::sessionState, this means that the machine is currently locked for a session, whose process identifier can then be found in the IMachine::sessionPID attribute. In ISession::state, this means that a machine is currently locked for this session, and the mutable machine object can be found in the ISession::machine attribute (see IMachine::lockMachine for details). |
SessionState_Spawning |
A new process is being spawned for the machine as a result of IMachine::launchVMProcess call. This state also occurs as a short transient state during an IMachine::lockMachine call. |
SessionState_Unlocking |
The session is being unlocked. |
enum CPUPropertyType |
Virtual CPU property type.
This enumeration represents possible values of the IMachine get- and setCPUProperty methods.
{24D356A6-2F45-4ABD-B977-1CBE9C4701F5}
enum HWVirtExPropertyType |
Hardware virtualization property type.
This enumeration represents possible values for the IMachine::getHWVirtExProperty and IMachine::setHWVirtExProperty methods.
{CE81DFDD-D2B8-4A90-BBEA-40EE8B7FFCEE}
enum FaultToleranceState |
Used with IMachine::faultToleranceState.
{5124F7EC-6B67-493C-9DEE-EE45A44114E1}
enum LockType |
Used with IMachine::lockMachine.
{168A6A8E-12FD-4878-A1F9-38A750A56089}
enum SessionType |
Session type.
This enumeration represents possible values of the ISession::type attribute.
{A13C02CB-0C2C-421E-8317-AC0E8AAA153A}
SessionType_Null |
Null value (never used by the API). |
SessionType_WriteLock |
Session has acquired an exclusive write lock on a machine using IMachine::lockMachine. |
SessionType_Remote |
Session has launched a VM process using IMachine::launchVMProcess |
SessionType_Shared |
Session has obtained a link to another session using IMachine::lockMachine |
enum DeviceType |
Device type.
{6D9420F7-0B56-4636-99F9-7346F1B01E57}
DeviceType_Null |
Null value, may also mean "no device" (not allowed for IConsole::getDeviceActivity). |
DeviceType_Floppy |
Floppy device. |
DeviceType_DVD |
CD/DVD-ROM device. |
DeviceType_HardDisk |
Hard disk device. |
DeviceType_Network |
Network device. |
DeviceType_USB |
USB device. |
DeviceType_SharedFolder |
Shared folder device. |
enum DeviceActivity |
Device activity for IConsole::getDeviceActivity.
{6FC8AEAA-130A-4EB5-8954-3F921422D707}
enum ClipboardMode |
enum DragAndDropMode |
enum Scope |
enum BIOSBootMenuMode |
enum ProcessorFeature |
enum FirmwareType |
Firmware type.
{B903F264-C230-483E-AC74-2B37CE60D371}
enum PointingHIDType |
Type of pointing device used in a virtual machine.
{E44B2F7B-72BA-44FB-9E53-2186014F0D17}
enum KeyboardHIDType |
Type of keyboard device used in a virtual machine.
{383E43D7-5C7C-4EC8-9CB8-EDA1BCCD6699}
enum VFSType |
enum VFSFileType |
enum ImportOptions |
Import options, used with IAppliance::importMachines.
{0A981523-3B20-4004-8EE3-DFD322202ACE}
Used with IVirtualSystemDescription to describe the type of a configuration value.
{303C0900-A746-4612-8C67-79003E91F459}
Used with IVirtualSystemDescription::getValuesByType to describe the value type to fetch.
{56D9403F-3425-4118-9919-36F2A9B8C77C}
enum CleanupMode |
Cleanup mode, used with IMachine::unregister.
{67897C50-7CCA-47A9-83F6-CE8FD8EB5441}
enum CloneMode |
Clone mode, used with IMachine::cloneTo.
{A7A159FE-5096-4B8D-8C3C-D033CB0B35A8}
enum CloneOptions |
Clone options, used with IMachine::cloneTo.
{22243F8E-96AB-497C-8CF0-F40A566C630B}
enum AutostopType |
Autostop types, used with IMachine::autostopType.
{6BB96740-CF34-470D-AAB2-2CD48EA2E10E}
Type of encapsulation.
Ethernet encapsulation includes both wired and wireless Ethernet connections.
{1AA54AAF-2497-45A2-BFB1-8EB225E93D5B}
Current status of the interface.
{CC474A69-2710-434B-8D99-C38E5D5A6F41}
Guest Additions facility IDs.
{98F7F957-89FB-49B6-A3B1-31E3285EB1D8}
Guest Additions facility classes.
{446451B2-C88D-4E5D-84C9-91BC7F533F5F}
Guest Additions facility states.
{CE06F9E1-394E-4FE9-9368-5A88C567DBDE}
Guest Additions run level type.
{A25417EE-A9DD-4F5B-B0DC-377860087754}
enum AdditionsUpdateFlag |
Guest Additions update flags.
{726A818D-18D6-4389-94E8-3E9E6826171A}
enum FileSeekType |
enum ProcessInputFlag |
enum ProcessOutputFlag |
enum ProcessWaitForFlag |
Process waiting flags.
Multiple flags can be combined.
{23B550C7-78E1-437E-98F0-65FD9757BCD2}
enum ProcessWaitResult |
Process waiting results.
Depending on the process waiting flags (for more information see ProcessWaitForFlag) the waiting result can vary based on the processes' current status.
To wait for a gust process to terminate after it has been created by IGuestSession::processCreate or IGuestSession::processCreateEx one would specify ProcessWaitResult_Terminate.
If a guest process has been started with ProcessCreateFlag_WaitForStdOut a client can wait with ProcessWaitResult_StdOut for new data to arrive on stdout; same applies for ProcessCreateFlag_WaitForStdErr and ProcessWaitResult_StdErr.
{40719CBE-F192-4FE9-A231-6697B3C8E2B4}
ProcessWaitResult_None |
No result was returned. Not being used. |
ProcessWaitResult_Start |
The process has been started. |
ProcessWaitResult_Terminate |
The process has been terminated. |
ProcessWaitResult_Status |
The process has changed its status. The status then can be retrieved via IProcess::status. |
ProcessWaitResult_Error |
Error while executing the process. |
ProcessWaitResult_Timeout |
The waiting operation timed out. This also will happen when no event has been occured matching the current waiting flags in a IProcess::waitFor call. |
ProcessWaitResult_StdIn |
The process signalled that stdin became available for writing and that the process awaits input now. |
ProcessWaitResult_StdOut |
Data on stdout became available for reading. |
ProcessWaitResult_StdErr |
Data on stderr became available for reading. |
ProcessWaitResult_WaitFlagNotSupported |
A waiting flag specified in the IProcess::waitFor call is not supported by the guest. |
enum CopyFileFlag |
File copying flags.
{23F79FDF-738A-493D-B80B-42D607C9B916}
enum DirectoryCreateFlag |
Directory recursive removement flags.
{455AABF0-7692-48F6-9061-F21579B65769}
enum PathRenameFlag |
Path renaming flags.
{F3BAA09F-C758-453D-B91C-C7787D76351D}
enum ProcessCreateFlag |
Guest process execution flags.
{35192799-BFDE-405D-9BEA-C735AB9998E4}
enum ProcessPriority |
enum SymlinkType |
enum SymlinkReadFlag |
enum ProcessStatus |
Process execution statuses.
{4D52368F-5B48-4BFE-B486-ACF89139B52F}
enum FsObjType |
File system object type.
{A1ED437C-B3C3-4CA2-B19C-4239D658D5E8}
enum DragAndDropAction |
Possible actions within an Drag and Drop operation.
{47F3B162-C107-4FCD-BFA7-54B8135C441E}
enum DirectoryOpenFlag |
enum MediumState |
Virtual medium state.
{EF41E980-E012-43CD-9DEA-479D4EF14D13}
MediumState_NotCreated |
Associated medium storage does not exist (either was not created yet or was deleted). |
MediumState_Created |
Associated storage exists and accessible; this gets set if the accessibility check performed by IMedium::refreshState was successful. |
MediumState_LockedRead |
Medium is locked for reading (see IMedium::lockRead), no data modification is possible. |
MediumState_LockedWrite |
Medium is locked for writing (see IMedium::lockWrite), no concurrent data reading or modification is possible. |
MediumState_Inaccessible |
Medium accessibility check (see IMedium::refreshState) has not yet been performed, or else, associated medium storage is not accessible. In the first case, IMedium::lastAccessError is empty, in the second case, it describes the error that occurred. |
MediumState_Creating |
Associated medium storage is being created. |
MediumState_Deleting |
Associated medium storage is being deleted. |
enum MediumType |
Virtual medium type.
For each IMedium, this defines how the medium is attached to a virtual machine (see IMediumAttachment) and what happens when a snapshot (see ISnapshot) is taken of a virtual machine which has the medium attached. At the moment DVD and floppy media are always of type "writethrough".
{FE663FB5-C244-4E1B-9D81-C628B417DD04}
enum MediumVariant |
Virtual medium image variant.
More than one flag may be set.
{80685B6B-E42F-497D-8271-E77BF3C61ADA}
enum DataType |
enum DataFlags |
Medium format capability flags.
{7342BA79-7CE0-4D94-8F86-5ED5A185D9BD}
MediumFormatCapabilities_Uuid |
Supports UUIDs as expected by VirtualBox code. |
MediumFormatCapabilities_CreateFixed |
Supports creating fixed size images, allocating all space instantly. |
MediumFormatCapabilities_CreateDynamic |
Supports creating dynamically growing images, allocating space on demand. |
MediumFormatCapabilities_CreateSplit2G |
Supports creating images split in chunks of a bit less than 2 GBytes. |
MediumFormatCapabilities_Differencing |
Supports being used as a format for differencing media (see IMedium::createDiffStorage). |
MediumFormatCapabilities_Asynchronous |
Supports asynchronous I/O operations for at least some configurations. |
MediumFormatCapabilities_File |
The format backend operates on files (the IMedium::location attribute of the medium specifies a file used to store medium data; for a list of supported file extensions see IMediumFormat::describeFileExtensions). |
MediumFormatCapabilities_Properties |
The format backend uses the property interface to configure the storage location and properties (the IMediumFormat::describeProperties method is used to get access to properties supported by the given medium format). |
MediumFormatCapabilities_TcpNetworking |
The format backend uses the TCP networking interface for network access. |
MediumFormatCapabilities_VFS |
The format backend supports virtual filesystem functionality. |
MediumFormatCapabilities_CapabilityMask |
enum MouseButtonState |
Mouse button state.
{9EE094B8-B28A-4D56-A166-973CB588D7F8}
Format of the video memory buffer.
Constants represented by this enum can be used to test for particular values of IFramebuffer::pixelFormat. See also IFramebuffer::requestResize.
See also www.fourcc.org for more information about FOURCC pixel formats.
{7ACFD5ED-29E3-45E3-8136-73C9224F3D2D}
FramebufferPixelFormat_Opaque |
Unknown buffer format (the user may not assume any particular format of the buffer). |
FramebufferPixelFormat_FOURCC_RGB |
Basic RGB format (IFramebuffer::bitsPerPixel determines the bit layout). |
Network attachment type.
{2AC4BC71-6B82-417A-ACD1-F7426D2570D6}
enum NetworkAdapterType |
Network adapter type.
{3C2281E4-D952-4E87-8C7D-24379CB6A81C}
The promiscuous mode policy of an interface.
{C963768A-376F-4C85-8D84-D8CED4B7269E}
enum PortMode |
The PortMode enumeration represents possible communication modes for the virtual serial port device.
{533B5FE3-0185-4197-86A7-17E37DD39D76}
enum USBDeviceState |
USB device state.
This enumeration represents all possible states of the USB device physically attached to the host computer regarding its state on the host computer and availability to guest computers (all currently running virtual machines).
Once a supported USB device is attached to the host, global USB filters (IHost::USBDeviceFilters) are activated. They can either ignore the device, or put it to USBDeviceState_Held state, or do nothing. Unless the device is ignored by global filters, filters of all currently running guests (IUSBController::deviceFilters) are activated that can put it to USBDeviceState_Captured state.
If the device was ignored by global filters, or didn't match any filters at all (including guest ones), it is handled by the host in a normal way. In this case, the device state is determined by the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy or USBDeviceState_Available, depending on the current device usage.
Besides auto-capturing based on filters, the device can be manually captured by guests (IConsole::attachUSBDevice) if its state is USBDeviceState_Busy, USBDeviceState_Available or USBDeviceState_Held.
{B99A2E65-67FB-4882-82FD-F3E5E8193AB4}
Actions for host USB device filters.
{CBC30A49-2F4E-43B5-9DA6-121320475933}
enum AudioDriverType |
Host audio driver type.
{4BCC3D73-C2FE-40DB-B72F-0C2CA9D68496}
enum AudioControllerType |
enum AuthType |
enum Reason |
Internal event reason type.
{E7E8E097-299D-4E98-8BBC-C31C2D47D0CC}
enum StorageBus |
The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy); see IStorageController::bus.
{EEE67AB3-668D-4EF5-91E0-7025FE4A0D7A}
The exact variant of storage controller hardware presented to the guest; see IStorageController::controllerType.
{8A412B8A-F43E-4456-BD37-B474F0879A58}
enum ChipsetType |
enum NATAliasMode |
enum NATProtocol |
enum BandwidthGroupType |
enum VBoxEventType |
Type of an event.
See @link ::IEvent IEvent@endlink<b></b> for an introduction to VirtualBox event handling.
{0D67E79E-B7B1-4919-AAB3-B36866075515}
VBoxEventType_Invalid |
Invalid event, must be first. |
VBoxEventType_Any |
Wildcard for all events. Events of this type are never delivered, and only used in IEventSource::registerListener call to simplify registration. |
VBoxEventType_Vetoable |
Wildcard for all vetoable events. Events of this type are never delivered, and only used in IEventSource::registerListener call to simplify registration. |
VBoxEventType_MachineEvent |
Wildcard for all machine events. Events of this type are never delivered, and only used in IEventSource::registerListener call to simplify registration. |
VBoxEventType_SnapshotEvent |
Wildcard for all snapshot events. Events of this type are never delivered, and only used in IEventSource::registerListener call to simplify registration. |
VBoxEventType_InputEvent |
Wildcard for all input device (keyboard, mouse) events. Events of this type are never delivered, and only used in IEventSource::registerListener call to simplify registration. |
VBoxEventType_LastWildcard |
Last wildcard. |
VBoxEventType_OnMachineStateChanged | |
VBoxEventType_OnMachineDataChanged | |
VBoxEventType_OnExtraDataChanged | |
VBoxEventType_OnExtraDataCanChange | |
VBoxEventType_OnMediumRegistered | |
VBoxEventType_OnMachineRegistered | |
VBoxEventType_OnSessionStateChanged | |
VBoxEventType_OnSnapshotTaken |
See ISnapshotTakenEvent. |
VBoxEventType_OnSnapshotDeleted | |
VBoxEventType_OnSnapshotChanged | |
VBoxEventType_OnGuestPropertyChanged | |
VBoxEventType_OnMousePointerShapeChanged | |
VBoxEventType_OnMouseCapabilityChanged | |
VBoxEventType_OnKeyboardLedsChanged | |
VBoxEventType_OnStateChanged |
See IStateChangedEvent. |
VBoxEventType_OnAdditionsStateChanged | |
VBoxEventType_OnNetworkAdapterChanged | |
VBoxEventType_OnSerialPortChanged | |
VBoxEventType_OnParallelPortChanged | |
VBoxEventType_OnStorageControllerChanged | |
VBoxEventType_OnMediumChanged |
See IMediumChangedEvent. |
VBoxEventType_OnVRDEServerChanged | |
VBoxEventType_OnUSBControllerChanged | |
VBoxEventType_OnUSBDeviceStateChanged | |
VBoxEventType_OnSharedFolderChanged | |
VBoxEventType_OnRuntimeError |
See IRuntimeErrorEvent. |
VBoxEventType_OnCanShowWindow |
See ICanShowWindowEvent. |
VBoxEventType_OnShowWindow |
See IShowWindowEvent. |
VBoxEventType_OnCPUChanged |
See ICPUChangedEvent. |
VBoxEventType_OnVRDEServerInfoChanged | |
VBoxEventType_OnEventSourceChanged | |
VBoxEventType_OnCPUExecutionCapChanged | |
VBoxEventType_OnGuestKeyboard |
See IGuestKeyboardEvent. |
VBoxEventType_OnGuestMouse |
See IGuestMouseEvent. |
VBoxEventType_OnNATRedirect |
See INATRedirectEvent. |
VBoxEventType_OnHostPCIDevicePlug | |
VBoxEventType_OnVBoxSVCAvailabilityChanged | |
VBoxEventType_OnBandwidthGroupChanged | |
VBoxEventType_OnGuestMonitorChanged | |
VBoxEventType_OnStorageDeviceChanged | |
VBoxEventType_OnClipboardModeChanged | |
VBoxEventType_OnDragAndDropModeChanged | |
VBoxEventType_Last |
Must be last event, used for iterations and structures relying on numerical event values. |
How the guest monitor has been changed.
{EF172985-7E36-4297-95BE-E46396968D66}