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,
02041 };
02042
02043 enum DataType
02044 {
02045 DataType_Int32 = 0,
02046 DataType_Int8 = 1,
02047 DataType_String = 2,
02048 };
02049
02050 enum DataFlags
02051 {
02052 DataFlags_None = 0x00,
02053 DataFlags_Mandatory = 0x01,
02054 DataFlags_Expert = 0x02,
02055 DataFlags_Array = 0x04,
02056 DataFlags_FlagMask = 0x07,
02057 };
02058
02066 enum MediumFormatCapabilities
02067 {
02074 MediumFormatCapabilities_Uuid = 0x01,
02081 MediumFormatCapabilities_CreateFixed = 0x02,
02089 MediumFormatCapabilities_CreateDynamic = 0x04,
02096 MediumFormatCapabilities_CreateSplit2G = 0x08,
02103 MediumFormatCapabilities_Differencing = 0x10,
02110 MediumFormatCapabilities_Asynchronous = 0x20,
02120 MediumFormatCapabilities_File = 0x40,
02129 MediumFormatCapabilities_Properties = 0x80,
02136 MediumFormatCapabilities_TcpNetworking = 0x100,
02143 MediumFormatCapabilities_VFS = 0x200,
02144 MediumFormatCapabilities_CapabilityMask = 0x3FF,
02145 };
02146
02154 enum MouseButtonState
02155 {
02156 MouseButtonState_LeftButton = 0x01,
02157 MouseButtonState_RightButton = 0x02,
02158 MouseButtonState_MiddleButton = 0x04,
02159 MouseButtonState_WheelUp = 0x08,
02160 MouseButtonState_WheelDown = 0x10,
02161 MouseButtonState_XButton1 = 0x20,
02162 MouseButtonState_XButton2 = 0x40,
02163 MouseButtonState_MouseStateMask = 0x7F,
02164 };
02165
02176 enum FramebufferPixelFormat
02177 {
02185 FramebufferPixelFormat_Opaque = 0,
02193 FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
02194 };
02195
02203 enum NetworkAttachmentType
02204 {
02209 NetworkAttachmentType_Null = 0,
02210 NetworkAttachmentType_NAT = 1,
02211 NetworkAttachmentType_Bridged = 2,
02212 NetworkAttachmentType_Internal = 3,
02213 NetworkAttachmentType_HostOnly = 4,
02214 NetworkAttachmentType_Generic = 5,
02215 };
02216
02224 enum NetworkAdapterType
02225 {
02230 NetworkAdapterType_Null = 0,
02235 NetworkAdapterType_Am79C970A = 1,
02240 NetworkAdapterType_Am79C973 = 2,
02245 NetworkAdapterType_I82540EM = 3,
02250 NetworkAdapterType_I82543GC = 4,
02255 NetworkAdapterType_I82545EM = 5,
02260 NetworkAdapterType_Virtio = 6,
02261 };
02262
02270 enum NetworkAdapterPromiscModePolicy
02271 {
02276 NetworkAdapterPromiscModePolicy_Deny = 1,
02284 NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
02292 NetworkAdapterPromiscModePolicy_AllowAll = 3,
02293 };
02294
02303 enum PortMode
02304 {
02309 PortMode_Disconnected = 0,
02314 PortMode_HostPipe = 1,
02319 PortMode_HostDevice = 2,
02324 PortMode_RawFile = 3,
02325 };
02326
02365 enum USBDeviceState
02366 {
02373 USBDeviceState_NotSupported = 0,
02381 USBDeviceState_Unavailable = 1,
02388 USBDeviceState_Busy = 2,
02396 USBDeviceState_Available = 3,
02404 USBDeviceState_Held = 4,
02412 USBDeviceState_Captured = 5,
02413 };
02414
02424 enum USBDeviceFilterAction
02425 {
02430 USBDeviceFilterAction_Null = 0,
02435 USBDeviceFilterAction_Ignore = 1,
02440 USBDeviceFilterAction_Hold = 2,
02441 };
02442
02450 enum AudioDriverType
02451 {
02456 AudioDriverType_Null = 0,
02461 AudioDriverType_WinMM = 1,
02466 AudioDriverType_OSS = 2,
02471 AudioDriverType_ALSA = 3,
02476 AudioDriverType_DirectSound = 4,
02481 AudioDriverType_CoreAudio = 5,
02486 AudioDriverType_MMPM = 6,
02491 AudioDriverType_Pulse = 7,
02496 AudioDriverType_SolAudio = 8,
02497 };
02498
02506 enum AudioControllerType
02507 {
02508 AudioControllerType_AC97 = 0,
02509 AudioControllerType_SB16 = 1,
02510 AudioControllerType_HDA = 2,
02511 };
02512
02520 enum AuthType
02521 {
02526 AuthType_Null = 0,
02527 AuthType_External = 1,
02528 AuthType_Guest = 2,
02529 };
02530
02539 enum StorageBus
02540 {
02545 StorageBus_Null = 0,
02546 StorageBus_IDE = 1,
02547 StorageBus_SATA = 2,
02548 StorageBus_SCSI = 3,
02549 StorageBus_Floppy = 4,
02550 StorageBus_SAS = 5,
02551 };
02552
02561 enum StorageControllerType
02562 {
02567 StorageControllerType_Null = 0,
02572 StorageControllerType_LsiLogic = 1,
02577 StorageControllerType_BusLogic = 2,
02582 StorageControllerType_IntelAhci = 3,
02587 StorageControllerType_PIIX3 = 4,
02592 StorageControllerType_PIIX4 = 5,
02597 StorageControllerType_ICH6 = 6,
02602 StorageControllerType_I82078 = 7,
02607 StorageControllerType_LsiLogicSas = 8,
02608 };
02609
02617 enum ChipsetType
02618 {
02623 ChipsetType_Null = 0,
02628 ChipsetType_PIIX3 = 1,
02633 ChipsetType_ICH9 = 2,
02634 };
02635
02641 enum NATAliasMode
02642 {
02647 NATAliasMode_AliasLog = 0x1,
02652 NATAliasMode_AliasProxyOnly = 0x02,
02657 NATAliasMode_AliasUseSamePorts = 0x04,
02658 };
02659
02665 enum NATProtocol
02666 {
02671 NATProtocol_UDP = 0,
02676 NATProtocol_TCP = 1,
02677 };
02678
02686 enum BandwidthGroupType
02687 {
02694 BandwidthGroupType_Null = 0,
02701 BandwidthGroupType_Disk = 1,
02708 BandwidthGroupType_Network = 2,
02709 };
02710
02719 enum VBoxEventType
02720 {
02727 VBoxEventType_Invalid = 0,
02736 VBoxEventType_Any = 1,
02744 VBoxEventType_Vetoable = 2,
02752 VBoxEventType_MachineEvent = 3,
02760 VBoxEventType_SnapshotEvent = 4,
02769 VBoxEventType_InputEvent = 5,
02776 VBoxEventType_LastWildcard = 31,
02783 VBoxEventType_OnMachineStateChanged = 32,
02790 VBoxEventType_OnMachineDataChanged = 33,
02797 VBoxEventType_OnExtraDataChanged = 34,
02804 VBoxEventType_OnExtraDataCanChange = 35,
02811 VBoxEventType_OnMediumRegistered = 36,
02818 VBoxEventType_OnMachineRegistered = 37,
02825 VBoxEventType_OnSessionStateChanged = 38,
02832 VBoxEventType_OnSnapshotTaken = 39,
02839 VBoxEventType_OnSnapshotDeleted = 40,
02846 VBoxEventType_OnSnapshotChanged = 41,
02853 VBoxEventType_OnGuestPropertyChanged = 42,
02860 VBoxEventType_OnMousePointerShapeChanged = 43,
02867 VBoxEventType_OnMouseCapabilityChanged = 44,
02874 VBoxEventType_OnKeyboardLedsChanged = 45,
02881 VBoxEventType_OnStateChanged = 46,
02888 VBoxEventType_OnAdditionsStateChanged = 47,
02895 VBoxEventType_OnNetworkAdapterChanged = 48,
02902 VBoxEventType_OnSerialPortChanged = 49,
02909 VBoxEventType_OnParallelPortChanged = 50,
02916 VBoxEventType_OnStorageControllerChanged = 51,
02923 VBoxEventType_OnMediumChanged = 52,
02930 VBoxEventType_OnVRDEServerChanged = 53,
02937 VBoxEventType_OnUSBControllerChanged = 54,
02944 VBoxEventType_OnUSBDeviceStateChanged = 55,
02951 VBoxEventType_OnSharedFolderChanged = 56,
02958 VBoxEventType_OnRuntimeError = 57,
02965 VBoxEventType_OnCanShowWindow = 58,
02972 VBoxEventType_OnShowWindow = 59,
02979 VBoxEventType_OnCPUChanged = 60,
02986 VBoxEventType_OnVRDEServerInfoChanged = 61,
02993 VBoxEventType_OnEventSourceChanged = 62,
03000 VBoxEventType_OnCPUExecutionCapChanged = 63,
03007 VBoxEventType_OnGuestKeyboard = 64,
03014 VBoxEventType_OnGuestMouse = 65,
03021 VBoxEventType_OnNATRedirect = 66,
03028 VBoxEventType_OnHostPciDevicePlug = 67,
03035 VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
03042 VBoxEventType_OnBandwidthGroupChanged = 69,
03049 VBoxEventType_OnGuestMonitorChanged = 70,
03056 VBoxEventType_OnStorageDeviceChanged = 71,
03063 VBoxEventType_Last = 72,
03064 };
03065
03073 enum GuestMonitorChangedEventType
03074 {
03081 GuestMonitorChangedEventType_Enabled = 0,
03088 GuestMonitorChangedEventType_Disabled = 1,
03095 GuestMonitorChangedEventType_NewOrigin = 2,
03096 };
03097
03131 interface IVirtualBoxErrorInfo : $errorinfo
03132 {
03150 readonly attribute long resultCode;
03151
03163 readonly attribute wstringUUID interfaceID;
03164
03175 readonly attribute wstring component;
03176
03187 readonly attribute wstring text;
03188
03199 readonly attribute IVirtualBoxErrorInfo next;
03200
03201 };
03202
03213 interface IDHCPServer : $unknown
03214 {
03220 attribute boolean enabled;
03221
03227 readonly attribute wstring IPAddress;
03228
03234 readonly attribute wstring networkMask;
03235
03241 readonly attribute wstring networkName;
03242
03248 readonly attribute wstring lowerIP;
03249
03255 readonly attribute wstring upperIP;
03256
03285 void setConfiguration (
03286 in wstring IPAddress,
03287 in wstring networkMask,
03288 in wstring FromIPAddress,
03289 in wstring ToIPAddress
03290 );
03291
03316 void start (
03317 in wstring networkName,
03318 in wstring trunkName,
03319 in wstring trunkType
03320 );
03321
03334 void stop();
03335
03336 };
03337
03356 interface IVirtualBox : $unknown
03357 {
03365 readonly attribute wstring version;
03366
03372 readonly attribute unsigned long revision;
03373
03383 readonly attribute wstring packageType;
03384
03396 readonly attribute wstring APIVersion;
03397
03413 readonly attribute wstring homeFolder;
03414
03422 readonly attribute wstring settingsFilePath;
03423
03427 readonly attribute IHost host;
03428
03432 readonly attribute ISystemProperties systemProperties;
03433
03439 readonly attribute IMachine[] machines;
03440
03450 readonly attribute IMedium[] hardDisks;
03451
03457 readonly attribute IMedium[] DVDImages;
03458
03464 readonly attribute IMedium[] floppyImages;
03465
03466 readonly attribute IProgress[] progressOperations;
03467
03468 readonly attribute IGuestOSType[] guestOSTypes;
03469
03486 readonly attribute ISharedFolder[] sharedFolders;
03487
03493 readonly attribute IPerformanceCollector performanceCollector;
03494
03500 readonly attribute IDHCPServer[] DHCPServers;
03501
03507 readonly attribute IEventSource eventSource;
03508
03514 readonly attribute IExtPackManager extensionPackManager;
03515
03521 readonly attribute wstring[] internalNetworks;
03522
03528 readonly attribute wstring[] genericNetworkDrivers;
03529
03569 void composeMachineFilename (
03570 in wstring name,
03571 in wstring baseFolder,
03572 [retval] out wstring file
03573 );
03574
03671 void createMachine (
03672 in wstring settingsFile,
03673 in wstring name,
03674 in wstring osTypeId,
03675 in wstringUUID id,
03676 in boolean forceOverwrite,
03677 [retval] out IMachine machine
03678 );
03679
03705 void openMachine (
03706 in wstring settingsFile,
03707 [retval] out IMachine machine
03708 );
03709
03741 void registerMachine (
03742 in IMachine machine
03743 );
03744
03765 void findMachine (
03766 in wstring nameOrId,
03767 [retval] out IMachine machine
03768 );
03769
03779 void createAppliance (
03780 [retval] out IAppliance appliance
03781 );
03782
03845 void createHardDisk (
03846 in wstring format,
03847 in wstring location,
03848 [retval] out IMedium medium
03849 );
03850
03955 void openMedium (
03956 in wstring location,
03957 in DeviceType deviceType,
03958 in AccessMode accessMode,
03959 in boolean forceNewUuid,
03960 [retval] out IMedium medium
03961 );
03962
03994 void findMedium (
03995 in wstring location,
03996 in DeviceType type,
03997 [retval] out IMedium medium
03998 );
03999
04028 void getGuestOSType (
04029 in wstringUUID id,
04030 [retval] out IGuestOSType type
04031 );
04032
04055 void createSharedFolder (
04056 in wstring name,
04057 in wstring hostPath,
04058 in boolean writable,
04059 in boolean automount
04060 );
04061
04076 void removeSharedFolder (
04077 in wstring name
04078 );
04079
04088 void getExtraDataKeys (
04089 [retval] out wstring[] value
04090 );
04091
04120 void getExtraData (
04121 in wstring key,
04122 [retval] out wstring value
04123 );
04124
04174 void setExtraData (
04175 in wstring key,
04176 in wstring value
04177 );
04178
04195 void createDHCPServer (
04196 in wstring name,
04197 [retval] out IDHCPServer server
04198 );
04199
04216 void findDHCPServerByNetworkName (
04217 in wstring name,
04218 [retval] out IDHCPServer server
04219 );
04220
04235 void removeDHCPServer (
04236 in IDHCPServer server
04237 );
04238
04263 void checkFirmwarePresent (
04264 in FirmwareType firmwareType,
04265 in wstring version,
04266 out wstring url,
04267 out wstring file,
04268 [retval] out boolean result
04269 );
04270
04271 };
04272
04283 interface IVFSExplorer : $unknown
04284 {
04288 readonly attribute wstring path;
04289
04293 readonly attribute VFSType type;
04294
04302 void update (
04303 [retval] out IProgress aProgress
04304 );
04305
04313 void cd (
04314 in wstring aDir,
04315 [retval] out IProgress aProgress
04316 );
04317
04323 void cdUp (
04324 [retval] out IProgress aProgress
04325 );
04326
04339 void entryList (
04340 out wstring[] aNames,
04341 out unsigned long[] aTypes,
04342 out unsigned long[] aSizes,
04343 out unsigned long[] aModes
04344 );
04345
04354 void exists (
04355 in wstring[] aNames,
04356 [retval] out wstring[] aExists
04357 );
04358
04366 void remove (
04367 in wstring[] aNames,
04368 [retval] out IProgress aProgress
04369 );
04370
04371 };
04372
04438 interface IAppliance : $unknown
04439 {
04447 readonly attribute wstring path;
04448
04479 readonly attribute wstring[] disks;
04480
04488 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
04489
04497 readonly attribute wstring[] machines;
04498
04515 void read (
04516 in wstring file,
04517 [retval] out IProgress aProgress
04518 );
04519
04536 void interpret();
04537
04560 void importMachines (
04561 in ImportOptions[] options,
04562 [retval] out IProgress aProgress
04563 );
04564
04572 void createVFSExplorer (
04573 in wstring aUri,
04574 [retval] out IVFSExplorer aExplorer
04575 );
04576
04606 void write (
04607 in wstring format,
04608 in boolean manifest,
04609 in wstring path,
04610 [retval] out IProgress progress
04611 );
04612
04618 void getWarnings (
04619 [retval] out wstring[] aWarnings
04620 );
04621
04622 };
04623
04635 interface IVirtualSystemDescription : $unknown
04636 {
04640 readonly attribute unsigned long count;
04641
04765 void getDescription (
04766 out VirtualSystemDescriptionType[] aTypes,
04767 out wstring[] aRefs,
04768 out wstring[] aOvfValues,
04769 out wstring[] aVBoxValues,
04770 out wstring[] aExtraConfigValues
04771 );
04772
04789 void getDescriptionByType (
04790 in VirtualSystemDescriptionType aType,
04791 out VirtualSystemDescriptionType[] aTypes,
04792 out wstring[] aRefs,
04793 out wstring[] aOvfValues,
04794 out wstring[] aVBoxValues,
04795 out wstring[] aExtraConfigValues
04796 );
04797
04809 void getValuesByType (
04810 in VirtualSystemDescriptionType aType,
04811 in VirtualSystemDescriptionValueType aWhich,
04812 [retval] out wstring[] aValues
04813 );
04814
04840 void setFinalValues (
04841 in boolean[] aEnabled,
04842 in wstring[] aVBoxValues,
04843 in wstring[] aExtraConfigValues
04844 );
04845
04860 void addDescription (
04861 in VirtualSystemDescriptionType aType,
04862 in wstring aVBoxValue,
04863 in wstring aExtraConfigValue
04864 );
04865
04866 };
04867
04868 interface IInternalMachineControl : $unknown
04869 {
04876 void setRemoveSavedStateFile (
04877 in boolean aRemove
04878 );
04879
04891 void updateState (
04892 in MachineState state
04893 );
04894
04895 void getIPCId (
04896 [retval] out wstring id
04897 );
04898
04910 void beginPowerUp (
04911 in IProgress aProgress
04912 );
04913
04923 void endPowerUp (
04924 in long result
04925 );
04926
04938 void beginPoweringDown (
04939 out IProgress progress
04940 );
04941
04971 void endPoweringDown (
04972 in long result,
04973 in wstring errMsg
04974 );
04975
04989 void runUSBDeviceFilters (
04990 in IUSBDevice device,
04991 out boolean matched,
04992 out unsigned long maskedInterfaces
04993 );
04994
05003 void captureUSBDevice (
05004 in wstringUUID id
05005 );
05006
05022 void detachUSBDevice (
05023 in wstringUUID id,
05024 in boolean done
05025 );
05026
05035 void autoCaptureUSBDevices();
05036
05052 void detachAllUSBDevices (
05053 in boolean done
05054 );
05055
05070 void onSessionEnd (
05071 in ISession session,
05072 [retval] out IProgress progress
05073 );
05074
05090 void beginSavingState (
05091 out IProgress progress,
05092 out wstring stateFilePath
05093 );
05094
05124 void endSavingState (
05125 in long result,
05126 in wstring errMsg
05127 );
05128
05143 void adoptSavedState (
05144 in wstring savedStateFile
05145 );
05146
05195 void beginTakingSnapshot (
05196 in IConsole initiator,
05197 in wstring name,
05198 in wstring description,
05199 in IProgress consoleProgress,
05200 in boolean fTakingSnapshotOnline,
05201 out wstring stateFilePath
05202 );
05203
05213 void endTakingSnapshot (
05214 in boolean success
05215 );
05216
05245 void deleteSnapshot (
05246 in IConsole initiator,
05247 in wstringUUID startId,
05248 in wstringUUID endId,
05249 in boolean deleteAllChildren,
05250 out MachineState machineState,
05251 [retval] out IProgress progress
05252 );
05253
05272 void finishOnlineMergeMedium (
05273 in IMediumAttachment mediumAttachment,
05274 in IMedium source,
05275 in IMedium target,
05276 in boolean mergeForward,
05277 in IMedium parentForTarget,
05278 in IMedium[] childrenToReparent
05279 );
05280
05294 void restoreSnapshot (
05295 in IConsole initiator,
05296 in ISnapshot snapshot,
05297 out MachineState machineState,
05298 [retval] out IProgress progress
05299 );
05300
05327 void pullGuestProperties (
05328 out wstring[] name,
05329 out wstring[] value,
05330 out long long[] timestamp,
05331 out wstring[] flags
05332 );
05333
05355 void pushGuestProperty (
05356 in wstring name,
05357 in wstring value,
05358 in long long timestamp,
05359 in wstring flags
05360 );
05361
05373 void lockMedia();
05374
05384 void unlockMedia();
05385
05401 void ejectMedium (
05402 in IMediumAttachment attachment,
05403 [retval] out IMediumAttachment newAttachment
05404 );
05405
05406 };
05407
05416 interface IBIOSSettings : $unknown
05417 {
05421 attribute boolean logoFadeIn;
05422
05426 attribute boolean logoFadeOut;
05427
05431 attribute unsigned long logoDisplayTime;
05432
05439 attribute wstring logoImagePath;
05440
05444 attribute BIOSBootMenuMode bootMenuMode;
05445
05449 attribute boolean ACPIEnabled;
05450
05457 attribute boolean IOAPICEnabled;
05458
05468 attribute long long timeOffset;
05469
05476 attribute boolean PXEDebugEnabled;
05477
05478 };
05479
05487 interface IPciAddress : $unknown
05488 {
05494 attribute short bus;
05495
05501 attribute short device;
05502
05508 attribute short devFunction;
05509
05515 void asLong (
05516 [retval] out long result
05517 );
05518
05524 void fromLong (
05525 in long number
05526 );
05527
05528 };
05529
05537 interface IPciDeviceAttachment : $unknown
05538 {
05544 readonly attribute wstring name;
05545
05551 readonly attribute boolean isPhysicalDevice;
05552
05558 readonly attribute long hostAddress;
05559
05565 readonly attribute long guestAddress;
05566
05567 };
05568
05609 interface IMachine : $unknown
05610 {
05614 readonly attribute IVirtualBox parent;
05615
05665 readonly attribute boolean accessible;
05666
05678 readonly attribute IVirtualBoxErrorInfo accessError;
05679
05719 attribute wstring name;
05720
05731 attribute wstring description;
05732
05736 readonly attribute wstringUUID id;
05737
05752 attribute wstring OSTypeId;
05753
05757 attribute wstring hardwareVersion;
05758
05768 attribute wstringUUID hardwareUUID;
05769
05773 attribute unsigned long CPUCount;
05774
05780 attribute boolean CPUHotPlugEnabled;
05781
05789 attribute unsigned long CPUExecutionCap;
05790
05794 attribute unsigned long memorySize;
05795
05799 attribute unsigned long memoryBalloonSize;
05800
05807 attribute boolean pageFusionEnabled;
05808
05812 attribute unsigned long VRAMSize;
05813
05819 attribute boolean accelerate3DEnabled;
05820
05826 attribute boolean accelerate2DVideoEnabled;
05827
05838 attribute unsigned long monitorCount;
05839
05843 readonly attribute IBIOSSettings BIOSSettings;
05844
05849 attribute FirmwareType firmwareType;
05850
05856 attribute PointingHidType pointingHidType;
05857
05863 attribute KeyboardHidType keyboardHidType;
05864
05871 attribute boolean hpetEnabled;
05872
05876 attribute ChipsetType chipsetType;
05877
05911 attribute wstring snapshotFolder;
05912
05916 readonly attribute IVRDEServer VRDEServer;
05917
05918 attribute boolean emulatedUSBWebcameraEnabled;
05919
05920 attribute boolean emulatedUSBCardReaderEnabled;
05921
05925 readonly attribute IMediumAttachment[] mediumAttachments;
05926
05938 readonly attribute IUSBController USBController;
05939
05943 readonly attribute IAudioAdapter audioAdapter;
05944
05948 readonly attribute IStorageController[] storageControllers;
05949
05955 readonly attribute wstring settingsFilePath;
05956
05981 readonly attribute boolean settingsModified;
05982
05986 readonly attribute SessionState sessionState;
05987
06000 readonly attribute wstring sessionType;
06001
06011 readonly attribute unsigned long sessionPid;
06012
06016 readonly attribute MachineState state;
06017
06024 readonly attribute long long lastStateChange;
06025
06037 readonly attribute wstring stateFilePath;
06038
06048 readonly attribute wstring logFolder;
06049
06060 readonly attribute ISnapshot currentSnapshot;
06061
06068 readonly attribute unsigned long snapshotCount;
06069
06101 readonly attribute boolean currentStateModified;
06102
06114 readonly attribute ISharedFolder[] sharedFolders;
06115
06122 attribute ClipboardMode clipboardMode;
06123
06131 attribute wstring guestPropertyNotificationPatterns;
06132
06141 attribute boolean teleporterEnabled;
06142
06153 attribute unsigned long teleporterPort;
06154
06161 attribute wstring teleporterAddress;
06162
06170 attribute wstring teleporterPassword;
06171
06179 attribute FaultToleranceState faultToleranceState;
06180
06187 attribute unsigned long faultTolerancePort;
06188
06194 attribute wstring faultToleranceAddress;
06195
06203 attribute wstring faultTolerancePassword;
06204
06210 attribute unsigned long faultToleranceSyncInterval;
06211
06219 attribute boolean RTCUseUTC;
06220
06227 attribute boolean ioCacheEnabled;
06228
06234 attribute unsigned long ioCacheSize;
06235
06241 readonly attribute IBandwidthControl bandwidthControl;
06242
06252 readonly attribute IPciDeviceAttachment[] pciDeviceAssignments;
06253
06359 void lockMachine (
06360 in ISession session,
06361 in LockType lockType
06362 );
06363
06493 void launchVMProcess (
06494 in ISession session,
06495 in wstring type,
06496 in wstring environment,
06497 [retval] out IProgress progress
06498 );
06499
06537 void setBootOrder (
06538 in unsigned long position,
06539 in DeviceType device
06540 );
06541
06576 void getBootOrder (
06577 in unsigned long position,
06578 [retval] out DeviceType device
06579 );
06580
06682 void attachDevice (
06683 in wstring name,
06684 in long controllerPort,
06685 in long device,
06686 in DeviceType type,
06687 in IMedium medium
06688 );
06689
06742 void detachDevice (
06743 in wstring name,
06744 in long controllerPort,
06745 in long device
06746 );
06747
06790 void passthroughDevice (
06791 in wstring name,
06792 in long controllerPort,
06793 in long device,
06794 in boolean passthrough
06795 );
06796
06839 void temporaryEjectDevice (
06840 in wstring name,
06841 in long controllerPort,
06842 in long device,
06843 in boolean temporaryEject
06844 );
06845
06891 void nonRotationalDevice (
06892 in wstring name,
06893 in long controllerPort,
06894 in long device,
06895 in boolean nonRotational
06896 );
06897
06938 void setBandwidthGroupForDevice (
06939 in wstring name,
06940 in long controllerPort,
06941 in long device,
06942 in IBandwidthGroup bandwidthGroup
06943 );
06944
07007 void mountMedium (
07008 in wstring name,
07009 in long controllerPort,
07010 in long device,
07011 in IMedium medium,
07012 in boolean force
07013 );
07014
07043 void getMedium (
07044 in wstring name,
07045 in long controllerPort,
07046 in long device,
07047 [retval] out IMedium medium
07048 );
07049
07064 void getMediumAttachmentsOfController (
07065 in wstring name,
07066 [retval] out IMediumAttachment[] mediumAttachments
07067 );
07068
07083 void getMediumAttachment (
07084 in wstring name,
07085 in long controllerPort,
07086 in long device,
07087 [retval] out IMediumAttachment attachment
07088 );
07089
07130 void attachHostPciDevice (
07131 in long hostAddress,
07132 in long desiredGuestAddress,
07133 in boolean tryToUnbind
07134 );
07135
07176 void detachHostPciDevice (
07177 in long hostAddress
07178 );
07179
07197 void getNetworkAdapter (
07198 in unsigned long slot,
07199 [retval] out INetworkAdapter adapter
07200 );
07201
07234 void addStorageController (
07235 in wstring name,
07236 in StorageBus connectionType,
07237 [retval] out IStorageController controller
07238 );
07239
07253 void getStorageControllerByName (
07254 in wstring name,
07255 [retval] out IStorageController storageController
07256 );
07257
07271 void getStorageControllerByInstance (
07272 in unsigned long instance,
07273 [retval] out IStorageController storageController
07274 );
07275
07289 void removeStorageController (
07290 in wstring name
07291 );
07292
07314 void setStorageControllerBootable (
07315 in wstring name,
07316 in boolean bootable
07317 );
07318
07336 void getSerialPort (
07337 in unsigned long slot,
07338 [retval] out ISerialPort port
07339 );
07340
07358 void getParallelPort (
07359 in unsigned long slot,
07360 [retval] out IParallelPort port
07361 );
07362
07371 void getExtraDataKeys (
07372 [retval] out wstring[] value
07373 );
07374
07403 void getExtraData (
07404 in wstring key,
07405 [retval] out wstring value
07406 );
07407
07457 void setExtraData (
07458 in wstring key,
07459 in wstring value
07460 );
07461
07483 void getCPUProperty (
07484 in CPUPropertyType property,
07485 [retval] out boolean value
07486 );
07487
07509 void setCPUProperty (
07510 in CPUPropertyType property,
07511 in boolean value
07512 );
07513
07553 void getCPUIDLeaf (
07554 in unsigned long id,
07555 out unsigned long valEax,
07556 out unsigned long valEbx,
07557 out unsigned long valEcx,
07558 out unsigned long valEdx
07559 );
07560
07604 void setCPUIDLeaf (
07605 in unsigned long id,
07606 in unsigned long valEax,
07607 in unsigned long valEbx,
07608 in unsigned long valEcx,
07609 in unsigned long valEdx
07610 );
07611
07629 void removeCPUIDLeaf (
07630 in unsigned long id
07631 );
07632
07638 void removeAllCPUIDLeaves();
07639
07661 void getHWVirtExProperty (
07662 in HWVirtExPropertyType property,
07663 [retval] out boolean value
07664 );
07665
07687 void setHWVirtExProperty (
07688 in HWVirtExPropertyType property,
07689 in boolean value
07690 );
07691
07737 void saveSettings();
07738
07762 void discardSettings();
07763
07847 void unregister (
07848 in CleanupMode cleanupMode,
07849 [retval] out IMedium[] aMedia
07850 );
07851
07908 void delete (
07909 in IMedium[] aMedia,
07910 [retval] out IProgress aProgress
07911 );
07912
07924 void export (
07925 in IAppliance aAppliance,
07926 in wstring location,
07927 [retval] out IVirtualSystemDescription aDescription
07928 );
07929
07953 void findSnapshot (
07954 in wstring nameOrId,
07955 [retval] out ISnapshot snapshot
07956 );
07957
07991 void createSharedFolder (
07992 in wstring name,
07993 in wstring hostPath,
07994 in boolean writable,
07995 in boolean automount
07996 );
07997
08023 void removeSharedFolder (
08024 in wstring name
08025 );
08026
08050 void canShowConsoleWindow (
08051 [retval] out boolean canShow
08052 );
08053
08088 void showConsoleWindow (
08089 [retval] out long long winId
08090 );
08091
08124 void getGuestProperty (
08125 in wstring name,
08126 out wstring value,
08127 out long long timestamp,
08128 out wstring flags
08129 );
08130
08153 void getGuestPropertyValue (
08154 in wstring property,
08155 [retval] out wstring value
08156 );
08157
08180 void getGuestPropertyTimestamp (
08181 in wstring property,
08182 [retval] out long long value
08183 );
08184
08235 void setGuestProperty (
08236 in wstring property,
08237 in wstring value,
08238 in wstring flags
08239 );
08240
08281 void setGuestPropertyValue (
08282 in wstring property,
08283 in wstring value
08284 );
08285
08316 void enumerateGuestProperties (
08317 in wstring patterns,
08318 out wstring[] name,
08319 out wstring[] value,
08320 out long long[] timestamp,
08321 out wstring[] flags
08322 );
08323
08341 void querySavedGuestSize (
08342 in unsigned long screenId,
08343 out unsigned long width,
08344 out unsigned long height
08345 );
08346
08368 void querySavedThumbnailSize (
08369 in unsigned long screenId,
08370 out unsigned long size,
08371 out unsigned long width,
08372 out unsigned long height
08373 );
08374
08401 void readSavedThumbnailToArray (
08402 in unsigned long screenId,
08403 in boolean BGR,
08404 out unsigned long width,
08405 out unsigned long height,
08406 [retval] out octet[] data
08407 );
08408
08430 void readSavedThumbnailPNGToArray (
08431 in unsigned long screenId,
08432 out unsigned long width,
08433 out unsigned long height,
08434 [retval] out octet[] data
08435 );
08436
08458 void querySavedScreenshotPNGSize (
08459 in unsigned long screenId,
08460 out unsigned long size,
08461 out unsigned long width,
08462 out unsigned long height
08463 );
08464
08486 void readSavedScreenshotPNGToArray (
08487 in unsigned long screenId,
08488 out unsigned long width,
08489 out unsigned long height,
08490 [retval] out octet[] data
08491 );
08492
08502 void hotPlugCPU (
08503 in unsigned long cpu
08504 );
08505
08515 void hotUnplugCPU (
08516 in unsigned long cpu
08517 );
08518
08532 void getCPUStatus (
08533 in unsigned long cpu,
08534 [retval] out boolean attached
08535 );
08536
08551 void queryLogFilename (
08552 in unsigned long idx,
08553 [retval] out wstring filename
08554 );
08555
08581 void readLog (
08582 in unsigned long idx,
08583 in long long offset,
08584 in long long size,
08585 [retval] out octet[] data
08586 );
08587
08620 void cloneTo (
08621 in IMachine target,
08622 in CloneMode mode,
08623 in CloneOptions[] options,
08624 [retval] out IProgress progress
08625 );
08626
08627 };
08628
08637 interface IVRDEServerInfo : $unknown
08638 {
08644 readonly attribute boolean active;
08645
08654 readonly attribute long port;
08655
08661 readonly attribute unsigned long numberOfClients;
08662
08668 readonly attribute long long beginTime;
08669
08676 readonly attribute long long endTime;
08677
08683 readonly attribute long long bytesSent;
08684
08690 readonly attribute long long bytesSentTotal;
08691
08697 readonly attribute long long bytesReceived;
08698
08704 readonly attribute long long bytesReceivedTotal;
08705
08711 readonly attribute wstring user;
08712
08718 readonly attribute wstring domain;
08719
08725 readonly attribute wstring clientName;
08726
08732 readonly attribute wstring clientIP;
08733
08739 readonly attribute unsigned long clientVersion;
08740
08748 readonly attribute unsigned long encryptionStyle;
08749
08750 };
08751
08773 interface IConsole : $unknown
08774 {
08786 readonly attribute IMachine machine;
08787
08801 readonly attribute MachineState state;
08802
08806 readonly attribute IGuest guest;
08807
08818 readonly attribute IKeyboard keyboard;
08819
08830 readonly attribute IMouse mouse;
08831
08841 readonly attribute IDisplay display;
08842
08846 readonly attribute IMachineDebugger debugger;
08847
08858 readonly attribute IUSBDevice[] USBDevices;
08859
08867 readonly attribute IHostUSBDevice[] remoteUSBDevices;
08868
08884 readonly attribute ISharedFolder[] sharedFolders;
08885
08891 readonly attribute IVRDEServerInfo VRDEServerInfo;
08892
08898 readonly attribute IEventSource eventSource;
08899
08903 readonly attribute IPciDeviceAttachment[] attachedPciDevices;
08904
08913 attribute boolean useHostClipboard;
08914
08979 void powerUp (
08980 [retval] out IProgress progress
08981 );
08982
09016 void powerUpPaused (
09017 [retval] out IProgress progress
09018 );
09019
09039 void powerDown (
09040 [retval] out IProgress progress
09041 );
09042
09062 void reset();
09063
09083 void pause();
09084
09104 void resume();
09105
09125 void powerButton();
09126
09146 void sleepButton();
09147
09159 void getPowerButtonHandled (
09160 [retval] out boolean handled
09161 );
09162
09176 void getGuestEnteredACPIMode (
09177 [retval] out boolean entered
09178 );
09179
09232 void saveState (
09233 [retval] out IProgress progress
09234 );
09235
09268 void adoptSavedState (
09269 in wstring savedStateFile
09270 );
09271
09302 void discardSavedState (
09303 in boolean fRemoveFile
09304 );
09305
09318 void getDeviceActivity (
09319 in DeviceType type,
09320 [retval] out DeviceActivity activity
09321 );
09322
09360 void attachUSBDevice (
09361 in wstringUUID id
09362 );
09363
09398 void detachUSBDevice (
09399 in wstringUUID id,
09400 [retval] out IUSBDevice device
09401 );
09402
09425 void findUSBDeviceByAddress (
09426 in wstring name,
09427 [retval] out IUSBDevice device
09428 );
09429
09449 void findUSBDeviceById (
09450 in wstringUUID id,
09451 [retval] out IUSBDevice device
09452 );
09453
09487 void createSharedFolder (
09488 in wstring name,
09489 in wstring hostPath,
09490 in boolean writable,
09491 in boolean automount
09492 );
09493
09518 void removeSharedFolder (
09519 in wstring name
09520 );
09521
09559 void takeSnapshot (
09560 in wstring name,
09561 in wstring description,
09562 [retval] out IProgress progress
09563 );
09564
09637 void deleteSnapshot (
09638 in wstringUUID id,
09639 [retval] out IProgress progress
09640 );
09641
09681 void deleteSnapshotAndAllChildren (
09682 in wstringUUID id,
09683 [retval] out IProgress progress
09684 );
09685
09729 void deleteSnapshotRange (
09730 in wstringUUID startId,
09731 in wstringUUID endId,
09732 [retval] out IProgress progress
09733 );
09734
09775 void restoreSnapshot (
09776 in ISnapshot snapshot,
09777 [retval] out IProgress progress
09778 );
09779
09818 void teleport (
09819 in wstring hostname,
09820 in unsigned long tcpport,
09821 in wstring password,
09822 in unsigned long maxDowntime,
09823 [retval] out IProgress progress
09824 );
09825
09826 };
09827
09838 interface IHostNetworkInterface : $unknown
09839 {
09843 readonly attribute wstring name;
09844
09848 readonly attribute wstringUUID id;
09849
09853 readonly attribute wstring networkName;
09854
09858 readonly attribute boolean dhcpEnabled;
09859
09863 readonly attribute wstring IPAddress;
09864
09868 readonly attribute wstring networkMask;
09869
09873 readonly attribute boolean IPV6Supported;
09874
09878 readonly attribute wstring IPV6Address;
09879
09883 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
09884
09888 readonly attribute wstring hardwareAddress;
09889
09893 readonly attribute HostNetworkInterfaceMediumType mediumType;
09894
09898 readonly attribute HostNetworkInterfaceStatus status;
09899
09903 readonly attribute HostNetworkInterfaceType interfaceType;
09904
09916 void enableStaticIpConfig (
09917 in wstring IPAddress,
09918 in wstring networkMask
09919 );
09920
09932 void enableStaticIpConfigV6 (
09933 in wstring IPV6Address,
09934 in unsigned long IPV6NetworkMaskPrefixLength
09935 );
09936
09940 void enableDynamicIpConfig();
09941
09945 void dhcpRediscover();
09946
09947 };
09948
09965 interface IHost : $unknown
09966 {
09970 readonly attribute IMedium[] DVDDrives;
09971
09975 readonly attribute IMedium[] floppyDrives;
09976
09990 readonly attribute IHostUSBDevice[] USBDevices;
09991
10015 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
10016
10020 readonly attribute IHostNetworkInterface[] networkInterfaces;
10021
10025 readonly attribute unsigned long processorCount;
10026
10030 readonly attribute unsigned long processorOnlineCount;
10031
10035 readonly attribute unsigned long processorCoreCount;
10036
10040 readonly attribute unsigned long memorySize;
10041
10045 readonly attribute unsigned long memoryAvailable;
10046
10050 readonly attribute wstring operatingSystem;
10051
10055 readonly attribute wstring OSVersion;
10056
10060 readonly attribute long long UTCTime;
10061
10065 readonly attribute boolean Acceleration3DAvailable;
10066
10081 void getProcessorSpeed (
10082 in unsigned long cpuId,
10083 [retval] out unsigned long speed
10084 );
10085
10097 void getProcessorFeature (
10098 in ProcessorFeature feature,
10099 [retval] out boolean supported
10100 );
10101
10120 void getProcessorDescription (
10121 in unsigned long cpuId,
10122 [retval] out wstring description
10123 );
10124
10165 void getProcessorCPUIDLeaf (
10166 in unsigned long cpuId,
10167 in unsigned long leaf,
10168 in unsigned long subLeaf,
10169 out unsigned long valEax,
10170 out unsigned long valEbx,
10171 out unsigned long valEcx,
10172 out unsigned long valEdx
10173 );
10174
10195 void createHostOnlyNetworkInterface (
10196 out IHostNetworkInterface hostInterface,
10197 [retval] out IProgress progress
10198 );
10199
10220 void removeHostOnlyNetworkInterface (
10221 in wstringUUID id,
10222 [retval] out IProgress progress
10223 );
10224
10244 void createUSBDeviceFilter (
10245 in wstring name,
10246 [retval] out IHostUSBDeviceFilter filter
10247 );
10248
10291 void insertUSBDeviceFilter (
10292 in unsigned long position,
10293 in IHostUSBDeviceFilter filter
10294 );
10295
10323 void removeUSBDeviceFilter (
10324 in unsigned long position
10325 );
10326
10344 void findHostDVDDrive (
10345 in wstring name,
10346 [retval] out IMedium drive
10347 );
10348
10366 void findHostFloppyDrive (
10367 in wstring name,
10368 [retval] out IMedium drive
10369 );
10370
10386 void findHostNetworkInterfaceByName (
10387 in wstring name,
10388 [retval] out IHostNetworkInterface networkInterface
10389 );
10390
10406 void findHostNetworkInterfaceById (
10407 in wstringUUID id,
10408 [retval] out IHostNetworkInterface networkInterface
10409 );
10410
10420 void findHostNetworkInterfacesOfType (
10421 in HostNetworkInterfaceType type,
10422 [retval] out IHostNetworkInterface[] networkInterfaces
10423 );
10424
10444 void findUSBDeviceById (
10445 in wstringUUID id,
10446 [retval] out IHostUSBDevice device
10447 );
10448
10471 void findUSBDeviceByAddress (
10472 in wstring name,
10473 [retval] out IHostUSBDevice device
10474 );
10475
10483 void generateMACAddress (
10484 [retval] out wstring address
10485 );
10486
10487 };
10488
10501 interface ISystemProperties : $unknown
10502 {
10506 readonly attribute unsigned long minGuestRAM;
10507
10511 readonly attribute unsigned long maxGuestRAM;
10512
10516 readonly attribute unsigned long minGuestVRAM;
10517
10521 readonly attribute unsigned long maxGuestVRAM;
10522
10526 readonly attribute unsigned long minGuestCPUCount;
10527
10531 readonly attribute unsigned long maxGuestCPUCount;
10532
10536 readonly attribute unsigned long maxGuestMonitors;
10537
10542 readonly attribute long long infoVDSize;
10543
10550 readonly attribute unsigned long serialPortCount;
10551
10558 readonly attribute unsigned long parallelPortCount;
10559
10569 readonly attribute unsigned long maxBootPosition;
10570
10594 attribute wstring defaultMachineFolder;
10595
10620 readonly attribute IMediumFormat[] mediumFormats;
10621
10655 attribute wstring defaultHardDiskFormat;
10656
10662 attribute long long freeDiskSpaceWarning;
10663
10668 attribute unsigned long freeDiskSpacePercentWarning;
10669
10675 attribute long long freeDiskSpaceError;
10676
10681 attribute unsigned long freeDiskSpacePercentError;
10682
10706 attribute wstring VRDEAuthLibrary;
10707
10736 attribute wstring webServiceAuthLibrary;
10737
10751 attribute wstring defaultVRDEExtPack;
10752
10758 attribute unsigned long logHistoryCount;
10759
10764 readonly attribute AudioDriverType defaultAudioDriver;
10765
10776 void getMaxNetworkAdapters (
10777 in ChipsetType chipset,
10778 [retval] out unsigned long maxNetworkAdapters
10779 );
10780
10794 void getMaxNetworkAdaptersOfType (
10795 in ChipsetType chipset,
10796 in NetworkAttachmentType type,
10797 [retval] out unsigned long maxNetworkAdapters
10798 );
10799
10809 void getMaxDevicesPerPortForStorageBus (
10810 in StorageBus bus,
10811 [retval] out unsigned long maxDevicesPerPort
10812 );
10813
10821 void getMinPortCountForStorageBus (
10822 in StorageBus bus,
10823 [retval] out unsigned long minPortCount
10824 );
10825
10833 void getMaxPortCountForStorageBus (
10834 in StorageBus bus,
10835 [retval] out unsigned long maxPortCount
10836 );
10837
10850 void getMaxInstancesOfStorageBus (
10851 in ChipsetType chipset,
10852 in StorageBus bus,
10853 [retval] out unsigned long maxInstances
10854 );
10855
10865 void getDeviceTypesForStorageBus (
10866 in StorageBus bus,
10867 [retval] out DeviceType[] deviceTypes
10868 );
10869
10878 void getDefaultIoCacheSettingForStorageController (
10879 in StorageControllerType controllerType,
10880 [retval] out boolean enabled
10881 );
10882
10883 };
10884
10890 interface IGuestOSType : $unknown
10891 {
10895 readonly attribute wstring familyId;
10896
10900 readonly attribute wstring familyDescription;
10901
10905 readonly attribute wstring id;
10906
10910 readonly attribute wstring description;
10911
10915 readonly attribute boolean is64Bit;
10916
10920 readonly attribute boolean recommendedIOAPIC;
10921
10925 readonly attribute boolean recommendedVirtEx;
10926
10930 readonly attribute unsigned long recommendedRAM;
10931
10935 readonly attribute unsigned long recommendedVRAM;
10936
10940 readonly attribute long long recommendedHDD;
10941
10945 readonly attribute NetworkAdapterType adapterType;
10946
10950 readonly attribute boolean recommendedPae;
10951
10955 readonly attribute StorageControllerType recommendedDvdStorageController;
10956
10960 readonly attribute StorageBus recommendedDvdStorageBus;
10961
10965 readonly attribute StorageControllerType recommendedHdStorageController;
10966
10970 readonly attribute StorageBus recommendedHdStorageBus;
10971
10975 readonly attribute FirmwareType recommendedFirmware;
10976
10980 readonly attribute boolean recommendedUsbHid;
10981
10985 readonly attribute boolean recommendedHpet;
10986
10990 readonly attribute boolean recommendedUsbTablet;
10991
10995 readonly attribute boolean recommendedRtcUseUtc;
10996
11000 readonly attribute ChipsetType recommendedChipset;
11001
11005 readonly attribute AudioControllerType recommendedAudioController;
11006
11007 };
11008
11016 interface IAdditionsFacility : $unknown
11017 {
11021 readonly attribute AdditionsFacilityClass classType;
11022
11029 readonly attribute long long lastUpdated;
11030
11034 readonly attribute wstring name;
11035
11039 readonly attribute AdditionsFacilityStatus status;
11040
11044 readonly attribute AdditionsFacilityType type;
11045
11046 };
11047
11055 interface IGuestDirEntry : $unknown
11056 {
11060 readonly attribute long long nodeId;
11061
11065 readonly attribute wstring name;
11066
11070 readonly attribute GuestDirEntryType type;
11071
11072 };
11073
11087 interface IGuest : $unknown
11088 {
11103 readonly attribute wstring OSTypeId;
11104
11110 readonly attribute AdditionsRunLevelType additionsRunLevel;
11111
11119 readonly attribute wstring additionsVersion;
11120
11127 readonly attribute IAdditionsFacility[] facilities;
11128
11132 attribute unsigned long memoryBalloonSize;
11133
11137 attribute unsigned long statisticsUpdateInterval;
11138
11170 void internalGetStatistics (
11171 out unsigned long cpuUser,
11172 out unsigned long cpuKernel,
11173 out unsigned long cpuIdle,
11174 out unsigned long memTotal,
11175 out unsigned long memFree,
11176 out unsigned long memBalloon,
11177 out unsigned long memShared,
11178 out unsigned long memCache,
11179 out unsigned long pagedTotal,
11180 out unsigned long memAllocTotal,
11181 out unsigned long memFreeTotal,
11182 out unsigned long memBalloonTotal,
11183 out unsigned long memSharedTotal
11184 );
11185
11197 void getFacilityStatus (
11198 in AdditionsFacilityType facility,
11199 out long long timestamp,
11200 [retval] out AdditionsFacilityStatus status
11201 );
11202
11220 void getAdditionsStatus (
11221 in AdditionsRunLevelType level,
11222 [retval] out boolean active
11223 );
11224
11254 void setCredentials (
11255 in wstring userName,
11256 in wstring password,
11257 in wstring domain,
11258 in boolean allowInteractiveLogon
11259 );
11260
11328 void executeProcess (
11329 in wstring execName,
11330 in unsigned long flags,
11331 in wstring[] arguments,
11332 in wstring[] environment,
11333 in wstring userName,
11334 in wstring password,
11335 in unsigned long timeoutMS,
11336 out unsigned long pid,
11337 [retval] out IProgress progress
11338 );
11339
11376 void getProcessOutput (
11377 in unsigned long pid,
11378 in unsigned long flags,
11379 in unsigned long timeoutMS,
11380 in long long size,
11381 [retval] out octet[] data
11382 );
11383
11414 void getProcessStatus (
11415 in unsigned long pid,
11416 out unsigned long exitcode,
11417 out unsigned long flags,
11418 [retval] out ExecuteProcessStatus reason
11419 );
11420
11457 void copyFromGuest (
11458 in wstring source,
11459 in wstring dest,
11460 in wstring userName,
11461 in wstring password,
11462 in unsigned long flags,
11463 [retval] out IProgress progress
11464 );
11465
11502 void copyToGuest (
11503 in wstring source,
11504 in wstring dest,
11505 in wstring userName,
11506 in wstring password,
11507 in unsigned long flags,
11508 [retval] out IProgress progress
11509 );
11510
11528 void directoryClose (
11529 in unsigned long handle
11530 );
11531
11566 void directoryCreate (
11567 in wstring directory,
11568 in wstring userName,
11569 in wstring password,
11570 in unsigned long mode,
11571 in unsigned long flags
11572 );
11573
11613 void directoryOpen (
11614 in wstring directory,
11615 in wstring filter,
11616 in unsigned long flags,
11617 in wstring userName,
11618 in wstring password,
11619 [retval] out unsigned long handle
11620 );
11621
11651 void directoryRead (
11652 in unsigned long handle,
11653 [retval] out IGuestDirEntry entry
11654 );
11655
11691 void fileExists (
11692 in wstring file,
11693 in wstring userName,
11694 in wstring password,
11695 [retval] out boolean exists
11696 );
11697
11729 void fileQuerySize (
11730 in wstring file,
11731 in wstring userName,
11732 in wstring password,
11733 [retval] out long long size
11734 );
11735
11769 void setProcessInput (
11770 in unsigned long pid,
11771 in unsigned long flags,
11772 in unsigned long timeoutMS,
11773 in octet[] data,
11774 [retval] out unsigned long written
11775 );
11776
11800 void updateGuestAdditions (
11801 in wstring source,
11802 in unsigned long flags,
11803 [retval] out IProgress progress
11804 );
11805
11806 };
11807
11848 interface IProgress : $unknown
11849 {
11853 readonly attribute wstringUUID id;
11854
11858 readonly attribute wstring description;
11859
11863 readonly attribute $unknown initiator;
11864
11868 readonly attribute boolean cancelable;
11869
11877 readonly attribute unsigned long percent;
11878
11892 readonly attribute long timeRemaining;
11893
11897 readonly attribute boolean completed;
11898
11902 readonly attribute boolean canceled;
11903
11910 readonly attribute long resultCode;
11911
11921 readonly attribute IVirtualBoxErrorInfo errorInfo;
11922
11929 readonly attribute unsigned long operationCount;
11930
11934 readonly attribute unsigned long operation;
11935
11941 readonly attribute wstring operationDescription;
11942
11946 readonly attribute unsigned long operationPercent;
11947
11951 readonly attribute unsigned long operationWeight;
11952
11960 attribute unsigned long timeout;
11961
11965 void setCurrentOperationProgress (
11966 in unsigned long percent
11967 );
11968
11972 void setNextOperation (
11973 in wstring nextOperationDescription,
11974 in unsigned long nextOperationsWeight
11975 );
11976
12003 void waitForCompletion (
12004 in long timeout
12005 );
12006
12030 void waitForOperationCompletion (
12031 in unsigned long operation,
12032 in long timeout
12033 );
12034
12060 void waitForAsyncProgressCompletion (
12061 in IProgress pProgressAsync
12062 );
12063
12080 void cancel();
12081
12082 };
12083
12167 interface ISnapshot : $unknown
12168 {
12172 readonly attribute wstringUUID id;
12173
12181 attribute wstring name;
12182
12190 attribute wstring description;
12191
12197 readonly attribute long long timeStamp;
12198
12210 readonly attribute boolean online;
12211
12223 readonly attribute IMachine machine;
12224
12231 readonly attribute ISnapshot parent;
12232
12241 readonly attribute ISnapshot[] children;
12242
12250 void getChildrenCount (
12251 [retval] out unsigned long childrenCount
12252 );
12253
12254 };
12255
12442 interface IMediumAttachment : $unknown
12443 {
12448 readonly attribute IMedium medium;
12449
12455 readonly attribute wstring controller;
12456
12462 readonly attribute long port;
12463
12469 readonly attribute long device;
12470
12474 readonly attribute DeviceType type;
12475
12479 readonly attribute boolean passthrough;
12480
12484 readonly attribute boolean temporaryEject;
12485
12490 readonly attribute boolean isEjected;
12491
12495 readonly attribute boolean nonRotational;
12496
12500 readonly attribute IBandwidthGroup bandwidthGroup;
12501
12502 };
12503
12661 interface IMedium : $unknown
12662 {
12676 readonly attribute wstringUUID id;
12677
12696 attribute wstring description;
12697
12713 readonly attribute MediumState state;
12714
12723 readonly attribute unsigned long variant;
12724
12746 attribute wstring location;
12747
12767 readonly attribute wstring name;
12768
12773 readonly attribute DeviceType deviceType;
12774
12778 readonly attribute boolean hostDrive;
12779
12792 readonly attribute long long size;
12793
12808 readonly attribute wstring format;
12809
12825 readonly attribute IMediumFormat mediumFormat;
12826
12851 attribute MediumType type;
12852
12866 readonly attribute MediumType[] allowedTypes;
12867
12877 readonly attribute IMedium parent;
12878
12886 readonly attribute IMedium[] children;
12887
12898 readonly attribute IMedium base;
12899
12932 readonly attribute boolean readOnly;
12933
12954 readonly attribute long long logicalSize;
12955
12983 attribute boolean autoReset;
12984
12999 readonly attribute wstring lastAccessError;
13000
13017 readonly attribute wstringUUID[] machineIds;
13018
13044 void setIDs (
13045 in boolean setImageId,
13046 in wstringUUID imageId,
13047 in boolean setParentId,
13048 in wstringUUID parentId
13049 );
13050
13085 void refreshState (
13086 [retval] out MediumState state
13087 );
13088
13115 void getSnapshotIds (
13116 in wstringUUID machineId,
13117 [retval] out wstringUUID[] snapshotIds
13118 );
13119
13179 void lockRead (
13180 [retval] out MediumState state
13181 );
13182
13205 void unlockRead (
13206 [retval] out MediumState state
13207 );
13208
13263 void lockWrite (
13264 [retval] out MediumState state
13265 );
13266
13289 void unlockWrite (
13290 [retval] out MediumState state
13291 );
13292
13342 void close();
13343
13373 void getProperty (
13374 in wstring name,
13375 [retval] out wstring value
13376 );
13377
13409 void setProperty (
13410 in wstring name,
13411 in wstring value
13412 );
13413
13448 void getProperties (
13449 in wstring names,
13450 out wstring[] returnNames,
13451 [retval] out wstring[] returnValues
13452 );
13453
13483 void setProperties (
13484 in wstring[] names,
13485 in wstring[] values
13486 );
13487
13520 void createBaseStorage (
13521 in long long logicalSize,
13522 in unsigned long variant,
13523 [retval] out IProgress progress
13524 );
13525
13577 void deleteStorage (
13578 [retval] out IProgress progress
13579 );
13580
13619 void createDiffStorage (
13620 in IMedium target,
13621 in unsigned long variant,
13622 [retval] out IProgress progress
13623 );
13624
13700 void mergeTo (
13701 in IMedium target,
13702 [retval] out IProgress progress
13703 );
13704
13754 void cloneTo (
13755 in IMedium target,
13756 in unsigned long variant,
13757 in IMedium parent,
13758 [retval] out IProgress progress
13759 );
13760
13789 void compact (
13790 [retval] out IProgress progress
13791 );
13792
13825 void resize (
13826 in long long logicalSize,
13827 [retval] out IProgress progress
13828 );
13829
13863 void reset (
13864 [retval] out IProgress progress
13865 );
13866
13867 };
13868
13891 interface IMediumFormat : $unknown
13892 {
13911 readonly attribute wstring id;
13912
13920 readonly attribute wstring name;
13921
13930 readonly attribute unsigned long capabilities;
13931
13950 void describeFileExtensions (
13951 out wstring[] extensions,
13952 out DeviceType[] type
13953 );
13954
13982 void describeProperties (
13983 out wstring[] names,
13984 out wstring[] description,
13985 out DataType[] types,
13986 out unsigned long[] flags,
13987 out wstring[] defaults
13988 );
13989
13990 };
13991
14004 interface IKeyboard : $unknown
14005 {
14011 readonly attribute IEventSource eventSource;
14012
14025 void putScancode (
14026 in long scancode
14027 );
14028
14041 void putScancodes (
14042 in long[] scancodes,
14043 [retval] out unsigned long codesStored
14044 );
14045
14060 void putCAD();
14061
14062 };
14063
14075 interface IMouse : $unknown
14076 {
14091 readonly attribute boolean absoluteSupported;
14092
14107 readonly attribute boolean relativeSupported;
14108
14123 readonly attribute boolean needsHostCursor;
14124
14130 readonly attribute IEventSource eventSource;
14131
14197 void putMouseEvent (
14198 in long dx,
14199 in long dy,
14200 in long dz,
14201 in long dw,
14202 in long buttonState
14203 );
14204
14277 void putMouseEventAbsolute (
14278 in long x,
14279 in long y,
14280 in long dz,
14281 in long dw,
14282 in long buttonState
14283 );
14284
14285 };
14286
14287 interface IFramebuffer : $unknown
14288 {
14297 readonly attribute octetPtr address;
14298
14302 readonly attribute unsigned long width;
14303
14307 readonly attribute unsigned long height;
14308
14315 readonly attribute unsigned long bitsPerPixel;
14316
14323 readonly attribute unsigned long bytesPerLine;
14324
14335 readonly attribute unsigned long pixelFormat;
14336
14343 readonly attribute boolean usesGuestVRAM;
14344
14354 readonly attribute unsigned long heightReduction;
14355
14370 readonly attribute IFramebufferOverlay overlay;
14371
14378 readonly attribute long long winId;
14379
14387 void lock();
14388
14396 void unlock();
14397
14405 void notifyUpdate (
14406 in unsigned long x,
14407 in unsigned long y,
14408 in unsigned long width,
14409 in unsigned long height
14410 );
14411
14524 void requestResize (
14525 in unsigned long screenId,
14526 in unsigned long pixelFormat,
14527 in octetPtr VRAM,
14528 in unsigned long bitsPerPixel,
14529 in unsigned long bytesPerLine,
14530 in unsigned long width,
14531 in unsigned long height,
14532 [retval] out boolean finished
14533 );
14534
14546 void videoModeSupported (
14547 in unsigned long width,
14548 in unsigned long height,
14549 in unsigned long bpp,
14550 [retval] out boolean supported
14551 );
14552
14589 void getVisibleRegion (
14590 in octetPtr rectangles,
14591 in unsigned long count,
14592 [retval] out unsigned long countCopied
14593 );
14594
14629 void setVisibleRegion (
14630 in octetPtr rectangles,
14631 in unsigned long count
14632 );
14633
14654 void processVHWACommand (
14655 in octetPtr command
14656 );
14657
14658 };
14659
14674 interface IFramebufferOverlay : IFramebuffer
14675 {
14679 readonly attribute unsigned long x;
14680
14684 readonly attribute unsigned long y;
14685
14691 attribute boolean visible;
14692
14699 attribute unsigned long alpha;
14700
14706 void move (
14707 in unsigned long x,
14708 in unsigned long y
14709 );
14710
14711 };
14712
14728 interface IDisplay : $unknown
14729 {
14733 void getScreenResolution (
14734 in unsigned long screenId,
14735 out unsigned long width,
14736 out unsigned long height,
14737 out unsigned long bitsPerPixel
14738 );
14739
14745 void setFramebuffer (
14746 in unsigned long screenId,
14747 in IFramebuffer framebuffer
14748 );
14749
14755 void getFramebuffer (
14756 in unsigned long screenId,
14757 out IFramebuffer framebuffer,
14758 out long xOrigin,
14759 out long yOrigin
14760 );
14761
14790 void setVideoModeHint (
14791 in unsigned long width,
14792 in unsigned long height,
14793 in unsigned long bitsPerPixel,
14794 in unsigned long display
14795 );
14796
14808 void setSeamlessMode (
14809 in boolean enabled
14810 );
14811
14847 void takeScreenShot (
14848 in unsigned long screenId,
14849 in octetPtr address,
14850 in unsigned long width,
14851 in unsigned long height
14852 );
14853
14897 void takeScreenShotToArray (
14898 in unsigned long screenId,
14899 in unsigned long width,
14900 in unsigned long height,
14901 [retval] out octet[] screenData
14902 );
14903
14942 void takeScreenShotPNGToArray (
14943 in unsigned long screenId,
14944 in unsigned long width,
14945 in unsigned long height,
14946 [retval] out octet[] screenData
14947 );
14948
15000 void drawToScreen (
15001 in unsigned long screenId,
15002 in octetPtr address,
15003 in unsigned long x,
15004 in unsigned long y,
15005 in unsigned long width,
15006 in unsigned long height
15007 );
15008
15023 void invalidateAndUpdate();
15024
15038 void resizeCompleted (
15039 in unsigned long screenId
15040 );
15041
15054 void completeVHWACommand (
15055 in octetPtr command
15056 );
15057
15058 };
15059
15075 interface INetworkAdapter : $unknown
15076 {
15084 attribute NetworkAdapterType adapterType;
15085
15093 readonly attribute unsigned long slot;
15094
15103 attribute boolean enabled;
15104
15111 attribute wstring MACAddress;
15112
15118 attribute NetworkAttachmentType attachmentType;
15119
15125 attribute wstring bridgedInterface;
15126
15132 attribute wstring hostOnlyInterface;
15133
15139 attribute wstring internalNetwork;
15140
15146 attribute wstring NATNetwork;
15147
15153 attribute wstring genericDriver;
15154
15161 attribute boolean cableConnected;
15162
15168 attribute unsigned long lineSpeed;
15169
15176 attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
15177
15184 attribute boolean traceEnabled;
15185
15192 attribute wstring traceFile;
15193
15201 readonly attribute INATEngine natDriver;
15202
15209 attribute unsigned long bootPriority;
15210
15214 attribute IBandwidthGroup bandwidthGroup;
15215
15234 void getProperty (
15235 in wstring key,
15236 [retval] out wstring value
15237 );
15238
15257 void setProperty (
15258 in wstring key,
15259 in wstring value
15260 );
15261
15289 void getProperties (
15290 in wstring names,
15291 out wstring[] returnNames,
15292 [retval] out wstring[] returnValues
15293 );
15294
15295 };
15296
15325 interface ISerialPort : $unknown
15326 {
15334 readonly attribute unsigned long slot;
15335
15342 attribute boolean enabled;
15343
15347 attribute unsigned long IOBase;
15348
15352 attribute unsigned long IRQ;
15353
15364 attribute PortMode hostMode;
15365
15373 attribute boolean server;
15374
15384 attribute wstring path;
15385
15386 };
15387
15407 interface IParallelPort : $unknown
15408 {
15416 readonly attribute unsigned long slot;
15417
15424 attribute boolean enabled;
15425
15429 attribute unsigned long IOBase;
15430
15434 attribute unsigned long IRQ;
15435
15443 attribute wstring path;
15444
15445 };
15446
15447 interface IMachineDebugger : $unknown
15448 {
15452 attribute boolean singlestep;
15453
15457 attribute boolean recompileUser;
15458
15462 attribute boolean recompileSupervisor;
15463
15467 attribute boolean PATMEnabled;
15468
15472 attribute boolean CSAMEnabled;
15473
15477 attribute boolean logEnabled;
15478
15482 readonly attribute wstring logFlags;
15483
15487 readonly attribute wstring logGroups;
15488
15492 readonly attribute wstring logDestinations;
15493
15500 readonly attribute boolean HWVirtExEnabled;
15501
15508 readonly attribute boolean HWVirtExNestedPagingEnabled;
15509
15516 readonly attribute boolean HWVirtExVPIDEnabled;
15517
15526 readonly attribute wstring OSName;
15527
15536 readonly attribute wstring OSVersion;
15537
15544 readonly attribute boolean PAEEnabled;
15545
15552 attribute unsigned long virtualTimeRate;
15553
15560 readonly attribute long long VM;
15561
15577 void dumpGuestCore (
15578 in wstring filename,
15579 in wstring compression
15580 );
15581
15598 void dumpHostProcessCore (
15599 in wstring filename,
15600 in wstring compression
15601 );
15602
15623 void info (
15624 in wstring name,
15625 in wstring args,
15626 [retval] out wstring info
15627 );
15628
15634 void injectNMI();
15635
15646 void modifyLogGroups (
15647 in wstring settings
15648 );
15649
15660 void modifyLogFlags (
15661 in wstring settings
15662 );
15663
15674 void modifyLogDestinations (
15675 in wstring settings
15676 );
15677
15692 void readPhysicalMemory (
15693 in long long address,
15694 in unsigned long size,
15695 [retval] out octet[] bytes
15696 );
15697
15712 void writePhysicalMemory (
15713 in long long address,
15714 in unsigned long size,
15715 in octet[] bytes
15716 );
15717
15734 void readVirtualMemory (
15735 in unsigned long cpuId,
15736 in long long address,
15737 in unsigned long size,
15738 [retval] out octet[] bytes
15739 );
15740
15757 void writeVirtualMemory (
15758 in unsigned long cpuId,
15759 in long long address,
15760 in unsigned long size,
15761 in octet[] bytes
15762 );
15763
15776 void detectOS (
15777 [retval] out wstring os
15778 );
15779
15797 void getRegister (
15798 in unsigned long cpuId,
15799 in wstring name,
15800 [retval] out wstring value
15801 );
15802
15820 void getRegisters (
15821 in unsigned long cpuId,
15822 out wstring[] names,
15823 out wstring[] values
15824 );
15825
15844 void setRegister (
15845 in unsigned long cpuId,
15846 in wstring name,
15847 in wstring value
15848 );
15849
15868 void setRegisters (
15869 in unsigned long cpuId,
15870 in wstring[] names,
15871 in wstring[] values
15872 );
15873
15886 void dumpGuestStack (
15887 in unsigned long cpuId,
15888 [retval] out wstring stack
15889 );
15890
15898 void resetStats (
15899 in wstring pattern
15900 );
15901
15909 void dumpStats (
15910 in wstring pattern
15911 );
15912
15924 void getStats (
15925 in wstring pattern,
15926 in boolean withDescriptions,
15927 out wstring stats
15928 );
15929
15930 };
15931
15932 interface IUSBController : $unknown
15933 {
15942 attribute boolean enabled;
15943
15952 attribute boolean enabledEhci;
15953
15959 readonly attribute boolean proxyAvailable;
15960
15968 readonly attribute unsigned short USBStandard;
15969
15995 readonly attribute IUSBDeviceFilter[] deviceFilters;
15996
16024 void createDeviceFilter (
16025 in wstring name,
16026 [retval] out IUSBDeviceFilter filter
16027 );
16028
16073 void insertDeviceFilter (
16074 in unsigned long position,
16075 in IUSBDeviceFilter filter
16076 );
16077
16110 void removeDeviceFilter (
16111 in unsigned long position,
16112 [retval] out IUSBDeviceFilter filter
16113 );
16114
16115 };
16116
16129 interface IUSBDevice : $unknown
16130 {
16137 readonly attribute wstringUUID id;
16138
16142 readonly attribute unsigned short vendorId;
16143
16147 readonly attribute unsigned short productId;
16148
16156 readonly attribute unsigned short revision;
16157
16161 readonly attribute wstring manufacturer;
16162
16166 readonly attribute wstring product;
16167
16171 readonly attribute wstring serialNumber;
16172
16176 readonly attribute wstring address;
16177
16184 readonly attribute unsigned short port;
16185
16191 readonly attribute unsigned short version;
16192
16200 readonly attribute unsigned short portVersion;
16201
16208 readonly attribute boolean remote;
16209
16210 };
16211
16286 interface IUSBDeviceFilter : $unknown
16287 {
16295 attribute wstring name;
16296
16300 attribute boolean active;
16301
16309 attribute wstring vendorId;
16310
16318 attribute wstring productId;
16319
16333 attribute wstring revision;
16334
16339 attribute wstring manufacturer;
16340
16345 attribute wstring product;
16346
16351 attribute wstring serialNumber;
16352
16357 attribute wstring port;
16358
16368 attribute wstring remote;
16369
16379 attribute unsigned long maskedInterfaces;
16380
16381 };
16382
16399 interface IHostUSBDevice : IUSBDevice
16400 {
16406 readonly attribute USBDeviceState state;
16407
16408 };
16409
16432 interface IHostUSBDeviceFilter : IUSBDeviceFilter
16433 {
16440 attribute USBDeviceFilterAction action;
16441
16442 };
16443
16452 interface IAudioAdapter : $unknown
16453 {
16462 attribute boolean enabled;
16463
16469 attribute AudioControllerType audioController;
16470
16477 attribute AudioDriverType audioDriver;
16478
16479 };
16480
16481 interface IVRDEServer : $unknown
16482 {
16486 attribute boolean enabled;
16487
16491 attribute AuthType authType;
16492
16496 attribute unsigned long authTimeout;
16497
16504 attribute boolean allowMultiConnection;
16505
16513 attribute boolean reuseSingleConnection;
16514
16521 attribute wstring VRDEExtPack;
16522
16529 attribute wstring authLibrary;
16530
16536 readonly attribute wstring[] VRDEProperties;
16537
16551 void setVRDEProperty (
16552 in wstring key,
16553 in wstring value
16554 );
16555
16569 void getVRDEProperty (
16570 in wstring key,
16571 [retval] out wstring value
16572 );
16573
16574 };
16575
16633 interface ISharedFolder : $unknown
16634 {
16638 readonly attribute wstring name;
16639
16643 readonly attribute wstring hostPath;
16644
16654 readonly attribute boolean accessible;
16655
16662 readonly attribute boolean writable;
16663
16669 readonly attribute boolean autoMount;
16670
16683 readonly attribute wstring lastAccessError;
16684
16685 };
16686
16687 interface IInternalSessionControl : $unknown
16688 {
16693 void getPID (
16694 [retval] out unsigned long pid
16695 );
16696
16718 void getRemoteConsole (
16719 [retval] out IConsole console
16720 );
16721
16745 void assignMachine (
16746 in IMachine machine
16747 );
16748
16763 void assignRemoteMachine (
16764 in IMachine machine,
16765 in IConsole console
16766 );
16767
16791 void updateMachineState (
16792 in MachineState aMachineState
16793 );
16794
16810 void uninitialize();
16811
16834 void onNetworkAdapterChange (
16835 in INetworkAdapter networkAdapter,
16836 in boolean changeAdapter
16837 );
16838
16861 void onSerialPortChange (
16862 in ISerialPort serialPort
16863 );
16864
16887 void onParallelPortChange (
16888 in IParallelPort parallelPort
16889 );
16890
16913 void onStorageControllerChange();
16914
16941 void onMediumChange (
16942 in IMediumAttachment mediumAttachment,
16943 in boolean force
16944 );
16945
16972 void onStorageDeviceChange (
16973 in IMediumAttachment mediumAttachment,
16974 in boolean remove
16975 );
16976
16986 void onCPUChange (
16987 in unsigned long cpu,
16988 in boolean add
16989 );
16990
16998 void onCPUExecutionCapChange (
16999 in unsigned long executionCap
17000 );
17001
17026 void onVRDEServerChange (
17027 in boolean restart
17028 );
17029
17052 void onUSBControllerChange();
17053
17082 void onSharedFolderChange (
17083 in boolean global
17084 );
17085
17111 void onUSBDeviceAttach (
17112 in IUSBDevice device,
17113 in IVirtualBoxErrorInfo error,
17114 in unsigned long maskedInterfaces
17115 );
17116
17142 void onUSBDeviceDetach (
17143 in wstringUUID id,
17144 in IVirtualBoxErrorInfo error
17145 );
17146
17164 void onShowWindow (
17165 in boolean check,
17166 out boolean canShow,
17167 out long long winId
17168 );
17169
17177 void onBandwidthGroupChange (
17178 in IBandwidthGroup bandwidthGroup
17179 );
17180
17204 void accessGuestProperty (
17205 in wstring name,
17206 in wstring value,
17207 in wstring flags,
17208 in boolean isSetter,
17209 out wstring retValue,
17210 out long long retTimestamp,
17211 out wstring retFlags
17212 );
17213
17261 void enumerateGuestProperties (
17262 in wstring patterns,
17263 out wstring[] key,
17264 out wstring[] value,
17265 out long long[] timestamp,
17266 out wstring[] flags
17267 );
17268
17314 void onlineMergeMedium (
17315 in IMediumAttachment mediumAttachment,
17316 in unsigned long sourceIdx,
17317 in unsigned long targetIdx,
17318 in IMedium source,
17319 in IMedium target,
17320 in boolean mergeForward,
17321 in IMedium parentForTarget,
17322 in IMedium[] childrenToReparent,
17323 in IProgress progress
17324 );
17325
17326 };
17327
17386 interface ISession : $unknown
17387 {
17391 readonly attribute SessionState state;
17392
17400 readonly attribute SessionType type;
17401
17405 readonly attribute IMachine machine;
17406
17410 readonly attribute IConsole console;
17411
17443 void unlockMachine();
17444
17445 };
17446
17469 interface IStorageController : $unknown
17470 {
17479 readonly attribute wstring name;
17480
17486 readonly attribute unsigned long maxDevicesPerPortCount;
17487
17493 readonly attribute unsigned long minPortCount;
17494
17500 readonly attribute unsigned long maxPortCount;
17501
17507 attribute unsigned long instance;
17508
17517 attribute unsigned long portCount;
17518
17524 readonly attribute StorageBus bus;
17525
17538 attribute StorageControllerType controllerType;
17539
17554 attribute boolean useHostIOCache;
17555
17561 readonly attribute boolean bootable;
17562
17585 void getIDEEmulationPort (
17586 in long devicePosition,
17587 [retval] out long portNumber
17588 );
17589
17613 void setIDEEmulationPort (
17614 in long devicePosition,
17615 in long portNumber
17616 );
17617
17618 };
17619
17643 interface IManagedObjectRef : $unknown
17644 {
17651 void getInterfaceName (
17652 [retval] out wstring return
17653 );
17654
17662 void release();
17663
17664 };
17665
17674 interface IWebsessionManager : $unknown
17675 {
17684 void logon (
17685 in wstring username,
17686 in wstring password,
17687 [retval] out IVirtualBox return
17688 );
17689
17699 void getSessionObject (
17700 in IVirtualBox refIVirtualBox,
17701 [retval] out ISession return
17702 );
17703
17711 void logoff (
17712 in IVirtualBox refIVirtualBox
17713 );
17714
17715 };
17716
17725 interface IPerformanceMetric : $unknown
17726 {
17732 readonly attribute wstring metricName;
17733
17739 readonly attribute $unknown object;
17740
17746 readonly attribute wstring description;
17747
17753 readonly attribute unsigned long period;
17754
17764 readonly attribute unsigned long count;
17765
17771 readonly attribute wstring unit;
17772
17778 readonly attribute long minimumValue;
17779
17785 readonly attribute long maximumValue;
17786
17787 };
17788
17895 interface IPerformanceCollector : $unknown
17896 {
17907 readonly attribute wstring[] metricNames;
17908
17932 void getMetrics (
17933 in wstring[] metricNames,
17934 in $unknown[] objects,
17935 [retval] out IPerformanceMetric[] metrics
17936 );
17937
17976 void setupMetrics (
17977 in wstring[] metricNames,
17978 in $unknown[] objects,
17979 in unsigned long period,
17980 in unsigned long count,
17981 [retval] out IPerformanceMetric[] affectedMetrics
17982 );
17983
18012 void enableMetrics (
18013 in wstring[] metricNames,
18014 in $unknown[] objects,
18015 [retval] out IPerformanceMetric[] affectedMetrics
18016 );
18017
18046 void disableMetrics (
18047 in wstring[] metricNames,
18048 in $unknown[] objects,
18049 [retval] out IPerformanceMetric[] affectedMetrics
18050 );
18051
18140 void queryMetricsData (
18141 in wstring[] metricNames,
18142 in $unknown[] objects,
18143 out wstring[] returnMetricNames,
18144 out $unknown[] returnObjects,
18145 out wstring[] returnUnits,
18146 out unsigned long[] returnScales,
18147 out unsigned long[] returnSequenceNumbers,
18148 out unsigned long[] returnDataIndices,
18149 out unsigned long[] returnDataLengths,
18150 [retval] out long[] returnData
18151 );
18152
18153 };
18154
18162 interface INATEngine : $unknown
18163 {
18168 attribute wstring network;
18169
18176 attribute wstring hostIP;
18177
18182 attribute wstring tftpPrefix;
18183
18188 attribute wstring tftpBootFile;
18189
18197 attribute wstring tftpNextServer;
18198
18202 attribute unsigned long aliasMode;
18203
18207 attribute boolean dnsPassDomain;
18208
18213 attribute boolean dnsProxy;
18214
18219 attribute boolean dnsUseHostResolver;
18220
18225 readonly attribute wstring[] redirects;
18226
18242 void setNetworkSettings (
18243 in unsigned long mtu,
18244 in unsigned long sockSnd,
18245 in unsigned long sockRcv,
18246 in unsigned long TcpWndSnd,
18247 in unsigned long TcpWndRcv
18248 );
18249
18254 void getNetworkSettings (
18255 out unsigned long mtu,
18256 out unsigned long sockSnd,
18257 out unsigned long sockRcv,
18258 out unsigned long TcpWndSnd,
18259 out unsigned long TcpWndRcv
18260 );
18261
18281 void addRedirect (
18282 in wstring name,
18283 in NATProtocol proto,
18284 in wstring hostIp,
18285 in unsigned short hostPort,
18286 in wstring guestIp,
18287 in unsigned short guestPort
18288 );
18289
18295 void removeRedirect (
18296 in wstring name
18297 );
18298
18299 };
18300
18309 interface IExtPackPlugIn : $unknown
18310 {
18314 readonly attribute wstring name;
18315
18319 readonly attribute wstring description;
18320
18326 readonly attribute wstring frontend;
18327
18331 readonly attribute wstring modulePath;
18332
18333 };
18334
18343 interface IExtPackBase : $unknown
18344 {
18348 readonly attribute wstring name;
18349
18353 readonly attribute wstring description;
18354
18363 readonly attribute wstring version;
18364
18368 readonly attribute unsigned long revision;
18369
18373 readonly attribute wstring VRDEModule;
18374
18378 readonly attribute IExtPackPlugIn[] plugIns;
18379
18389 readonly attribute boolean usable;
18390
18397 readonly attribute wstring whyUnusable;
18398
18402 readonly attribute boolean showLicense;
18403
18412 readonly attribute wstring license;
18413
18437 void queryLicense (
18438 in wstring preferredLocale,
18439 in wstring preferredLanguage,
18440 in wstring format,
18441 [retval] out wstring licenseText
18442 );
18443
18444 };
18445
18454 interface IExtPack : IExtPackBase
18455 {
18467 void queryObject (
18468 in wstring objUuid,
18469 [retval] out $unknown returnInterface
18470 );
18471
18472 };
18473
18483 interface IExtPackFile : IExtPackBase
18484 {
18490 readonly attribute wstring filePath;
18491
18510 void install (
18511 in boolean replace,
18512 in wstring displayInfo,
18513 [retval] out IProgress progess
18514 );
18515
18516 };
18517
18528 interface IExtPackManager : $unknown
18529 {
18535 readonly attribute IExtPack[] installedExtPacks;
18536
18554 void find (
18555 in wstring name,
18556 [retval] out IExtPack returnData
18557 );
18558
18569 void openExtPackFile (
18570 in wstring path,
18571 [retval] out IExtPackFile file
18572 );
18573
18592 void uninstall (
18593 in wstring name,
18594 in boolean forcedRemoval,
18595 in wstring displayInfo,
18596 [retval] out IProgress progess
18597 );
18598
18602 void cleanup();
18603
18616 void queryAllPlugInsForFrontend (
18617 in wstring frontendName,
18618 [retval] out wstring[] plugInModules
18619 );
18620
18628 void isExtPackUsable (
18629 in wstring name,
18630 [retval] out boolean usable
18631 );
18632
18633 };
18634
18640 interface IBandwidthGroup : $unknown
18641 {
18645 readonly attribute wstring name;
18646
18650 readonly attribute BandwidthGroupType type;
18651
18655 readonly attribute unsigned long reference;
18656
18661 attribute unsigned long maxMbPerSec;
18662
18663 };
18664
18673 interface IBandwidthControl : $unknown
18674 {
18680 readonly attribute unsigned long numGroups;
18681
18694 void createBandwidthGroup (
18695 in wstring name,
18696 in BandwidthGroupType type,
18697 in unsigned long maxMbPerSec
18698 );
18699
18707 void deleteBandwidthGroup (
18708 in wstring name
18709 );
18710
18720 void getBandwidthGroup (
18721 in wstring name,
18722 [retval] out IBandwidthGroup bandwidthGroup
18723 );
18724
18732 void getAllBandwidthGroups (
18733 [retval] out IBandwidthGroup[] bandwidthGroups
18734 );
18735
18736 };
18737
18750 interface IVirtualBoxClient : $unknown
18751 {
18757 readonly attribute IVirtualBox virtualBox;
18758
18764 readonly attribute ISession session;
18765
18771 readonly attribute IEventSource eventSource;
18772
18773 };
18774
18788 interface IEventSource : $unknown
18789 {
18795 void createListener (
18796 [retval] out IEventListener listener
18797 );
18798
18814 void createAggregator (
18815 in IEventSource[] subordinates,
18816 [retval] out IEventSource result
18817 );
18818
18851 void registerListener (
18852 in IEventListener listener,
18853 in VBoxEventType[] interesting,
18854 in boolean active
18855 );
18856
18865 void unregisterListener (
18866 in IEventListener listener
18867 );
18868
18883 void fireEvent (
18884 in IEvent event,
18885 in long timeout,
18886 [retval] out boolean result
18887 );
18888
18913 void getEvent (
18914 in IEventListener listener,
18915 in long timeout,
18916 [retval] out IEvent event
18917 );
18918
18930 void eventProcessed (
18931 in IEventListener listener,
18932 in IEvent event
18933 );
18934
18935 };
18936
18946 interface IEventListener : $unknown
18947 {
18960 void handleEvent (
18961 in IEvent event
18962 );
18963
18964 };
18965
19042 interface IEvent : $unknown
19043 {
19049 readonly attribute VBoxEventType type;
19050
19056 readonly attribute IEventSource source;
19057
19068 readonly attribute boolean waitable;
19069
19076 void setProcessed();
19077
19091 void waitProcessed (
19092 in long timeout,
19093 [retval] out boolean result
19094 );
19095
19096 };
19097
19103 interface IReusableEvent : IEvent
19104 {
19108 readonly attribute unsigned long generation;
19109
19116 void reuse();
19117
19118 };
19119
19125 interface IMachineEvent : IEvent
19126 {
19130 readonly attribute wstringUUID machineId;
19131
19132 };
19133
19139 interface IMachineStateChangedEvent : IMachineEvent
19140 {
19144 readonly attribute MachineState state;
19145
19146 };
19147
19155 interface IMachineDataChangedEvent : IMachineEvent
19156 {
19163 readonly attribute boolean temporary;
19164
19165 };
19166
19175 interface IMediumRegisteredEvent : IEvent
19176 {
19180 readonly attribute wstringUUID mediumId;
19181
19185 readonly attribute DeviceType mediumType;
19186
19193 readonly attribute boolean registered;
19194
19195 };
19196
19205 interface IMachineRegisteredEvent : IMachineEvent
19206 {
19213 readonly attribute boolean registered;
19214
19215 };
19216
19226 interface ISessionStateChangedEvent : IMachineEvent
19227 {
19233 readonly attribute SessionState state;
19234
19235 };
19236
19244 interface IGuestPropertyChangedEvent : IMachineEvent
19245 {
19251 readonly attribute wstring name;
19252
19258 readonly attribute wstring value;
19259
19265 readonly attribute wstring flags;
19266
19267 };
19268
19274 interface ISnapshotEvent : IMachineEvent
19275 {
19279 readonly attribute wstringUUID snapshotId;
19280
19281 };
19282
19292 interface ISnapshotTakenEvent : ISnapshotEvent
19293 {
19294 };
19295
19312 interface ISnapshotDeletedEvent : ISnapshotEvent
19313 {
19314 };
19315
19325 interface ISnapshotChangedEvent : ISnapshotEvent
19326 {
19327 };
19328
19337 interface IMousePointerShapeChangedEvent : IEvent
19338 {
19344 readonly attribute boolean visible;
19345
19351 readonly attribute boolean alpha;
19352
19358 readonly attribute unsigned long xhot;
19359
19365 readonly attribute unsigned long yhot;
19366
19372 readonly attribute unsigned long width;
19373
19379 readonly attribute unsigned long height;
19380
19413 readonly attribute octet[] shape;
19414
19415 };
19416
19425 interface IMouseCapabilityChangedEvent : IEvent
19426 {
19432 readonly attribute boolean supportsAbsolute;
19433
19439 readonly attribute boolean supportsRelative;
19440
19446 readonly attribute boolean needsHostCursor;
19447
19448 };
19449
19458 interface IKeyboardLedsChangedEvent : IEvent
19459 {
19465 readonly attribute boolean numLock;
19466
19472 readonly attribute boolean capsLock;
19473
19479 readonly attribute boolean scrollLock;
19480
19481 };
19482
19491 interface IStateChangedEvent : IEvent
19492 {
19498 readonly attribute MachineState state;
19499
19500 };
19501
19511 interface IAdditionsStateChangedEvent : IEvent
19512 {
19513 };
19514
19525 interface INetworkAdapterChangedEvent : IEvent
19526 {
19532 readonly attribute INetworkAdapter networkAdapter;
19533
19534 };
19535
19546 interface ISerialPortChangedEvent : IEvent
19547 {
19553 readonly attribute ISerialPort serialPort;
19554
19555 };
19556
19567 interface IParallelPortChangedEvent : IEvent
19568 {
19574 readonly attribute IParallelPort parallelPort;
19575
19576 };
19577
19587 interface IStorageControllerChangedEvent : IEvent
19588 {
19589 };
19590
19600 interface IMediumChangedEvent : IEvent
19601 {
19607 readonly attribute IMediumAttachment mediumAttachment;
19608
19609 };
19610
19618 interface ICPUChangedEvent : IEvent
19619 {
19625 readonly attribute unsigned long cpu;
19626
19632 readonly attribute boolean add;
19633
19634 };
19635
19643 interface ICPUExecutionCapChangedEvent : IEvent
19644 {
19650 readonly attribute unsigned long executionCap;
19651
19652 };
19653
19661 interface IGuestKeyboardEvent : IEvent
19662 {
19668 readonly attribute long[] scancodes;
19669
19670 };
19671
19679 interface IGuestMouseEvent : IReusableEvent
19680 {
19686 readonly attribute boolean absolute;
19687
19693 readonly attribute long x;
19694
19700 readonly attribute long y;
19701
19707 readonly attribute long z;
19708
19714 readonly attribute long w;
19715
19721 readonly attribute long buttons;
19722
19723 };
19724
19735 interface IVRDEServerChangedEvent : IEvent
19736 {
19737 };
19738
19748 interface IVRDEServerInfoChangedEvent : IEvent
19749 {
19750 };
19751
19762 interface IUSBControllerChangedEvent : IEvent
19763 {
19764 };
19765
19789 interface IUSBDeviceStateChangedEvent : IEvent
19790 {
19796 readonly attribute IUSBDevice device;
19797
19803 readonly attribute boolean attached;
19804
19810 readonly attribute IVirtualBoxErrorInfo error;
19811
19812 };
19813
19829 interface ISharedFolderChangedEvent : IEvent
19830 {
19836 readonly attribute Scope scope;
19837
19838 };
19839
19891 interface IRuntimeErrorEvent : IEvent
19892 {
19898 readonly attribute boolean fatal;
19899
19905 readonly attribute wstring id;
19906
19912 readonly attribute wstring message;
19913
19914 };
19915
19923 interface IEventSourceChangedEvent : IEvent
19924 {
19930 readonly attribute IEventListener listener;
19931
19937 readonly attribute boolean add;
19938
19939 };
19940
19949 interface IExtraDataChangedEvent : IEvent
19950 {
19957 readonly attribute wstringUUID machineId;
19958
19964 readonly attribute wstring key;
19965
19971 readonly attribute wstring value;
19972
19973 };
19974
19980 interface IVetoEvent : IEvent
19981 {
19991 void addVeto (
19992 in wstring reason
19993 );
19994
20004 void isVetoed (
20005 [retval] out boolean result
20006 );
20007
20017 void getVetos (
20018 [retval] out wstring[] result
20019 );
20020
20021 };
20022
20032 interface IExtraDataCanChangeEvent : IVetoEvent
20033 {
20040 readonly attribute wstringUUID machineId;
20041
20047 readonly attribute wstring key;
20048
20054 readonly attribute wstring value;
20055
20056 };
20057
20073 interface ICanShowWindowEvent : IVetoEvent
20074 {
20075 };
20076
20108 interface IShowWindowEvent : IEvent
20109 {
20118 attribute long long winId;
20119
20120 };
20121
20129 interface INATRedirectEvent : IMachineEvent
20130 {
20136 readonly attribute unsigned long slot;
20137
20143 readonly attribute boolean remove;
20144
20150 readonly attribute wstring name;
20151
20157 readonly attribute NATProtocol proto;
20158
20164 readonly attribute wstring hostIp;
20165
20171 readonly attribute long hostPort;
20172
20178 readonly attribute wstring guestIp;
20179
20185 readonly attribute long guestPort;
20186
20187 };
20188
20201 interface IHostPciDevicePlugEvent : IMachineEvent
20202 {
20208 readonly attribute boolean plugged;
20209
20216 readonly attribute boolean success;
20217
20223 readonly attribute IPciDeviceAttachment attachment;
20224
20230 readonly attribute wstring message;
20231
20232 };
20233
20242 interface IVBoxSVCAvailabilityChangedEvent : IEvent
20243 {
20249 readonly attribute boolean available;
20250
20251 };
20252
20260 interface IBandwidthGroupChangedEvent : IEvent
20261 {
20267 readonly attribute IBandwidthGroup bandwidthGroup;
20268
20269 };
20270
20278 interface IGuestMonitorChangedEvent : IEvent
20279 {
20285 readonly attribute GuestMonitorChangedEventType changeType;
20286
20292 readonly attribute unsigned long screenId;
20293
20300 readonly attribute unsigned long originX;
20301
20308 readonly attribute unsigned long originY;
20309
20316 readonly attribute unsigned long width;
20317
20324 readonly attribute unsigned long height;
20325
20326 };
20327
20337 interface IStorageDeviceChangedEvent : IEvent
20338 {
20344 readonly attribute IMediumAttachment storageDevice;
20345
20351 readonly attribute boolean removed;
20352
20353 };
20354
20355