VirtualBox Main API

Class List
Here are the classes, structs, unions and interfaces with brief descriptions:

C IAdditionsFacility | Structure representing a Guest Additions facility
C IAdditionsStateChangedEvent | Notification when a Guest Additions property changes
C IAppliance | Represents a platform-independent appliance in OVF format
C IAudioAdapter | Virtual audio adapter of the virtual machine
C IAudioAdapterChangedEvent | Notification when a property of the audio adapter changes
C IAudioSettings | Audio settings for a virtual machine
C IBandwidthControl | Controls the bandwidth groups of one machine used to cap I/O done by a VM
C IBandwidthGroup | Represents one bandwidth group
C IBandwidthGroupChangedEvent | Notification when one of the bandwidth groups changed
C IBooleanFormValue |
C 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
C ICertificate | X.509 certificate details
C IChoiceFormValue |
C IClipboardErrorEvent | Notification when a clipboard error occurred
C IClipboardEvent | Abstract base interface for clipboard events
C IClipboardFileTransferModeChangedEvent | Notification when the shared clipboard file transfer mode changes
C IClipboardModeChangedEvent | Notification when the shared clipboard mode changes
C ICloudClient |
C ICloudMachine | Virtual virtual machine (sic) in the cloud
C ICloudNetwork |
C ICloudNetworkEnvironmentInfo |
C ICloudNetworkGatewayInfo |
C ICloudProfile |
C ICloudProfileChangedEvent |
C ICloudProfileRegisteredEvent |
C ICloudProvider |
C ICloudProviderListChangedEvent | Each individual provider that is installed or uninstalled is reported as an ICloudProviderRegisteredEvent
C ICloudProviderManager |
C ICloudProviderRegisteredEvent | A cloud provider was installed or uninstalled
C ICloudProviderUninstallEvent | A cloud provider is about to be uninstalled
C IConsole | Interface to control virtual machine execution
C ICPUChangedEvent | Notification when a CPU changes
C ICPUExecutionCapChangedEvent | Notification when the CPU execution cap changes
C ICPUProfile | CPU profile
C ICursorPositionChangedEvent | The guest reports cursor position data
C IDataStream | Used to retrieve a data stream
C IDHCPConfig | The DHCP server has several configuration levels: global, group and individual MAC
C IDHCPGlobalConfig | The global DHCP server configuration, see IDHCPServer::globalConfig
C IDHCPGroupCondition |
C IDHCPGroupConfig | A configuration that applies to a group of NICs
C IDHCPIndividualConfig | Configuration for a single NIC, either given directly by MAC address or by VM + adaptor slot number
C IDHCPServer | VirtualBox DHCP server configuration
C IDirectory | Abstract parent interface for directories handled by VirtualBox
C IDisplay | Virtual machine's display
C IDisplaySourceBitmap |
C IDnDBase | Base abstract interface for drag'n drop
C IDnDModeChangedEvent | Notification when the drag'n drop mode changes
C IDnDSource | Abstract interface for handling drag'n drop sources
C IDnDTarget | Abstract interface for handling drag'n drop targets
C IEmulatedUSB | Manages emulated USB devices
C IEvent | Abstract parent interface for VirtualBox events
C IEventListener | Event listener
C IEventSource | Event source
C IEventSourceChangedEvent | Notification when an event source state changes (listener added or removed)
C IExtPack | Interface for querying information about an extension pack as well as accessing COM objects within it
C IExtPackBase | Interface for querying information about an extension pack as well as accessing COM objects within it
C IExtPackFile | Extension pack file (aka tarball, .vbox-extpack) representation returned by IExtPackManager::openExtPackFile
C IExtPackInstalledEvent | Extension pack installed event
C IExtPackManager | Interface for managing VirtualBox Extension Packs
C IExtPackPlugIn | Interface for keeping information about a plug-in that ships with an extension pack
C IExtPackUninstalledEvent | Extension pack uninstalled event
C IExtraDataCanChangeEvent | Notification when someone tries to change extra data for either the given machine or (if `null`) global extra data
C IExtraDataChangedEvent | Notification when machine specific or global extra data has changed
C IFile | Abstract parent interface for files handled by VirtualBox
C IFirmwareSettings | Firmware settings of the virtual machine
C IForm |
C IFormValue |
C IFramebuffer |
C IFramebufferOverlay | Alpha blended overlay for displaying status icons above an IFramebuffer
C IFsInfo | Abstract parent interface for VirtualBox file system information
C IFsObjInfo | Abstract parent interface for VirtualBox file system object information
C IGraphicsAdapter | Graphics adapter of the virtual machine
C IGuest | Information about the operating system running inside the virtual machine
C IGuestAdditionsStatusChangedEvent | The guest addition status changed
C IGuestDebugControl | Controls the guest debug settings of one virtual machine
C IGuestDebugControlChangedEvent | Notification when a property of the guest debug settings changes
C IGuestDirectory | Implementation of the IDirectory object for directories in the guest
C IGuestDirectoryEvent | Base abstract interface for all guest directory events
C IGuestDirectoryReadEvent | Notification when a directory entry has been read
C IGuestDirectoryRegisteredEvent | Notification when a guest directory was registered or unregistered
C IGuestDirectoryStateChangedEvent | Notification when a guest directory changed its state
C IGuestDnDSource | Implementation of the IDnDSource object for source drag'n drop operations on the guest
C IGuestDnDTarget | Implementation of the IDnDTarget object for target drag'n drop operations on the guest
C IGuestFile | Implementation of the IFile object for files in the guest
C IGuestFileEvent | Base abstract interface for all guest file events
C IGuestFileIOEvent | Base abstract interface for all guest file input/output (IO) events
C IGuestFileOffsetChangedEvent | Notification when a guest file changed its current offset via IFile::seek
C IGuestFileReadEvent | Notification when data has been read from a guest file
C IGuestFileRegisteredEvent | Notification when a guest file was registered or unregistered
C IGuestFileSizeChangedEvent | Notification when a guest file changed its size via IFile::setSize
C IGuestFileStateChangedEvent | Notification when a guest file changed its state
C IGuestFileWriteEvent | Notification when data has been written to a guest file
C IGuestFsInfo | Represents the guest implementation of the IFsInfo object
C IGuestFsObjInfo | Represents the guest implementation of the IFsObjInfo object
C IGuestKeyboardEvent | Notification when guest keyboard event happens
C IGuestMonitorChangedEvent | Notification when the guest enables one of its monitors
C IGuestMonitorInfoChangedEvent | The guest reports cursor position data
C IGuestMouseEvent | Notification when guest mouse event happens
C IGuestMultiTouchEvent | Notification when guest touch screen event happens
C IGuestOSType | Specifies a guest OS type and its recommendations
C IGuestProcess | Implementation of the IProcess object for processes the host has started in the guest
C IGuestProcessEvent | Base abstract interface for all guest process events
C IGuestProcessInputNotifyEvent | Notification when a guest process' stdin became available
C IGuestProcessIOEvent | Base abstract interface for all guest process input/output (IO) events
C IGuestProcessOutputEvent | Notification when there is guest process output available for reading
C IGuestProcessRegisteredEvent | Notification when a guest process was registered or unregistered
C IGuestProcessStateChangedEvent | Notification when a guest process changed its state
C IGuestPropertyChangedEvent | Notification when a guest property has changed
C IGuestScreenInfo |
C IGuestSession | A guest session represents one impersonated user account in the guest, so every operation will use the same credentials specified when creating the session object via IGuest::createSession
C IGuestSessionEvent | Base abstract interface for all guest session events
C IGuestSessionRegisteredEvent | Notification when a guest session was registered or unregistered
C IGuestSessionStateChangedEvent | Notification when a guest session changed its state
C IGuestUserStateChangedEvent | Notification when a guest user changed its state
C IHost | Physical machine that this VirtualBox installation runs on
C IHostAudioDevice | Represents an audio device provided by the host OS
C IHostAudioDeviceChangedEvent | Notification when a host audio device state has changed
C IHostDrive | Drive of the physical machine
C IHostDrivePartition | Partition of the host drive
C IHostNameResolutionConfigurationChangeEvent |
C IHostNetworkInterface | Represents one of host's network interfaces
C IHostOnlyNetwork |
C IHostPCIDevicePlugEvent | Notification when host PCI device is plugged/unplugged
C IHostUpdateAgent | Implementation of the IUpdateAgent object for VirtualBox host updates
C IHostUSBDevice | Physical USB device attached to the host computer
C IHostUSBDeviceFilter | Global filter for a physical USB device used by the host computer
C IHostVideoInputDevice | Represents one of host's video capture devices, for example a webcam
C IHostX86 | The x86-specific interface for the physical host machine
C IInternalMachineControl |
C IInternalProgressControl |
C IInternalSessionControl |
C IKeyboard | Virtual machine's keyboard
C IKeyboardLedsChangedEvent | Notification when the guest OS executes the KBD_CMD_SET_LEDS command to alter the state of the keyboard LEDs
C ILanguageChangedEvent |
C IMachine | Virtual machine, or guest, created in VirtualBox
C IMachineDataChangedEvent | Any of the settings of the given machine has changed
C IMachineDebugger |
C IMachineEvent | Base abstract interface for all machine events
C IMachineGroupsChangedEvent | The groups of the machine have changed
C IMachineRegisteredEvent | The given machine was registered or unregistered within this VirtualBox installation
C IMachineStateChangedEvent | Machine state change event
C IManagedObjectRef | Managed object reference
C IMedium | Virtual storage for a machine's hard disks, CD/DVD or floppy drives
C IMediumAttachment | Links storage media to virtual machines
C IMediumChangedEvent | Notification when a medium attachment changes
C IMediumConfigChangedEvent | The configuration of the given medium was changed (location, properties, child/parent or anything else)
C IMediumFormat | Medium format
C IMediumIO | Used to access and modify the content of a medium
C IMediumRegisteredEvent | The given medium was registered or unregistered within this VirtualBox installation
C IMouse | Virtual machine's mouse
C IMouseCapabilityChangedEvent | Notification when the mouse capabilities reported by the guest have changed
C IMousePointerShape | The guest mouse pointer description
C IMousePointerShapeChangedEvent | Notification when the guest mouse pointer shape has changed
C INATEngine | Interface for managing a NAT engine which is used with a virtual machine
C INATNetwork |
C INATNetworkAlterEvent |
C INATNetworkChangedEvent |
C INATNetworkCreationDeletionEvent |
C INATNetworkPortForwardEvent |
C INATNetworkSettingEvent |
C INATNetworkStartStopEvent |
C INATRedirectEvent | Notification when NAT redirect rule added or removed
C INetworkAdapter | Represents a virtual network adapter that is attached to a virtual machine
C INetworkAdapterChangedEvent | Notification when a property of one of the virtual network adapters changes
C INvramStore | Provides access to the NVRAM store collecting all permanent states from different sources (UEFI, TPM, etc.)
C IParallelPort | Virtual parallel port device
C IParallelPortChangedEvent | Notification when a property of one of the virtual parallel ports changes
C IPCIAddress | Address on the PCI bus
C IPCIDeviceAttachment | Information about PCI attachments
C IPerformanceCollector | Service that collects and stores performance metrics data
C IPerformanceMetric | Parameters of the given performance metric
C IPlatform | Platform object for a virtual machine
C IPlatformARM | The ARM-specific platform properties for a virtual machine
C IPlatformProperties | Properties of a specific virtualization platform
C IPlatformX86 | The x86 specific platform properties for a virtual machine
C IProcess | Abstract parent interface for processes handled by VirtualBox
C IProgress | Used to track and control asynchronous tasks within VirtualBox
C IProgressCreatedEvent | Notification of a new progress object creation/deletion
C IProgressEvent | Base abstract interface for all progress events
C IProgressPercentageChangedEvent | Progress state change event
C IProgressTaskCompletedEvent | Progress task completion event
C IRangedInteger64FormValue |
C IRangedIntegerFormValue |
C IRecordingScreenSettings | Recording settings of a single virtual screen
C IRecordingScreenStateChangedEvent | Notification when a screen recording state has changed
C IRecordingSettings | Recording settings of the virtual machine
C IRecordingStateChangedEvent | Notification when the machine's recording state has changed
C IResourceStore | Provides access to resources accessed by various device implementations and created when the VM is started (only the FDT currently)
C IReusableEvent | Base abstract interface for all reusable events
C IRuntimeErrorEvent | Notification when an error happens during the virtual machine execution
C ISerialPort | Virtual serial port device
C ISerialPortChangedEvent | Notification when a property of one of the virtual serial ports changes
C ISession | Client process and allows for locking virtual machines (represented by IMachine objects) to prevent conflicting changes to the machine
C ISessionStateChangedEvent | The state of the session for the given machine was changed
C ISharedFolder | Folder in the host computer's file system accessible from the guest OS running inside a virtual machine using an associated logical name
C ISharedFolderChangedEvent | Notification when a shared folder is added or removed
C 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
C ISnapshot | Snapshot of the virtual machine
C ISnapshotChangedEvent | Snapshot properties (name and/or description) have been changed
C ISnapshotDeletedEvent | Snapshot of the given machine has been deleted
C ISnapshotEvent | Base interface for all snapshot events
C ISnapshotRestoredEvent | Snapshot of the given machine has been restored
C ISnapshotTakenEvent | A new snapshot of the machine has been taken
C IStateChangedEvent | Notification when the execution state of the machine has changed
C IStorageController | Represents a storage controller that is attached to a virtual machine (IMachine)
C IStorageControllerChangedEvent | Notification when a storage controllers changes
C IStorageDeviceChangedEvent | Notification when a storage device is attached or removed
C IStringArray | When you need to return an array of strings asynchronously (under a progress) you cannot use by-value out parameter `type="wstring" safearray="yes" dir="out"`, hence this wrapper
C IStringFormValue |
C ISystemProperties | Global properties of the given VirtualBox installation
C IToken | Token passed to an API client, which triggers cleanup actions when it is explicitly released by calling the abandon method (preferred, as it is accurately defined when the release happens), or when the object reference count drops to 0
C ITrustedPlatformModule | Settings of the virtual machine's trusted platform module
C IUefiVariableStore | Allows inspecting and manipulating the content of an existing UEFI variable store in a NVRAM file
C IUnattended | Pipeline for preparing the Guest OS for fully automated install
C IUpdateAgent | Abstract parent interface for handling updateable software components
C IUpdateAgentAvailableEvent | Notification when an update is available
C IUpdateAgentErrorEvent | Notification when an update agent error occurred
C IUpdateAgentEvent | Abstract base interface for update agent events
C IUpdateAgentSettingsChangedEvent | Notification when update agent settings have been changed
C IUpdateAgentStateChangedEvent | Notification when an update agent state has been changed
C IUSBController |
C IUSBControllerChangedEvent | Notification when a property of the virtual USB controllers changes
C IUSBDevice | Virtual USB device attached to the virtual machine
C IUSBDeviceFilter | USB device filter used to perform actions on one or more USB devices
C IUSBDeviceFilters |
C IUSBDeviceStateChangedEvent | Notification when a USB device is attached to or detached from the virtual USB controller
C IUSBProxyBackend | The USBProxyBackend interface represents a source for USB devices available to the host for attaching to the VM
C IVBoxSVCAvailabilityChangedEvent | Notification when VBoxSVC becomes unavailable (due to a crash or similar unexpected circumstances) or available again
C IVBoxSVCRegistration | Implemented by the VirtualBox class factory and registered with VBoxSDS so it can retrieve IVirtualBox on behalf of other VBoxSVCs
C IVetoEvent | Base abstract interface for veto events
C IVFSExplorer | The VFSExplorer interface unifies access to different file system types
C IVirtualBox | Main interface exposed by the product that provides virtual machine management
C IVirtualBoxClient | Convenience interface for client applications
C IVirtualBoxErrorInfo | Extended error information
C IVirtualBoxSDS | System-wide directory service helper
C IVirtualSystemDescription | Represents one virtual system (machine) in an appliance
C IVirtualSystemDescriptionForm |
C IVRDEServer |
C IVRDEServerChangedEvent | Notification when a property of the VRDE server changes
C IVRDEServerInfo | Contains information about the remote desktop (VRDE) server capabilities and status
C IVRDEServerInfoChangedEvent | Notification when the status of the VRDE server changes
C IWebsessionManager | Websession manager