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
01434 enum CopyFileFlag
01435 {
01440 CopyFileFlag_None = 0,
01445 CopyFileFlag_Recursive = 1,
01450 CopyFileFlag_Update = 2,
01455 CopyFileFlag_FollowLinks = 4,
01456 };
01457
01465 enum CreateDirectoryFlag
01466 {
01471 CreateDirectoryFlag_None = 0,
01476 CreateDirectoryFlag_Parents = 1,
01477 };
01478
01488 enum MediumState
01489 {
01497 MediumState_NotCreated = 0,
01506 MediumState_Created = 1,
01514 MediumState_LockedRead = 2,
01522 MediumState_LockedWrite = 3,
01532 MediumState_Inaccessible = 4,
01539 MediumState_Creating = 5,
01546 MediumState_Deleting = 6,
01547 };
01548
01558 enum MediumType
01559 {
01567 MediumType_Normal = 0,
01575 MediumType_Immutable = 1,
01583 MediumType_Writethrough = 2,
01592 MediumType_Shareable = 3,
01601 MediumType_Readonly = 4,
01602 };
01603
01613 enum MediumVariant
01614 {
01621 MediumVariant_Standard = 0,
01628 MediumVariant_VmdkSplit2G = 0x01,
01636 MediumVariant_VmdkStreamOptimized = 0x04,
01643 MediumVariant_VmdkESX = 0x08,
01650 MediumVariant_Fixed = 0x10000,
01657 MediumVariant_Diff = 0x20000,
01658 };
01659
01660 enum DataType
01661 {
01662 DataType_Int32 = 0,
01663 DataType_Int8 = 1,
01664 DataType_String = 2,
01665 };
01666
01667 enum DataFlags
01668 {
01669 DataFlags_None = 0x00,
01670 DataFlags_Mandatory = 0x01,
01671 DataFlags_Expert = 0x02,
01672 DataFlags_Array = 0x04,
01673 DataFlags_FlagMask = 0x07,
01674 };
01675
01683 enum MediumFormatCapabilities
01684 {
01691 MediumFormatCapabilities_Uuid = 0x01,
01698 MediumFormatCapabilities_CreateFixed = 0x02,
01706 MediumFormatCapabilities_CreateDynamic = 0x04,
01713 MediumFormatCapabilities_CreateSplit2G = 0x08,
01720 MediumFormatCapabilities_Differencing = 0x10,
01727 MediumFormatCapabilities_Asynchronous = 0x20,
01737 MediumFormatCapabilities_File = 0x40,
01746 MediumFormatCapabilities_Properties = 0x80,
01753 MediumFormatCapabilities_TcpNetworking = 0x100,
01760 MediumFormatCapabilities_VFS = 0x200,
01761 MediumFormatCapabilities_CapabilityMask = 0x3FF,
01762 };
01763
01771 enum MouseButtonState
01772 {
01773 MouseButtonState_LeftButton = 0x01,
01774 MouseButtonState_RightButton = 0x02,
01775 MouseButtonState_MiddleButton = 0x04,
01776 MouseButtonState_WheelUp = 0x08,
01777 MouseButtonState_WheelDown = 0x10,
01778 MouseButtonState_XButton1 = 0x20,
01779 MouseButtonState_XButton2 = 0x40,
01780 MouseButtonState_MouseStateMask = 0x7F,
01781 };
01782
01793 enum FramebufferPixelFormat
01794 {
01802 FramebufferPixelFormat_Opaque = 0,
01810 FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
01811 };
01812
01820 enum NetworkAttachmentType
01821 {
01826 NetworkAttachmentType_Null = 0,
01827 NetworkAttachmentType_NAT = 1,
01828 NetworkAttachmentType_Bridged = 2,
01829 NetworkAttachmentType_Internal = 3,
01830 NetworkAttachmentType_HostOnly = 4,
01831 NetworkAttachmentType_VDE = 5,
01832 };
01833
01841 enum NetworkAdapterType
01842 {
01847 NetworkAdapterType_Null = 0,
01852 NetworkAdapterType_Am79C970A = 1,
01857 NetworkAdapterType_Am79C973 = 2,
01862 NetworkAdapterType_I82540EM = 3,
01867 NetworkAdapterType_I82543GC = 4,
01872 NetworkAdapterType_I82545EM = 5,
01877 NetworkAdapterType_Virtio = 6,
01878 };
01879
01888 enum PortMode
01889 {
01894 PortMode_Disconnected = 0,
01899 PortMode_HostPipe = 1,
01904 PortMode_HostDevice = 2,
01909 PortMode_RawFile = 3,
01910 };
01911
01950 enum USBDeviceState
01951 {
01958 USBDeviceState_NotSupported = 0,
01966 USBDeviceState_Unavailable = 1,
01973 USBDeviceState_Busy = 2,
01981 USBDeviceState_Available = 3,
01989 USBDeviceState_Held = 4,
01997 USBDeviceState_Captured = 5,
01998 };
01999
02009 enum USBDeviceFilterAction
02010 {
02015 USBDeviceFilterAction_Null = 0,
02020 USBDeviceFilterAction_Ignore = 1,
02025 USBDeviceFilterAction_Hold = 2,
02026 };
02027
02035 enum AudioDriverType
02036 {
02041 AudioDriverType_Null = 0,
02046 AudioDriverType_WinMM = 1,
02051 AudioDriverType_OSS = 2,
02056 AudioDriverType_ALSA = 3,
02061 AudioDriverType_DirectSound = 4,
02066 AudioDriverType_CoreAudio = 5,
02071 AudioDriverType_MMPM = 6,
02076 AudioDriverType_Pulse = 7,
02081 AudioDriverType_SolAudio = 8,
02082 };
02083
02091 enum AudioControllerType
02092 {
02093 AudioControllerType_AC97 = 0,
02094 AudioControllerType_SB16 = 1,
02095 AudioControllerType_HDA = 2,
02096 };
02097
02105 enum AuthType
02106 {
02111 AuthType_Null = 0,
02112 AuthType_External = 1,
02113 AuthType_Guest = 2,
02114 };
02115
02124 enum StorageBus
02125 {
02130 StorageBus_Null = 0,
02131 StorageBus_IDE = 1,
02132 StorageBus_SATA = 2,
02133 StorageBus_SCSI = 3,
02134 StorageBus_Floppy = 4,
02135 StorageBus_SAS = 5,
02136 };
02137
02146 enum StorageControllerType
02147 {
02152 StorageControllerType_Null = 0,
02157 StorageControllerType_LsiLogic = 1,
02162 StorageControllerType_BusLogic = 2,
02167 StorageControllerType_IntelAhci = 3,
02172 StorageControllerType_PIIX3 = 4,
02177 StorageControllerType_PIIX4 = 5,
02182 StorageControllerType_ICH6 = 6,
02187 StorageControllerType_I82078 = 7,
02192 StorageControllerType_LsiLogicSas = 8,
02193 };
02194
02202 enum ChipsetType
02203 {
02208 ChipsetType_Null = 0,
02213 ChipsetType_PIIX3 = 1,
02218 ChipsetType_ICH9 = 2,
02219 };
02220
02226 enum NATAliasMode
02227 {
02232 NATAliasMode_AliasLog = 0x1,
02237 NATAliasMode_AliasProxyOnly = 0x02,
02242 NATAliasMode_AliasUseSamePorts = 0x04,
02243 };
02244
02250 enum NATProtocol
02251 {
02256 NATProtocol_UDP = 0,
02261 NATProtocol_TCP = 1,
02262 };
02263
02271 enum BandwidthGroupType
02272 {
02279 BandwidthGroupType_Null = 0,
02286 BandwidthGroupType_Disk = 1,
02293 BandwidthGroupType_Network = 2,
02294 };
02295
02304 enum VBoxEventType
02305 {
02312 VBoxEventType_Invalid = 0,
02321 VBoxEventType_Any = 1,
02329 VBoxEventType_Vetoable = 2,
02337 VBoxEventType_MachineEvent = 3,
02345 VBoxEventType_SnapshotEvent = 4,
02354 VBoxEventType_InputEvent = 5,
02361 VBoxEventType_LastWildcard = 31,
02368 VBoxEventType_OnMachineStateChanged = 32,
02375 VBoxEventType_OnMachineDataChanged = 33,
02382 VBoxEventType_OnExtraDataChanged = 34,
02389 VBoxEventType_OnExtraDataCanChange = 35,
02396 VBoxEventType_OnMediumRegistered = 36,
02403 VBoxEventType_OnMachineRegistered = 37,
02410 VBoxEventType_OnSessionStateChanged = 38,
02417 VBoxEventType_OnSnapshotTaken = 39,
02424 VBoxEventType_OnSnapshotDeleted = 40,
02431 VBoxEventType_OnSnapshotChanged = 41,
02438 VBoxEventType_OnGuestPropertyChanged = 42,
02445 VBoxEventType_OnMousePointerShapeChanged = 43,
02452 VBoxEventType_OnMouseCapabilityChanged = 44,
02459 VBoxEventType_OnKeyboardLedsChanged = 45,
02466 VBoxEventType_OnStateChanged = 46,
02473 VBoxEventType_OnAdditionsStateChanged = 47,
02480 VBoxEventType_OnNetworkAdapterChanged = 48,
02487 VBoxEventType_OnSerialPortChanged = 49,
02494 VBoxEventType_OnParallelPortChanged = 50,
02501 VBoxEventType_OnStorageControllerChanged = 51,
02508 VBoxEventType_OnMediumChanged = 52,
02515 VBoxEventType_OnVRDEServerChanged = 53,
02522 VBoxEventType_OnUSBControllerChanged = 54,
02529 VBoxEventType_OnUSBDeviceStateChanged = 55,
02536 VBoxEventType_OnSharedFolderChanged = 56,
02543 VBoxEventType_OnRuntimeError = 57,
02550 VBoxEventType_OnCanShowWindow = 58,
02557 VBoxEventType_OnShowWindow = 59,
02564 VBoxEventType_OnCPUChanged = 60,
02571 VBoxEventType_OnVRDEServerInfoChanged = 61,
02578 VBoxEventType_OnEventSourceChanged = 62,
02585 VBoxEventType_OnCPUExecutionCapChanged = 63,
02592 VBoxEventType_OnGuestKeyboard = 64,
02599 VBoxEventType_OnGuestMouse = 65,
02606 VBoxEventType_OnNATRedirect = 66,
02613 VBoxEventType_OnHostPciDevicePlug = 67,
02620 VBoxEventType_OnVBoxSVCUnavailable = 68,
02627 VBoxEventType_OnBandwidthGroupChanged = 69,
02634 VBoxEventType_Last = 70,
02635 };
02636
02669 interface IVirtualBoxErrorInfo : $errorinfo
02670 {
02688 readonly attribute long resultCode;
02689
02701 readonly attribute wstringUUID interfaceID;
02702
02713 readonly attribute wstring component;
02714
02725 readonly attribute wstring text;
02726
02737 readonly attribute IVirtualBoxErrorInfo next;
02738
02739 };
02740
02751 interface IDHCPServer : $unknown
02752 {
02758 attribute boolean enabled;
02759
02765 readonly attribute wstring IPAddress;
02766
02772 readonly attribute wstring networkMask;
02773
02779 readonly attribute wstring networkName;
02780
02786 readonly attribute wstring lowerIP;
02787
02793 readonly attribute wstring upperIP;
02794
02823 void setConfiguration (
02824 in wstring IPAddress,
02825 in wstring networkMask,
02826 in wstring FromIPAddress,
02827 in wstring ToIPAddress
02828 );
02829
02854 void start (
02855 in wstring networkName,
02856 in wstring trunkName,
02857 in wstring trunkType
02858 );
02859
02872 void stop();
02873
02874 };
02875
02894 interface IVirtualBox : $unknown
02895 {
02903 readonly attribute wstring version;
02904
02910 readonly attribute unsigned long revision;
02911
02921 readonly attribute wstring packageType;
02922
02938 readonly attribute wstring homeFolder;
02939
02947 readonly attribute wstring settingsFilePath;
02948
02952 readonly attribute IHost host;
02953
02957 readonly attribute ISystemProperties systemProperties;
02958
02964 readonly attribute IMachine[] machines;
02965
02975 readonly attribute IMedium[] hardDisks;
02976
02982 readonly attribute IMedium[] DVDImages;
02983
02989 readonly attribute IMedium[] floppyImages;
02990
02991 readonly attribute IProgress[] progressOperations;
02992
02993 readonly attribute IGuestOSType[] guestOSTypes;
02994
03011 readonly attribute ISharedFolder[] sharedFolders;
03012
03018 readonly attribute IPerformanceCollector performanceCollector;
03019
03025 readonly attribute IDHCPServer[] DHCPServers;
03026
03032 readonly attribute IEventSource eventSource;
03033
03039 readonly attribute IExtPackManager extensionPackManager;
03040
03080 void composeMachineFilename (
03081 in wstring name,
03082 in wstring baseFolder,
03083 [retval] out wstring file
03084 );
03085
03182 void createMachine (
03183 in wstring settingsFile,
03184 in wstring name,
03185 in wstring osTypeId,
03186 in wstringUUID id,
03187 in boolean forceOverwrite,
03188 [retval] out IMachine machine
03189 );
03190
03216 void openMachine (
03217 in wstring settingsFile,
03218 [retval] out IMachine machine
03219 );
03220
03252 void registerMachine (
03253 in IMachine machine
03254 );
03255
03276 void findMachine (
03277 in wstring nameOrId,
03278 [retval] out IMachine machine
03279 );
03280
03290 void createAppliance (
03291 [retval] out IAppliance appliance
03292 );
03293
03356 void createHardDisk (
03357 in wstring format,
03358 in wstring location,
03359 [retval] out IMedium medium
03360 );
03361
03473 void openMedium (
03474 in wstring location,
03475 in DeviceType deviceType,
03476 in AccessMode accessMode,
03477 [retval] out IMedium medium
03478 );
03479
03511 void findMedium (
03512 in wstring location,
03513 in DeviceType type,
03514 [retval] out IMedium medium
03515 );
03516
03545 void getGuestOSType (
03546 in wstringUUID id,
03547 [retval] out IGuestOSType type
03548 );
03549
03572 void createSharedFolder (
03573 in wstring name,
03574 in wstring hostPath,
03575 in boolean writable,
03576 in boolean automount
03577 );
03578
03593 void removeSharedFolder (
03594 in wstring name
03595 );
03596
03605 void getExtraDataKeys (
03606 [retval] out wstring[] value
03607 );
03608
03637 void getExtraData (
03638 in wstring key,
03639 [retval] out wstring value
03640 );
03641
03691 void setExtraData (
03692 in wstring key,
03693 in wstring value
03694 );
03695
03712 void createDHCPServer (
03713 in wstring name,
03714 [retval] out IDHCPServer server
03715 );
03716
03733 void findDHCPServerByNetworkName (
03734 in wstring name,
03735 [retval] out IDHCPServer server
03736 );
03737
03752 void removeDHCPServer (
03753 in IDHCPServer server
03754 );
03755
03780 void checkFirmwarePresent (
03781 in FirmwareType firmwareType,
03782 in wstring version,
03783 out wstring url,
03784 out wstring file,
03785 [retval] out boolean result
03786 );
03787
03788 };
03789
03800 interface IVFSExplorer : $unknown
03801 {
03805 readonly attribute wstring path;
03806
03810 readonly attribute VFSType type;
03811
03819 void update (
03820 [retval] out IProgress aProgress
03821 );
03822
03830 void cd (
03831 in wstring aDir,
03832 [retval] out IProgress aProgress
03833 );
03834
03840 void cdUp (
03841 [retval] out IProgress aProgress
03842 );
03843
03856 void entryList (
03857 out wstring[] aNames,
03858 out unsigned long[] aTypes,
03859 out unsigned long[] aSizes,
03860 out unsigned long[] aModes
03861 );
03862
03871 void exists (
03872 in wstring[] aNames,
03873 [retval] out wstring[] aExists
03874 );
03875
03883 void remove (
03884 in wstring[] aNames,
03885 [retval] out IProgress aProgress
03886 );
03887
03888 };
03889
03955 interface IAppliance : $unknown
03956 {
03964 readonly attribute wstring path;
03965
03996 readonly attribute wstring[] disks;
03997
04005 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
04006
04014 readonly attribute wstring[] machines;
04015
04032 void read (
04033 in wstring file,
04034 [retval] out IProgress aProgress
04035 );
04036
04053 void interpret();
04054
04075 void importMachines (
04076 [retval] out IProgress aProgress
04077 );
04078
04086 void createVFSExplorer (
04087 in wstring aUri,
04088 [retval] out IVFSExplorer aExplorer
04089 );
04090
04120 void write (
04121 in wstring format,
04122 in boolean manifest,
04123 in wstring path,
04124 [retval] out IProgress progress
04125 );
04126
04132 void getWarnings (
04133 [retval] out wstring[] aWarnings
04134 );
04135
04136 };
04137
04149 interface IVirtualSystemDescription : $unknown
04150 {
04154 readonly attribute unsigned long count;
04155
04279 void getDescription (
04280 out VirtualSystemDescriptionType[] aTypes,
04281 out wstring[] aRefs,
04282 out wstring[] aOvfValues,
04283 out wstring[] aVBoxValues,
04284 out wstring[] aExtraConfigValues
04285 );
04286
04303 void getDescriptionByType (
04304 in VirtualSystemDescriptionType aType,
04305 out VirtualSystemDescriptionType[] aTypes,
04306 out wstring[] aRefs,
04307 out wstring[] aOvfValues,
04308 out wstring[] aVBoxValues,
04309 out wstring[] aExtraConfigValues
04310 );
04311
04323 void getValuesByType (
04324 in VirtualSystemDescriptionType aType,
04325 in VirtualSystemDescriptionValueType aWhich,
04326 [retval] out wstring[] aValues
04327 );
04328
04354 void setFinalValues (
04355 in boolean[] aEnabled,
04356 in wstring[] aVBoxValues,
04357 in wstring[] aExtraConfigValues
04358 );
04359
04374 void addDescription (
04375 in VirtualSystemDescriptionType aType,
04376 in wstring aVBoxValue,
04377 in wstring aExtraConfigValue
04378 );
04379
04380 };
04381
04382 interface IInternalMachineControl : $unknown
04383 {
04390 void setRemoveSavedStateFile (
04391 in boolean aRemove
04392 );
04393
04405 void updateState (
04406 in MachineState state
04407 );
04408
04409 void getIPCId (
04410 [retval] out wstring id
04411 );
04412
04424 void beginPowerUp (
04425 in IProgress aProgress
04426 );
04427
04437 void endPowerUp (
04438 in long result
04439 );
04440
04454 void runUSBDeviceFilters (
04455 in IUSBDevice device,
04456 out boolean matched,
04457 out unsigned long maskedInterfaces
04458 );
04459
04468 void captureUSBDevice (
04469 in wstringUUID id
04470 );
04471
04487 void detachUSBDevice (
04488 in wstringUUID id,
04489 in boolean done
04490 );
04491
04500 void autoCaptureUSBDevices();
04501
04517 void detachAllUSBDevices (
04518 in boolean done
04519 );
04520
04535 void onSessionEnd (
04536 in ISession session,
04537 [retval] out IProgress progress
04538 );
04539
04555 void beginSavingState (
04556 out IProgress progress,
04557 out wstring stateFilePath
04558 );
04559
04589 void endSavingState (
04590 in long result,
04591 in wstring errMsg
04592 );
04593
04608 void adoptSavedState (
04609 in wstring savedStateFile
04610 );
04611
04660 void beginTakingSnapshot (
04661 in IConsole initiator,
04662 in wstring name,
04663 in wstring description,
04664 in IProgress consoleProgress,
04665 in boolean fTakingSnapshotOnline,
04666 out wstring stateFilePath
04667 );
04668
04678 void endTakingSnapshot (
04679 in boolean success
04680 );
04681
04702 void deleteSnapshot (
04703 in IConsole initiator,
04704 in wstringUUID id,
04705 out MachineState machineState,
04706 [retval] out IProgress progress
04707 );
04708
04727 void finishOnlineMergeMedium (
04728 in IMediumAttachment mediumAttachment,
04729 in IMedium source,
04730 in IMedium target,
04731 in boolean mergeForward,
04732 in IMedium parentForTarget,
04733 in IMedium[] childrenToReparent
04734 );
04735
04749 void restoreSnapshot (
04750 in IConsole initiator,
04751 in ISnapshot snapshot,
04752 out MachineState machineState,
04753 [retval] out IProgress progress
04754 );
04755
04782 void pullGuestProperties (
04783 out wstring[] name,
04784 out wstring[] value,
04785 out long long[] timestamp,
04786 out wstring[] flags
04787 );
04788
04810 void pushGuestProperty (
04811 in wstring name,
04812 in wstring value,
04813 in long long timestamp,
04814 in wstring flags
04815 );
04816
04828 void lockMedia();
04829
04839 void unlockMedia();
04840
04841 };
04842
04851 interface IBIOSSettings : $unknown
04852 {
04856 attribute boolean logoFadeIn;
04857
04861 attribute boolean logoFadeOut;
04862
04866 attribute unsigned long logoDisplayTime;
04867
04874 attribute wstring logoImagePath;
04875
04879 attribute BIOSBootMenuMode bootMenuMode;
04880
04884 attribute boolean ACPIEnabled;
04885
04892 attribute boolean IOAPICEnabled;
04893
04903 attribute long long timeOffset;
04904
04911 attribute boolean PXEDebugEnabled;
04912
04913 };
04914
04922 interface IEventContext : $unknown
04923 {
04924 };
04925
04933 interface IPciAddress : $unknown
04934 {
04940 attribute short bus;
04941
04947 attribute short device;
04948
04954 attribute short devFunction;
04955
04961 void asLong (
04962 [retval] out long result
04963 );
04964
04970 void fromLong (
04971 in long number
04972 );
04973
04974 };
04975
04983 interface IPciDeviceAttachment : $unknown
04984 {
04990 readonly attribute wstring name;
04991
04997 readonly attribute boolean isPhysicalDevice;
04998
05004 readonly attribute long hostAddress;
05005
05011 readonly attribute long guestAddress;
05012
05013 };
05014
05055 interface IMachine : $unknown
05056 {
05060 readonly attribute IVirtualBox parent;
05061
05111 readonly attribute boolean accessible;
05112
05124 readonly attribute IVirtualBoxErrorInfo accessError;
05125
05165 attribute wstring name;
05166
05177 attribute wstring description;
05178
05182 readonly attribute wstringUUID id;
05183
05198 attribute wstring OSTypeId;
05199
05203 attribute wstring HardwareVersion;
05204
05214 attribute wstringUUID hardwareUUID;
05215
05219 attribute unsigned long CPUCount;
05220
05226 attribute boolean CPUHotPlugEnabled;
05227
05235 attribute unsigned long CPUExecutionCap;
05236
05240 attribute unsigned long memorySize;
05241
05245 attribute unsigned long memoryBalloonSize;
05246
05253 attribute boolean PageFusionEnabled;
05254
05258 attribute unsigned long VRAMSize;
05259
05265 attribute boolean accelerate3DEnabled;
05266
05272 attribute boolean accelerate2DVideoEnabled;
05273
05284 attribute unsigned long monitorCount;
05285
05289 readonly attribute IBIOSSettings BIOSSettings;
05290
05295 attribute FirmwareType firmwareType;
05296
05302 attribute PointingHidType pointingHidType;
05303
05309 attribute KeyboardHidType keyboardHidType;
05310
05317 attribute boolean hpetEnabled;
05318
05322 attribute ChipsetType chipsetType;
05323
05357 attribute wstring snapshotFolder;
05358
05362 readonly attribute IVRDEServer VRDEServer;
05363
05367 readonly attribute IMediumAttachment[] mediumAttachments;
05368
05380 readonly attribute IUSBController USBController;
05381
05385 readonly attribute IAudioAdapter audioAdapter;
05386
05390 readonly attribute IStorageController[] storageControllers;
05391
05397 readonly attribute wstring settingsFilePath;
05398
05423 readonly attribute boolean settingsModified;
05424
05428 readonly attribute SessionState sessionState;
05429
05442 readonly attribute wstring sessionType;
05443
05453 readonly attribute unsigned long sessionPid;
05454
05458 readonly attribute MachineState state;
05459
05466 readonly attribute long long lastStateChange;
05467
05479 readonly attribute wstring stateFilePath;
05480
05490 readonly attribute wstring logFolder;
05491
05502 readonly attribute ISnapshot currentSnapshot;
05503
05510 readonly attribute unsigned long snapshotCount;
05511
05543 readonly attribute boolean currentStateModified;
05544
05556 readonly attribute ISharedFolder[] sharedFolders;
05557
05564 attribute ClipboardMode clipboardMode;
05565
05573 attribute wstring guestPropertyNotificationPatterns;
05574
05583 attribute boolean teleporterEnabled;
05584
05595 attribute unsigned long teleporterPort;
05596
05603 attribute wstring teleporterAddress;
05604
05612 attribute wstring teleporterPassword;
05613
05621 attribute FaultToleranceState faultToleranceState;
05622
05629 attribute unsigned long faultTolerancePort;
05630
05636 attribute wstring faultToleranceAddress;
05637
05645 attribute wstring faultTolerancePassword;
05646
05652 attribute unsigned long faultToleranceSyncInterval;
05653
05661 attribute boolean RTCUseUTC;
05662
05669 attribute boolean ioCacheEnabled;
05670
05676 attribute unsigned long ioCacheSize;
05677
05683 readonly attribute IBandwidthControl bandwidthControl;
05684
05693 readonly attribute IPciDeviceAttachment[] pciDeviceAssignments;
05694
05800 void lockMachine (
05801 in ISession session,
05802 in LockType lockType
05803 );
05804
05928 void launchVMProcess (
05929 in ISession session,
05930 in wstring type,
05931 in wstring environment,
05932 [retval] out IProgress progress
05933 );
05934
05972 void setBootOrder (
05973 in unsigned long position,
05974 in DeviceType device
05975 );
05976
06011 void getBootOrder (
06012 in unsigned long position,
06013 [retval] out DeviceType device
06014 );
06015
06117 void attachDevice (
06118 in wstring name,
06119 in long controllerPort,
06120 in long device,
06121 in DeviceType type,
06122 in IMedium medium
06123 );
06124
06177 void detachDevice (
06178 in wstring name,
06179 in long controllerPort,
06180 in long device
06181 );
06182
06225 void passthroughDevice (
06226 in wstring name,
06227 in long controllerPort,
06228 in long device,
06229 in boolean passthrough
06230 );
06231
06274 void setBandwidthGroupForDevice (
06275 in wstring name,
06276 in long controllerPort,
06277 in long device,
06278 in IBandwidthGroup bandwidthGroup
06279 );
06280
06343 void mountMedium (
06344 in wstring name,
06345 in long controllerPort,
06346 in long device,
06347 in IMedium medium,
06348 in boolean force
06349 );
06350
06379 void getMedium (
06380 in wstring name,
06381 in long controllerPort,
06382 in long device,
06383 [retval] out IMedium medium
06384 );
06385
06400 void getMediumAttachmentsOfController (
06401 in wstring name,
06402 [retval] out IMediumAttachment[] mediumAttachments
06403 );
06404
06419 void getMediumAttachment (
06420 in wstring name,
06421 in long controllerPort,
06422 in long device,
06423 [retval] out IMediumAttachment attachment
06424 );
06425
06471 void attachHostPciDevice (
06472 in long hostAddress,
06473 in long desiredGuestAddress,
06474 in IEventContext eventContext,
06475 in boolean tryToUnbind
06476 );
06477
06521 void detachHostPciDevice (
06522 in long hostAddress
06523 );
06524
06542 void getNetworkAdapter (
06543 in unsigned long slot,
06544 [retval] out INetworkAdapter adapter
06545 );
06546
06579 void addStorageController (
06580 in wstring name,
06581 in StorageBus connectionType,
06582 [retval] out IStorageController controller
06583 );
06584
06598 void getStorageControllerByName (
06599 in wstring name,
06600 [retval] out IStorageController storageController
06601 );
06602
06616 void getStorageControllerByInstance (
06617 in unsigned long instance,
06618 [retval] out IStorageController storageController
06619 );
06620
06634 void removeStorageController (
06635 in wstring name
06636 );
06637
06659 void setStorageControllerBootable (
06660 in wstring name,
06661 in boolean bootable
06662 );
06663
06681 void getSerialPort (
06682 in unsigned long slot,
06683 [retval] out ISerialPort port
06684 );
06685
06703 void getParallelPort (
06704 in unsigned long slot,
06705 [retval] out IParallelPort port
06706 );
06707
06716 void getExtraDataKeys (
06717 [retval] out wstring[] value
06718 );
06719
06748 void getExtraData (
06749 in wstring key,
06750 [retval] out wstring value
06751 );
06752
06802 void setExtraData (
06803 in wstring key,
06804 in wstring value
06805 );
06806
06828 void getCPUProperty (
06829 in CPUPropertyType property,
06830 [retval] out boolean value
06831 );
06832
06854 void setCPUProperty (
06855 in CPUPropertyType property,
06856 in boolean value
06857 );
06858
06898 void getCPUIDLeaf (
06899 in unsigned long id,
06900 out unsigned long valEax,
06901 out unsigned long valEbx,
06902 out unsigned long valEcx,
06903 out unsigned long valEdx
06904 );
06905
06949 void setCPUIDLeaf (
06950 in unsigned long id,
06951 in unsigned long valEax,
06952 in unsigned long valEbx,
06953 in unsigned long valEcx,
06954 in unsigned long valEdx
06955 );
06956
06974 void removeCPUIDLeaf (
06975 in unsigned long id
06976 );
06977
06983 void removeAllCPUIDLeaves();
06984
07006 void getHWVirtExProperty (
07007 in HWVirtExPropertyType property,
07008 [retval] out boolean value
07009 );
07010
07032 void setHWVirtExProperty (
07033 in HWVirtExPropertyType property,
07034 in boolean value
07035 );
07036
07082 void saveSettings();
07083
07107 void discardSettings();
07108
07183 void unregister (
07184 in CleanupMode cleanupMode,
07185 [retval] out IMedium[] aMedia
07186 );
07187
07244 void delete (
07245 in IMedium[] aMedia,
07246 [retval] out IProgress aProgress
07247 );
07248
07260 void export (
07261 in IAppliance aAppliance,
07262 in wstring location,
07263 [retval] out IVirtualSystemDescription aDescription
07264 );
07265
07288 void findSnapshot (
07289 in wstring nameOrId,
07290 [retval] out ISnapshot snapshot
07291 );
07292
07326 void createSharedFolder (
07327 in wstring name,
07328 in wstring hostPath,
07329 in boolean writable,
07330 in boolean automount
07331 );
07332
07358 void removeSharedFolder (
07359 in wstring name
07360 );
07361
07385 void canShowConsoleWindow (
07386 [retval] out boolean canShow
07387 );
07388
07423 void showConsoleWindow (
07424 [retval] out long long winId
07425 );
07426
07459 void getGuestProperty (
07460 in wstring name,
07461 out wstring value,
07462 out long long timestamp,
07463 out wstring flags
07464 );
07465
07488 void getGuestPropertyValue (
07489 in wstring property,
07490 [retval] out wstring value
07491 );
07492
07515 void getGuestPropertyTimestamp (
07516 in wstring property,
07517 [retval] out long long value
07518 );
07519
07570 void setGuestProperty (
07571 in wstring property,
07572 in wstring value,
07573 in wstring flags
07574 );
07575
07616 void setGuestPropertyValue (
07617 in wstring property,
07618 in wstring value
07619 );
07620
07651 void enumerateGuestProperties (
07652 in wstring patterns,
07653 out wstring[] name,
07654 out wstring[] value,
07655 out long long[] timestamp,
07656 out wstring[] flags
07657 );
07658
07676 void querySavedGuestSize (
07677 in unsigned long screenId,
07678 out unsigned long width,
07679 out unsigned long height
07680 );
07681
07703 void querySavedThumbnailSize (
07704 in unsigned long screenId,
07705 out unsigned long size,
07706 out unsigned long width,
07707 out unsigned long height
07708 );
07709
07736 void readSavedThumbnailToArray (
07737 in unsigned long screenId,
07738 in boolean BGR,
07739 out unsigned long width,
07740 out unsigned long height,
07741 [retval] out octet[] data
07742 );
07743
07765 void readSavedThumbnailPNGToArray (
07766 in unsigned long screenId,
07767 out unsigned long width,
07768 out unsigned long height,
07769 [retval] out octet[] data
07770 );
07771
07793 void querySavedScreenshotPNGSize (
07794 in unsigned long screenId,
07795 out unsigned long size,
07796 out unsigned long width,
07797 out unsigned long height
07798 );
07799
07821 void readSavedScreenshotPNGToArray (
07822 in unsigned long screenId,
07823 out unsigned long width,
07824 out unsigned long height,
07825 [retval] out octet[] data
07826 );
07827
07837 void hotPlugCPU (
07838 in unsigned long cpu
07839 );
07840
07850 void hotUnplugCPU (
07851 in unsigned long cpu
07852 );
07853
07867 void getCPUStatus (
07868 in unsigned long cpu,
07869 [retval] out boolean attached
07870 );
07871
07886 void queryLogFilename (
07887 in unsigned long idx,
07888 [retval] out wstring filename
07889 );
07890
07916 void readLog (
07917 in unsigned long idx,
07918 in long long offset,
07919 in long long size,
07920 [retval] out octet[] data
07921 );
07922
07923 };
07924
07933 interface IVRDEServerInfo : $unknown
07934 {
07940 readonly attribute boolean active;
07941
07950 readonly attribute long port;
07951
07957 readonly attribute unsigned long numberOfClients;
07958
07964 readonly attribute long long beginTime;
07965
07972 readonly attribute long long endTime;
07973
07979 readonly attribute long long bytesSent;
07980
07986 readonly attribute long long bytesSentTotal;
07987
07993 readonly attribute long long bytesReceived;
07994
08000 readonly attribute long long bytesReceivedTotal;
08001
08007 readonly attribute wstring user;
08008
08014 readonly attribute wstring domain;
08015
08021 readonly attribute wstring clientName;
08022
08028 readonly attribute wstring clientIP;
08029
08035 readonly attribute unsigned long clientVersion;
08036
08044 readonly attribute unsigned long encryptionStyle;
08045
08046 };
08047
08069 interface IConsole : $unknown
08070 {
08082 readonly attribute IMachine machine;
08083
08097 readonly attribute MachineState state;
08098
08102 readonly attribute IGuest guest;
08103
08114 readonly attribute IKeyboard keyboard;
08115
08126 readonly attribute IMouse mouse;
08127
08137 readonly attribute IDisplay display;
08138
08142 readonly attribute IMachineDebugger debugger;
08143
08154 readonly attribute IUSBDevice[] USBDevices;
08155
08163 readonly attribute IHostUSBDevice[] remoteUSBDevices;
08164
08180 readonly attribute ISharedFolder[] sharedFolders;
08181
08187 readonly attribute IVRDEServerInfo VRDEServerInfo;
08188
08194 readonly attribute IEventSource eventSource;
08195
08199 readonly attribute IPciDeviceAttachment[] attachedPciDevices;
08200
08265 void powerUp (
08266 [retval] out IProgress progress
08267 );
08268
08302 void powerUpPaused (
08303 [retval] out IProgress progress
08304 );
08305
08325 void powerDown (
08326 [retval] out IProgress progress
08327 );
08328
08348 void reset();
08349
08369 void pause();
08370
08390 void resume();
08391
08411 void powerButton();
08412
08432 void sleepButton();
08433
08445 void getPowerButtonHandled (
08446 [retval] out boolean handled
08447 );
08448
08462 void getGuestEnteredACPIMode (
08463 [retval] out boolean entered
08464 );
08465
08518 void saveState (
08519 [retval] out IProgress progress
08520 );
08521
08554 void adoptSavedState (
08555 in wstring savedStateFile
08556 );
08557
08588 void discardSavedState (
08589 in boolean fRemoveFile
08590 );
08591
08604 void getDeviceActivity (
08605 in DeviceType type,
08606 [retval] out DeviceActivity activity
08607 );
08608
08645 void attachUSBDevice (
08646 in wstringUUID id
08647 );
08648
08682 void detachUSBDevice (
08683 in wstringUUID id,
08684 [retval] out IUSBDevice device
08685 );
08686
08709 void findUSBDeviceByAddress (
08710 in wstring name,
08711 [retval] out IUSBDevice device
08712 );
08713
08733 void findUSBDeviceById (
08734 in wstringUUID id,
08735 [retval] out IUSBDevice device
08736 );
08737
08771 void createSharedFolder (
08772 in wstring name,
08773 in wstring hostPath,
08774 in boolean writable,
08775 in boolean automount
08776 );
08777
08802 void removeSharedFolder (
08803 in wstring name
08804 );
08805
08843 void takeSnapshot (
08844 in wstring name,
08845 in wstring description,
08846 [retval] out IProgress progress
08847 );
08848
08919 void deleteSnapshot (
08920 in wstringUUID id,
08921 [retval] out IProgress progress
08922 );
08923
08964 void restoreSnapshot (
08965 in ISnapshot snapshot,
08966 [retval] out IProgress progress
08967 );
08968
09007 void teleport (
09008 in wstring hostname,
09009 in unsigned long tcpport,
09010 in wstring password,
09011 in unsigned long maxDowntime,
09012 [retval] out IProgress progress
09013 );
09014
09015 };
09016
09027 interface IHostNetworkInterface : $unknown
09028 {
09032 readonly attribute wstring name;
09033
09037 readonly attribute wstringUUID id;
09038
09042 readonly attribute wstring networkName;
09043
09047 readonly attribute boolean dhcpEnabled;
09048
09052 readonly attribute wstring IPAddress;
09053
09057 readonly attribute wstring networkMask;
09058
09062 readonly attribute boolean IPV6Supported;
09063
09067 readonly attribute wstring IPV6Address;
09068
09072 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
09073
09077 readonly attribute wstring hardwareAddress;
09078
09082 readonly attribute HostNetworkInterfaceMediumType mediumType;
09083
09087 readonly attribute HostNetworkInterfaceStatus status;
09088
09092 readonly attribute HostNetworkInterfaceType interfaceType;
09093
09105 void enableStaticIpConfig (
09106 in wstring IPAddress,
09107 in wstring networkMask
09108 );
09109
09121 void enableStaticIpConfigV6 (
09122 in wstring IPV6Address,
09123 in unsigned long IPV6NetworkMaskPrefixLength
09124 );
09125
09129 void enableDynamicIpConfig();
09130
09134 void dhcpRediscover();
09135
09136 };
09137
09154 interface IHost : $unknown
09155 {
09159 readonly attribute IMedium[] DVDDrives;
09160
09164 readonly attribute IMedium[] floppyDrives;
09165
09179 readonly attribute IHostUSBDevice[] USBDevices;
09180
09203 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
09204
09208 readonly attribute IHostNetworkInterface[] networkInterfaces;
09209
09213 readonly attribute unsigned long processorCount;
09214
09218 readonly attribute unsigned long processorOnlineCount;
09219
09223 readonly attribute unsigned long processorCoreCount;
09224
09228 readonly attribute unsigned long memorySize;
09229
09233 readonly attribute unsigned long memoryAvailable;
09234
09238 readonly attribute wstring operatingSystem;
09239
09243 readonly attribute wstring OSVersion;
09244
09248 readonly attribute long long UTCTime;
09249
09253 readonly attribute boolean Acceleration3DAvailable;
09254
09269 void getProcessorSpeed (
09270 in unsigned long cpuId,
09271 [retval] out unsigned long speed
09272 );
09273
09285 void getProcessorFeature (
09286 in ProcessorFeature feature,
09287 [retval] out boolean supported
09288 );
09289
09308 void getProcessorDescription (
09309 in unsigned long cpuId,
09310 [retval] out wstring description
09311 );
09312
09353 void getProcessorCPUIDLeaf (
09354 in unsigned long cpuId,
09355 in unsigned long leaf,
09356 in unsigned long subLeaf,
09357 out unsigned long valEax,
09358 out unsigned long valEbx,
09359 out unsigned long valEcx,
09360 out unsigned long valEdx
09361 );
09362
09383 void createHostOnlyNetworkInterface (
09384 out IHostNetworkInterface hostInterface,
09385 [retval] out IProgress progress
09386 );
09387
09408 void removeHostOnlyNetworkInterface (
09409 in wstringUUID id,
09410 [retval] out IProgress progress
09411 );
09412
09432 void createUSBDeviceFilter (
09433 in wstring name,
09434 [retval] out IHostUSBDeviceFilter filter
09435 );
09436
09479 void insertUSBDeviceFilter (
09480 in unsigned long position,
09481 in IHostUSBDeviceFilter filter
09482 );
09483
09511 void removeUSBDeviceFilter (
09512 in unsigned long position
09513 );
09514
09532 void findHostDVDDrive (
09533 in wstring name,
09534 [retval] out IMedium drive
09535 );
09536
09554 void findHostFloppyDrive (
09555 in wstring name,
09556 [retval] out IMedium drive
09557 );
09558
09574 void findHostNetworkInterfaceByName (
09575 in wstring name,
09576 [retval] out IHostNetworkInterface networkInterface
09577 );
09578
09594 void findHostNetworkInterfaceById (
09595 in wstringUUID id,
09596 [retval] out IHostNetworkInterface networkInterface
09597 );
09598
09608 void findHostNetworkInterfacesOfType (
09609 in HostNetworkInterfaceType type,
09610 [retval] out IHostNetworkInterface[] networkInterfaces
09611 );
09612
09632 void findUSBDeviceById (
09633 in wstringUUID id,
09634 [retval] out IHostUSBDevice device
09635 );
09636
09659 void findUSBDeviceByAddress (
09660 in wstring name,
09661 [retval] out IHostUSBDevice device
09662 );
09663
09664 };
09665
09678 interface ISystemProperties : $unknown
09679 {
09683 readonly attribute unsigned long minGuestRAM;
09684
09688 readonly attribute unsigned long maxGuestRAM;
09689
09693 readonly attribute unsigned long minGuestVRAM;
09694
09698 readonly attribute unsigned long maxGuestVRAM;
09699
09703 readonly attribute unsigned long minGuestCPUCount;
09704
09708 readonly attribute unsigned long maxGuestCPUCount;
09709
09713 readonly attribute unsigned long maxGuestMonitors;
09714
09719 readonly attribute long long infoVDSize;
09720
09727 readonly attribute unsigned long networkAdapterCount;
09728
09735 readonly attribute unsigned long serialPortCount;
09736
09743 readonly attribute unsigned long parallelPortCount;
09744
09754 readonly attribute unsigned long maxBootPosition;
09755
09779 attribute wstring defaultMachineFolder;
09780
09806 readonly attribute IMediumFormat[] mediumFormats;
09807
09841 attribute wstring defaultHardDiskFormat;
09842
09848 attribute long long freeDiskSpaceWarning;
09849
09854 attribute unsigned long freeDiskSpacePercentWarning;
09855
09861 attribute long long freeDiskSpaceError;
09862
09867 attribute unsigned long freeDiskSpacePercentError;
09868
09892 attribute wstring VRDEAuthLibrary;
09893
09922 attribute wstring webServiceAuthLibrary;
09923
09937 attribute wstring defaultVRDEExtPack;
09938
09944 attribute unsigned long LogHistoryCount;
09945
09950 readonly attribute AudioDriverType defaultAudioDriver;
09951
09961 void getMaxDevicesPerPortForStorageBus (
09962 in StorageBus bus,
09963 [retval] out unsigned long maxDevicesPerPort
09964 );
09965
09973 void getMinPortCountForStorageBus (
09974 in StorageBus bus,
09975 [retval] out unsigned long minPortCount
09976 );
09977
09985 void getMaxPortCountForStorageBus (
09986 in StorageBus bus,
09987 [retval] out unsigned long maxPortCount
09988 );
09989
10002 void getMaxInstancesOfStorageBus (
10003 in ChipsetType chipset,
10004 in StorageBus bus,
10005 [retval] out unsigned long maxInstances
10006 );
10007
10017 void getDeviceTypesForStorageBus (
10018 in StorageBus bus,
10019 [retval] out DeviceType[] deviceTypes
10020 );
10021
10030 void getDefaultIoCacheSettingForStorageController (
10031 in StorageControllerType controllerType,
10032 [retval] out boolean enabled
10033 );
10034
10035 };
10036
10042 interface IGuestOSType : $unknown
10043 {
10047 readonly attribute wstring familyId;
10048
10052 readonly attribute wstring familyDescription;
10053
10057 readonly attribute wstring id;
10058
10062 readonly attribute wstring description;
10063
10067 readonly attribute boolean is64Bit;
10068
10072 readonly attribute boolean recommendedIOAPIC;
10073
10077 readonly attribute boolean recommendedVirtEx;
10078
10082 readonly attribute unsigned long recommendedRAM;
10083
10087 readonly attribute unsigned long recommendedVRAM;
10088
10092 readonly attribute long long recommendedHDD;
10093
10097 readonly attribute NetworkAdapterType adapterType;
10098
10102 readonly attribute boolean recommendedPae;
10103
10107 readonly attribute StorageControllerType recommendedDvdStorageController;
10108
10112 readonly attribute StorageBus recommendedDvdStorageBus;
10113
10117 readonly attribute StorageControllerType recommendedHdStorageController;
10118
10122 readonly attribute StorageBus recommendedHdStorageBus;
10123
10127 readonly attribute FirmwareType recommendedFirmware;
10128
10132 readonly attribute boolean recommendedUsbHid;
10133
10137 readonly attribute boolean recommendedHpet;
10138
10142 readonly attribute boolean recommendedUsbTablet;
10143
10147 readonly attribute boolean recommendedRtcUseUtc;
10148
10152 readonly attribute ChipsetType recommendedChipset;
10153
10157 readonly attribute AudioControllerType recommendedAudioController;
10158
10159 };
10160
10174 interface IGuest : $unknown
10175 {
10190 readonly attribute wstring OSTypeId;
10191
10197 readonly attribute AdditionsRunLevelType additionsRunLevel;
10198
10206 readonly attribute wstring additionsVersion;
10207
10214 readonly attribute boolean supportsSeamless;
10215
10224 readonly attribute boolean supportsGraphics;
10225
10229 attribute unsigned long memoryBalloonSize;
10230
10234 attribute unsigned long statisticsUpdateInterval;
10235
10267 void internalGetStatistics (
10268 out unsigned long cpuUser,
10269 out unsigned long cpuKernel,
10270 out unsigned long cpuIdle,
10271 out unsigned long memTotal,
10272 out unsigned long memFree,
10273 out unsigned long memBalloon,
10274 out unsigned long memShared,
10275 out unsigned long memCache,
10276 out unsigned long pagedTotal,
10277 out unsigned long memAllocTotal,
10278 out unsigned long memFreeTotal,
10279 out unsigned long memBalloonTotal,
10280 out unsigned long memSharedTotal
10281 );
10282
10300 void getAdditionsStatus (
10301 in AdditionsRunLevelType level,
10302 [retval] out boolean active
10303 );
10304
10334 void setCredentials (
10335 in wstring userName,
10336 in wstring password,
10337 in wstring domain,
10338 in boolean allowInteractiveLogon
10339 );
10340
10394 void executeProcess (
10395 in wstring execName,
10396 in unsigned long flags,
10397 in wstring[] arguments,
10398 in wstring[] environment,
10399 in wstring userName,
10400 in wstring password,
10401 in unsigned long timeoutMS,
10402 out unsigned long pid,
10403 [retval] out IProgress progress
10404 );
10405
10443 void getProcessOutput (
10444 in unsigned long pid,
10445 in unsigned long flags,
10446 in unsigned long timeoutMS,
10447 in long long size,
10448 [retval] out octet[] data
10449 );
10450
10481 void getProcessStatus (
10482 in unsigned long pid,
10483 out unsigned long exitcode,
10484 out unsigned long flags,
10485 [retval] out unsigned long reason
10486 );
10487
10525 void copyToGuest (
10526 in wstring source,
10527 in wstring dest,
10528 in wstring userName,
10529 in wstring password,
10530 in unsigned long flags,
10531 [retval] out IProgress progress
10532 );
10533
10571 void createDirectory (
10572 in wstring directory,
10573 in wstring userName,
10574 in wstring password,
10575 in unsigned long mode,
10576 in unsigned long flags,
10577 [retval] out IProgress progress
10578 );
10579
10609 void setProcessInput (
10610 in unsigned long pid,
10611 in unsigned long flags,
10612 in octet[] data,
10613 [retval] out unsigned long written
10614 );
10615
10640 void updateGuestAdditions (
10641 in wstring source,
10642 in unsigned long flags,
10643 [retval] out IProgress progress
10644 );
10645
10646 };
10647
10688 interface IProgress : $unknown
10689 {
10693 readonly attribute wstringUUID id;
10694
10698 readonly attribute wstring description;
10699
10703 readonly attribute $unknown initiator;
10704
10708 readonly attribute boolean cancelable;
10709
10717 readonly attribute unsigned long percent;
10718
10732 readonly attribute long timeRemaining;
10733
10737 readonly attribute boolean completed;
10738
10742 readonly attribute boolean canceled;
10743
10750 readonly attribute long resultCode;
10751
10761 readonly attribute IVirtualBoxErrorInfo errorInfo;
10762
10769 readonly attribute unsigned long operationCount;
10770
10774 readonly attribute unsigned long operation;
10775
10781 readonly attribute wstring operationDescription;
10782
10786 readonly attribute unsigned long operationPercent;
10787
10791 readonly attribute unsigned long operationWeight;
10792
10800 attribute unsigned long timeout;
10801
10805 void setCurrentOperationProgress (
10806 in unsigned long percent
10807 );
10808
10812 void setNextOperation (
10813 in wstring nextOperationDescription,
10814 in unsigned long nextOperationsWeight
10815 );
10816
10843 void waitForCompletion (
10844 in long timeout
10845 );
10846
10870 void waitForOperationCompletion (
10871 in unsigned long operation,
10872 in long timeout
10873 );
10874
10891 void cancel();
10892
10893 };
10894
10973 interface ISnapshot : $unknown
10974 {
10978 readonly attribute wstringUUID id;
10979
10983 attribute wstring name;
10984
10988 attribute wstring description;
10989
10995 readonly attribute long long timeStamp;
10996
11008 readonly attribute boolean online;
11009
11021 readonly attribute IMachine machine;
11022
11029 readonly attribute ISnapshot parent;
11030
11036 readonly attribute ISnapshot[] children;
11037
11038 };
11039
11062 interface IMediumAttachment : $unknown
11063 {
11068 readonly attribute IMedium medium;
11069
11075 readonly attribute wstring controller;
11076
11082 readonly attribute long port;
11083
11089 readonly attribute long device;
11090
11094 readonly attribute DeviceType type;
11095
11099 readonly attribute boolean passthrough;
11100
11104 readonly attribute IBandwidthGroup bandwidthGroup;
11105
11106 };
11107
11449 interface IMedium : $unknown
11450 {
11464 readonly attribute wstringUUID id;
11465
11484 attribute wstring description;
11485
11501 readonly attribute MediumState state;
11502
11510 readonly attribute MediumVariant variant;
11511
11533 attribute wstring location;
11534
11554 readonly attribute wstring name;
11555
11560 readonly attribute DeviceType deviceType;
11561
11565 readonly attribute boolean hostDrive;
11566
11579 readonly attribute long long size;
11580
11595 readonly attribute wstring format;
11596
11612 readonly attribute IMediumFormat mediumFormat;
11613
11638 attribute MediumType type;
11639
11649 readonly attribute IMedium parent;
11650
11658 readonly attribute IMedium[] children;
11659
11670 readonly attribute IMedium base;
11671
11704 readonly attribute boolean readOnly;
11705
11726 readonly attribute long long logicalSize;
11727
11755 attribute boolean autoReset;
11756
11771 readonly attribute wstring lastAccessError;
11772
11789 readonly attribute wstringUUID[] machineIds;
11790
11816 void setIDs (
11817 in boolean setImageId,
11818 in wstringUUID imageId,
11819 in boolean setParentId,
11820 in wstringUUID parentId
11821 );
11822
11857 void refreshState (
11858 [retval] out MediumState state
11859 );
11860
11887 void getSnapshotIds (
11888 in wstringUUID machineId,
11889 [retval] out wstringUUID[] snapshotIds
11890 );
11891
11951 void lockRead (
11952 [retval] out MediumState state
11953 );
11954
11977 void unlockRead (
11978 [retval] out MediumState state
11979 );
11980
12035 void lockWrite (
12036 [retval] out MediumState state
12037 );
12038
12061 void unlockWrite (
12062 [retval] out MediumState state
12063 );
12064
12114 void close();
12115
12145 void getProperty (
12146 in wstring name,
12147 [retval] out wstring value
12148 );
12149
12181 void setProperty (
12182 in wstring name,
12183 in wstring value
12184 );
12185
12219 void getProperties (
12220 in wstring names,
12221 out wstring[] returnNames,
12222 [retval] out wstring[] returnValues
12223 );
12224
12256 void setProperties (
12257 in wstring[] names,
12258 in wstring[] values
12259 );
12260
12292 void createBaseStorage (
12293 in long long logicalSize,
12294 in MediumVariant variant,
12295 [retval] out IProgress progress
12296 );
12297
12349 void deleteStorage (
12350 [retval] out IProgress progress
12351 );
12352
12390 void createDiffStorage (
12391 in IMedium target,
12392 in MediumVariant variant,
12393 [retval] out IProgress progress
12394 );
12395
12471 void mergeTo (
12472 in IMedium target,
12473 [retval] out IProgress progress
12474 );
12475
12524 void cloneTo (
12525 in IMedium target,
12526 in MediumVariant variant,
12527 in IMedium parent,
12528 [retval] out IProgress progress
12529 );
12530
12559 void compact (
12560 [retval] out IProgress progress
12561 );
12562
12595 void resize (
12596 in long long logicalSize,
12597 [retval] out IProgress progress
12598 );
12599
12633 void reset (
12634 [retval] out IProgress progress
12635 );
12636
12637 };
12638
12661 interface IMediumFormat : $unknown
12662 {
12681 readonly attribute wstring id;
12682
12690 readonly attribute wstring name;
12691
12700 readonly attribute unsigned long capabilities;
12701
12720 void describeFileExtensions (
12721 out wstring[] extensions,
12722 out DeviceType[] type
12723 );
12724
12754 void describeProperties (
12755 out wstring[] names,
12756 out wstring[] description,
12757 out DataType[] types,
12758 out unsigned long[] flags,
12759 out wstring[] defaults
12760 );
12761
12762 };
12763
12776 interface IKeyboard : $unknown
12777 {
12783 readonly attribute IEventSource eventSource;
12784
12797 void putScancode (
12798 in long scancode
12799 );
12800
12813 void putScancodes (
12814 in long[] scancodes,
12815 [retval] out unsigned long codesStored
12816 );
12817
12832 void putCAD();
12833
12834 };
12835
12847 interface IMouse : $unknown
12848 {
12863 readonly attribute boolean absoluteSupported;
12864
12879 readonly attribute boolean relativeSupported;
12880
12895 readonly attribute boolean needsHostCursor;
12896
12902 readonly attribute IEventSource eventSource;
12903
12969 void putMouseEvent (
12970 in long dx,
12971 in long dy,
12972 in long dz,
12973 in long dw,
12974 in long buttonState
12975 );
12976
13049 void putMouseEventAbsolute (
13050 in long x,
13051 in long y,
13052 in long dz,
13053 in long dw,
13054 in long buttonState
13055 );
13056
13057 };
13058
13059 interface IFramebuffer : $unknown
13060 {
13069 readonly attribute octetPtr address;
13070
13074 readonly attribute unsigned long width;
13075
13079 readonly attribute unsigned long height;
13080
13087 readonly attribute unsigned long bitsPerPixel;
13088
13095 readonly attribute unsigned long bytesPerLine;
13096
13107 readonly attribute unsigned long pixelFormat;
13108
13115 readonly attribute boolean usesGuestVRAM;
13116
13126 readonly attribute unsigned long heightReduction;
13127
13142 readonly attribute IFramebufferOverlay overlay;
13143
13150 readonly attribute long long winId;
13151
13159 void lock();
13160
13168 void unlock();
13169
13177 void notifyUpdate (
13178 in unsigned long x,
13179 in unsigned long y,
13180 in unsigned long width,
13181 in unsigned long height
13182 );
13183
13296 void requestResize (
13297 in unsigned long screenId,
13298 in unsigned long pixelFormat,
13299 in octetPtr VRAM,
13300 in unsigned long bitsPerPixel,
13301 in unsigned long bytesPerLine,
13302 in unsigned long width,
13303 in unsigned long height,
13304 [retval] out boolean finished
13305 );
13306
13318 void videoModeSupported (
13319 in unsigned long width,
13320 in unsigned long height,
13321 in unsigned long bpp,
13322 [retval] out boolean supported
13323 );
13324
13361 void getVisibleRegion (
13362 in octetPtr rectangles,
13363 in unsigned long count,
13364 [retval] out unsigned long countCopied
13365 );
13366
13401 void setVisibleRegion (
13402 in octetPtr rectangles,
13403 in unsigned long count
13404 );
13405
13426 void processVHWACommand (
13427 in octetPtr command
13428 );
13429
13430 };
13431
13446 interface IFramebufferOverlay : IFramebuffer
13447 {
13451 readonly attribute unsigned long x;
13452
13456 readonly attribute unsigned long y;
13457
13463 attribute boolean visible;
13464
13471 attribute unsigned long alpha;
13472
13478 void move (
13479 in unsigned long x,
13480 in unsigned long y
13481 );
13482
13483 };
13484
13500 interface IDisplay : $unknown
13501 {
13505 void getScreenResolution (
13506 in unsigned long screenId,
13507 out unsigned long width,
13508 out unsigned long height,
13509 out unsigned long bitsPerPixel
13510 );
13511
13517 void setFramebuffer (
13518 in unsigned long screenId,
13519 in IFramebuffer framebuffer
13520 );
13521
13527 void getFramebuffer (
13528 in unsigned long screenId,
13529 out IFramebuffer framebuffer,
13530 out long xOrigin,
13531 out long yOrigin
13532 );
13533
13562 void setVideoModeHint (
13563 in unsigned long width,
13564 in unsigned long height,
13565 in unsigned long bitsPerPixel,
13566 in unsigned long display
13567 );
13568
13579 void setSeamlessMode (
13580 in boolean enabled
13581 );
13582
13616 void takeScreenShot (
13617 in unsigned long screenId,
13618 in octetPtr address,
13619 in unsigned long width,
13620 in unsigned long height
13621 );
13622
13666 void takeScreenShotToArray (
13667 in unsigned long screenId,
13668 in unsigned long width,
13669 in unsigned long height,
13670 [retval] out octet[] screenData
13671 );
13672
13711 void takeScreenShotPNGToArray (
13712 in unsigned long screenId,
13713 in unsigned long width,
13714 in unsigned long height,
13715 [retval] out octet[] screenData
13716 );
13717
13769 void drawToScreen (
13770 in unsigned long screenId,
13771 in octetPtr address,
13772 in unsigned long x,
13773 in unsigned long y,
13774 in unsigned long width,
13775 in unsigned long height
13776 );
13777
13792 void invalidateAndUpdate();
13793
13807 void resizeCompleted (
13808 in unsigned long screenId
13809 );
13810
13823 void completeVHWACommand (
13824 in octetPtr command
13825 );
13826
13827 };
13828
13844 interface INetworkAdapter : $unknown
13845 {
13853 attribute NetworkAdapterType adapterType;
13854
13862 readonly attribute unsigned long slot;
13863
13872 attribute boolean enabled;
13873
13880 attribute wstring MACAddress;
13881
13882 readonly attribute NetworkAttachmentType attachmentType;
13883
13889 attribute wstring hostInterface;
13890
13896 attribute wstring internalNetwork;
13897
13903 attribute wstring NATNetwork;
13904
13910 attribute wstring VDENetwork;
13911
13918 attribute boolean cableConnected;
13919
13925 attribute unsigned long lineSpeed;
13926
13933 attribute boolean traceEnabled;
13934
13941 attribute wstring traceFile;
13942
13950 readonly attribute INATEngine natDriver;
13951
13958 attribute unsigned long bootPriority;
13959
13966 attribute unsigned long bandwidthLimit;
13967
13973 void attachToNAT();
13974
13980 void attachToBridgedInterface();
13981
13987 void attachToInternalNetwork();
13988
13994 void attachToHostOnlyInterface();
13995
14001 void attachToVDE();
14002
14008 void detach();
14009
14010 };
14011
14040 interface ISerialPort : $unknown
14041 {
14049 readonly attribute unsigned long slot;
14050
14057 attribute boolean enabled;
14058
14062 attribute unsigned long IOBase;
14063
14067 attribute unsigned long IRQ;
14068
14079 attribute PortMode hostMode;
14080
14088 attribute boolean server;
14089
14099 attribute wstring path;
14100
14101 };
14102
14122 interface IParallelPort : $unknown
14123 {
14131 readonly attribute unsigned long slot;
14132
14139 attribute boolean enabled;
14140
14144 attribute unsigned long IOBase;
14145
14149 attribute unsigned long IRQ;
14150
14158 attribute wstring path;
14159
14160 };
14161
14162 interface IMachineDebugger : $unknown
14163 {
14167 attribute boolean singlestep;
14168
14172 attribute boolean recompileUser;
14173
14177 attribute boolean recompileSupervisor;
14178
14182 attribute boolean PATMEnabled;
14183
14187 attribute boolean CSAMEnabled;
14188
14192 attribute boolean logEnabled;
14193
14200 readonly attribute boolean HWVirtExEnabled;
14201
14208 readonly attribute boolean HWVirtExNestedPagingEnabled;
14209
14216 readonly attribute boolean HWVirtExVPIDEnabled;
14217
14224 readonly attribute boolean PAEEnabled;
14225
14232 attribute unsigned long virtualTimeRate;
14233
14240 readonly attribute long long VM;
14241
14249 void resetStats (
14250 in wstring pattern
14251 );
14252
14260 void dumpStats (
14261 in wstring pattern
14262 );
14263
14275 void getStats (
14276 in wstring pattern,
14277 in boolean withDescriptions,
14278 out wstring stats
14279 );
14280
14286 void injectNMI();
14287
14288 };
14289
14290 interface IUSBController : $unknown
14291 {
14300 attribute boolean enabled;
14301
14310 attribute boolean enabledEhci;
14311
14317 readonly attribute boolean proxyAvailable;
14318
14326 readonly attribute unsigned short USBStandard;
14327
14353 readonly attribute IUSBDeviceFilter[] deviceFilters;
14354
14382 void createDeviceFilter (
14383 in wstring name,
14384 [retval] out IUSBDeviceFilter filter
14385 );
14386
14431 void insertDeviceFilter (
14432 in unsigned long position,
14433 in IUSBDeviceFilter filter
14434 );
14435
14468 void removeDeviceFilter (
14469 in unsigned long position,
14470 [retval] out IUSBDeviceFilter filter
14471 );
14472
14473 };
14474
14487 interface IUSBDevice : $unknown
14488 {
14495 readonly attribute wstringUUID id;
14496
14500 readonly attribute unsigned short vendorId;
14501
14505 readonly attribute unsigned short productId;
14506
14514 readonly attribute unsigned short revision;
14515
14519 readonly attribute wstring manufacturer;
14520
14524 readonly attribute wstring product;
14525
14529 readonly attribute wstring serialNumber;
14530
14534 readonly attribute wstring address;
14535
14542 readonly attribute unsigned short port;
14543
14549 readonly attribute unsigned short version;
14550
14558 readonly attribute unsigned short portVersion;
14559
14566 readonly attribute boolean remote;
14567
14568 };
14569
14643 interface IUSBDeviceFilter : $unknown
14644 {
14652 attribute wstring name;
14653
14657 attribute boolean active;
14658
14666 attribute wstring vendorId;
14667
14675 attribute wstring productId;
14676
14690 attribute wstring revision;
14691
14696 attribute wstring manufacturer;
14697
14702 attribute wstring product;
14703
14708 attribute wstring serialNumber;
14709
14714 attribute wstring port;
14715
14725 attribute wstring remote;
14726
14736 attribute unsigned long maskedInterfaces;
14737
14738 };
14739
14755 interface IHostUSBDevice : IUSBDevice
14756 {
14762 readonly attribute USBDeviceState state;
14763
14764 };
14765
14788 interface IHostUSBDeviceFilter : IUSBDeviceFilter
14789 {
14796 attribute USBDeviceFilterAction action;
14797
14798 };
14799
14808 interface IAudioAdapter : $unknown
14809 {
14818 attribute boolean enabled;
14819
14825 attribute AudioControllerType audioController;
14826
14833 attribute AudioDriverType audioDriver;
14834
14835 };
14836
14837 interface IVRDEServer : $unknown
14838 {
14842 attribute boolean enabled;
14843
14847 attribute AuthType authType;
14848
14852 attribute unsigned long authTimeout;
14853
14860 attribute boolean allowMultiConnection;
14861
14869 attribute boolean reuseSingleConnection;
14870
14876 attribute boolean videoChannel;
14877
14883 attribute unsigned long videoChannelQuality;
14884
14891 attribute wstring VRDEExtPack;
14892
14899 attribute wstring AuthLibrary;
14900
14914 void setVRDEProperty (
14915 in wstring key,
14916 in wstring value
14917 );
14918
14932 void getVRDEProperty (
14933 in wstring key,
14934 [retval] out wstring value
14935 );
14936
14937 };
14938
14996 interface ISharedFolder : $unknown
14997 {
15001 readonly attribute wstring name;
15002
15006 readonly attribute wstring hostPath;
15007
15017 readonly attribute boolean accessible;
15018
15025 readonly attribute boolean writable;
15026
15032 readonly attribute boolean autoMount;
15033
15046 readonly attribute wstring lastAccessError;
15047
15048 };
15049
15050 interface IInternalSessionControl : $unknown
15051 {
15056 void getPID (
15057 [retval] out unsigned long pid
15058 );
15059
15081 void getRemoteConsole (
15082 [retval] out IConsole console
15083 );
15084
15108 void assignMachine (
15109 in IMachine machine
15110 );
15111
15126 void assignRemoteMachine (
15127 in IMachine machine,
15128 in IConsole console
15129 );
15130
15154 void updateMachineState (
15155 in MachineState aMachineState
15156 );
15157
15173 void uninitialize();
15174
15197 void onNetworkAdapterChange (
15198 in INetworkAdapter networkAdapter,
15199 in boolean changeAdapter
15200 );
15201
15224 void onSerialPortChange (
15225 in ISerialPort serialPort
15226 );
15227
15250 void onParallelPortChange (
15251 in IParallelPort parallelPort
15252 );
15253
15276 void onStorageControllerChange();
15277
15300 void onMediumChange (
15301 in IMediumAttachment mediumAttachment,
15302 in boolean force
15303 );
15304
15314 void onCPUChange (
15315 in unsigned long cpu,
15316 in boolean add
15317 );
15318
15326 void onCPUExecutionCapChange (
15327 in unsigned long executionCap
15328 );
15329
15354 void onVRDEServerChange (
15355 in boolean restart
15356 );
15357
15380 void onUSBControllerChange();
15381
15410 void onSharedFolderChange (
15411 in boolean global
15412 );
15413
15439 void onUSBDeviceAttach (
15440 in IUSBDevice device,
15441 in IVirtualBoxErrorInfo error,
15442 in unsigned long maskedInterfaces
15443 );
15444
15470 void onUSBDeviceDetach (
15471 in wstringUUID id,
15472 in IVirtualBoxErrorInfo error
15473 );
15474
15492 void onShowWindow (
15493 in boolean check,
15494 out boolean canShow,
15495 out long long winId
15496 );
15497
15505 void onBandwidthGroupChange (
15506 in IBandwidthGroup bandwidthGroup
15507 );
15508
15532 void accessGuestProperty (
15533 in wstring name,
15534 in wstring value,
15535 in wstring flags,
15536 in boolean isSetter,
15537 out wstring retValue,
15538 out long long retTimestamp,
15539 out wstring retFlags
15540 );
15541
15589 void enumerateGuestProperties (
15590 in wstring patterns,
15591 out wstring[] key,
15592 out wstring[] value,
15593 out long long[] timestamp,
15594 out wstring[] flags
15595 );
15596
15642 void onlineMergeMedium (
15643 in IMediumAttachment mediumAttachment,
15644 in unsigned long sourceIdx,
15645 in unsigned long targetIdx,
15646 in IMedium source,
15647 in IMedium target,
15648 in boolean mergeForward,
15649 in IMedium parentForTarget,
15650 in IMedium[] childrenToReparent,
15651 in IProgress progress
15652 );
15653
15654 };
15655
15714 interface ISession : $unknown
15715 {
15719 readonly attribute SessionState state;
15720
15728 readonly attribute SessionType type;
15729
15733 readonly attribute IMachine machine;
15734
15738 readonly attribute IConsole console;
15739
15771 void unlockMachine();
15772
15773 };
15774
15797 interface IStorageController : $unknown
15798 {
15807 readonly attribute wstring name;
15808
15814 readonly attribute unsigned long maxDevicesPerPortCount;
15815
15821 readonly attribute unsigned long minPortCount;
15822
15828 readonly attribute unsigned long maxPortCount;
15829
15835 attribute unsigned long instance;
15836
15845 attribute unsigned long portCount;
15846
15852 readonly attribute StorageBus bus;
15853
15866 attribute StorageControllerType controllerType;
15867
15882 attribute boolean useHostIOCache;
15883
15889 readonly attribute boolean bootable;
15890
15913 void getIDEEmulationPort (
15914 in long devicePosition,
15915 [retval] out long portNumber
15916 );
15917
15941 void setIDEEmulationPort (
15942 in long devicePosition,
15943 in long portNumber
15944 );
15945
15946 };
15947
15971 interface IManagedObjectRef : $unknown
15972 {
15979 void getInterfaceName (
15980 [retval] out wstring return
15981 );
15982
15990 void release();
15991
15992 };
15993
16002 interface IWebsessionManager : $unknown
16003 {
16012 void logon (
16013 in wstring username,
16014 in wstring password,
16015 [retval] out IVirtualBox return
16016 );
16017
16027 void getSessionObject (
16028 in IVirtualBox refIVirtualBox,
16029 [retval] out ISession return
16030 );
16031
16039 void logoff (
16040 in IVirtualBox refIVirtualBox
16041 );
16042
16043 };
16044
16053 interface IPerformanceMetric : $unknown
16054 {
16060 readonly attribute wstring metricName;
16061
16067 readonly attribute $unknown object;
16068
16074 readonly attribute wstring description;
16075
16081 readonly attribute unsigned long period;
16082
16092 readonly attribute unsigned long count;
16093
16099 readonly attribute wstring unit;
16100
16106 readonly attribute long minimumValue;
16107
16113 readonly attribute long maximumValue;
16114
16115 };
16116
16222 interface IPerformanceCollector : $unknown
16223 {
16234 readonly attribute wstring[] metricNames;
16235
16259 void getMetrics (
16260 in wstring[] metricNames,
16261 in $unknown[] objects,
16262 [retval] out IPerformanceMetric[] metrics
16263 );
16264
16303 void setupMetrics (
16304 in wstring[] metricNames,
16305 in $unknown[] objects,
16306 in unsigned long period,
16307 in unsigned long count,
16308 [retval] out IPerformanceMetric[] affectedMetrics
16309 );
16310
16339 void enableMetrics (
16340 in wstring[] metricNames,
16341 in $unknown[] objects,
16342 [retval] out IPerformanceMetric[] affectedMetrics
16343 );
16344
16373 void disableMetrics (
16374 in wstring[] metricNames,
16375 in $unknown[] objects,
16376 [retval] out IPerformanceMetric[] affectedMetrics
16377 );
16378
16467 void queryMetricsData (
16468 in wstring[] metricNames,
16469 in $unknown[] objects,
16470 out wstring[] returnMetricNames,
16471 out $unknown[] returnObjects,
16472 out wstring[] returnUnits,
16473 out unsigned long[] returnScales,
16474 out unsigned long[] returnSequenceNumbers,
16475 out unsigned long[] returnDataIndices,
16476 out unsigned long[] returnDataLengths,
16477 [retval] out long[] returnData
16478 );
16479
16480 };
16481
16489 interface INATEngine : $unknown
16490 {
16495 attribute wstring network;
16496
16503 attribute wstring hostIP;
16504
16509 attribute wstring tftpPrefix;
16510
16515 attribute wstring tftpBootFile;
16516
16524 attribute wstring tftpNextServer;
16525
16529 attribute unsigned long aliasMode;
16530
16534 attribute boolean dnsPassDomain;
16535
16540 attribute boolean dnsProxy;
16541
16546 attribute boolean dnsUseHostResolver;
16547
16552 readonly attribute wstring[] redirects;
16553
16569 void setNetworkSettings (
16570 in unsigned long mtu,
16571 in unsigned long sockSnd,
16572 in unsigned long sockRcv,
16573 in unsigned long TcpWndSnd,
16574 in unsigned long TcpWndRcv
16575 );
16576
16581 void getNetworkSettings (
16582 out unsigned long mtu,
16583 out unsigned long sockSnd,
16584 out unsigned long sockRcv,
16585 out unsigned long TcpWndSnd,
16586 out unsigned long TcpWndRcv
16587 );
16588
16608 void addRedirect (
16609 in wstring name,
16610 in NATProtocol proto,
16611 in wstring hostIp,
16612 in unsigned short hostPort,
16613 in wstring guestIp,
16614 in unsigned short guestPort
16615 );
16616
16622 void removeRedirect (
16623 in wstring name
16624 );
16625
16626 };
16627
16636 interface IExtPackPlugIn : $unknown
16637 {
16641 readonly attribute wstring name;
16642
16646 readonly attribute wstring description;
16647
16653 readonly attribute wstring frontend;
16654
16658 readonly attribute wstring modulePath;
16659
16660 };
16661
16670 interface IExtPackBase : $unknown
16671 {
16675 readonly attribute wstring name;
16676
16680 readonly attribute wstring description;
16681
16690 readonly attribute wstring version;
16691
16695 readonly attribute unsigned long revision;
16696
16700 readonly attribute wstring VRDEModule;
16701
16705 readonly attribute IExtPackPlugIn[] plugIns;
16706
16716 readonly attribute boolean usable;
16717
16724 readonly attribute wstring whyUnusable;
16725
16726 };
16727
16736 interface IExtPack : IExtPackBase
16737 {
16749 void queryObject (
16750 in wstring objUuid,
16751 out $unknown returnInterface
16752 );
16753
16754 };
16755
16766 interface IExtPackFile : IExtPackBase
16767 {
16773 readonly attribute wstring filePath;
16774
16780 void install();
16781
16782 };
16783
16794 interface IExtPackManager : $unknown
16795 {
16801 readonly attribute IExtPack[] installedExtPacks;
16802
16820 void find (
16821 in wstring name,
16822 [retval] out IExtPack returnData
16823 );
16824
16835 void openExtPackFile (
16836 in wstring path,
16837 [retval] out IExtPackFile file
16838 );
16839
16850 void install (
16851 in wstring path,
16852 [retval] out wstring name
16853 );
16854
16865 void uninstall (
16866 in wstring name,
16867 in boolean forcedRemoval
16868 );
16869
16873 void cleanup();
16874
16887 void QueryAllPlugInsForFrontend (
16888 in wstring frontendName,
16889 [retval] out wstring[] plugInModules
16890 );
16891
16892 };
16893
16899 interface IBandwidthGroup : $unknown
16900 {
16904 readonly attribute wstring name;
16905
16909 readonly attribute BandwidthGroupType type;
16910
16914 readonly attribute unsigned long reference;
16915
16920 attribute unsigned long maxMbPerSec;
16921
16922 };
16923
16932 interface IBandwidthControl : $unknown
16933 {
16939 readonly attribute unsigned long numGroups;
16940
16953 void CreateBandwidthGroup (
16954 in wstring name,
16955 in BandwidthGroupType type,
16956 in unsigned long maxBytesPerSec
16957 );
16958
16966 void DeleteBandwidthGroup (
16967 in wstring name
16968 );
16969
16979 void GetBandwidthGroup (
16980 in wstring name,
16981 [retval] out IBandwidthGroup bandwidthGroup
16982 );
16983
16991 void GetAllBandwidthGroups (
16992 [retval] out IBandwidthGroup[] bandwidthGroups
16993 );
16994
16995 };
16996
17009 interface IVirtualBoxClient : $unknown
17010 {
17016 readonly attribute IVirtualBox virtualBox;
17017
17023 readonly attribute ISession session;
17024
17030 readonly attribute IEventSource eventSource;
17031
17032 };
17033
17047 interface IEventSource : $unknown
17048 {
17054 void createListener (
17055 [retval] out IEventListener listener
17056 );
17057
17069 void createAggregator (
17070 in IEventSource[] subordinates,
17071 [retval] out IEventSource result
17072 );
17073
17106 void registerListener (
17107 in IEventListener listener,
17108 in VBoxEventType[] interesting,
17109 in boolean active
17110 );
17111
17120 void unregisterListener (
17121 in IEventListener listener
17122 );
17123
17138 void fireEvent (
17139 in IEvent event,
17140 in long timeout,
17141 [retval] out boolean result
17142 );
17143
17168 void getEvent (
17169 in IEventListener listener,
17170 in long timeout,
17171 [retval] out IEvent event
17172 );
17173
17185 void eventProcessed (
17186 in IEventListener listener,
17187 in IEvent event
17188 );
17189
17190 };
17191
17201 interface IEventListener : $unknown
17202 {
17211 void handleEvent (
17212 in IEvent event
17213 );
17214
17215 };
17216
17293 interface IEvent : $unknown
17294 {
17300 readonly attribute VBoxEventType type;
17301
17307 readonly attribute IEventSource source;
17308
17319 readonly attribute boolean waitable;
17320
17327 void setProcessed();
17328
17342 void waitProcessed (
17343 in long timeout,
17344 [retval] out boolean result
17345 );
17346
17347 };
17348
17354 interface IReusableEvent : IEvent
17355 {
17359 readonly attribute unsigned long generation;
17360
17367 void reuse();
17368
17369 };
17370
17376 interface IMachineEvent : IEvent
17377 {
17381 readonly attribute wstringUUID machineId;
17382
17383 };
17384
17390 interface IMachineStateChangedEvent : IMachineEvent
17391 {
17395 readonly attribute MachineState state;
17396
17397 };
17398
17406 interface IMachineDataChangedEvent : IMachineEvent
17407 {
17408 };
17409
17418 interface IMediumRegisteredEvent : IEvent
17419 {
17423 readonly attribute wstringUUID mediumId;
17424
17428 readonly attribute DeviceType mediumType;
17429
17436 readonly attribute boolean registered;
17437
17438 };
17439
17448 interface IMachineRegisteredEvent : IMachineEvent
17449 {
17456 readonly attribute boolean registered;
17457
17458 };
17459
17469 interface ISessionStateChangedEvent : IMachineEvent
17470 {
17476 readonly attribute SessionState state;
17477
17478 };
17479
17487 interface IGuestPropertyChangedEvent : IMachineEvent
17488 {
17494 readonly attribute wstring name;
17495
17501 readonly attribute wstring value;
17502
17508 readonly attribute wstring flags;
17509
17510 };
17511
17517 interface ISnapshotEvent : IMachineEvent
17518 {
17522 readonly attribute wstringUUID snapshotId;
17523
17524 };
17525
17535 interface ISnapshotTakenEvent : ISnapshotEvent
17536 {
17537 };
17538
17555 interface ISnapshotDeletedEvent : ISnapshotEvent
17556 {
17557 };
17558
17568 interface ISnapshotChangedEvent : ISnapshotEvent
17569 {
17570 };
17571
17580 interface IMousePointerShapeChangedEvent : IEvent
17581 {
17587 readonly attribute boolean visible;
17588
17594 readonly attribute boolean alpha;
17595
17601 readonly attribute unsigned long xhot;
17602
17608 readonly attribute unsigned long yhot;
17609
17615 readonly attribute unsigned long width;
17616
17622 readonly attribute unsigned long height;
17623
17656 readonly attribute octet[] shape;
17657
17658 };
17659
17668 interface IMouseCapabilityChangedEvent : IEvent
17669 {
17675 readonly attribute boolean supportsAbsolute;
17676
17682 readonly attribute boolean supportsRelative;
17683
17689 readonly attribute boolean needsHostCursor;
17690
17691 };
17692
17701 interface IKeyboardLedsChangedEvent : IEvent
17702 {
17708 readonly attribute boolean numLock;
17709
17715 readonly attribute boolean capsLock;
17716
17722 readonly attribute boolean scrollLock;
17723
17724 };
17725
17734 interface IStateChangedEvent : IEvent
17735 {
17741 readonly attribute MachineState state;
17742
17743 };
17744
17754 interface IAdditionsStateChangedEvent : IEvent
17755 {
17756 };
17757
17768 interface INetworkAdapterChangedEvent : IEvent
17769 {
17775 readonly attribute INetworkAdapter networkAdapter;
17776
17777 };
17778
17789 interface ISerialPortChangedEvent : IEvent
17790 {
17796 readonly attribute ISerialPort serialPort;
17797
17798 };
17799
17810 interface IParallelPortChangedEvent : IEvent
17811 {
17817 readonly attribute IParallelPort parallelPort;
17818
17819 };
17820
17830 interface IStorageControllerChangedEvent : IEvent
17831 {
17832 };
17833
17843 interface IMediumChangedEvent : IEvent
17844 {
17850 readonly attribute IMediumAttachment mediumAttachment;
17851
17852 };
17853
17861 interface ICPUChangedEvent : IEvent
17862 {
17868 readonly attribute unsigned long cpu;
17869
17875 readonly attribute boolean add;
17876
17877 };
17878
17886 interface ICPUExecutionCapChangedEvent : IEvent
17887 {
17893 readonly attribute unsigned long executionCap;
17894
17895 };
17896
17904 interface IGuestKeyboardEvent : IEvent
17905 {
17911 readonly attribute long[] scancodes;
17912
17913 };
17914
17922 interface IGuestMouseEvent : IReusableEvent
17923 {
17929 readonly attribute boolean absolute;
17930
17936 readonly attribute long x;
17937
17943 readonly attribute long y;
17944
17950 readonly attribute long z;
17951
17957 readonly attribute long w;
17958
17964 readonly attribute long buttons;
17965
17966 };
17967
17978 interface IVRDEServerChangedEvent : IEvent
17979 {
17980 };
17981
17991 interface IVRDEServerInfoChangedEvent : IEvent
17992 {
17993 };
17994
18005 interface IUSBControllerChangedEvent : IEvent
18006 {
18007 };
18008
18032 interface IUSBDeviceStateChangedEvent : IEvent
18033 {
18039 readonly attribute IUSBDevice device;
18040
18046 readonly attribute boolean attached;
18047
18053 readonly attribute IVirtualBoxErrorInfo error;
18054
18055 };
18056
18072 interface ISharedFolderChangedEvent : IEvent
18073 {
18079 readonly attribute Scope scope;
18080
18081 };
18082
18134 interface IRuntimeErrorEvent : IEvent
18135 {
18141 readonly attribute boolean fatal;
18142
18148 readonly attribute wstring id;
18149
18155 readonly attribute wstring message;
18156
18157 };
18158
18166 interface IEventSourceChangedEvent : IEvent
18167 {
18173 readonly attribute IEventListener listener;
18174
18180 readonly attribute boolean add;
18181
18182 };
18183
18192 interface IExtraDataChangedEvent : IEvent
18193 {
18200 readonly attribute wstringUUID machineId;
18201
18207 readonly attribute wstring key;
18208
18214 readonly attribute wstring value;
18215
18216 };
18217
18223 interface IVetoEvent : IEvent
18224 {
18234 void addVeto (
18235 in wstring reason
18236 );
18237
18247 void isVetoed (
18248 [retval] out boolean result
18249 );
18250
18260 void getVetos (
18261 [retval] out wstring[] result
18262 );
18263
18264 };
18265
18275 interface IExtraDataCanChangeEvent : IVetoEvent
18276 {
18283 readonly attribute wstringUUID machineId;
18284
18290 readonly attribute wstring key;
18291
18297 readonly attribute wstring value;
18298
18299 };
18300
18316 interface ICanShowWindowEvent : IVetoEvent
18317 {
18318 };
18319
18351 interface IShowWindowEvent : IEvent
18352 {
18361 attribute long long winId;
18362
18363 };
18364
18372 interface INATRedirectEvent : IMachineEvent
18373 {
18379 readonly attribute unsigned long slot;
18380
18386 readonly attribute boolean remove;
18387
18393 readonly attribute wstring name;
18394
18400 readonly attribute NATProtocol proto;
18401
18407 readonly attribute wstring hostIp;
18408
18414 readonly attribute long hostPort;
18415
18421 readonly attribute wstring guestIp;
18422
18428 readonly attribute long guestPort;
18429
18430 };
18431
18439 interface IHostPciDevicePlugEvent : IMachineEvent
18440 {
18446 readonly attribute boolean plugged;
18447
18454 readonly attribute boolean success;
18455
18461 readonly attribute IPciDeviceAttachment attachment;
18462
18469 readonly attribute IEventContext eventContext;
18470
18476 readonly attribute wstring message;
18477
18478 };
18479
18488 interface IVBoxSVCUnavailableEvent : IEvent
18489 {
18490 };
18491
18499 interface IBandwidthGroupChangedEvent : IEvent
18500 {
18506 readonly attribute IBandwidthGroup bandwidthGroup;
18507
18508 };
18509
18510