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
01167 enum ImportOptions
01168 {
01173 ImportOptions_KeepAllMACs = 1,
01178 ImportOptions_KeepNATMACs = 2,
01179 };
01180
01187 enum VirtualSystemDescriptionType
01188 {
01189 VirtualSystemDescriptionType_Ignore = 1,
01190 VirtualSystemDescriptionType_OS = 2,
01191 VirtualSystemDescriptionType_Name = 3,
01192 VirtualSystemDescriptionType_Product = 4,
01193 VirtualSystemDescriptionType_Vendor = 5,
01194 VirtualSystemDescriptionType_Version = 6,
01195 VirtualSystemDescriptionType_ProductUrl = 7,
01196 VirtualSystemDescriptionType_VendorUrl = 8,
01197 VirtualSystemDescriptionType_Description = 9,
01198 VirtualSystemDescriptionType_License = 10,
01199 VirtualSystemDescriptionType_Miscellaneous = 11,
01200 VirtualSystemDescriptionType_CPU = 12,
01201 VirtualSystemDescriptionType_Memory = 13,
01202 VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
01203 VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
01204 VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
01205 VirtualSystemDescriptionType_HardDiskControllerSAS = 17,
01206 VirtualSystemDescriptionType_HardDiskImage = 18,
01207 VirtualSystemDescriptionType_Floppy = 19,
01208 VirtualSystemDescriptionType_CDROM = 20,
01209 VirtualSystemDescriptionType_NetworkAdapter = 21,
01210 VirtualSystemDescriptionType_USBController = 22,
01211 VirtualSystemDescriptionType_SoundCard = 23,
01216 VirtualSystemDescriptionType_SettingsFile = 24,
01217 };
01218
01225 enum VirtualSystemDescriptionValueType
01226 {
01227 VirtualSystemDescriptionValueType_Reference = 1,
01228 VirtualSystemDescriptionValueType_Original = 2,
01229 VirtualSystemDescriptionValueType_Auto = 3,
01230 VirtualSystemDescriptionValueType_ExtraConfig = 4,
01231 };
01232
01239 enum CleanupMode
01240 {
01245 CleanupMode_UnregisterOnly = 1,
01250 CleanupMode_DetachAllReturnNone = 2,
01255 CleanupMode_DetachAllReturnHardDisksOnly = 3,
01260 CleanupMode_Full = 4,
01261 };
01262
01270 enum CloneMode
01271 {
01276 CloneMode_MachineState = 1,
01281 CloneMode_MachineAndChildStates = 2,
01286 CloneMode_AllStates = 3,
01287 };
01288
01296 enum CloneOptions
01297 {
01302 CloneOptions_Link = 1,
01307 CloneOptions_KeepAllMACs = 2,
01312 CloneOptions_KeepNATMACs = 3,
01317 CloneOptions_KeepDiskNames = 4,
01318 };
01319
01330 enum HostNetworkInterfaceMediumType
01331 {
01338 HostNetworkInterfaceMediumType_Unknown = 0,
01345 HostNetworkInterfaceMediumType_Ethernet = 1,
01352 HostNetworkInterfaceMediumType_PPP = 2,
01359 HostNetworkInterfaceMediumType_SLIP = 3,
01360 };
01361
01371 enum HostNetworkInterfaceStatus
01372 {
01379 HostNetworkInterfaceStatus_Unknown = 0,
01386 HostNetworkInterfaceStatus_Up = 1,
01393 HostNetworkInterfaceStatus_Down = 2,
01394 };
01395
01403 enum HostNetworkInterfaceType
01404 {
01405 HostNetworkInterfaceType_Bridged = 1,
01406 HostNetworkInterfaceType_HostOnly = 2,
01407 };
01408
01416 enum AdditionsFacilityType
01417 {
01422 AdditionsFacilityType_None = 0,
01427 AdditionsFacilityType_VBoxGuestDriver = 20,
01432 AdditionsFacilityType_VBoxService = 100,
01437 AdditionsFacilityType_VBoxTrayClient = 101,
01442 AdditionsFacilityType_Seamless = 1000,
01450 AdditionsFacilityType_Graphics = 1100,
01455 AdditionsFacilityType_All = 2147483646,
01456 };
01457
01465 enum AdditionsFacilityClass
01466 {
01471 AdditionsFacilityClass_None = 0,
01476 AdditionsFacilityClass_Driver = 10,
01481 AdditionsFacilityClass_Service = 30,
01486 AdditionsFacilityClass_Program = 50,
01491 AdditionsFacilityClass_Feature = 100,
01496 AdditionsFacilityClass_ThirdParty = 999,
01501 AdditionsFacilityClass_All = 2147483646,
01502 };
01503
01511 enum AdditionsFacilityStatus
01512 {
01517 AdditionsFacilityStatus_Inactive = 0,
01522 AdditionsFacilityStatus_Paused = 1,
01527 AdditionsFacilityStatus_PreInit = 20,
01532 AdditionsFacilityStatus_Init = 30,
01537 AdditionsFacilityStatus_Active = 50,
01542 AdditionsFacilityStatus_Terminating = 100,
01547 AdditionsFacilityStatus_Terminated = 101,
01552 AdditionsFacilityStatus_Failed = 800,
01557 AdditionsFacilityStatus_Unknown = 999,
01558 };
01559
01567 enum AdditionsRunLevelType
01568 {
01573 AdditionsRunLevelType_None = 0,
01578 AdditionsRunLevelType_System = 1,
01583 AdditionsRunLevelType_Userland = 2,
01588 AdditionsRunLevelType_Desktop = 3,
01589 };
01590
01598 enum AdditionsUpdateFlag
01599 {
01604 AdditionsUpdateFlag_None = 0,
01610 AdditionsUpdateFlag_WaitForUpdateStartOnly = 1,
01611 };
01612
01620 enum ExecuteProcessFlag
01621 {
01626 ExecuteProcessFlag_None = 0,
01632 ExecuteProcessFlag_WaitForProcessStartOnly = 1,
01637 ExecuteProcessFlag_IgnoreOrphanedProcesses = 2,
01642 ExecuteProcessFlag_Hidden = 4,
01647 ExecuteProcessFlag_NoProfile = 8,
01648 };
01649
01657 enum ExecuteProcessStatus
01658 {
01663 ExecuteProcessStatus_Undefined = 0,
01668 ExecuteProcessStatus_Started = 1,
01673 ExecuteProcessStatus_TerminatedNormally = 2,
01678 ExecuteProcessStatus_TerminatedSignal = 3,
01683 ExecuteProcessStatus_TerminatedAbnormally = 4,
01688 ExecuteProcessStatus_TimedOutKilled = 5,
01693 ExecuteProcessStatus_TimedOutAbnormally = 6,
01698 ExecuteProcessStatus_Down = 7,
01703 ExecuteProcessStatus_Error = 8,
01704 };
01705
01713 enum ProcessInputFlag
01714 {
01719 ProcessInputFlag_None = 0,
01724 ProcessInputFlag_EndOfFile = 1,
01725 };
01726
01735 enum ProcessOutputFlag
01736 {
01741 ProcessOutputFlag_None = 0,
01746 ProcessOutputFlag_StdErr = 1,
01747 };
01748
01757 enum CopyFileFlag
01758 {
01763 CopyFileFlag_None = 0,
01768 CopyFileFlag_Recursive = 1,
01773 CopyFileFlag_Update = 2,
01778 CopyFileFlag_FollowLinks = 4,
01779 };
01780
01788 enum DirectoryCreateFlag
01789 {
01794 DirectoryCreateFlag_None = 0,
01799 DirectoryCreateFlag_Parents = 1,
01800 };
01801
01809 enum DirectoryOpenFlag
01810 {
01815 DirectoryOpenFlag_None = 0,
01816 };
01817
01825 enum GuestDirEntryType
01826 {
01831 GuestDirEntryType_Unknown = 0,
01836 GuestDirEntryType_Directory = 4,
01841 GuestDirEntryType_File = 10,
01846 GuestDirEntryType_Symlink = 12,
01847 };
01848
01858 enum MediumState
01859 {
01867 MediumState_NotCreated = 0,
01876 MediumState_Created = 1,
01884 MediumState_LockedRead = 2,
01892 MediumState_LockedWrite = 3,
01902 MediumState_Inaccessible = 4,
01909 MediumState_Creating = 5,
01916 MediumState_Deleting = 6,
01917 };
01918
01929 enum MediumType
01930 {
01938 MediumType_Normal = 0,
01946 MediumType_Immutable = 1,
01954 MediumType_Writethrough = 2,
01963 MediumType_Shareable = 3,
01972 MediumType_Readonly = 4,
01984 MediumType_MultiAttach = 5,
01985 };
01986
01996 enum MediumVariant
01997 {
02004 MediumVariant_Standard = 0,
02011 MediumVariant_VmdkSplit2G = 0x01,
02019 MediumVariant_VmdkStreamOptimized = 0x04,
02026 MediumVariant_VmdkESX = 0x08,
02033 MediumVariant_Fixed = 0x10000,
02040 MediumVariant_Diff = 0x20000,
02048 MediumVariant_NoCreateDir = 0x40000000,
02049 };
02050
02051 enum DataType
02052 {
02053 DataType_Int32 = 0,
02054 DataType_Int8 = 1,
02055 DataType_String = 2,
02056 };
02057
02058 enum DataFlags
02059 {
02060 DataFlags_None = 0x00,
02061 DataFlags_Mandatory = 0x01,
02062 DataFlags_Expert = 0x02,
02063 DataFlags_Array = 0x04,
02064 DataFlags_FlagMask = 0x07,
02065 };
02066
02074 enum MediumFormatCapabilities
02075 {
02082 MediumFormatCapabilities_Uuid = 0x01,
02089 MediumFormatCapabilities_CreateFixed = 0x02,
02097 MediumFormatCapabilities_CreateDynamic = 0x04,
02104 MediumFormatCapabilities_CreateSplit2G = 0x08,
02111 MediumFormatCapabilities_Differencing = 0x10,
02118 MediumFormatCapabilities_Asynchronous = 0x20,
02128 MediumFormatCapabilities_File = 0x40,
02137 MediumFormatCapabilities_Properties = 0x80,
02144 MediumFormatCapabilities_TcpNetworking = 0x100,
02151 MediumFormatCapabilities_VFS = 0x200,
02152 MediumFormatCapabilities_CapabilityMask = 0x3FF,
02153 };
02154
02162 enum MouseButtonState
02163 {
02164 MouseButtonState_LeftButton = 0x01,
02165 MouseButtonState_RightButton = 0x02,
02166 MouseButtonState_MiddleButton = 0x04,
02167 MouseButtonState_WheelUp = 0x08,
02168 MouseButtonState_WheelDown = 0x10,
02169 MouseButtonState_XButton1 = 0x20,
02170 MouseButtonState_XButton2 = 0x40,
02171 MouseButtonState_MouseStateMask = 0x7F,
02172 };
02173
02184 enum FramebufferPixelFormat
02185 {
02193 FramebufferPixelFormat_Opaque = 0,
02201 FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
02202 };
02203
02211 enum NetworkAttachmentType
02212 {
02217 NetworkAttachmentType_Null = 0,
02218 NetworkAttachmentType_NAT = 1,
02219 NetworkAttachmentType_Bridged = 2,
02220 NetworkAttachmentType_Internal = 3,
02221 NetworkAttachmentType_HostOnly = 4,
02222 NetworkAttachmentType_Generic = 5,
02223 };
02224
02232 enum NetworkAdapterType
02233 {
02238 NetworkAdapterType_Null = 0,
02243 NetworkAdapterType_Am79C970A = 1,
02248 NetworkAdapterType_Am79C973 = 2,
02253 NetworkAdapterType_I82540EM = 3,
02258 NetworkAdapterType_I82543GC = 4,
02263 NetworkAdapterType_I82545EM = 5,
02268 NetworkAdapterType_Virtio = 6,
02269 };
02270
02278 enum NetworkAdapterPromiscModePolicy
02279 {
02284 NetworkAdapterPromiscModePolicy_Deny = 1,
02292 NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
02300 NetworkAdapterPromiscModePolicy_AllowAll = 3,
02301 };
02302
02311 enum PortMode
02312 {
02317 PortMode_Disconnected = 0,
02322 PortMode_HostPipe = 1,
02327 PortMode_HostDevice = 2,
02332 PortMode_RawFile = 3,
02333 };
02334
02373 enum USBDeviceState
02374 {
02381 USBDeviceState_NotSupported = 0,
02389 USBDeviceState_Unavailable = 1,
02396 USBDeviceState_Busy = 2,
02404 USBDeviceState_Available = 3,
02412 USBDeviceState_Held = 4,
02420 USBDeviceState_Captured = 5,
02421 };
02422
02432 enum USBDeviceFilterAction
02433 {
02438 USBDeviceFilterAction_Null = 0,
02443 USBDeviceFilterAction_Ignore = 1,
02448 USBDeviceFilterAction_Hold = 2,
02449 };
02450
02458 enum AudioDriverType
02459 {
02464 AudioDriverType_Null = 0,
02469 AudioDriverType_WinMM = 1,
02474 AudioDriverType_OSS = 2,
02479 AudioDriverType_ALSA = 3,
02484 AudioDriverType_DirectSound = 4,
02489 AudioDriverType_CoreAudio = 5,
02494 AudioDriverType_MMPM = 6,
02499 AudioDriverType_Pulse = 7,
02504 AudioDriverType_SolAudio = 8,
02505 };
02506
02514 enum AudioControllerType
02515 {
02516 AudioControllerType_AC97 = 0,
02517 AudioControllerType_SB16 = 1,
02518 AudioControllerType_HDA = 2,
02519 };
02520
02528 enum AuthType
02529 {
02534 AuthType_Null = 0,
02535 AuthType_External = 1,
02536 AuthType_Guest = 2,
02537 };
02538
02547 enum StorageBus
02548 {
02553 StorageBus_Null = 0,
02554 StorageBus_IDE = 1,
02555 StorageBus_SATA = 2,
02556 StorageBus_SCSI = 3,
02557 StorageBus_Floppy = 4,
02558 StorageBus_SAS = 5,
02559 };
02560
02569 enum StorageControllerType
02570 {
02575 StorageControllerType_Null = 0,
02580 StorageControllerType_LsiLogic = 1,
02585 StorageControllerType_BusLogic = 2,
02590 StorageControllerType_IntelAhci = 3,
02595 StorageControllerType_PIIX3 = 4,
02600 StorageControllerType_PIIX4 = 5,
02605 StorageControllerType_ICH6 = 6,
02610 StorageControllerType_I82078 = 7,
02615 StorageControllerType_LsiLogicSas = 8,
02616 };
02617
02625 enum ChipsetType
02626 {
02631 ChipsetType_Null = 0,
02636 ChipsetType_PIIX3 = 1,
02641 ChipsetType_ICH9 = 2,
02642 };
02643
02649 enum NATAliasMode
02650 {
02655 NATAliasMode_AliasLog = 0x1,
02660 NATAliasMode_AliasProxyOnly = 0x02,
02665 NATAliasMode_AliasUseSamePorts = 0x04,
02666 };
02667
02673 enum NATProtocol
02674 {
02679 NATProtocol_UDP = 0,
02684 NATProtocol_TCP = 1,
02685 };
02686
02694 enum BandwidthGroupType
02695 {
02702 BandwidthGroupType_Null = 0,
02709 BandwidthGroupType_Disk = 1,
02716 BandwidthGroupType_Network = 2,
02717 };
02718
02727 enum VBoxEventType
02728 {
02735 VBoxEventType_Invalid = 0,
02744 VBoxEventType_Any = 1,
02752 VBoxEventType_Vetoable = 2,
02760 VBoxEventType_MachineEvent = 3,
02768 VBoxEventType_SnapshotEvent = 4,
02777 VBoxEventType_InputEvent = 5,
02784 VBoxEventType_LastWildcard = 31,
02791 VBoxEventType_OnMachineStateChanged = 32,
02798 VBoxEventType_OnMachineDataChanged = 33,
02805 VBoxEventType_OnExtraDataChanged = 34,
02812 VBoxEventType_OnExtraDataCanChange = 35,
02819 VBoxEventType_OnMediumRegistered = 36,
02826 VBoxEventType_OnMachineRegistered = 37,
02833 VBoxEventType_OnSessionStateChanged = 38,
02840 VBoxEventType_OnSnapshotTaken = 39,
02847 VBoxEventType_OnSnapshotDeleted = 40,
02854 VBoxEventType_OnSnapshotChanged = 41,
02861 VBoxEventType_OnGuestPropertyChanged = 42,
02868 VBoxEventType_OnMousePointerShapeChanged = 43,
02875 VBoxEventType_OnMouseCapabilityChanged = 44,
02882 VBoxEventType_OnKeyboardLedsChanged = 45,
02889 VBoxEventType_OnStateChanged = 46,
02896 VBoxEventType_OnAdditionsStateChanged = 47,
02903 VBoxEventType_OnNetworkAdapterChanged = 48,
02910 VBoxEventType_OnSerialPortChanged = 49,
02917 VBoxEventType_OnParallelPortChanged = 50,
02924 VBoxEventType_OnStorageControllerChanged = 51,
02931 VBoxEventType_OnMediumChanged = 52,
02938 VBoxEventType_OnVRDEServerChanged = 53,
02945 VBoxEventType_OnUSBControllerChanged = 54,
02952 VBoxEventType_OnUSBDeviceStateChanged = 55,
02959 VBoxEventType_OnSharedFolderChanged = 56,
02966 VBoxEventType_OnRuntimeError = 57,
02973 VBoxEventType_OnCanShowWindow = 58,
02980 VBoxEventType_OnShowWindow = 59,
02987 VBoxEventType_OnCPUChanged = 60,
02994 VBoxEventType_OnVRDEServerInfoChanged = 61,
03001 VBoxEventType_OnEventSourceChanged = 62,
03008 VBoxEventType_OnCPUExecutionCapChanged = 63,
03015 VBoxEventType_OnGuestKeyboard = 64,
03022 VBoxEventType_OnGuestMouse = 65,
03029 VBoxEventType_OnNATRedirect = 66,
03036 VBoxEventType_OnHostPciDevicePlug = 67,
03043 VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
03050 VBoxEventType_OnBandwidthGroupChanged = 69,
03057 VBoxEventType_OnGuestMonitorChanged = 70,
03064 VBoxEventType_OnStorageDeviceChanged = 71,
03071 VBoxEventType_Last = 72,
03072 };
03073
03081 enum GuestMonitorChangedEventType
03082 {
03089 GuestMonitorChangedEventType_Enabled = 0,
03096 GuestMonitorChangedEventType_Disabled = 1,
03103 GuestMonitorChangedEventType_NewOrigin = 2,
03104 };
03105
03139 interface IVirtualBoxErrorInfo : $errorinfo
03140 {
03158 readonly attribute long resultCode;
03159
03171 readonly attribute wstringUUID interfaceID;
03172
03183 readonly attribute wstring component;
03184
03195 readonly attribute wstring text;
03196
03207 readonly attribute IVirtualBoxErrorInfo next;
03208
03209 };
03210
03221 interface IDHCPServer : $unknown
03222 {
03228 attribute boolean enabled;
03229
03235 readonly attribute wstring IPAddress;
03236
03242 readonly attribute wstring networkMask;
03243
03249 readonly attribute wstring networkName;
03250
03256 readonly attribute wstring lowerIP;
03257
03263 readonly attribute wstring upperIP;
03264
03293 void setConfiguration (
03294 in wstring IPAddress,
03295 in wstring networkMask,
03296 in wstring FromIPAddress,
03297 in wstring ToIPAddress
03298 );
03299
03324 void start (
03325 in wstring networkName,
03326 in wstring trunkName,
03327 in wstring trunkType
03328 );
03329
03342 void stop();
03343
03344 };
03345
03364 interface IVirtualBox : $unknown
03365 {
03373 readonly attribute wstring version;
03374
03380 readonly attribute unsigned long revision;
03381
03391 readonly attribute wstring packageType;
03392
03404 readonly attribute wstring APIVersion;
03405
03421 readonly attribute wstring homeFolder;
03422
03430 readonly attribute wstring settingsFilePath;
03431
03435 readonly attribute IHost host;
03436
03440 readonly attribute ISystemProperties systemProperties;
03441
03447 readonly attribute IMachine[] machines;
03448
03458 readonly attribute IMedium[] hardDisks;
03459
03465 readonly attribute IMedium[] DVDImages;
03466
03472 readonly attribute IMedium[] floppyImages;
03473
03474 readonly attribute IProgress[] progressOperations;
03475
03476 readonly attribute IGuestOSType[] guestOSTypes;
03477
03494 readonly attribute ISharedFolder[] sharedFolders;
03495
03501 readonly attribute IPerformanceCollector performanceCollector;
03502
03508 readonly attribute IDHCPServer[] DHCPServers;
03509
03515 readonly attribute IEventSource eventSource;
03516
03522 readonly attribute IExtPackManager extensionPackManager;
03523
03529 readonly attribute wstring[] internalNetworks;
03530
03536 readonly attribute wstring[] genericNetworkDrivers;
03537
03577 void composeMachineFilename (
03578 in wstring name,
03579 in wstring baseFolder,
03580 [retval] out wstring file
03581 );
03582
03679 void createMachine (
03680 in wstring settingsFile,
03681 in wstring name,
03682 in wstring osTypeId,
03683 in wstringUUID id,
03684 in boolean forceOverwrite,
03685 [retval] out IMachine machine
03686 );
03687
03713 void openMachine (
03714 in wstring settingsFile,
03715 [retval] out IMachine machine
03716 );
03717
03749 void registerMachine (
03750 in IMachine machine
03751 );
03752
03773 void findMachine (
03774 in wstring nameOrId,
03775 [retval] out IMachine machine
03776 );
03777
03787 void createAppliance (
03788 [retval] out IAppliance appliance
03789 );
03790
03853 void createHardDisk (
03854 in wstring format,
03855 in wstring location,
03856 [retval] out IMedium medium
03857 );
03858
03963 void openMedium (
03964 in wstring location,
03965 in DeviceType deviceType,
03966 in AccessMode accessMode,
03967 in boolean forceNewUuid,
03968 [retval] out IMedium medium
03969 );
03970
04002 void findMedium (
04003 in wstring location,
04004 in DeviceType type,
04005 [retval] out IMedium medium
04006 );
04007
04036 void getGuestOSType (
04037 in wstringUUID id,
04038 [retval] out IGuestOSType type
04039 );
04040
04063 void createSharedFolder (
04064 in wstring name,
04065 in wstring hostPath,
04066 in boolean writable,
04067 in boolean automount
04068 );
04069
04084 void removeSharedFolder (
04085 in wstring name
04086 );
04087
04096 void getExtraDataKeys (
04097 [retval] out wstring[] value
04098 );
04099
04128 void getExtraData (
04129 in wstring key,
04130 [retval] out wstring value
04131 );
04132
04182 void setExtraData (
04183 in wstring key,
04184 in wstring value
04185 );
04186
04203 void createDHCPServer (
04204 in wstring name,
04205 [retval] out IDHCPServer server
04206 );
04207
04224 void findDHCPServerByNetworkName (
04225 in wstring name,
04226 [retval] out IDHCPServer server
04227 );
04228
04243 void removeDHCPServer (
04244 in IDHCPServer server
04245 );
04246
04271 void checkFirmwarePresent (
04272 in FirmwareType firmwareType,
04273 in wstring version,
04274 out wstring url,
04275 out wstring file,
04276 [retval] out boolean result
04277 );
04278
04279 };
04280
04291 interface IVFSExplorer : $unknown
04292 {
04296 readonly attribute wstring path;
04297
04301 readonly attribute VFSType type;
04302
04310 void update (
04311 [retval] out IProgress aProgress
04312 );
04313
04321 void cd (
04322 in wstring aDir,
04323 [retval] out IProgress aProgress
04324 );
04325
04331 void cdUp (
04332 [retval] out IProgress aProgress
04333 );
04334
04347 void entryList (
04348 out wstring[] aNames,
04349 out unsigned long[] aTypes,
04350 out unsigned long[] aSizes,
04351 out unsigned long[] aModes
04352 );
04353
04362 void exists (
04363 in wstring[] aNames,
04364 [retval] out wstring[] aExists
04365 );
04366
04374 void remove (
04375 in wstring[] aNames,
04376 [retval] out IProgress aProgress
04377 );
04378
04379 };
04380
04446 interface IAppliance : $unknown
04447 {
04455 readonly attribute wstring path;
04456
04487 readonly attribute wstring[] disks;
04488
04496 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
04497
04505 readonly attribute wstring[] machines;
04506
04523 void read (
04524 in wstring file,
04525 [retval] out IProgress aProgress
04526 );
04527
04544 void interpret();
04545
04568 void importMachines (
04569 in ImportOptions[] options,
04570 [retval] out IProgress aProgress
04571 );
04572
04580 void createVFSExplorer (
04581 in wstring aUri,
04582 [retval] out IVFSExplorer aExplorer
04583 );
04584
04614 void write (
04615 in wstring format,
04616 in boolean manifest,
04617 in wstring path,
04618 [retval] out IProgress progress
04619 );
04620
04626 void getWarnings (
04627 [retval] out wstring[] aWarnings
04628 );
04629
04630 };
04631
04643 interface IVirtualSystemDescription : $unknown
04644 {
04648 readonly attribute unsigned long count;
04649
04773 void getDescription (
04774 out VirtualSystemDescriptionType[] aTypes,
04775 out wstring[] aRefs,
04776 out wstring[] aOvfValues,
04777 out wstring[] aVBoxValues,
04778 out wstring[] aExtraConfigValues
04779 );
04780
04797 void getDescriptionByType (
04798 in VirtualSystemDescriptionType aType,
04799 out VirtualSystemDescriptionType[] aTypes,
04800 out wstring[] aRefs,
04801 out wstring[] aOvfValues,
04802 out wstring[] aVBoxValues,
04803 out wstring[] aExtraConfigValues
04804 );
04805
04817 void getValuesByType (
04818 in VirtualSystemDescriptionType aType,
04819 in VirtualSystemDescriptionValueType aWhich,
04820 [retval] out wstring[] aValues
04821 );
04822
04848 void setFinalValues (
04849 in boolean[] aEnabled,
04850 in wstring[] aVBoxValues,
04851 in wstring[] aExtraConfigValues
04852 );
04853
04868 void addDescription (
04869 in VirtualSystemDescriptionType aType,
04870 in wstring aVBoxValue,
04871 in wstring aExtraConfigValue
04872 );
04873
04874 };
04875
04876 interface IInternalMachineControl : $unknown
04877 {
04884 void setRemoveSavedStateFile (
04885 in boolean aRemove
04886 );
04887
04899 void updateState (
04900 in MachineState state
04901 );
04902
04903 void getIPCId (
04904 [retval] out wstring id
04905 );
04906
04918 void beginPowerUp (
04919 in IProgress aProgress
04920 );
04921
04931 void endPowerUp (
04932 in long result
04933 );
04934
04946 void beginPoweringDown (
04947 out IProgress progress
04948 );
04949
04979 void endPoweringDown (
04980 in long result,
04981 in wstring errMsg
04982 );
04983
04997 void runUSBDeviceFilters (
04998 in IUSBDevice device,
04999 out boolean matched,
05000 out unsigned long maskedInterfaces
05001 );
05002
05011 void captureUSBDevice (
05012 in wstringUUID id
05013 );
05014
05030 void detachUSBDevice (
05031 in wstringUUID id,
05032 in boolean done
05033 );
05034
05043 void autoCaptureUSBDevices();
05044
05060 void detachAllUSBDevices (
05061 in boolean done
05062 );
05063
05078 void onSessionEnd (
05079 in ISession session,
05080 [retval] out IProgress progress
05081 );
05082
05098 void beginSavingState (
05099 out IProgress progress,
05100 out wstring stateFilePath
05101 );
05102
05132 void endSavingState (
05133 in long result,
05134 in wstring errMsg
05135 );
05136
05151 void adoptSavedState (
05152 in wstring savedStateFile
05153 );
05154
05203 void beginTakingSnapshot (
05204 in IConsole initiator,
05205 in wstring name,
05206 in wstring description,
05207 in IProgress consoleProgress,
05208 in boolean fTakingSnapshotOnline,
05209 out wstring stateFilePath
05210 );
05211
05221 void endTakingSnapshot (
05222 in boolean success
05223 );
05224
05253 void deleteSnapshot (
05254 in IConsole initiator,
05255 in wstringUUID startId,
05256 in wstringUUID endId,
05257 in boolean deleteAllChildren,
05258 out MachineState machineState,
05259 [retval] out IProgress progress
05260 );
05261
05280 void finishOnlineMergeMedium (
05281 in IMediumAttachment mediumAttachment,
05282 in IMedium source,
05283 in IMedium target,
05284 in boolean mergeForward,
05285 in IMedium parentForTarget,
05286 in IMedium[] childrenToReparent
05287 );
05288
05302 void restoreSnapshot (
05303 in IConsole initiator,
05304 in ISnapshot snapshot,
05305 out MachineState machineState,
05306 [retval] out IProgress progress
05307 );
05308
05335 void pullGuestProperties (
05336 out wstring[] name,
05337 out wstring[] value,
05338 out long long[] timestamp,
05339 out wstring[] flags
05340 );
05341
05363 void pushGuestProperty (
05364 in wstring name,
05365 in wstring value,
05366 in long long timestamp,
05367 in wstring flags
05368 );
05369
05381 void lockMedia();
05382
05392 void unlockMedia();
05393
05409 void ejectMedium (
05410 in IMediumAttachment attachment,
05411 [retval] out IMediumAttachment newAttachment
05412 );
05413
05414 };
05415
05424 interface IBIOSSettings : $unknown
05425 {
05429 attribute boolean logoFadeIn;
05430
05434 attribute boolean logoFadeOut;
05435
05439 attribute unsigned long logoDisplayTime;
05440
05447 attribute wstring logoImagePath;
05448
05452 attribute BIOSBootMenuMode bootMenuMode;
05453
05457 attribute boolean ACPIEnabled;
05458
05465 attribute boolean IOAPICEnabled;
05466
05476 attribute long long timeOffset;
05477
05484 attribute boolean PXEDebugEnabled;
05485
05486 };
05487
05495 interface IPciAddress : $unknown
05496 {
05502 attribute short bus;
05503
05509 attribute short device;
05510
05516 attribute short devFunction;
05517
05523 void asLong (
05524 [retval] out long result
05525 );
05526
05532 void fromLong (
05533 in long number
05534 );
05535
05536 };
05537
05545 interface IPciDeviceAttachment : $unknown
05546 {
05552 readonly attribute wstring name;
05553
05559 readonly attribute boolean isPhysicalDevice;
05560
05566 readonly attribute long hostAddress;
05567
05573 readonly attribute long guestAddress;
05574
05575 };
05576
05617 interface IMachine : $unknown
05618 {
05622 readonly attribute IVirtualBox parent;
05623
05673 readonly attribute boolean accessible;
05674
05686 readonly attribute IVirtualBoxErrorInfo accessError;
05687
05727 attribute wstring name;
05728
05739 attribute wstring description;
05740
05744 readonly attribute wstringUUID id;
05745
05760 attribute wstring OSTypeId;
05761
05765 attribute wstring hardwareVersion;
05766
05776 attribute wstringUUID hardwareUUID;
05777
05781 attribute unsigned long CPUCount;
05782
05788 attribute boolean CPUHotPlugEnabled;
05789
05797 attribute unsigned long CPUExecutionCap;
05798
05802 attribute unsigned long memorySize;
05803
05807 attribute unsigned long memoryBalloonSize;
05808
05815 attribute boolean pageFusionEnabled;
05816
05820 attribute unsigned long VRAMSize;
05821
05827 attribute boolean accelerate3DEnabled;
05828
05834 attribute boolean accelerate2DVideoEnabled;
05835
05846 attribute unsigned long monitorCount;
05847
05851 readonly attribute IBIOSSettings BIOSSettings;
05852
05857 attribute FirmwareType firmwareType;
05858
05864 attribute PointingHidType pointingHidType;
05865
05871 attribute KeyboardHidType keyboardHidType;
05872
05879 attribute boolean hpetEnabled;
05880
05884 attribute ChipsetType chipsetType;
05885
05919 attribute wstring snapshotFolder;
05920
05924 readonly attribute IVRDEServer VRDEServer;
05925
05926 attribute boolean emulatedUSBWebcameraEnabled;
05927
05928 attribute boolean emulatedUSBCardReaderEnabled;
05929
05933 readonly attribute IMediumAttachment[] mediumAttachments;
05934
05946 readonly attribute IUSBController USBController;
05947
05951 readonly attribute IAudioAdapter audioAdapter;
05952
05956 readonly attribute IStorageController[] storageControllers;
05957
05963 readonly attribute wstring settingsFilePath;
05964
05989 readonly attribute boolean settingsModified;
05990
05994 readonly attribute SessionState sessionState;
05995
06008 readonly attribute wstring sessionType;
06009
06019 readonly attribute unsigned long sessionPid;
06020
06024 readonly attribute MachineState state;
06025
06032 readonly attribute long long lastStateChange;
06033
06045 readonly attribute wstring stateFilePath;
06046
06056 readonly attribute wstring logFolder;
06057
06068 readonly attribute ISnapshot currentSnapshot;
06069
06076 readonly attribute unsigned long snapshotCount;
06077
06109 readonly attribute boolean currentStateModified;
06110
06122 readonly attribute ISharedFolder[] sharedFolders;
06123
06130 attribute ClipboardMode clipboardMode;
06131
06139 attribute wstring guestPropertyNotificationPatterns;
06140
06149 attribute boolean teleporterEnabled;
06150
06161 attribute unsigned long teleporterPort;
06162
06169 attribute wstring teleporterAddress;
06170
06178 attribute wstring teleporterPassword;
06179
06187 attribute FaultToleranceState faultToleranceState;
06188
06195 attribute unsigned long faultTolerancePort;
06196
06202 attribute wstring faultToleranceAddress;
06203
06211 attribute wstring faultTolerancePassword;
06212
06218 attribute unsigned long faultToleranceSyncInterval;
06219
06227 attribute boolean RTCUseUTC;
06228
06235 attribute boolean ioCacheEnabled;
06236
06242 attribute unsigned long ioCacheSize;
06243
06249 readonly attribute IBandwidthControl bandwidthControl;
06250
06260 readonly attribute IPciDeviceAttachment[] pciDeviceAssignments;
06261
06367 void lockMachine (
06368 in ISession session,
06369 in LockType lockType
06370 );
06371
06501 void launchVMProcess (
06502 in ISession session,
06503 in wstring type,
06504 in wstring environment,
06505 [retval] out IProgress progress
06506 );
06507
06545 void setBootOrder (
06546 in unsigned long position,
06547 in DeviceType device
06548 );
06549
06584 void getBootOrder (
06585 in unsigned long position,
06586 [retval] out DeviceType device
06587 );
06588
06690 void attachDevice (
06691 in wstring name,
06692 in long controllerPort,
06693 in long device,
06694 in DeviceType type,
06695 in IMedium medium
06696 );
06697
06750 void detachDevice (
06751 in wstring name,
06752 in long controllerPort,
06753 in long device
06754 );
06755
06798 void passthroughDevice (
06799 in wstring name,
06800 in long controllerPort,
06801 in long device,
06802 in boolean passthrough
06803 );
06804
06847 void temporaryEjectDevice (
06848 in wstring name,
06849 in long controllerPort,
06850 in long device,
06851 in boolean temporaryEject
06852 );
06853
06899 void nonRotationalDevice (
06900 in wstring name,
06901 in long controllerPort,
06902 in long device,
06903 in boolean nonRotational
06904 );
06905
06946 void setBandwidthGroupForDevice (
06947 in wstring name,
06948 in long controllerPort,
06949 in long device,
06950 in IBandwidthGroup bandwidthGroup
06951 );
06952
07015 void mountMedium (
07016 in wstring name,
07017 in long controllerPort,
07018 in long device,
07019 in IMedium medium,
07020 in boolean force
07021 );
07022
07051 void getMedium (
07052 in wstring name,
07053 in long controllerPort,
07054 in long device,
07055 [retval] out IMedium medium
07056 );
07057
07072 void getMediumAttachmentsOfController (
07073 in wstring name,
07074 [retval] out IMediumAttachment[] mediumAttachments
07075 );
07076
07091 void getMediumAttachment (
07092 in wstring name,
07093 in long controllerPort,
07094 in long device,
07095 [retval] out IMediumAttachment attachment
07096 );
07097
07138 void attachHostPciDevice (
07139 in long hostAddress,
07140 in long desiredGuestAddress,
07141 in boolean tryToUnbind
07142 );
07143
07184 void detachHostPciDevice (
07185 in long hostAddress
07186 );
07187
07205 void getNetworkAdapter (
07206 in unsigned long slot,
07207 [retval] out INetworkAdapter adapter
07208 );
07209
07242 void addStorageController (
07243 in wstring name,
07244 in StorageBus connectionType,
07245 [retval] out IStorageController controller
07246 );
07247
07261 void getStorageControllerByName (
07262 in wstring name,
07263 [retval] out IStorageController storageController
07264 );
07265
07279 void getStorageControllerByInstance (
07280 in unsigned long instance,
07281 [retval] out IStorageController storageController
07282 );
07283
07297 void removeStorageController (
07298 in wstring name
07299 );
07300
07322 void setStorageControllerBootable (
07323 in wstring name,
07324 in boolean bootable
07325 );
07326
07344 void getSerialPort (
07345 in unsigned long slot,
07346 [retval] out ISerialPort port
07347 );
07348
07366 void getParallelPort (
07367 in unsigned long slot,
07368 [retval] out IParallelPort port
07369 );
07370
07379 void getExtraDataKeys (
07380 [retval] out wstring[] value
07381 );
07382
07411 void getExtraData (
07412 in wstring key,
07413 [retval] out wstring value
07414 );
07415
07465 void setExtraData (
07466 in wstring key,
07467 in wstring value
07468 );
07469
07491 void getCPUProperty (
07492 in CPUPropertyType property,
07493 [retval] out boolean value
07494 );
07495
07517 void setCPUProperty (
07518 in CPUPropertyType property,
07519 in boolean value
07520 );
07521
07561 void getCPUIDLeaf (
07562 in unsigned long id,
07563 out unsigned long valEax,
07564 out unsigned long valEbx,
07565 out unsigned long valEcx,
07566 out unsigned long valEdx
07567 );
07568
07612 void setCPUIDLeaf (
07613 in unsigned long id,
07614 in unsigned long valEax,
07615 in unsigned long valEbx,
07616 in unsigned long valEcx,
07617 in unsigned long valEdx
07618 );
07619
07637 void removeCPUIDLeaf (
07638 in unsigned long id
07639 );
07640
07646 void removeAllCPUIDLeaves();
07647
07669 void getHWVirtExProperty (
07670 in HWVirtExPropertyType property,
07671 [retval] out boolean value
07672 );
07673
07695 void setHWVirtExProperty (
07696 in HWVirtExPropertyType property,
07697 in boolean value
07698 );
07699
07745 void saveSettings();
07746
07770 void discardSettings();
07771
07855 void unregister (
07856 in CleanupMode cleanupMode,
07857 [retval] out IMedium[] aMedia
07858 );
07859
07916 void delete (
07917 in IMedium[] aMedia,
07918 [retval] out IProgress aProgress
07919 );
07920
07932 void export (
07933 in IAppliance aAppliance,
07934 in wstring location,
07935 [retval] out IVirtualSystemDescription aDescription
07936 );
07937
07961 void findSnapshot (
07962 in wstring nameOrId,
07963 [retval] out ISnapshot snapshot
07964 );
07965
07999 void createSharedFolder (
08000 in wstring name,
08001 in wstring hostPath,
08002 in boolean writable,
08003 in boolean automount
08004 );
08005
08031 void removeSharedFolder (
08032 in wstring name
08033 );
08034
08058 void canShowConsoleWindow (
08059 [retval] out boolean canShow
08060 );
08061
08096 void showConsoleWindow (
08097 [retval] out long long winId
08098 );
08099
08132 void getGuestProperty (
08133 in wstring name,
08134 out wstring value,
08135 out long long timestamp,
08136 out wstring flags
08137 );
08138
08161 void getGuestPropertyValue (
08162 in wstring property,
08163 [retval] out wstring value
08164 );
08165
08188 void getGuestPropertyTimestamp (
08189 in wstring property,
08190 [retval] out long long value
08191 );
08192
08243 void setGuestProperty (
08244 in wstring property,
08245 in wstring value,
08246 in wstring flags
08247 );
08248
08289 void setGuestPropertyValue (
08290 in wstring property,
08291 in wstring value
08292 );
08293
08324 void enumerateGuestProperties (
08325 in wstring patterns,
08326 out wstring[] name,
08327 out wstring[] value,
08328 out long long[] timestamp,
08329 out wstring[] flags
08330 );
08331
08349 void querySavedGuestSize (
08350 in unsigned long screenId,
08351 out unsigned long width,
08352 out unsigned long height
08353 );
08354
08376 void querySavedThumbnailSize (
08377 in unsigned long screenId,
08378 out unsigned long size,
08379 out unsigned long width,
08380 out unsigned long height
08381 );
08382
08409 void readSavedThumbnailToArray (
08410 in unsigned long screenId,
08411 in boolean BGR,
08412 out unsigned long width,
08413 out unsigned long height,
08414 [retval] out octet[] data
08415 );
08416
08438 void readSavedThumbnailPNGToArray (
08439 in unsigned long screenId,
08440 out unsigned long width,
08441 out unsigned long height,
08442 [retval] out octet[] data
08443 );
08444
08466 void querySavedScreenshotPNGSize (
08467 in unsigned long screenId,
08468 out unsigned long size,
08469 out unsigned long width,
08470 out unsigned long height
08471 );
08472
08494 void readSavedScreenshotPNGToArray (
08495 in unsigned long screenId,
08496 out unsigned long width,
08497 out unsigned long height,
08498 [retval] out octet[] data
08499 );
08500
08510 void hotPlugCPU (
08511 in unsigned long cpu
08512 );
08513
08523 void hotUnplugCPU (
08524 in unsigned long cpu
08525 );
08526
08540 void getCPUStatus (
08541 in unsigned long cpu,
08542 [retval] out boolean attached
08543 );
08544
08559 void queryLogFilename (
08560 in unsigned long idx,
08561 [retval] out wstring filename
08562 );
08563
08589 void readLog (
08590 in unsigned long idx,
08591 in long long offset,
08592 in long long size,
08593 [retval] out octet[] data
08594 );
08595
08628 void cloneTo (
08629 in IMachine target,
08630 in CloneMode mode,
08631 in CloneOptions[] options,
08632 [retval] out IProgress progress
08633 );
08634
08635 };
08636
08645 interface IVRDEServerInfo : $unknown
08646 {
08652 readonly attribute boolean active;
08653
08662 readonly attribute long port;
08663
08669 readonly attribute unsigned long numberOfClients;
08670
08676 readonly attribute long long beginTime;
08677
08684 readonly attribute long long endTime;
08685
08691 readonly attribute long long bytesSent;
08692
08698 readonly attribute long long bytesSentTotal;
08699
08705 readonly attribute long long bytesReceived;
08706
08712 readonly attribute long long bytesReceivedTotal;
08713
08719 readonly attribute wstring user;
08720
08726 readonly attribute wstring domain;
08727
08733 readonly attribute wstring clientName;
08734
08740 readonly attribute wstring clientIP;
08741
08747 readonly attribute unsigned long clientVersion;
08748
08756 readonly attribute unsigned long encryptionStyle;
08757
08758 };
08759
08781 interface IConsole : $unknown
08782 {
08794 readonly attribute IMachine machine;
08795
08809 readonly attribute MachineState state;
08810
08814 readonly attribute IGuest guest;
08815
08826 readonly attribute IKeyboard keyboard;
08827
08838 readonly attribute IMouse mouse;
08839
08849 readonly attribute IDisplay display;
08850
08854 readonly attribute IMachineDebugger debugger;
08855
08866 readonly attribute IUSBDevice[] USBDevices;
08867
08875 readonly attribute IHostUSBDevice[] remoteUSBDevices;
08876
08892 readonly attribute ISharedFolder[] sharedFolders;
08893
08899 readonly attribute IVRDEServerInfo VRDEServerInfo;
08900
08906 readonly attribute IEventSource eventSource;
08907
08911 readonly attribute IPciDeviceAttachment[] attachedPciDevices;
08912
08921 attribute boolean useHostClipboard;
08922
08987 void powerUp (
08988 [retval] out IProgress progress
08989 );
08990
09024 void powerUpPaused (
09025 [retval] out IProgress progress
09026 );
09027
09047 void powerDown (
09048 [retval] out IProgress progress
09049 );
09050
09070 void reset();
09071
09091 void pause();
09092
09112 void resume();
09113
09133 void powerButton();
09134
09154 void sleepButton();
09155
09167 void getPowerButtonHandled (
09168 [retval] out boolean handled
09169 );
09170
09184 void getGuestEnteredACPIMode (
09185 [retval] out boolean entered
09186 );
09187
09240 void saveState (
09241 [retval] out IProgress progress
09242 );
09243
09276 void adoptSavedState (
09277 in wstring savedStateFile
09278 );
09279
09310 void discardSavedState (
09311 in boolean fRemoveFile
09312 );
09313
09326 void getDeviceActivity (
09327 in DeviceType type,
09328 [retval] out DeviceActivity activity
09329 );
09330
09368 void attachUSBDevice (
09369 in wstringUUID id
09370 );
09371
09406 void detachUSBDevice (
09407 in wstringUUID id,
09408 [retval] out IUSBDevice device
09409 );
09410
09433 void findUSBDeviceByAddress (
09434 in wstring name,
09435 [retval] out IUSBDevice device
09436 );
09437
09457 void findUSBDeviceById (
09458 in wstringUUID id,
09459 [retval] out IUSBDevice device
09460 );
09461
09495 void createSharedFolder (
09496 in wstring name,
09497 in wstring hostPath,
09498 in boolean writable,
09499 in boolean automount
09500 );
09501
09526 void removeSharedFolder (
09527 in wstring name
09528 );
09529
09567 void takeSnapshot (
09568 in wstring name,
09569 in wstring description,
09570 [retval] out IProgress progress
09571 );
09572
09645 void deleteSnapshot (
09646 in wstringUUID id,
09647 [retval] out IProgress progress
09648 );
09649
09689 void deleteSnapshotAndAllChildren (
09690 in wstringUUID id,
09691 [retval] out IProgress progress
09692 );
09693
09737 void deleteSnapshotRange (
09738 in wstringUUID startId,
09739 in wstringUUID endId,
09740 [retval] out IProgress progress
09741 );
09742
09783 void restoreSnapshot (
09784 in ISnapshot snapshot,
09785 [retval] out IProgress progress
09786 );
09787
09826 void teleport (
09827 in wstring hostname,
09828 in unsigned long tcpport,
09829 in wstring password,
09830 in unsigned long maxDowntime,
09831 [retval] out IProgress progress
09832 );
09833
09834 };
09835
09846 interface IHostNetworkInterface : $unknown
09847 {
09851 readonly attribute wstring name;
09852
09856 readonly attribute wstringUUID id;
09857
09861 readonly attribute wstring networkName;
09862
09866 readonly attribute boolean dhcpEnabled;
09867
09871 readonly attribute wstring IPAddress;
09872
09876 readonly attribute wstring networkMask;
09877
09881 readonly attribute boolean IPV6Supported;
09882
09886 readonly attribute wstring IPV6Address;
09887
09891 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
09892
09896 readonly attribute wstring hardwareAddress;
09897
09901 readonly attribute HostNetworkInterfaceMediumType mediumType;
09902
09906 readonly attribute HostNetworkInterfaceStatus status;
09907
09911 readonly attribute HostNetworkInterfaceType interfaceType;
09912
09924 void enableStaticIpConfig (
09925 in wstring IPAddress,
09926 in wstring networkMask
09927 );
09928
09940 void enableStaticIpConfigV6 (
09941 in wstring IPV6Address,
09942 in unsigned long IPV6NetworkMaskPrefixLength
09943 );
09944
09948 void enableDynamicIpConfig();
09949
09953 void dhcpRediscover();
09954
09955 };
09956
09973 interface IHost : $unknown
09974 {
09978 readonly attribute IMedium[] DVDDrives;
09979
09983 readonly attribute IMedium[] floppyDrives;
09984
09998 readonly attribute IHostUSBDevice[] USBDevices;
09999
10023 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
10024
10028 readonly attribute IHostNetworkInterface[] networkInterfaces;
10029
10033 readonly attribute unsigned long processorCount;
10034
10038 readonly attribute unsigned long processorOnlineCount;
10039
10043 readonly attribute unsigned long processorCoreCount;
10044
10048 readonly attribute unsigned long memorySize;
10049
10053 readonly attribute unsigned long memoryAvailable;
10054
10058 readonly attribute wstring operatingSystem;
10059
10063 readonly attribute wstring OSVersion;
10064
10068 readonly attribute long long UTCTime;
10069
10073 readonly attribute boolean Acceleration3DAvailable;
10074
10089 void getProcessorSpeed (
10090 in unsigned long cpuId,
10091 [retval] out unsigned long speed
10092 );
10093
10105 void getProcessorFeature (
10106 in ProcessorFeature feature,
10107 [retval] out boolean supported
10108 );
10109
10128 void getProcessorDescription (
10129 in unsigned long cpuId,
10130 [retval] out wstring description
10131 );
10132
10173 void getProcessorCPUIDLeaf (
10174 in unsigned long cpuId,
10175 in unsigned long leaf,
10176 in unsigned long subLeaf,
10177 out unsigned long valEax,
10178 out unsigned long valEbx,
10179 out unsigned long valEcx,
10180 out unsigned long valEdx
10181 );
10182
10203 void createHostOnlyNetworkInterface (
10204 out IHostNetworkInterface hostInterface,
10205 [retval] out IProgress progress
10206 );
10207
10228 void removeHostOnlyNetworkInterface (
10229 in wstringUUID id,
10230 [retval] out IProgress progress
10231 );
10232
10252 void createUSBDeviceFilter (
10253 in wstring name,
10254 [retval] out IHostUSBDeviceFilter filter
10255 );
10256
10299 void insertUSBDeviceFilter (
10300 in unsigned long position,
10301 in IHostUSBDeviceFilter filter
10302 );
10303
10331 void removeUSBDeviceFilter (
10332 in unsigned long position
10333 );
10334
10352 void findHostDVDDrive (
10353 in wstring name,
10354 [retval] out IMedium drive
10355 );
10356
10374 void findHostFloppyDrive (
10375 in wstring name,
10376 [retval] out IMedium drive
10377 );
10378
10394 void findHostNetworkInterfaceByName (
10395 in wstring name,
10396 [retval] out IHostNetworkInterface networkInterface
10397 );
10398
10414 void findHostNetworkInterfaceById (
10415 in wstringUUID id,
10416 [retval] out IHostNetworkInterface networkInterface
10417 );
10418
10428 void findHostNetworkInterfacesOfType (
10429 in HostNetworkInterfaceType type,
10430 [retval] out IHostNetworkInterface[] networkInterfaces
10431 );
10432
10452 void findUSBDeviceById (
10453 in wstringUUID id,
10454 [retval] out IHostUSBDevice device
10455 );
10456
10479 void findUSBDeviceByAddress (
10480 in wstring name,
10481 [retval] out IHostUSBDevice device
10482 );
10483
10491 void generateMACAddress (
10492 [retval] out wstring address
10493 );
10494
10495 };
10496
10509 interface ISystemProperties : $unknown
10510 {
10514 readonly attribute unsigned long minGuestRAM;
10515
10519 readonly attribute unsigned long maxGuestRAM;
10520
10524 readonly attribute unsigned long minGuestVRAM;
10525
10529 readonly attribute unsigned long maxGuestVRAM;
10530
10534 readonly attribute unsigned long minGuestCPUCount;
10535
10539 readonly attribute unsigned long maxGuestCPUCount;
10540
10544 readonly attribute unsigned long maxGuestMonitors;
10545
10550 readonly attribute long long infoVDSize;
10551
10558 readonly attribute unsigned long serialPortCount;
10559
10566 readonly attribute unsigned long parallelPortCount;
10567
10577 readonly attribute unsigned long maxBootPosition;
10578
10602 attribute wstring defaultMachineFolder;
10603
10628 readonly attribute IMediumFormat[] mediumFormats;
10629
10663 attribute wstring defaultHardDiskFormat;
10664
10670 attribute long long freeDiskSpaceWarning;
10671
10676 attribute unsigned long freeDiskSpacePercentWarning;
10677
10683 attribute long long freeDiskSpaceError;
10684
10689 attribute unsigned long freeDiskSpacePercentError;
10690
10714 attribute wstring VRDEAuthLibrary;
10715
10744 attribute wstring webServiceAuthLibrary;
10745
10759 attribute wstring defaultVRDEExtPack;
10760
10766 attribute unsigned long logHistoryCount;
10767
10772 readonly attribute AudioDriverType defaultAudioDriver;
10773
10784 void getMaxNetworkAdapters (
10785 in ChipsetType chipset,
10786 [retval] out unsigned long maxNetworkAdapters
10787 );
10788
10802 void getMaxNetworkAdaptersOfType (
10803 in ChipsetType chipset,
10804 in NetworkAttachmentType type,
10805 [retval] out unsigned long maxNetworkAdapters
10806 );
10807
10817 void getMaxDevicesPerPortForStorageBus (
10818 in StorageBus bus,
10819 [retval] out unsigned long maxDevicesPerPort
10820 );
10821
10829 void getMinPortCountForStorageBus (
10830 in StorageBus bus,
10831 [retval] out unsigned long minPortCount
10832 );
10833
10841 void getMaxPortCountForStorageBus (
10842 in StorageBus bus,
10843 [retval] out unsigned long maxPortCount
10844 );
10845
10858 void getMaxInstancesOfStorageBus (
10859 in ChipsetType chipset,
10860 in StorageBus bus,
10861 [retval] out unsigned long maxInstances
10862 );
10863
10873 void getDeviceTypesForStorageBus (
10874 in StorageBus bus,
10875 [retval] out DeviceType[] deviceTypes
10876 );
10877
10886 void getDefaultIoCacheSettingForStorageController (
10887 in StorageControllerType controllerType,
10888 [retval] out boolean enabled
10889 );
10890
10891 };
10892
10898 interface IGuestOSType : $unknown
10899 {
10903 readonly attribute wstring familyId;
10904
10908 readonly attribute wstring familyDescription;
10909
10913 readonly attribute wstring id;
10914
10918 readonly attribute wstring description;
10919
10923 readonly attribute boolean is64Bit;
10924
10928 readonly attribute boolean recommendedIOAPIC;
10929
10933 readonly attribute boolean recommendedVirtEx;
10934
10938 readonly attribute unsigned long recommendedRAM;
10939
10943 readonly attribute unsigned long recommendedVRAM;
10944
10948 readonly attribute long long recommendedHDD;
10949
10953 readonly attribute NetworkAdapterType adapterType;
10954
10958 readonly attribute boolean recommendedPae;
10959
10963 readonly attribute StorageControllerType recommendedDvdStorageController;
10964
10968 readonly attribute StorageBus recommendedDvdStorageBus;
10969
10973 readonly attribute StorageControllerType recommendedHdStorageController;
10974
10978 readonly attribute StorageBus recommendedHdStorageBus;
10979
10983 readonly attribute FirmwareType recommendedFirmware;
10984
10988 readonly attribute boolean recommendedUsbHid;
10989
10993 readonly attribute boolean recommendedHpet;
10994
10998 readonly attribute boolean recommendedUsbTablet;
10999
11003 readonly attribute boolean recommendedRtcUseUtc;
11004
11008 readonly attribute ChipsetType recommendedChipset;
11009
11013 readonly attribute AudioControllerType recommendedAudioController;
11014
11015 };
11016
11024 interface IAdditionsFacility : $unknown
11025 {
11029 readonly attribute AdditionsFacilityClass classType;
11030
11037 readonly attribute long long lastUpdated;
11038
11042 readonly attribute wstring name;
11043
11047 readonly attribute AdditionsFacilityStatus status;
11048
11052 readonly attribute AdditionsFacilityType type;
11053
11054 };
11055
11063 interface IGuestDirEntry : $unknown
11064 {
11068 readonly attribute long long nodeId;
11069
11073 readonly attribute wstring name;
11074
11078 readonly attribute GuestDirEntryType type;
11079
11080 };
11081
11095 interface IGuest : $unknown
11096 {
11111 readonly attribute wstring OSTypeId;
11112
11118 readonly attribute AdditionsRunLevelType additionsRunLevel;
11119
11127 readonly attribute wstring additionsVersion;
11128
11135 readonly attribute IAdditionsFacility[] facilities;
11136
11140 attribute unsigned long memoryBalloonSize;
11141
11145 attribute unsigned long statisticsUpdateInterval;
11146
11178 void internalGetStatistics (
11179 out unsigned long cpuUser,
11180 out unsigned long cpuKernel,
11181 out unsigned long cpuIdle,
11182 out unsigned long memTotal,
11183 out unsigned long memFree,
11184 out unsigned long memBalloon,
11185 out unsigned long memShared,
11186 out unsigned long memCache,
11187 out unsigned long pagedTotal,
11188 out unsigned long memAllocTotal,
11189 out unsigned long memFreeTotal,
11190 out unsigned long memBalloonTotal,
11191 out unsigned long memSharedTotal
11192 );
11193
11205 void getFacilityStatus (
11206 in AdditionsFacilityType facility,
11207 out long long timestamp,
11208 [retval] out AdditionsFacilityStatus status
11209 );
11210
11228 void getAdditionsStatus (
11229 in AdditionsRunLevelType level,
11230 [retval] out boolean active
11231 );
11232
11262 void setCredentials (
11263 in wstring userName,
11264 in wstring password,
11265 in wstring domain,
11266 in boolean allowInteractiveLogon
11267 );
11268
11336 void executeProcess (
11337 in wstring execName,
11338 in unsigned long flags,
11339 in wstring[] arguments,
11340 in wstring[] environment,
11341 in wstring userName,
11342 in wstring password,
11343 in unsigned long timeoutMS,
11344 out unsigned long pid,
11345 [retval] out IProgress progress
11346 );
11347
11384 void getProcessOutput (
11385 in unsigned long pid,
11386 in unsigned long flags,
11387 in unsigned long timeoutMS,
11388 in long long size,
11389 [retval] out octet[] data
11390 );
11391
11422 void getProcessStatus (
11423 in unsigned long pid,
11424 out unsigned long exitcode,
11425 out unsigned long flags,
11426 [retval] out ExecuteProcessStatus reason
11427 );
11428
11465 void copyFromGuest (
11466 in wstring source,
11467 in wstring dest,
11468 in wstring userName,
11469 in wstring password,
11470 in unsigned long flags,
11471 [retval] out IProgress progress
11472 );
11473
11510 void copyToGuest (
11511 in wstring source,
11512 in wstring dest,
11513 in wstring userName,
11514 in wstring password,
11515 in unsigned long flags,
11516 [retval] out IProgress progress
11517 );
11518
11536 void directoryClose (
11537 in unsigned long handle
11538 );
11539
11574 void directoryCreate (
11575 in wstring directory,
11576 in wstring userName,
11577 in wstring password,
11578 in unsigned long mode,
11579 in unsigned long flags
11580 );
11581
11621 void directoryOpen (
11622 in wstring directory,
11623 in wstring filter,
11624 in unsigned long flags,
11625 in wstring userName,
11626 in wstring password,
11627 [retval] out unsigned long handle
11628 );
11629
11659 void directoryRead (
11660 in unsigned long handle,
11661 [retval] out IGuestDirEntry entry
11662 );
11663
11699 void fileExists (
11700 in wstring file,
11701 in wstring userName,
11702 in wstring password,
11703 [retval] out boolean exists
11704 );
11705
11737 void fileQuerySize (
11738 in wstring file,
11739 in wstring userName,
11740 in wstring password,
11741 [retval] out long long size
11742 );
11743
11777 void setProcessInput (
11778 in unsigned long pid,
11779 in unsigned long flags,
11780 in unsigned long timeoutMS,
11781 in octet[] data,
11782 [retval] out unsigned long written
11783 );
11784
11808 void updateGuestAdditions (
11809 in wstring source,
11810 in unsigned long flags,
11811 [retval] out IProgress progress
11812 );
11813
11814 };
11815
11856 interface IProgress : $unknown
11857 {
11861 readonly attribute wstringUUID id;
11862
11866 readonly attribute wstring description;
11867
11871 readonly attribute $unknown initiator;
11872
11876 readonly attribute boolean cancelable;
11877
11885 readonly attribute unsigned long percent;
11886
11900 readonly attribute long timeRemaining;
11901
11905 readonly attribute boolean completed;
11906
11910 readonly attribute boolean canceled;
11911
11918 readonly attribute long resultCode;
11919
11929 readonly attribute IVirtualBoxErrorInfo errorInfo;
11930
11937 readonly attribute unsigned long operationCount;
11938
11942 readonly attribute unsigned long operation;
11943
11949 readonly attribute wstring operationDescription;
11950
11954 readonly attribute unsigned long operationPercent;
11955
11959 readonly attribute unsigned long operationWeight;
11960
11968 attribute unsigned long timeout;
11969
11973 void setCurrentOperationProgress (
11974 in unsigned long percent
11975 );
11976
11980 void setNextOperation (
11981 in wstring nextOperationDescription,
11982 in unsigned long nextOperationsWeight
11983 );
11984
12011 void waitForCompletion (
12012 in long timeout
12013 );
12014
12038 void waitForOperationCompletion (
12039 in unsigned long operation,
12040 in long timeout
12041 );
12042
12068 void waitForAsyncProgressCompletion (
12069 in IProgress pProgressAsync
12070 );
12071
12088 void cancel();
12089
12090 };
12091
12175 interface ISnapshot : $unknown
12176 {
12180 readonly attribute wstringUUID id;
12181
12189 attribute wstring name;
12190
12198 attribute wstring description;
12199
12205 readonly attribute long long timeStamp;
12206
12218 readonly attribute boolean online;
12219
12231 readonly attribute IMachine machine;
12232
12239 readonly attribute ISnapshot parent;
12240
12249 readonly attribute ISnapshot[] children;
12250
12258 void getChildrenCount (
12259 [retval] out unsigned long childrenCount
12260 );
12261
12262 };
12263
12450 interface IMediumAttachment : $unknown
12451 {
12456 readonly attribute IMedium medium;
12457
12463 readonly attribute wstring controller;
12464
12470 readonly attribute long port;
12471
12477 readonly attribute long device;
12478
12482 readonly attribute DeviceType type;
12483
12487 readonly attribute boolean passthrough;
12488
12492 readonly attribute boolean temporaryEject;
12493
12498 readonly attribute boolean isEjected;
12499
12503 readonly attribute boolean nonRotational;
12504
12508 readonly attribute IBandwidthGroup bandwidthGroup;
12509
12510 };
12511
12669 interface IMedium : $unknown
12670 {
12684 readonly attribute wstringUUID id;
12685
12704 attribute wstring description;
12705
12721 readonly attribute MediumState state;
12722
12731 readonly attribute unsigned long variant;
12732
12754 attribute wstring location;
12755
12775 readonly attribute wstring name;
12776
12781 readonly attribute DeviceType deviceType;
12782
12786 readonly attribute boolean hostDrive;
12787
12800 readonly attribute long long size;
12801
12816 readonly attribute wstring format;
12817
12833 readonly attribute IMediumFormat mediumFormat;
12834
12859 attribute MediumType type;
12860
12874 readonly attribute MediumType[] allowedTypes;
12875
12885 readonly attribute IMedium parent;
12886
12894 readonly attribute IMedium[] children;
12895
12906 readonly attribute IMedium base;
12907
12940 readonly attribute boolean readOnly;
12941
12962 readonly attribute long long logicalSize;
12963
12991 attribute boolean autoReset;
12992
13007 readonly attribute wstring lastAccessError;
13008
13025 readonly attribute wstringUUID[] machineIds;
13026
13052 void setIDs (
13053 in boolean setImageId,
13054 in wstringUUID imageId,
13055 in boolean setParentId,
13056 in wstringUUID parentId
13057 );
13058
13093 void refreshState (
13094 [retval] out MediumState state
13095 );
13096
13123 void getSnapshotIds (
13124 in wstringUUID machineId,
13125 [retval] out wstringUUID[] snapshotIds
13126 );
13127
13187 void lockRead (
13188 [retval] out MediumState state
13189 );
13190
13213 void unlockRead (
13214 [retval] out MediumState state
13215 );
13216
13271 void lockWrite (
13272 [retval] out MediumState state
13273 );
13274
13297 void unlockWrite (
13298 [retval] out MediumState state
13299 );
13300
13350 void close();
13351
13381 void getProperty (
13382 in wstring name,
13383 [retval] out wstring value
13384 );
13385
13417 void setProperty (
13418 in wstring name,
13419 in wstring value
13420 );
13421
13456 void getProperties (
13457 in wstring names,
13458 out wstring[] returnNames,
13459 [retval] out wstring[] returnValues
13460 );
13461
13491 void setProperties (
13492 in wstring[] names,
13493 in wstring[] values
13494 );
13495
13528 void createBaseStorage (
13529 in long long logicalSize,
13530 in unsigned long variant,
13531 [retval] out IProgress progress
13532 );
13533
13585 void deleteStorage (
13586 [retval] out IProgress progress
13587 );
13588
13627 void createDiffStorage (
13628 in IMedium target,
13629 in unsigned long variant,
13630 [retval] out IProgress progress
13631 );
13632
13708 void mergeTo (
13709 in IMedium target,
13710 [retval] out IProgress progress
13711 );
13712
13762 void cloneTo (
13763 in IMedium target,
13764 in unsigned long variant,
13765 in IMedium parent,
13766 [retval] out IProgress progress
13767 );
13768
13797 void compact (
13798 [retval] out IProgress progress
13799 );
13800
13833 void resize (
13834 in long long logicalSize,
13835 [retval] out IProgress progress
13836 );
13837
13871 void reset (
13872 [retval] out IProgress progress
13873 );
13874
13875 };
13876
13899 interface IMediumFormat : $unknown
13900 {
13919 readonly attribute wstring id;
13920
13928 readonly attribute wstring name;
13929
13938 readonly attribute unsigned long capabilities;
13939
13958 void describeFileExtensions (
13959 out wstring[] extensions,
13960 out DeviceType[] type
13961 );
13962
13990 void describeProperties (
13991 out wstring[] names,
13992 out wstring[] description,
13993 out DataType[] types,
13994 out unsigned long[] flags,
13995 out wstring[] defaults
13996 );
13997
13998 };
13999
14012 interface IKeyboard : $unknown
14013 {
14019 readonly attribute IEventSource eventSource;
14020
14033 void putScancode (
14034 in long scancode
14035 );
14036
14049 void putScancodes (
14050 in long[] scancodes,
14051 [retval] out unsigned long codesStored
14052 );
14053
14068 void putCAD();
14069
14070 };
14071
14083 interface IMouse : $unknown
14084 {
14099 readonly attribute boolean absoluteSupported;
14100
14115 readonly attribute boolean relativeSupported;
14116
14131 readonly attribute boolean needsHostCursor;
14132
14138 readonly attribute IEventSource eventSource;
14139
14205 void putMouseEvent (
14206 in long dx,
14207 in long dy,
14208 in long dz,
14209 in long dw,
14210 in long buttonState
14211 );
14212
14285 void putMouseEventAbsolute (
14286 in long x,
14287 in long y,
14288 in long dz,
14289 in long dw,
14290 in long buttonState
14291 );
14292
14293 };
14294
14295 interface IFramebuffer : $unknown
14296 {
14305 readonly attribute octetPtr address;
14306
14310 readonly attribute unsigned long width;
14311
14315 readonly attribute unsigned long height;
14316
14323 readonly attribute unsigned long bitsPerPixel;
14324
14331 readonly attribute unsigned long bytesPerLine;
14332
14343 readonly attribute unsigned long pixelFormat;
14344
14351 readonly attribute boolean usesGuestVRAM;
14352
14362 readonly attribute unsigned long heightReduction;
14363
14378 readonly attribute IFramebufferOverlay overlay;
14379
14386 readonly attribute long long winId;
14387
14395 void lock();
14396
14404 void unlock();
14405
14413 void notifyUpdate (
14414 in unsigned long x,
14415 in unsigned long y,
14416 in unsigned long width,
14417 in unsigned long height
14418 );
14419
14532 void requestResize (
14533 in unsigned long screenId,
14534 in unsigned long pixelFormat,
14535 in octetPtr VRAM,
14536 in unsigned long bitsPerPixel,
14537 in unsigned long bytesPerLine,
14538 in unsigned long width,
14539 in unsigned long height,
14540 [retval] out boolean finished
14541 );
14542
14554 void videoModeSupported (
14555 in unsigned long width,
14556 in unsigned long height,
14557 in unsigned long bpp,
14558 [retval] out boolean supported
14559 );
14560
14597 void getVisibleRegion (
14598 in octetPtr rectangles,
14599 in unsigned long count,
14600 [retval] out unsigned long countCopied
14601 );
14602
14637 void setVisibleRegion (
14638 in octetPtr rectangles,
14639 in unsigned long count
14640 );
14641
14662 void processVHWACommand (
14663 in octetPtr command
14664 );
14665
14666 };
14667
14682 interface IFramebufferOverlay : IFramebuffer
14683 {
14687 readonly attribute unsigned long x;
14688
14692 readonly attribute unsigned long y;
14693
14699 attribute boolean visible;
14700
14707 attribute unsigned long alpha;
14708
14714 void move (
14715 in unsigned long x,
14716 in unsigned long y
14717 );
14718
14719 };
14720
14736 interface IDisplay : $unknown
14737 {
14741 void getScreenResolution (
14742 in unsigned long screenId,
14743 out unsigned long width,
14744 out unsigned long height,
14745 out unsigned long bitsPerPixel
14746 );
14747
14753 void setFramebuffer (
14754 in unsigned long screenId,
14755 in IFramebuffer framebuffer
14756 );
14757
14763 void getFramebuffer (
14764 in unsigned long screenId,
14765 out IFramebuffer framebuffer,
14766 out long xOrigin,
14767 out long yOrigin
14768 );
14769
14798 void setVideoModeHint (
14799 in unsigned long width,
14800 in unsigned long height,
14801 in unsigned long bitsPerPixel,
14802 in unsigned long display
14803 );
14804
14816 void setSeamlessMode (
14817 in boolean enabled
14818 );
14819
14855 void takeScreenShot (
14856 in unsigned long screenId,
14857 in octetPtr address,
14858 in unsigned long width,
14859 in unsigned long height
14860 );
14861
14905 void takeScreenShotToArray (
14906 in unsigned long screenId,
14907 in unsigned long width,
14908 in unsigned long height,
14909 [retval] out octet[] screenData
14910 );
14911
14950 void takeScreenShotPNGToArray (
14951 in unsigned long screenId,
14952 in unsigned long width,
14953 in unsigned long height,
14954 [retval] out octet[] screenData
14955 );
14956
15008 void drawToScreen (
15009 in unsigned long screenId,
15010 in octetPtr address,
15011 in unsigned long x,
15012 in unsigned long y,
15013 in unsigned long width,
15014 in unsigned long height
15015 );
15016
15031 void invalidateAndUpdate();
15032
15046 void resizeCompleted (
15047 in unsigned long screenId
15048 );
15049
15062 void completeVHWACommand (
15063 in octetPtr command
15064 );
15065
15066 };
15067
15083 interface INetworkAdapter : $unknown
15084 {
15092 attribute NetworkAdapterType adapterType;
15093
15101 readonly attribute unsigned long slot;
15102
15111 attribute boolean enabled;
15112
15119 attribute wstring MACAddress;
15120
15126 attribute NetworkAttachmentType attachmentType;
15127
15133 attribute wstring bridgedInterface;
15134
15140 attribute wstring hostOnlyInterface;
15141
15147 attribute wstring internalNetwork;
15148
15154 attribute wstring NATNetwork;
15155
15161 attribute wstring genericDriver;
15162
15169 attribute boolean cableConnected;
15170
15176 attribute unsigned long lineSpeed;
15177
15184 attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
15185
15192 attribute boolean traceEnabled;
15193
15200 attribute wstring traceFile;
15201
15209 readonly attribute INATEngine natDriver;
15210
15217 attribute unsigned long bootPriority;
15218
15222 attribute IBandwidthGroup bandwidthGroup;
15223
15242 void getProperty (
15243 in wstring key,
15244 [retval] out wstring value
15245 );
15246
15265 void setProperty (
15266 in wstring key,
15267 in wstring value
15268 );
15269
15297 void getProperties (
15298 in wstring names,
15299 out wstring[] returnNames,
15300 [retval] out wstring[] returnValues
15301 );
15302
15303 };
15304
15333 interface ISerialPort : $unknown
15334 {
15342 readonly attribute unsigned long slot;
15343
15350 attribute boolean enabled;
15351
15355 attribute unsigned long IOBase;
15356
15360 attribute unsigned long IRQ;
15361
15372 attribute PortMode hostMode;
15373
15381 attribute boolean server;
15382
15392 attribute wstring path;
15393
15394 };
15395
15415 interface IParallelPort : $unknown
15416 {
15424 readonly attribute unsigned long slot;
15425
15432 attribute boolean enabled;
15433
15437 attribute unsigned long IOBase;
15438
15442 attribute unsigned long IRQ;
15443
15451 attribute wstring path;
15452
15453 };
15454
15455 interface IMachineDebugger : $unknown
15456 {
15460 attribute boolean singlestep;
15461
15465 attribute boolean recompileUser;
15466
15470 attribute boolean recompileSupervisor;
15471
15475 attribute boolean PATMEnabled;
15476
15480 attribute boolean CSAMEnabled;
15481
15485 attribute boolean logEnabled;
15486
15490 readonly attribute wstring logFlags;
15491
15495 readonly attribute wstring logGroups;
15496
15500 readonly attribute wstring logDestinations;
15501
15508 readonly attribute boolean HWVirtExEnabled;
15509
15516 readonly attribute boolean HWVirtExNestedPagingEnabled;
15517
15524 readonly attribute boolean HWVirtExVPIDEnabled;
15525
15534 readonly attribute wstring OSName;
15535
15544 readonly attribute wstring OSVersion;
15545
15552 readonly attribute boolean PAEEnabled;
15553
15560 attribute unsigned long virtualTimeRate;
15561
15568 readonly attribute long long VM;
15569
15585 void dumpGuestCore (
15586 in wstring filename,
15587 in wstring compression
15588 );
15589
15606 void dumpHostProcessCore (
15607 in wstring filename,
15608 in wstring compression
15609 );
15610
15631 void info (
15632 in wstring name,
15633 in wstring args,
15634 [retval] out wstring info
15635 );
15636
15642 void injectNMI();
15643
15654 void modifyLogGroups (
15655 in wstring settings
15656 );
15657
15668 void modifyLogFlags (
15669 in wstring settings
15670 );
15671
15682 void modifyLogDestinations (
15683 in wstring settings
15684 );
15685
15700 void readPhysicalMemory (
15701 in long long address,
15702 in unsigned long size,
15703 [retval] out octet[] bytes
15704 );
15705
15720 void writePhysicalMemory (
15721 in long long address,
15722 in unsigned long size,
15723 in octet[] bytes
15724 );
15725
15742 void readVirtualMemory (
15743 in unsigned long cpuId,
15744 in long long address,
15745 in unsigned long size,
15746 [retval] out octet[] bytes
15747 );
15748
15765 void writeVirtualMemory (
15766 in unsigned long cpuId,
15767 in long long address,
15768 in unsigned long size,
15769 in octet[] bytes
15770 );
15771
15784 void detectOS (
15785 [retval] out wstring os
15786 );
15787
15805 void getRegister (
15806 in unsigned long cpuId,
15807 in wstring name,
15808 [retval] out wstring value
15809 );
15810
15828 void getRegisters (
15829 in unsigned long cpuId,
15830 out wstring[] names,
15831 out wstring[] values
15832 );
15833
15852 void setRegister (
15853 in unsigned long cpuId,
15854 in wstring name,
15855 in wstring value
15856 );
15857
15876 void setRegisters (
15877 in unsigned long cpuId,
15878 in wstring[] names,
15879 in wstring[] values
15880 );
15881
15894 void dumpGuestStack (
15895 in unsigned long cpuId,
15896 [retval] out wstring stack
15897 );
15898
15906 void resetStats (
15907 in wstring pattern
15908 );
15909
15917 void dumpStats (
15918 in wstring pattern
15919 );
15920
15932 void getStats (
15933 in wstring pattern,
15934 in boolean withDescriptions,
15935 out wstring stats
15936 );
15937
15938 };
15939
15940 interface IUSBController : $unknown
15941 {
15950 attribute boolean enabled;
15951
15960 attribute boolean enabledEhci;
15961
15967 readonly attribute boolean proxyAvailable;
15968
15976 readonly attribute unsigned short USBStandard;
15977
16003 readonly attribute IUSBDeviceFilter[] deviceFilters;
16004
16032 void createDeviceFilter (
16033 in wstring name,
16034 [retval] out IUSBDeviceFilter filter
16035 );
16036
16081 void insertDeviceFilter (
16082 in unsigned long position,
16083 in IUSBDeviceFilter filter
16084 );
16085
16118 void removeDeviceFilter (
16119 in unsigned long position,
16120 [retval] out IUSBDeviceFilter filter
16121 );
16122
16123 };
16124
16137 interface IUSBDevice : $unknown
16138 {
16145 readonly attribute wstringUUID id;
16146
16150 readonly attribute unsigned short vendorId;
16151
16155 readonly attribute unsigned short productId;
16156
16164 readonly attribute unsigned short revision;
16165
16169 readonly attribute wstring manufacturer;
16170
16174 readonly attribute wstring product;
16175
16179 readonly attribute wstring serialNumber;
16180
16184 readonly attribute wstring address;
16185
16192 readonly attribute unsigned short port;
16193
16199 readonly attribute unsigned short version;
16200
16208 readonly attribute unsigned short portVersion;
16209
16216 readonly attribute boolean remote;
16217
16218 };
16219
16294 interface IUSBDeviceFilter : $unknown
16295 {
16303 attribute wstring name;
16304
16308 attribute boolean active;
16309
16317 attribute wstring vendorId;
16318
16326 attribute wstring productId;
16327
16341 attribute wstring revision;
16342
16347 attribute wstring manufacturer;
16348
16353 attribute wstring product;
16354
16359 attribute wstring serialNumber;
16360
16365 attribute wstring port;
16366
16376 attribute wstring remote;
16377
16387 attribute unsigned long maskedInterfaces;
16388
16389 };
16390
16407 interface IHostUSBDevice : IUSBDevice
16408 {
16414 readonly attribute USBDeviceState state;
16415
16416 };
16417
16440 interface IHostUSBDeviceFilter : IUSBDeviceFilter
16441 {
16448 attribute USBDeviceFilterAction action;
16449
16450 };
16451
16460 interface IAudioAdapter : $unknown
16461 {
16470 attribute boolean enabled;
16471
16477 attribute AudioControllerType audioController;
16478
16485 attribute AudioDriverType audioDriver;
16486
16487 };
16488
16489 interface IVRDEServer : $unknown
16490 {
16494 attribute boolean enabled;
16495
16499 attribute AuthType authType;
16500
16504 attribute unsigned long authTimeout;
16505
16512 attribute boolean allowMultiConnection;
16513
16521 attribute boolean reuseSingleConnection;
16522
16529 attribute wstring VRDEExtPack;
16530
16537 attribute wstring authLibrary;
16538
16544 readonly attribute wstring[] VRDEProperties;
16545
16559 void setVRDEProperty (
16560 in wstring key,
16561 in wstring value
16562 );
16563
16577 void getVRDEProperty (
16578 in wstring key,
16579 [retval] out wstring value
16580 );
16581
16582 };
16583
16641 interface ISharedFolder : $unknown
16642 {
16646 readonly attribute wstring name;
16647
16651 readonly attribute wstring hostPath;
16652
16662 readonly attribute boolean accessible;
16663
16670 readonly attribute boolean writable;
16671
16677 readonly attribute boolean autoMount;
16678
16691 readonly attribute wstring lastAccessError;
16692
16693 };
16694
16695 interface IInternalSessionControl : $unknown
16696 {
16701 void getPID (
16702 [retval] out unsigned long pid
16703 );
16704
16726 void getRemoteConsole (
16727 [retval] out IConsole console
16728 );
16729
16753 void assignMachine (
16754 in IMachine machine
16755 );
16756
16771 void assignRemoteMachine (
16772 in IMachine machine,
16773 in IConsole console
16774 );
16775
16799 void updateMachineState (
16800 in MachineState aMachineState
16801 );
16802
16818 void uninitialize();
16819
16842 void onNetworkAdapterChange (
16843 in INetworkAdapter networkAdapter,
16844 in boolean changeAdapter
16845 );
16846
16869 void onSerialPortChange (
16870 in ISerialPort serialPort
16871 );
16872
16895 void onParallelPortChange (
16896 in IParallelPort parallelPort
16897 );
16898
16921 void onStorageControllerChange();
16922
16949 void onMediumChange (
16950 in IMediumAttachment mediumAttachment,
16951 in boolean force
16952 );
16953
16980 void onStorageDeviceChange (
16981 in IMediumAttachment mediumAttachment,
16982 in boolean remove
16983 );
16984
16994 void onCPUChange (
16995 in unsigned long cpu,
16996 in boolean add
16997 );
16998
17006 void onCPUExecutionCapChange (
17007 in unsigned long executionCap
17008 );
17009
17034 void onVRDEServerChange (
17035 in boolean restart
17036 );
17037
17060 void onUSBControllerChange();
17061
17090 void onSharedFolderChange (
17091 in boolean global
17092 );
17093
17119 void onUSBDeviceAttach (
17120 in IUSBDevice device,
17121 in IVirtualBoxErrorInfo error,
17122 in unsigned long maskedInterfaces
17123 );
17124
17150 void onUSBDeviceDetach (
17151 in wstringUUID id,
17152 in IVirtualBoxErrorInfo error
17153 );
17154
17172 void onShowWindow (
17173 in boolean check,
17174 out boolean canShow,
17175 out long long winId
17176 );
17177
17185 void onBandwidthGroupChange (
17186 in IBandwidthGroup bandwidthGroup
17187 );
17188
17212 void accessGuestProperty (
17213 in wstring name,
17214 in wstring value,
17215 in wstring flags,
17216 in boolean isSetter,
17217 out wstring retValue,
17218 out long long retTimestamp,
17219 out wstring retFlags
17220 );
17221
17269 void enumerateGuestProperties (
17270 in wstring patterns,
17271 out wstring[] key,
17272 out wstring[] value,
17273 out long long[] timestamp,
17274 out wstring[] flags
17275 );
17276
17322 void onlineMergeMedium (
17323 in IMediumAttachment mediumAttachment,
17324 in unsigned long sourceIdx,
17325 in unsigned long targetIdx,
17326 in IMedium source,
17327 in IMedium target,
17328 in boolean mergeForward,
17329 in IMedium parentForTarget,
17330 in IMedium[] childrenToReparent,
17331 in IProgress progress
17332 );
17333
17334 };
17335
17394 interface ISession : $unknown
17395 {
17399 readonly attribute SessionState state;
17400
17408 readonly attribute SessionType type;
17409
17413 readonly attribute IMachine machine;
17414
17418 readonly attribute IConsole console;
17419
17451 void unlockMachine();
17452
17453 };
17454
17477 interface IStorageController : $unknown
17478 {
17487 readonly attribute wstring name;
17488
17494 readonly attribute unsigned long maxDevicesPerPortCount;
17495
17501 readonly attribute unsigned long minPortCount;
17502
17508 readonly attribute unsigned long maxPortCount;
17509
17515 attribute unsigned long instance;
17516
17525 attribute unsigned long portCount;
17526
17532 readonly attribute StorageBus bus;
17533
17546 attribute StorageControllerType controllerType;
17547
17562 attribute boolean useHostIOCache;
17563
17569 readonly attribute boolean bootable;
17570
17593 void getIDEEmulationPort (
17594 in long devicePosition,
17595 [retval] out long portNumber
17596 );
17597
17621 void setIDEEmulationPort (
17622 in long devicePosition,
17623 in long portNumber
17624 );
17625
17626 };
17627
17651 interface IManagedObjectRef : $unknown
17652 {
17659 void getInterfaceName (
17660 [retval] out wstring return
17661 );
17662
17670 void release();
17671
17672 };
17673
17682 interface IWebsessionManager : $unknown
17683 {
17692 void logon (
17693 in wstring username,
17694 in wstring password,
17695 [retval] out IVirtualBox return
17696 );
17697
17707 void getSessionObject (
17708 in IVirtualBox refIVirtualBox,
17709 [retval] out ISession return
17710 );
17711
17719 void logoff (
17720 in IVirtualBox refIVirtualBox
17721 );
17722
17723 };
17724
17733 interface IPerformanceMetric : $unknown
17734 {
17740 readonly attribute wstring metricName;
17741
17747 readonly attribute $unknown object;
17748
17754 readonly attribute wstring description;
17755
17761 readonly attribute unsigned long period;
17762
17772 readonly attribute unsigned long count;
17773
17779 readonly attribute wstring unit;
17780
17786 readonly attribute long minimumValue;
17787
17793 readonly attribute long maximumValue;
17794
17795 };
17796
17903 interface IPerformanceCollector : $unknown
17904 {
17915 readonly attribute wstring[] metricNames;
17916
17940 void getMetrics (
17941 in wstring[] metricNames,
17942 in $unknown[] objects,
17943 [retval] out IPerformanceMetric[] metrics
17944 );
17945
17984 void setupMetrics (
17985 in wstring[] metricNames,
17986 in $unknown[] objects,
17987 in unsigned long period,
17988 in unsigned long count,
17989 [retval] out IPerformanceMetric[] affectedMetrics
17990 );
17991
18020 void enableMetrics (
18021 in wstring[] metricNames,
18022 in $unknown[] objects,
18023 [retval] out IPerformanceMetric[] affectedMetrics
18024 );
18025
18054 void disableMetrics (
18055 in wstring[] metricNames,
18056 in $unknown[] objects,
18057 [retval] out IPerformanceMetric[] affectedMetrics
18058 );
18059
18148 void queryMetricsData (
18149 in wstring[] metricNames,
18150 in $unknown[] objects,
18151 out wstring[] returnMetricNames,
18152 out $unknown[] returnObjects,
18153 out wstring[] returnUnits,
18154 out unsigned long[] returnScales,
18155 out unsigned long[] returnSequenceNumbers,
18156 out unsigned long[] returnDataIndices,
18157 out unsigned long[] returnDataLengths,
18158 [retval] out long[] returnData
18159 );
18160
18161 };
18162
18170 interface INATEngine : $unknown
18171 {
18176 attribute wstring network;
18177
18184 attribute wstring hostIP;
18185
18190 attribute wstring tftpPrefix;
18191
18196 attribute wstring tftpBootFile;
18197
18205 attribute wstring tftpNextServer;
18206
18210 attribute unsigned long aliasMode;
18211
18215 attribute boolean dnsPassDomain;
18216
18221 attribute boolean dnsProxy;
18222
18227 attribute boolean dnsUseHostResolver;
18228
18233 readonly attribute wstring[] redirects;
18234
18250 void setNetworkSettings (
18251 in unsigned long mtu,
18252 in unsigned long sockSnd,
18253 in unsigned long sockRcv,
18254 in unsigned long TcpWndSnd,
18255 in unsigned long TcpWndRcv
18256 );
18257
18262 void getNetworkSettings (
18263 out unsigned long mtu,
18264 out unsigned long sockSnd,
18265 out unsigned long sockRcv,
18266 out unsigned long TcpWndSnd,
18267 out unsigned long TcpWndRcv
18268 );
18269
18289 void addRedirect (
18290 in wstring name,
18291 in NATProtocol proto,
18292 in wstring hostIp,
18293 in unsigned short hostPort,
18294 in wstring guestIp,
18295 in unsigned short guestPort
18296 );
18297
18303 void removeRedirect (
18304 in wstring name
18305 );
18306
18307 };
18308
18317 interface IExtPackPlugIn : $unknown
18318 {
18322 readonly attribute wstring name;
18323
18327 readonly attribute wstring description;
18328
18334 readonly attribute wstring frontend;
18335
18339 readonly attribute wstring modulePath;
18340
18341 };
18342
18351 interface IExtPackBase : $unknown
18352 {
18356 readonly attribute wstring name;
18357
18361 readonly attribute wstring description;
18362
18371 readonly attribute wstring version;
18372
18376 readonly attribute unsigned long revision;
18377
18381 readonly attribute wstring VRDEModule;
18382
18386 readonly attribute IExtPackPlugIn[] plugIns;
18387
18397 readonly attribute boolean usable;
18398
18405 readonly attribute wstring whyUnusable;
18406
18410 readonly attribute boolean showLicense;
18411
18420 readonly attribute wstring license;
18421
18445 void queryLicense (
18446 in wstring preferredLocale,
18447 in wstring preferredLanguage,
18448 in wstring format,
18449 [retval] out wstring licenseText
18450 );
18451
18452 };
18453
18462 interface IExtPack : IExtPackBase
18463 {
18475 void queryObject (
18476 in wstring objUuid,
18477 [retval] out $unknown returnInterface
18478 );
18479
18480 };
18481
18491 interface IExtPackFile : IExtPackBase
18492 {
18498 readonly attribute wstring filePath;
18499
18518 void install (
18519 in boolean replace,
18520 in wstring displayInfo,
18521 [retval] out IProgress progess
18522 );
18523
18524 };
18525
18536 interface IExtPackManager : $unknown
18537 {
18543 readonly attribute IExtPack[] installedExtPacks;
18544
18562 void find (
18563 in wstring name,
18564 [retval] out IExtPack returnData
18565 );
18566
18577 void openExtPackFile (
18578 in wstring path,
18579 [retval] out IExtPackFile file
18580 );
18581
18600 void uninstall (
18601 in wstring name,
18602 in boolean forcedRemoval,
18603 in wstring displayInfo,
18604 [retval] out IProgress progess
18605 );
18606
18610 void cleanup();
18611
18624 void queryAllPlugInsForFrontend (
18625 in wstring frontendName,
18626 [retval] out wstring[] plugInModules
18627 );
18628
18636 void isExtPackUsable (
18637 in wstring name,
18638 [retval] out boolean usable
18639 );
18640
18641 };
18642
18648 interface IBandwidthGroup : $unknown
18649 {
18653 readonly attribute wstring name;
18654
18658 readonly attribute BandwidthGroupType type;
18659
18663 readonly attribute unsigned long reference;
18664
18669 attribute unsigned long maxMbPerSec;
18670
18671 };
18672
18681 interface IBandwidthControl : $unknown
18682 {
18688 readonly attribute unsigned long numGroups;
18689
18702 void createBandwidthGroup (
18703 in wstring name,
18704 in BandwidthGroupType type,
18705 in unsigned long maxMbPerSec
18706 );
18707
18715 void deleteBandwidthGroup (
18716 in wstring name
18717 );
18718
18728 void getBandwidthGroup (
18729 in wstring name,
18730 [retval] out IBandwidthGroup bandwidthGroup
18731 );
18732
18740 void getAllBandwidthGroups (
18741 [retval] out IBandwidthGroup[] bandwidthGroups
18742 );
18743
18744 };
18745
18758 interface IVirtualBoxClient : $unknown
18759 {
18765 readonly attribute IVirtualBox virtualBox;
18766
18772 readonly attribute ISession session;
18773
18779 readonly attribute IEventSource eventSource;
18780
18781 };
18782
18796 interface IEventSource : $unknown
18797 {
18803 void createListener (
18804 [retval] out IEventListener listener
18805 );
18806
18822 void createAggregator (
18823 in IEventSource[] subordinates,
18824 [retval] out IEventSource result
18825 );
18826
18859 void registerListener (
18860 in IEventListener listener,
18861 in VBoxEventType[] interesting,
18862 in boolean active
18863 );
18864
18873 void unregisterListener (
18874 in IEventListener listener
18875 );
18876
18891 void fireEvent (
18892 in IEvent event,
18893 in long timeout,
18894 [retval] out boolean result
18895 );
18896
18921 void getEvent (
18922 in IEventListener listener,
18923 in long timeout,
18924 [retval] out IEvent event
18925 );
18926
18938 void eventProcessed (
18939 in IEventListener listener,
18940 in IEvent event
18941 );
18942
18943 };
18944
18954 interface IEventListener : $unknown
18955 {
18968 void handleEvent (
18969 in IEvent event
18970 );
18971
18972 };
18973
19050 interface IEvent : $unknown
19051 {
19057 readonly attribute VBoxEventType type;
19058
19064 readonly attribute IEventSource source;
19065
19076 readonly attribute boolean waitable;
19077
19084 void setProcessed();
19085
19099 void waitProcessed (
19100 in long timeout,
19101 [retval] out boolean result
19102 );
19103
19104 };
19105
19111 interface IReusableEvent : IEvent
19112 {
19116 readonly attribute unsigned long generation;
19117
19124 void reuse();
19125
19126 };
19127
19133 interface IMachineEvent : IEvent
19134 {
19138 readonly attribute wstringUUID machineId;
19139
19140 };
19141
19147 interface IMachineStateChangedEvent : IMachineEvent
19148 {
19152 readonly attribute MachineState state;
19153
19154 };
19155
19163 interface IMachineDataChangedEvent : IMachineEvent
19164 {
19171 readonly attribute boolean temporary;
19172
19173 };
19174
19183 interface IMediumRegisteredEvent : IEvent
19184 {
19188 readonly attribute wstringUUID mediumId;
19189
19193 readonly attribute DeviceType mediumType;
19194
19201 readonly attribute boolean registered;
19202
19203 };
19204
19213 interface IMachineRegisteredEvent : IMachineEvent
19214 {
19221 readonly attribute boolean registered;
19222
19223 };
19224
19234 interface ISessionStateChangedEvent : IMachineEvent
19235 {
19241 readonly attribute SessionState state;
19242
19243 };
19244
19252 interface IGuestPropertyChangedEvent : IMachineEvent
19253 {
19259 readonly attribute wstring name;
19260
19266 readonly attribute wstring value;
19267
19273 readonly attribute wstring flags;
19274
19275 };
19276
19282 interface ISnapshotEvent : IMachineEvent
19283 {
19287 readonly attribute wstringUUID snapshotId;
19288
19289 };
19290
19300 interface ISnapshotTakenEvent : ISnapshotEvent
19301 {
19302 };
19303
19320 interface ISnapshotDeletedEvent : ISnapshotEvent
19321 {
19322 };
19323
19333 interface ISnapshotChangedEvent : ISnapshotEvent
19334 {
19335 };
19336
19345 interface IMousePointerShapeChangedEvent : IEvent
19346 {
19352 readonly attribute boolean visible;
19353
19359 readonly attribute boolean alpha;
19360
19366 readonly attribute unsigned long xhot;
19367
19373 readonly attribute unsigned long yhot;
19374
19380 readonly attribute unsigned long width;
19381
19387 readonly attribute unsigned long height;
19388
19421 readonly attribute octet[] shape;
19422
19423 };
19424
19433 interface IMouseCapabilityChangedEvent : IEvent
19434 {
19440 readonly attribute boolean supportsAbsolute;
19441
19447 readonly attribute boolean supportsRelative;
19448
19454 readonly attribute boolean needsHostCursor;
19455
19456 };
19457
19466 interface IKeyboardLedsChangedEvent : IEvent
19467 {
19473 readonly attribute boolean numLock;
19474
19480 readonly attribute boolean capsLock;
19481
19487 readonly attribute boolean scrollLock;
19488
19489 };
19490
19499 interface IStateChangedEvent : IEvent
19500 {
19506 readonly attribute MachineState state;
19507
19508 };
19509
19519 interface IAdditionsStateChangedEvent : IEvent
19520 {
19521 };
19522
19533 interface INetworkAdapterChangedEvent : IEvent
19534 {
19540 readonly attribute INetworkAdapter networkAdapter;
19541
19542 };
19543
19554 interface ISerialPortChangedEvent : IEvent
19555 {
19561 readonly attribute ISerialPort serialPort;
19562
19563 };
19564
19575 interface IParallelPortChangedEvent : IEvent
19576 {
19582 readonly attribute IParallelPort parallelPort;
19583
19584 };
19585
19595 interface IStorageControllerChangedEvent : IEvent
19596 {
19597 };
19598
19608 interface IMediumChangedEvent : IEvent
19609 {
19615 readonly attribute IMediumAttachment mediumAttachment;
19616
19617 };
19618
19626 interface ICPUChangedEvent : IEvent
19627 {
19633 readonly attribute unsigned long cpu;
19634
19640 readonly attribute boolean add;
19641
19642 };
19643
19651 interface ICPUExecutionCapChangedEvent : IEvent
19652 {
19658 readonly attribute unsigned long executionCap;
19659
19660 };
19661
19669 interface IGuestKeyboardEvent : IEvent
19670 {
19676 readonly attribute long[] scancodes;
19677
19678 };
19679
19687 interface IGuestMouseEvent : IReusableEvent
19688 {
19694 readonly attribute boolean absolute;
19695
19701 readonly attribute long x;
19702
19708 readonly attribute long y;
19709
19715 readonly attribute long z;
19716
19722 readonly attribute long w;
19723
19729 readonly attribute long buttons;
19730
19731 };
19732
19743 interface IVRDEServerChangedEvent : IEvent
19744 {
19745 };
19746
19756 interface IVRDEServerInfoChangedEvent : IEvent
19757 {
19758 };
19759
19770 interface IUSBControllerChangedEvent : IEvent
19771 {
19772 };
19773
19797 interface IUSBDeviceStateChangedEvent : IEvent
19798 {
19804 readonly attribute IUSBDevice device;
19805
19811 readonly attribute boolean attached;
19812
19818 readonly attribute IVirtualBoxErrorInfo error;
19819
19820 };
19821
19837 interface ISharedFolderChangedEvent : IEvent
19838 {
19844 readonly attribute Scope scope;
19845
19846 };
19847
19899 interface IRuntimeErrorEvent : IEvent
19900 {
19906 readonly attribute boolean fatal;
19907
19913 readonly attribute wstring id;
19914
19920 readonly attribute wstring message;
19921
19922 };
19923
19931 interface IEventSourceChangedEvent : IEvent
19932 {
19938 readonly attribute IEventListener listener;
19939
19945 readonly attribute boolean add;
19946
19947 };
19948
19957 interface IExtraDataChangedEvent : IEvent
19958 {
19965 readonly attribute wstringUUID machineId;
19966
19972 readonly attribute wstring key;
19973
19979 readonly attribute wstring value;
19980
19981 };
19982
19988 interface IVetoEvent : IEvent
19989 {
19999 void addVeto (
20000 in wstring reason
20001 );
20002
20012 void isVetoed (
20013 [retval] out boolean result
20014 );
20015
20025 void getVetos (
20026 [retval] out wstring[] result
20027 );
20028
20029 };
20030
20040 interface IExtraDataCanChangeEvent : IVetoEvent
20041 {
20048 readonly attribute wstringUUID machineId;
20049
20055 readonly attribute wstring key;
20056
20062 readonly attribute wstring value;
20063
20064 };
20065
20081 interface ICanShowWindowEvent : IVetoEvent
20082 {
20083 };
20084
20116 interface IShowWindowEvent : IEvent
20117 {
20126 attribute long long winId;
20127
20128 };
20129
20137 interface INATRedirectEvent : IMachineEvent
20138 {
20144 readonly attribute unsigned long slot;
20145
20151 readonly attribute boolean remove;
20152
20158 readonly attribute wstring name;
20159
20165 readonly attribute NATProtocol proto;
20166
20172 readonly attribute wstring hostIp;
20173
20179 readonly attribute long hostPort;
20180
20186 readonly attribute wstring guestIp;
20187
20193 readonly attribute long guestPort;
20194
20195 };
20196
20209 interface IHostPciDevicePlugEvent : IMachineEvent
20210 {
20216 readonly attribute boolean plugged;
20217
20224 readonly attribute boolean success;
20225
20231 readonly attribute IPciDeviceAttachment attachment;
20232
20238 readonly attribute wstring message;
20239
20240 };
20241
20250 interface IVBoxSVCAvailabilityChangedEvent : IEvent
20251 {
20257 readonly attribute boolean available;
20258
20259 };
20260
20268 interface IBandwidthGroupChangedEvent : IEvent
20269 {
20275 readonly attribute IBandwidthGroup bandwidthGroup;
20276
20277 };
20278
20286 interface IGuestMonitorChangedEvent : IEvent
20287 {
20293 readonly attribute GuestMonitorChangedEventType changeType;
20294
20300 readonly attribute unsigned long screenId;
20301
20308 readonly attribute unsigned long originX;
20309
20316 readonly attribute unsigned long originY;
20317
20324 readonly attribute unsigned long width;
20325
20332 readonly attribute unsigned long height;
20333
20334 };
20335
20345 interface IStorageDeviceChangedEvent : IEvent
20346 {
20352 readonly attribute IMediumAttachment storageDevice;
20353
20359 readonly attribute boolean removed;
20360
20361 };
20362
20363