00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00130 const HRESULT VBOX_E_OBJECT_NOT_FOUND = 0x80BB0001;
00138 const HRESULT VBOX_E_INVALID_VM_STATE = 0x80BB0002;
00146 const HRESULT VBOX_E_VM_ERROR = 0x80BB0003;
00154 const HRESULT VBOX_E_FILE_ERROR = 0x80BB0004;
00162 const HRESULT VBOX_E_IPRT_ERROR = 0x80BB0005;
00170 const HRESULT VBOX_E_PDM_ERROR = 0x80BB0006;
00178 const HRESULT VBOX_E_INVALID_OBJECT_STATE = 0x80BB0007;
00186 const HRESULT VBOX_E_HOST_ERROR = 0x80BB0008;
00194 const HRESULT VBOX_E_NOT_SUPPORTED = 0x80BB0009;
00202 const HRESULT VBOX_E_XML_ERROR = 0x80BB000A;
00210 const HRESULT VBOX_E_INVALID_SESSION_STATE = 0x80BB000B;
00218 const HRESULT VBOX_E_OBJECT_IN_USE = 0x80BB000C;
00228 enum SettingsVersion
00229 {
00234 SettingsVersion_Null = 0,
00239 SettingsVersion_v1_0 = 1,
00244 SettingsVersion_v1_1 = 2,
00249 SettingsVersion_v1_2 = 3,
00254 SettingsVersion_v1_3pre = 4,
00259 SettingsVersion_v1_3 = 5,
00264 SettingsVersion_v1_4 = 6,
00269 SettingsVersion_v1_5 = 7,
00274 SettingsVersion_v1_6 = 8,
00279 SettingsVersion_v1_7 = 9,
00284 SettingsVersion_v1_8 = 10,
00289 SettingsVersion_v1_9 = 11,
00294 SettingsVersion_v1_10 = 12,
00299 SettingsVersion_v1_11 = 13,
00304 SettingsVersion_Future = 99999,
00305 };
00306
00314 enum AccessMode
00315 {
00316 AccessMode_ReadOnly = 1,
00317 AccessMode_ReadWrite = 2,
00318 };
00319
00437 enum MachineState
00438 {
00443 MachineState_Null = 0,
00451 MachineState_PoweredOff = 1,
00460 MachineState_Saved = 2,
00469 MachineState_Teleported = 3,
00478 MachineState_Aborted = 4,
00485 MachineState_Running = 5,
00492 MachineState_Paused = 6,
00500 MachineState_Stuck = 7,
00510 MachineState_Teleporting = 8,
00521 MachineState_LiveSnapshotting = 9,
00529 MachineState_Starting = 10,
00537 MachineState_Stopping = 11,
00545 MachineState_Saving = 12,
00553 MachineState_Restoring = 13,
00562 MachineState_TeleportingPausedVM = 14,
00569 MachineState_TeleportingIn = 15,
00576 MachineState_FaultTolerantSyncing = 16,
00584 MachineState_DeletingSnapshotOnline = 17,
00592 MachineState_DeletingSnapshotPaused = 18,
00599 MachineState_RestoringSnapshot = 19,
00608 MachineState_DeletingSnapshot = 20,
00615 MachineState_SettingUp = 21,
00622 MachineState_FirstOnline = 5,
00629 MachineState_LastOnline = 18,
00636 MachineState_FirstTransient = 8,
00643 MachineState_LastTransient = 21,
00644 };
00645
00655 enum SessionState
00656 {
00661 SessionState_Null = 0,
00672 SessionState_Unlocked = 1,
00686 SessionState_Locked = 2,
00696 SessionState_Spawning = 3,
00703 SessionState_Unlocking = 4,
00704 };
00705
00714 enum CPUPropertyType
00715 {
00720 CPUPropertyType_Null = 0,
00729 CPUPropertyType_PAE = 1,
00737 CPUPropertyType_Synthetic = 2,
00738 };
00739
00749 enum HWVirtExPropertyType
00750 {
00755 HWVirtExPropertyType_Null = 0,
00763 HWVirtExPropertyType_Enabled = 1,
00772 HWVirtExPropertyType_Exclusive = 2,
00779 HWVirtExPropertyType_VPID = 3,
00786 HWVirtExPropertyType_NestedPaging = 4,
00793 HWVirtExPropertyType_LargePages = 5,
00801 HWVirtExPropertyType_Force = 6,
00802 };
00803
00811 enum FaultToleranceState
00812 {
00817 FaultToleranceState_Inactive = 1,
00822 FaultToleranceState_Master = 2,
00827 FaultToleranceState_Standby = 3,
00828 };
00829
00837 enum LockType
00838 {
00843 LockType_Write = 2,
00848 LockType_Shared = 1,
00849 };
00850
00859 enum SessionType
00860 {
00865 SessionType_Null = 0,
00873 SessionType_WriteLock = 1,
00880 SessionType_Remote = 2,
00887 SessionType_Shared = 3,
00888 };
00889
00897 enum DeviceType
00898 {
00906 DeviceType_Null = 0,
00911 DeviceType_Floppy = 1,
00916 DeviceType_DVD = 2,
00921 DeviceType_HardDisk = 3,
00926 DeviceType_Network = 4,
00931 DeviceType_USB = 5,
00936 DeviceType_SharedFolder = 6,
00937 };
00938
00946 enum DeviceActivity
00947 {
00948 DeviceActivity_Null = 0,
00949 DeviceActivity_Idle = 1,
00950 DeviceActivity_Reading = 2,
00951 DeviceActivity_Writing = 3,
00952 };
00953
00961 enum ClipboardMode
00962 {
00963 ClipboardMode_Disabled = 0,
00964 ClipboardMode_HostToGuest = 1,
00965 ClipboardMode_GuestToHost = 2,
00966 ClipboardMode_Bidirectional = 3,
00967 };
00968
00979 enum Scope
00980 {
00981 Scope_Global = 0,
00982 Scope_Machine = 1,
00983 Scope_Session = 2,
00984 };
00985
00993 enum BIOSBootMenuMode
00994 {
00995 BIOSBootMenuMode_Disabled = 0,
00996 BIOSBootMenuMode_MenuOnly = 1,
00997 BIOSBootMenuMode_MessageAndMenu = 2,
00998 };
00999
01007 enum ProcessorFeature
01008 {
01009 ProcessorFeature_HWVirtEx = 0,
01010 ProcessorFeature_PAE = 1,
01011 ProcessorFeature_LongMode = 2,
01012 ProcessorFeature_NestedPaging = 3,
01013 };
01014
01022 enum FirmwareType
01023 {
01028 FirmwareType_BIOS = 1,
01033 FirmwareType_EFI = 2,
01038 FirmwareType_EFI32 = 3,
01043 FirmwareType_EFI64 = 4,
01048 FirmwareType_EFIDUAL = 5,
01049 };
01050
01058 enum PointingHidType
01059 {
01064 PointingHidType_None = 1,
01069 PointingHidType_PS2Mouse = 2,
01074 PointingHidType_USBMouse = 3,
01079 PointingHidType_USBTablet = 4,
01085 PointingHidType_ComboMouse = 5,
01086 };
01087
01095 enum KeyboardHidType
01096 {
01101 KeyboardHidType_None = 1,
01106 KeyboardHidType_PS2Keyboard = 2,
01111 KeyboardHidType_USBKeyboard = 3,
01117 KeyboardHidType_ComboKeyboard = 4,
01118 };
01119
01127 enum VFSType
01128 {
01129 VFSType_File = 1,
01130 VFSType_Cloud = 2,
01131 VFSType_S3 = 3,
01132 VFSType_WebDav = 4,
01133 };
01134
01142 enum VFSFileType
01143 {
01144 VFSFileType_Unknown = 1,
01145 VFSFileType_Fifo = 2,
01146 VFSFileType_DevChar = 3,
01147 VFSFileType_Directory = 4,
01148 VFSFileType_DevBlock = 5,
01149 VFSFileType_File = 6,
01150 VFSFileType_SymLink = 7,
01151 VFSFileType_Socket = 8,
01152 VFSFileType_WhiteOut = 9,
01153 };
01154
01161 enum VirtualSystemDescriptionType
01162 {
01163 VirtualSystemDescriptionType_Ignore = 1,
01164 VirtualSystemDescriptionType_OS = 2,
01165 VirtualSystemDescriptionType_Name = 3,
01166 VirtualSystemDescriptionType_Product = 4,
01167 VirtualSystemDescriptionType_Vendor = 5,
01168 VirtualSystemDescriptionType_Version = 6,
01169 VirtualSystemDescriptionType_ProductUrl = 7,
01170 VirtualSystemDescriptionType_VendorUrl = 8,
01171 VirtualSystemDescriptionType_Description = 9,
01172 VirtualSystemDescriptionType_License = 10,
01173 VirtualSystemDescriptionType_Miscellaneous = 11,
01174 VirtualSystemDescriptionType_CPU = 12,
01175 VirtualSystemDescriptionType_Memory = 13,
01176 VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
01177 VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
01178 VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
01179 VirtualSystemDescriptionType_HardDiskControllerSAS = 17,
01180 VirtualSystemDescriptionType_HardDiskImage = 18,
01181 VirtualSystemDescriptionType_Floppy = 19,
01182 VirtualSystemDescriptionType_CDROM = 20,
01183 VirtualSystemDescriptionType_NetworkAdapter = 21,
01184 VirtualSystemDescriptionType_USBController = 22,
01185 VirtualSystemDescriptionType_SoundCard = 23,
01186 };
01187
01194 enum VirtualSystemDescriptionValueType
01195 {
01196 VirtualSystemDescriptionValueType_Reference = 1,
01197 VirtualSystemDescriptionValueType_Original = 2,
01198 VirtualSystemDescriptionValueType_Auto = 3,
01199 VirtualSystemDescriptionValueType_ExtraConfig = 4,
01200 };
01201
01208 enum CleanupMode
01209 {
01214 CleanupMode_UnregisterOnly = 1,
01219 CleanupMode_DetachAllReturnNone = 2,
01224 CleanupMode_DetachAllReturnHardDisksOnly = 3,
01229 CleanupMode_Full = 4,
01230 };
01231
01242 enum HostNetworkInterfaceMediumType
01243 {
01250 HostNetworkInterfaceMediumType_Unknown = 0,
01257 HostNetworkInterfaceMediumType_Ethernet = 1,
01264 HostNetworkInterfaceMediumType_PPP = 2,
01271 HostNetworkInterfaceMediumType_SLIP = 3,
01272 };
01273
01283 enum HostNetworkInterfaceStatus
01284 {
01291 HostNetworkInterfaceStatus_Unknown = 0,
01298 HostNetworkInterfaceStatus_Up = 1,
01305 HostNetworkInterfaceStatus_Down = 2,
01306 };
01307
01315 enum HostNetworkInterfaceType
01316 {
01317 HostNetworkInterfaceType_Bridged = 1,
01318 HostNetworkInterfaceType_HostOnly = 2,
01319 };
01320
01328 enum AdditionsRunLevelType
01329 {
01334 AdditionsRunLevelType_None = 0,
01339 AdditionsRunLevelType_System = 1,
01344 AdditionsRunLevelType_Userland = 2,
01349 AdditionsRunLevelType_Desktop = 3,
01350 };
01351
01359 enum AdditionsUpdateFlag
01360 {
01365 AdditionsUpdateFlag_None = 0,
01371 AdditionsUpdateFlag_WaitForUpdateStartOnly = 1,
01372 };
01373
01381 enum ExecuteProcessFlag
01382 {
01387 ExecuteProcessFlag_None = 0,
01393 ExecuteProcessFlag_WaitForProcessStartOnly = 1,
01398 ExecuteProcessFlag_IgnoreOrphanedProcesses = 2,
01403 ExecuteProcessFlag_Hidden = 4,
01404 };
01405
01413 enum ProcessInputFlag
01414 {
01419 ProcessInputFlag_None = 0,
01424 ProcessInputFlag_EndOfFile = 1,
01425 };
01426
01435 enum CopyFileFlag
01436 {
01441 CopyFileFlag_None = 0,
01446 CopyFileFlag_Recursive = 1,
01451 CopyFileFlag_Update = 2,
01456 CopyFileFlag_FollowLinks = 4,
01457 };
01458
01466 enum CreateDirectoryFlag
01467 {
01472 CreateDirectoryFlag_None = 0,
01477 CreateDirectoryFlag_Parents = 1,
01478 };
01479
01489 enum MediumState
01490 {
01498 MediumState_NotCreated = 0,
01507 MediumState_Created = 1,
01515 MediumState_LockedRead = 2,
01523 MediumState_LockedWrite = 3,
01533 MediumState_Inaccessible = 4,
01540 MediumState_Creating = 5,
01547 MediumState_Deleting = 6,
01548 };
01549
01559 enum MediumType
01560 {
01568 MediumType_Normal = 0,
01576 MediumType_Immutable = 1,
01584 MediumType_Writethrough = 2,
01593 MediumType_Shareable = 3,
01602 MediumType_Readonly = 4,
01614 MediumType_MultiAttach = 5,
01615 };
01616
01626 enum MediumVariant
01627 {
01634 MediumVariant_Standard = 0,
01641 MediumVariant_VmdkSplit2G = 0x01,
01649 MediumVariant_VmdkStreamOptimized = 0x04,
01656 MediumVariant_VmdkESX = 0x08,
01663 MediumVariant_Fixed = 0x10000,
01670 MediumVariant_Diff = 0x20000,
01671 };
01672
01673 enum DataType
01674 {
01675 DataType_Int32 = 0,
01676 DataType_Int8 = 1,
01677 DataType_String = 2,
01678 };
01679
01680 enum DataFlags
01681 {
01682 DataFlags_None = 0x00,
01683 DataFlags_Mandatory = 0x01,
01684 DataFlags_Expert = 0x02,
01685 DataFlags_Array = 0x04,
01686 DataFlags_FlagMask = 0x07,
01687 };
01688
01696 enum MediumFormatCapabilities
01697 {
01704 MediumFormatCapabilities_Uuid = 0x01,
01711 MediumFormatCapabilities_CreateFixed = 0x02,
01719 MediumFormatCapabilities_CreateDynamic = 0x04,
01726 MediumFormatCapabilities_CreateSplit2G = 0x08,
01733 MediumFormatCapabilities_Differencing = 0x10,
01740 MediumFormatCapabilities_Asynchronous = 0x20,
01750 MediumFormatCapabilities_File = 0x40,
01759 MediumFormatCapabilities_Properties = 0x80,
01766 MediumFormatCapabilities_TcpNetworking = 0x100,
01773 MediumFormatCapabilities_VFS = 0x200,
01774 MediumFormatCapabilities_CapabilityMask = 0x3FF,
01775 };
01776
01784 enum MouseButtonState
01785 {
01786 MouseButtonState_LeftButton = 0x01,
01787 MouseButtonState_RightButton = 0x02,
01788 MouseButtonState_MiddleButton = 0x04,
01789 MouseButtonState_WheelUp = 0x08,
01790 MouseButtonState_WheelDown = 0x10,
01791 MouseButtonState_XButton1 = 0x20,
01792 MouseButtonState_XButton2 = 0x40,
01793 MouseButtonState_MouseStateMask = 0x7F,
01794 };
01795
01806 enum FramebufferPixelFormat
01807 {
01815 FramebufferPixelFormat_Opaque = 0,
01823 FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
01824 };
01825
01833 enum NetworkAttachmentType
01834 {
01839 NetworkAttachmentType_Null = 0,
01840 NetworkAttachmentType_NAT = 1,
01841 NetworkAttachmentType_Bridged = 2,
01842 NetworkAttachmentType_Internal = 3,
01843 NetworkAttachmentType_HostOnly = 4,
01844 NetworkAttachmentType_VDE = 5,
01845 };
01846
01854 enum NetworkAdapterType
01855 {
01860 NetworkAdapterType_Null = 0,
01865 NetworkAdapterType_Am79C970A = 1,
01870 NetworkAdapterType_Am79C973 = 2,
01875 NetworkAdapterType_I82540EM = 3,
01880 NetworkAdapterType_I82543GC = 4,
01885 NetworkAdapterType_I82545EM = 5,
01890 NetworkAdapterType_Virtio = 6,
01891 };
01892
01901 enum PortMode
01902 {
01907 PortMode_Disconnected = 0,
01912 PortMode_HostPipe = 1,
01917 PortMode_HostDevice = 2,
01922 PortMode_RawFile = 3,
01923 };
01924
01963 enum USBDeviceState
01964 {
01971 USBDeviceState_NotSupported = 0,
01979 USBDeviceState_Unavailable = 1,
01986 USBDeviceState_Busy = 2,
01994 USBDeviceState_Available = 3,
02002 USBDeviceState_Held = 4,
02010 USBDeviceState_Captured = 5,
02011 };
02012
02022 enum USBDeviceFilterAction
02023 {
02028 USBDeviceFilterAction_Null = 0,
02033 USBDeviceFilterAction_Ignore = 1,
02038 USBDeviceFilterAction_Hold = 2,
02039 };
02040
02048 enum AudioDriverType
02049 {
02054 AudioDriverType_Null = 0,
02059 AudioDriverType_WinMM = 1,
02064 AudioDriverType_OSS = 2,
02069 AudioDriverType_ALSA = 3,
02074 AudioDriverType_DirectSound = 4,
02079 AudioDriverType_CoreAudio = 5,
02084 AudioDriverType_MMPM = 6,
02089 AudioDriverType_Pulse = 7,
02094 AudioDriverType_SolAudio = 8,
02095 };
02096
02104 enum AudioControllerType
02105 {
02106 AudioControllerType_AC97 = 0,
02107 AudioControllerType_SB16 = 1,
02108 AudioControllerType_HDA = 2,
02109 };
02110
02118 enum AuthType
02119 {
02124 AuthType_Null = 0,
02125 AuthType_External = 1,
02126 AuthType_Guest = 2,
02127 };
02128
02137 enum StorageBus
02138 {
02143 StorageBus_Null = 0,
02144 StorageBus_IDE = 1,
02145 StorageBus_SATA = 2,
02146 StorageBus_SCSI = 3,
02147 StorageBus_Floppy = 4,
02148 StorageBus_SAS = 5,
02149 };
02150
02159 enum StorageControllerType
02160 {
02165 StorageControllerType_Null = 0,
02170 StorageControllerType_LsiLogic = 1,
02175 StorageControllerType_BusLogic = 2,
02180 StorageControllerType_IntelAhci = 3,
02185 StorageControllerType_PIIX3 = 4,
02190 StorageControllerType_PIIX4 = 5,
02195 StorageControllerType_ICH6 = 6,
02200 StorageControllerType_I82078 = 7,
02205 StorageControllerType_LsiLogicSas = 8,
02206 };
02207
02215 enum ChipsetType
02216 {
02221 ChipsetType_Null = 0,
02226 ChipsetType_PIIX3 = 1,
02231 ChipsetType_ICH9 = 2,
02232 };
02233
02239 enum NATAliasMode
02240 {
02245 NATAliasMode_AliasLog = 0x1,
02250 NATAliasMode_AliasProxyOnly = 0x02,
02255 NATAliasMode_AliasUseSamePorts = 0x04,
02256 };
02257
02263 enum NATProtocol
02264 {
02269 NATProtocol_UDP = 0,
02274 NATProtocol_TCP = 1,
02275 };
02276
02284 enum BandwidthGroupType
02285 {
02292 BandwidthGroupType_Null = 0,
02299 BandwidthGroupType_Disk = 1,
02306 BandwidthGroupType_Network = 2,
02307 };
02308
02317 enum VBoxEventType
02318 {
02325 VBoxEventType_Invalid = 0,
02334 VBoxEventType_Any = 1,
02342 VBoxEventType_Vetoable = 2,
02350 VBoxEventType_MachineEvent = 3,
02358 VBoxEventType_SnapshotEvent = 4,
02367 VBoxEventType_InputEvent = 5,
02374 VBoxEventType_LastWildcard = 31,
02381 VBoxEventType_OnMachineStateChanged = 32,
02388 VBoxEventType_OnMachineDataChanged = 33,
02395 VBoxEventType_OnExtraDataChanged = 34,
02402 VBoxEventType_OnExtraDataCanChange = 35,
02409 VBoxEventType_OnMediumRegistered = 36,
02416 VBoxEventType_OnMachineRegistered = 37,
02423 VBoxEventType_OnSessionStateChanged = 38,
02430 VBoxEventType_OnSnapshotTaken = 39,
02437 VBoxEventType_OnSnapshotDeleted = 40,
02444 VBoxEventType_OnSnapshotChanged = 41,
02451 VBoxEventType_OnGuestPropertyChanged = 42,
02458 VBoxEventType_OnMousePointerShapeChanged = 43,
02465 VBoxEventType_OnMouseCapabilityChanged = 44,
02472 VBoxEventType_OnKeyboardLedsChanged = 45,
02479 VBoxEventType_OnStateChanged = 46,
02486 VBoxEventType_OnAdditionsStateChanged = 47,
02493 VBoxEventType_OnNetworkAdapterChanged = 48,
02500 VBoxEventType_OnSerialPortChanged = 49,
02507 VBoxEventType_OnParallelPortChanged = 50,
02514 VBoxEventType_OnStorageControllerChanged = 51,
02521 VBoxEventType_OnMediumChanged = 52,
02528 VBoxEventType_OnVRDEServerChanged = 53,
02535 VBoxEventType_OnUSBControllerChanged = 54,
02542 VBoxEventType_OnUSBDeviceStateChanged = 55,
02549 VBoxEventType_OnSharedFolderChanged = 56,
02556 VBoxEventType_OnRuntimeError = 57,
02563 VBoxEventType_OnCanShowWindow = 58,
02570 VBoxEventType_OnShowWindow = 59,
02577 VBoxEventType_OnCPUChanged = 60,
02584 VBoxEventType_OnVRDEServerInfoChanged = 61,
02591 VBoxEventType_OnEventSourceChanged = 62,
02598 VBoxEventType_OnCPUExecutionCapChanged = 63,
02605 VBoxEventType_OnGuestKeyboard = 64,
02612 VBoxEventType_OnGuestMouse = 65,
02619 VBoxEventType_OnNATRedirect = 66,
02626 VBoxEventType_OnHostPciDevicePlug = 67,
02633 VBoxEventType_OnVBoxSVCUnavailable = 68,
02640 VBoxEventType_OnBandwidthGroupChanged = 69,
02647 VBoxEventType_Last = 70,
02648 };
02649
02682 interface IVirtualBoxErrorInfo : $errorinfo
02683 {
02701 readonly attribute long resultCode;
02702
02714 readonly attribute wstringUUID interfaceID;
02715
02726 readonly attribute wstring component;
02727
02738 readonly attribute wstring text;
02739
02750 readonly attribute IVirtualBoxErrorInfo next;
02751
02752 };
02753
02764 interface IDHCPServer : $unknown
02765 {
02771 attribute boolean enabled;
02772
02778 readonly attribute wstring IPAddress;
02779
02785 readonly attribute wstring networkMask;
02786
02792 readonly attribute wstring networkName;
02793
02799 readonly attribute wstring lowerIP;
02800
02806 readonly attribute wstring upperIP;
02807
02836 void setConfiguration (
02837 in wstring IPAddress,
02838 in wstring networkMask,
02839 in wstring FromIPAddress,
02840 in wstring ToIPAddress
02841 );
02842
02867 void start (
02868 in wstring networkName,
02869 in wstring trunkName,
02870 in wstring trunkType
02871 );
02872
02885 void stop();
02886
02887 };
02888
02907 interface IVirtualBox : $unknown
02908 {
02916 readonly attribute wstring version;
02917
02923 readonly attribute unsigned long revision;
02924
02934 readonly attribute wstring packageType;
02935
02951 readonly attribute wstring homeFolder;
02952
02960 readonly attribute wstring settingsFilePath;
02961
02965 readonly attribute IHost host;
02966
02970 readonly attribute ISystemProperties systemProperties;
02971
02977 readonly attribute IMachine[] machines;
02978
02988 readonly attribute IMedium[] hardDisks;
02989
02995 readonly attribute IMedium[] DVDImages;
02996
03002 readonly attribute IMedium[] floppyImages;
03003
03004 readonly attribute IProgress[] progressOperations;
03005
03006 readonly attribute IGuestOSType[] guestOSTypes;
03007
03024 readonly attribute ISharedFolder[] sharedFolders;
03025
03031 readonly attribute IPerformanceCollector performanceCollector;
03032
03038 readonly attribute IDHCPServer[] DHCPServers;
03039
03045 readonly attribute IEventSource eventSource;
03046
03052 readonly attribute IExtPackManager extensionPackManager;
03053
03093 void composeMachineFilename (
03094 in wstring name,
03095 in wstring baseFolder,
03096 [retval] out wstring file
03097 );
03098
03195 void createMachine (
03196 in wstring settingsFile,
03197 in wstring name,
03198 in wstring osTypeId,
03199 in wstringUUID id,
03200 in boolean forceOverwrite,
03201 [retval] out IMachine machine
03202 );
03203
03229 void openMachine (
03230 in wstring settingsFile,
03231 [retval] out IMachine machine
03232 );
03233
03265 void registerMachine (
03266 in IMachine machine
03267 );
03268
03289 void findMachine (
03290 in wstring nameOrId,
03291 [retval] out IMachine machine
03292 );
03293
03303 void createAppliance (
03304 [retval] out IAppliance appliance
03305 );
03306
03369 void createHardDisk (
03370 in wstring format,
03371 in wstring location,
03372 [retval] out IMedium medium
03373 );
03374
03486 void openMedium (
03487 in wstring location,
03488 in DeviceType deviceType,
03489 in AccessMode accessMode,
03490 [retval] out IMedium medium
03491 );
03492
03524 void findMedium (
03525 in wstring location,
03526 in DeviceType type,
03527 [retval] out IMedium medium
03528 );
03529
03558 void getGuestOSType (
03559 in wstringUUID id,
03560 [retval] out IGuestOSType type
03561 );
03562
03585 void createSharedFolder (
03586 in wstring name,
03587 in wstring hostPath,
03588 in boolean writable,
03589 in boolean automount
03590 );
03591
03606 void removeSharedFolder (
03607 in wstring name
03608 );
03609
03618 void getExtraDataKeys (
03619 [retval] out wstring[] value
03620 );
03621
03650 void getExtraData (
03651 in wstring key,
03652 [retval] out wstring value
03653 );
03654
03704 void setExtraData (
03705 in wstring key,
03706 in wstring value
03707 );
03708
03725 void createDHCPServer (
03726 in wstring name,
03727 [retval] out IDHCPServer server
03728 );
03729
03746 void findDHCPServerByNetworkName (
03747 in wstring name,
03748 [retval] out IDHCPServer server
03749 );
03750
03765 void removeDHCPServer (
03766 in IDHCPServer server
03767 );
03768
03793 void checkFirmwarePresent (
03794 in FirmwareType firmwareType,
03795 in wstring version,
03796 out wstring url,
03797 out wstring file,
03798 [retval] out boolean result
03799 );
03800
03801 };
03802
03813 interface IVFSExplorer : $unknown
03814 {
03818 readonly attribute wstring path;
03819
03823 readonly attribute VFSType type;
03824
03832 void update (
03833 [retval] out IProgress aProgress
03834 );
03835
03843 void cd (
03844 in wstring aDir,
03845 [retval] out IProgress aProgress
03846 );
03847
03853 void cdUp (
03854 [retval] out IProgress aProgress
03855 );
03856
03869 void entryList (
03870 out wstring[] aNames,
03871 out unsigned long[] aTypes,
03872 out unsigned long[] aSizes,
03873 out unsigned long[] aModes
03874 );
03875
03884 void exists (
03885 in wstring[] aNames,
03886 [retval] out wstring[] aExists
03887 );
03888
03896 void remove (
03897 in wstring[] aNames,
03898 [retval] out IProgress aProgress
03899 );
03900
03901 };
03902
03968 interface IAppliance : $unknown
03969 {
03977 readonly attribute wstring path;
03978
04009 readonly attribute wstring[] disks;
04010
04018 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
04019
04027 readonly attribute wstring[] machines;
04028
04045 void read (
04046 in wstring file,
04047 [retval] out IProgress aProgress
04048 );
04049
04066 void interpret();
04067
04088 void importMachines (
04089 [retval] out IProgress aProgress
04090 );
04091
04099 void createVFSExplorer (
04100 in wstring aUri,
04101 [retval] out IVFSExplorer aExplorer
04102 );
04103
04133 void write (
04134 in wstring format,
04135 in boolean manifest,
04136 in wstring path,
04137 [retval] out IProgress progress
04138 );
04139
04145 void getWarnings (
04146 [retval] out wstring[] aWarnings
04147 );
04148
04149 };
04150
04162 interface IVirtualSystemDescription : $unknown
04163 {
04167 readonly attribute unsigned long count;
04168
04292 void getDescription (
04293 out VirtualSystemDescriptionType[] aTypes,
04294 out wstring[] aRefs,
04295 out wstring[] aOvfValues,
04296 out wstring[] aVBoxValues,
04297 out wstring[] aExtraConfigValues
04298 );
04299
04316 void getDescriptionByType (
04317 in VirtualSystemDescriptionType aType,
04318 out VirtualSystemDescriptionType[] aTypes,
04319 out wstring[] aRefs,
04320 out wstring[] aOvfValues,
04321 out wstring[] aVBoxValues,
04322 out wstring[] aExtraConfigValues
04323 );
04324
04336 void getValuesByType (
04337 in VirtualSystemDescriptionType aType,
04338 in VirtualSystemDescriptionValueType aWhich,
04339 [retval] out wstring[] aValues
04340 );
04341
04367 void setFinalValues (
04368 in boolean[] aEnabled,
04369 in wstring[] aVBoxValues,
04370 in wstring[] aExtraConfigValues
04371 );
04372
04387 void addDescription (
04388 in VirtualSystemDescriptionType aType,
04389 in wstring aVBoxValue,
04390 in wstring aExtraConfigValue
04391 );
04392
04393 };
04394
04395 interface IInternalMachineControl : $unknown
04396 {
04403 void setRemoveSavedStateFile (
04404 in boolean aRemove
04405 );
04406
04418 void updateState (
04419 in MachineState state
04420 );
04421
04422 void getIPCId (
04423 [retval] out wstring id
04424 );
04425
04437 void beginPowerUp (
04438 in IProgress aProgress
04439 );
04440
04450 void endPowerUp (
04451 in long result
04452 );
04453
04467 void runUSBDeviceFilters (
04468 in IUSBDevice device,
04469 out boolean matched,
04470 out unsigned long maskedInterfaces
04471 );
04472
04481 void captureUSBDevice (
04482 in wstringUUID id
04483 );
04484
04500 void detachUSBDevice (
04501 in wstringUUID id,
04502 in boolean done
04503 );
04504
04513 void autoCaptureUSBDevices();
04514
04530 void detachAllUSBDevices (
04531 in boolean done
04532 );
04533
04548 void onSessionEnd (
04549 in ISession session,
04550 [retval] out IProgress progress
04551 );
04552
04568 void beginSavingState (
04569 out IProgress progress,
04570 out wstring stateFilePath
04571 );
04572
04602 void endSavingState (
04603 in long result,
04604 in wstring errMsg
04605 );
04606
04621 void adoptSavedState (
04622 in wstring savedStateFile
04623 );
04624
04673 void beginTakingSnapshot (
04674 in IConsole initiator,
04675 in wstring name,
04676 in wstring description,
04677 in IProgress consoleProgress,
04678 in boolean fTakingSnapshotOnline,
04679 out wstring stateFilePath
04680 );
04681
04691 void endTakingSnapshot (
04692 in boolean success
04693 );
04694
04715 void deleteSnapshot (
04716 in IConsole initiator,
04717 in wstringUUID id,
04718 out MachineState machineState,
04719 [retval] out IProgress progress
04720 );
04721
04740 void finishOnlineMergeMedium (
04741 in IMediumAttachment mediumAttachment,
04742 in IMedium source,
04743 in IMedium target,
04744 in boolean mergeForward,
04745 in IMedium parentForTarget,
04746 in IMedium[] childrenToReparent
04747 );
04748
04762 void restoreSnapshot (
04763 in IConsole initiator,
04764 in ISnapshot snapshot,
04765 out MachineState machineState,
04766 [retval] out IProgress progress
04767 );
04768
04795 void pullGuestProperties (
04796 out wstring[] name,
04797 out wstring[] value,
04798 out long long[] timestamp,
04799 out wstring[] flags
04800 );
04801
04823 void pushGuestProperty (
04824 in wstring name,
04825 in wstring value,
04826 in long long timestamp,
04827 in wstring flags
04828 );
04829
04841 void lockMedia();
04842
04852 void unlockMedia();
04853
04854 };
04855
04864 interface IBIOSSettings : $unknown
04865 {
04869 attribute boolean logoFadeIn;
04870
04874 attribute boolean logoFadeOut;
04875
04879 attribute unsigned long logoDisplayTime;
04880
04887 attribute wstring logoImagePath;
04888
04892 attribute BIOSBootMenuMode bootMenuMode;
04893
04897 attribute boolean ACPIEnabled;
04898
04905 attribute boolean IOAPICEnabled;
04906
04916 attribute long long timeOffset;
04917
04924 attribute boolean PXEDebugEnabled;
04925
04926 };
04927
04935 interface IEventContext : $unknown
04936 {
04937 };
04938
04946 interface IPciAddress : $unknown
04947 {
04953 attribute short bus;
04954
04960 attribute short device;
04961
04967 attribute short devFunction;
04968
04974 void asLong (
04975 [retval] out long result
04976 );
04977
04983 void fromLong (
04984 in long number
04985 );
04986
04987 };
04988
04996 interface IPciDeviceAttachment : $unknown
04997 {
05003 readonly attribute wstring name;
05004
05010 readonly attribute boolean isPhysicalDevice;
05011
05017 readonly attribute long hostAddress;
05018
05024 readonly attribute long guestAddress;
05025
05026 };
05027
05068 interface IMachine : $unknown
05069 {
05073 readonly attribute IVirtualBox parent;
05074
05124 readonly attribute boolean accessible;
05125
05137 readonly attribute IVirtualBoxErrorInfo accessError;
05138
05178 attribute wstring name;
05179
05190 attribute wstring description;
05191
05195 readonly attribute wstringUUID id;
05196
05211 attribute wstring OSTypeId;
05212
05216 attribute wstring HardwareVersion;
05217
05227 attribute wstringUUID hardwareUUID;
05228
05232 attribute unsigned long CPUCount;
05233
05239 attribute boolean CPUHotPlugEnabled;
05240
05248 attribute unsigned long CPUExecutionCap;
05249
05253 attribute unsigned long memorySize;
05254
05258 attribute unsigned long memoryBalloonSize;
05259
05266 attribute boolean PageFusionEnabled;
05267
05271 attribute unsigned long VRAMSize;
05272
05278 attribute boolean accelerate3DEnabled;
05279
05285 attribute boolean accelerate2DVideoEnabled;
05286
05297 attribute unsigned long monitorCount;
05298
05302 readonly attribute IBIOSSettings BIOSSettings;
05303
05308 attribute FirmwareType firmwareType;
05309
05315 attribute PointingHidType pointingHidType;
05316
05322 attribute KeyboardHidType keyboardHidType;
05323
05330 attribute boolean hpetEnabled;
05331
05335 attribute ChipsetType chipsetType;
05336
05370 attribute wstring snapshotFolder;
05371
05375 readonly attribute IVRDEServer VRDEServer;
05376
05380 readonly attribute IMediumAttachment[] mediumAttachments;
05381
05393 readonly attribute IUSBController USBController;
05394
05398 readonly attribute IAudioAdapter audioAdapter;
05399
05403 readonly attribute IStorageController[] storageControllers;
05404
05410 readonly attribute wstring settingsFilePath;
05411
05436 readonly attribute boolean settingsModified;
05437
05441 readonly attribute SessionState sessionState;
05442
05455 readonly attribute wstring sessionType;
05456
05466 readonly attribute unsigned long sessionPid;
05467
05471 readonly attribute MachineState state;
05472
05479 readonly attribute long long lastStateChange;
05480
05492 readonly attribute wstring stateFilePath;
05493
05503 readonly attribute wstring logFolder;
05504
05515 readonly attribute ISnapshot currentSnapshot;
05516
05523 readonly attribute unsigned long snapshotCount;
05524
05556 readonly attribute boolean currentStateModified;
05557
05569 readonly attribute ISharedFolder[] sharedFolders;
05570
05577 attribute ClipboardMode clipboardMode;
05578
05586 attribute wstring guestPropertyNotificationPatterns;
05587
05596 attribute boolean teleporterEnabled;
05597
05608 attribute unsigned long teleporterPort;
05609
05616 attribute wstring teleporterAddress;
05617
05625 attribute wstring teleporterPassword;
05626
05634 attribute FaultToleranceState faultToleranceState;
05635
05642 attribute unsigned long faultTolerancePort;
05643
05649 attribute wstring faultToleranceAddress;
05650
05658 attribute wstring faultTolerancePassword;
05659
05665 attribute unsigned long faultToleranceSyncInterval;
05666
05674 attribute boolean RTCUseUTC;
05675
05682 attribute boolean ioCacheEnabled;
05683
05689 attribute unsigned long ioCacheSize;
05690
05696 readonly attribute IBandwidthControl bandwidthControl;
05697
05706 readonly attribute IPciDeviceAttachment[] pciDeviceAssignments;
05707
05813 void lockMachine (
05814 in ISession session,
05815 in LockType lockType
05816 );
05817
05941 void launchVMProcess (
05942 in ISession session,
05943 in wstring type,
05944 in wstring environment,
05945 [retval] out IProgress progress
05946 );
05947
05985 void setBootOrder (
05986 in unsigned long position,
05987 in DeviceType device
05988 );
05989
06024 void getBootOrder (
06025 in unsigned long position,
06026 [retval] out DeviceType device
06027 );
06028
06130 void attachDevice (
06131 in wstring name,
06132 in long controllerPort,
06133 in long device,
06134 in DeviceType type,
06135 in IMedium medium
06136 );
06137
06190 void detachDevice (
06191 in wstring name,
06192 in long controllerPort,
06193 in long device
06194 );
06195
06238 void passthroughDevice (
06239 in wstring name,
06240 in long controllerPort,
06241 in long device,
06242 in boolean passthrough
06243 );
06244
06287 void setBandwidthGroupForDevice (
06288 in wstring name,
06289 in long controllerPort,
06290 in long device,
06291 in IBandwidthGroup bandwidthGroup
06292 );
06293
06356 void mountMedium (
06357 in wstring name,
06358 in long controllerPort,
06359 in long device,
06360 in IMedium medium,
06361 in boolean force
06362 );
06363
06392 void getMedium (
06393 in wstring name,
06394 in long controllerPort,
06395 in long device,
06396 [retval] out IMedium medium
06397 );
06398
06413 void getMediumAttachmentsOfController (
06414 in wstring name,
06415 [retval] out IMediumAttachment[] mediumAttachments
06416 );
06417
06432 void getMediumAttachment (
06433 in wstring name,
06434 in long controllerPort,
06435 in long device,
06436 [retval] out IMediumAttachment attachment
06437 );
06438
06484 void attachHostPciDevice (
06485 in long hostAddress,
06486 in long desiredGuestAddress,
06487 in IEventContext eventContext,
06488 in boolean tryToUnbind
06489 );
06490
06534 void detachHostPciDevice (
06535 in long hostAddress
06536 );
06537
06555 void getNetworkAdapter (
06556 in unsigned long slot,
06557 [retval] out INetworkAdapter adapter
06558 );
06559
06592 void addStorageController (
06593 in wstring name,
06594 in StorageBus connectionType,
06595 [retval] out IStorageController controller
06596 );
06597
06611 void getStorageControllerByName (
06612 in wstring name,
06613 [retval] out IStorageController storageController
06614 );
06615
06629 void getStorageControllerByInstance (
06630 in unsigned long instance,
06631 [retval] out IStorageController storageController
06632 );
06633
06647 void removeStorageController (
06648 in wstring name
06649 );
06650
06672 void setStorageControllerBootable (
06673 in wstring name,
06674 in boolean bootable
06675 );
06676
06694 void getSerialPort (
06695 in unsigned long slot,
06696 [retval] out ISerialPort port
06697 );
06698
06716 void getParallelPort (
06717 in unsigned long slot,
06718 [retval] out IParallelPort port
06719 );
06720
06729 void getExtraDataKeys (
06730 [retval] out wstring[] value
06731 );
06732
06761 void getExtraData (
06762 in wstring key,
06763 [retval] out wstring value
06764 );
06765
06815 void setExtraData (
06816 in wstring key,
06817 in wstring value
06818 );
06819
06841 void getCPUProperty (
06842 in CPUPropertyType property,
06843 [retval] out boolean value
06844 );
06845
06867 void setCPUProperty (
06868 in CPUPropertyType property,
06869 in boolean value
06870 );
06871
06911 void getCPUIDLeaf (
06912 in unsigned long id,
06913 out unsigned long valEax,
06914 out unsigned long valEbx,
06915 out unsigned long valEcx,
06916 out unsigned long valEdx
06917 );
06918
06962 void setCPUIDLeaf (
06963 in unsigned long id,
06964 in unsigned long valEax,
06965 in unsigned long valEbx,
06966 in unsigned long valEcx,
06967 in unsigned long valEdx
06968 );
06969
06987 void removeCPUIDLeaf (
06988 in unsigned long id
06989 );
06990
06996 void removeAllCPUIDLeaves();
06997
07019 void getHWVirtExProperty (
07020 in HWVirtExPropertyType property,
07021 [retval] out boolean value
07022 );
07023
07045 void setHWVirtExProperty (
07046 in HWVirtExPropertyType property,
07047 in boolean value
07048 );
07049
07095 void saveSettings();
07096
07120 void discardSettings();
07121
07196 void unregister (
07197 in CleanupMode cleanupMode,
07198 [retval] out IMedium[] aMedia
07199 );
07200
07257 void delete (
07258 in IMedium[] aMedia,
07259 [retval] out IProgress aProgress
07260 );
07261
07273 void export (
07274 in IAppliance aAppliance,
07275 in wstring location,
07276 [retval] out IVirtualSystemDescription aDescription
07277 );
07278
07301 void findSnapshot (
07302 in wstring nameOrId,
07303 [retval] out ISnapshot snapshot
07304 );
07305
07339 void createSharedFolder (
07340 in wstring name,
07341 in wstring hostPath,
07342 in boolean writable,
07343 in boolean automount
07344 );
07345
07371 void removeSharedFolder (
07372 in wstring name
07373 );
07374
07398 void canShowConsoleWindow (
07399 [retval] out boolean canShow
07400 );
07401
07436 void showConsoleWindow (
07437 [retval] out long long winId
07438 );
07439
07472 void getGuestProperty (
07473 in wstring name,
07474 out wstring value,
07475 out long long timestamp,
07476 out wstring flags
07477 );
07478
07501 void getGuestPropertyValue (
07502 in wstring property,
07503 [retval] out wstring value
07504 );
07505
07528 void getGuestPropertyTimestamp (
07529 in wstring property,
07530 [retval] out long long value
07531 );
07532
07583 void setGuestProperty (
07584 in wstring property,
07585 in wstring value,
07586 in wstring flags
07587 );
07588
07629 void setGuestPropertyValue (
07630 in wstring property,
07631 in wstring value
07632 );
07633
07664 void enumerateGuestProperties (
07665 in wstring patterns,
07666 out wstring[] name,
07667 out wstring[] value,
07668 out long long[] timestamp,
07669 out wstring[] flags
07670 );
07671
07689 void querySavedGuestSize (
07690 in unsigned long screenId,
07691 out unsigned long width,
07692 out unsigned long height
07693 );
07694
07716 void querySavedThumbnailSize (
07717 in unsigned long screenId,
07718 out unsigned long size,
07719 out unsigned long width,
07720 out unsigned long height
07721 );
07722
07749 void readSavedThumbnailToArray (
07750 in unsigned long screenId,
07751 in boolean BGR,
07752 out unsigned long width,
07753 out unsigned long height,
07754 [retval] out octet[] data
07755 );
07756
07778 void readSavedThumbnailPNGToArray (
07779 in unsigned long screenId,
07780 out unsigned long width,
07781 out unsigned long height,
07782 [retval] out octet[] data
07783 );
07784
07806 void querySavedScreenshotPNGSize (
07807 in unsigned long screenId,
07808 out unsigned long size,
07809 out unsigned long width,
07810 out unsigned long height
07811 );
07812
07834 void readSavedScreenshotPNGToArray (
07835 in unsigned long screenId,
07836 out unsigned long width,
07837 out unsigned long height,
07838 [retval] out octet[] data
07839 );
07840
07850 void hotPlugCPU (
07851 in unsigned long cpu
07852 );
07853
07863 void hotUnplugCPU (
07864 in unsigned long cpu
07865 );
07866
07880 void getCPUStatus (
07881 in unsigned long cpu,
07882 [retval] out boolean attached
07883 );
07884
07899 void queryLogFilename (
07900 in unsigned long idx,
07901 [retval] out wstring filename
07902 );
07903
07929 void readLog (
07930 in unsigned long idx,
07931 in long long offset,
07932 in long long size,
07933 [retval] out octet[] data
07934 );
07935
07936 };
07937
07946 interface IVRDEServerInfo : $unknown
07947 {
07953 readonly attribute boolean active;
07954
07963 readonly attribute long port;
07964
07970 readonly attribute unsigned long numberOfClients;
07971
07977 readonly attribute long long beginTime;
07978
07985 readonly attribute long long endTime;
07986
07992 readonly attribute long long bytesSent;
07993
07999 readonly attribute long long bytesSentTotal;
08000
08006 readonly attribute long long bytesReceived;
08007
08013 readonly attribute long long bytesReceivedTotal;
08014
08020 readonly attribute wstring user;
08021
08027 readonly attribute wstring domain;
08028
08034 readonly attribute wstring clientName;
08035
08041 readonly attribute wstring clientIP;
08042
08048 readonly attribute unsigned long clientVersion;
08049
08057 readonly attribute unsigned long encryptionStyle;
08058
08059 };
08060
08082 interface IConsole : $unknown
08083 {
08095 readonly attribute IMachine machine;
08096
08110 readonly attribute MachineState state;
08111
08115 readonly attribute IGuest guest;
08116
08127 readonly attribute IKeyboard keyboard;
08128
08139 readonly attribute IMouse mouse;
08140
08150 readonly attribute IDisplay display;
08151
08155 readonly attribute IMachineDebugger debugger;
08156
08167 readonly attribute IUSBDevice[] USBDevices;
08168
08176 readonly attribute IHostUSBDevice[] remoteUSBDevices;
08177
08193 readonly attribute ISharedFolder[] sharedFolders;
08194
08200 readonly attribute IVRDEServerInfo VRDEServerInfo;
08201
08207 readonly attribute IEventSource eventSource;
08208
08212 readonly attribute IPciDeviceAttachment[] attachedPciDevices;
08213
08278 void powerUp (
08279 [retval] out IProgress progress
08280 );
08281
08315 void powerUpPaused (
08316 [retval] out IProgress progress
08317 );
08318
08338 void powerDown (
08339 [retval] out IProgress progress
08340 );
08341
08361 void reset();
08362
08382 void pause();
08383
08403 void resume();
08404
08424 void powerButton();
08425
08445 void sleepButton();
08446
08458 void getPowerButtonHandled (
08459 [retval] out boolean handled
08460 );
08461
08475 void getGuestEnteredACPIMode (
08476 [retval] out boolean entered
08477 );
08478
08531 void saveState (
08532 [retval] out IProgress progress
08533 );
08534
08567 void adoptSavedState (
08568 in wstring savedStateFile
08569 );
08570
08601 void discardSavedState (
08602 in boolean fRemoveFile
08603 );
08604
08617 void getDeviceActivity (
08618 in DeviceType type,
08619 [retval] out DeviceActivity activity
08620 );
08621
08658 void attachUSBDevice (
08659 in wstringUUID id
08660 );
08661
08695 void detachUSBDevice (
08696 in wstringUUID id,
08697 [retval] out IUSBDevice device
08698 );
08699
08722 void findUSBDeviceByAddress (
08723 in wstring name,
08724 [retval] out IUSBDevice device
08725 );
08726
08746 void findUSBDeviceById (
08747 in wstringUUID id,
08748 [retval] out IUSBDevice device
08749 );
08750
08784 void createSharedFolder (
08785 in wstring name,
08786 in wstring hostPath,
08787 in boolean writable,
08788 in boolean automount
08789 );
08790
08815 void removeSharedFolder (
08816 in wstring name
08817 );
08818
08856 void takeSnapshot (
08857 in wstring name,
08858 in wstring description,
08859 [retval] out IProgress progress
08860 );
08861
08932 void deleteSnapshot (
08933 in wstringUUID id,
08934 [retval] out IProgress progress
08935 );
08936
08977 void restoreSnapshot (
08978 in ISnapshot snapshot,
08979 [retval] out IProgress progress
08980 );
08981
09020 void teleport (
09021 in wstring hostname,
09022 in unsigned long tcpport,
09023 in wstring password,
09024 in unsigned long maxDowntime,
09025 [retval] out IProgress progress
09026 );
09027
09028 };
09029
09040 interface IHostNetworkInterface : $unknown
09041 {
09045 readonly attribute wstring name;
09046
09050 readonly attribute wstringUUID id;
09051
09055 readonly attribute wstring networkName;
09056
09060 readonly attribute boolean dhcpEnabled;
09061
09065 readonly attribute wstring IPAddress;
09066
09070 readonly attribute wstring networkMask;
09071
09075 readonly attribute boolean IPV6Supported;
09076
09080 readonly attribute wstring IPV6Address;
09081
09085 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
09086
09090 readonly attribute wstring hardwareAddress;
09091
09095 readonly attribute HostNetworkInterfaceMediumType mediumType;
09096
09100 readonly attribute HostNetworkInterfaceStatus status;
09101
09105 readonly attribute HostNetworkInterfaceType interfaceType;
09106
09118 void enableStaticIpConfig (
09119 in wstring IPAddress,
09120 in wstring networkMask
09121 );
09122
09134 void enableStaticIpConfigV6 (
09135 in wstring IPV6Address,
09136 in unsigned long IPV6NetworkMaskPrefixLength
09137 );
09138
09142 void enableDynamicIpConfig();
09143
09147 void dhcpRediscover();
09148
09149 };
09150
09167 interface IHost : $unknown
09168 {
09172 readonly attribute IMedium[] DVDDrives;
09173
09177 readonly attribute IMedium[] floppyDrives;
09178
09192 readonly attribute IHostUSBDevice[] USBDevices;
09193
09216 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
09217
09221 readonly attribute IHostNetworkInterface[] networkInterfaces;
09222
09226 readonly attribute unsigned long processorCount;
09227
09231 readonly attribute unsigned long processorOnlineCount;
09232
09236 readonly attribute unsigned long processorCoreCount;
09237
09241 readonly attribute unsigned long memorySize;
09242
09246 readonly attribute unsigned long memoryAvailable;
09247
09251 readonly attribute wstring operatingSystem;
09252
09256 readonly attribute wstring OSVersion;
09257
09261 readonly attribute long long UTCTime;
09262
09266 readonly attribute boolean Acceleration3DAvailable;
09267
09282 void getProcessorSpeed (
09283 in unsigned long cpuId,
09284 [retval] out unsigned long speed
09285 );
09286
09298 void getProcessorFeature (
09299 in ProcessorFeature feature,
09300 [retval] out boolean supported
09301 );
09302
09321 void getProcessorDescription (
09322 in unsigned long cpuId,
09323 [retval] out wstring description
09324 );
09325
09366 void getProcessorCPUIDLeaf (
09367 in unsigned long cpuId,
09368 in unsigned long leaf,
09369 in unsigned long subLeaf,
09370 out unsigned long valEax,
09371 out unsigned long valEbx,
09372 out unsigned long valEcx,
09373 out unsigned long valEdx
09374 );
09375
09396 void createHostOnlyNetworkInterface (
09397 out IHostNetworkInterface hostInterface,
09398 [retval] out IProgress progress
09399 );
09400
09421 void removeHostOnlyNetworkInterface (
09422 in wstringUUID id,
09423 [retval] out IProgress progress
09424 );
09425
09445 void createUSBDeviceFilter (
09446 in wstring name,
09447 [retval] out IHostUSBDeviceFilter filter
09448 );
09449
09492 void insertUSBDeviceFilter (
09493 in unsigned long position,
09494 in IHostUSBDeviceFilter filter
09495 );
09496
09524 void removeUSBDeviceFilter (
09525 in unsigned long position
09526 );
09527
09545 void findHostDVDDrive (
09546 in wstring name,
09547 [retval] out IMedium drive
09548 );
09549
09567 void findHostFloppyDrive (
09568 in wstring name,
09569 [retval] out IMedium drive
09570 );
09571
09587 void findHostNetworkInterfaceByName (
09588 in wstring name,
09589 [retval] out IHostNetworkInterface networkInterface
09590 );
09591
09607 void findHostNetworkInterfaceById (
09608 in wstringUUID id,
09609 [retval] out IHostNetworkInterface networkInterface
09610 );
09611
09621 void findHostNetworkInterfacesOfType (
09622 in HostNetworkInterfaceType type,
09623 [retval] out IHostNetworkInterface[] networkInterfaces
09624 );
09625
09645 void findUSBDeviceById (
09646 in wstringUUID id,
09647 [retval] out IHostUSBDevice device
09648 );
09649
09672 void findUSBDeviceByAddress (
09673 in wstring name,
09674 [retval] out IHostUSBDevice device
09675 );
09676
09677 };
09678
09691 interface ISystemProperties : $unknown
09692 {
09696 readonly attribute unsigned long minGuestRAM;
09697
09701 readonly attribute unsigned long maxGuestRAM;
09702
09706 readonly attribute unsigned long minGuestVRAM;
09707
09711 readonly attribute unsigned long maxGuestVRAM;
09712
09716 readonly attribute unsigned long minGuestCPUCount;
09717
09721 readonly attribute unsigned long maxGuestCPUCount;
09722
09726 readonly attribute unsigned long maxGuestMonitors;
09727
09732 readonly attribute long long infoVDSize;
09733
09740 readonly attribute unsigned long networkAdapterCount;
09741
09748 readonly attribute unsigned long serialPortCount;
09749
09756 readonly attribute unsigned long parallelPortCount;
09757
09767 readonly attribute unsigned long maxBootPosition;
09768
09792 attribute wstring defaultMachineFolder;
09793
09819 readonly attribute IMediumFormat[] mediumFormats;
09820
09854 attribute wstring defaultHardDiskFormat;
09855
09861 attribute long long freeDiskSpaceWarning;
09862
09867 attribute unsigned long freeDiskSpacePercentWarning;
09868
09874 attribute long long freeDiskSpaceError;
09875
09880 attribute unsigned long freeDiskSpacePercentError;
09881
09905 attribute wstring VRDEAuthLibrary;
09906
09935 attribute wstring webServiceAuthLibrary;
09936
09950 attribute wstring defaultVRDEExtPack;
09951
09957 attribute unsigned long LogHistoryCount;
09958
09963 readonly attribute AudioDriverType defaultAudioDriver;
09964
09974 void getMaxDevicesPerPortForStorageBus (
09975 in StorageBus bus,
09976 [retval] out unsigned long maxDevicesPerPort
09977 );
09978
09986 void getMinPortCountForStorageBus (
09987 in StorageBus bus,
09988 [retval] out unsigned long minPortCount
09989 );
09990
09998 void getMaxPortCountForStorageBus (
09999 in StorageBus bus,
10000 [retval] out unsigned long maxPortCount
10001 );
10002
10015 void getMaxInstancesOfStorageBus (
10016 in ChipsetType chipset,
10017 in StorageBus bus,
10018 [retval] out unsigned long maxInstances
10019 );
10020
10030 void getDeviceTypesForStorageBus (
10031 in StorageBus bus,
10032 [retval] out DeviceType[] deviceTypes
10033 );
10034
10043 void getDefaultIoCacheSettingForStorageController (
10044 in StorageControllerType controllerType,
10045 [retval] out boolean enabled
10046 );
10047
10048 };
10049
10055 interface IGuestOSType : $unknown
10056 {
10060 readonly attribute wstring familyId;
10061
10065 readonly attribute wstring familyDescription;
10066
10070 readonly attribute wstring id;
10071
10075 readonly attribute wstring description;
10076
10080 readonly attribute boolean is64Bit;
10081
10085 readonly attribute boolean recommendedIOAPIC;
10086
10090 readonly attribute boolean recommendedVirtEx;
10091
10095 readonly attribute unsigned long recommendedRAM;
10096
10100 readonly attribute unsigned long recommendedVRAM;
10101
10105 readonly attribute long long recommendedHDD;
10106
10110 readonly attribute NetworkAdapterType adapterType;
10111
10115 readonly attribute boolean recommendedPae;
10116
10120 readonly attribute StorageControllerType recommendedDvdStorageController;
10121
10125 readonly attribute StorageBus recommendedDvdStorageBus;
10126
10130 readonly attribute StorageControllerType recommendedHdStorageController;
10131
10135 readonly attribute StorageBus recommendedHdStorageBus;
10136
10140 readonly attribute FirmwareType recommendedFirmware;
10141
10145 readonly attribute boolean recommendedUsbHid;
10146
10150 readonly attribute boolean recommendedHpet;
10151
10155 readonly attribute boolean recommendedUsbTablet;
10156
10160 readonly attribute boolean recommendedRtcUseUtc;
10161
10165 readonly attribute ChipsetType recommendedChipset;
10166
10170 readonly attribute AudioControllerType recommendedAudioController;
10171
10172 };
10173
10187 interface IGuest : $unknown
10188 {
10203 readonly attribute wstring OSTypeId;
10204
10210 readonly attribute AdditionsRunLevelType additionsRunLevel;
10211
10219 readonly attribute wstring additionsVersion;
10220
10227 readonly attribute boolean supportsSeamless;
10228
10237 readonly attribute boolean supportsGraphics;
10238
10242 attribute unsigned long memoryBalloonSize;
10243
10247 attribute unsigned long statisticsUpdateInterval;
10248
10280 void internalGetStatistics (
10281 out unsigned long cpuUser,
10282 out unsigned long cpuKernel,
10283 out unsigned long cpuIdle,
10284 out unsigned long memTotal,
10285 out unsigned long memFree,
10286 out unsigned long memBalloon,
10287 out unsigned long memShared,
10288 out unsigned long memCache,
10289 out unsigned long pagedTotal,
10290 out unsigned long memAllocTotal,
10291 out unsigned long memFreeTotal,
10292 out unsigned long memBalloonTotal,
10293 out unsigned long memSharedTotal
10294 );
10295
10313 void getAdditionsStatus (
10314 in AdditionsRunLevelType level,
10315 [retval] out boolean active
10316 );
10317
10347 void setCredentials (
10348 in wstring userName,
10349 in wstring password,
10350 in wstring domain,
10351 in boolean allowInteractiveLogon
10352 );
10353
10405 void executeProcess (
10406 in wstring execName,
10407 in unsigned long flags,
10408 in wstring[] arguments,
10409 in wstring[] environment,
10410 in wstring userName,
10411 in wstring password,
10412 in unsigned long timeoutMS,
10413 out unsigned long pid,
10414 [retval] out IProgress progress
10415 );
10416
10454 void getProcessOutput (
10455 in unsigned long pid,
10456 in unsigned long flags,
10457 in unsigned long timeoutMS,
10458 in long long size,
10459 [retval] out octet[] data
10460 );
10461
10492 void getProcessStatus (
10493 in unsigned long pid,
10494 out unsigned long exitcode,
10495 out unsigned long flags,
10496 [retval] out unsigned long reason
10497 );
10498
10535 void copyToGuest (
10536 in wstring source,
10537 in wstring dest,
10538 in wstring userName,
10539 in wstring password,
10540 in unsigned long flags,
10541 [retval] out IProgress progress
10542 );
10543
10580 void createDirectory (
10581 in wstring directory,
10582 in wstring userName,
10583 in wstring password,
10584 in unsigned long mode,
10585 in unsigned long flags,
10586 [retval] out IProgress progress
10587 );
10588
10622 void setProcessInput (
10623 in unsigned long pid,
10624 in unsigned long flags,
10625 in unsigned long timeoutMS,
10626 in octet[] data,
10627 [retval] out unsigned long written
10628 );
10629
10653 void updateGuestAdditions (
10654 in wstring source,
10655 in unsigned long flags,
10656 [retval] out IProgress progress
10657 );
10658
10659 };
10660
10701 interface IProgress : $unknown
10702 {
10706 readonly attribute wstringUUID id;
10707
10711 readonly attribute wstring description;
10712
10716 readonly attribute $unknown initiator;
10717
10721 readonly attribute boolean cancelable;
10722
10730 readonly attribute unsigned long percent;
10731
10745 readonly attribute long timeRemaining;
10746
10750 readonly attribute boolean completed;
10751
10755 readonly attribute boolean canceled;
10756
10763 readonly attribute long resultCode;
10764
10774 readonly attribute IVirtualBoxErrorInfo errorInfo;
10775
10782 readonly attribute unsigned long operationCount;
10783
10787 readonly attribute unsigned long operation;
10788
10794 readonly attribute wstring operationDescription;
10795
10799 readonly attribute unsigned long operationPercent;
10800
10804 readonly attribute unsigned long operationWeight;
10805
10813 attribute unsigned long timeout;
10814
10818 void setCurrentOperationProgress (
10819 in unsigned long percent
10820 );
10821
10825 void setNextOperation (
10826 in wstring nextOperationDescription,
10827 in unsigned long nextOperationsWeight
10828 );
10829
10856 void waitForCompletion (
10857 in long timeout
10858 );
10859
10883 void waitForOperationCompletion (
10884 in unsigned long operation,
10885 in long timeout
10886 );
10887
10904 void cancel();
10905
10906 };
10907
10986 interface ISnapshot : $unknown
10987 {
10991 readonly attribute wstringUUID id;
10992
10996 attribute wstring name;
10997
11001 attribute wstring description;
11002
11008 readonly attribute long long timeStamp;
11009
11021 readonly attribute boolean online;
11022
11034 readonly attribute IMachine machine;
11035
11042 readonly attribute ISnapshot parent;
11043
11049 readonly attribute ISnapshot[] children;
11050
11051 };
11052
11075 interface IMediumAttachment : $unknown
11076 {
11081 readonly attribute IMedium medium;
11082
11088 readonly attribute wstring controller;
11089
11095 readonly attribute long port;
11096
11102 readonly attribute long device;
11103
11107 readonly attribute DeviceType type;
11108
11112 readonly attribute boolean passthrough;
11113
11117 readonly attribute IBandwidthGroup bandwidthGroup;
11118
11119 };
11120
11462 interface IMedium : $unknown
11463 {
11477 readonly attribute wstringUUID id;
11478
11497 attribute wstring description;
11498
11514 readonly attribute MediumState state;
11515
11523 readonly attribute MediumVariant variant;
11524
11546 attribute wstring location;
11547
11567 readonly attribute wstring name;
11568
11573 readonly attribute DeviceType deviceType;
11574
11578 readonly attribute boolean hostDrive;
11579
11592 readonly attribute long long size;
11593
11608 readonly attribute wstring format;
11609
11625 readonly attribute IMediumFormat mediumFormat;
11626
11651 attribute MediumType type;
11652
11662 readonly attribute IMedium parent;
11663
11671 readonly attribute IMedium[] children;
11672
11683 readonly attribute IMedium base;
11684
11717 readonly attribute boolean readOnly;
11718
11739 readonly attribute long long logicalSize;
11740
11768 attribute boolean autoReset;
11769
11784 readonly attribute wstring lastAccessError;
11785
11802 readonly attribute wstringUUID[] machineIds;
11803
11829 void setIDs (
11830 in boolean setImageId,
11831 in wstringUUID imageId,
11832 in boolean setParentId,
11833 in wstringUUID parentId
11834 );
11835
11870 void refreshState (
11871 [retval] out MediumState state
11872 );
11873
11900 void getSnapshotIds (
11901 in wstringUUID machineId,
11902 [retval] out wstringUUID[] snapshotIds
11903 );
11904
11964 void lockRead (
11965 [retval] out MediumState state
11966 );
11967
11990 void unlockRead (
11991 [retval] out MediumState state
11992 );
11993
12048 void lockWrite (
12049 [retval] out MediumState state
12050 );
12051
12074 void unlockWrite (
12075 [retval] out MediumState state
12076 );
12077
12127 void close();
12128
12158 void getProperty (
12159 in wstring name,
12160 [retval] out wstring value
12161 );
12162
12194 void setProperty (
12195 in wstring name,
12196 in wstring value
12197 );
12198
12232 void getProperties (
12233 in wstring names,
12234 out wstring[] returnNames,
12235 [retval] out wstring[] returnValues
12236 );
12237
12269 void setProperties (
12270 in wstring[] names,
12271 in wstring[] values
12272 );
12273
12305 void createBaseStorage (
12306 in long long logicalSize,
12307 in MediumVariant variant,
12308 [retval] out IProgress progress
12309 );
12310
12362 void deleteStorage (
12363 [retval] out IProgress progress
12364 );
12365
12403 void createDiffStorage (
12404 in IMedium target,
12405 in MediumVariant variant,
12406 [retval] out IProgress progress
12407 );
12408
12484 void mergeTo (
12485 in IMedium target,
12486 [retval] out IProgress progress
12487 );
12488
12537 void cloneTo (
12538 in IMedium target,
12539 in MediumVariant variant,
12540 in IMedium parent,
12541 [retval] out IProgress progress
12542 );
12543
12572 void compact (
12573 [retval] out IProgress progress
12574 );
12575
12608 void resize (
12609 in long long logicalSize,
12610 [retval] out IProgress progress
12611 );
12612
12646 void reset (
12647 [retval] out IProgress progress
12648 );
12649
12650 };
12651
12674 interface IMediumFormat : $unknown
12675 {
12694 readonly attribute wstring id;
12695
12703 readonly attribute wstring name;
12704
12713 readonly attribute unsigned long capabilities;
12714
12733 void describeFileExtensions (
12734 out wstring[] extensions,
12735 out DeviceType[] type
12736 );
12737
12767 void describeProperties (
12768 out wstring[] names,
12769 out wstring[] description,
12770 out DataType[] types,
12771 out unsigned long[] flags,
12772 out wstring[] defaults
12773 );
12774
12775 };
12776
12789 interface IKeyboard : $unknown
12790 {
12796 readonly attribute IEventSource eventSource;
12797
12810 void putScancode (
12811 in long scancode
12812 );
12813
12826 void putScancodes (
12827 in long[] scancodes,
12828 [retval] out unsigned long codesStored
12829 );
12830
12845 void putCAD();
12846
12847 };
12848
12860 interface IMouse : $unknown
12861 {
12876 readonly attribute boolean absoluteSupported;
12877
12892 readonly attribute boolean relativeSupported;
12893
12908 readonly attribute boolean needsHostCursor;
12909
12915 readonly attribute IEventSource eventSource;
12916
12982 void putMouseEvent (
12983 in long dx,
12984 in long dy,
12985 in long dz,
12986 in long dw,
12987 in long buttonState
12988 );
12989
13062 void putMouseEventAbsolute (
13063 in long x,
13064 in long y,
13065 in long dz,
13066 in long dw,
13067 in long buttonState
13068 );
13069
13070 };
13071
13072 interface IFramebuffer : $unknown
13073 {
13082 readonly attribute octetPtr address;
13083
13087 readonly attribute unsigned long width;
13088
13092 readonly attribute unsigned long height;
13093
13100 readonly attribute unsigned long bitsPerPixel;
13101
13108 readonly attribute unsigned long bytesPerLine;
13109
13120 readonly attribute unsigned long pixelFormat;
13121
13128 readonly attribute boolean usesGuestVRAM;
13129
13139 readonly attribute unsigned long heightReduction;
13140
13155 readonly attribute IFramebufferOverlay overlay;
13156
13163 readonly attribute long long winId;
13164
13172 void lock();
13173
13181 void unlock();
13182
13190 void notifyUpdate (
13191 in unsigned long x,
13192 in unsigned long y,
13193 in unsigned long width,
13194 in unsigned long height
13195 );
13196
13309 void requestResize (
13310 in unsigned long screenId,
13311 in unsigned long pixelFormat,
13312 in octetPtr VRAM,
13313 in unsigned long bitsPerPixel,
13314 in unsigned long bytesPerLine,
13315 in unsigned long width,
13316 in unsigned long height,
13317 [retval] out boolean finished
13318 );
13319
13331 void videoModeSupported (
13332 in unsigned long width,
13333 in unsigned long height,
13334 in unsigned long bpp,
13335 [retval] out boolean supported
13336 );
13337
13374 void getVisibleRegion (
13375 in octetPtr rectangles,
13376 in unsigned long count,
13377 [retval] out unsigned long countCopied
13378 );
13379
13414 void setVisibleRegion (
13415 in octetPtr rectangles,
13416 in unsigned long count
13417 );
13418
13439 void processVHWACommand (
13440 in octetPtr command
13441 );
13442
13443 };
13444
13459 interface IFramebufferOverlay : IFramebuffer
13460 {
13464 readonly attribute unsigned long x;
13465
13469 readonly attribute unsigned long y;
13470
13476 attribute boolean visible;
13477
13484 attribute unsigned long alpha;
13485
13491 void move (
13492 in unsigned long x,
13493 in unsigned long y
13494 );
13495
13496 };
13497
13513 interface IDisplay : $unknown
13514 {
13518 void getScreenResolution (
13519 in unsigned long screenId,
13520 out unsigned long width,
13521 out unsigned long height,
13522 out unsigned long bitsPerPixel
13523 );
13524
13530 void setFramebuffer (
13531 in unsigned long screenId,
13532 in IFramebuffer framebuffer
13533 );
13534
13540 void getFramebuffer (
13541 in unsigned long screenId,
13542 out IFramebuffer framebuffer,
13543 out long xOrigin,
13544 out long yOrigin
13545 );
13546
13575 void setVideoModeHint (
13576 in unsigned long width,
13577 in unsigned long height,
13578 in unsigned long bitsPerPixel,
13579 in unsigned long display
13580 );
13581
13592 void setSeamlessMode (
13593 in boolean enabled
13594 );
13595
13629 void takeScreenShot (
13630 in unsigned long screenId,
13631 in octetPtr address,
13632 in unsigned long width,
13633 in unsigned long height
13634 );
13635
13679 void takeScreenShotToArray (
13680 in unsigned long screenId,
13681 in unsigned long width,
13682 in unsigned long height,
13683 [retval] out octet[] screenData
13684 );
13685
13724 void takeScreenShotPNGToArray (
13725 in unsigned long screenId,
13726 in unsigned long width,
13727 in unsigned long height,
13728 [retval] out octet[] screenData
13729 );
13730
13782 void drawToScreen (
13783 in unsigned long screenId,
13784 in octetPtr address,
13785 in unsigned long x,
13786 in unsigned long y,
13787 in unsigned long width,
13788 in unsigned long height
13789 );
13790
13805 void invalidateAndUpdate();
13806
13820 void resizeCompleted (
13821 in unsigned long screenId
13822 );
13823
13836 void completeVHWACommand (
13837 in octetPtr command
13838 );
13839
13840 };
13841
13857 interface INetworkAdapter : $unknown
13858 {
13866 attribute NetworkAdapterType adapterType;
13867
13875 readonly attribute unsigned long slot;
13876
13885 attribute boolean enabled;
13886
13893 attribute wstring MACAddress;
13894
13895 readonly attribute NetworkAttachmentType attachmentType;
13896
13902 attribute wstring hostInterface;
13903
13909 attribute wstring internalNetwork;
13910
13916 attribute wstring NATNetwork;
13917
13923 attribute wstring VDENetwork;
13924
13931 attribute boolean cableConnected;
13932
13938 attribute unsigned long lineSpeed;
13939
13946 attribute boolean traceEnabled;
13947
13954 attribute wstring traceFile;
13955
13963 readonly attribute INATEngine natDriver;
13964
13971 attribute unsigned long bootPriority;
13972
13979 attribute unsigned long bandwidthLimit;
13980
13986 void attachToNAT();
13987
13993 void attachToBridgedInterface();
13994
14000 void attachToInternalNetwork();
14001
14007 void attachToHostOnlyInterface();
14008
14014 void attachToVDE();
14015
14021 void detach();
14022
14023 };
14024
14053 interface ISerialPort : $unknown
14054 {
14062 readonly attribute unsigned long slot;
14063
14070 attribute boolean enabled;
14071
14075 attribute unsigned long IOBase;
14076
14080 attribute unsigned long IRQ;
14081
14092 attribute PortMode hostMode;
14093
14101 attribute boolean server;
14102
14112 attribute wstring path;
14113
14114 };
14115
14135 interface IParallelPort : $unknown
14136 {
14144 readonly attribute unsigned long slot;
14145
14152 attribute boolean enabled;
14153
14157 attribute unsigned long IOBase;
14158
14162 attribute unsigned long IRQ;
14163
14171 attribute wstring path;
14172
14173 };
14174
14175 interface IMachineDebugger : $unknown
14176 {
14180 attribute boolean singlestep;
14181
14185 attribute boolean recompileUser;
14186
14190 attribute boolean recompileSupervisor;
14191
14195 attribute boolean PATMEnabled;
14196
14200 attribute boolean CSAMEnabled;
14201
14205 attribute boolean logEnabled;
14206
14213 readonly attribute boolean HWVirtExEnabled;
14214
14221 readonly attribute boolean HWVirtExNestedPagingEnabled;
14222
14229 readonly attribute boolean HWVirtExVPIDEnabled;
14230
14237 readonly attribute boolean PAEEnabled;
14238
14245 attribute unsigned long virtualTimeRate;
14246
14253 readonly attribute long long VM;
14254
14262 void resetStats (
14263 in wstring pattern
14264 );
14265
14273 void dumpStats (
14274 in wstring pattern
14275 );
14276
14288 void getStats (
14289 in wstring pattern,
14290 in boolean withDescriptions,
14291 out wstring stats
14292 );
14293
14299 void injectNMI();
14300
14312 void dumpGuestCore (
14313 in wstring filename
14314 );
14315
14316 };
14317
14318 interface IUSBController : $unknown
14319 {
14328 attribute boolean enabled;
14329
14338 attribute boolean enabledEhci;
14339
14345 readonly attribute boolean proxyAvailable;
14346
14354 readonly attribute unsigned short USBStandard;
14355
14381 readonly attribute IUSBDeviceFilter[] deviceFilters;
14382
14410 void createDeviceFilter (
14411 in wstring name,
14412 [retval] out IUSBDeviceFilter filter
14413 );
14414
14459 void insertDeviceFilter (
14460 in unsigned long position,
14461 in IUSBDeviceFilter filter
14462 );
14463
14496 void removeDeviceFilter (
14497 in unsigned long position,
14498 [retval] out IUSBDeviceFilter filter
14499 );
14500
14501 };
14502
14515 interface IUSBDevice : $unknown
14516 {
14523 readonly attribute wstringUUID id;
14524
14528 readonly attribute unsigned short vendorId;
14529
14533 readonly attribute unsigned short productId;
14534
14542 readonly attribute unsigned short revision;
14543
14547 readonly attribute wstring manufacturer;
14548
14552 readonly attribute wstring product;
14553
14557 readonly attribute wstring serialNumber;
14558
14562 readonly attribute wstring address;
14563
14570 readonly attribute unsigned short port;
14571
14577 readonly attribute unsigned short version;
14578
14586 readonly attribute unsigned short portVersion;
14587
14594 readonly attribute boolean remote;
14595
14596 };
14597
14671 interface IUSBDeviceFilter : $unknown
14672 {
14680 attribute wstring name;
14681
14685 attribute boolean active;
14686
14694 attribute wstring vendorId;
14695
14703 attribute wstring productId;
14704
14718 attribute wstring revision;
14719
14724 attribute wstring manufacturer;
14725
14730 attribute wstring product;
14731
14736 attribute wstring serialNumber;
14737
14742 attribute wstring port;
14743
14753 attribute wstring remote;
14754
14764 attribute unsigned long maskedInterfaces;
14765
14766 };
14767
14783 interface IHostUSBDevice : IUSBDevice
14784 {
14790 readonly attribute USBDeviceState state;
14791
14792 };
14793
14816 interface IHostUSBDeviceFilter : IUSBDeviceFilter
14817 {
14824 attribute USBDeviceFilterAction action;
14825
14826 };
14827
14836 interface IAudioAdapter : $unknown
14837 {
14846 attribute boolean enabled;
14847
14853 attribute AudioControllerType audioController;
14854
14861 attribute AudioDriverType audioDriver;
14862
14863 };
14864
14865 interface IVRDEServer : $unknown
14866 {
14870 attribute boolean enabled;
14871
14875 attribute AuthType authType;
14876
14880 attribute unsigned long authTimeout;
14881
14888 attribute boolean allowMultiConnection;
14889
14897 attribute boolean reuseSingleConnection;
14898
14904 attribute boolean videoChannel;
14905
14911 attribute unsigned long videoChannelQuality;
14912
14919 attribute wstring VRDEExtPack;
14920
14927 attribute wstring AuthLibrary;
14928
14934 readonly attribute wstring[] VRDEProperties;
14935
14949 void setVRDEProperty (
14950 in wstring key,
14951 in wstring value
14952 );
14953
14967 void getVRDEProperty (
14968 in wstring key,
14969 [retval] out wstring value
14970 );
14971
14972 };
14973
15031 interface ISharedFolder : $unknown
15032 {
15036 readonly attribute wstring name;
15037
15041 readonly attribute wstring hostPath;
15042
15052 readonly attribute boolean accessible;
15053
15060 readonly attribute boolean writable;
15061
15067 readonly attribute boolean autoMount;
15068
15081 readonly attribute wstring lastAccessError;
15082
15083 };
15084
15085 interface IInternalSessionControl : $unknown
15086 {
15091 void getPID (
15092 [retval] out unsigned long pid
15093 );
15094
15116 void getRemoteConsole (
15117 [retval] out IConsole console
15118 );
15119
15143 void assignMachine (
15144 in IMachine machine
15145 );
15146
15161 void assignRemoteMachine (
15162 in IMachine machine,
15163 in IConsole console
15164 );
15165
15189 void updateMachineState (
15190 in MachineState aMachineState
15191 );
15192
15208 void uninitialize();
15209
15232 void onNetworkAdapterChange (
15233 in INetworkAdapter networkAdapter,
15234 in boolean changeAdapter
15235 );
15236
15259 void onSerialPortChange (
15260 in ISerialPort serialPort
15261 );
15262
15285 void onParallelPortChange (
15286 in IParallelPort parallelPort
15287 );
15288
15311 void onStorageControllerChange();
15312
15335 void onMediumChange (
15336 in IMediumAttachment mediumAttachment,
15337 in boolean force
15338 );
15339
15349 void onCPUChange (
15350 in unsigned long cpu,
15351 in boolean add
15352 );
15353
15361 void onCPUExecutionCapChange (
15362 in unsigned long executionCap
15363 );
15364
15389 void onVRDEServerChange (
15390 in boolean restart
15391 );
15392
15415 void onUSBControllerChange();
15416
15445 void onSharedFolderChange (
15446 in boolean global
15447 );
15448
15474 void onUSBDeviceAttach (
15475 in IUSBDevice device,
15476 in IVirtualBoxErrorInfo error,
15477 in unsigned long maskedInterfaces
15478 );
15479
15505 void onUSBDeviceDetach (
15506 in wstringUUID id,
15507 in IVirtualBoxErrorInfo error
15508 );
15509
15527 void onShowWindow (
15528 in boolean check,
15529 out boolean canShow,
15530 out long long winId
15531 );
15532
15540 void onBandwidthGroupChange (
15541 in IBandwidthGroup bandwidthGroup
15542 );
15543
15567 void accessGuestProperty (
15568 in wstring name,
15569 in wstring value,
15570 in wstring flags,
15571 in boolean isSetter,
15572 out wstring retValue,
15573 out long long retTimestamp,
15574 out wstring retFlags
15575 );
15576
15624 void enumerateGuestProperties (
15625 in wstring patterns,
15626 out wstring[] key,
15627 out wstring[] value,
15628 out long long[] timestamp,
15629 out wstring[] flags
15630 );
15631
15677 void onlineMergeMedium (
15678 in IMediumAttachment mediumAttachment,
15679 in unsigned long sourceIdx,
15680 in unsigned long targetIdx,
15681 in IMedium source,
15682 in IMedium target,
15683 in boolean mergeForward,
15684 in IMedium parentForTarget,
15685 in IMedium[] childrenToReparent,
15686 in IProgress progress
15687 );
15688
15689 };
15690
15749 interface ISession : $unknown
15750 {
15754 readonly attribute SessionState state;
15755
15763 readonly attribute SessionType type;
15764
15768 readonly attribute IMachine machine;
15769
15773 readonly attribute IConsole console;
15774
15806 void unlockMachine();
15807
15808 };
15809
15832 interface IStorageController : $unknown
15833 {
15842 readonly attribute wstring name;
15843
15849 readonly attribute unsigned long maxDevicesPerPortCount;
15850
15856 readonly attribute unsigned long minPortCount;
15857
15863 readonly attribute unsigned long maxPortCount;
15864
15870 attribute unsigned long instance;
15871
15880 attribute unsigned long portCount;
15881
15887 readonly attribute StorageBus bus;
15888
15901 attribute StorageControllerType controllerType;
15902
15917 attribute boolean useHostIOCache;
15918
15924 readonly attribute boolean bootable;
15925
15948 void getIDEEmulationPort (
15949 in long devicePosition,
15950 [retval] out long portNumber
15951 );
15952
15976 void setIDEEmulationPort (
15977 in long devicePosition,
15978 in long portNumber
15979 );
15980
15981 };
15982
16006 interface IManagedObjectRef : $unknown
16007 {
16014 void getInterfaceName (
16015 [retval] out wstring return
16016 );
16017
16025 void release();
16026
16027 };
16028
16037 interface IWebsessionManager : $unknown
16038 {
16047 void logon (
16048 in wstring username,
16049 in wstring password,
16050 [retval] out IVirtualBox return
16051 );
16052
16062 void getSessionObject (
16063 in IVirtualBox refIVirtualBox,
16064 [retval] out ISession return
16065 );
16066
16074 void logoff (
16075 in IVirtualBox refIVirtualBox
16076 );
16077
16078 };
16079
16088 interface IPerformanceMetric : $unknown
16089 {
16095 readonly attribute wstring metricName;
16096
16102 readonly attribute $unknown object;
16103
16109 readonly attribute wstring description;
16110
16116 readonly attribute unsigned long period;
16117
16127 readonly attribute unsigned long count;
16128
16134 readonly attribute wstring unit;
16135
16141 readonly attribute long minimumValue;
16142
16148 readonly attribute long maximumValue;
16149
16150 };
16151
16257 interface IPerformanceCollector : $unknown
16258 {
16269 readonly attribute wstring[] metricNames;
16270
16294 void getMetrics (
16295 in wstring[] metricNames,
16296 in $unknown[] objects,
16297 [retval] out IPerformanceMetric[] metrics
16298 );
16299
16338 void setupMetrics (
16339 in wstring[] metricNames,
16340 in $unknown[] objects,
16341 in unsigned long period,
16342 in unsigned long count,
16343 [retval] out IPerformanceMetric[] affectedMetrics
16344 );
16345
16374 void enableMetrics (
16375 in wstring[] metricNames,
16376 in $unknown[] objects,
16377 [retval] out IPerformanceMetric[] affectedMetrics
16378 );
16379
16408 void disableMetrics (
16409 in wstring[] metricNames,
16410 in $unknown[] objects,
16411 [retval] out IPerformanceMetric[] affectedMetrics
16412 );
16413
16502 void queryMetricsData (
16503 in wstring[] metricNames,
16504 in $unknown[] objects,
16505 out wstring[] returnMetricNames,
16506 out $unknown[] returnObjects,
16507 out wstring[] returnUnits,
16508 out unsigned long[] returnScales,
16509 out unsigned long[] returnSequenceNumbers,
16510 out unsigned long[] returnDataIndices,
16511 out unsigned long[] returnDataLengths,
16512 [retval] out long[] returnData
16513 );
16514
16515 };
16516
16524 interface INATEngine : $unknown
16525 {
16530 attribute wstring network;
16531
16538 attribute wstring hostIP;
16539
16544 attribute wstring tftpPrefix;
16545
16550 attribute wstring tftpBootFile;
16551
16559 attribute wstring tftpNextServer;
16560
16564 attribute unsigned long aliasMode;
16565
16569 attribute boolean dnsPassDomain;
16570
16575 attribute boolean dnsProxy;
16576
16581 attribute boolean dnsUseHostResolver;
16582
16587 readonly attribute wstring[] redirects;
16588
16604 void setNetworkSettings (
16605 in unsigned long mtu,
16606 in unsigned long sockSnd,
16607 in unsigned long sockRcv,
16608 in unsigned long TcpWndSnd,
16609 in unsigned long TcpWndRcv
16610 );
16611
16616 void getNetworkSettings (
16617 out unsigned long mtu,
16618 out unsigned long sockSnd,
16619 out unsigned long sockRcv,
16620 out unsigned long TcpWndSnd,
16621 out unsigned long TcpWndRcv
16622 );
16623
16643 void addRedirect (
16644 in wstring name,
16645 in NATProtocol proto,
16646 in wstring hostIp,
16647 in unsigned short hostPort,
16648 in wstring guestIp,
16649 in unsigned short guestPort
16650 );
16651
16657 void removeRedirect (
16658 in wstring name
16659 );
16660
16661 };
16662
16671 interface IExtPackPlugIn : $unknown
16672 {
16676 readonly attribute wstring name;
16677
16681 readonly attribute wstring description;
16682
16688 readonly attribute wstring frontend;
16689
16693 readonly attribute wstring modulePath;
16694
16695 };
16696
16705 interface IExtPackBase : $unknown
16706 {
16710 readonly attribute wstring name;
16711
16715 readonly attribute wstring description;
16716
16725 readonly attribute wstring version;
16726
16730 readonly attribute unsigned long revision;
16731
16735 readonly attribute wstring VRDEModule;
16736
16740 readonly attribute IExtPackPlugIn[] plugIns;
16741
16751 readonly attribute boolean usable;
16752
16759 readonly attribute wstring whyUnusable;
16760
16764 readonly attribute boolean showLicense;
16765
16774 readonly attribute wstring license;
16775
16799 void queryLicense (
16800 in wstring preferredLocale,
16801 in wstring preferredLanguage,
16802 in wstring format,
16803 [retval] out wstring licenseText
16804 );
16805
16806 };
16807
16816 interface IExtPack : IExtPackBase
16817 {
16829 void queryObject (
16830 in wstring objUuid,
16831 [retval] out $unknown returnInterface
16832 );
16833
16834 };
16835
16846 interface IExtPackFile : IExtPackBase
16847 {
16853 readonly attribute wstring filePath;
16854
16865 void install (
16866 in boolean replace
16867 );
16868
16869 };
16870
16881 interface IExtPackManager : $unknown
16882 {
16888 readonly attribute IExtPack[] installedExtPacks;
16889
16907 void find (
16908 in wstring name,
16909 [retval] out IExtPack returnData
16910 );
16911
16922 void openExtPackFile (
16923 in wstring path,
16924 [retval] out IExtPackFile file
16925 );
16926
16937 void uninstall (
16938 in wstring name,
16939 in boolean forcedRemoval
16940 );
16941
16945 void cleanup();
16946
16959 void QueryAllPlugInsForFrontend (
16960 in wstring frontendName,
16961 [retval] out wstring[] plugInModules
16962 );
16963
16969 void IsExtPackUsable (
16970 in wstring name,
16971 [retval] out boolean usable
16972 );
16973
16974 };
16975
16981 interface IBandwidthGroup : $unknown
16982 {
16986 readonly attribute wstring name;
16987
16991 readonly attribute BandwidthGroupType type;
16992
16996 readonly attribute unsigned long reference;
16997
17002 attribute unsigned long maxMbPerSec;
17003
17004 };
17005
17014 interface IBandwidthControl : $unknown
17015 {
17021 readonly attribute unsigned long numGroups;
17022
17035 void CreateBandwidthGroup (
17036 in wstring name,
17037 in BandwidthGroupType type,
17038 in unsigned long maxBytesPerSec
17039 );
17040
17048 void DeleteBandwidthGroup (
17049 in wstring name
17050 );
17051
17061 void GetBandwidthGroup (
17062 in wstring name,
17063 [retval] out IBandwidthGroup bandwidthGroup
17064 );
17065
17073 void GetAllBandwidthGroups (
17074 [retval] out IBandwidthGroup[] bandwidthGroups
17075 );
17076
17077 };
17078
17091 interface IVirtualBoxClient : $unknown
17092 {
17098 readonly attribute IVirtualBox virtualBox;
17099
17105 readonly attribute ISession session;
17106
17112 readonly attribute IEventSource eventSource;
17113
17114 };
17115
17129 interface IEventSource : $unknown
17130 {
17136 void createListener (
17137 [retval] out IEventListener listener
17138 );
17139
17151 void createAggregator (
17152 in IEventSource[] subordinates,
17153 [retval] out IEventSource result
17154 );
17155
17188 void registerListener (
17189 in IEventListener listener,
17190 in VBoxEventType[] interesting,
17191 in boolean active
17192 );
17193
17202 void unregisterListener (
17203 in IEventListener listener
17204 );
17205
17220 void fireEvent (
17221 in IEvent event,
17222 in long timeout,
17223 [retval] out boolean result
17224 );
17225
17250 void getEvent (
17251 in IEventListener listener,
17252 in long timeout,
17253 [retval] out IEvent event
17254 );
17255
17267 void eventProcessed (
17268 in IEventListener listener,
17269 in IEvent event
17270 );
17271
17272 };
17273
17283 interface IEventListener : $unknown
17284 {
17295 void handleEvent (
17296 in IEvent event
17297 );
17298
17299 };
17300
17377 interface IEvent : $unknown
17378 {
17384 readonly attribute VBoxEventType type;
17385
17391 readonly attribute IEventSource source;
17392
17403 readonly attribute boolean waitable;
17404
17411 void setProcessed();
17412
17426 void waitProcessed (
17427 in long timeout,
17428 [retval] out boolean result
17429 );
17430
17431 };
17432
17438 interface IReusableEvent : IEvent
17439 {
17443 readonly attribute unsigned long generation;
17444
17451 void reuse();
17452
17453 };
17454
17460 interface IMachineEvent : IEvent
17461 {
17465 readonly attribute wstringUUID machineId;
17466
17467 };
17468
17474 interface IMachineStateChangedEvent : IMachineEvent
17475 {
17479 readonly attribute MachineState state;
17480
17481 };
17482
17490 interface IMachineDataChangedEvent : IMachineEvent
17491 {
17492 };
17493
17502 interface IMediumRegisteredEvent : IEvent
17503 {
17507 readonly attribute wstringUUID mediumId;
17508
17512 readonly attribute DeviceType mediumType;
17513
17520 readonly attribute boolean registered;
17521
17522 };
17523
17532 interface IMachineRegisteredEvent : IMachineEvent
17533 {
17540 readonly attribute boolean registered;
17541
17542 };
17543
17553 interface ISessionStateChangedEvent : IMachineEvent
17554 {
17560 readonly attribute SessionState state;
17561
17562 };
17563
17571 interface IGuestPropertyChangedEvent : IMachineEvent
17572 {
17578 readonly attribute wstring name;
17579
17585 readonly attribute wstring value;
17586
17592 readonly attribute wstring flags;
17593
17594 };
17595
17601 interface ISnapshotEvent : IMachineEvent
17602 {
17606 readonly attribute wstringUUID snapshotId;
17607
17608 };
17609
17619 interface ISnapshotTakenEvent : ISnapshotEvent
17620 {
17621 };
17622
17639 interface ISnapshotDeletedEvent : ISnapshotEvent
17640 {
17641 };
17642
17652 interface ISnapshotChangedEvent : ISnapshotEvent
17653 {
17654 };
17655
17664 interface IMousePointerShapeChangedEvent : IEvent
17665 {
17671 readonly attribute boolean visible;
17672
17678 readonly attribute boolean alpha;
17679
17685 readonly attribute unsigned long xhot;
17686
17692 readonly attribute unsigned long yhot;
17693
17699 readonly attribute unsigned long width;
17700
17706 readonly attribute unsigned long height;
17707
17740 readonly attribute octet[] shape;
17741
17742 };
17743
17752 interface IMouseCapabilityChangedEvent : IEvent
17753 {
17759 readonly attribute boolean supportsAbsolute;
17760
17766 readonly attribute boolean supportsRelative;
17767
17773 readonly attribute boolean needsHostCursor;
17774
17775 };
17776
17785 interface IKeyboardLedsChangedEvent : IEvent
17786 {
17792 readonly attribute boolean numLock;
17793
17799 readonly attribute boolean capsLock;
17800
17806 readonly attribute boolean scrollLock;
17807
17808 };
17809
17818 interface IStateChangedEvent : IEvent
17819 {
17825 readonly attribute MachineState state;
17826
17827 };
17828
17838 interface IAdditionsStateChangedEvent : IEvent
17839 {
17840 };
17841
17852 interface INetworkAdapterChangedEvent : IEvent
17853 {
17859 readonly attribute INetworkAdapter networkAdapter;
17860
17861 };
17862
17873 interface ISerialPortChangedEvent : IEvent
17874 {
17880 readonly attribute ISerialPort serialPort;
17881
17882 };
17883
17894 interface IParallelPortChangedEvent : IEvent
17895 {
17901 readonly attribute IParallelPort parallelPort;
17902
17903 };
17904
17914 interface IStorageControllerChangedEvent : IEvent
17915 {
17916 };
17917
17927 interface IMediumChangedEvent : IEvent
17928 {
17934 readonly attribute IMediumAttachment mediumAttachment;
17935
17936 };
17937
17945 interface ICPUChangedEvent : IEvent
17946 {
17952 readonly attribute unsigned long cpu;
17953
17959 readonly attribute boolean add;
17960
17961 };
17962
17970 interface ICPUExecutionCapChangedEvent : IEvent
17971 {
17977 readonly attribute unsigned long executionCap;
17978
17979 };
17980
17988 interface IGuestKeyboardEvent : IEvent
17989 {
17995 readonly attribute long[] scancodes;
17996
17997 };
17998
18006 interface IGuestMouseEvent : IReusableEvent
18007 {
18013 readonly attribute boolean absolute;
18014
18020 readonly attribute long x;
18021
18027 readonly attribute long y;
18028
18034 readonly attribute long z;
18035
18041 readonly attribute long w;
18042
18048 readonly attribute long buttons;
18049
18050 };
18051
18062 interface IVRDEServerChangedEvent : IEvent
18063 {
18064 };
18065
18075 interface IVRDEServerInfoChangedEvent : IEvent
18076 {
18077 };
18078
18089 interface IUSBControllerChangedEvent : IEvent
18090 {
18091 };
18092
18116 interface IUSBDeviceStateChangedEvent : IEvent
18117 {
18123 readonly attribute IUSBDevice device;
18124
18130 readonly attribute boolean attached;
18131
18137 readonly attribute IVirtualBoxErrorInfo error;
18138
18139 };
18140
18156 interface ISharedFolderChangedEvent : IEvent
18157 {
18163 readonly attribute Scope scope;
18164
18165 };
18166
18218 interface IRuntimeErrorEvent : IEvent
18219 {
18225 readonly attribute boolean fatal;
18226
18232 readonly attribute wstring id;
18233
18239 readonly attribute wstring message;
18240
18241 };
18242
18250 interface IEventSourceChangedEvent : IEvent
18251 {
18257 readonly attribute IEventListener listener;
18258
18264 readonly attribute boolean add;
18265
18266 };
18267
18276 interface IExtraDataChangedEvent : IEvent
18277 {
18284 readonly attribute wstringUUID machineId;
18285
18291 readonly attribute wstring key;
18292
18298 readonly attribute wstring value;
18299
18300 };
18301
18307 interface IVetoEvent : IEvent
18308 {
18318 void addVeto (
18319 in wstring reason
18320 );
18321
18331 void isVetoed (
18332 [retval] out boolean result
18333 );
18334
18344 void getVetos (
18345 [retval] out wstring[] result
18346 );
18347
18348 };
18349
18359 interface IExtraDataCanChangeEvent : IVetoEvent
18360 {
18367 readonly attribute wstringUUID machineId;
18368
18374 readonly attribute wstring key;
18375
18381 readonly attribute wstring value;
18382
18383 };
18384
18400 interface ICanShowWindowEvent : IVetoEvent
18401 {
18402 };
18403
18435 interface IShowWindowEvent : IEvent
18436 {
18445 attribute long long winId;
18446
18447 };
18448
18456 interface INATRedirectEvent : IMachineEvent
18457 {
18463 readonly attribute unsigned long slot;
18464
18470 readonly attribute boolean remove;
18471
18477 readonly attribute wstring name;
18478
18484 readonly attribute NATProtocol proto;
18485
18491 readonly attribute wstring hostIp;
18492
18498 readonly attribute long hostPort;
18499
18505 readonly attribute wstring guestIp;
18506
18512 readonly attribute long guestPort;
18513
18514 };
18515
18523 interface IHostPciDevicePlugEvent : IMachineEvent
18524 {
18530 readonly attribute boolean plugged;
18531
18538 readonly attribute boolean success;
18539
18545 readonly attribute IPciDeviceAttachment attachment;
18546
18553 readonly attribute IEventContext eventContext;
18554
18560 readonly attribute wstring message;
18561
18562 };
18563
18572 interface IVBoxSVCUnavailableEvent : IEvent
18573 {
18574 };
18575
18583 interface IBandwidthGroupChangedEvent : IEvent
18584 {
18590 readonly attribute IBandwidthGroup bandwidthGroup;
18591
18592 };
18593
18594