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,
01603 };
01604
01614 enum MediumVariant
01615 {
01622 MediumVariant_Standard = 0,
01629 MediumVariant_VmdkSplit2G = 0x01,
01637 MediumVariant_VmdkStreamOptimized = 0x04,
01644 MediumVariant_VmdkESX = 0x08,
01651 MediumVariant_Fixed = 0x10000,
01658 MediumVariant_Diff = 0x20000,
01659 };
01660
01661 enum DataType
01662 {
01663 DataType_Int32 = 0,
01664 DataType_Int8 = 1,
01665 DataType_String = 2,
01666 };
01667
01668 enum DataFlags
01669 {
01670 DataFlags_None = 0x00,
01671 DataFlags_Mandatory = 0x01,
01672 DataFlags_Expert = 0x02,
01673 DataFlags_Array = 0x04,
01674 DataFlags_FlagMask = 0x07,
01675 };
01676
01684 enum MediumFormatCapabilities
01685 {
01692 MediumFormatCapabilities_Uuid = 0x01,
01699 MediumFormatCapabilities_CreateFixed = 0x02,
01707 MediumFormatCapabilities_CreateDynamic = 0x04,
01714 MediumFormatCapabilities_CreateSplit2G = 0x08,
01721 MediumFormatCapabilities_Differencing = 0x10,
01728 MediumFormatCapabilities_Asynchronous = 0x20,
01738 MediumFormatCapabilities_File = 0x40,
01747 MediumFormatCapabilities_Properties = 0x80,
01754 MediumFormatCapabilities_TcpNetworking = 0x100,
01761 MediumFormatCapabilities_VFS = 0x200,
01762 MediumFormatCapabilities_CapabilityMask = 0x3FF,
01763 };
01764
01772 enum MouseButtonState
01773 {
01774 MouseButtonState_LeftButton = 0x01,
01775 MouseButtonState_RightButton = 0x02,
01776 MouseButtonState_MiddleButton = 0x04,
01777 MouseButtonState_WheelUp = 0x08,
01778 MouseButtonState_WheelDown = 0x10,
01779 MouseButtonState_XButton1 = 0x20,
01780 MouseButtonState_XButton2 = 0x40,
01781 MouseButtonState_MouseStateMask = 0x7F,
01782 };
01783
01794 enum FramebufferPixelFormat
01795 {
01803 FramebufferPixelFormat_Opaque = 0,
01811 FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
01812 };
01813
01821 enum NetworkAttachmentType
01822 {
01827 NetworkAttachmentType_Null = 0,
01828 NetworkAttachmentType_NAT = 1,
01829 NetworkAttachmentType_Bridged = 2,
01830 NetworkAttachmentType_Internal = 3,
01831 NetworkAttachmentType_HostOnly = 4,
01832 NetworkAttachmentType_VDE = 5,
01833 };
01834
01842 enum NetworkAdapterType
01843 {
01848 NetworkAdapterType_Null = 0,
01853 NetworkAdapterType_Am79C970A = 1,
01858 NetworkAdapterType_Am79C973 = 2,
01863 NetworkAdapterType_I82540EM = 3,
01868 NetworkAdapterType_I82543GC = 4,
01873 NetworkAdapterType_I82545EM = 5,
01878 NetworkAdapterType_Virtio = 6,
01879 };
01880
01889 enum PortMode
01890 {
01895 PortMode_Disconnected = 0,
01900 PortMode_HostPipe = 1,
01905 PortMode_HostDevice = 2,
01910 PortMode_RawFile = 3,
01911 };
01912
01951 enum USBDeviceState
01952 {
01959 USBDeviceState_NotSupported = 0,
01967 USBDeviceState_Unavailable = 1,
01974 USBDeviceState_Busy = 2,
01982 USBDeviceState_Available = 3,
01990 USBDeviceState_Held = 4,
01998 USBDeviceState_Captured = 5,
01999 };
02000
02010 enum USBDeviceFilterAction
02011 {
02016 USBDeviceFilterAction_Null = 0,
02021 USBDeviceFilterAction_Ignore = 1,
02026 USBDeviceFilterAction_Hold = 2,
02027 };
02028
02036 enum AudioDriverType
02037 {
02042 AudioDriverType_Null = 0,
02047 AudioDriverType_WinMM = 1,
02052 AudioDriverType_OSS = 2,
02057 AudioDriverType_ALSA = 3,
02062 AudioDriverType_DirectSound = 4,
02067 AudioDriverType_CoreAudio = 5,
02072 AudioDriverType_MMPM = 6,
02077 AudioDriverType_Pulse = 7,
02082 AudioDriverType_SolAudio = 8,
02083 };
02084
02092 enum AudioControllerType
02093 {
02094 AudioControllerType_AC97 = 0,
02095 AudioControllerType_SB16 = 1,
02096 AudioControllerType_HDA = 2,
02097 };
02098
02106 enum AuthType
02107 {
02112 AuthType_Null = 0,
02113 AuthType_External = 1,
02114 AuthType_Guest = 2,
02115 };
02116
02125 enum StorageBus
02126 {
02131 StorageBus_Null = 0,
02132 StorageBus_IDE = 1,
02133 StorageBus_SATA = 2,
02134 StorageBus_SCSI = 3,
02135 StorageBus_Floppy = 4,
02136 StorageBus_SAS = 5,
02137 };
02138
02147 enum StorageControllerType
02148 {
02153 StorageControllerType_Null = 0,
02158 StorageControllerType_LsiLogic = 1,
02163 StorageControllerType_BusLogic = 2,
02168 StorageControllerType_IntelAhci = 3,
02173 StorageControllerType_PIIX3 = 4,
02178 StorageControllerType_PIIX4 = 5,
02183 StorageControllerType_ICH6 = 6,
02188 StorageControllerType_I82078 = 7,
02193 StorageControllerType_LsiLogicSas = 8,
02194 };
02195
02203 enum ChipsetType
02204 {
02209 ChipsetType_Null = 0,
02214 ChipsetType_PIIX3 = 1,
02219 ChipsetType_ICH9 = 2,
02220 };
02221
02227 enum NATAliasMode
02228 {
02233 NATAliasMode_AliasLog = 0x1,
02238 NATAliasMode_AliasProxyOnly = 0x02,
02243 NATAliasMode_AliasUseSamePorts = 0x04,
02244 };
02245
02251 enum NATProtocol
02252 {
02257 NATProtocol_UDP = 0,
02262 NATProtocol_TCP = 1,
02263 };
02264
02272 enum BandwidthGroupType
02273 {
02280 BandwidthGroupType_Null = 0,
02287 BandwidthGroupType_Disk = 1,
02294 BandwidthGroupType_Network = 2,
02295 };
02296
02305 enum VBoxEventType
02306 {
02313 VBoxEventType_Invalid = 0,
02322 VBoxEventType_Any = 1,
02330 VBoxEventType_Vetoable = 2,
02338 VBoxEventType_MachineEvent = 3,
02346 VBoxEventType_SnapshotEvent = 4,
02355 VBoxEventType_InputEvent = 5,
02362 VBoxEventType_LastWildcard = 31,
02369 VBoxEventType_OnMachineStateChanged = 32,
02376 VBoxEventType_OnMachineDataChanged = 33,
02383 VBoxEventType_OnExtraDataChanged = 34,
02390 VBoxEventType_OnExtraDataCanChange = 35,
02397 VBoxEventType_OnMediumRegistered = 36,
02404 VBoxEventType_OnMachineRegistered = 37,
02411 VBoxEventType_OnSessionStateChanged = 38,
02418 VBoxEventType_OnSnapshotTaken = 39,
02425 VBoxEventType_OnSnapshotDeleted = 40,
02432 VBoxEventType_OnSnapshotChanged = 41,
02439 VBoxEventType_OnGuestPropertyChanged = 42,
02446 VBoxEventType_OnMousePointerShapeChanged = 43,
02453 VBoxEventType_OnMouseCapabilityChanged = 44,
02460 VBoxEventType_OnKeyboardLedsChanged = 45,
02467 VBoxEventType_OnStateChanged = 46,
02474 VBoxEventType_OnAdditionsStateChanged = 47,
02481 VBoxEventType_OnNetworkAdapterChanged = 48,
02488 VBoxEventType_OnSerialPortChanged = 49,
02495 VBoxEventType_OnParallelPortChanged = 50,
02502 VBoxEventType_OnStorageControllerChanged = 51,
02509 VBoxEventType_OnMediumChanged = 52,
02516 VBoxEventType_OnVRDEServerChanged = 53,
02523 VBoxEventType_OnUSBControllerChanged = 54,
02530 VBoxEventType_OnUSBDeviceStateChanged = 55,
02537 VBoxEventType_OnSharedFolderChanged = 56,
02544 VBoxEventType_OnRuntimeError = 57,
02551 VBoxEventType_OnCanShowWindow = 58,
02558 VBoxEventType_OnShowWindow = 59,
02565 VBoxEventType_OnCPUChanged = 60,
02572 VBoxEventType_OnVRDEServerInfoChanged = 61,
02579 VBoxEventType_OnEventSourceChanged = 62,
02586 VBoxEventType_OnCPUExecutionCapChanged = 63,
02593 VBoxEventType_OnGuestKeyboard = 64,
02600 VBoxEventType_OnGuestMouse = 65,
02607 VBoxEventType_OnNATRedirect = 66,
02614 VBoxEventType_OnHostPciDevicePlug = 67,
02621 VBoxEventType_OnVBoxSVCUnavailable = 68,
02628 VBoxEventType_OnBandwidthGroupChanged = 69,
02635 VBoxEventType_Last = 70,
02636 };
02637
02670 interface IVirtualBoxErrorInfo : $errorinfo
02671 {
02689 readonly attribute long resultCode;
02690
02702 readonly attribute wstringUUID interfaceID;
02703
02714 readonly attribute wstring component;
02715
02726 readonly attribute wstring text;
02727
02738 readonly attribute IVirtualBoxErrorInfo next;
02739
02740 };
02741
02752 interface IDHCPServer : $unknown
02753 {
02759 attribute boolean enabled;
02760
02766 readonly attribute wstring IPAddress;
02767
02773 readonly attribute wstring networkMask;
02774
02780 readonly attribute wstring networkName;
02781
02787 readonly attribute wstring lowerIP;
02788
02794 readonly attribute wstring upperIP;
02795
02824 void setConfiguration (
02825 in wstring IPAddress,
02826 in wstring networkMask,
02827 in wstring FromIPAddress,
02828 in wstring ToIPAddress
02829 );
02830
02855 void start (
02856 in wstring networkName,
02857 in wstring trunkName,
02858 in wstring trunkType
02859 );
02860
02873 void stop();
02874
02875 };
02876
02895 interface IVirtualBox : $unknown
02896 {
02904 readonly attribute wstring version;
02905
02911 readonly attribute unsigned long revision;
02912
02922 readonly attribute wstring packageType;
02923
02939 readonly attribute wstring homeFolder;
02940
02948 readonly attribute wstring settingsFilePath;
02949
02953 readonly attribute IHost host;
02954
02958 readonly attribute ISystemProperties systemProperties;
02959
02965 readonly attribute IMachine[] machines;
02966
02976 readonly attribute IMedium[] hardDisks;
02977
02983 readonly attribute IMedium[] DVDImages;
02984
02990 readonly attribute IMedium[] floppyImages;
02991
02992 readonly attribute IProgress[] progressOperations;
02993
02994 readonly attribute IGuestOSType[] guestOSTypes;
02995
03012 readonly attribute ISharedFolder[] sharedFolders;
03013
03019 readonly attribute IPerformanceCollector performanceCollector;
03020
03026 readonly attribute IDHCPServer[] DHCPServers;
03027
03033 readonly attribute IEventSource eventSource;
03034
03040 readonly attribute IExtPackManager extensionPackManager;
03041
03081 void composeMachineFilename (
03082 in wstring name,
03083 in wstring baseFolder,
03084 [retval] out wstring file
03085 );
03086
03183 void createMachine (
03184 in wstring settingsFile,
03185 in wstring name,
03186 in wstring osTypeId,
03187 in wstringUUID id,
03188 in boolean forceOverwrite,
03189 [retval] out IMachine machine
03190 );
03191
03217 void openMachine (
03218 in wstring settingsFile,
03219 [retval] out IMachine machine
03220 );
03221
03253 void registerMachine (
03254 in IMachine machine
03255 );
03256
03277 void findMachine (
03278 in wstring nameOrId,
03279 [retval] out IMachine machine
03280 );
03281
03291 void createAppliance (
03292 [retval] out IAppliance appliance
03293 );
03294
03357 void createHardDisk (
03358 in wstring format,
03359 in wstring location,
03360 [retval] out IMedium medium
03361 );
03362
03474 void openMedium (
03475 in wstring location,
03476 in DeviceType deviceType,
03477 in AccessMode accessMode,
03478 [retval] out IMedium medium
03479 );
03480
03512 void findMedium (
03513 in wstring location,
03514 in DeviceType type,
03515 [retval] out IMedium medium
03516 );
03517
03546 void getGuestOSType (
03547 in wstringUUID id,
03548 [retval] out IGuestOSType type
03549 );
03550
03573 void createSharedFolder (
03574 in wstring name,
03575 in wstring hostPath,
03576 in boolean writable,
03577 in boolean automount
03578 );
03579
03594 void removeSharedFolder (
03595 in wstring name
03596 );
03597
03606 void getExtraDataKeys (
03607 [retval] out wstring[] value
03608 );
03609
03638 void getExtraData (
03639 in wstring key,
03640 [retval] out wstring value
03641 );
03642
03692 void setExtraData (
03693 in wstring key,
03694 in wstring value
03695 );
03696
03713 void createDHCPServer (
03714 in wstring name,
03715 [retval] out IDHCPServer server
03716 );
03717
03734 void findDHCPServerByNetworkName (
03735 in wstring name,
03736 [retval] out IDHCPServer server
03737 );
03738
03753 void removeDHCPServer (
03754 in IDHCPServer server
03755 );
03756
03781 void checkFirmwarePresent (
03782 in FirmwareType firmwareType,
03783 in wstring version,
03784 out wstring url,
03785 out wstring file,
03786 [retval] out boolean result
03787 );
03788
03789 };
03790
03801 interface IVFSExplorer : $unknown
03802 {
03806 readonly attribute wstring path;
03807
03811 readonly attribute VFSType type;
03812
03820 void update (
03821 [retval] out IProgress aProgress
03822 );
03823
03831 void cd (
03832 in wstring aDir,
03833 [retval] out IProgress aProgress
03834 );
03835
03841 void cdUp (
03842 [retval] out IProgress aProgress
03843 );
03844
03857 void entryList (
03858 out wstring[] aNames,
03859 out unsigned long[] aTypes,
03860 out unsigned long[] aSizes,
03861 out unsigned long[] aModes
03862 );
03863
03872 void exists (
03873 in wstring[] aNames,
03874 [retval] out wstring[] aExists
03875 );
03876
03884 void remove (
03885 in wstring[] aNames,
03886 [retval] out IProgress aProgress
03887 );
03888
03889 };
03890
03956 interface IAppliance : $unknown
03957 {
03965 readonly attribute wstring path;
03966
03997 readonly attribute wstring[] disks;
03998
04006 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
04007
04015 readonly attribute wstring[] machines;
04016
04033 void read (
04034 in wstring file,
04035 [retval] out IProgress aProgress
04036 );
04037
04054 void interpret();
04055
04076 void importMachines (
04077 [retval] out IProgress aProgress
04078 );
04079
04087 void createVFSExplorer (
04088 in wstring aUri,
04089 [retval] out IVFSExplorer aExplorer
04090 );
04091
04121 void write (
04122 in wstring format,
04123 in boolean manifest,
04124 in wstring path,
04125 [retval] out IProgress progress
04126 );
04127
04133 void getWarnings (
04134 [retval] out wstring[] aWarnings
04135 );
04136
04137 };
04138
04150 interface IVirtualSystemDescription : $unknown
04151 {
04155 readonly attribute unsigned long count;
04156
04280 void getDescription (
04281 out VirtualSystemDescriptionType[] aTypes,
04282 out wstring[] aRefs,
04283 out wstring[] aOvfValues,
04284 out wstring[] aVBoxValues,
04285 out wstring[] aExtraConfigValues
04286 );
04287
04304 void getDescriptionByType (
04305 in VirtualSystemDescriptionType aType,
04306 out VirtualSystemDescriptionType[] aTypes,
04307 out wstring[] aRefs,
04308 out wstring[] aOvfValues,
04309 out wstring[] aVBoxValues,
04310 out wstring[] aExtraConfigValues
04311 );
04312
04324 void getValuesByType (
04325 in VirtualSystemDescriptionType aType,
04326 in VirtualSystemDescriptionValueType aWhich,
04327 [retval] out wstring[] aValues
04328 );
04329
04355 void setFinalValues (
04356 in boolean[] aEnabled,
04357 in wstring[] aVBoxValues,
04358 in wstring[] aExtraConfigValues
04359 );
04360
04375 void addDescription (
04376 in VirtualSystemDescriptionType aType,
04377 in wstring aVBoxValue,
04378 in wstring aExtraConfigValue
04379 );
04380
04381 };
04382
04383 interface IInternalMachineControl : $unknown
04384 {
04391 void setRemoveSavedStateFile (
04392 in boolean aRemove
04393 );
04394
04406 void updateState (
04407 in MachineState state
04408 );
04409
04410 void getIPCId (
04411 [retval] out wstring id
04412 );
04413
04425 void beginPowerUp (
04426 in IProgress aProgress
04427 );
04428
04438 void endPowerUp (
04439 in long result
04440 );
04441
04455 void runUSBDeviceFilters (
04456 in IUSBDevice device,
04457 out boolean matched,
04458 out unsigned long maskedInterfaces
04459 );
04460
04469 void captureUSBDevice (
04470 in wstringUUID id
04471 );
04472
04488 void detachUSBDevice (
04489 in wstringUUID id,
04490 in boolean done
04491 );
04492
04501 void autoCaptureUSBDevices();
04502
04518 void detachAllUSBDevices (
04519 in boolean done
04520 );
04521
04536 void onSessionEnd (
04537 in ISession session,
04538 [retval] out IProgress progress
04539 );
04540
04556 void beginSavingState (
04557 out IProgress progress,
04558 out wstring stateFilePath
04559 );
04560
04590 void endSavingState (
04591 in long result,
04592 in wstring errMsg
04593 );
04594
04609 void adoptSavedState (
04610 in wstring savedStateFile
04611 );
04612
04661 void beginTakingSnapshot (
04662 in IConsole initiator,
04663 in wstring name,
04664 in wstring description,
04665 in IProgress consoleProgress,
04666 in boolean fTakingSnapshotOnline,
04667 out wstring stateFilePath
04668 );
04669
04679 void endTakingSnapshot (
04680 in boolean success
04681 );
04682
04703 void deleteSnapshot (
04704 in IConsole initiator,
04705 in wstringUUID id,
04706 out MachineState machineState,
04707 [retval] out IProgress progress
04708 );
04709
04728 void finishOnlineMergeMedium (
04729 in IMediumAttachment mediumAttachment,
04730 in IMedium source,
04731 in IMedium target,
04732 in boolean mergeForward,
04733 in IMedium parentForTarget,
04734 in IMedium[] childrenToReparent
04735 );
04736
04750 void restoreSnapshot (
04751 in IConsole initiator,
04752 in ISnapshot snapshot,
04753 out MachineState machineState,
04754 [retval] out IProgress progress
04755 );
04756
04783 void pullGuestProperties (
04784 out wstring[] name,
04785 out wstring[] value,
04786 out long long[] timestamp,
04787 out wstring[] flags
04788 );
04789
04811 void pushGuestProperty (
04812 in wstring name,
04813 in wstring value,
04814 in long long timestamp,
04815 in wstring flags
04816 );
04817
04829 void lockMedia();
04830
04840 void unlockMedia();
04841
04842 };
04843
04852 interface IBIOSSettings : $unknown
04853 {
04857 attribute boolean logoFadeIn;
04858
04862 attribute boolean logoFadeOut;
04863
04867 attribute unsigned long logoDisplayTime;
04868
04875 attribute wstring logoImagePath;
04876
04880 attribute BIOSBootMenuMode bootMenuMode;
04881
04885 attribute boolean ACPIEnabled;
04886
04893 attribute boolean IOAPICEnabled;
04894
04904 attribute long long timeOffset;
04905
04912 attribute boolean PXEDebugEnabled;
04913
04914 };
04915
04923 interface IEventContext : $unknown
04924 {
04925 };
04926
04934 interface IPciAddress : $unknown
04935 {
04941 attribute short bus;
04942
04948 attribute short device;
04949
04955 attribute short devFunction;
04956
04962 void asLong (
04963 [retval] out long result
04964 );
04965
04971 void fromLong (
04972 in long number
04973 );
04974
04975 };
04976
04984 interface IPciDeviceAttachment : $unknown
04985 {
04991 readonly attribute wstring name;
04992
04998 readonly attribute boolean isPhysicalDevice;
04999
05005 readonly attribute long hostAddress;
05006
05012 readonly attribute long guestAddress;
05013
05014 };
05015
05056 interface IMachine : $unknown
05057 {
05061 readonly attribute IVirtualBox parent;
05062
05112 readonly attribute boolean accessible;
05113
05125 readonly attribute IVirtualBoxErrorInfo accessError;
05126
05166 attribute wstring name;
05167
05178 attribute wstring description;
05179
05183 readonly attribute wstringUUID id;
05184
05199 attribute wstring OSTypeId;
05200
05204 attribute wstring HardwareVersion;
05205
05215 attribute wstringUUID hardwareUUID;
05216
05220 attribute unsigned long CPUCount;
05221
05227 attribute boolean CPUHotPlugEnabled;
05228
05236 attribute unsigned long CPUExecutionCap;
05237
05241 attribute unsigned long memorySize;
05242
05246 attribute unsigned long memoryBalloonSize;
05247
05254 attribute boolean PageFusionEnabled;
05255
05259 attribute unsigned long VRAMSize;
05260
05266 attribute boolean accelerate3DEnabled;
05267
05273 attribute boolean accelerate2DVideoEnabled;
05274
05285 attribute unsigned long monitorCount;
05286
05290 readonly attribute IBIOSSettings BIOSSettings;
05291
05296 attribute FirmwareType firmwareType;
05297
05303 attribute PointingHidType pointingHidType;
05304
05310 attribute KeyboardHidType keyboardHidType;
05311
05318 attribute boolean hpetEnabled;
05319
05323 attribute ChipsetType chipsetType;
05324
05358 attribute wstring snapshotFolder;
05359
05363 readonly attribute IVRDEServer VRDEServer;
05364
05368 readonly attribute IMediumAttachment[] mediumAttachments;
05369
05381 readonly attribute IUSBController USBController;
05382
05386 readonly attribute IAudioAdapter audioAdapter;
05387
05391 readonly attribute IStorageController[] storageControllers;
05392
05398 readonly attribute wstring settingsFilePath;
05399
05424 readonly attribute boolean settingsModified;
05425
05429 readonly attribute SessionState sessionState;
05430
05443 readonly attribute wstring sessionType;
05444
05454 readonly attribute unsigned long sessionPid;
05455
05459 readonly attribute MachineState state;
05460
05467 readonly attribute long long lastStateChange;
05468
05480 readonly attribute wstring stateFilePath;
05481
05491 readonly attribute wstring logFolder;
05492
05503 readonly attribute ISnapshot currentSnapshot;
05504
05511 readonly attribute unsigned long snapshotCount;
05512
05544 readonly attribute boolean currentStateModified;
05545
05557 readonly attribute ISharedFolder[] sharedFolders;
05558
05565 attribute ClipboardMode clipboardMode;
05566
05574 attribute wstring guestPropertyNotificationPatterns;
05575
05584 attribute boolean teleporterEnabled;
05585
05596 attribute unsigned long teleporterPort;
05597
05604 attribute wstring teleporterAddress;
05605
05613 attribute wstring teleporterPassword;
05614
05622 attribute FaultToleranceState faultToleranceState;
05623
05630 attribute unsigned long faultTolerancePort;
05631
05637 attribute wstring faultToleranceAddress;
05638
05646 attribute wstring faultTolerancePassword;
05647
05653 attribute unsigned long faultToleranceSyncInterval;
05654
05662 attribute boolean RTCUseUTC;
05663
05670 attribute boolean ioCacheEnabled;
05671
05677 attribute unsigned long ioCacheSize;
05678
05684 readonly attribute IBandwidthControl bandwidthControl;
05685
05694 readonly attribute IPciDeviceAttachment[] pciDeviceAssignments;
05695
05801 void lockMachine (
05802 in ISession session,
05803 in LockType lockType
05804 );
05805
05929 void launchVMProcess (
05930 in ISession session,
05931 in wstring type,
05932 in wstring environment,
05933 [retval] out IProgress progress
05934 );
05935
05973 void setBootOrder (
05974 in unsigned long position,
05975 in DeviceType device
05976 );
05977
06012 void getBootOrder (
06013 in unsigned long position,
06014 [retval] out DeviceType device
06015 );
06016
06118 void attachDevice (
06119 in wstring name,
06120 in long controllerPort,
06121 in long device,
06122 in DeviceType type,
06123 in IMedium medium
06124 );
06125
06178 void detachDevice (
06179 in wstring name,
06180 in long controllerPort,
06181 in long device
06182 );
06183
06226 void passthroughDevice (
06227 in wstring name,
06228 in long controllerPort,
06229 in long device,
06230 in boolean passthrough
06231 );
06232
06275 void setBandwidthGroupForDevice (
06276 in wstring name,
06277 in long controllerPort,
06278 in long device,
06279 in IBandwidthGroup bandwidthGroup
06280 );
06281
06344 void mountMedium (
06345 in wstring name,
06346 in long controllerPort,
06347 in long device,
06348 in IMedium medium,
06349 in boolean force
06350 );
06351
06380 void getMedium (
06381 in wstring name,
06382 in long controllerPort,
06383 in long device,
06384 [retval] out IMedium medium
06385 );
06386
06401 void getMediumAttachmentsOfController (
06402 in wstring name,
06403 [retval] out IMediumAttachment[] mediumAttachments
06404 );
06405
06420 void getMediumAttachment (
06421 in wstring name,
06422 in long controllerPort,
06423 in long device,
06424 [retval] out IMediumAttachment attachment
06425 );
06426
06472 void attachHostPciDevice (
06473 in long hostAddress,
06474 in long desiredGuestAddress,
06475 in IEventContext eventContext,
06476 in boolean tryToUnbind
06477 );
06478
06522 void detachHostPciDevice (
06523 in long hostAddress
06524 );
06525
06543 void getNetworkAdapter (
06544 in unsigned long slot,
06545 [retval] out INetworkAdapter adapter
06546 );
06547
06580 void addStorageController (
06581 in wstring name,
06582 in StorageBus connectionType,
06583 [retval] out IStorageController controller
06584 );
06585
06599 void getStorageControllerByName (
06600 in wstring name,
06601 [retval] out IStorageController storageController
06602 );
06603
06617 void getStorageControllerByInstance (
06618 in unsigned long instance,
06619 [retval] out IStorageController storageController
06620 );
06621
06635 void removeStorageController (
06636 in wstring name
06637 );
06638
06660 void setStorageControllerBootable (
06661 in wstring name,
06662 in boolean bootable
06663 );
06664
06682 void getSerialPort (
06683 in unsigned long slot,
06684 [retval] out ISerialPort port
06685 );
06686
06704 void getParallelPort (
06705 in unsigned long slot,
06706 [retval] out IParallelPort port
06707 );
06708
06717 void getExtraDataKeys (
06718 [retval] out wstring[] value
06719 );
06720
06749 void getExtraData (
06750 in wstring key,
06751 [retval] out wstring value
06752 );
06753
06803 void setExtraData (
06804 in wstring key,
06805 in wstring value
06806 );
06807
06829 void getCPUProperty (
06830 in CPUPropertyType property,
06831 [retval] out boolean value
06832 );
06833
06855 void setCPUProperty (
06856 in CPUPropertyType property,
06857 in boolean value
06858 );
06859
06899 void getCPUIDLeaf (
06900 in unsigned long id,
06901 out unsigned long valEax,
06902 out unsigned long valEbx,
06903 out unsigned long valEcx,
06904 out unsigned long valEdx
06905 );
06906
06950 void setCPUIDLeaf (
06951 in unsigned long id,
06952 in unsigned long valEax,
06953 in unsigned long valEbx,
06954 in unsigned long valEcx,
06955 in unsigned long valEdx
06956 );
06957
06975 void removeCPUIDLeaf (
06976 in unsigned long id
06977 );
06978
06984 void removeAllCPUIDLeaves();
06985
07007 void getHWVirtExProperty (
07008 in HWVirtExPropertyType property,
07009 [retval] out boolean value
07010 );
07011
07033 void setHWVirtExProperty (
07034 in HWVirtExPropertyType property,
07035 in boolean value
07036 );
07037
07083 void saveSettings();
07084
07108 void discardSettings();
07109
07184 void unregister (
07185 in CleanupMode cleanupMode,
07186 [retval] out IMedium[] aMedia
07187 );
07188
07245 void delete (
07246 in IMedium[] aMedia,
07247 [retval] out IProgress aProgress
07248 );
07249
07261 void export (
07262 in IAppliance aAppliance,
07263 in wstring location,
07264 [retval] out IVirtualSystemDescription aDescription
07265 );
07266
07289 void findSnapshot (
07290 in wstring nameOrId,
07291 [retval] out ISnapshot snapshot
07292 );
07293
07327 void createSharedFolder (
07328 in wstring name,
07329 in wstring hostPath,
07330 in boolean writable,
07331 in boolean automount
07332 );
07333
07359 void removeSharedFolder (
07360 in wstring name
07361 );
07362
07386 void canShowConsoleWindow (
07387 [retval] out boolean canShow
07388 );
07389
07424 void showConsoleWindow (
07425 [retval] out long long winId
07426 );
07427
07460 void getGuestProperty (
07461 in wstring name,
07462 out wstring value,
07463 out long long timestamp,
07464 out wstring flags
07465 );
07466
07489 void getGuestPropertyValue (
07490 in wstring property,
07491 [retval] out wstring value
07492 );
07493
07516 void getGuestPropertyTimestamp (
07517 in wstring property,
07518 [retval] out long long value
07519 );
07520
07571 void setGuestProperty (
07572 in wstring property,
07573 in wstring value,
07574 in wstring flags
07575 );
07576
07617 void setGuestPropertyValue (
07618 in wstring property,
07619 in wstring value
07620 );
07621
07652 void enumerateGuestProperties (
07653 in wstring patterns,
07654 out wstring[] name,
07655 out wstring[] value,
07656 out long long[] timestamp,
07657 out wstring[] flags
07658 );
07659
07677 void querySavedGuestSize (
07678 in unsigned long screenId,
07679 out unsigned long width,
07680 out unsigned long height
07681 );
07682
07704 void querySavedThumbnailSize (
07705 in unsigned long screenId,
07706 out unsigned long size,
07707 out unsigned long width,
07708 out unsigned long height
07709 );
07710
07737 void readSavedThumbnailToArray (
07738 in unsigned long screenId,
07739 in boolean BGR,
07740 out unsigned long width,
07741 out unsigned long height,
07742 [retval] out octet[] data
07743 );
07744
07766 void readSavedThumbnailPNGToArray (
07767 in unsigned long screenId,
07768 out unsigned long width,
07769 out unsigned long height,
07770 [retval] out octet[] data
07771 );
07772
07794 void querySavedScreenshotPNGSize (
07795 in unsigned long screenId,
07796 out unsigned long size,
07797 out unsigned long width,
07798 out unsigned long height
07799 );
07800
07822 void readSavedScreenshotPNGToArray (
07823 in unsigned long screenId,
07824 out unsigned long width,
07825 out unsigned long height,
07826 [retval] out octet[] data
07827 );
07828
07838 void hotPlugCPU (
07839 in unsigned long cpu
07840 );
07841
07851 void hotUnplugCPU (
07852 in unsigned long cpu
07853 );
07854
07868 void getCPUStatus (
07869 in unsigned long cpu,
07870 [retval] out boolean attached
07871 );
07872
07887 void queryLogFilename (
07888 in unsigned long idx,
07889 [retval] out wstring filename
07890 );
07891
07917 void readLog (
07918 in unsigned long idx,
07919 in long long offset,
07920 in long long size,
07921 [retval] out octet[] data
07922 );
07923
07924 };
07925
07934 interface IVRDEServerInfo : $unknown
07935 {
07941 readonly attribute boolean active;
07942
07951 readonly attribute long port;
07952
07958 readonly attribute unsigned long numberOfClients;
07959
07965 readonly attribute long long beginTime;
07966
07973 readonly attribute long long endTime;
07974
07980 readonly attribute long long bytesSent;
07981
07987 readonly attribute long long bytesSentTotal;
07988
07994 readonly attribute long long bytesReceived;
07995
08001 readonly attribute long long bytesReceivedTotal;
08002
08008 readonly attribute wstring user;
08009
08015 readonly attribute wstring domain;
08016
08022 readonly attribute wstring clientName;
08023
08029 readonly attribute wstring clientIP;
08030
08036 readonly attribute unsigned long clientVersion;
08037
08045 readonly attribute unsigned long encryptionStyle;
08046
08047 };
08048
08070 interface IConsole : $unknown
08071 {
08083 readonly attribute IMachine machine;
08084
08098 readonly attribute MachineState state;
08099
08103 readonly attribute IGuest guest;
08104
08115 readonly attribute IKeyboard keyboard;
08116
08127 readonly attribute IMouse mouse;
08128
08138 readonly attribute IDisplay display;
08139
08143 readonly attribute IMachineDebugger debugger;
08144
08155 readonly attribute IUSBDevice[] USBDevices;
08156
08164 readonly attribute IHostUSBDevice[] remoteUSBDevices;
08165
08181 readonly attribute ISharedFolder[] sharedFolders;
08182
08188 readonly attribute IVRDEServerInfo VRDEServerInfo;
08189
08195 readonly attribute IEventSource eventSource;
08196
08200 readonly attribute IPciDeviceAttachment[] attachedPciDevices;
08201
08266 void powerUp (
08267 [retval] out IProgress progress
08268 );
08269
08303 void powerUpPaused (
08304 [retval] out IProgress progress
08305 );
08306
08326 void powerDown (
08327 [retval] out IProgress progress
08328 );
08329
08349 void reset();
08350
08370 void pause();
08371
08391 void resume();
08392
08412 void powerButton();
08413
08433 void sleepButton();
08434
08446 void getPowerButtonHandled (
08447 [retval] out boolean handled
08448 );
08449
08463 void getGuestEnteredACPIMode (
08464 [retval] out boolean entered
08465 );
08466
08519 void saveState (
08520 [retval] out IProgress progress
08521 );
08522
08555 void adoptSavedState (
08556 in wstring savedStateFile
08557 );
08558
08589 void discardSavedState (
08590 in boolean fRemoveFile
08591 );
08592
08605 void getDeviceActivity (
08606 in DeviceType type,
08607 [retval] out DeviceActivity activity
08608 );
08609
08646 void attachUSBDevice (
08647 in wstringUUID id
08648 );
08649
08683 void detachUSBDevice (
08684 in wstringUUID id,
08685 [retval] out IUSBDevice device
08686 );
08687
08710 void findUSBDeviceByAddress (
08711 in wstring name,
08712 [retval] out IUSBDevice device
08713 );
08714
08734 void findUSBDeviceById (
08735 in wstringUUID id,
08736 [retval] out IUSBDevice device
08737 );
08738
08772 void createSharedFolder (
08773 in wstring name,
08774 in wstring hostPath,
08775 in boolean writable,
08776 in boolean automount
08777 );
08778
08803 void removeSharedFolder (
08804 in wstring name
08805 );
08806
08844 void takeSnapshot (
08845 in wstring name,
08846 in wstring description,
08847 [retval] out IProgress progress
08848 );
08849
08920 void deleteSnapshot (
08921 in wstringUUID id,
08922 [retval] out IProgress progress
08923 );
08924
08965 void restoreSnapshot (
08966 in ISnapshot snapshot,
08967 [retval] out IProgress progress
08968 );
08969
09008 void teleport (
09009 in wstring hostname,
09010 in unsigned long tcpport,
09011 in wstring password,
09012 in unsigned long maxDowntime,
09013 [retval] out IProgress progress
09014 );
09015
09016 };
09017
09028 interface IHostNetworkInterface : $unknown
09029 {
09033 readonly attribute wstring name;
09034
09038 readonly attribute wstringUUID id;
09039
09043 readonly attribute wstring networkName;
09044
09048 readonly attribute boolean dhcpEnabled;
09049
09053 readonly attribute wstring IPAddress;
09054
09058 readonly attribute wstring networkMask;
09059
09063 readonly attribute boolean IPV6Supported;
09064
09068 readonly attribute wstring IPV6Address;
09069
09073 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
09074
09078 readonly attribute wstring hardwareAddress;
09079
09083 readonly attribute HostNetworkInterfaceMediumType mediumType;
09084
09088 readonly attribute HostNetworkInterfaceStatus status;
09089
09093 readonly attribute HostNetworkInterfaceType interfaceType;
09094
09106 void enableStaticIpConfig (
09107 in wstring IPAddress,
09108 in wstring networkMask
09109 );
09110
09122 void enableStaticIpConfigV6 (
09123 in wstring IPV6Address,
09124 in unsigned long IPV6NetworkMaskPrefixLength
09125 );
09126
09130 void enableDynamicIpConfig();
09131
09135 void dhcpRediscover();
09136
09137 };
09138
09155 interface IHost : $unknown
09156 {
09160 readonly attribute IMedium[] DVDDrives;
09161
09165 readonly attribute IMedium[] floppyDrives;
09166
09180 readonly attribute IHostUSBDevice[] USBDevices;
09181
09204 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
09205
09209 readonly attribute IHostNetworkInterface[] networkInterfaces;
09210
09214 readonly attribute unsigned long processorCount;
09215
09219 readonly attribute unsigned long processorOnlineCount;
09220
09224 readonly attribute unsigned long processorCoreCount;
09225
09229 readonly attribute unsigned long memorySize;
09230
09234 readonly attribute unsigned long memoryAvailable;
09235
09239 readonly attribute wstring operatingSystem;
09240
09244 readonly attribute wstring OSVersion;
09245
09249 readonly attribute long long UTCTime;
09250
09254 readonly attribute boolean Acceleration3DAvailable;
09255
09270 void getProcessorSpeed (
09271 in unsigned long cpuId,
09272 [retval] out unsigned long speed
09273 );
09274
09286 void getProcessorFeature (
09287 in ProcessorFeature feature,
09288 [retval] out boolean supported
09289 );
09290
09309 void getProcessorDescription (
09310 in unsigned long cpuId,
09311 [retval] out wstring description
09312 );
09313
09354 void getProcessorCPUIDLeaf (
09355 in unsigned long cpuId,
09356 in unsigned long leaf,
09357 in unsigned long subLeaf,
09358 out unsigned long valEax,
09359 out unsigned long valEbx,
09360 out unsigned long valEcx,
09361 out unsigned long valEdx
09362 );
09363
09384 void createHostOnlyNetworkInterface (
09385 out IHostNetworkInterface hostInterface,
09386 [retval] out IProgress progress
09387 );
09388
09409 void removeHostOnlyNetworkInterface (
09410 in wstringUUID id,
09411 [retval] out IProgress progress
09412 );
09413
09433 void createUSBDeviceFilter (
09434 in wstring name,
09435 [retval] out IHostUSBDeviceFilter filter
09436 );
09437
09480 void insertUSBDeviceFilter (
09481 in unsigned long position,
09482 in IHostUSBDeviceFilter filter
09483 );
09484
09512 void removeUSBDeviceFilter (
09513 in unsigned long position
09514 );
09515
09533 void findHostDVDDrive (
09534 in wstring name,
09535 [retval] out IMedium drive
09536 );
09537
09555 void findHostFloppyDrive (
09556 in wstring name,
09557 [retval] out IMedium drive
09558 );
09559
09575 void findHostNetworkInterfaceByName (
09576 in wstring name,
09577 [retval] out IHostNetworkInterface networkInterface
09578 );
09579
09595 void findHostNetworkInterfaceById (
09596 in wstringUUID id,
09597 [retval] out IHostNetworkInterface networkInterface
09598 );
09599
09609 void findHostNetworkInterfacesOfType (
09610 in HostNetworkInterfaceType type,
09611 [retval] out IHostNetworkInterface[] networkInterfaces
09612 );
09613
09633 void findUSBDeviceById (
09634 in wstringUUID id,
09635 [retval] out IHostUSBDevice device
09636 );
09637
09660 void findUSBDeviceByAddress (
09661 in wstring name,
09662 [retval] out IHostUSBDevice device
09663 );
09664
09665 };
09666
09679 interface ISystemProperties : $unknown
09680 {
09684 readonly attribute unsigned long minGuestRAM;
09685
09689 readonly attribute unsigned long maxGuestRAM;
09690
09694 readonly attribute unsigned long minGuestVRAM;
09695
09699 readonly attribute unsigned long maxGuestVRAM;
09700
09704 readonly attribute unsigned long minGuestCPUCount;
09705
09709 readonly attribute unsigned long maxGuestCPUCount;
09710
09714 readonly attribute unsigned long maxGuestMonitors;
09715
09720 readonly attribute long long infoVDSize;
09721
09728 readonly attribute unsigned long networkAdapterCount;
09729
09736 readonly attribute unsigned long serialPortCount;
09737
09744 readonly attribute unsigned long parallelPortCount;
09745
09755 readonly attribute unsigned long maxBootPosition;
09756
09780 attribute wstring defaultMachineFolder;
09781
09807 readonly attribute IMediumFormat[] mediumFormats;
09808
09842 attribute wstring defaultHardDiskFormat;
09843
09849 attribute long long freeDiskSpaceWarning;
09850
09855 attribute unsigned long freeDiskSpacePercentWarning;
09856
09862 attribute long long freeDiskSpaceError;
09863
09868 attribute unsigned long freeDiskSpacePercentError;
09869
09893 attribute wstring VRDEAuthLibrary;
09894
09923 attribute wstring webServiceAuthLibrary;
09924
09938 attribute wstring defaultVRDEExtPack;
09939
09945 attribute unsigned long LogHistoryCount;
09946
09951 readonly attribute AudioDriverType defaultAudioDriver;
09952
09962 void getMaxDevicesPerPortForStorageBus (
09963 in StorageBus bus,
09964 [retval] out unsigned long maxDevicesPerPort
09965 );
09966
09974 void getMinPortCountForStorageBus (
09975 in StorageBus bus,
09976 [retval] out unsigned long minPortCount
09977 );
09978
09986 void getMaxPortCountForStorageBus (
09987 in StorageBus bus,
09988 [retval] out unsigned long maxPortCount
09989 );
09990
10003 void getMaxInstancesOfStorageBus (
10004 in ChipsetType chipset,
10005 in StorageBus bus,
10006 [retval] out unsigned long maxInstances
10007 );
10008
10018 void getDeviceTypesForStorageBus (
10019 in StorageBus bus,
10020 [retval] out DeviceType[] deviceTypes
10021 );
10022
10031 void getDefaultIoCacheSettingForStorageController (
10032 in StorageControllerType controllerType,
10033 [retval] out boolean enabled
10034 );
10035
10036 };
10037
10043 interface IGuestOSType : $unknown
10044 {
10048 readonly attribute wstring familyId;
10049
10053 readonly attribute wstring familyDescription;
10054
10058 readonly attribute wstring id;
10059
10063 readonly attribute wstring description;
10064
10068 readonly attribute boolean is64Bit;
10069
10073 readonly attribute boolean recommendedIOAPIC;
10074
10078 readonly attribute boolean recommendedVirtEx;
10079
10083 readonly attribute unsigned long recommendedRAM;
10084
10088 readonly attribute unsigned long recommendedVRAM;
10089
10093 readonly attribute long long recommendedHDD;
10094
10098 readonly attribute NetworkAdapterType adapterType;
10099
10103 readonly attribute boolean recommendedPae;
10104
10108 readonly attribute StorageControllerType recommendedDvdStorageController;
10109
10113 readonly attribute StorageBus recommendedDvdStorageBus;
10114
10118 readonly attribute StorageControllerType recommendedHdStorageController;
10119
10123 readonly attribute StorageBus recommendedHdStorageBus;
10124
10128 readonly attribute FirmwareType recommendedFirmware;
10129
10133 readonly attribute boolean recommendedUsbHid;
10134
10138 readonly attribute boolean recommendedHpet;
10139
10143 readonly attribute boolean recommendedUsbTablet;
10144
10148 readonly attribute boolean recommendedRtcUseUtc;
10149
10153 readonly attribute ChipsetType recommendedChipset;
10154
10158 readonly attribute AudioControllerType recommendedAudioController;
10159
10160 };
10161
10175 interface IGuest : $unknown
10176 {
10191 readonly attribute wstring OSTypeId;
10192
10198 readonly attribute AdditionsRunLevelType additionsRunLevel;
10199
10207 readonly attribute wstring additionsVersion;
10208
10215 readonly attribute boolean supportsSeamless;
10216
10225 readonly attribute boolean supportsGraphics;
10226
10230 attribute unsigned long memoryBalloonSize;
10231
10235 attribute unsigned long statisticsUpdateInterval;
10236
10268 void internalGetStatistics (
10269 out unsigned long cpuUser,
10270 out unsigned long cpuKernel,
10271 out unsigned long cpuIdle,
10272 out unsigned long memTotal,
10273 out unsigned long memFree,
10274 out unsigned long memBalloon,
10275 out unsigned long memShared,
10276 out unsigned long memCache,
10277 out unsigned long pagedTotal,
10278 out unsigned long memAllocTotal,
10279 out unsigned long memFreeTotal,
10280 out unsigned long memBalloonTotal,
10281 out unsigned long memSharedTotal
10282 );
10283
10301 void getAdditionsStatus (
10302 in AdditionsRunLevelType level,
10303 [retval] out boolean active
10304 );
10305
10335 void setCredentials (
10336 in wstring userName,
10337 in wstring password,
10338 in wstring domain,
10339 in boolean allowInteractiveLogon
10340 );
10341
10395 void executeProcess (
10396 in wstring execName,
10397 in unsigned long flags,
10398 in wstring[] arguments,
10399 in wstring[] environment,
10400 in wstring userName,
10401 in wstring password,
10402 in unsigned long timeoutMS,
10403 out unsigned long pid,
10404 [retval] out IProgress progress
10405 );
10406
10444 void getProcessOutput (
10445 in unsigned long pid,
10446 in unsigned long flags,
10447 in unsigned long timeoutMS,
10448 in long long size,
10449 [retval] out octet[] data
10450 );
10451
10482 void getProcessStatus (
10483 in unsigned long pid,
10484 out unsigned long exitcode,
10485 out unsigned long flags,
10486 [retval] out unsigned long reason
10487 );
10488
10526 void copyToGuest (
10527 in wstring source,
10528 in wstring dest,
10529 in wstring userName,
10530 in wstring password,
10531 in unsigned long flags,
10532 [retval] out IProgress progress
10533 );
10534
10572 void createDirectory (
10573 in wstring directory,
10574 in wstring userName,
10575 in wstring password,
10576 in unsigned long mode,
10577 in unsigned long flags,
10578 [retval] out IProgress progress
10579 );
10580
10610 void setProcessInput (
10611 in unsigned long pid,
10612 in unsigned long flags,
10613 in octet[] data,
10614 [retval] out unsigned long written
10615 );
10616
10641 void updateGuestAdditions (
10642 in wstring source,
10643 in unsigned long flags,
10644 [retval] out IProgress progress
10645 );
10646
10647 };
10648
10689 interface IProgress : $unknown
10690 {
10694 readonly attribute wstringUUID id;
10695
10699 readonly attribute wstring description;
10700
10704 readonly attribute $unknown initiator;
10705
10709 readonly attribute boolean cancelable;
10710
10718 readonly attribute unsigned long percent;
10719
10733 readonly attribute long timeRemaining;
10734
10738 readonly attribute boolean completed;
10739
10743 readonly attribute boolean canceled;
10744
10751 readonly attribute long resultCode;
10752
10762 readonly attribute IVirtualBoxErrorInfo errorInfo;
10763
10770 readonly attribute unsigned long operationCount;
10771
10775 readonly attribute unsigned long operation;
10776
10782 readonly attribute wstring operationDescription;
10783
10787 readonly attribute unsigned long operationPercent;
10788
10792 readonly attribute unsigned long operationWeight;
10793
10801 attribute unsigned long timeout;
10802
10806 void setCurrentOperationProgress (
10807 in unsigned long percent
10808 );
10809
10813 void setNextOperation (
10814 in wstring nextOperationDescription,
10815 in unsigned long nextOperationsWeight
10816 );
10817
10844 void waitForCompletion (
10845 in long timeout
10846 );
10847
10871 void waitForOperationCompletion (
10872 in unsigned long operation,
10873 in long timeout
10874 );
10875
10892 void cancel();
10893
10894 };
10895
10974 interface ISnapshot : $unknown
10975 {
10979 readonly attribute wstringUUID id;
10980
10984 attribute wstring name;
10985
10989 attribute wstring description;
10990
10996 readonly attribute long long timeStamp;
10997
11009 readonly attribute boolean online;
11010
11022 readonly attribute IMachine machine;
11023
11030 readonly attribute ISnapshot parent;
11031
11037 readonly attribute ISnapshot[] children;
11038
11039 };
11040
11063 interface IMediumAttachment : $unknown
11064 {
11069 readonly attribute IMedium medium;
11070
11076 readonly attribute wstring controller;
11077
11083 readonly attribute long port;
11084
11090 readonly attribute long device;
11091
11095 readonly attribute DeviceType type;
11096
11100 readonly attribute boolean passthrough;
11101
11105 readonly attribute IBandwidthGroup bandwidthGroup;
11106
11107 };
11108
11450 interface IMedium : $unknown
11451 {
11465 readonly attribute wstringUUID id;
11466
11485 attribute wstring description;
11486
11502 readonly attribute MediumState state;
11503
11511 readonly attribute MediumVariant variant;
11512
11534 attribute wstring location;
11535
11555 readonly attribute wstring name;
11556
11561 readonly attribute DeviceType deviceType;
11562
11566 readonly attribute boolean hostDrive;
11567
11580 readonly attribute long long size;
11581
11596 readonly attribute wstring format;
11597
11613 readonly attribute IMediumFormat mediumFormat;
11614
11639 attribute MediumType type;
11640
11650 readonly attribute IMedium parent;
11651
11659 readonly attribute IMedium[] children;
11660
11671 readonly attribute IMedium base;
11672
11705 readonly attribute boolean readOnly;
11706
11727 readonly attribute long long logicalSize;
11728
11756 attribute boolean autoReset;
11757
11772 readonly attribute wstring lastAccessError;
11773
11790 readonly attribute wstringUUID[] machineIds;
11791
11817 void setIDs (
11818 in boolean setImageId,
11819 in wstringUUID imageId,
11820 in boolean setParentId,
11821 in wstringUUID parentId
11822 );
11823
11858 void refreshState (
11859 [retval] out MediumState state
11860 );
11861
11888 void getSnapshotIds (
11889 in wstringUUID machineId,
11890 [retval] out wstringUUID[] snapshotIds
11891 );
11892
11952 void lockRead (
11953 [retval] out MediumState state
11954 );
11955
11978 void unlockRead (
11979 [retval] out MediumState state
11980 );
11981
12036 void lockWrite (
12037 [retval] out MediumState state
12038 );
12039
12062 void unlockWrite (
12063 [retval] out MediumState state
12064 );
12065
12115 void close();
12116
12146 void getProperty (
12147 in wstring name,
12148 [retval] out wstring value
12149 );
12150
12182 void setProperty (
12183 in wstring name,
12184 in wstring value
12185 );
12186
12220 void getProperties (
12221 in wstring names,
12222 out wstring[] returnNames,
12223 [retval] out wstring[] returnValues
12224 );
12225
12257 void setProperties (
12258 in wstring[] names,
12259 in wstring[] values
12260 );
12261
12293 void createBaseStorage (
12294 in long long logicalSize,
12295 in MediumVariant variant,
12296 [retval] out IProgress progress
12297 );
12298
12350 void deleteStorage (
12351 [retval] out IProgress progress
12352 );
12353
12391 void createDiffStorage (
12392 in IMedium target,
12393 in MediumVariant variant,
12394 [retval] out IProgress progress
12395 );
12396
12472 void mergeTo (
12473 in IMedium target,
12474 [retval] out IProgress progress
12475 );
12476
12525 void cloneTo (
12526 in IMedium target,
12527 in MediumVariant variant,
12528 in IMedium parent,
12529 [retval] out IProgress progress
12530 );
12531
12560 void compact (
12561 [retval] out IProgress progress
12562 );
12563
12596 void resize (
12597 in long long logicalSize,
12598 [retval] out IProgress progress
12599 );
12600
12634 void reset (
12635 [retval] out IProgress progress
12636 );
12637
12638 };
12639
12662 interface IMediumFormat : $unknown
12663 {
12682 readonly attribute wstring id;
12683
12691 readonly attribute wstring name;
12692
12701 readonly attribute unsigned long capabilities;
12702
12721 void describeFileExtensions (
12722 out wstring[] extensions,
12723 out DeviceType[] type
12724 );
12725
12755 void describeProperties (
12756 out wstring[] names,
12757 out wstring[] description,
12758 out DataType[] types,
12759 out unsigned long[] flags,
12760 out wstring[] defaults
12761 );
12762
12763 };
12764
12777 interface IKeyboard : $unknown
12778 {
12784 readonly attribute IEventSource eventSource;
12785
12798 void putScancode (
12799 in long scancode
12800 );
12801
12814 void putScancodes (
12815 in long[] scancodes,
12816 [retval] out unsigned long codesStored
12817 );
12818
12833 void putCAD();
12834
12835 };
12836
12848 interface IMouse : $unknown
12849 {
12864 readonly attribute boolean absoluteSupported;
12865
12880 readonly attribute boolean relativeSupported;
12881
12896 readonly attribute boolean needsHostCursor;
12897
12903 readonly attribute IEventSource eventSource;
12904
12970 void putMouseEvent (
12971 in long dx,
12972 in long dy,
12973 in long dz,
12974 in long dw,
12975 in long buttonState
12976 );
12977
13050 void putMouseEventAbsolute (
13051 in long x,
13052 in long y,
13053 in long dz,
13054 in long dw,
13055 in long buttonState
13056 );
13057
13058 };
13059
13060 interface IFramebuffer : $unknown
13061 {
13070 readonly attribute octetPtr address;
13071
13075 readonly attribute unsigned long width;
13076
13080 readonly attribute unsigned long height;
13081
13088 readonly attribute unsigned long bitsPerPixel;
13089
13096 readonly attribute unsigned long bytesPerLine;
13097
13108 readonly attribute unsigned long pixelFormat;
13109
13116 readonly attribute boolean usesGuestVRAM;
13117
13127 readonly attribute unsigned long heightReduction;
13128
13143 readonly attribute IFramebufferOverlay overlay;
13144
13151 readonly attribute long long winId;
13152
13160 void lock();
13161
13169 void unlock();
13170
13178 void notifyUpdate (
13179 in unsigned long x,
13180 in unsigned long y,
13181 in unsigned long width,
13182 in unsigned long height
13183 );
13184
13297 void requestResize (
13298 in unsigned long screenId,
13299 in unsigned long pixelFormat,
13300 in octetPtr VRAM,
13301 in unsigned long bitsPerPixel,
13302 in unsigned long bytesPerLine,
13303 in unsigned long width,
13304 in unsigned long height,
13305 [retval] out boolean finished
13306 );
13307
13319 void videoModeSupported (
13320 in unsigned long width,
13321 in unsigned long height,
13322 in unsigned long bpp,
13323 [retval] out boolean supported
13324 );
13325
13362 void getVisibleRegion (
13363 in octetPtr rectangles,
13364 in unsigned long count,
13365 [retval] out unsigned long countCopied
13366 );
13367
13402 void setVisibleRegion (
13403 in octetPtr rectangles,
13404 in unsigned long count
13405 );
13406
13427 void processVHWACommand (
13428 in octetPtr command
13429 );
13430
13431 };
13432
13447 interface IFramebufferOverlay : IFramebuffer
13448 {
13452 readonly attribute unsigned long x;
13453
13457 readonly attribute unsigned long y;
13458
13464 attribute boolean visible;
13465
13472 attribute unsigned long alpha;
13473
13479 void move (
13480 in unsigned long x,
13481 in unsigned long y
13482 );
13483
13484 };
13485
13501 interface IDisplay : $unknown
13502 {
13506 void getScreenResolution (
13507 in unsigned long screenId,
13508 out unsigned long width,
13509 out unsigned long height,
13510 out unsigned long bitsPerPixel
13511 );
13512
13518 void setFramebuffer (
13519 in unsigned long screenId,
13520 in IFramebuffer framebuffer
13521 );
13522
13528 void getFramebuffer (
13529 in unsigned long screenId,
13530 out IFramebuffer framebuffer,
13531 out long xOrigin,
13532 out long yOrigin
13533 );
13534
13563 void setVideoModeHint (
13564 in unsigned long width,
13565 in unsigned long height,
13566 in unsigned long bitsPerPixel,
13567 in unsigned long display
13568 );
13569
13580 void setSeamlessMode (
13581 in boolean enabled
13582 );
13583
13617 void takeScreenShot (
13618 in unsigned long screenId,
13619 in octetPtr address,
13620 in unsigned long width,
13621 in unsigned long height
13622 );
13623
13667 void takeScreenShotToArray (
13668 in unsigned long screenId,
13669 in unsigned long width,
13670 in unsigned long height,
13671 [retval] out octet[] screenData
13672 );
13673
13712 void takeScreenShotPNGToArray (
13713 in unsigned long screenId,
13714 in unsigned long width,
13715 in unsigned long height,
13716 [retval] out octet[] screenData
13717 );
13718
13770 void drawToScreen (
13771 in unsigned long screenId,
13772 in octetPtr address,
13773 in unsigned long x,
13774 in unsigned long y,
13775 in unsigned long width,
13776 in unsigned long height
13777 );
13778
13793 void invalidateAndUpdate();
13794
13808 void resizeCompleted (
13809 in unsigned long screenId
13810 );
13811
13824 void completeVHWACommand (
13825 in octetPtr command
13826 );
13827
13828 };
13829
13845 interface INetworkAdapter : $unknown
13846 {
13854 attribute NetworkAdapterType adapterType;
13855
13863 readonly attribute unsigned long slot;
13864
13873 attribute boolean enabled;
13874
13881 attribute wstring MACAddress;
13882
13883 readonly attribute NetworkAttachmentType attachmentType;
13884
13890 attribute wstring hostInterface;
13891
13897 attribute wstring internalNetwork;
13898
13904 attribute wstring NATNetwork;
13905
13911 attribute wstring VDENetwork;
13912
13919 attribute boolean cableConnected;
13920
13926 attribute unsigned long lineSpeed;
13927
13934 attribute boolean traceEnabled;
13935
13942 attribute wstring traceFile;
13943
13951 readonly attribute INATEngine natDriver;
13952
13959 attribute unsigned long bootPriority;
13960
13967 attribute unsigned long bandwidthLimit;
13968
13974 void attachToNAT();
13975
13981 void attachToBridgedInterface();
13982
13988 void attachToInternalNetwork();
13989
13995 void attachToHostOnlyInterface();
13996
14002 void attachToVDE();
14003
14009 void detach();
14010
14011 };
14012
14041 interface ISerialPort : $unknown
14042 {
14050 readonly attribute unsigned long slot;
14051
14058 attribute boolean enabled;
14059
14063 attribute unsigned long IOBase;
14064
14068 attribute unsigned long IRQ;
14069
14080 attribute PortMode hostMode;
14081
14089 attribute boolean server;
14090
14100 attribute wstring path;
14101
14102 };
14103
14123 interface IParallelPort : $unknown
14124 {
14132 readonly attribute unsigned long slot;
14133
14140 attribute boolean enabled;
14141
14145 attribute unsigned long IOBase;
14146
14150 attribute unsigned long IRQ;
14151
14159 attribute wstring path;
14160
14161 };
14162
14163 interface IMachineDebugger : $unknown
14164 {
14168 attribute boolean singlestep;
14169
14173 attribute boolean recompileUser;
14174
14178 attribute boolean recompileSupervisor;
14179
14183 attribute boolean PATMEnabled;
14184
14188 attribute boolean CSAMEnabled;
14189
14193 attribute boolean logEnabled;
14194
14201 readonly attribute boolean HWVirtExEnabled;
14202
14209 readonly attribute boolean HWVirtExNestedPagingEnabled;
14210
14217 readonly attribute boolean HWVirtExVPIDEnabled;
14218
14225 readonly attribute boolean PAEEnabled;
14226
14233 attribute unsigned long virtualTimeRate;
14234
14241 readonly attribute long long VM;
14242
14250 void resetStats (
14251 in wstring pattern
14252 );
14253
14261 void dumpStats (
14262 in wstring pattern
14263 );
14264
14276 void getStats (
14277 in wstring pattern,
14278 in boolean withDescriptions,
14279 out wstring stats
14280 );
14281
14287 void injectNMI();
14288
14300 void dumpGuestCore (
14301 in wstring filename
14302 );
14303
14304 };
14305
14306 interface IUSBController : $unknown
14307 {
14316 attribute boolean enabled;
14317
14326 attribute boolean enabledEhci;
14327
14333 readonly attribute boolean proxyAvailable;
14334
14342 readonly attribute unsigned short USBStandard;
14343
14369 readonly attribute IUSBDeviceFilter[] deviceFilters;
14370
14398 void createDeviceFilter (
14399 in wstring name,
14400 [retval] out IUSBDeviceFilter filter
14401 );
14402
14447 void insertDeviceFilter (
14448 in unsigned long position,
14449 in IUSBDeviceFilter filter
14450 );
14451
14484 void removeDeviceFilter (
14485 in unsigned long position,
14486 [retval] out IUSBDeviceFilter filter
14487 );
14488
14489 };
14490
14503 interface IUSBDevice : $unknown
14504 {
14511 readonly attribute wstringUUID id;
14512
14516 readonly attribute unsigned short vendorId;
14517
14521 readonly attribute unsigned short productId;
14522
14530 readonly attribute unsigned short revision;
14531
14535 readonly attribute wstring manufacturer;
14536
14540 readonly attribute wstring product;
14541
14545 readonly attribute wstring serialNumber;
14546
14550 readonly attribute wstring address;
14551
14558 readonly attribute unsigned short port;
14559
14565 readonly attribute unsigned short version;
14566
14574 readonly attribute unsigned short portVersion;
14575
14582 readonly attribute boolean remote;
14583
14584 };
14585
14659 interface IUSBDeviceFilter : $unknown
14660 {
14668 attribute wstring name;
14669
14673 attribute boolean active;
14674
14682 attribute wstring vendorId;
14683
14691 attribute wstring productId;
14692
14706 attribute wstring revision;
14707
14712 attribute wstring manufacturer;
14713
14718 attribute wstring product;
14719
14724 attribute wstring serialNumber;
14725
14730 attribute wstring port;
14731
14741 attribute wstring remote;
14742
14752 attribute unsigned long maskedInterfaces;
14753
14754 };
14755
14771 interface IHostUSBDevice : IUSBDevice
14772 {
14778 readonly attribute USBDeviceState state;
14779
14780 };
14781
14804 interface IHostUSBDeviceFilter : IUSBDeviceFilter
14805 {
14812 attribute USBDeviceFilterAction action;
14813
14814 };
14815
14824 interface IAudioAdapter : $unknown
14825 {
14834 attribute boolean enabled;
14835
14841 attribute AudioControllerType audioController;
14842
14849 attribute AudioDriverType audioDriver;
14850
14851 };
14852
14853 interface IVRDEServer : $unknown
14854 {
14858 attribute boolean enabled;
14859
14863 attribute AuthType authType;
14864
14868 attribute unsigned long authTimeout;
14869
14876 attribute boolean allowMultiConnection;
14877
14885 attribute boolean reuseSingleConnection;
14886
14892 attribute boolean videoChannel;
14893
14899 attribute unsigned long videoChannelQuality;
14900
14907 attribute wstring VRDEExtPack;
14908
14915 attribute wstring AuthLibrary;
14916
14930 void setVRDEProperty (
14931 in wstring key,
14932 in wstring value
14933 );
14934
14948 void getVRDEProperty (
14949 in wstring key,
14950 [retval] out wstring value
14951 );
14952
14953 };
14954
15012 interface ISharedFolder : $unknown
15013 {
15017 readonly attribute wstring name;
15018
15022 readonly attribute wstring hostPath;
15023
15033 readonly attribute boolean accessible;
15034
15041 readonly attribute boolean writable;
15042
15048 readonly attribute boolean autoMount;
15049
15062 readonly attribute wstring lastAccessError;
15063
15064 };
15065
15066 interface IInternalSessionControl : $unknown
15067 {
15072 void getPID (
15073 [retval] out unsigned long pid
15074 );
15075
15097 void getRemoteConsole (
15098 [retval] out IConsole console
15099 );
15100
15124 void assignMachine (
15125 in IMachine machine
15126 );
15127
15142 void assignRemoteMachine (
15143 in IMachine machine,
15144 in IConsole console
15145 );
15146
15170 void updateMachineState (
15171 in MachineState aMachineState
15172 );
15173
15189 void uninitialize();
15190
15213 void onNetworkAdapterChange (
15214 in INetworkAdapter networkAdapter,
15215 in boolean changeAdapter
15216 );
15217
15240 void onSerialPortChange (
15241 in ISerialPort serialPort
15242 );
15243
15266 void onParallelPortChange (
15267 in IParallelPort parallelPort
15268 );
15269
15292 void onStorageControllerChange();
15293
15316 void onMediumChange (
15317 in IMediumAttachment mediumAttachment,
15318 in boolean force
15319 );
15320
15330 void onCPUChange (
15331 in unsigned long cpu,
15332 in boolean add
15333 );
15334
15342 void onCPUExecutionCapChange (
15343 in unsigned long executionCap
15344 );
15345
15370 void onVRDEServerChange (
15371 in boolean restart
15372 );
15373
15396 void onUSBControllerChange();
15397
15426 void onSharedFolderChange (
15427 in boolean global
15428 );
15429
15455 void onUSBDeviceAttach (
15456 in IUSBDevice device,
15457 in IVirtualBoxErrorInfo error,
15458 in unsigned long maskedInterfaces
15459 );
15460
15486 void onUSBDeviceDetach (
15487 in wstringUUID id,
15488 in IVirtualBoxErrorInfo error
15489 );
15490
15508 void onShowWindow (
15509 in boolean check,
15510 out boolean canShow,
15511 out long long winId
15512 );
15513
15521 void onBandwidthGroupChange (
15522 in IBandwidthGroup bandwidthGroup
15523 );
15524
15548 void accessGuestProperty (
15549 in wstring name,
15550 in wstring value,
15551 in wstring flags,
15552 in boolean isSetter,
15553 out wstring retValue,
15554 out long long retTimestamp,
15555 out wstring retFlags
15556 );
15557
15605 void enumerateGuestProperties (
15606 in wstring patterns,
15607 out wstring[] key,
15608 out wstring[] value,
15609 out long long[] timestamp,
15610 out wstring[] flags
15611 );
15612
15658 void onlineMergeMedium (
15659 in IMediumAttachment mediumAttachment,
15660 in unsigned long sourceIdx,
15661 in unsigned long targetIdx,
15662 in IMedium source,
15663 in IMedium target,
15664 in boolean mergeForward,
15665 in IMedium parentForTarget,
15666 in IMedium[] childrenToReparent,
15667 in IProgress progress
15668 );
15669
15670 };
15671
15730 interface ISession : $unknown
15731 {
15735 readonly attribute SessionState state;
15736
15744 readonly attribute SessionType type;
15745
15749 readonly attribute IMachine machine;
15750
15754 readonly attribute IConsole console;
15755
15787 void unlockMachine();
15788
15789 };
15790
15813 interface IStorageController : $unknown
15814 {
15823 readonly attribute wstring name;
15824
15830 readonly attribute unsigned long maxDevicesPerPortCount;
15831
15837 readonly attribute unsigned long minPortCount;
15838
15844 readonly attribute unsigned long maxPortCount;
15845
15851 attribute unsigned long instance;
15852
15861 attribute unsigned long portCount;
15862
15868 readonly attribute StorageBus bus;
15869
15882 attribute StorageControllerType controllerType;
15883
15898 attribute boolean useHostIOCache;
15899
15905 readonly attribute boolean bootable;
15906
15929 void getIDEEmulationPort (
15930 in long devicePosition,
15931 [retval] out long portNumber
15932 );
15933
15957 void setIDEEmulationPort (
15958 in long devicePosition,
15959 in long portNumber
15960 );
15961
15962 };
15963
15987 interface IManagedObjectRef : $unknown
15988 {
15995 void getInterfaceName (
15996 [retval] out wstring return
15997 );
15998
16006 void release();
16007
16008 };
16009
16018 interface IWebsessionManager : $unknown
16019 {
16028 void logon (
16029 in wstring username,
16030 in wstring password,
16031 [retval] out IVirtualBox return
16032 );
16033
16043 void getSessionObject (
16044 in IVirtualBox refIVirtualBox,
16045 [retval] out ISession return
16046 );
16047
16055 void logoff (
16056 in IVirtualBox refIVirtualBox
16057 );
16058
16059 };
16060
16069 interface IPerformanceMetric : $unknown
16070 {
16076 readonly attribute wstring metricName;
16077
16083 readonly attribute $unknown object;
16084
16090 readonly attribute wstring description;
16091
16097 readonly attribute unsigned long period;
16098
16108 readonly attribute unsigned long count;
16109
16115 readonly attribute wstring unit;
16116
16122 readonly attribute long minimumValue;
16123
16129 readonly attribute long maximumValue;
16130
16131 };
16132
16238 interface IPerformanceCollector : $unknown
16239 {
16250 readonly attribute wstring[] metricNames;
16251
16275 void getMetrics (
16276 in wstring[] metricNames,
16277 in $unknown[] objects,
16278 [retval] out IPerformanceMetric[] metrics
16279 );
16280
16319 void setupMetrics (
16320 in wstring[] metricNames,
16321 in $unknown[] objects,
16322 in unsigned long period,
16323 in unsigned long count,
16324 [retval] out IPerformanceMetric[] affectedMetrics
16325 );
16326
16355 void enableMetrics (
16356 in wstring[] metricNames,
16357 in $unknown[] objects,
16358 [retval] out IPerformanceMetric[] affectedMetrics
16359 );
16360
16389 void disableMetrics (
16390 in wstring[] metricNames,
16391 in $unknown[] objects,
16392 [retval] out IPerformanceMetric[] affectedMetrics
16393 );
16394
16483 void queryMetricsData (
16484 in wstring[] metricNames,
16485 in $unknown[] objects,
16486 out wstring[] returnMetricNames,
16487 out $unknown[] returnObjects,
16488 out wstring[] returnUnits,
16489 out unsigned long[] returnScales,
16490 out unsigned long[] returnSequenceNumbers,
16491 out unsigned long[] returnDataIndices,
16492 out unsigned long[] returnDataLengths,
16493 [retval] out long[] returnData
16494 );
16495
16496 };
16497
16505 interface INATEngine : $unknown
16506 {
16511 attribute wstring network;
16512
16519 attribute wstring hostIP;
16520
16525 attribute wstring tftpPrefix;
16526
16531 attribute wstring tftpBootFile;
16532
16540 attribute wstring tftpNextServer;
16541
16545 attribute unsigned long aliasMode;
16546
16550 attribute boolean dnsPassDomain;
16551
16556 attribute boolean dnsProxy;
16557
16562 attribute boolean dnsUseHostResolver;
16563
16568 readonly attribute wstring[] redirects;
16569
16585 void setNetworkSettings (
16586 in unsigned long mtu,
16587 in unsigned long sockSnd,
16588 in unsigned long sockRcv,
16589 in unsigned long TcpWndSnd,
16590 in unsigned long TcpWndRcv
16591 );
16592
16597 void getNetworkSettings (
16598 out unsigned long mtu,
16599 out unsigned long sockSnd,
16600 out unsigned long sockRcv,
16601 out unsigned long TcpWndSnd,
16602 out unsigned long TcpWndRcv
16603 );
16604
16624 void addRedirect (
16625 in wstring name,
16626 in NATProtocol proto,
16627 in wstring hostIp,
16628 in unsigned short hostPort,
16629 in wstring guestIp,
16630 in unsigned short guestPort
16631 );
16632
16638 void removeRedirect (
16639 in wstring name
16640 );
16641
16642 };
16643
16652 interface IExtPackPlugIn : $unknown
16653 {
16657 readonly attribute wstring name;
16658
16662 readonly attribute wstring description;
16663
16669 readonly attribute wstring frontend;
16670
16674 readonly attribute wstring modulePath;
16675
16676 };
16677
16686 interface IExtPackBase : $unknown
16687 {
16691 readonly attribute wstring name;
16692
16696 readonly attribute wstring description;
16697
16706 readonly attribute wstring version;
16707
16711 readonly attribute unsigned long revision;
16712
16716 readonly attribute wstring VRDEModule;
16717
16721 readonly attribute IExtPackPlugIn[] plugIns;
16722
16732 readonly attribute boolean usable;
16733
16740 readonly attribute wstring whyUnusable;
16741
16745 readonly attribute boolean showLicense;
16746
16755 readonly attribute wstring license;
16756
16780 void queryLicense (
16781 in wstring preferredLocale,
16782 in wstring preferredLanguage,
16783 in wstring format,
16784 [retval] out wstring licenseText
16785 );
16786
16787 };
16788
16797 interface IExtPack : IExtPackBase
16798 {
16810 void queryObject (
16811 in wstring objUuid,
16812 [retval] out $unknown returnInterface
16813 );
16814
16815 };
16816
16827 interface IExtPackFile : IExtPackBase
16828 {
16834 readonly attribute wstring filePath;
16835
16841 void install();
16842
16843 };
16844
16855 interface IExtPackManager : $unknown
16856 {
16862 readonly attribute IExtPack[] installedExtPacks;
16863
16881 void find (
16882 in wstring name,
16883 [retval] out IExtPack returnData
16884 );
16885
16896 void openExtPackFile (
16897 in wstring path,
16898 [retval] out IExtPackFile file
16899 );
16900
16911 void uninstall (
16912 in wstring name,
16913 in boolean forcedRemoval
16914 );
16915
16919 void cleanup();
16920
16933 void QueryAllPlugInsForFrontend (
16934 in wstring frontendName,
16935 [retval] out wstring[] plugInModules
16936 );
16937
16943 void IsExtPackUsable (
16944 in wstring name,
16945 [retval] out boolean usable
16946 );
16947
16948 };
16949
16955 interface IBandwidthGroup : $unknown
16956 {
16960 readonly attribute wstring name;
16961
16965 readonly attribute BandwidthGroupType type;
16966
16970 readonly attribute unsigned long reference;
16971
16976 attribute unsigned long maxMbPerSec;
16977
16978 };
16979
16988 interface IBandwidthControl : $unknown
16989 {
16995 readonly attribute unsigned long numGroups;
16996
17009 void CreateBandwidthGroup (
17010 in wstring name,
17011 in BandwidthGroupType type,
17012 in unsigned long maxBytesPerSec
17013 );
17014
17022 void DeleteBandwidthGroup (
17023 in wstring name
17024 );
17025
17035 void GetBandwidthGroup (
17036 in wstring name,
17037 [retval] out IBandwidthGroup bandwidthGroup
17038 );
17039
17047 void GetAllBandwidthGroups (
17048 [retval] out IBandwidthGroup[] bandwidthGroups
17049 );
17050
17051 };
17052
17065 interface IVirtualBoxClient : $unknown
17066 {
17072 readonly attribute IVirtualBox virtualBox;
17073
17079 readonly attribute ISession session;
17080
17086 readonly attribute IEventSource eventSource;
17087
17088 };
17089
17103 interface IEventSource : $unknown
17104 {
17110 void createListener (
17111 [retval] out IEventListener listener
17112 );
17113
17125 void createAggregator (
17126 in IEventSource[] subordinates,
17127 [retval] out IEventSource result
17128 );
17129
17162 void registerListener (
17163 in IEventListener listener,
17164 in VBoxEventType[] interesting,
17165 in boolean active
17166 );
17167
17176 void unregisterListener (
17177 in IEventListener listener
17178 );
17179
17194 void fireEvent (
17195 in IEvent event,
17196 in long timeout,
17197 [retval] out boolean result
17198 );
17199
17224 void getEvent (
17225 in IEventListener listener,
17226 in long timeout,
17227 [retval] out IEvent event
17228 );
17229
17241 void eventProcessed (
17242 in IEventListener listener,
17243 in IEvent event
17244 );
17245
17246 };
17247
17257 interface IEventListener : $unknown
17258 {
17269 void handleEvent (
17270 in IEvent event
17271 );
17272
17273 };
17274
17351 interface IEvent : $unknown
17352 {
17358 readonly attribute VBoxEventType type;
17359
17365 readonly attribute IEventSource source;
17366
17377 readonly attribute boolean waitable;
17378
17385 void setProcessed();
17386
17400 void waitProcessed (
17401 in long timeout,
17402 [retval] out boolean result
17403 );
17404
17405 };
17406
17412 interface IReusableEvent : IEvent
17413 {
17417 readonly attribute unsigned long generation;
17418
17425 void reuse();
17426
17427 };
17428
17434 interface IMachineEvent : IEvent
17435 {
17439 readonly attribute wstringUUID machineId;
17440
17441 };
17442
17448 interface IMachineStateChangedEvent : IMachineEvent
17449 {
17453 readonly attribute MachineState state;
17454
17455 };
17456
17464 interface IMachineDataChangedEvent : IMachineEvent
17465 {
17466 };
17467
17476 interface IMediumRegisteredEvent : IEvent
17477 {
17481 readonly attribute wstringUUID mediumId;
17482
17486 readonly attribute DeviceType mediumType;
17487
17494 readonly attribute boolean registered;
17495
17496 };
17497
17506 interface IMachineRegisteredEvent : IMachineEvent
17507 {
17514 readonly attribute boolean registered;
17515
17516 };
17517
17527 interface ISessionStateChangedEvent : IMachineEvent
17528 {
17534 readonly attribute SessionState state;
17535
17536 };
17537
17545 interface IGuestPropertyChangedEvent : IMachineEvent
17546 {
17552 readonly attribute wstring name;
17553
17559 readonly attribute wstring value;
17560
17566 readonly attribute wstring flags;
17567
17568 };
17569
17575 interface ISnapshotEvent : IMachineEvent
17576 {
17580 readonly attribute wstringUUID snapshotId;
17581
17582 };
17583
17593 interface ISnapshotTakenEvent : ISnapshotEvent
17594 {
17595 };
17596
17613 interface ISnapshotDeletedEvent : ISnapshotEvent
17614 {
17615 };
17616
17626 interface ISnapshotChangedEvent : ISnapshotEvent
17627 {
17628 };
17629
17638 interface IMousePointerShapeChangedEvent : IEvent
17639 {
17645 readonly attribute boolean visible;
17646
17652 readonly attribute boolean alpha;
17653
17659 readonly attribute unsigned long xhot;
17660
17666 readonly attribute unsigned long yhot;
17667
17673 readonly attribute unsigned long width;
17674
17680 readonly attribute unsigned long height;
17681
17714 readonly attribute octet[] shape;
17715
17716 };
17717
17726 interface IMouseCapabilityChangedEvent : IEvent
17727 {
17733 readonly attribute boolean supportsAbsolute;
17734
17740 readonly attribute boolean supportsRelative;
17741
17747 readonly attribute boolean needsHostCursor;
17748
17749 };
17750
17759 interface IKeyboardLedsChangedEvent : IEvent
17760 {
17766 readonly attribute boolean numLock;
17767
17773 readonly attribute boolean capsLock;
17774
17780 readonly attribute boolean scrollLock;
17781
17782 };
17783
17792 interface IStateChangedEvent : IEvent
17793 {
17799 readonly attribute MachineState state;
17800
17801 };
17802
17812 interface IAdditionsStateChangedEvent : IEvent
17813 {
17814 };
17815
17826 interface INetworkAdapterChangedEvent : IEvent
17827 {
17833 readonly attribute INetworkAdapter networkAdapter;
17834
17835 };
17836
17847 interface ISerialPortChangedEvent : IEvent
17848 {
17854 readonly attribute ISerialPort serialPort;
17855
17856 };
17857
17868 interface IParallelPortChangedEvent : IEvent
17869 {
17875 readonly attribute IParallelPort parallelPort;
17876
17877 };
17878
17888 interface IStorageControllerChangedEvent : IEvent
17889 {
17890 };
17891
17901 interface IMediumChangedEvent : IEvent
17902 {
17908 readonly attribute IMediumAttachment mediumAttachment;
17909
17910 };
17911
17919 interface ICPUChangedEvent : IEvent
17920 {
17926 readonly attribute unsigned long cpu;
17927
17933 readonly attribute boolean add;
17934
17935 };
17936
17944 interface ICPUExecutionCapChangedEvent : IEvent
17945 {
17951 readonly attribute unsigned long executionCap;
17952
17953 };
17954
17962 interface IGuestKeyboardEvent : IEvent
17963 {
17969 readonly attribute long[] scancodes;
17970
17971 };
17972
17980 interface IGuestMouseEvent : IReusableEvent
17981 {
17987 readonly attribute boolean absolute;
17988
17994 readonly attribute long x;
17995
18001 readonly attribute long y;
18002
18008 readonly attribute long z;
18009
18015 readonly attribute long w;
18016
18022 readonly attribute long buttons;
18023
18024 };
18025
18036 interface IVRDEServerChangedEvent : IEvent
18037 {
18038 };
18039
18049 interface IVRDEServerInfoChangedEvent : IEvent
18050 {
18051 };
18052
18063 interface IUSBControllerChangedEvent : IEvent
18064 {
18065 };
18066
18090 interface IUSBDeviceStateChangedEvent : IEvent
18091 {
18097 readonly attribute IUSBDevice device;
18098
18104 readonly attribute boolean attached;
18105
18111 readonly attribute IVirtualBoxErrorInfo error;
18112
18113 };
18114
18130 interface ISharedFolderChangedEvent : IEvent
18131 {
18137 readonly attribute Scope scope;
18138
18139 };
18140
18192 interface IRuntimeErrorEvent : IEvent
18193 {
18199 readonly attribute boolean fatal;
18200
18206 readonly attribute wstring id;
18207
18213 readonly attribute wstring message;
18214
18215 };
18216
18224 interface IEventSourceChangedEvent : IEvent
18225 {
18231 readonly attribute IEventListener listener;
18232
18238 readonly attribute boolean add;
18239
18240 };
18241
18250 interface IExtraDataChangedEvent : IEvent
18251 {
18258 readonly attribute wstringUUID machineId;
18259
18265 readonly attribute wstring key;
18266
18272 readonly attribute wstring value;
18273
18274 };
18275
18281 interface IVetoEvent : IEvent
18282 {
18292 void addVeto (
18293 in wstring reason
18294 );
18295
18305 void isVetoed (
18306 [retval] out boolean result
18307 );
18308
18318 void getVetos (
18319 [retval] out wstring[] result
18320 );
18321
18322 };
18323
18333 interface IExtraDataCanChangeEvent : IVetoEvent
18334 {
18341 readonly attribute wstringUUID machineId;
18342
18348 readonly attribute wstring key;
18349
18355 readonly attribute wstring value;
18356
18357 };
18358
18374 interface ICanShowWindowEvent : IVetoEvent
18375 {
18376 };
18377
18409 interface IShowWindowEvent : IEvent
18410 {
18419 attribute long long winId;
18420
18421 };
18422
18430 interface INATRedirectEvent : IMachineEvent
18431 {
18437 readonly attribute unsigned long slot;
18438
18444 readonly attribute boolean remove;
18445
18451 readonly attribute wstring name;
18452
18458 readonly attribute NATProtocol proto;
18459
18465 readonly attribute wstring hostIp;
18466
18472 readonly attribute long hostPort;
18473
18479 readonly attribute wstring guestIp;
18480
18486 readonly attribute long guestPort;
18487
18488 };
18489
18497 interface IHostPciDevicePlugEvent : IMachineEvent
18498 {
18504 readonly attribute boolean plugged;
18505
18512 readonly attribute boolean success;
18513
18519 readonly attribute IPciDeviceAttachment attachment;
18520
18527 readonly attribute IEventContext eventContext;
18528
18534 readonly attribute wstring message;
18535
18536 };
18537
18546 interface IVBoxSVCUnavailableEvent : IEvent
18547 {
18548 };
18549
18557 interface IBandwidthGroupChangedEvent : IEvent
18558 {
18564 readonly attribute IBandwidthGroup bandwidthGroup;
18565
18566 };
18567
18568