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
03490 readonly attribute wstring[] internalNetworks;
03491
03497 readonly attribute wstring[] genericNetworkDrivers;
03498
03538 void composeMachineFilename (
03539 in wstring name,
03540 in wstring baseFolder,
03541 [retval] out wstring file
03542 );
03543
03640 void createMachine (
03641 in wstring settingsFile,
03642 in wstring name,
03643 in wstring osTypeId,
03644 in wstringUUID id,
03645 in boolean forceOverwrite,
03646 [retval] out IMachine machine
03647 );
03648
03674 void openMachine (
03675 in wstring settingsFile,
03676 [retval] out IMachine machine
03677 );
03678
03710 void registerMachine (
03711 in IMachine machine
03712 );
03713
03734 void findMachine (
03735 in wstring nameOrId,
03736 [retval] out IMachine machine
03737 );
03738
03748 void createAppliance (
03749 [retval] out IAppliance appliance
03750 );
03751
03814 void createHardDisk (
03815 in wstring format,
03816 in wstring location,
03817 [retval] out IMedium medium
03818 );
03819
03924 void openMedium (
03925 in wstring location,
03926 in DeviceType deviceType,
03927 in AccessMode accessMode,
03928 in boolean forceNewUuid,
03929 [retval] out IMedium medium
03930 );
03931
03963 void findMedium (
03964 in wstring location,
03965 in DeviceType type,
03966 [retval] out IMedium medium
03967 );
03968
03997 void getGuestOSType (
03998 in wstringUUID id,
03999 [retval] out IGuestOSType type
04000 );
04001
04024 void createSharedFolder (
04025 in wstring name,
04026 in wstring hostPath,
04027 in boolean writable,
04028 in boolean automount
04029 );
04030
04045 void removeSharedFolder (
04046 in wstring name
04047 );
04048
04057 void getExtraDataKeys (
04058 [retval] out wstring[] value
04059 );
04060
04089 void getExtraData (
04090 in wstring key,
04091 [retval] out wstring value
04092 );
04093
04143 void setExtraData (
04144 in wstring key,
04145 in wstring value
04146 );
04147
04164 void createDHCPServer (
04165 in wstring name,
04166 [retval] out IDHCPServer server
04167 );
04168
04185 void findDHCPServerByNetworkName (
04186 in wstring name,
04187 [retval] out IDHCPServer server
04188 );
04189
04204 void removeDHCPServer (
04205 in IDHCPServer server
04206 );
04207
04232 void checkFirmwarePresent (
04233 in FirmwareType firmwareType,
04234 in wstring version,
04235 out wstring url,
04236 out wstring file,
04237 [retval] out boolean result
04238 );
04239
04240 };
04241
04252 interface IVFSExplorer : $unknown
04253 {
04257 readonly attribute wstring path;
04258
04262 readonly attribute VFSType type;
04263
04271 void update (
04272 [retval] out IProgress aProgress
04273 );
04274
04282 void cd (
04283 in wstring aDir,
04284 [retval] out IProgress aProgress
04285 );
04286
04292 void cdUp (
04293 [retval] out IProgress aProgress
04294 );
04295
04308 void entryList (
04309 out wstring[] aNames,
04310 out unsigned long[] aTypes,
04311 out unsigned long[] aSizes,
04312 out unsigned long[] aModes
04313 );
04314
04323 void exists (
04324 in wstring[] aNames,
04325 [retval] out wstring[] aExists
04326 );
04327
04335 void remove (
04336 in wstring[] aNames,
04337 [retval] out IProgress aProgress
04338 );
04339
04340 };
04341
04407 interface IAppliance : $unknown
04408 {
04416 readonly attribute wstring path;
04417
04448 readonly attribute wstring[] disks;
04449
04457 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
04458
04466 readonly attribute wstring[] machines;
04467
04484 void read (
04485 in wstring file,
04486 [retval] out IProgress aProgress
04487 );
04488
04505 void interpret();
04506
04527 void importMachines (
04528 [retval] out IProgress aProgress
04529 );
04530
04538 void createVFSExplorer (
04539 in wstring aUri,
04540 [retval] out IVFSExplorer aExplorer
04541 );
04542
04572 void write (
04573 in wstring format,
04574 in boolean manifest,
04575 in wstring path,
04576 [retval] out IProgress progress
04577 );
04578
04584 void getWarnings (
04585 [retval] out wstring[] aWarnings
04586 );
04587
04588 };
04589
04601 interface IVirtualSystemDescription : $unknown
04602 {
04606 readonly attribute unsigned long count;
04607
04731 void getDescription (
04732 out VirtualSystemDescriptionType[] aTypes,
04733 out wstring[] aRefs,
04734 out wstring[] aOvfValues,
04735 out wstring[] aVBoxValues,
04736 out wstring[] aExtraConfigValues
04737 );
04738
04755 void getDescriptionByType (
04756 in VirtualSystemDescriptionType aType,
04757 out VirtualSystemDescriptionType[] aTypes,
04758 out wstring[] aRefs,
04759 out wstring[] aOvfValues,
04760 out wstring[] aVBoxValues,
04761 out wstring[] aExtraConfigValues
04762 );
04763
04775 void getValuesByType (
04776 in VirtualSystemDescriptionType aType,
04777 in VirtualSystemDescriptionValueType aWhich,
04778 [retval] out wstring[] aValues
04779 );
04780
04806 void setFinalValues (
04807 in boolean[] aEnabled,
04808 in wstring[] aVBoxValues,
04809 in wstring[] aExtraConfigValues
04810 );
04811
04826 void addDescription (
04827 in VirtualSystemDescriptionType aType,
04828 in wstring aVBoxValue,
04829 in wstring aExtraConfigValue
04830 );
04831
04832 };
04833
04834 interface IInternalMachineControl : $unknown
04835 {
04842 void setRemoveSavedStateFile (
04843 in boolean aRemove
04844 );
04845
04857 void updateState (
04858 in MachineState state
04859 );
04860
04861 void getIPCId (
04862 [retval] out wstring id
04863 );
04864
04876 void beginPowerUp (
04877 in IProgress aProgress
04878 );
04879
04889 void endPowerUp (
04890 in long result
04891 );
04892
04904 void beginPoweringDown (
04905 out IProgress progress
04906 );
04907
04937 void endPoweringDown (
04938 in long result,
04939 in wstring errMsg
04940 );
04941
04955 void runUSBDeviceFilters (
04956 in IUSBDevice device,
04957 out boolean matched,
04958 out unsigned long maskedInterfaces
04959 );
04960
04969 void captureUSBDevice (
04970 in wstringUUID id
04971 );
04972
04988 void detachUSBDevice (
04989 in wstringUUID id,
04990 in boolean done
04991 );
04992
05001 void autoCaptureUSBDevices();
05002
05018 void detachAllUSBDevices (
05019 in boolean done
05020 );
05021
05036 void onSessionEnd (
05037 in ISession session,
05038 [retval] out IProgress progress
05039 );
05040
05056 void beginSavingState (
05057 out IProgress progress,
05058 out wstring stateFilePath
05059 );
05060
05090 void endSavingState (
05091 in long result,
05092 in wstring errMsg
05093 );
05094
05109 void adoptSavedState (
05110 in wstring savedStateFile
05111 );
05112
05161 void beginTakingSnapshot (
05162 in IConsole initiator,
05163 in wstring name,
05164 in wstring description,
05165 in IProgress consoleProgress,
05166 in boolean fTakingSnapshotOnline,
05167 out wstring stateFilePath
05168 );
05169
05179 void endTakingSnapshot (
05180 in boolean success
05181 );
05182
05207 void deleteSnapshot (
05208 in IConsole initiator,
05209 in wstringUUID id,
05210 in boolean deleteAllChildren,
05211 out MachineState machineState,
05212 [retval] out IProgress progress
05213 );
05214
05233 void finishOnlineMergeMedium (
05234 in IMediumAttachment mediumAttachment,
05235 in IMedium source,
05236 in IMedium target,
05237 in boolean mergeForward,
05238 in IMedium parentForTarget,
05239 in IMedium[] childrenToReparent
05240 );
05241
05255 void restoreSnapshot (
05256 in IConsole initiator,
05257 in ISnapshot snapshot,
05258 out MachineState machineState,
05259 [retval] out IProgress progress
05260 );
05261
05288 void pullGuestProperties (
05289 out wstring[] name,
05290 out wstring[] value,
05291 out long long[] timestamp,
05292 out wstring[] flags
05293 );
05294
05316 void pushGuestProperty (
05317 in wstring name,
05318 in wstring value,
05319 in long long timestamp,
05320 in wstring flags
05321 );
05322
05334 void lockMedia();
05335
05345 void unlockMedia();
05346
05362 void ejectMedium (
05363 in IMediumAttachment attachment,
05364 [retval] out IMediumAttachment newAttachment
05365 );
05366
05367 };
05368
05377 interface IBIOSSettings : $unknown
05378 {
05382 attribute boolean logoFadeIn;
05383
05387 attribute boolean logoFadeOut;
05388
05392 attribute unsigned long logoDisplayTime;
05393
05400 attribute wstring logoImagePath;
05401
05405 attribute BIOSBootMenuMode bootMenuMode;
05406
05410 attribute boolean ACPIEnabled;
05411
05418 attribute boolean IOAPICEnabled;
05419
05429 attribute long long timeOffset;
05430
05437 attribute boolean PXEDebugEnabled;
05438
05439 };
05440
05448 interface IPciAddress : $unknown
05449 {
05455 attribute short bus;
05456
05462 attribute short device;
05463
05469 attribute short devFunction;
05470
05476 void asLong (
05477 [retval] out long result
05478 );
05479
05485 void fromLong (
05486 in long number
05487 );
05488
05489 };
05490
05498 interface IPciDeviceAttachment : $unknown
05499 {
05505 readonly attribute wstring name;
05506
05512 readonly attribute boolean isPhysicalDevice;
05513
05519 readonly attribute long hostAddress;
05520
05526 readonly attribute long guestAddress;
05527
05528 };
05529
05570 interface IMachine : $unknown
05571 {
05575 readonly attribute IVirtualBox parent;
05576
05626 readonly attribute boolean accessible;
05627
05639 readonly attribute IVirtualBoxErrorInfo accessError;
05640
05680 attribute wstring name;
05681
05692 attribute wstring description;
05693
05697 readonly attribute wstringUUID id;
05698
05713 attribute wstring OSTypeId;
05714
05718 attribute wstring hardwareVersion;
05719
05729 attribute wstringUUID hardwareUUID;
05730
05734 attribute unsigned long CPUCount;
05735
05741 attribute boolean CPUHotPlugEnabled;
05742
05750 attribute unsigned long CPUExecutionCap;
05751
05755 attribute unsigned long memorySize;
05756
05760 attribute unsigned long memoryBalloonSize;
05761
05768 attribute boolean pageFusionEnabled;
05769
05773 attribute unsigned long VRAMSize;
05774
05780 attribute boolean accelerate3DEnabled;
05781
05787 attribute boolean accelerate2DVideoEnabled;
05788
05799 attribute unsigned long monitorCount;
05800
05804 readonly attribute IBIOSSettings BIOSSettings;
05805
05810 attribute FirmwareType firmwareType;
05811
05817 attribute PointingHidType pointingHidType;
05818
05824 attribute KeyboardHidType keyboardHidType;
05825
05832 attribute boolean hpetEnabled;
05833
05837 attribute ChipsetType chipsetType;
05838
05872 attribute wstring snapshotFolder;
05873
05877 readonly attribute IVRDEServer VRDEServer;
05878
05879 attribute boolean emulatedUSBWebcameraEnabled;
05880
05881 attribute boolean emulatedUSBCardReaderEnabled;
05882
05886 readonly attribute IMediumAttachment[] mediumAttachments;
05887
05899 readonly attribute IUSBController USBController;
05900
05904 readonly attribute IAudioAdapter audioAdapter;
05905
05909 readonly attribute IStorageController[] storageControllers;
05910
05916 readonly attribute wstring settingsFilePath;
05917
05942 readonly attribute boolean settingsModified;
05943
05947 readonly attribute SessionState sessionState;
05948
05961 readonly attribute wstring sessionType;
05962
05972 readonly attribute unsigned long sessionPid;
05973
05977 readonly attribute MachineState state;
05978
05985 readonly attribute long long lastStateChange;
05986
05998 readonly attribute wstring stateFilePath;
05999
06009 readonly attribute wstring logFolder;
06010
06021 readonly attribute ISnapshot currentSnapshot;
06022
06029 readonly attribute unsigned long snapshotCount;
06030
06062 readonly attribute boolean currentStateModified;
06063
06075 readonly attribute ISharedFolder[] sharedFolders;
06076
06083 attribute ClipboardMode clipboardMode;
06084
06092 attribute wstring guestPropertyNotificationPatterns;
06093
06102 attribute boolean teleporterEnabled;
06103
06114 attribute unsigned long teleporterPort;
06115
06122 attribute wstring teleporterAddress;
06123
06131 attribute wstring teleporterPassword;
06132
06140 attribute FaultToleranceState faultToleranceState;
06141
06148 attribute unsigned long faultTolerancePort;
06149
06155 attribute wstring faultToleranceAddress;
06156
06164 attribute wstring faultTolerancePassword;
06165
06171 attribute unsigned long faultToleranceSyncInterval;
06172
06180 attribute boolean RTCUseUTC;
06181
06188 attribute boolean ioCacheEnabled;
06189
06195 attribute unsigned long ioCacheSize;
06196
06202 readonly attribute IBandwidthControl bandwidthControl;
06203
06213 readonly attribute IPciDeviceAttachment[] pciDeviceAssignments;
06214
06320 void lockMachine (
06321 in ISession session,
06322 in LockType lockType
06323 );
06324
06454 void launchVMProcess (
06455 in ISession session,
06456 in wstring type,
06457 in wstring environment,
06458 [retval] out IProgress progress
06459 );
06460
06498 void setBootOrder (
06499 in unsigned long position,
06500 in DeviceType device
06501 );
06502
06537 void getBootOrder (
06538 in unsigned long position,
06539 [retval] out DeviceType device
06540 );
06541
06643 void attachDevice (
06644 in wstring name,
06645 in long controllerPort,
06646 in long device,
06647 in DeviceType type,
06648 in IMedium medium
06649 );
06650
06703 void detachDevice (
06704 in wstring name,
06705 in long controllerPort,
06706 in long device
06707 );
06708
06751 void passthroughDevice (
06752 in wstring name,
06753 in long controllerPort,
06754 in long device,
06755 in boolean passthrough
06756 );
06757
06800 void temporaryEjectDevice (
06801 in wstring name,
06802 in long controllerPort,
06803 in long device,
06804 in boolean temporaryEject
06805 );
06806
06852 void nonRotationalDevice (
06853 in wstring name,
06854 in long controllerPort,
06855 in long device,
06856 in boolean nonRotational
06857 );
06858
06899 void setBandwidthGroupForDevice (
06900 in wstring name,
06901 in long controllerPort,
06902 in long device,
06903 in IBandwidthGroup bandwidthGroup
06904 );
06905
06968 void mountMedium (
06969 in wstring name,
06970 in long controllerPort,
06971 in long device,
06972 in IMedium medium,
06973 in boolean force
06974 );
06975
07004 void getMedium (
07005 in wstring name,
07006 in long controllerPort,
07007 in long device,
07008 [retval] out IMedium medium
07009 );
07010
07025 void getMediumAttachmentsOfController (
07026 in wstring name,
07027 [retval] out IMediumAttachment[] mediumAttachments
07028 );
07029
07044 void getMediumAttachment (
07045 in wstring name,
07046 in long controllerPort,
07047 in long device,
07048 [retval] out IMediumAttachment attachment
07049 );
07050
07091 void attachHostPciDevice (
07092 in long hostAddress,
07093 in long desiredGuestAddress,
07094 in boolean tryToUnbind
07095 );
07096
07137 void detachHostPciDevice (
07138 in long hostAddress
07139 );
07140
07158 void getNetworkAdapter (
07159 in unsigned long slot,
07160 [retval] out INetworkAdapter adapter
07161 );
07162
07195 void addStorageController (
07196 in wstring name,
07197 in StorageBus connectionType,
07198 [retval] out IStorageController controller
07199 );
07200
07214 void getStorageControllerByName (
07215 in wstring name,
07216 [retval] out IStorageController storageController
07217 );
07218
07232 void getStorageControllerByInstance (
07233 in unsigned long instance,
07234 [retval] out IStorageController storageController
07235 );
07236
07250 void removeStorageController (
07251 in wstring name
07252 );
07253
07275 void setStorageControllerBootable (
07276 in wstring name,
07277 in boolean bootable
07278 );
07279
07297 void getSerialPort (
07298 in unsigned long slot,
07299 [retval] out ISerialPort port
07300 );
07301
07319 void getParallelPort (
07320 in unsigned long slot,
07321 [retval] out IParallelPort port
07322 );
07323
07332 void getExtraDataKeys (
07333 [retval] out wstring[] value
07334 );
07335
07364 void getExtraData (
07365 in wstring key,
07366 [retval] out wstring value
07367 );
07368
07418 void setExtraData (
07419 in wstring key,
07420 in wstring value
07421 );
07422
07444 void getCPUProperty (
07445 in CPUPropertyType property,
07446 [retval] out boolean value
07447 );
07448
07470 void setCPUProperty (
07471 in CPUPropertyType property,
07472 in boolean value
07473 );
07474
07514 void getCPUIDLeaf (
07515 in unsigned long id,
07516 out unsigned long valEax,
07517 out unsigned long valEbx,
07518 out unsigned long valEcx,
07519 out unsigned long valEdx
07520 );
07521
07565 void setCPUIDLeaf (
07566 in unsigned long id,
07567 in unsigned long valEax,
07568 in unsigned long valEbx,
07569 in unsigned long valEcx,
07570 in unsigned long valEdx
07571 );
07572
07590 void removeCPUIDLeaf (
07591 in unsigned long id
07592 );
07593
07599 void removeAllCPUIDLeaves();
07600
07622 void getHWVirtExProperty (
07623 in HWVirtExPropertyType property,
07624 [retval] out boolean value
07625 );
07626
07648 void setHWVirtExProperty (
07649 in HWVirtExPropertyType property,
07650 in boolean value
07651 );
07652
07698 void saveSettings();
07699
07723 void discardSettings();
07724
07808 void unregister (
07809 in CleanupMode cleanupMode,
07810 [retval] out IMedium[] aMedia
07811 );
07812
07869 void delete (
07870 in IMedium[] aMedia,
07871 [retval] out IProgress aProgress
07872 );
07873
07885 void export (
07886 in IAppliance aAppliance,
07887 in wstring location,
07888 [retval] out IVirtualSystemDescription aDescription
07889 );
07890
07914 void findSnapshot (
07915 in wstring nameOrId,
07916 [retval] out ISnapshot snapshot
07917 );
07918
07952 void createSharedFolder (
07953 in wstring name,
07954 in wstring hostPath,
07955 in boolean writable,
07956 in boolean automount
07957 );
07958
07984 void removeSharedFolder (
07985 in wstring name
07986 );
07987
08011 void canShowConsoleWindow (
08012 [retval] out boolean canShow
08013 );
08014
08049 void showConsoleWindow (
08050 [retval] out long long winId
08051 );
08052
08085 void getGuestProperty (
08086 in wstring name,
08087 out wstring value,
08088 out long long timestamp,
08089 out wstring flags
08090 );
08091
08114 void getGuestPropertyValue (
08115 in wstring property,
08116 [retval] out wstring value
08117 );
08118
08141 void getGuestPropertyTimestamp (
08142 in wstring property,
08143 [retval] out long long value
08144 );
08145
08196 void setGuestProperty (
08197 in wstring property,
08198 in wstring value,
08199 in wstring flags
08200 );
08201
08242 void setGuestPropertyValue (
08243 in wstring property,
08244 in wstring value
08245 );
08246
08277 void enumerateGuestProperties (
08278 in wstring patterns,
08279 out wstring[] name,
08280 out wstring[] value,
08281 out long long[] timestamp,
08282 out wstring[] flags
08283 );
08284
08302 void querySavedGuestSize (
08303 in unsigned long screenId,
08304 out unsigned long width,
08305 out unsigned long height
08306 );
08307
08329 void querySavedThumbnailSize (
08330 in unsigned long screenId,
08331 out unsigned long size,
08332 out unsigned long width,
08333 out unsigned long height
08334 );
08335
08362 void readSavedThumbnailToArray (
08363 in unsigned long screenId,
08364 in boolean BGR,
08365 out unsigned long width,
08366 out unsigned long height,
08367 [retval] out octet[] data
08368 );
08369
08391 void readSavedThumbnailPNGToArray (
08392 in unsigned long screenId,
08393 out unsigned long width,
08394 out unsigned long height,
08395 [retval] out octet[] data
08396 );
08397
08419 void querySavedScreenshotPNGSize (
08420 in unsigned long screenId,
08421 out unsigned long size,
08422 out unsigned long width,
08423 out unsigned long height
08424 );
08425
08447 void readSavedScreenshotPNGToArray (
08448 in unsigned long screenId,
08449 out unsigned long width,
08450 out unsigned long height,
08451 [retval] out octet[] data
08452 );
08453
08463 void hotPlugCPU (
08464 in unsigned long cpu
08465 );
08466
08476 void hotUnplugCPU (
08477 in unsigned long cpu
08478 );
08479
08493 void getCPUStatus (
08494 in unsigned long cpu,
08495 [retval] out boolean attached
08496 );
08497
08512 void queryLogFilename (
08513 in unsigned long idx,
08514 [retval] out wstring filename
08515 );
08516
08542 void readLog (
08543 in unsigned long idx,
08544 in long long offset,
08545 in long long size,
08546 [retval] out octet[] data
08547 );
08548
08581 void cloneTo (
08582 in IMachine target,
08583 in CloneMode mode,
08584 in CloneOptions[] options,
08585 [retval] out IProgress progress
08586 );
08587
08588 };
08589
08598 interface IVRDEServerInfo : $unknown
08599 {
08605 readonly attribute boolean active;
08606
08615 readonly attribute long port;
08616
08622 readonly attribute unsigned long numberOfClients;
08623
08629 readonly attribute long long beginTime;
08630
08637 readonly attribute long long endTime;
08638
08644 readonly attribute long long bytesSent;
08645
08651 readonly attribute long long bytesSentTotal;
08652
08658 readonly attribute long long bytesReceived;
08659
08665 readonly attribute long long bytesReceivedTotal;
08666
08672 readonly attribute wstring user;
08673
08679 readonly attribute wstring domain;
08680
08686 readonly attribute wstring clientName;
08687
08693 readonly attribute wstring clientIP;
08694
08700 readonly attribute unsigned long clientVersion;
08701
08709 readonly attribute unsigned long encryptionStyle;
08710
08711 };
08712
08734 interface IConsole : $unknown
08735 {
08747 readonly attribute IMachine machine;
08748
08762 readonly attribute MachineState state;
08763
08767 readonly attribute IGuest guest;
08768
08779 readonly attribute IKeyboard keyboard;
08780
08791 readonly attribute IMouse mouse;
08792
08802 readonly attribute IDisplay display;
08803
08807 readonly attribute IMachineDebugger debugger;
08808
08819 readonly attribute IUSBDevice[] USBDevices;
08820
08828 readonly attribute IHostUSBDevice[] remoteUSBDevices;
08829
08845 readonly attribute ISharedFolder[] sharedFolders;
08846
08852 readonly attribute IVRDEServerInfo VRDEServerInfo;
08853
08859 readonly attribute IEventSource eventSource;
08860
08864 readonly attribute IPciDeviceAttachment[] attachedPciDevices;
08865
08874 attribute boolean useHostClipboard;
08875
08940 void powerUp (
08941 [retval] out IProgress progress
08942 );
08943
08977 void powerUpPaused (
08978 [retval] out IProgress progress
08979 );
08980
09000 void powerDown (
09001 [retval] out IProgress progress
09002 );
09003
09023 void reset();
09024
09044 void pause();
09045
09065 void resume();
09066
09086 void powerButton();
09087
09107 void sleepButton();
09108
09120 void getPowerButtonHandled (
09121 [retval] out boolean handled
09122 );
09123
09137 void getGuestEnteredACPIMode (
09138 [retval] out boolean entered
09139 );
09140
09193 void saveState (
09194 [retval] out IProgress progress
09195 );
09196
09229 void adoptSavedState (
09230 in wstring savedStateFile
09231 );
09232
09263 void discardSavedState (
09264 in boolean fRemoveFile
09265 );
09266
09279 void getDeviceActivity (
09280 in DeviceType type,
09281 [retval] out DeviceActivity activity
09282 );
09283
09321 void attachUSBDevice (
09322 in wstringUUID id
09323 );
09324
09359 void detachUSBDevice (
09360 in wstringUUID id,
09361 [retval] out IUSBDevice device
09362 );
09363
09386 void findUSBDeviceByAddress (
09387 in wstring name,
09388 [retval] out IUSBDevice device
09389 );
09390
09410 void findUSBDeviceById (
09411 in wstringUUID id,
09412 [retval] out IUSBDevice device
09413 );
09414
09448 void createSharedFolder (
09449 in wstring name,
09450 in wstring hostPath,
09451 in boolean writable,
09452 in boolean automount
09453 );
09454
09479 void removeSharedFolder (
09480 in wstring name
09481 );
09482
09520 void takeSnapshot (
09521 in wstring name,
09522 in wstring description,
09523 [retval] out IProgress progress
09524 );
09525
09598 void deleteSnapshot (
09599 in wstringUUID id,
09600 [retval] out IProgress progress
09601 );
09602
09642 void deleteSnapshotAndAllChildren (
09643 in wstringUUID id,
09644 [retval] out IProgress progress
09645 );
09646
09687 void restoreSnapshot (
09688 in ISnapshot snapshot,
09689 [retval] out IProgress progress
09690 );
09691
09730 void teleport (
09731 in wstring hostname,
09732 in unsigned long tcpport,
09733 in wstring password,
09734 in unsigned long maxDowntime,
09735 [retval] out IProgress progress
09736 );
09737
09738 };
09739
09750 interface IHostNetworkInterface : $unknown
09751 {
09755 readonly attribute wstring name;
09756
09760 readonly attribute wstringUUID id;
09761
09765 readonly attribute wstring networkName;
09766
09770 readonly attribute boolean dhcpEnabled;
09771
09775 readonly attribute wstring IPAddress;
09776
09780 readonly attribute wstring networkMask;
09781
09785 readonly attribute boolean IPV6Supported;
09786
09790 readonly attribute wstring IPV6Address;
09791
09795 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
09796
09800 readonly attribute wstring hardwareAddress;
09801
09805 readonly attribute HostNetworkInterfaceMediumType mediumType;
09806
09810 readonly attribute HostNetworkInterfaceStatus status;
09811
09815 readonly attribute HostNetworkInterfaceType interfaceType;
09816
09828 void enableStaticIpConfig (
09829 in wstring IPAddress,
09830 in wstring networkMask
09831 );
09832
09844 void enableStaticIpConfigV6 (
09845 in wstring IPV6Address,
09846 in unsigned long IPV6NetworkMaskPrefixLength
09847 );
09848
09852 void enableDynamicIpConfig();
09853
09857 void dhcpRediscover();
09858
09859 };
09860
09877 interface IHost : $unknown
09878 {
09882 readonly attribute IMedium[] DVDDrives;
09883
09887 readonly attribute IMedium[] floppyDrives;
09888
09902 readonly attribute IHostUSBDevice[] USBDevices;
09903
09927 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
09928
09932 readonly attribute IHostNetworkInterface[] networkInterfaces;
09933
09937 readonly attribute unsigned long processorCount;
09938
09942 readonly attribute unsigned long processorOnlineCount;
09943
09947 readonly attribute unsigned long processorCoreCount;
09948
09952 readonly attribute unsigned long memorySize;
09953
09957 readonly attribute unsigned long memoryAvailable;
09958
09962 readonly attribute wstring operatingSystem;
09963
09967 readonly attribute wstring OSVersion;
09968
09972 readonly attribute long long UTCTime;
09973
09977 readonly attribute boolean Acceleration3DAvailable;
09978
09993 void getProcessorSpeed (
09994 in unsigned long cpuId,
09995 [retval] out unsigned long speed
09996 );
09997
10009 void getProcessorFeature (
10010 in ProcessorFeature feature,
10011 [retval] out boolean supported
10012 );
10013
10032 void getProcessorDescription (
10033 in unsigned long cpuId,
10034 [retval] out wstring description
10035 );
10036
10077 void getProcessorCPUIDLeaf (
10078 in unsigned long cpuId,
10079 in unsigned long leaf,
10080 in unsigned long subLeaf,
10081 out unsigned long valEax,
10082 out unsigned long valEbx,
10083 out unsigned long valEcx,
10084 out unsigned long valEdx
10085 );
10086
10107 void createHostOnlyNetworkInterface (
10108 out IHostNetworkInterface hostInterface,
10109 [retval] out IProgress progress
10110 );
10111
10132 void removeHostOnlyNetworkInterface (
10133 in wstringUUID id,
10134 [retval] out IProgress progress
10135 );
10136
10156 void createUSBDeviceFilter (
10157 in wstring name,
10158 [retval] out IHostUSBDeviceFilter filter
10159 );
10160
10203 void insertUSBDeviceFilter (
10204 in unsigned long position,
10205 in IHostUSBDeviceFilter filter
10206 );
10207
10235 void removeUSBDeviceFilter (
10236 in unsigned long position
10237 );
10238
10256 void findHostDVDDrive (
10257 in wstring name,
10258 [retval] out IMedium drive
10259 );
10260
10278 void findHostFloppyDrive (
10279 in wstring name,
10280 [retval] out IMedium drive
10281 );
10282
10298 void findHostNetworkInterfaceByName (
10299 in wstring name,
10300 [retval] out IHostNetworkInterface networkInterface
10301 );
10302
10318 void findHostNetworkInterfaceById (
10319 in wstringUUID id,
10320 [retval] out IHostNetworkInterface networkInterface
10321 );
10322
10332 void findHostNetworkInterfacesOfType (
10333 in HostNetworkInterfaceType type,
10334 [retval] out IHostNetworkInterface[] networkInterfaces
10335 );
10336
10356 void findUSBDeviceById (
10357 in wstringUUID id,
10358 [retval] out IHostUSBDevice device
10359 );
10360
10383 void findUSBDeviceByAddress (
10384 in wstring name,
10385 [retval] out IHostUSBDevice device
10386 );
10387
10395 void generateMACAddress (
10396 [retval] out wstring address
10397 );
10398
10399 };
10400
10413 interface ISystemProperties : $unknown
10414 {
10418 readonly attribute unsigned long minGuestRAM;
10419
10423 readonly attribute unsigned long maxGuestRAM;
10424
10428 readonly attribute unsigned long minGuestVRAM;
10429
10433 readonly attribute unsigned long maxGuestVRAM;
10434
10438 readonly attribute unsigned long minGuestCPUCount;
10439
10443 readonly attribute unsigned long maxGuestCPUCount;
10444
10448 readonly attribute unsigned long maxGuestMonitors;
10449
10454 readonly attribute long long infoVDSize;
10455
10462 readonly attribute unsigned long serialPortCount;
10463
10470 readonly attribute unsigned long parallelPortCount;
10471
10481 readonly attribute unsigned long maxBootPosition;
10482
10506 attribute wstring defaultMachineFolder;
10507
10532 readonly attribute IMediumFormat[] mediumFormats;
10533
10567 attribute wstring defaultHardDiskFormat;
10568
10574 attribute long long freeDiskSpaceWarning;
10575
10580 attribute unsigned long freeDiskSpacePercentWarning;
10581
10587 attribute long long freeDiskSpaceError;
10588
10593 attribute unsigned long freeDiskSpacePercentError;
10594
10618 attribute wstring VRDEAuthLibrary;
10619
10648 attribute wstring webServiceAuthLibrary;
10649
10663 attribute wstring defaultVRDEExtPack;
10664
10670 attribute unsigned long logHistoryCount;
10671
10676 readonly attribute AudioDriverType defaultAudioDriver;
10677
10688 void getMaxNetworkAdapters (
10689 in ChipsetType chipset,
10690 [retval] out unsigned long maxNetworkAdapters
10691 );
10692
10706 void getMaxNetworkAdaptersOfType (
10707 in ChipsetType chipset,
10708 in NetworkAttachmentType type,
10709 [retval] out unsigned long maxNetworkAdapters
10710 );
10711
10721 void getMaxDevicesPerPortForStorageBus (
10722 in StorageBus bus,
10723 [retval] out unsigned long maxDevicesPerPort
10724 );
10725
10733 void getMinPortCountForStorageBus (
10734 in StorageBus bus,
10735 [retval] out unsigned long minPortCount
10736 );
10737
10745 void getMaxPortCountForStorageBus (
10746 in StorageBus bus,
10747 [retval] out unsigned long maxPortCount
10748 );
10749
10762 void getMaxInstancesOfStorageBus (
10763 in ChipsetType chipset,
10764 in StorageBus bus,
10765 [retval] out unsigned long maxInstances
10766 );
10767
10777 void getDeviceTypesForStorageBus (
10778 in StorageBus bus,
10779 [retval] out DeviceType[] deviceTypes
10780 );
10781
10790 void getDefaultIoCacheSettingForStorageController (
10791 in StorageControllerType controllerType,
10792 [retval] out boolean enabled
10793 );
10794
10795 };
10796
10802 interface IGuestOSType : $unknown
10803 {
10807 readonly attribute wstring familyId;
10808
10812 readonly attribute wstring familyDescription;
10813
10817 readonly attribute wstring id;
10818
10822 readonly attribute wstring description;
10823
10827 readonly attribute boolean is64Bit;
10828
10832 readonly attribute boolean recommendedIOAPIC;
10833
10837 readonly attribute boolean recommendedVirtEx;
10838
10842 readonly attribute unsigned long recommendedRAM;
10843
10847 readonly attribute unsigned long recommendedVRAM;
10848
10852 readonly attribute long long recommendedHDD;
10853
10857 readonly attribute NetworkAdapterType adapterType;
10858
10862 readonly attribute boolean recommendedPae;
10863
10867 readonly attribute StorageControllerType recommendedDvdStorageController;
10868
10872 readonly attribute StorageBus recommendedDvdStorageBus;
10873
10877 readonly attribute StorageControllerType recommendedHdStorageController;
10878
10882 readonly attribute StorageBus recommendedHdStorageBus;
10883
10887 readonly attribute FirmwareType recommendedFirmware;
10888
10892 readonly attribute boolean recommendedUsbHid;
10893
10897 readonly attribute boolean recommendedHpet;
10898
10902 readonly attribute boolean recommendedUsbTablet;
10903
10907 readonly attribute boolean recommendedRtcUseUtc;
10908
10912 readonly attribute ChipsetType recommendedChipset;
10913
10917 readonly attribute AudioControllerType recommendedAudioController;
10918
10919 };
10920
10928 interface IAdditionsFacility : $unknown
10929 {
10933 readonly attribute AdditionsFacilityClass classType;
10934
10941 readonly attribute long long lastUpdated;
10942
10946 readonly attribute wstring name;
10947
10951 readonly attribute AdditionsFacilityStatus status;
10952
10956 readonly attribute AdditionsFacilityType type;
10957
10958 };
10959
10967 interface IGuestDirEntry : $unknown
10968 {
10972 readonly attribute long long nodeId;
10973
10977 readonly attribute wstring name;
10978
10982 readonly attribute GuestDirEntryType type;
10983
10984 };
10985
10999 interface IGuest : $unknown
11000 {
11015 readonly attribute wstring OSTypeId;
11016
11022 readonly attribute AdditionsRunLevelType additionsRunLevel;
11023
11031 readonly attribute wstring additionsVersion;
11032
11039 readonly attribute IAdditionsFacility[] facilities;
11040
11044 attribute unsigned long memoryBalloonSize;
11045
11049 attribute unsigned long statisticsUpdateInterval;
11050
11082 void internalGetStatistics (
11083 out unsigned long cpuUser,
11084 out unsigned long cpuKernel,
11085 out unsigned long cpuIdle,
11086 out unsigned long memTotal,
11087 out unsigned long memFree,
11088 out unsigned long memBalloon,
11089 out unsigned long memShared,
11090 out unsigned long memCache,
11091 out unsigned long pagedTotal,
11092 out unsigned long memAllocTotal,
11093 out unsigned long memFreeTotal,
11094 out unsigned long memBalloonTotal,
11095 out unsigned long memSharedTotal
11096 );
11097
11109 void getFacilityStatus (
11110 in AdditionsFacilityType facility,
11111 out long long timestamp,
11112 [retval] out AdditionsFacilityStatus status
11113 );
11114
11132 void getAdditionsStatus (
11133 in AdditionsRunLevelType level,
11134 [retval] out boolean active
11135 );
11136
11166 void setCredentials (
11167 in wstring userName,
11168 in wstring password,
11169 in wstring domain,
11170 in boolean allowInteractiveLogon
11171 );
11172
11224 void executeProcess (
11225 in wstring execName,
11226 in unsigned long flags,
11227 in wstring[] arguments,
11228 in wstring[] environment,
11229 in wstring userName,
11230 in wstring password,
11231 in unsigned long timeoutMS,
11232 out unsigned long pid,
11233 [retval] out IProgress progress
11234 );
11235
11272 void getProcessOutput (
11273 in unsigned long pid,
11274 in unsigned long flags,
11275 in unsigned long timeoutMS,
11276 in long long size,
11277 [retval] out octet[] data
11278 );
11279
11310 void getProcessStatus (
11311 in unsigned long pid,
11312 out unsigned long exitcode,
11313 out unsigned long flags,
11314 [retval] out ExecuteProcessStatus reason
11315 );
11316
11353 void copyFromGuest (
11354 in wstring source,
11355 in wstring dest,
11356 in wstring userName,
11357 in wstring password,
11358 in unsigned long flags,
11359 [retval] out IProgress progress
11360 );
11361
11398 void copyToGuest (
11399 in wstring source,
11400 in wstring dest,
11401 in wstring userName,
11402 in wstring password,
11403 in unsigned long flags,
11404 [retval] out IProgress progress
11405 );
11406
11424 void directoryClose (
11425 in unsigned long handle
11426 );
11427
11462 void directoryCreate (
11463 in wstring directory,
11464 in wstring userName,
11465 in wstring password,
11466 in unsigned long mode,
11467 in unsigned long flags
11468 );
11469
11509 void directoryOpen (
11510 in wstring directory,
11511 in wstring filter,
11512 in unsigned long flags,
11513 in wstring userName,
11514 in wstring password,
11515 [retval] out unsigned long handle
11516 );
11517
11539 void directoryRead (
11540 in unsigned long handle,
11541 [retval] out IGuestDirEntry entry
11542 );
11543
11575 void fileExists (
11576 in wstring file,
11577 in wstring userName,
11578 in wstring password,
11579 [retval] out boolean exists
11580 );
11581
11615 void setProcessInput (
11616 in unsigned long pid,
11617 in unsigned long flags,
11618 in unsigned long timeoutMS,
11619 in octet[] data,
11620 [retval] out unsigned long written
11621 );
11622
11646 void updateGuestAdditions (
11647 in wstring source,
11648 in unsigned long flags,
11649 [retval] out IProgress progress
11650 );
11651
11652 };
11653
11694 interface IProgress : $unknown
11695 {
11699 readonly attribute wstringUUID id;
11700
11704 readonly attribute wstring description;
11705
11709 readonly attribute $unknown initiator;
11710
11714 readonly attribute boolean cancelable;
11715
11723 readonly attribute unsigned long percent;
11724
11738 readonly attribute long timeRemaining;
11739
11743 readonly attribute boolean completed;
11744
11748 readonly attribute boolean canceled;
11749
11756 readonly attribute long resultCode;
11757
11767 readonly attribute IVirtualBoxErrorInfo errorInfo;
11768
11775 readonly attribute unsigned long operationCount;
11776
11780 readonly attribute unsigned long operation;
11781
11787 readonly attribute wstring operationDescription;
11788
11792 readonly attribute unsigned long operationPercent;
11793
11797 readonly attribute unsigned long operationWeight;
11798
11806 attribute unsigned long timeout;
11807
11811 void setCurrentOperationProgress (
11812 in unsigned long percent
11813 );
11814
11818 void setNextOperation (
11819 in wstring nextOperationDescription,
11820 in unsigned long nextOperationsWeight
11821 );
11822
11849 void waitForCompletion (
11850 in long timeout
11851 );
11852
11876 void waitForOperationCompletion (
11877 in unsigned long operation,
11878 in long timeout
11879 );
11880
11906 void waitForAsyncProgressCompletion (
11907 in IProgress pProgressAsync
11908 );
11909
11926 void cancel();
11927
11928 };
11929
12013 interface ISnapshot : $unknown
12014 {
12018 readonly attribute wstringUUID id;
12019
12027 attribute wstring name;
12028
12036 attribute wstring description;
12037
12043 readonly attribute long long timeStamp;
12044
12056 readonly attribute boolean online;
12057
12069 readonly attribute IMachine machine;
12070
12077 readonly attribute ISnapshot parent;
12078
12087 readonly attribute ISnapshot[] children;
12088
12096 void getChildrenCount (
12097 [retval] out unsigned long childrenCount
12098 );
12099
12100 };
12101
12288 interface IMediumAttachment : $unknown
12289 {
12294 readonly attribute IMedium medium;
12295
12301 readonly attribute wstring controller;
12302
12308 readonly attribute long port;
12309
12315 readonly attribute long device;
12316
12320 readonly attribute DeviceType type;
12321
12325 readonly attribute boolean passthrough;
12326
12330 readonly attribute boolean temporaryEject;
12331
12336 readonly attribute boolean isEjected;
12337
12341 readonly attribute boolean nonRotational;
12342
12346 readonly attribute IBandwidthGroup bandwidthGroup;
12347
12348 };
12349
12507 interface IMedium : $unknown
12508 {
12522 readonly attribute wstringUUID id;
12523
12542 attribute wstring description;
12543
12559 readonly attribute MediumState state;
12560
12569 readonly attribute unsigned long variant;
12570
12592 attribute wstring location;
12593
12613 readonly attribute wstring name;
12614
12619 readonly attribute DeviceType deviceType;
12620
12624 readonly attribute boolean hostDrive;
12625
12638 readonly attribute long long size;
12639
12654 readonly attribute wstring format;
12655
12671 readonly attribute IMediumFormat mediumFormat;
12672
12697 attribute MediumType type;
12698
12712 readonly attribute MediumType[] allowedTypes;
12713
12723 readonly attribute IMedium parent;
12724
12732 readonly attribute IMedium[] children;
12733
12744 readonly attribute IMedium base;
12745
12778 readonly attribute boolean readOnly;
12779
12800 readonly attribute long long logicalSize;
12801
12829 attribute boolean autoReset;
12830
12845 readonly attribute wstring lastAccessError;
12846
12863 readonly attribute wstringUUID[] machineIds;
12864
12890 void setIDs (
12891 in boolean setImageId,
12892 in wstringUUID imageId,
12893 in boolean setParentId,
12894 in wstringUUID parentId
12895 );
12896
12931 void refreshState (
12932 [retval] out MediumState state
12933 );
12934
12961 void getSnapshotIds (
12962 in wstringUUID machineId,
12963 [retval] out wstringUUID[] snapshotIds
12964 );
12965
13025 void lockRead (
13026 [retval] out MediumState state
13027 );
13028
13051 void unlockRead (
13052 [retval] out MediumState state
13053 );
13054
13109 void lockWrite (
13110 [retval] out MediumState state
13111 );
13112
13135 void unlockWrite (
13136 [retval] out MediumState state
13137 );
13138
13188 void close();
13189
13219 void getProperty (
13220 in wstring name,
13221 [retval] out wstring value
13222 );
13223
13255 void setProperty (
13256 in wstring name,
13257 in wstring value
13258 );
13259
13294 void getProperties (
13295 in wstring names,
13296 out wstring[] returnNames,
13297 [retval] out wstring[] returnValues
13298 );
13299
13329 void setProperties (
13330 in wstring[] names,
13331 in wstring[] values
13332 );
13333
13366 void createBaseStorage (
13367 in long long logicalSize,
13368 in unsigned long variant,
13369 [retval] out IProgress progress
13370 );
13371
13423 void deleteStorage (
13424 [retval] out IProgress progress
13425 );
13426
13465 void createDiffStorage (
13466 in IMedium target,
13467 in unsigned long variant,
13468 [retval] out IProgress progress
13469 );
13470
13546 void mergeTo (
13547 in IMedium target,
13548 [retval] out IProgress progress
13549 );
13550
13600 void cloneTo (
13601 in IMedium target,
13602 in unsigned long variant,
13603 in IMedium parent,
13604 [retval] out IProgress progress
13605 );
13606
13635 void compact (
13636 [retval] out IProgress progress
13637 );
13638
13671 void resize (
13672 in long long logicalSize,
13673 [retval] out IProgress progress
13674 );
13675
13709 void reset (
13710 [retval] out IProgress progress
13711 );
13712
13713 };
13714
13737 interface IMediumFormat : $unknown
13738 {
13757 readonly attribute wstring id;
13758
13766 readonly attribute wstring name;
13767
13776 readonly attribute unsigned long capabilities;
13777
13796 void describeFileExtensions (
13797 out wstring[] extensions,
13798 out DeviceType[] type
13799 );
13800
13828 void describeProperties (
13829 out wstring[] names,
13830 out wstring[] description,
13831 out DataType[] types,
13832 out unsigned long[] flags,
13833 out wstring[] defaults
13834 );
13835
13836 };
13837
13850 interface IKeyboard : $unknown
13851 {
13857 readonly attribute IEventSource eventSource;
13858
13871 void putScancode (
13872 in long scancode
13873 );
13874
13887 void putScancodes (
13888 in long[] scancodes,
13889 [retval] out unsigned long codesStored
13890 );
13891
13906 void putCAD();
13907
13908 };
13909
13921 interface IMouse : $unknown
13922 {
13937 readonly attribute boolean absoluteSupported;
13938
13953 readonly attribute boolean relativeSupported;
13954
13969 readonly attribute boolean needsHostCursor;
13970
13976 readonly attribute IEventSource eventSource;
13977
14043 void putMouseEvent (
14044 in long dx,
14045 in long dy,
14046 in long dz,
14047 in long dw,
14048 in long buttonState
14049 );
14050
14123 void putMouseEventAbsolute (
14124 in long x,
14125 in long y,
14126 in long dz,
14127 in long dw,
14128 in long buttonState
14129 );
14130
14131 };
14132
14133 interface IFramebuffer : $unknown
14134 {
14143 readonly attribute octetPtr address;
14144
14148 readonly attribute unsigned long width;
14149
14153 readonly attribute unsigned long height;
14154
14161 readonly attribute unsigned long bitsPerPixel;
14162
14169 readonly attribute unsigned long bytesPerLine;
14170
14181 readonly attribute unsigned long pixelFormat;
14182
14189 readonly attribute boolean usesGuestVRAM;
14190
14200 readonly attribute unsigned long heightReduction;
14201
14216 readonly attribute IFramebufferOverlay overlay;
14217
14224 readonly attribute long long winId;
14225
14233 void lock();
14234
14242 void unlock();
14243
14251 void notifyUpdate (
14252 in unsigned long x,
14253 in unsigned long y,
14254 in unsigned long width,
14255 in unsigned long height
14256 );
14257
14370 void requestResize (
14371 in unsigned long screenId,
14372 in unsigned long pixelFormat,
14373 in octetPtr VRAM,
14374 in unsigned long bitsPerPixel,
14375 in unsigned long bytesPerLine,
14376 in unsigned long width,
14377 in unsigned long height,
14378 [retval] out boolean finished
14379 );
14380
14392 void videoModeSupported (
14393 in unsigned long width,
14394 in unsigned long height,
14395 in unsigned long bpp,
14396 [retval] out boolean supported
14397 );
14398
14435 void getVisibleRegion (
14436 in octetPtr rectangles,
14437 in unsigned long count,
14438 [retval] out unsigned long countCopied
14439 );
14440
14475 void setVisibleRegion (
14476 in octetPtr rectangles,
14477 in unsigned long count
14478 );
14479
14500 void processVHWACommand (
14501 in octetPtr command
14502 );
14503
14504 };
14505
14520 interface IFramebufferOverlay : IFramebuffer
14521 {
14525 readonly attribute unsigned long x;
14526
14530 readonly attribute unsigned long y;
14531
14537 attribute boolean visible;
14538
14545 attribute unsigned long alpha;
14546
14552 void move (
14553 in unsigned long x,
14554 in unsigned long y
14555 );
14556
14557 };
14558
14574 interface IDisplay : $unknown
14575 {
14579 void getScreenResolution (
14580 in unsigned long screenId,
14581 out unsigned long width,
14582 out unsigned long height,
14583 out unsigned long bitsPerPixel
14584 );
14585
14591 void setFramebuffer (
14592 in unsigned long screenId,
14593 in IFramebuffer framebuffer
14594 );
14595
14601 void getFramebuffer (
14602 in unsigned long screenId,
14603 out IFramebuffer framebuffer,
14604 out long xOrigin,
14605 out long yOrigin
14606 );
14607
14636 void setVideoModeHint (
14637 in unsigned long width,
14638 in unsigned long height,
14639 in unsigned long bitsPerPixel,
14640 in unsigned long display
14641 );
14642
14654 void setSeamlessMode (
14655 in boolean enabled
14656 );
14657
14693 void takeScreenShot (
14694 in unsigned long screenId,
14695 in octetPtr address,
14696 in unsigned long width,
14697 in unsigned long height
14698 );
14699
14743 void takeScreenShotToArray (
14744 in unsigned long screenId,
14745 in unsigned long width,
14746 in unsigned long height,
14747 [retval] out octet[] screenData
14748 );
14749
14788 void takeScreenShotPNGToArray (
14789 in unsigned long screenId,
14790 in unsigned long width,
14791 in unsigned long height,
14792 [retval] out octet[] screenData
14793 );
14794
14846 void drawToScreen (
14847 in unsigned long screenId,
14848 in octetPtr address,
14849 in unsigned long x,
14850 in unsigned long y,
14851 in unsigned long width,
14852 in unsigned long height
14853 );
14854
14869 void invalidateAndUpdate();
14870
14884 void resizeCompleted (
14885 in unsigned long screenId
14886 );
14887
14900 void completeVHWACommand (
14901 in octetPtr command
14902 );
14903
14904 };
14905
14921 interface INetworkAdapter : $unknown
14922 {
14930 attribute NetworkAdapterType adapterType;
14931
14939 readonly attribute unsigned long slot;
14940
14949 attribute boolean enabled;
14950
14957 attribute wstring MACAddress;
14958
14964 attribute NetworkAttachmentType attachmentType;
14965
14971 attribute wstring bridgedInterface;
14972
14978 attribute wstring hostOnlyInterface;
14979
14985 attribute wstring internalNetwork;
14986
14992 attribute wstring NATNetwork;
14993
14999 attribute wstring genericDriver;
15000
15007 attribute boolean cableConnected;
15008
15014 attribute unsigned long lineSpeed;
15015
15022 attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
15023
15030 attribute boolean traceEnabled;
15031
15038 attribute wstring traceFile;
15039
15047 readonly attribute INATEngine natDriver;
15048
15055 attribute unsigned long bootPriority;
15056
15060 attribute IBandwidthGroup bandwidthGroup;
15061
15080 void getProperty (
15081 in wstring key,
15082 [retval] out wstring value
15083 );
15084
15103 void setProperty (
15104 in wstring key,
15105 in wstring value
15106 );
15107
15135 void getProperties (
15136 in wstring names,
15137 out wstring[] returnNames,
15138 [retval] out wstring[] returnValues
15139 );
15140
15141 };
15142
15171 interface ISerialPort : $unknown
15172 {
15180 readonly attribute unsigned long slot;
15181
15188 attribute boolean enabled;
15189
15193 attribute unsigned long IOBase;
15194
15198 attribute unsigned long IRQ;
15199
15210 attribute PortMode hostMode;
15211
15219 attribute boolean server;
15220
15230 attribute wstring path;
15231
15232 };
15233
15253 interface IParallelPort : $unknown
15254 {
15262 readonly attribute unsigned long slot;
15263
15270 attribute boolean enabled;
15271
15275 attribute unsigned long IOBase;
15276
15280 attribute unsigned long IRQ;
15281
15289 attribute wstring path;
15290
15291 };
15292
15293 interface IMachineDebugger : $unknown
15294 {
15298 attribute boolean singlestep;
15299
15303 attribute boolean recompileUser;
15304
15308 attribute boolean recompileSupervisor;
15309
15313 attribute boolean PATMEnabled;
15314
15318 attribute boolean CSAMEnabled;
15319
15323 attribute boolean logEnabled;
15324
15328 readonly attribute wstring logFlags;
15329
15333 readonly attribute wstring logGroups;
15334
15338 readonly attribute wstring logDestinations;
15339
15346 readonly attribute boolean HWVirtExEnabled;
15347
15354 readonly attribute boolean HWVirtExNestedPagingEnabled;
15355
15362 readonly attribute boolean HWVirtExVPIDEnabled;
15363
15372 readonly attribute wstring OSName;
15373
15382 readonly attribute wstring OSVersion;
15383
15390 readonly attribute boolean PAEEnabled;
15391
15398 attribute unsigned long virtualTimeRate;
15399
15406 readonly attribute long long VM;
15407
15423 void dumpGuestCore (
15424 in wstring filename,
15425 in wstring compression
15426 );
15427
15444 void dumpHostProcessCore (
15445 in wstring filename,
15446 in wstring compression
15447 );
15448
15469 void info (
15470 in wstring name,
15471 in wstring args,
15472 [retval] out wstring info
15473 );
15474
15480 void injectNMI();
15481
15492 void modifyLogGroups (
15493 in wstring settings
15494 );
15495
15506 void modifyLogFlags (
15507 in wstring settings
15508 );
15509
15520 void modifyLogDestinations (
15521 in wstring settings
15522 );
15523
15538 void readPhysicalMemory (
15539 in long long address,
15540 in unsigned long size,
15541 [retval] out octet[] bytes
15542 );
15543
15558 void writePhysicalMemory (
15559 in long long address,
15560 in unsigned long size,
15561 in octet[] bytes
15562 );
15563
15580 void readVirtualMemory (
15581 in unsigned long cpuId,
15582 in long long address,
15583 in unsigned long size,
15584 [retval] out octet[] bytes
15585 );
15586
15603 void writeVirtualMemory (
15604 in unsigned long cpuId,
15605 in long long address,
15606 in unsigned long size,
15607 in octet[] bytes
15608 );
15609
15622 void detectOS (
15623 [retval] out wstring os
15624 );
15625
15643 void getRegister (
15644 in unsigned long cpuId,
15645 in wstring name,
15646 [retval] out wstring value
15647 );
15648
15666 void getRegisters (
15667 in unsigned long cpuId,
15668 out wstring[] names,
15669 out wstring[] values
15670 );
15671
15690 void setRegister (
15691 in unsigned long cpuId,
15692 in wstring name,
15693 in wstring value
15694 );
15695
15714 void setRegisters (
15715 in unsigned long cpuId,
15716 in wstring[] names,
15717 in wstring[] values
15718 );
15719
15732 void dumpGuestStack (
15733 in unsigned long cpuId,
15734 [retval] out wstring stack
15735 );
15736
15744 void resetStats (
15745 in wstring pattern
15746 );
15747
15755 void dumpStats (
15756 in wstring pattern
15757 );
15758
15770 void getStats (
15771 in wstring pattern,
15772 in boolean withDescriptions,
15773 out wstring stats
15774 );
15775
15776 };
15777
15778 interface IUSBController : $unknown
15779 {
15788 attribute boolean enabled;
15789
15798 attribute boolean enabledEhci;
15799
15805 readonly attribute boolean proxyAvailable;
15806
15814 readonly attribute unsigned short USBStandard;
15815
15841 readonly attribute IUSBDeviceFilter[] deviceFilters;
15842
15870 void createDeviceFilter (
15871 in wstring name,
15872 [retval] out IUSBDeviceFilter filter
15873 );
15874
15919 void insertDeviceFilter (
15920 in unsigned long position,
15921 in IUSBDeviceFilter filter
15922 );
15923
15956 void removeDeviceFilter (
15957 in unsigned long position,
15958 [retval] out IUSBDeviceFilter filter
15959 );
15960
15961 };
15962
15975 interface IUSBDevice : $unknown
15976 {
15983 readonly attribute wstringUUID id;
15984
15988 readonly attribute unsigned short vendorId;
15989
15993 readonly attribute unsigned short productId;
15994
16002 readonly attribute unsigned short revision;
16003
16007 readonly attribute wstring manufacturer;
16008
16012 readonly attribute wstring product;
16013
16017 readonly attribute wstring serialNumber;
16018
16022 readonly attribute wstring address;
16023
16030 readonly attribute unsigned short port;
16031
16037 readonly attribute unsigned short version;
16038
16046 readonly attribute unsigned short portVersion;
16047
16054 readonly attribute boolean remote;
16055
16056 };
16057
16132 interface IUSBDeviceFilter : $unknown
16133 {
16141 attribute wstring name;
16142
16146 attribute boolean active;
16147
16155 attribute wstring vendorId;
16156
16164 attribute wstring productId;
16165
16179 attribute wstring revision;
16180
16185 attribute wstring manufacturer;
16186
16191 attribute wstring product;
16192
16197 attribute wstring serialNumber;
16198
16203 attribute wstring port;
16204
16214 attribute wstring remote;
16215
16225 attribute unsigned long maskedInterfaces;
16226
16227 };
16228
16245 interface IHostUSBDevice : IUSBDevice
16246 {
16252 readonly attribute USBDeviceState state;
16253
16254 };
16255
16278 interface IHostUSBDeviceFilter : IUSBDeviceFilter
16279 {
16286 attribute USBDeviceFilterAction action;
16287
16288 };
16289
16298 interface IAudioAdapter : $unknown
16299 {
16308 attribute boolean enabled;
16309
16315 attribute AudioControllerType audioController;
16316
16323 attribute AudioDriverType audioDriver;
16324
16325 };
16326
16327 interface IVRDEServer : $unknown
16328 {
16332 attribute boolean enabled;
16333
16337 attribute AuthType authType;
16338
16342 attribute unsigned long authTimeout;
16343
16350 attribute boolean allowMultiConnection;
16351
16359 attribute boolean reuseSingleConnection;
16360
16367 attribute wstring VRDEExtPack;
16368
16375 attribute wstring authLibrary;
16376
16382 readonly attribute wstring[] VRDEProperties;
16383
16397 void setVRDEProperty (
16398 in wstring key,
16399 in wstring value
16400 );
16401
16415 void getVRDEProperty (
16416 in wstring key,
16417 [retval] out wstring value
16418 );
16419
16420 };
16421
16479 interface ISharedFolder : $unknown
16480 {
16484 readonly attribute wstring name;
16485
16489 readonly attribute wstring hostPath;
16490
16500 readonly attribute boolean accessible;
16501
16508 readonly attribute boolean writable;
16509
16515 readonly attribute boolean autoMount;
16516
16529 readonly attribute wstring lastAccessError;
16530
16531 };
16532
16533 interface IInternalSessionControl : $unknown
16534 {
16539 void getPID (
16540 [retval] out unsigned long pid
16541 );
16542
16564 void getRemoteConsole (
16565 [retval] out IConsole console
16566 );
16567
16591 void assignMachine (
16592 in IMachine machine
16593 );
16594
16609 void assignRemoteMachine (
16610 in IMachine machine,
16611 in IConsole console
16612 );
16613
16637 void updateMachineState (
16638 in MachineState aMachineState
16639 );
16640
16656 void uninitialize();
16657
16680 void onNetworkAdapterChange (
16681 in INetworkAdapter networkAdapter,
16682 in boolean changeAdapter
16683 );
16684
16707 void onSerialPortChange (
16708 in ISerialPort serialPort
16709 );
16710
16733 void onParallelPortChange (
16734 in IParallelPort parallelPort
16735 );
16736
16759 void onStorageControllerChange();
16760
16787 void onMediumChange (
16788 in IMediumAttachment mediumAttachment,
16789 in boolean force
16790 );
16791
16818 void onStorageDeviceChange (
16819 in IMediumAttachment mediumAttachment,
16820 in boolean remove
16821 );
16822
16832 void onCPUChange (
16833 in unsigned long cpu,
16834 in boolean add
16835 );
16836
16844 void onCPUExecutionCapChange (
16845 in unsigned long executionCap
16846 );
16847
16872 void onVRDEServerChange (
16873 in boolean restart
16874 );
16875
16898 void onUSBControllerChange();
16899
16928 void onSharedFolderChange (
16929 in boolean global
16930 );
16931
16957 void onUSBDeviceAttach (
16958 in IUSBDevice device,
16959 in IVirtualBoxErrorInfo error,
16960 in unsigned long maskedInterfaces
16961 );
16962
16988 void onUSBDeviceDetach (
16989 in wstringUUID id,
16990 in IVirtualBoxErrorInfo error
16991 );
16992
17010 void onShowWindow (
17011 in boolean check,
17012 out boolean canShow,
17013 out long long winId
17014 );
17015
17023 void onBandwidthGroupChange (
17024 in IBandwidthGroup bandwidthGroup
17025 );
17026
17050 void accessGuestProperty (
17051 in wstring name,
17052 in wstring value,
17053 in wstring flags,
17054 in boolean isSetter,
17055 out wstring retValue,
17056 out long long retTimestamp,
17057 out wstring retFlags
17058 );
17059
17107 void enumerateGuestProperties (
17108 in wstring patterns,
17109 out wstring[] key,
17110 out wstring[] value,
17111 out long long[] timestamp,
17112 out wstring[] flags
17113 );
17114
17160 void onlineMergeMedium (
17161 in IMediumAttachment mediumAttachment,
17162 in unsigned long sourceIdx,
17163 in unsigned long targetIdx,
17164 in IMedium source,
17165 in IMedium target,
17166 in boolean mergeForward,
17167 in IMedium parentForTarget,
17168 in IMedium[] childrenToReparent,
17169 in IProgress progress
17170 );
17171
17172 };
17173
17232 interface ISession : $unknown
17233 {
17237 readonly attribute SessionState state;
17238
17246 readonly attribute SessionType type;
17247
17251 readonly attribute IMachine machine;
17252
17256 readonly attribute IConsole console;
17257
17289 void unlockMachine();
17290
17291 };
17292
17315 interface IStorageController : $unknown
17316 {
17325 readonly attribute wstring name;
17326
17332 readonly attribute unsigned long maxDevicesPerPortCount;
17333
17339 readonly attribute unsigned long minPortCount;
17340
17346 readonly attribute unsigned long maxPortCount;
17347
17353 attribute unsigned long instance;
17354
17363 attribute unsigned long portCount;
17364
17370 readonly attribute StorageBus bus;
17371
17384 attribute StorageControllerType controllerType;
17385
17400 attribute boolean useHostIOCache;
17401
17407 readonly attribute boolean bootable;
17408
17431 void getIDEEmulationPort (
17432 in long devicePosition,
17433 [retval] out long portNumber
17434 );
17435
17459 void setIDEEmulationPort (
17460 in long devicePosition,
17461 in long portNumber
17462 );
17463
17464 };
17465
17489 interface IManagedObjectRef : $unknown
17490 {
17497 void getInterfaceName (
17498 [retval] out wstring return
17499 );
17500
17508 void release();
17509
17510 };
17511
17520 interface IWebsessionManager : $unknown
17521 {
17530 void logon (
17531 in wstring username,
17532 in wstring password,
17533 [retval] out IVirtualBox return
17534 );
17535
17545 void getSessionObject (
17546 in IVirtualBox refIVirtualBox,
17547 [retval] out ISession return
17548 );
17549
17557 void logoff (
17558 in IVirtualBox refIVirtualBox
17559 );
17560
17561 };
17562
17571 interface IPerformanceMetric : $unknown
17572 {
17578 readonly attribute wstring metricName;
17579
17585 readonly attribute $unknown object;
17586
17592 readonly attribute wstring description;
17593
17599 readonly attribute unsigned long period;
17600
17610 readonly attribute unsigned long count;
17611
17617 readonly attribute wstring unit;
17618
17624 readonly attribute long minimumValue;
17625
17631 readonly attribute long maximumValue;
17632
17633 };
17634
17741 interface IPerformanceCollector : $unknown
17742 {
17753 readonly attribute wstring[] metricNames;
17754
17778 void getMetrics (
17779 in wstring[] metricNames,
17780 in $unknown[] objects,
17781 [retval] out IPerformanceMetric[] metrics
17782 );
17783
17822 void setupMetrics (
17823 in wstring[] metricNames,
17824 in $unknown[] objects,
17825 in unsigned long period,
17826 in unsigned long count,
17827 [retval] out IPerformanceMetric[] affectedMetrics
17828 );
17829
17858 void enableMetrics (
17859 in wstring[] metricNames,
17860 in $unknown[] objects,
17861 [retval] out IPerformanceMetric[] affectedMetrics
17862 );
17863
17892 void disableMetrics (
17893 in wstring[] metricNames,
17894 in $unknown[] objects,
17895 [retval] out IPerformanceMetric[] affectedMetrics
17896 );
17897
17986 void queryMetricsData (
17987 in wstring[] metricNames,
17988 in $unknown[] objects,
17989 out wstring[] returnMetricNames,
17990 out $unknown[] returnObjects,
17991 out wstring[] returnUnits,
17992 out unsigned long[] returnScales,
17993 out unsigned long[] returnSequenceNumbers,
17994 out unsigned long[] returnDataIndices,
17995 out unsigned long[] returnDataLengths,
17996 [retval] out long[] returnData
17997 );
17998
17999 };
18000
18008 interface INATEngine : $unknown
18009 {
18014 attribute wstring network;
18015
18022 attribute wstring hostIP;
18023
18028 attribute wstring tftpPrefix;
18029
18034 attribute wstring tftpBootFile;
18035
18043 attribute wstring tftpNextServer;
18044
18048 attribute unsigned long aliasMode;
18049
18053 attribute boolean dnsPassDomain;
18054
18059 attribute boolean dnsProxy;
18060
18065 attribute boolean dnsUseHostResolver;
18066
18071 readonly attribute wstring[] redirects;
18072
18088 void setNetworkSettings (
18089 in unsigned long mtu,
18090 in unsigned long sockSnd,
18091 in unsigned long sockRcv,
18092 in unsigned long TcpWndSnd,
18093 in unsigned long TcpWndRcv
18094 );
18095
18100 void getNetworkSettings (
18101 out unsigned long mtu,
18102 out unsigned long sockSnd,
18103 out unsigned long sockRcv,
18104 out unsigned long TcpWndSnd,
18105 out unsigned long TcpWndRcv
18106 );
18107
18127 void addRedirect (
18128 in wstring name,
18129 in NATProtocol proto,
18130 in wstring hostIp,
18131 in unsigned short hostPort,
18132 in wstring guestIp,
18133 in unsigned short guestPort
18134 );
18135
18141 void removeRedirect (
18142 in wstring name
18143 );
18144
18145 };
18146
18155 interface IExtPackPlugIn : $unknown
18156 {
18160 readonly attribute wstring name;
18161
18165 readonly attribute wstring description;
18166
18172 readonly attribute wstring frontend;
18173
18177 readonly attribute wstring modulePath;
18178
18179 };
18180
18189 interface IExtPackBase : $unknown
18190 {
18194 readonly attribute wstring name;
18195
18199 readonly attribute wstring description;
18200
18209 readonly attribute wstring version;
18210
18214 readonly attribute unsigned long revision;
18215
18219 readonly attribute wstring VRDEModule;
18220
18224 readonly attribute IExtPackPlugIn[] plugIns;
18225
18235 readonly attribute boolean usable;
18236
18243 readonly attribute wstring whyUnusable;
18244
18248 readonly attribute boolean showLicense;
18249
18258 readonly attribute wstring license;
18259
18283 void queryLicense (
18284 in wstring preferredLocale,
18285 in wstring preferredLanguage,
18286 in wstring format,
18287 [retval] out wstring licenseText
18288 );
18289
18290 };
18291
18300 interface IExtPack : IExtPackBase
18301 {
18313 void queryObject (
18314 in wstring objUuid,
18315 [retval] out $unknown returnInterface
18316 );
18317
18318 };
18319
18329 interface IExtPackFile : IExtPackBase
18330 {
18336 readonly attribute wstring filePath;
18337
18356 void install (
18357 in boolean replace,
18358 in wstring displayInfo,
18359 [retval] out IProgress progess
18360 );
18361
18362 };
18363
18374 interface IExtPackManager : $unknown
18375 {
18381 readonly attribute IExtPack[] installedExtPacks;
18382
18400 void find (
18401 in wstring name,
18402 [retval] out IExtPack returnData
18403 );
18404
18415 void openExtPackFile (
18416 in wstring path,
18417 [retval] out IExtPackFile file
18418 );
18419
18438 void uninstall (
18439 in wstring name,
18440 in boolean forcedRemoval,
18441 in wstring displayInfo,
18442 [retval] out IProgress progess
18443 );
18444
18448 void cleanup();
18449
18462 void queryAllPlugInsForFrontend (
18463 in wstring frontendName,
18464 [retval] out wstring[] plugInModules
18465 );
18466
18474 void isExtPackUsable (
18475 in wstring name,
18476 [retval] out boolean usable
18477 );
18478
18479 };
18480
18486 interface IBandwidthGroup : $unknown
18487 {
18491 readonly attribute wstring name;
18492
18496 readonly attribute BandwidthGroupType type;
18497
18501 readonly attribute unsigned long reference;
18502
18507 attribute unsigned long maxMbPerSec;
18508
18509 };
18510
18519 interface IBandwidthControl : $unknown
18520 {
18526 readonly attribute unsigned long numGroups;
18527
18540 void createBandwidthGroup (
18541 in wstring name,
18542 in BandwidthGroupType type,
18543 in unsigned long maxMbPerSec
18544 );
18545
18553 void deleteBandwidthGroup (
18554 in wstring name
18555 );
18556
18566 void getBandwidthGroup (
18567 in wstring name,
18568 [retval] out IBandwidthGroup bandwidthGroup
18569 );
18570
18578 void getAllBandwidthGroups (
18579 [retval] out IBandwidthGroup[] bandwidthGroups
18580 );
18581
18582 };
18583
18596 interface IVirtualBoxClient : $unknown
18597 {
18603 readonly attribute IVirtualBox virtualBox;
18604
18610 readonly attribute ISession session;
18611
18617 readonly attribute IEventSource eventSource;
18618
18619 };
18620
18634 interface IEventSource : $unknown
18635 {
18641 void createListener (
18642 [retval] out IEventListener listener
18643 );
18644
18660 void createAggregator (
18661 in IEventSource[] subordinates,
18662 [retval] out IEventSource result
18663 );
18664
18697 void registerListener (
18698 in IEventListener listener,
18699 in VBoxEventType[] interesting,
18700 in boolean active
18701 );
18702
18711 void unregisterListener (
18712 in IEventListener listener
18713 );
18714
18729 void fireEvent (
18730 in IEvent event,
18731 in long timeout,
18732 [retval] out boolean result
18733 );
18734
18759 void getEvent (
18760 in IEventListener listener,
18761 in long timeout,
18762 [retval] out IEvent event
18763 );
18764
18776 void eventProcessed (
18777 in IEventListener listener,
18778 in IEvent event
18779 );
18780
18781 };
18782
18792 interface IEventListener : $unknown
18793 {
18806 void handleEvent (
18807 in IEvent event
18808 );
18809
18810 };
18811
18888 interface IEvent : $unknown
18889 {
18895 readonly attribute VBoxEventType type;
18896
18902 readonly attribute IEventSource source;
18903
18914 readonly attribute boolean waitable;
18915
18922 void setProcessed();
18923
18937 void waitProcessed (
18938 in long timeout,
18939 [retval] out boolean result
18940 );
18941
18942 };
18943
18949 interface IReusableEvent : IEvent
18950 {
18954 readonly attribute unsigned long generation;
18955
18962 void reuse();
18963
18964 };
18965
18971 interface IMachineEvent : IEvent
18972 {
18976 readonly attribute wstringUUID machineId;
18977
18978 };
18979
18985 interface IMachineStateChangedEvent : IMachineEvent
18986 {
18990 readonly attribute MachineState state;
18991
18992 };
18993
19001 interface IMachineDataChangedEvent : IMachineEvent
19002 {
19003 };
19004
19013 interface IMediumRegisteredEvent : IEvent
19014 {
19018 readonly attribute wstringUUID mediumId;
19019
19023 readonly attribute DeviceType mediumType;
19024
19031 readonly attribute boolean registered;
19032
19033 };
19034
19043 interface IMachineRegisteredEvent : IMachineEvent
19044 {
19051 readonly attribute boolean registered;
19052
19053 };
19054
19064 interface ISessionStateChangedEvent : IMachineEvent
19065 {
19071 readonly attribute SessionState state;
19072
19073 };
19074
19082 interface IGuestPropertyChangedEvent : IMachineEvent
19083 {
19089 readonly attribute wstring name;
19090
19096 readonly attribute wstring value;
19097
19103 readonly attribute wstring flags;
19104
19105 };
19106
19112 interface ISnapshotEvent : IMachineEvent
19113 {
19117 readonly attribute wstringUUID snapshotId;
19118
19119 };
19120
19130 interface ISnapshotTakenEvent : ISnapshotEvent
19131 {
19132 };
19133
19150 interface ISnapshotDeletedEvent : ISnapshotEvent
19151 {
19152 };
19153
19163 interface ISnapshotChangedEvent : ISnapshotEvent
19164 {
19165 };
19166
19175 interface IMousePointerShapeChangedEvent : IEvent
19176 {
19182 readonly attribute boolean visible;
19183
19189 readonly attribute boolean alpha;
19190
19196 readonly attribute unsigned long xhot;
19197
19203 readonly attribute unsigned long yhot;
19204
19210 readonly attribute unsigned long width;
19211
19217 readonly attribute unsigned long height;
19218
19251 readonly attribute octet[] shape;
19252
19253 };
19254
19263 interface IMouseCapabilityChangedEvent : IEvent
19264 {
19270 readonly attribute boolean supportsAbsolute;
19271
19277 readonly attribute boolean supportsRelative;
19278
19284 readonly attribute boolean needsHostCursor;
19285
19286 };
19287
19296 interface IKeyboardLedsChangedEvent : IEvent
19297 {
19303 readonly attribute boolean numLock;
19304
19310 readonly attribute boolean capsLock;
19311
19317 readonly attribute boolean scrollLock;
19318
19319 };
19320
19329 interface IStateChangedEvent : IEvent
19330 {
19336 readonly attribute MachineState state;
19337
19338 };
19339
19349 interface IAdditionsStateChangedEvent : IEvent
19350 {
19351 };
19352
19363 interface INetworkAdapterChangedEvent : IEvent
19364 {
19370 readonly attribute INetworkAdapter networkAdapter;
19371
19372 };
19373
19384 interface ISerialPortChangedEvent : IEvent
19385 {
19391 readonly attribute ISerialPort serialPort;
19392
19393 };
19394
19405 interface IParallelPortChangedEvent : IEvent
19406 {
19412 readonly attribute IParallelPort parallelPort;
19413
19414 };
19415
19425 interface IStorageControllerChangedEvent : IEvent
19426 {
19427 };
19428
19438 interface IMediumChangedEvent : IEvent
19439 {
19445 readonly attribute IMediumAttachment mediumAttachment;
19446
19447 };
19448
19456 interface ICPUChangedEvent : IEvent
19457 {
19463 readonly attribute unsigned long cpu;
19464
19470 readonly attribute boolean add;
19471
19472 };
19473
19481 interface ICPUExecutionCapChangedEvent : IEvent
19482 {
19488 readonly attribute unsigned long executionCap;
19489
19490 };
19491
19499 interface IGuestKeyboardEvent : IEvent
19500 {
19506 readonly attribute long[] scancodes;
19507
19508 };
19509
19517 interface IGuestMouseEvent : IReusableEvent
19518 {
19524 readonly attribute boolean absolute;
19525
19531 readonly attribute long x;
19532
19538 readonly attribute long y;
19539
19545 readonly attribute long z;
19546
19552 readonly attribute long w;
19553
19559 readonly attribute long buttons;
19560
19561 };
19562
19573 interface IVRDEServerChangedEvent : IEvent
19574 {
19575 };
19576
19586 interface IVRDEServerInfoChangedEvent : IEvent
19587 {
19588 };
19589
19600 interface IUSBControllerChangedEvent : IEvent
19601 {
19602 };
19603
19627 interface IUSBDeviceStateChangedEvent : IEvent
19628 {
19634 readonly attribute IUSBDevice device;
19635
19641 readonly attribute boolean attached;
19642
19648 readonly attribute IVirtualBoxErrorInfo error;
19649
19650 };
19651
19667 interface ISharedFolderChangedEvent : IEvent
19668 {
19674 readonly attribute Scope scope;
19675
19676 };
19677
19729 interface IRuntimeErrorEvent : IEvent
19730 {
19736 readonly attribute boolean fatal;
19737
19743 readonly attribute wstring id;
19744
19750 readonly attribute wstring message;
19751
19752 };
19753
19761 interface IEventSourceChangedEvent : IEvent
19762 {
19768 readonly attribute IEventListener listener;
19769
19775 readonly attribute boolean add;
19776
19777 };
19778
19787 interface IExtraDataChangedEvent : IEvent
19788 {
19795 readonly attribute wstringUUID machineId;
19796
19802 readonly attribute wstring key;
19803
19809 readonly attribute wstring value;
19810
19811 };
19812
19818 interface IVetoEvent : IEvent
19819 {
19829 void addVeto (
19830 in wstring reason
19831 );
19832
19842 void isVetoed (
19843 [retval] out boolean result
19844 );
19845
19855 void getVetos (
19856 [retval] out wstring[] result
19857 );
19858
19859 };
19860
19870 interface IExtraDataCanChangeEvent : IVetoEvent
19871 {
19878 readonly attribute wstringUUID machineId;
19879
19885 readonly attribute wstring key;
19886
19892 readonly attribute wstring value;
19893
19894 };
19895
19911 interface ICanShowWindowEvent : IVetoEvent
19912 {
19913 };
19914
19946 interface IShowWindowEvent : IEvent
19947 {
19956 attribute long long winId;
19957
19958 };
19959
19967 interface INATRedirectEvent : IMachineEvent
19968 {
19974 readonly attribute unsigned long slot;
19975
19981 readonly attribute boolean remove;
19982
19988 readonly attribute wstring name;
19989
19995 readonly attribute NATProtocol proto;
19996
20002 readonly attribute wstring hostIp;
20003
20009 readonly attribute long hostPort;
20010
20016 readonly attribute wstring guestIp;
20017
20023 readonly attribute long guestPort;
20024
20025 };
20026
20039 interface IHostPciDevicePlugEvent : IMachineEvent
20040 {
20046 readonly attribute boolean plugged;
20047
20054 readonly attribute boolean success;
20055
20061 readonly attribute IPciDeviceAttachment attachment;
20062
20068 readonly attribute wstring message;
20069
20070 };
20071
20080 interface IVBoxSVCAvailabilityChangedEvent : IEvent
20081 {
20087 readonly attribute boolean available;
20088
20089 };
20090
20098 interface IBandwidthGroupChangedEvent : IEvent
20099 {
20105 readonly attribute IBandwidthGroup bandwidthGroup;
20106
20107 };
20108
20116 interface IGuestMonitorChangedEvent : IEvent
20117 {
20123 readonly attribute GuestMonitorChangedEventType changeType;
20124
20130 readonly attribute unsigned long screenId;
20131
20138 readonly attribute unsigned long originX;
20139
20146 readonly attribute unsigned long originY;
20147
20154 readonly attribute unsigned long width;
20155
20162 readonly attribute unsigned long height;
20163
20164 };
20165
20175 interface IStorageDeviceChangedEvent : IEvent
20176 {
20182 readonly attribute IMediumAttachment storageDevice;
20183
20189 readonly attribute boolean removed;
20190
20191 };
20192
20193