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_v1_12 = 14,
00309 SettingsVersion_Future = 99999,
00310 };
00311
00319 enum AccessMode
00320 {
00321 AccessMode_ReadOnly = 1,
00322 AccessMode_ReadWrite = 2,
00323 };
00324
00442 enum MachineState
00443 {
00448 MachineState_Null = 0,
00456 MachineState_PoweredOff = 1,
00465 MachineState_Saved = 2,
00474 MachineState_Teleported = 3,
00483 MachineState_Aborted = 4,
00490 MachineState_Running = 5,
00497 MachineState_Paused = 6,
00505 MachineState_Stuck = 7,
00515 MachineState_Teleporting = 8,
00526 MachineState_LiveSnapshotting = 9,
00534 MachineState_Starting = 10,
00542 MachineState_Stopping = 11,
00550 MachineState_Saving = 12,
00558 MachineState_Restoring = 13,
00567 MachineState_TeleportingPausedVM = 14,
00574 MachineState_TeleportingIn = 15,
00581 MachineState_FaultTolerantSyncing = 16,
00589 MachineState_DeletingSnapshotOnline = 17,
00597 MachineState_DeletingSnapshotPaused = 18,
00604 MachineState_RestoringSnapshot = 19,
00613 MachineState_DeletingSnapshot = 20,
00620 MachineState_SettingUp = 21,
00627 MachineState_FirstOnline = 5,
00634 MachineState_LastOnline = 18,
00641 MachineState_FirstTransient = 8,
00648 MachineState_LastTransient = 21,
00649 };
00650
00660 enum SessionState
00661 {
00666 SessionState_Null = 0,
00677 SessionState_Unlocked = 1,
00691 SessionState_Locked = 2,
00701 SessionState_Spawning = 3,
00708 SessionState_Unlocking = 4,
00709 };
00710
00719 enum CPUPropertyType
00720 {
00725 CPUPropertyType_Null = 0,
00734 CPUPropertyType_PAE = 1,
00742 CPUPropertyType_Synthetic = 2,
00743 };
00744
00754 enum HWVirtExPropertyType
00755 {
00760 HWVirtExPropertyType_Null = 0,
00768 HWVirtExPropertyType_Enabled = 1,
00777 HWVirtExPropertyType_Exclusive = 2,
00784 HWVirtExPropertyType_VPID = 3,
00791 HWVirtExPropertyType_NestedPaging = 4,
00798 HWVirtExPropertyType_LargePages = 5,
00806 HWVirtExPropertyType_Force = 6,
00807 };
00808
00816 enum FaultToleranceState
00817 {
00822 FaultToleranceState_Inactive = 1,
00827 FaultToleranceState_Master = 2,
00832 FaultToleranceState_Standby = 3,
00833 };
00834
00842 enum LockType
00843 {
00848 LockType_Write = 2,
00853 LockType_Shared = 1,
00854 };
00855
00864 enum SessionType
00865 {
00870 SessionType_Null = 0,
00878 SessionType_WriteLock = 1,
00885 SessionType_Remote = 2,
00892 SessionType_Shared = 3,
00893 };
00894
00902 enum DeviceType
00903 {
00911 DeviceType_Null = 0,
00916 DeviceType_Floppy = 1,
00921 DeviceType_DVD = 2,
00926 DeviceType_HardDisk = 3,
00931 DeviceType_Network = 4,
00936 DeviceType_USB = 5,
00941 DeviceType_SharedFolder = 6,
00942 };
00943
00951 enum DeviceActivity
00952 {
00953 DeviceActivity_Null = 0,
00954 DeviceActivity_Idle = 1,
00955 DeviceActivity_Reading = 2,
00956 DeviceActivity_Writing = 3,
00957 };
00958
00966 enum ClipboardMode
00967 {
00968 ClipboardMode_Disabled = 0,
00969 ClipboardMode_HostToGuest = 1,
00970 ClipboardMode_GuestToHost = 2,
00971 ClipboardMode_Bidirectional = 3,
00972 };
00973
00984 enum Scope
00985 {
00986 Scope_Global = 0,
00987 Scope_Machine = 1,
00988 Scope_Session = 2,
00989 };
00990
00998 enum BIOSBootMenuMode
00999 {
01000 BIOSBootMenuMode_Disabled = 0,
01001 BIOSBootMenuMode_MenuOnly = 1,
01002 BIOSBootMenuMode_MessageAndMenu = 2,
01003 };
01004
01012 enum ProcessorFeature
01013 {
01014 ProcessorFeature_HWVirtEx = 0,
01015 ProcessorFeature_PAE = 1,
01016 ProcessorFeature_LongMode = 2,
01017 ProcessorFeature_NestedPaging = 3,
01018 };
01019
01027 enum FirmwareType
01028 {
01033 FirmwareType_BIOS = 1,
01038 FirmwareType_EFI = 2,
01043 FirmwareType_EFI32 = 3,
01048 FirmwareType_EFI64 = 4,
01053 FirmwareType_EFIDUAL = 5,
01054 };
01055
01063 enum PointingHidType
01064 {
01069 PointingHidType_None = 1,
01074 PointingHidType_PS2Mouse = 2,
01079 PointingHidType_USBMouse = 3,
01084 PointingHidType_USBTablet = 4,
01090 PointingHidType_ComboMouse = 5,
01091 };
01092
01100 enum KeyboardHidType
01101 {
01106 KeyboardHidType_None = 1,
01111 KeyboardHidType_PS2Keyboard = 2,
01116 KeyboardHidType_USBKeyboard = 3,
01122 KeyboardHidType_ComboKeyboard = 4,
01123 };
01124
01132 enum VFSType
01133 {
01134 VFSType_File = 1,
01135 VFSType_Cloud = 2,
01136 VFSType_S3 = 3,
01137 VFSType_WebDav = 4,
01138 };
01139
01147 enum VFSFileType
01148 {
01149 VFSFileType_Unknown = 1,
01150 VFSFileType_Fifo = 2,
01151 VFSFileType_DevChar = 3,
01152 VFSFileType_Directory = 4,
01153 VFSFileType_DevBlock = 5,
01154 VFSFileType_File = 6,
01155 VFSFileType_SymLink = 7,
01156 VFSFileType_Socket = 8,
01157 VFSFileType_WhiteOut = 9,
01158 };
01159
01166 enum VirtualSystemDescriptionType
01167 {
01168 VirtualSystemDescriptionType_Ignore = 1,
01169 VirtualSystemDescriptionType_OS = 2,
01170 VirtualSystemDescriptionType_Name = 3,
01171 VirtualSystemDescriptionType_Product = 4,
01172 VirtualSystemDescriptionType_Vendor = 5,
01173 VirtualSystemDescriptionType_Version = 6,
01174 VirtualSystemDescriptionType_ProductUrl = 7,
01175 VirtualSystemDescriptionType_VendorUrl = 8,
01176 VirtualSystemDescriptionType_Description = 9,
01177 VirtualSystemDescriptionType_License = 10,
01178 VirtualSystemDescriptionType_Miscellaneous = 11,
01179 VirtualSystemDescriptionType_CPU = 12,
01180 VirtualSystemDescriptionType_Memory = 13,
01181 VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
01182 VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
01183 VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
01184 VirtualSystemDescriptionType_HardDiskControllerSAS = 17,
01185 VirtualSystemDescriptionType_HardDiskImage = 18,
01186 VirtualSystemDescriptionType_Floppy = 19,
01187 VirtualSystemDescriptionType_CDROM = 20,
01188 VirtualSystemDescriptionType_NetworkAdapter = 21,
01189 VirtualSystemDescriptionType_USBController = 22,
01190 VirtualSystemDescriptionType_SoundCard = 23,
01191 };
01192
01199 enum VirtualSystemDescriptionValueType
01200 {
01201 VirtualSystemDescriptionValueType_Reference = 1,
01202 VirtualSystemDescriptionValueType_Original = 2,
01203 VirtualSystemDescriptionValueType_Auto = 3,
01204 VirtualSystemDescriptionValueType_ExtraConfig = 4,
01205 };
01206
01213 enum CleanupMode
01214 {
01219 CleanupMode_UnregisterOnly = 1,
01224 CleanupMode_DetachAllReturnNone = 2,
01229 CleanupMode_DetachAllReturnHardDisksOnly = 3,
01234 CleanupMode_Full = 4,
01235 };
01236
01244 enum CloneMode
01245 {
01250 CloneMode_MachineState = 1,
01255 CloneMode_MachineAndChildStates = 2,
01260 CloneMode_AllStates = 3,
01261 };
01262
01270 enum CloneOptions
01271 {
01276 CloneOptions_Link = 1,
01281 CloneOptions_KeepAllMACs = 2,
01286 CloneOptions_KeepNATMACs = 3,
01287 };
01288
01299 enum HostNetworkInterfaceMediumType
01300 {
01307 HostNetworkInterfaceMediumType_Unknown = 0,
01314 HostNetworkInterfaceMediumType_Ethernet = 1,
01321 HostNetworkInterfaceMediumType_PPP = 2,
01328 HostNetworkInterfaceMediumType_SLIP = 3,
01329 };
01330
01340 enum HostNetworkInterfaceStatus
01341 {
01348 HostNetworkInterfaceStatus_Unknown = 0,
01355 HostNetworkInterfaceStatus_Up = 1,
01362 HostNetworkInterfaceStatus_Down = 2,
01363 };
01364
01372 enum HostNetworkInterfaceType
01373 {
01374 HostNetworkInterfaceType_Bridged = 1,
01375 HostNetworkInterfaceType_HostOnly = 2,
01376 };
01377
01385 enum AdditionsFacilityType
01386 {
01391 AdditionsFacilityType_None = 0,
01396 AdditionsFacilityType_VBoxGuestDriver = 20,
01401 AdditionsFacilityType_VBoxService = 100,
01406 AdditionsFacilityType_VBoxTrayClient = 101,
01411 AdditionsFacilityType_Seamless = 1000,
01419 AdditionsFacilityType_Graphics = 1100,
01424 AdditionsFacilityType_All = 2147483646,
01425 };
01426
01434 enum AdditionsFacilityClass
01435 {
01440 AdditionsFacilityClass_None = 0,
01445 AdditionsFacilityClass_Driver = 10,
01450 AdditionsFacilityClass_Service = 30,
01455 AdditionsFacilityClass_Program = 50,
01460 AdditionsFacilityClass_Feature = 100,
01465 AdditionsFacilityClass_ThirdParty = 999,
01470 AdditionsFacilityClass_All = 2147483646,
01471 };
01472
01480 enum AdditionsFacilityStatus
01481 {
01486 AdditionsFacilityStatus_Inactive = 0,
01491 AdditionsFacilityStatus_Paused = 1,
01496 AdditionsFacilityStatus_PreInit = 20,
01501 AdditionsFacilityStatus_Init = 30,
01506 AdditionsFacilityStatus_Active = 50,
01511 AdditionsFacilityStatus_Terminating = 100,
01516 AdditionsFacilityStatus_Terminated = 101,
01521 AdditionsFacilityStatus_Failed = 800,
01526 AdditionsFacilityStatus_Unknown = 999,
01527 };
01528
01536 enum AdditionsRunLevelType
01537 {
01542 AdditionsRunLevelType_None = 0,
01547 AdditionsRunLevelType_System = 1,
01552 AdditionsRunLevelType_Userland = 2,
01557 AdditionsRunLevelType_Desktop = 3,
01558 };
01559
01567 enum AdditionsUpdateFlag
01568 {
01573 AdditionsUpdateFlag_None = 0,
01579 AdditionsUpdateFlag_WaitForUpdateStartOnly = 1,
01580 };
01581
01589 enum ExecuteProcessFlag
01590 {
01595 ExecuteProcessFlag_None = 0,
01601 ExecuteProcessFlag_WaitForProcessStartOnly = 1,
01606 ExecuteProcessFlag_IgnoreOrphanedProcesses = 2,
01611 ExecuteProcessFlag_Hidden = 4,
01616 ExecuteProcessFlag_NoProfile = 8,
01617 };
01618
01626 enum ExecuteProcessStatus
01627 {
01632 ExecuteProcessStatus_Undefined = 0,
01637 ExecuteProcessStatus_Started = 1,
01642 ExecuteProcessStatus_TerminatedNormally = 2,
01647 ExecuteProcessStatus_TerminatedSignal = 3,
01652 ExecuteProcessStatus_TerminatedAbnormally = 4,
01657 ExecuteProcessStatus_TimedOutKilled = 5,
01662 ExecuteProcessStatus_TimedOutAbnormally = 6,
01667 ExecuteProcessStatus_Down = 7,
01672 ExecuteProcessStatus_Error = 8,
01673 };
01674
01682 enum ProcessInputFlag
01683 {
01688 ProcessInputFlag_None = 0,
01693 ProcessInputFlag_EndOfFile = 1,
01694 };
01695
01704 enum ProcessOutputFlag
01705 {
01710 ProcessOutputFlag_None = 0,
01715 ProcessOutputFlag_StdErr = 1,
01716 };
01717
01726 enum CopyFileFlag
01727 {
01732 CopyFileFlag_None = 0,
01737 CopyFileFlag_Recursive = 1,
01742 CopyFileFlag_Update = 2,
01747 CopyFileFlag_FollowLinks = 4,
01748 };
01749
01757 enum DirectoryCreateFlag
01758 {
01763 DirectoryCreateFlag_None = 0,
01768 DirectoryCreateFlag_Parents = 1,
01769 };
01770
01778 enum DirectoryOpenFlag
01779 {
01784 DirectoryOpenFlag_None = 0,
01785 };
01786
01794 enum GuestDirEntryType
01795 {
01800 GuestDirEntryType_Unknown = 0,
01805 GuestDirEntryType_Directory = 4,
01810 GuestDirEntryType_File = 10,
01815 GuestDirEntryType_Symlink = 12,
01816 };
01817
01827 enum MediumState
01828 {
01836 MediumState_NotCreated = 0,
01845 MediumState_Created = 1,
01853 MediumState_LockedRead = 2,
01861 MediumState_LockedWrite = 3,
01871 MediumState_Inaccessible = 4,
01878 MediumState_Creating = 5,
01885 MediumState_Deleting = 6,
01886 };
01887
01898 enum MediumType
01899 {
01907 MediumType_Normal = 0,
01915 MediumType_Immutable = 1,
01923 MediumType_Writethrough = 2,
01932 MediumType_Shareable = 3,
01941 MediumType_Readonly = 4,
01953 MediumType_MultiAttach = 5,
01954 };
01955
01965 enum MediumVariant
01966 {
01973 MediumVariant_Standard = 0,
01980 MediumVariant_VmdkSplit2G = 0x01,
01988 MediumVariant_VmdkStreamOptimized = 0x04,
01995 MediumVariant_VmdkESX = 0x08,
02002 MediumVariant_Fixed = 0x10000,
02009 MediumVariant_Diff = 0x20000,
02010 };
02011
02012 enum DataType
02013 {
02014 DataType_Int32 = 0,
02015 DataType_Int8 = 1,
02016 DataType_String = 2,
02017 };
02018
02019 enum DataFlags
02020 {
02021 DataFlags_None = 0x00,
02022 DataFlags_Mandatory = 0x01,
02023 DataFlags_Expert = 0x02,
02024 DataFlags_Array = 0x04,
02025 DataFlags_FlagMask = 0x07,
02026 };
02027
02035 enum MediumFormatCapabilities
02036 {
02043 MediumFormatCapabilities_Uuid = 0x01,
02050 MediumFormatCapabilities_CreateFixed = 0x02,
02058 MediumFormatCapabilities_CreateDynamic = 0x04,
02065 MediumFormatCapabilities_CreateSplit2G = 0x08,
02072 MediumFormatCapabilities_Differencing = 0x10,
02079 MediumFormatCapabilities_Asynchronous = 0x20,
02089 MediumFormatCapabilities_File = 0x40,
02098 MediumFormatCapabilities_Properties = 0x80,
02105 MediumFormatCapabilities_TcpNetworking = 0x100,
02112 MediumFormatCapabilities_VFS = 0x200,
02113 MediumFormatCapabilities_CapabilityMask = 0x3FF,
02114 };
02115
02123 enum MouseButtonState
02124 {
02125 MouseButtonState_LeftButton = 0x01,
02126 MouseButtonState_RightButton = 0x02,
02127 MouseButtonState_MiddleButton = 0x04,
02128 MouseButtonState_WheelUp = 0x08,
02129 MouseButtonState_WheelDown = 0x10,
02130 MouseButtonState_XButton1 = 0x20,
02131 MouseButtonState_XButton2 = 0x40,
02132 MouseButtonState_MouseStateMask = 0x7F,
02133 };
02134
02145 enum FramebufferPixelFormat
02146 {
02154 FramebufferPixelFormat_Opaque = 0,
02162 FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
02163 };
02164
02172 enum NetworkAttachmentType
02173 {
02178 NetworkAttachmentType_Null = 0,
02179 NetworkAttachmentType_NAT = 1,
02180 NetworkAttachmentType_Bridged = 2,
02181 NetworkAttachmentType_Internal = 3,
02182 NetworkAttachmentType_HostOnly = 4,
02183 NetworkAttachmentType_Generic = 5,
02184 };
02185
02193 enum NetworkAdapterType
02194 {
02199 NetworkAdapterType_Null = 0,
02204 NetworkAdapterType_Am79C970A = 1,
02209 NetworkAdapterType_Am79C973 = 2,
02214 NetworkAdapterType_I82540EM = 3,
02219 NetworkAdapterType_I82543GC = 4,
02224 NetworkAdapterType_I82545EM = 5,
02229 NetworkAdapterType_Virtio = 6,
02230 };
02231
02239 enum NetworkAdapterPromiscModePolicy
02240 {
02245 NetworkAdapterPromiscModePolicy_Deny = 1,
02253 NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
02261 NetworkAdapterPromiscModePolicy_AllowAll = 3,
02262 };
02263
02272 enum PortMode
02273 {
02278 PortMode_Disconnected = 0,
02283 PortMode_HostPipe = 1,
02288 PortMode_HostDevice = 2,
02293 PortMode_RawFile = 3,
02294 };
02295
02334 enum USBDeviceState
02335 {
02342 USBDeviceState_NotSupported = 0,
02350 USBDeviceState_Unavailable = 1,
02357 USBDeviceState_Busy = 2,
02365 USBDeviceState_Available = 3,
02373 USBDeviceState_Held = 4,
02381 USBDeviceState_Captured = 5,
02382 };
02383
02393 enum USBDeviceFilterAction
02394 {
02399 USBDeviceFilterAction_Null = 0,
02404 USBDeviceFilterAction_Ignore = 1,
02409 USBDeviceFilterAction_Hold = 2,
02410 };
02411
02419 enum AudioDriverType
02420 {
02425 AudioDriverType_Null = 0,
02430 AudioDriverType_WinMM = 1,
02435 AudioDriverType_OSS = 2,
02440 AudioDriverType_ALSA = 3,
02445 AudioDriverType_DirectSound = 4,
02450 AudioDriverType_CoreAudio = 5,
02455 AudioDriverType_MMPM = 6,
02460 AudioDriverType_Pulse = 7,
02465 AudioDriverType_SolAudio = 8,
02466 };
02467
02475 enum AudioControllerType
02476 {
02477 AudioControllerType_AC97 = 0,
02478 AudioControllerType_SB16 = 1,
02479 AudioControllerType_HDA = 2,
02480 };
02481
02489 enum AuthType
02490 {
02495 AuthType_Null = 0,
02496 AuthType_External = 1,
02497 AuthType_Guest = 2,
02498 };
02499
02508 enum StorageBus
02509 {
02514 StorageBus_Null = 0,
02515 StorageBus_IDE = 1,
02516 StorageBus_SATA = 2,
02517 StorageBus_SCSI = 3,
02518 StorageBus_Floppy = 4,
02519 StorageBus_SAS = 5,
02520 };
02521
02530 enum StorageControllerType
02531 {
02536 StorageControllerType_Null = 0,
02541 StorageControllerType_LsiLogic = 1,
02546 StorageControllerType_BusLogic = 2,
02551 StorageControllerType_IntelAhci = 3,
02556 StorageControllerType_PIIX3 = 4,
02561 StorageControllerType_PIIX4 = 5,
02566 StorageControllerType_ICH6 = 6,
02571 StorageControllerType_I82078 = 7,
02576 StorageControllerType_LsiLogicSas = 8,
02577 };
02578
02586 enum ChipsetType
02587 {
02592 ChipsetType_Null = 0,
02597 ChipsetType_PIIX3 = 1,
02602 ChipsetType_ICH9 = 2,
02603 };
02604
02610 enum NATAliasMode
02611 {
02616 NATAliasMode_AliasLog = 0x1,
02621 NATAliasMode_AliasProxyOnly = 0x02,
02626 NATAliasMode_AliasUseSamePorts = 0x04,
02627 };
02628
02634 enum NATProtocol
02635 {
02640 NATProtocol_UDP = 0,
02645 NATProtocol_TCP = 1,
02646 };
02647
02655 enum BandwidthGroupType
02656 {
02663 BandwidthGroupType_Null = 0,
02670 BandwidthGroupType_Disk = 1,
02677 BandwidthGroupType_Network = 2,
02678 };
02679
02688 enum VBoxEventType
02689 {
02696 VBoxEventType_Invalid = 0,
02705 VBoxEventType_Any = 1,
02713 VBoxEventType_Vetoable = 2,
02721 VBoxEventType_MachineEvent = 3,
02729 VBoxEventType_SnapshotEvent = 4,
02738 VBoxEventType_InputEvent = 5,
02745 VBoxEventType_LastWildcard = 31,
02752 VBoxEventType_OnMachineStateChanged = 32,
02759 VBoxEventType_OnMachineDataChanged = 33,
02766 VBoxEventType_OnExtraDataChanged = 34,
02773 VBoxEventType_OnExtraDataCanChange = 35,
02780 VBoxEventType_OnMediumRegistered = 36,
02787 VBoxEventType_OnMachineRegistered = 37,
02794 VBoxEventType_OnSessionStateChanged = 38,
02801 VBoxEventType_OnSnapshotTaken = 39,
02808 VBoxEventType_OnSnapshotDeleted = 40,
02815 VBoxEventType_OnSnapshotChanged = 41,
02822 VBoxEventType_OnGuestPropertyChanged = 42,
02829 VBoxEventType_OnMousePointerShapeChanged = 43,
02836 VBoxEventType_OnMouseCapabilityChanged = 44,
02843 VBoxEventType_OnKeyboardLedsChanged = 45,
02850 VBoxEventType_OnStateChanged = 46,
02857 VBoxEventType_OnAdditionsStateChanged = 47,
02864 VBoxEventType_OnNetworkAdapterChanged = 48,
02871 VBoxEventType_OnSerialPortChanged = 49,
02878 VBoxEventType_OnParallelPortChanged = 50,
02885 VBoxEventType_OnStorageControllerChanged = 51,
02892 VBoxEventType_OnMediumChanged = 52,
02899 VBoxEventType_OnVRDEServerChanged = 53,
02906 VBoxEventType_OnUSBControllerChanged = 54,
02913 VBoxEventType_OnUSBDeviceStateChanged = 55,
02920 VBoxEventType_OnSharedFolderChanged = 56,
02927 VBoxEventType_OnRuntimeError = 57,
02934 VBoxEventType_OnCanShowWindow = 58,
02941 VBoxEventType_OnShowWindow = 59,
02948 VBoxEventType_OnCPUChanged = 60,
02955 VBoxEventType_OnVRDEServerInfoChanged = 61,
02962 VBoxEventType_OnEventSourceChanged = 62,
02969 VBoxEventType_OnCPUExecutionCapChanged = 63,
02976 VBoxEventType_OnGuestKeyboard = 64,
02983 VBoxEventType_OnGuestMouse = 65,
02990 VBoxEventType_OnNATRedirect = 66,
02997 VBoxEventType_OnHostPciDevicePlug = 67,
03004 VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
03011 VBoxEventType_OnBandwidthGroupChanged = 69,
03018 VBoxEventType_OnGuestMonitorChanged = 70,
03025 VBoxEventType_OnStorageDeviceChanged = 71,
03032 VBoxEventType_Last = 72,
03033 };
03034
03042 enum GuestMonitorChangedEventType
03043 {
03050 GuestMonitorChangedEventType_Enabled = 0,
03057 GuestMonitorChangedEventType_Disabled = 1,
03064 GuestMonitorChangedEventType_NewOrigin = 2,
03065 };
03066
03100 interface IVirtualBoxErrorInfo : $errorinfo
03101 {
03119 readonly attribute long resultCode;
03120
03132 readonly attribute wstringUUID interfaceID;
03133
03144 readonly attribute wstring component;
03145
03156 readonly attribute wstring text;
03157
03168 readonly attribute IVirtualBoxErrorInfo next;
03169
03170 };
03171
03182 interface IDHCPServer : $unknown
03183 {
03189 attribute boolean enabled;
03190
03196 readonly attribute wstring IPAddress;
03197
03203 readonly attribute wstring networkMask;
03204
03210 readonly attribute wstring networkName;
03211
03217 readonly attribute wstring lowerIP;
03218
03224 readonly attribute wstring upperIP;
03225
03254 void setConfiguration (
03255 in wstring IPAddress,
03256 in wstring networkMask,
03257 in wstring FromIPAddress,
03258 in wstring ToIPAddress
03259 );
03260
03285 void start (
03286 in wstring networkName,
03287 in wstring trunkName,
03288 in wstring trunkType
03289 );
03290
03303 void stop();
03304
03305 };
03306
03325 interface IVirtualBox : $unknown
03326 {
03334 readonly attribute wstring version;
03335
03341 readonly attribute unsigned long revision;
03342
03352 readonly attribute wstring packageType;
03353
03365 readonly attribute wstring APIVersion;
03366
03382 readonly attribute wstring homeFolder;
03383
03391 readonly attribute wstring settingsFilePath;
03392
03396 readonly attribute IHost host;
03397
03401 readonly attribute ISystemProperties systemProperties;
03402
03408 readonly attribute IMachine[] machines;
03409
03419 readonly attribute IMedium[] hardDisks;
03420
03426 readonly attribute IMedium[] DVDImages;
03427
03433 readonly attribute IMedium[] floppyImages;
03434
03435 readonly attribute IProgress[] progressOperations;
03436
03437 readonly attribute IGuestOSType[] guestOSTypes;
03438
03455 readonly attribute ISharedFolder[] sharedFolders;
03456
03462 readonly attribute IPerformanceCollector performanceCollector;
03463
03469 readonly attribute IDHCPServer[] DHCPServers;
03470
03476 readonly attribute IEventSource eventSource;
03477
03483 readonly attribute IExtPackManager extensionPackManager;
03484
03524 void composeMachineFilename (
03525 in wstring name,
03526 in wstring baseFolder,
03527 [retval] out wstring file
03528 );
03529
03626 void createMachine (
03627 in wstring settingsFile,
03628 in wstring name,
03629 in wstring osTypeId,
03630 in wstringUUID id,
03631 in boolean forceOverwrite,
03632 [retval] out IMachine machine
03633 );
03634
03660 void openMachine (
03661 in wstring settingsFile,
03662 [retval] out IMachine machine
03663 );
03664
03696 void registerMachine (
03697 in IMachine machine
03698 );
03699
03720 void findMachine (
03721 in wstring nameOrId,
03722 [retval] out IMachine machine
03723 );
03724
03734 void createAppliance (
03735 [retval] out IAppliance appliance
03736 );
03737
03800 void createHardDisk (
03801 in wstring format,
03802 in wstring location,
03803 [retval] out IMedium medium
03804 );
03805
03910 void openMedium (
03911 in wstring location,
03912 in DeviceType deviceType,
03913 in AccessMode accessMode,
03914 in boolean forceNewUuid,
03915 [retval] out IMedium medium
03916 );
03917
03949 void findMedium (
03950 in wstring location,
03951 in DeviceType type,
03952 [retval] out IMedium medium
03953 );
03954
03983 void getGuestOSType (
03984 in wstringUUID id,
03985 [retval] out IGuestOSType type
03986 );
03987
04010 void createSharedFolder (
04011 in wstring name,
04012 in wstring hostPath,
04013 in boolean writable,
04014 in boolean automount
04015 );
04016
04031 void removeSharedFolder (
04032 in wstring name
04033 );
04034
04043 void getExtraDataKeys (
04044 [retval] out wstring[] value
04045 );
04046
04075 void getExtraData (
04076 in wstring key,
04077 [retval] out wstring value
04078 );
04079
04129 void setExtraData (
04130 in wstring key,
04131 in wstring value
04132 );
04133
04150 void createDHCPServer (
04151 in wstring name,
04152 [retval] out IDHCPServer server
04153 );
04154
04171 void findDHCPServerByNetworkName (
04172 in wstring name,
04173 [retval] out IDHCPServer server
04174 );
04175
04190 void removeDHCPServer (
04191 in IDHCPServer server
04192 );
04193
04218 void checkFirmwarePresent (
04219 in FirmwareType firmwareType,
04220 in wstring version,
04221 out wstring url,
04222 out wstring file,
04223 [retval] out boolean result
04224 );
04225
04226 };
04227
04238 interface IVFSExplorer : $unknown
04239 {
04243 readonly attribute wstring path;
04244
04248 readonly attribute VFSType type;
04249
04257 void update (
04258 [retval] out IProgress aProgress
04259 );
04260
04268 void cd (
04269 in wstring aDir,
04270 [retval] out IProgress aProgress
04271 );
04272
04278 void cdUp (
04279 [retval] out IProgress aProgress
04280 );
04281
04294 void entryList (
04295 out wstring[] aNames,
04296 out unsigned long[] aTypes,
04297 out unsigned long[] aSizes,
04298 out unsigned long[] aModes
04299 );
04300
04309 void exists (
04310 in wstring[] aNames,
04311 [retval] out wstring[] aExists
04312 );
04313
04321 void remove (
04322 in wstring[] aNames,
04323 [retval] out IProgress aProgress
04324 );
04325
04326 };
04327
04393 interface IAppliance : $unknown
04394 {
04402 readonly attribute wstring path;
04403
04434 readonly attribute wstring[] disks;
04435
04443 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
04444
04452 readonly attribute wstring[] machines;
04453
04470 void read (
04471 in wstring file,
04472 [retval] out IProgress aProgress
04473 );
04474
04491 void interpret();
04492
04513 void importMachines (
04514 [retval] out IProgress aProgress
04515 );
04516
04524 void createVFSExplorer (
04525 in wstring aUri,
04526 [retval] out IVFSExplorer aExplorer
04527 );
04528
04558 void write (
04559 in wstring format,
04560 in boolean manifest,
04561 in wstring path,
04562 [retval] out IProgress progress
04563 );
04564
04570 void getWarnings (
04571 [retval] out wstring[] aWarnings
04572 );
04573
04574 };
04575
04587 interface IVirtualSystemDescription : $unknown
04588 {
04592 readonly attribute unsigned long count;
04593
04717 void getDescription (
04718 out VirtualSystemDescriptionType[] aTypes,
04719 out wstring[] aRefs,
04720 out wstring[] aOvfValues,
04721 out wstring[] aVBoxValues,
04722 out wstring[] aExtraConfigValues
04723 );
04724
04741 void getDescriptionByType (
04742 in VirtualSystemDescriptionType aType,
04743 out VirtualSystemDescriptionType[] aTypes,
04744 out wstring[] aRefs,
04745 out wstring[] aOvfValues,
04746 out wstring[] aVBoxValues,
04747 out wstring[] aExtraConfigValues
04748 );
04749
04761 void getValuesByType (
04762 in VirtualSystemDescriptionType aType,
04763 in VirtualSystemDescriptionValueType aWhich,
04764 [retval] out wstring[] aValues
04765 );
04766
04792 void setFinalValues (
04793 in boolean[] aEnabled,
04794 in wstring[] aVBoxValues,
04795 in wstring[] aExtraConfigValues
04796 );
04797
04812 void addDescription (
04813 in VirtualSystemDescriptionType aType,
04814 in wstring aVBoxValue,
04815 in wstring aExtraConfigValue
04816 );
04817
04818 };
04819
04820 interface IInternalMachineControl : $unknown
04821 {
04828 void setRemoveSavedStateFile (
04829 in boolean aRemove
04830 );
04831
04843 void updateState (
04844 in MachineState state
04845 );
04846
04847 void getIPCId (
04848 [retval] out wstring id
04849 );
04850
04862 void beginPowerUp (
04863 in IProgress aProgress
04864 );
04865
04875 void endPowerUp (
04876 in long result
04877 );
04878
04890 void beginPoweringDown (
04891 out IProgress progress
04892 );
04893
04923 void endPoweringDown (
04924 in long result,
04925 in wstring errMsg
04926 );
04927
04941 void runUSBDeviceFilters (
04942 in IUSBDevice device,
04943 out boolean matched,
04944 out unsigned long maskedInterfaces
04945 );
04946
04955 void captureUSBDevice (
04956 in wstringUUID id
04957 );
04958
04974 void detachUSBDevice (
04975 in wstringUUID id,
04976 in boolean done
04977 );
04978
04987 void autoCaptureUSBDevices();
04988
05004 void detachAllUSBDevices (
05005 in boolean done
05006 );
05007
05022 void onSessionEnd (
05023 in ISession session,
05024 [retval] out IProgress progress
05025 );
05026
05042 void beginSavingState (
05043 out IProgress progress,
05044 out wstring stateFilePath
05045 );
05046
05076 void endSavingState (
05077 in long result,
05078 in wstring errMsg
05079 );
05080
05095 void adoptSavedState (
05096 in wstring savedStateFile
05097 );
05098
05147 void beginTakingSnapshot (
05148 in IConsole initiator,
05149 in wstring name,
05150 in wstring description,
05151 in IProgress consoleProgress,
05152 in boolean fTakingSnapshotOnline,
05153 out wstring stateFilePath
05154 );
05155
05165 void endTakingSnapshot (
05166 in boolean success
05167 );
05168
05193 void deleteSnapshot (
05194 in IConsole initiator,
05195 in wstringUUID id,
05196 in boolean deleteAllChildren,
05197 out MachineState machineState,
05198 [retval] out IProgress progress
05199 );
05200
05219 void finishOnlineMergeMedium (
05220 in IMediumAttachment mediumAttachment,
05221 in IMedium source,
05222 in IMedium target,
05223 in boolean mergeForward,
05224 in IMedium parentForTarget,
05225 in IMedium[] childrenToReparent
05226 );
05227
05241 void restoreSnapshot (
05242 in IConsole initiator,
05243 in ISnapshot snapshot,
05244 out MachineState machineState,
05245 [retval] out IProgress progress
05246 );
05247
05274 void pullGuestProperties (
05275 out wstring[] name,
05276 out wstring[] value,
05277 out long long[] timestamp,
05278 out wstring[] flags
05279 );
05280
05302 void pushGuestProperty (
05303 in wstring name,
05304 in wstring value,
05305 in long long timestamp,
05306 in wstring flags
05307 );
05308
05320 void lockMedia();
05321
05331 void unlockMedia();
05332
05348 void ejectMedium (
05349 in IMediumAttachment attachment,
05350 [retval] out IMediumAttachment newAttachment
05351 );
05352
05353 };
05354
05363 interface IBIOSSettings : $unknown
05364 {
05368 attribute boolean logoFadeIn;
05369
05373 attribute boolean logoFadeOut;
05374
05378 attribute unsigned long logoDisplayTime;
05379
05386 attribute wstring logoImagePath;
05387
05391 attribute BIOSBootMenuMode bootMenuMode;
05392
05396 attribute boolean ACPIEnabled;
05397
05404 attribute boolean IOAPICEnabled;
05405
05415 attribute long long timeOffset;
05416
05423 attribute boolean PXEDebugEnabled;
05424
05425 };
05426
05434 interface IPciAddress : $unknown
05435 {
05441 attribute short bus;
05442
05448 attribute short device;
05449
05455 attribute short devFunction;
05456
05462 void asLong (
05463 [retval] out long result
05464 );
05465
05471 void fromLong (
05472 in long number
05473 );
05474
05475 };
05476
05484 interface IPciDeviceAttachment : $unknown
05485 {
05491 readonly attribute wstring name;
05492
05498 readonly attribute boolean isPhysicalDevice;
05499
05505 readonly attribute long hostAddress;
05506
05512 readonly attribute long guestAddress;
05513
05514 };
05515
05556 interface IMachine : $unknown
05557 {
05561 readonly attribute IVirtualBox parent;
05562
05612 readonly attribute boolean accessible;
05613
05625 readonly attribute IVirtualBoxErrorInfo accessError;
05626
05666 attribute wstring name;
05667
05678 attribute wstring description;
05679
05683 readonly attribute wstringUUID id;
05684
05699 attribute wstring OSTypeId;
05700
05704 attribute wstring hardwareVersion;
05705
05715 attribute wstringUUID hardwareUUID;
05716
05720 attribute unsigned long CPUCount;
05721
05727 attribute boolean CPUHotPlugEnabled;
05728
05736 attribute unsigned long CPUExecutionCap;
05737
05741 attribute unsigned long memorySize;
05742
05746 attribute unsigned long memoryBalloonSize;
05747
05754 attribute boolean pageFusionEnabled;
05755
05759 attribute unsigned long VRAMSize;
05760
05766 attribute boolean accelerate3DEnabled;
05767
05773 attribute boolean accelerate2DVideoEnabled;
05774
05785 attribute unsigned long monitorCount;
05786
05790 readonly attribute IBIOSSettings BIOSSettings;
05791
05796 attribute FirmwareType firmwareType;
05797
05803 attribute PointingHidType pointingHidType;
05804
05810 attribute KeyboardHidType keyboardHidType;
05811
05818 attribute boolean hpetEnabled;
05819
05823 attribute ChipsetType chipsetType;
05824
05858 attribute wstring snapshotFolder;
05859
05863 readonly attribute IVRDEServer VRDEServer;
05864
05865 attribute boolean emulatedUSBWebcameraEnabled;
05866
05867 attribute boolean emulatedUSBCardReaderEnabled;
05868
05872 readonly attribute IMediumAttachment[] mediumAttachments;
05873
05885 readonly attribute IUSBController USBController;
05886
05890 readonly attribute IAudioAdapter audioAdapter;
05891
05895 readonly attribute IStorageController[] storageControllers;
05896
05902 readonly attribute wstring settingsFilePath;
05903
05928 readonly attribute boolean settingsModified;
05929
05933 readonly attribute SessionState sessionState;
05934
05947 readonly attribute wstring sessionType;
05948
05958 readonly attribute unsigned long sessionPid;
05959
05963 readonly attribute MachineState state;
05964
05971 readonly attribute long long lastStateChange;
05972
05984 readonly attribute wstring stateFilePath;
05985
05995 readonly attribute wstring logFolder;
05996
06007 readonly attribute ISnapshot currentSnapshot;
06008
06015 readonly attribute unsigned long snapshotCount;
06016
06048 readonly attribute boolean currentStateModified;
06049
06061 readonly attribute ISharedFolder[] sharedFolders;
06062
06069 attribute ClipboardMode clipboardMode;
06070
06078 attribute wstring guestPropertyNotificationPatterns;
06079
06088 attribute boolean teleporterEnabled;
06089
06100 attribute unsigned long teleporterPort;
06101
06108 attribute wstring teleporterAddress;
06109
06117 attribute wstring teleporterPassword;
06118
06126 attribute FaultToleranceState faultToleranceState;
06127
06134 attribute unsigned long faultTolerancePort;
06135
06141 attribute wstring faultToleranceAddress;
06142
06150 attribute wstring faultTolerancePassword;
06151
06157 attribute unsigned long faultToleranceSyncInterval;
06158
06166 attribute boolean RTCUseUTC;
06167
06174 attribute boolean ioCacheEnabled;
06175
06181 attribute unsigned long ioCacheSize;
06182
06188 readonly attribute IBandwidthControl bandwidthControl;
06189
06199 readonly attribute IPciDeviceAttachment[] pciDeviceAssignments;
06200
06306 void lockMachine (
06307 in ISession session,
06308 in LockType lockType
06309 );
06310
06440 void launchVMProcess (
06441 in ISession session,
06442 in wstring type,
06443 in wstring environment,
06444 [retval] out IProgress progress
06445 );
06446
06484 void setBootOrder (
06485 in unsigned long position,
06486 in DeviceType device
06487 );
06488
06523 void getBootOrder (
06524 in unsigned long position,
06525 [retval] out DeviceType device
06526 );
06527
06629 void attachDevice (
06630 in wstring name,
06631 in long controllerPort,
06632 in long device,
06633 in DeviceType type,
06634 in IMedium medium
06635 );
06636
06689 void detachDevice (
06690 in wstring name,
06691 in long controllerPort,
06692 in long device
06693 );
06694
06737 void passthroughDevice (
06738 in wstring name,
06739 in long controllerPort,
06740 in long device,
06741 in boolean passthrough
06742 );
06743
06786 void temporaryEjectDevice (
06787 in wstring name,
06788 in long controllerPort,
06789 in long device,
06790 in boolean temporaryEject
06791 );
06792
06833 void setBandwidthGroupForDevice (
06834 in wstring name,
06835 in long controllerPort,
06836 in long device,
06837 in IBandwidthGroup bandwidthGroup
06838 );
06839
06902 void mountMedium (
06903 in wstring name,
06904 in long controllerPort,
06905 in long device,
06906 in IMedium medium,
06907 in boolean force
06908 );
06909
06938 void getMedium (
06939 in wstring name,
06940 in long controllerPort,
06941 in long device,
06942 [retval] out IMedium medium
06943 );
06944
06959 void getMediumAttachmentsOfController (
06960 in wstring name,
06961 [retval] out IMediumAttachment[] mediumAttachments
06962 );
06963
06978 void getMediumAttachment (
06979 in wstring name,
06980 in long controllerPort,
06981 in long device,
06982 [retval] out IMediumAttachment attachment
06983 );
06984
07025 void attachHostPciDevice (
07026 in long hostAddress,
07027 in long desiredGuestAddress,
07028 in boolean tryToUnbind
07029 );
07030
07071 void detachHostPciDevice (
07072 in long hostAddress
07073 );
07074
07092 void getNetworkAdapter (
07093 in unsigned long slot,
07094 [retval] out INetworkAdapter adapter
07095 );
07096
07129 void addStorageController (
07130 in wstring name,
07131 in StorageBus connectionType,
07132 [retval] out IStorageController controller
07133 );
07134
07148 void getStorageControllerByName (
07149 in wstring name,
07150 [retval] out IStorageController storageController
07151 );
07152
07166 void getStorageControllerByInstance (
07167 in unsigned long instance,
07168 [retval] out IStorageController storageController
07169 );
07170
07184 void removeStorageController (
07185 in wstring name
07186 );
07187
07209 void setStorageControllerBootable (
07210 in wstring name,
07211 in boolean bootable
07212 );
07213
07231 void getSerialPort (
07232 in unsigned long slot,
07233 [retval] out ISerialPort port
07234 );
07235
07253 void getParallelPort (
07254 in unsigned long slot,
07255 [retval] out IParallelPort port
07256 );
07257
07266 void getExtraDataKeys (
07267 [retval] out wstring[] value
07268 );
07269
07298 void getExtraData (
07299 in wstring key,
07300 [retval] out wstring value
07301 );
07302
07352 void setExtraData (
07353 in wstring key,
07354 in wstring value
07355 );
07356
07378 void getCPUProperty (
07379 in CPUPropertyType property,
07380 [retval] out boolean value
07381 );
07382
07404 void setCPUProperty (
07405 in CPUPropertyType property,
07406 in boolean value
07407 );
07408
07448 void getCPUIDLeaf (
07449 in unsigned long id,
07450 out unsigned long valEax,
07451 out unsigned long valEbx,
07452 out unsigned long valEcx,
07453 out unsigned long valEdx
07454 );
07455
07499 void setCPUIDLeaf (
07500 in unsigned long id,
07501 in unsigned long valEax,
07502 in unsigned long valEbx,
07503 in unsigned long valEcx,
07504 in unsigned long valEdx
07505 );
07506
07524 void removeCPUIDLeaf (
07525 in unsigned long id
07526 );
07527
07533 void removeAllCPUIDLeaves();
07534
07556 void getHWVirtExProperty (
07557 in HWVirtExPropertyType property,
07558 [retval] out boolean value
07559 );
07560
07582 void setHWVirtExProperty (
07583 in HWVirtExPropertyType property,
07584 in boolean value
07585 );
07586
07632 void saveSettings();
07633
07657 void discardSettings();
07658
07742 void unregister (
07743 in CleanupMode cleanupMode,
07744 [retval] out IMedium[] aMedia
07745 );
07746
07803 void delete (
07804 in IMedium[] aMedia,
07805 [retval] out IProgress aProgress
07806 );
07807
07819 void export (
07820 in IAppliance aAppliance,
07821 in wstring location,
07822 [retval] out IVirtualSystemDescription aDescription
07823 );
07824
07848 void findSnapshot (
07849 in wstring nameOrId,
07850 [retval] out ISnapshot snapshot
07851 );
07852
07886 void createSharedFolder (
07887 in wstring name,
07888 in wstring hostPath,
07889 in boolean writable,
07890 in boolean automount
07891 );
07892
07918 void removeSharedFolder (
07919 in wstring name
07920 );
07921
07945 void canShowConsoleWindow (
07946 [retval] out boolean canShow
07947 );
07948
07983 void showConsoleWindow (
07984 [retval] out long long winId
07985 );
07986
08019 void getGuestProperty (
08020 in wstring name,
08021 out wstring value,
08022 out long long timestamp,
08023 out wstring flags
08024 );
08025
08048 void getGuestPropertyValue (
08049 in wstring property,
08050 [retval] out wstring value
08051 );
08052
08075 void getGuestPropertyTimestamp (
08076 in wstring property,
08077 [retval] out long long value
08078 );
08079
08130 void setGuestProperty (
08131 in wstring property,
08132 in wstring value,
08133 in wstring flags
08134 );
08135
08176 void setGuestPropertyValue (
08177 in wstring property,
08178 in wstring value
08179 );
08180
08211 void enumerateGuestProperties (
08212 in wstring patterns,
08213 out wstring[] name,
08214 out wstring[] value,
08215 out long long[] timestamp,
08216 out wstring[] flags
08217 );
08218
08236 void querySavedGuestSize (
08237 in unsigned long screenId,
08238 out unsigned long width,
08239 out unsigned long height
08240 );
08241
08263 void querySavedThumbnailSize (
08264 in unsigned long screenId,
08265 out unsigned long size,
08266 out unsigned long width,
08267 out unsigned long height
08268 );
08269
08296 void readSavedThumbnailToArray (
08297 in unsigned long screenId,
08298 in boolean BGR,
08299 out unsigned long width,
08300 out unsigned long height,
08301 [retval] out octet[] data
08302 );
08303
08325 void readSavedThumbnailPNGToArray (
08326 in unsigned long screenId,
08327 out unsigned long width,
08328 out unsigned long height,
08329 [retval] out octet[] data
08330 );
08331
08353 void querySavedScreenshotPNGSize (
08354 in unsigned long screenId,
08355 out unsigned long size,
08356 out unsigned long width,
08357 out unsigned long height
08358 );
08359
08381 void readSavedScreenshotPNGToArray (
08382 in unsigned long screenId,
08383 out unsigned long width,
08384 out unsigned long height,
08385 [retval] out octet[] data
08386 );
08387
08397 void hotPlugCPU (
08398 in unsigned long cpu
08399 );
08400
08410 void hotUnplugCPU (
08411 in unsigned long cpu
08412 );
08413
08427 void getCPUStatus (
08428 in unsigned long cpu,
08429 [retval] out boolean attached
08430 );
08431
08446 void queryLogFilename (
08447 in unsigned long idx,
08448 [retval] out wstring filename
08449 );
08450
08476 void readLog (
08477 in unsigned long idx,
08478 in long long offset,
08479 in long long size,
08480 [retval] out octet[] data
08481 );
08482
08515 void cloneTo (
08516 in IMachine target,
08517 in CloneMode mode,
08518 in CloneOptions[] options,
08519 [retval] out IProgress progress
08520 );
08521
08522 };
08523
08532 interface IVRDEServerInfo : $unknown
08533 {
08539 readonly attribute boolean active;
08540
08549 readonly attribute long port;
08550
08556 readonly attribute unsigned long numberOfClients;
08557
08563 readonly attribute long long beginTime;
08564
08571 readonly attribute long long endTime;
08572
08578 readonly attribute long long bytesSent;
08579
08585 readonly attribute long long bytesSentTotal;
08586
08592 readonly attribute long long bytesReceived;
08593
08599 readonly attribute long long bytesReceivedTotal;
08600
08606 readonly attribute wstring user;
08607
08613 readonly attribute wstring domain;
08614
08620 readonly attribute wstring clientName;
08621
08627 readonly attribute wstring clientIP;
08628
08634 readonly attribute unsigned long clientVersion;
08635
08643 readonly attribute unsigned long encryptionStyle;
08644
08645 };
08646
08668 interface IConsole : $unknown
08669 {
08681 readonly attribute IMachine machine;
08682
08696 readonly attribute MachineState state;
08697
08701 readonly attribute IGuest guest;
08702
08713 readonly attribute IKeyboard keyboard;
08714
08725 readonly attribute IMouse mouse;
08726
08736 readonly attribute IDisplay display;
08737
08741 readonly attribute IMachineDebugger debugger;
08742
08753 readonly attribute IUSBDevice[] USBDevices;
08754
08762 readonly attribute IHostUSBDevice[] remoteUSBDevices;
08763
08779 readonly attribute ISharedFolder[] sharedFolders;
08780
08786 readonly attribute IVRDEServerInfo VRDEServerInfo;
08787
08793 readonly attribute IEventSource eventSource;
08794
08798 readonly attribute IPciDeviceAttachment[] attachedPciDevices;
08799
08808 attribute boolean useHostClipboard;
08809
08874 void powerUp (
08875 [retval] out IProgress progress
08876 );
08877
08911 void powerUpPaused (
08912 [retval] out IProgress progress
08913 );
08914
08934 void powerDown (
08935 [retval] out IProgress progress
08936 );
08937
08957 void reset();
08958
08978 void pause();
08979
08999 void resume();
09000
09020 void powerButton();
09021
09041 void sleepButton();
09042
09054 void getPowerButtonHandled (
09055 [retval] out boolean handled
09056 );
09057
09071 void getGuestEnteredACPIMode (
09072 [retval] out boolean entered
09073 );
09074
09127 void saveState (
09128 [retval] out IProgress progress
09129 );
09130
09163 void adoptSavedState (
09164 in wstring savedStateFile
09165 );
09166
09197 void discardSavedState (
09198 in boolean fRemoveFile
09199 );
09200
09213 void getDeviceActivity (
09214 in DeviceType type,
09215 [retval] out DeviceActivity activity
09216 );
09217
09255 void attachUSBDevice (
09256 in wstringUUID id
09257 );
09258
09293 void detachUSBDevice (
09294 in wstringUUID id,
09295 [retval] out IUSBDevice device
09296 );
09297
09320 void findUSBDeviceByAddress (
09321 in wstring name,
09322 [retval] out IUSBDevice device
09323 );
09324
09344 void findUSBDeviceById (
09345 in wstringUUID id,
09346 [retval] out IUSBDevice device
09347 );
09348
09382 void createSharedFolder (
09383 in wstring name,
09384 in wstring hostPath,
09385 in boolean writable,
09386 in boolean automount
09387 );
09388
09413 void removeSharedFolder (
09414 in wstring name
09415 );
09416
09454 void takeSnapshot (
09455 in wstring name,
09456 in wstring description,
09457 [retval] out IProgress progress
09458 );
09459
09532 void deleteSnapshot (
09533 in wstringUUID id,
09534 [retval] out IProgress progress
09535 );
09536
09576 void deleteSnapshotAndAllChildren (
09577 in wstringUUID id,
09578 [retval] out IProgress progress
09579 );
09580
09621 void restoreSnapshot (
09622 in ISnapshot snapshot,
09623 [retval] out IProgress progress
09624 );
09625
09664 void teleport (
09665 in wstring hostname,
09666 in unsigned long tcpport,
09667 in wstring password,
09668 in unsigned long maxDowntime,
09669 [retval] out IProgress progress
09670 );
09671
09672 };
09673
09684 interface IHostNetworkInterface : $unknown
09685 {
09689 readonly attribute wstring name;
09690
09694 readonly attribute wstringUUID id;
09695
09699 readonly attribute wstring networkName;
09700
09704 readonly attribute boolean dhcpEnabled;
09705
09709 readonly attribute wstring IPAddress;
09710
09714 readonly attribute wstring networkMask;
09715
09719 readonly attribute boolean IPV6Supported;
09720
09724 readonly attribute wstring IPV6Address;
09725
09729 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
09730
09734 readonly attribute wstring hardwareAddress;
09735
09739 readonly attribute HostNetworkInterfaceMediumType mediumType;
09740
09744 readonly attribute HostNetworkInterfaceStatus status;
09745
09749 readonly attribute HostNetworkInterfaceType interfaceType;
09750
09762 void enableStaticIpConfig (
09763 in wstring IPAddress,
09764 in wstring networkMask
09765 );
09766
09778 void enableStaticIpConfigV6 (
09779 in wstring IPV6Address,
09780 in unsigned long IPV6NetworkMaskPrefixLength
09781 );
09782
09786 void enableDynamicIpConfig();
09787
09791 void dhcpRediscover();
09792
09793 };
09794
09811 interface IHost : $unknown
09812 {
09816 readonly attribute IMedium[] DVDDrives;
09817
09821 readonly attribute IMedium[] floppyDrives;
09822
09836 readonly attribute IHostUSBDevice[] USBDevices;
09837
09861 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
09862
09866 readonly attribute IHostNetworkInterface[] networkInterfaces;
09867
09871 readonly attribute unsigned long processorCount;
09872
09876 readonly attribute unsigned long processorOnlineCount;
09877
09881 readonly attribute unsigned long processorCoreCount;
09882
09886 readonly attribute unsigned long memorySize;
09887
09891 readonly attribute unsigned long memoryAvailable;
09892
09896 readonly attribute wstring operatingSystem;
09897
09901 readonly attribute wstring OSVersion;
09902
09906 readonly attribute long long UTCTime;
09907
09911 readonly attribute boolean Acceleration3DAvailable;
09912
09927 void getProcessorSpeed (
09928 in unsigned long cpuId,
09929 [retval] out unsigned long speed
09930 );
09931
09943 void getProcessorFeature (
09944 in ProcessorFeature feature,
09945 [retval] out boolean supported
09946 );
09947
09966 void getProcessorDescription (
09967 in unsigned long cpuId,
09968 [retval] out wstring description
09969 );
09970
10011 void getProcessorCPUIDLeaf (
10012 in unsigned long cpuId,
10013 in unsigned long leaf,
10014 in unsigned long subLeaf,
10015 out unsigned long valEax,
10016 out unsigned long valEbx,
10017 out unsigned long valEcx,
10018 out unsigned long valEdx
10019 );
10020
10041 void createHostOnlyNetworkInterface (
10042 out IHostNetworkInterface hostInterface,
10043 [retval] out IProgress progress
10044 );
10045
10066 void removeHostOnlyNetworkInterface (
10067 in wstringUUID id,
10068 [retval] out IProgress progress
10069 );
10070
10090 void createUSBDeviceFilter (
10091 in wstring name,
10092 [retval] out IHostUSBDeviceFilter filter
10093 );
10094
10137 void insertUSBDeviceFilter (
10138 in unsigned long position,
10139 in IHostUSBDeviceFilter filter
10140 );
10141
10169 void removeUSBDeviceFilter (
10170 in unsigned long position
10171 );
10172
10190 void findHostDVDDrive (
10191 in wstring name,
10192 [retval] out IMedium drive
10193 );
10194
10212 void findHostFloppyDrive (
10213 in wstring name,
10214 [retval] out IMedium drive
10215 );
10216
10232 void findHostNetworkInterfaceByName (
10233 in wstring name,
10234 [retval] out IHostNetworkInterface networkInterface
10235 );
10236
10252 void findHostNetworkInterfaceById (
10253 in wstringUUID id,
10254 [retval] out IHostNetworkInterface networkInterface
10255 );
10256
10266 void findHostNetworkInterfacesOfType (
10267 in HostNetworkInterfaceType type,
10268 [retval] out IHostNetworkInterface[] networkInterfaces
10269 );
10270
10290 void findUSBDeviceById (
10291 in wstringUUID id,
10292 [retval] out IHostUSBDevice device
10293 );
10294
10317 void findUSBDeviceByAddress (
10318 in wstring name,
10319 [retval] out IHostUSBDevice device
10320 );
10321
10329 void generateMACAddress (
10330 [retval] out wstring address
10331 );
10332
10333 };
10334
10347 interface ISystemProperties : $unknown
10348 {
10352 readonly attribute unsigned long minGuestRAM;
10353
10357 readonly attribute unsigned long maxGuestRAM;
10358
10362 readonly attribute unsigned long minGuestVRAM;
10363
10367 readonly attribute unsigned long maxGuestVRAM;
10368
10372 readonly attribute unsigned long minGuestCPUCount;
10373
10377 readonly attribute unsigned long maxGuestCPUCount;
10378
10382 readonly attribute unsigned long maxGuestMonitors;
10383
10388 readonly attribute long long infoVDSize;
10389
10396 readonly attribute unsigned long serialPortCount;
10397
10404 readonly attribute unsigned long parallelPortCount;
10405
10415 readonly attribute unsigned long maxBootPosition;
10416
10440 attribute wstring defaultMachineFolder;
10441
10466 readonly attribute IMediumFormat[] mediumFormats;
10467
10501 attribute wstring defaultHardDiskFormat;
10502
10508 attribute long long freeDiskSpaceWarning;
10509
10514 attribute unsigned long freeDiskSpacePercentWarning;
10515
10521 attribute long long freeDiskSpaceError;
10522
10527 attribute unsigned long freeDiskSpacePercentError;
10528
10552 attribute wstring VRDEAuthLibrary;
10553
10582 attribute wstring webServiceAuthLibrary;
10583
10597 attribute wstring defaultVRDEExtPack;
10598
10604 attribute unsigned long logHistoryCount;
10605
10610 readonly attribute AudioDriverType defaultAudioDriver;
10611
10622 void getMaxNetworkAdapters (
10623 in ChipsetType chipset,
10624 [retval] out unsigned long maxNetworkAdapters
10625 );
10626
10640 void getMaxNetworkAdaptersOfType (
10641 in ChipsetType chipset,
10642 in NetworkAttachmentType type,
10643 [retval] out unsigned long maxNetworkAdapters
10644 );
10645
10655 void getMaxDevicesPerPortForStorageBus (
10656 in StorageBus bus,
10657 [retval] out unsigned long maxDevicesPerPort
10658 );
10659
10667 void getMinPortCountForStorageBus (
10668 in StorageBus bus,
10669 [retval] out unsigned long minPortCount
10670 );
10671
10679 void getMaxPortCountForStorageBus (
10680 in StorageBus bus,
10681 [retval] out unsigned long maxPortCount
10682 );
10683
10696 void getMaxInstancesOfStorageBus (
10697 in ChipsetType chipset,
10698 in StorageBus bus,
10699 [retval] out unsigned long maxInstances
10700 );
10701
10711 void getDeviceTypesForStorageBus (
10712 in StorageBus bus,
10713 [retval] out DeviceType[] deviceTypes
10714 );
10715
10724 void getDefaultIoCacheSettingForStorageController (
10725 in StorageControllerType controllerType,
10726 [retval] out boolean enabled
10727 );
10728
10729 };
10730
10736 interface IGuestOSType : $unknown
10737 {
10741 readonly attribute wstring familyId;
10742
10746 readonly attribute wstring familyDescription;
10747
10751 readonly attribute wstring id;
10752
10756 readonly attribute wstring description;
10757
10761 readonly attribute boolean is64Bit;
10762
10766 readonly attribute boolean recommendedIOAPIC;
10767
10771 readonly attribute boolean recommendedVirtEx;
10772
10776 readonly attribute unsigned long recommendedRAM;
10777
10781 readonly attribute unsigned long recommendedVRAM;
10782
10786 readonly attribute long long recommendedHDD;
10787
10791 readonly attribute NetworkAdapterType adapterType;
10792
10796 readonly attribute boolean recommendedPae;
10797
10801 readonly attribute StorageControllerType recommendedDvdStorageController;
10802
10806 readonly attribute StorageBus recommendedDvdStorageBus;
10807
10811 readonly attribute StorageControllerType recommendedHdStorageController;
10812
10816 readonly attribute StorageBus recommendedHdStorageBus;
10817
10821 readonly attribute FirmwareType recommendedFirmware;
10822
10826 readonly attribute boolean recommendedUsbHid;
10827
10831 readonly attribute boolean recommendedHpet;
10832
10836 readonly attribute boolean recommendedUsbTablet;
10837
10841 readonly attribute boolean recommendedRtcUseUtc;
10842
10846 readonly attribute ChipsetType recommendedChipset;
10847
10851 readonly attribute AudioControllerType recommendedAudioController;
10852
10853 };
10854
10862 interface IAdditionsFacility : $unknown
10863 {
10867 readonly attribute AdditionsFacilityClass classType;
10868
10875 readonly attribute long long lastUpdated;
10876
10880 readonly attribute wstring name;
10881
10885 readonly attribute AdditionsFacilityStatus status;
10886
10890 readonly attribute AdditionsFacilityType type;
10891
10892 };
10893
10901 interface IGuestDirEntry : $unknown
10902 {
10906 readonly attribute long long nodeId;
10907
10911 readonly attribute wstring name;
10912
10916 readonly attribute GuestDirEntryType type;
10917
10918 };
10919
10933 interface IGuest : $unknown
10934 {
10949 readonly attribute wstring OSTypeId;
10950
10956 readonly attribute AdditionsRunLevelType additionsRunLevel;
10957
10965 readonly attribute wstring additionsVersion;
10966
10973 readonly attribute IAdditionsFacility[] facilities;
10974
10978 attribute unsigned long memoryBalloonSize;
10979
10983 attribute unsigned long statisticsUpdateInterval;
10984
11016 void internalGetStatistics (
11017 out unsigned long cpuUser,
11018 out unsigned long cpuKernel,
11019 out unsigned long cpuIdle,
11020 out unsigned long memTotal,
11021 out unsigned long memFree,
11022 out unsigned long memBalloon,
11023 out unsigned long memShared,
11024 out unsigned long memCache,
11025 out unsigned long pagedTotal,
11026 out unsigned long memAllocTotal,
11027 out unsigned long memFreeTotal,
11028 out unsigned long memBalloonTotal,
11029 out unsigned long memSharedTotal
11030 );
11031
11043 void getFacilityStatus (
11044 in AdditionsFacilityType facility,
11045 out long long timestamp,
11046 [retval] out AdditionsFacilityStatus status
11047 );
11048
11066 void getAdditionsStatus (
11067 in AdditionsRunLevelType level,
11068 [retval] out boolean active
11069 );
11070
11100 void setCredentials (
11101 in wstring userName,
11102 in wstring password,
11103 in wstring domain,
11104 in boolean allowInteractiveLogon
11105 );
11106
11158 void executeProcess (
11159 in wstring execName,
11160 in unsigned long flags,
11161 in wstring[] arguments,
11162 in wstring[] environment,
11163 in wstring userName,
11164 in wstring password,
11165 in unsigned long timeoutMS,
11166 out unsigned long pid,
11167 [retval] out IProgress progress
11168 );
11169
11206 void getProcessOutput (
11207 in unsigned long pid,
11208 in unsigned long flags,
11209 in unsigned long timeoutMS,
11210 in long long size,
11211 [retval] out octet[] data
11212 );
11213
11244 void getProcessStatus (
11245 in unsigned long pid,
11246 out unsigned long exitcode,
11247 out unsigned long flags,
11248 [retval] out ExecuteProcessStatus reason
11249 );
11250
11287 void copyFromGuest (
11288 in wstring source,
11289 in wstring dest,
11290 in wstring userName,
11291 in wstring password,
11292 in unsigned long flags,
11293 [retval] out IProgress progress
11294 );
11295
11332 void copyToGuest (
11333 in wstring source,
11334 in wstring dest,
11335 in wstring userName,
11336 in wstring password,
11337 in unsigned long flags,
11338 [retval] out IProgress progress
11339 );
11340
11358 void directoryClose (
11359 in unsigned long handle
11360 );
11361
11396 void directoryCreate (
11397 in wstring directory,
11398 in wstring userName,
11399 in wstring password,
11400 in unsigned long mode,
11401 in unsigned long flags
11402 );
11403
11443 void directoryOpen (
11444 in wstring directory,
11445 in wstring filter,
11446 in unsigned long flags,
11447 in wstring userName,
11448 in wstring password,
11449 [retval] out unsigned long handle
11450 );
11451
11473 void directoryRead (
11474 in unsigned long handle,
11475 [retval] out IGuestDirEntry entry
11476 );
11477
11509 void fileExists (
11510 in wstring file,
11511 in wstring userName,
11512 in wstring password,
11513 [retval] out boolean exists
11514 );
11515
11549 void setProcessInput (
11550 in unsigned long pid,
11551 in unsigned long flags,
11552 in unsigned long timeoutMS,
11553 in octet[] data,
11554 [retval] out unsigned long written
11555 );
11556
11580 void updateGuestAdditions (
11581 in wstring source,
11582 in unsigned long flags,
11583 [retval] out IProgress progress
11584 );
11585
11586 };
11587
11628 interface IProgress : $unknown
11629 {
11633 readonly attribute wstringUUID id;
11634
11638 readonly attribute wstring description;
11639
11643 readonly attribute $unknown initiator;
11644
11648 readonly attribute boolean cancelable;
11649
11657 readonly attribute unsigned long percent;
11658
11672 readonly attribute long timeRemaining;
11673
11677 readonly attribute boolean completed;
11678
11682 readonly attribute boolean canceled;
11683
11690 readonly attribute long resultCode;
11691
11701 readonly attribute IVirtualBoxErrorInfo errorInfo;
11702
11709 readonly attribute unsigned long operationCount;
11710
11714 readonly attribute unsigned long operation;
11715
11721 readonly attribute wstring operationDescription;
11722
11726 readonly attribute unsigned long operationPercent;
11727
11731 readonly attribute unsigned long operationWeight;
11732
11740 attribute unsigned long timeout;
11741
11745 void setCurrentOperationProgress (
11746 in unsigned long percent
11747 );
11748
11752 void setNextOperation (
11753 in wstring nextOperationDescription,
11754 in unsigned long nextOperationsWeight
11755 );
11756
11783 void waitForCompletion (
11784 in long timeout
11785 );
11786
11810 void waitForOperationCompletion (
11811 in unsigned long operation,
11812 in long timeout
11813 );
11814
11840 void waitForAsyncProgressCompletion (
11841 in IProgress pProgressAsync
11842 );
11843
11860 void cancel();
11861
11862 };
11863
11947 interface ISnapshot : $unknown
11948 {
11952 readonly attribute wstringUUID id;
11953
11961 attribute wstring name;
11962
11970 attribute wstring description;
11971
11977 readonly attribute long long timeStamp;
11978
11990 readonly attribute boolean online;
11991
12003 readonly attribute IMachine machine;
12004
12011 readonly attribute ISnapshot parent;
12012
12021 readonly attribute ISnapshot[] children;
12022
12030 void getChildrenCount (
12031 [retval] out unsigned long childrenCount
12032 );
12033
12034 };
12035
12222 interface IMediumAttachment : $unknown
12223 {
12228 readonly attribute IMedium medium;
12229
12235 readonly attribute wstring controller;
12236
12242 readonly attribute long port;
12243
12249 readonly attribute long device;
12250
12254 readonly attribute DeviceType type;
12255
12259 readonly attribute boolean passthrough;
12260
12264 readonly attribute boolean temporaryEject;
12265
12270 readonly attribute boolean isEjected;
12271
12275 readonly attribute IBandwidthGroup bandwidthGroup;
12276
12277 };
12278
12436 interface IMedium : $unknown
12437 {
12451 readonly attribute wstringUUID id;
12452
12471 attribute wstring description;
12472
12488 readonly attribute MediumState state;
12489
12498 readonly attribute unsigned long variant;
12499
12521 attribute wstring location;
12522
12542 readonly attribute wstring name;
12543
12548 readonly attribute DeviceType deviceType;
12549
12553 readonly attribute boolean hostDrive;
12554
12567 readonly attribute long long size;
12568
12583 readonly attribute wstring format;
12584
12600 readonly attribute IMediumFormat mediumFormat;
12601
12626 attribute MediumType type;
12627
12637 readonly attribute IMedium parent;
12638
12646 readonly attribute IMedium[] children;
12647
12658 readonly attribute IMedium base;
12659
12692 readonly attribute boolean readOnly;
12693
12714 readonly attribute long long logicalSize;
12715
12743 attribute boolean autoReset;
12744
12759 readonly attribute wstring lastAccessError;
12760
12777 readonly attribute wstringUUID[] machineIds;
12778
12804 void setIDs (
12805 in boolean setImageId,
12806 in wstringUUID imageId,
12807 in boolean setParentId,
12808 in wstringUUID parentId
12809 );
12810
12845 void refreshState (
12846 [retval] out MediumState state
12847 );
12848
12875 void getSnapshotIds (
12876 in wstringUUID machineId,
12877 [retval] out wstringUUID[] snapshotIds
12878 );
12879
12939 void lockRead (
12940 [retval] out MediumState state
12941 );
12942
12965 void unlockRead (
12966 [retval] out MediumState state
12967 );
12968
13023 void lockWrite (
13024 [retval] out MediumState state
13025 );
13026
13049 void unlockWrite (
13050 [retval] out MediumState state
13051 );
13052
13102 void close();
13103
13133 void getProperty (
13134 in wstring name,
13135 [retval] out wstring value
13136 );
13137
13169 void setProperty (
13170 in wstring name,
13171 in wstring value
13172 );
13173
13208 void getProperties (
13209 in wstring names,
13210 out wstring[] returnNames,
13211 [retval] out wstring[] returnValues
13212 );
13213
13243 void setProperties (
13244 in wstring[] names,
13245 in wstring[] values
13246 );
13247
13280 void createBaseStorage (
13281 in long long logicalSize,
13282 in unsigned long variant,
13283 [retval] out IProgress progress
13284 );
13285
13337 void deleteStorage (
13338 [retval] out IProgress progress
13339 );
13340
13379 void createDiffStorage (
13380 in IMedium target,
13381 in unsigned long variant,
13382 [retval] out IProgress progress
13383 );
13384
13460 void mergeTo (
13461 in IMedium target,
13462 [retval] out IProgress progress
13463 );
13464
13514 void cloneTo (
13515 in IMedium target,
13516 in unsigned long variant,
13517 in IMedium parent,
13518 [retval] out IProgress progress
13519 );
13520
13549 void compact (
13550 [retval] out IProgress progress
13551 );
13552
13585 void resize (
13586 in long long logicalSize,
13587 [retval] out IProgress progress
13588 );
13589
13623 void reset (
13624 [retval] out IProgress progress
13625 );
13626
13627 };
13628
13651 interface IMediumFormat : $unknown
13652 {
13671 readonly attribute wstring id;
13672
13680 readonly attribute wstring name;
13681
13690 readonly attribute unsigned long capabilities;
13691
13710 void describeFileExtensions (
13711 out wstring[] extensions,
13712 out DeviceType[] type
13713 );
13714
13742 void describeProperties (
13743 out wstring[] names,
13744 out wstring[] description,
13745 out DataType[] types,
13746 out unsigned long[] flags,
13747 out wstring[] defaults
13748 );
13749
13750 };
13751
13764 interface IKeyboard : $unknown
13765 {
13771 readonly attribute IEventSource eventSource;
13772
13785 void putScancode (
13786 in long scancode
13787 );
13788
13801 void putScancodes (
13802 in long[] scancodes,
13803 [retval] out unsigned long codesStored
13804 );
13805
13820 void putCAD();
13821
13822 };
13823
13835 interface IMouse : $unknown
13836 {
13851 readonly attribute boolean absoluteSupported;
13852
13867 readonly attribute boolean relativeSupported;
13868
13883 readonly attribute boolean needsHostCursor;
13884
13890 readonly attribute IEventSource eventSource;
13891
13957 void putMouseEvent (
13958 in long dx,
13959 in long dy,
13960 in long dz,
13961 in long dw,
13962 in long buttonState
13963 );
13964
14037 void putMouseEventAbsolute (
14038 in long x,
14039 in long y,
14040 in long dz,
14041 in long dw,
14042 in long buttonState
14043 );
14044
14045 };
14046
14047 interface IFramebuffer : $unknown
14048 {
14057 readonly attribute octetPtr address;
14058
14062 readonly attribute unsigned long width;
14063
14067 readonly attribute unsigned long height;
14068
14075 readonly attribute unsigned long bitsPerPixel;
14076
14083 readonly attribute unsigned long bytesPerLine;
14084
14095 readonly attribute unsigned long pixelFormat;
14096
14103 readonly attribute boolean usesGuestVRAM;
14104
14114 readonly attribute unsigned long heightReduction;
14115
14130 readonly attribute IFramebufferOverlay overlay;
14131
14138 readonly attribute long long winId;
14139
14147 void lock();
14148
14156 void unlock();
14157
14165 void notifyUpdate (
14166 in unsigned long x,
14167 in unsigned long y,
14168 in unsigned long width,
14169 in unsigned long height
14170 );
14171
14284 void requestResize (
14285 in unsigned long screenId,
14286 in unsigned long pixelFormat,
14287 in octetPtr VRAM,
14288 in unsigned long bitsPerPixel,
14289 in unsigned long bytesPerLine,
14290 in unsigned long width,
14291 in unsigned long height,
14292 [retval] out boolean finished
14293 );
14294
14306 void videoModeSupported (
14307 in unsigned long width,
14308 in unsigned long height,
14309 in unsigned long bpp,
14310 [retval] out boolean supported
14311 );
14312
14349 void getVisibleRegion (
14350 in octetPtr rectangles,
14351 in unsigned long count,
14352 [retval] out unsigned long countCopied
14353 );
14354
14389 void setVisibleRegion (
14390 in octetPtr rectangles,
14391 in unsigned long count
14392 );
14393
14414 void processVHWACommand (
14415 in octetPtr command
14416 );
14417
14418 };
14419
14434 interface IFramebufferOverlay : IFramebuffer
14435 {
14439 readonly attribute unsigned long x;
14440
14444 readonly attribute unsigned long y;
14445
14451 attribute boolean visible;
14452
14459 attribute unsigned long alpha;
14460
14466 void move (
14467 in unsigned long x,
14468 in unsigned long y
14469 );
14470
14471 };
14472
14488 interface IDisplay : $unknown
14489 {
14493 void getScreenResolution (
14494 in unsigned long screenId,
14495 out unsigned long width,
14496 out unsigned long height,
14497 out unsigned long bitsPerPixel
14498 );
14499
14505 void setFramebuffer (
14506 in unsigned long screenId,
14507 in IFramebuffer framebuffer
14508 );
14509
14515 void getFramebuffer (
14516 in unsigned long screenId,
14517 out IFramebuffer framebuffer,
14518 out long xOrigin,
14519 out long yOrigin
14520 );
14521
14550 void setVideoModeHint (
14551 in unsigned long width,
14552 in unsigned long height,
14553 in unsigned long bitsPerPixel,
14554 in unsigned long display
14555 );
14556
14568 void setSeamlessMode (
14569 in boolean enabled
14570 );
14571
14607 void takeScreenShot (
14608 in unsigned long screenId,
14609 in octetPtr address,
14610 in unsigned long width,
14611 in unsigned long height
14612 );
14613
14657 void takeScreenShotToArray (
14658 in unsigned long screenId,
14659 in unsigned long width,
14660 in unsigned long height,
14661 [retval] out octet[] screenData
14662 );
14663
14702 void takeScreenShotPNGToArray (
14703 in unsigned long screenId,
14704 in unsigned long width,
14705 in unsigned long height,
14706 [retval] out octet[] screenData
14707 );
14708
14760 void drawToScreen (
14761 in unsigned long screenId,
14762 in octetPtr address,
14763 in unsigned long x,
14764 in unsigned long y,
14765 in unsigned long width,
14766 in unsigned long height
14767 );
14768
14783 void invalidateAndUpdate();
14784
14798 void resizeCompleted (
14799 in unsigned long screenId
14800 );
14801
14814 void completeVHWACommand (
14815 in octetPtr command
14816 );
14817
14818 };
14819
14835 interface INetworkAdapter : $unknown
14836 {
14844 attribute NetworkAdapterType adapterType;
14845
14853 readonly attribute unsigned long slot;
14854
14863 attribute boolean enabled;
14864
14871 attribute wstring MACAddress;
14872
14878 attribute NetworkAttachmentType attachmentType;
14879
14885 attribute wstring bridgedInterface;
14886
14892 attribute wstring hostOnlyInterface;
14893
14899 attribute wstring internalNetwork;
14900
14906 attribute wstring NATNetwork;
14907
14913 attribute wstring genericDriver;
14914
14921 attribute boolean cableConnected;
14922
14928 attribute unsigned long lineSpeed;
14929
14936 attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
14937
14944 attribute boolean traceEnabled;
14945
14952 attribute wstring traceFile;
14953
14961 readonly attribute INATEngine natDriver;
14962
14969 attribute unsigned long bootPriority;
14970
14974 attribute IBandwidthGroup bandwidthGroup;
14975
14994 void getProperty (
14995 in wstring key,
14996 [retval] out wstring value
14997 );
14998
15017 void setProperty (
15018 in wstring key,
15019 in wstring value
15020 );
15021
15049 void getProperties (
15050 in wstring names,
15051 out wstring[] returnNames,
15052 [retval] out wstring[] returnValues
15053 );
15054
15055 };
15056
15085 interface ISerialPort : $unknown
15086 {
15094 readonly attribute unsigned long slot;
15095
15102 attribute boolean enabled;
15103
15107 attribute unsigned long IOBase;
15108
15112 attribute unsigned long IRQ;
15113
15124 attribute PortMode hostMode;
15125
15133 attribute boolean server;
15134
15144 attribute wstring path;
15145
15146 };
15147
15167 interface IParallelPort : $unknown
15168 {
15176 readonly attribute unsigned long slot;
15177
15184 attribute boolean enabled;
15185
15189 attribute unsigned long IOBase;
15190
15194 attribute unsigned long IRQ;
15195
15203 attribute wstring path;
15204
15205 };
15206
15207 interface IMachineDebugger : $unknown
15208 {
15212 attribute boolean singlestep;
15213
15217 attribute boolean recompileUser;
15218
15222 attribute boolean recompileSupervisor;
15223
15227 attribute boolean PATMEnabled;
15228
15232 attribute boolean CSAMEnabled;
15233
15237 attribute boolean logEnabled;
15238
15242 readonly attribute wstring logFlags;
15243
15247 readonly attribute wstring logGroups;
15248
15252 readonly attribute wstring logDestinations;
15253
15260 readonly attribute boolean HWVirtExEnabled;
15261
15268 readonly attribute boolean HWVirtExNestedPagingEnabled;
15269
15276 readonly attribute boolean HWVirtExVPIDEnabled;
15277
15286 readonly attribute wstring OSName;
15287
15296 readonly attribute wstring OSVersion;
15297
15304 readonly attribute boolean PAEEnabled;
15305
15312 attribute unsigned long virtualTimeRate;
15313
15320 readonly attribute long long VM;
15321
15337 void dumpGuestCore (
15338 in wstring filename,
15339 in wstring compression
15340 );
15341
15358 void dumpHostProcessCore (
15359 in wstring filename,
15360 in wstring compression
15361 );
15362
15383 void info (
15384 in wstring name,
15385 in wstring args,
15386 [retval] out wstring info
15387 );
15388
15394 void injectNMI();
15395
15406 void modifyLogGroups (
15407 in wstring settings
15408 );
15409
15420 void modifyLogFlags (
15421 in wstring settings
15422 );
15423
15434 void modifyLogDestinations (
15435 in wstring settings
15436 );
15437
15452 void readPhysicalMemory (
15453 in long long address,
15454 in unsigned long size,
15455 [retval] out octet[] bytes
15456 );
15457
15472 void writePhysicalMemory (
15473 in long long address,
15474 in unsigned long size,
15475 in octet[] bytes
15476 );
15477
15494 void readVirtualMemory (
15495 in unsigned long cpuId,
15496 in long long address,
15497 in unsigned long size,
15498 [retval] out octet[] bytes
15499 );
15500
15517 void writeVirtualMemory (
15518 in unsigned long cpuId,
15519 in long long address,
15520 in unsigned long size,
15521 in octet[] bytes
15522 );
15523
15536 void detectOS (
15537 [retval] out wstring os
15538 );
15539
15557 void getRegister (
15558 in unsigned long cpuId,
15559 in wstring name,
15560 [retval] out wstring value
15561 );
15562
15580 void getRegisters (
15581 in unsigned long cpuId,
15582 out wstring[] names,
15583 out wstring[] values
15584 );
15585
15604 void setRegister (
15605 in unsigned long cpuId,
15606 in wstring name,
15607 in wstring value
15608 );
15609
15628 void setRegisters (
15629 in unsigned long cpuId,
15630 in wstring[] names,
15631 in wstring[] values
15632 );
15633
15646 void dumpGuestStack (
15647 in unsigned long cpuId,
15648 [retval] out wstring stack
15649 );
15650
15658 void resetStats (
15659 in wstring pattern
15660 );
15661
15669 void dumpStats (
15670 in wstring pattern
15671 );
15672
15684 void getStats (
15685 in wstring pattern,
15686 in boolean withDescriptions,
15687 out wstring stats
15688 );
15689
15690 };
15691
15692 interface IUSBController : $unknown
15693 {
15702 attribute boolean enabled;
15703
15712 attribute boolean enabledEhci;
15713
15719 readonly attribute boolean proxyAvailable;
15720
15728 readonly attribute unsigned short USBStandard;
15729
15755 readonly attribute IUSBDeviceFilter[] deviceFilters;
15756
15784 void createDeviceFilter (
15785 in wstring name,
15786 [retval] out IUSBDeviceFilter filter
15787 );
15788
15833 void insertDeviceFilter (
15834 in unsigned long position,
15835 in IUSBDeviceFilter filter
15836 );
15837
15870 void removeDeviceFilter (
15871 in unsigned long position,
15872 [retval] out IUSBDeviceFilter filter
15873 );
15874
15875 };
15876
15889 interface IUSBDevice : $unknown
15890 {
15897 readonly attribute wstringUUID id;
15898
15902 readonly attribute unsigned short vendorId;
15903
15907 readonly attribute unsigned short productId;
15908
15916 readonly attribute unsigned short revision;
15917
15921 readonly attribute wstring manufacturer;
15922
15926 readonly attribute wstring product;
15927
15931 readonly attribute wstring serialNumber;
15932
15936 readonly attribute wstring address;
15937
15944 readonly attribute unsigned short port;
15945
15951 readonly attribute unsigned short version;
15952
15960 readonly attribute unsigned short portVersion;
15961
15968 readonly attribute boolean remote;
15969
15970 };
15971
16046 interface IUSBDeviceFilter : $unknown
16047 {
16055 attribute wstring name;
16056
16060 attribute boolean active;
16061
16069 attribute wstring vendorId;
16070
16078 attribute wstring productId;
16079
16093 attribute wstring revision;
16094
16099 attribute wstring manufacturer;
16100
16105 attribute wstring product;
16106
16111 attribute wstring serialNumber;
16112
16117 attribute wstring port;
16118
16128 attribute wstring remote;
16129
16139 attribute unsigned long maskedInterfaces;
16140
16141 };
16142
16159 interface IHostUSBDevice : IUSBDevice
16160 {
16166 readonly attribute USBDeviceState state;
16167
16168 };
16169
16192 interface IHostUSBDeviceFilter : IUSBDeviceFilter
16193 {
16200 attribute USBDeviceFilterAction action;
16201
16202 };
16203
16212 interface IAudioAdapter : $unknown
16213 {
16222 attribute boolean enabled;
16223
16229 attribute AudioControllerType audioController;
16230
16237 attribute AudioDriverType audioDriver;
16238
16239 };
16240
16241 interface IVRDEServer : $unknown
16242 {
16246 attribute boolean enabled;
16247
16251 attribute AuthType authType;
16252
16256 attribute unsigned long authTimeout;
16257
16264 attribute boolean allowMultiConnection;
16265
16273 attribute boolean reuseSingleConnection;
16274
16281 attribute wstring VRDEExtPack;
16282
16289 attribute wstring authLibrary;
16290
16296 readonly attribute wstring[] VRDEProperties;
16297
16311 void setVRDEProperty (
16312 in wstring key,
16313 in wstring value
16314 );
16315
16329 void getVRDEProperty (
16330 in wstring key,
16331 [retval] out wstring value
16332 );
16333
16334 };
16335
16393 interface ISharedFolder : $unknown
16394 {
16398 readonly attribute wstring name;
16399
16403 readonly attribute wstring hostPath;
16404
16414 readonly attribute boolean accessible;
16415
16422 readonly attribute boolean writable;
16423
16429 readonly attribute boolean autoMount;
16430
16443 readonly attribute wstring lastAccessError;
16444
16445 };
16446
16447 interface IInternalSessionControl : $unknown
16448 {
16453 void getPID (
16454 [retval] out unsigned long pid
16455 );
16456
16478 void getRemoteConsole (
16479 [retval] out IConsole console
16480 );
16481
16505 void assignMachine (
16506 in IMachine machine
16507 );
16508
16523 void assignRemoteMachine (
16524 in IMachine machine,
16525 in IConsole console
16526 );
16527
16551 void updateMachineState (
16552 in MachineState aMachineState
16553 );
16554
16570 void uninitialize();
16571
16594 void onNetworkAdapterChange (
16595 in INetworkAdapter networkAdapter,
16596 in boolean changeAdapter
16597 );
16598
16621 void onSerialPortChange (
16622 in ISerialPort serialPort
16623 );
16624
16647 void onParallelPortChange (
16648 in IParallelPort parallelPort
16649 );
16650
16673 void onStorageControllerChange();
16674
16701 void onMediumChange (
16702 in IMediumAttachment mediumAttachment,
16703 in boolean force
16704 );
16705
16732 void onStorageDeviceChange (
16733 in IMediumAttachment mediumAttachment,
16734 in boolean remove
16735 );
16736
16746 void onCPUChange (
16747 in unsigned long cpu,
16748 in boolean add
16749 );
16750
16758 void onCPUExecutionCapChange (
16759 in unsigned long executionCap
16760 );
16761
16786 void onVRDEServerChange (
16787 in boolean restart
16788 );
16789
16812 void onUSBControllerChange();
16813
16842 void onSharedFolderChange (
16843 in boolean global
16844 );
16845
16871 void onUSBDeviceAttach (
16872 in IUSBDevice device,
16873 in IVirtualBoxErrorInfo error,
16874 in unsigned long maskedInterfaces
16875 );
16876
16902 void onUSBDeviceDetach (
16903 in wstringUUID id,
16904 in IVirtualBoxErrorInfo error
16905 );
16906
16924 void onShowWindow (
16925 in boolean check,
16926 out boolean canShow,
16927 out long long winId
16928 );
16929
16937 void onBandwidthGroupChange (
16938 in IBandwidthGroup bandwidthGroup
16939 );
16940
16964 void accessGuestProperty (
16965 in wstring name,
16966 in wstring value,
16967 in wstring flags,
16968 in boolean isSetter,
16969 out wstring retValue,
16970 out long long retTimestamp,
16971 out wstring retFlags
16972 );
16973
17021 void enumerateGuestProperties (
17022 in wstring patterns,
17023 out wstring[] key,
17024 out wstring[] value,
17025 out long long[] timestamp,
17026 out wstring[] flags
17027 );
17028
17074 void onlineMergeMedium (
17075 in IMediumAttachment mediumAttachment,
17076 in unsigned long sourceIdx,
17077 in unsigned long targetIdx,
17078 in IMedium source,
17079 in IMedium target,
17080 in boolean mergeForward,
17081 in IMedium parentForTarget,
17082 in IMedium[] childrenToReparent,
17083 in IProgress progress
17084 );
17085
17086 };
17087
17146 interface ISession : $unknown
17147 {
17151 readonly attribute SessionState state;
17152
17160 readonly attribute SessionType type;
17161
17165 readonly attribute IMachine machine;
17166
17170 readonly attribute IConsole console;
17171
17203 void unlockMachine();
17204
17205 };
17206
17229 interface IStorageController : $unknown
17230 {
17239 readonly attribute wstring name;
17240
17246 readonly attribute unsigned long maxDevicesPerPortCount;
17247
17253 readonly attribute unsigned long minPortCount;
17254
17260 readonly attribute unsigned long maxPortCount;
17261
17267 attribute unsigned long instance;
17268
17277 attribute unsigned long portCount;
17278
17284 readonly attribute StorageBus bus;
17285
17298 attribute StorageControllerType controllerType;
17299
17314 attribute boolean useHostIOCache;
17315
17321 readonly attribute boolean bootable;
17322
17345 void getIDEEmulationPort (
17346 in long devicePosition,
17347 [retval] out long portNumber
17348 );
17349
17373 void setIDEEmulationPort (
17374 in long devicePosition,
17375 in long portNumber
17376 );
17377
17378 };
17379
17403 interface IManagedObjectRef : $unknown
17404 {
17411 void getInterfaceName (
17412 [retval] out wstring return
17413 );
17414
17422 void release();
17423
17424 };
17425
17434 interface IWebsessionManager : $unknown
17435 {
17444 void logon (
17445 in wstring username,
17446 in wstring password,
17447 [retval] out IVirtualBox return
17448 );
17449
17459 void getSessionObject (
17460 in IVirtualBox refIVirtualBox,
17461 [retval] out ISession return
17462 );
17463
17471 void logoff (
17472 in IVirtualBox refIVirtualBox
17473 );
17474
17475 };
17476
17485 interface IPerformanceMetric : $unknown
17486 {
17492 readonly attribute wstring metricName;
17493
17499 readonly attribute $unknown object;
17500
17506 readonly attribute wstring description;
17507
17513 readonly attribute unsigned long period;
17514
17524 readonly attribute unsigned long count;
17525
17531 readonly attribute wstring unit;
17532
17538 readonly attribute long minimumValue;
17539
17545 readonly attribute long maximumValue;
17546
17547 };
17548
17655 interface IPerformanceCollector : $unknown
17656 {
17667 readonly attribute wstring[] metricNames;
17668
17692 void getMetrics (
17693 in wstring[] metricNames,
17694 in $unknown[] objects,
17695 [retval] out IPerformanceMetric[] metrics
17696 );
17697
17736 void setupMetrics (
17737 in wstring[] metricNames,
17738 in $unknown[] objects,
17739 in unsigned long period,
17740 in unsigned long count,
17741 [retval] out IPerformanceMetric[] affectedMetrics
17742 );
17743
17772 void enableMetrics (
17773 in wstring[] metricNames,
17774 in $unknown[] objects,
17775 [retval] out IPerformanceMetric[] affectedMetrics
17776 );
17777
17806 void disableMetrics (
17807 in wstring[] metricNames,
17808 in $unknown[] objects,
17809 [retval] out IPerformanceMetric[] affectedMetrics
17810 );
17811
17900 void queryMetricsData (
17901 in wstring[] metricNames,
17902 in $unknown[] objects,
17903 out wstring[] returnMetricNames,
17904 out $unknown[] returnObjects,
17905 out wstring[] returnUnits,
17906 out unsigned long[] returnScales,
17907 out unsigned long[] returnSequenceNumbers,
17908 out unsigned long[] returnDataIndices,
17909 out unsigned long[] returnDataLengths,
17910 [retval] out long[] returnData
17911 );
17912
17913 };
17914
17922 interface INATEngine : $unknown
17923 {
17928 attribute wstring network;
17929
17936 attribute wstring hostIP;
17937
17942 attribute wstring tftpPrefix;
17943
17948 attribute wstring tftpBootFile;
17949
17957 attribute wstring tftpNextServer;
17958
17962 attribute unsigned long aliasMode;
17963
17967 attribute boolean dnsPassDomain;
17968
17973 attribute boolean dnsProxy;
17974
17979 attribute boolean dnsUseHostResolver;
17980
17985 readonly attribute wstring[] redirects;
17986
18002 void setNetworkSettings (
18003 in unsigned long mtu,
18004 in unsigned long sockSnd,
18005 in unsigned long sockRcv,
18006 in unsigned long TcpWndSnd,
18007 in unsigned long TcpWndRcv
18008 );
18009
18014 void getNetworkSettings (
18015 out unsigned long mtu,
18016 out unsigned long sockSnd,
18017 out unsigned long sockRcv,
18018 out unsigned long TcpWndSnd,
18019 out unsigned long TcpWndRcv
18020 );
18021
18041 void addRedirect (
18042 in wstring name,
18043 in NATProtocol proto,
18044 in wstring hostIp,
18045 in unsigned short hostPort,
18046 in wstring guestIp,
18047 in unsigned short guestPort
18048 );
18049
18055 void removeRedirect (
18056 in wstring name
18057 );
18058
18059 };
18060
18069 interface IExtPackPlugIn : $unknown
18070 {
18074 readonly attribute wstring name;
18075
18079 readonly attribute wstring description;
18080
18086 readonly attribute wstring frontend;
18087
18091 readonly attribute wstring modulePath;
18092
18093 };
18094
18103 interface IExtPackBase : $unknown
18104 {
18108 readonly attribute wstring name;
18109
18113 readonly attribute wstring description;
18114
18123 readonly attribute wstring version;
18124
18128 readonly attribute unsigned long revision;
18129
18133 readonly attribute wstring VRDEModule;
18134
18138 readonly attribute IExtPackPlugIn[] plugIns;
18139
18149 readonly attribute boolean usable;
18150
18157 readonly attribute wstring whyUnusable;
18158
18162 readonly attribute boolean showLicense;
18163
18172 readonly attribute wstring license;
18173
18197 void queryLicense (
18198 in wstring preferredLocale,
18199 in wstring preferredLanguage,
18200 in wstring format,
18201 [retval] out wstring licenseText
18202 );
18203
18204 };
18205
18214 interface IExtPack : IExtPackBase
18215 {
18227 void queryObject (
18228 in wstring objUuid,
18229 [retval] out $unknown returnInterface
18230 );
18231
18232 };
18233
18243 interface IExtPackFile : IExtPackBase
18244 {
18250 readonly attribute wstring filePath;
18251
18270 void install (
18271 in boolean replace,
18272 in wstring displayInfo,
18273 [retval] out IProgress progess
18274 );
18275
18276 };
18277
18288 interface IExtPackManager : $unknown
18289 {
18295 readonly attribute IExtPack[] installedExtPacks;
18296
18314 void find (
18315 in wstring name,
18316 [retval] out IExtPack returnData
18317 );
18318
18329 void openExtPackFile (
18330 in wstring path,
18331 [retval] out IExtPackFile file
18332 );
18333
18352 void uninstall (
18353 in wstring name,
18354 in boolean forcedRemoval,
18355 in wstring displayInfo,
18356 [retval] out IProgress progess
18357 );
18358
18362 void cleanup();
18363
18376 void queryAllPlugInsForFrontend (
18377 in wstring frontendName,
18378 [retval] out wstring[] plugInModules
18379 );
18380
18388 void isExtPackUsable (
18389 in wstring name,
18390 [retval] out boolean usable
18391 );
18392
18393 };
18394
18400 interface IBandwidthGroup : $unknown
18401 {
18405 readonly attribute wstring name;
18406
18410 readonly attribute BandwidthGroupType type;
18411
18415 readonly attribute unsigned long reference;
18416
18421 attribute unsigned long maxMbPerSec;
18422
18423 };
18424
18433 interface IBandwidthControl : $unknown
18434 {
18440 readonly attribute unsigned long numGroups;
18441
18454 void createBandwidthGroup (
18455 in wstring name,
18456 in BandwidthGroupType type,
18457 in unsigned long maxMbPerSec
18458 );
18459
18467 void deleteBandwidthGroup (
18468 in wstring name
18469 );
18470
18480 void getBandwidthGroup (
18481 in wstring name,
18482 [retval] out IBandwidthGroup bandwidthGroup
18483 );
18484
18492 void getAllBandwidthGroups (
18493 [retval] out IBandwidthGroup[] bandwidthGroups
18494 );
18495
18496 };
18497
18510 interface IVirtualBoxClient : $unknown
18511 {
18517 readonly attribute IVirtualBox virtualBox;
18518
18524 readonly attribute ISession session;
18525
18531 readonly attribute IEventSource eventSource;
18532
18533 };
18534
18548 interface IEventSource : $unknown
18549 {
18555 void createListener (
18556 [retval] out IEventListener listener
18557 );
18558
18574 void createAggregator (
18575 in IEventSource[] subordinates,
18576 [retval] out IEventSource result
18577 );
18578
18611 void registerListener (
18612 in IEventListener listener,
18613 in VBoxEventType[] interesting,
18614 in boolean active
18615 );
18616
18625 void unregisterListener (
18626 in IEventListener listener
18627 );
18628
18643 void fireEvent (
18644 in IEvent event,
18645 in long timeout,
18646 [retval] out boolean result
18647 );
18648
18673 void getEvent (
18674 in IEventListener listener,
18675 in long timeout,
18676 [retval] out IEvent event
18677 );
18678
18690 void eventProcessed (
18691 in IEventListener listener,
18692 in IEvent event
18693 );
18694
18695 };
18696
18706 interface IEventListener : $unknown
18707 {
18720 void handleEvent (
18721 in IEvent event
18722 );
18723
18724 };
18725
18802 interface IEvent : $unknown
18803 {
18809 readonly attribute VBoxEventType type;
18810
18816 readonly attribute IEventSource source;
18817
18828 readonly attribute boolean waitable;
18829
18836 void setProcessed();
18837
18851 void waitProcessed (
18852 in long timeout,
18853 [retval] out boolean result
18854 );
18855
18856 };
18857
18863 interface IReusableEvent : IEvent
18864 {
18868 readonly attribute unsigned long generation;
18869
18876 void reuse();
18877
18878 };
18879
18885 interface IMachineEvent : IEvent
18886 {
18890 readonly attribute wstringUUID machineId;
18891
18892 };
18893
18899 interface IMachineStateChangedEvent : IMachineEvent
18900 {
18904 readonly attribute MachineState state;
18905
18906 };
18907
18915 interface IMachineDataChangedEvent : IMachineEvent
18916 {
18917 };
18918
18927 interface IMediumRegisteredEvent : IEvent
18928 {
18932 readonly attribute wstringUUID mediumId;
18933
18937 readonly attribute DeviceType mediumType;
18938
18945 readonly attribute boolean registered;
18946
18947 };
18948
18957 interface IMachineRegisteredEvent : IMachineEvent
18958 {
18965 readonly attribute boolean registered;
18966
18967 };
18968
18978 interface ISessionStateChangedEvent : IMachineEvent
18979 {
18985 readonly attribute SessionState state;
18986
18987 };
18988
18996 interface IGuestPropertyChangedEvent : IMachineEvent
18997 {
19003 readonly attribute wstring name;
19004
19010 readonly attribute wstring value;
19011
19017 readonly attribute wstring flags;
19018
19019 };
19020
19026 interface ISnapshotEvent : IMachineEvent
19027 {
19031 readonly attribute wstringUUID snapshotId;
19032
19033 };
19034
19044 interface ISnapshotTakenEvent : ISnapshotEvent
19045 {
19046 };
19047
19064 interface ISnapshotDeletedEvent : ISnapshotEvent
19065 {
19066 };
19067
19077 interface ISnapshotChangedEvent : ISnapshotEvent
19078 {
19079 };
19080
19089 interface IMousePointerShapeChangedEvent : IEvent
19090 {
19096 readonly attribute boolean visible;
19097
19103 readonly attribute boolean alpha;
19104
19110 readonly attribute unsigned long xhot;
19111
19117 readonly attribute unsigned long yhot;
19118
19124 readonly attribute unsigned long width;
19125
19131 readonly attribute unsigned long height;
19132
19165 readonly attribute octet[] shape;
19166
19167 };
19168
19177 interface IMouseCapabilityChangedEvent : IEvent
19178 {
19184 readonly attribute boolean supportsAbsolute;
19185
19191 readonly attribute boolean supportsRelative;
19192
19198 readonly attribute boolean needsHostCursor;
19199
19200 };
19201
19210 interface IKeyboardLedsChangedEvent : IEvent
19211 {
19217 readonly attribute boolean numLock;
19218
19224 readonly attribute boolean capsLock;
19225
19231 readonly attribute boolean scrollLock;
19232
19233 };
19234
19243 interface IStateChangedEvent : IEvent
19244 {
19250 readonly attribute MachineState state;
19251
19252 };
19253
19263 interface IAdditionsStateChangedEvent : IEvent
19264 {
19265 };
19266
19277 interface INetworkAdapterChangedEvent : IEvent
19278 {
19284 readonly attribute INetworkAdapter networkAdapter;
19285
19286 };
19287
19298 interface ISerialPortChangedEvent : IEvent
19299 {
19305 readonly attribute ISerialPort serialPort;
19306
19307 };
19308
19319 interface IParallelPortChangedEvent : IEvent
19320 {
19326 readonly attribute IParallelPort parallelPort;
19327
19328 };
19329
19339 interface IStorageControllerChangedEvent : IEvent
19340 {
19341 };
19342
19352 interface IMediumChangedEvent : IEvent
19353 {
19359 readonly attribute IMediumAttachment mediumAttachment;
19360
19361 };
19362
19370 interface ICPUChangedEvent : IEvent
19371 {
19377 readonly attribute unsigned long cpu;
19378
19384 readonly attribute boolean add;
19385
19386 };
19387
19395 interface ICPUExecutionCapChangedEvent : IEvent
19396 {
19402 readonly attribute unsigned long executionCap;
19403
19404 };
19405
19413 interface IGuestKeyboardEvent : IEvent
19414 {
19420 readonly attribute long[] scancodes;
19421
19422 };
19423
19431 interface IGuestMouseEvent : IReusableEvent
19432 {
19438 readonly attribute boolean absolute;
19439
19445 readonly attribute long x;
19446
19452 readonly attribute long y;
19453
19459 readonly attribute long z;
19460
19466 readonly attribute long w;
19467
19473 readonly attribute long buttons;
19474
19475 };
19476
19487 interface IVRDEServerChangedEvent : IEvent
19488 {
19489 };
19490
19500 interface IVRDEServerInfoChangedEvent : IEvent
19501 {
19502 };
19503
19514 interface IUSBControllerChangedEvent : IEvent
19515 {
19516 };
19517
19541 interface IUSBDeviceStateChangedEvent : IEvent
19542 {
19548 readonly attribute IUSBDevice device;
19549
19555 readonly attribute boolean attached;
19556
19562 readonly attribute IVirtualBoxErrorInfo error;
19563
19564 };
19565
19581 interface ISharedFolderChangedEvent : IEvent
19582 {
19588 readonly attribute Scope scope;
19589
19590 };
19591
19643 interface IRuntimeErrorEvent : IEvent
19644 {
19650 readonly attribute boolean fatal;
19651
19657 readonly attribute wstring id;
19658
19664 readonly attribute wstring message;
19665
19666 };
19667
19675 interface IEventSourceChangedEvent : IEvent
19676 {
19682 readonly attribute IEventListener listener;
19683
19689 readonly attribute boolean add;
19690
19691 };
19692
19701 interface IExtraDataChangedEvent : IEvent
19702 {
19709 readonly attribute wstringUUID machineId;
19710
19716 readonly attribute wstring key;
19717
19723 readonly attribute wstring value;
19724
19725 };
19726
19732 interface IVetoEvent : IEvent
19733 {
19743 void addVeto (
19744 in wstring reason
19745 );
19746
19756 void isVetoed (
19757 [retval] out boolean result
19758 );
19759
19769 void getVetos (
19770 [retval] out wstring[] result
19771 );
19772
19773 };
19774
19784 interface IExtraDataCanChangeEvent : IVetoEvent
19785 {
19792 readonly attribute wstringUUID machineId;
19793
19799 readonly attribute wstring key;
19800
19806 readonly attribute wstring value;
19807
19808 };
19809
19825 interface ICanShowWindowEvent : IVetoEvent
19826 {
19827 };
19828
19860 interface IShowWindowEvent : IEvent
19861 {
19870 attribute long long winId;
19871
19872 };
19873
19881 interface INATRedirectEvent : IMachineEvent
19882 {
19888 readonly attribute unsigned long slot;
19889
19895 readonly attribute boolean remove;
19896
19902 readonly attribute wstring name;
19903
19909 readonly attribute NATProtocol proto;
19910
19916 readonly attribute wstring hostIp;
19917
19923 readonly attribute long hostPort;
19924
19930 readonly attribute wstring guestIp;
19931
19937 readonly attribute long guestPort;
19938
19939 };
19940
19953 interface IHostPciDevicePlugEvent : IMachineEvent
19954 {
19960 readonly attribute boolean plugged;
19961
19968 readonly attribute boolean success;
19969
19975 readonly attribute IPciDeviceAttachment attachment;
19976
19982 readonly attribute wstring message;
19983
19984 };
19985
19994 interface IVBoxSVCAvailabilityChangedEvent : IEvent
19995 {
20001 readonly attribute boolean available;
20002
20003 };
20004
20012 interface IBandwidthGroupChangedEvent : IEvent
20013 {
20019 readonly attribute IBandwidthGroup bandwidthGroup;
20020
20021 };
20022
20030 interface IGuestMonitorChangedEvent : IEvent
20031 {
20037 readonly attribute GuestMonitorChangedEventType changeType;
20038
20044 readonly attribute unsigned long screenId;
20045
20052 readonly attribute unsigned long originX;
20053
20060 readonly attribute unsigned long originY;
20061
20068 readonly attribute unsigned long width;
20069
20076 readonly attribute unsigned long height;
20077
20078 };
20079
20089 interface IStorageDeviceChangedEvent : IEvent
20090 {
20096 readonly attribute IMediumAttachment storageDevice;
20097
20103 readonly attribute boolean removed;
20104
20105 };
20106
20107