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;
00227 const HRESULT VBOX_E_DONT_CALL_AGAIN = 0x80BB000D;
00236 enum SettingsVersion
00237 {
00242 SettingsVersion_Null = 0,
00247 SettingsVersion_v1_0 = 1,
00252 SettingsVersion_v1_1 = 2,
00257 SettingsVersion_v1_2 = 3,
00262 SettingsVersion_v1_3pre = 4,
00267 SettingsVersion_v1_3 = 5,
00272 SettingsVersion_v1_4 = 6,
00277 SettingsVersion_v1_5 = 7,
00282 SettingsVersion_v1_6 = 8,
00287 SettingsVersion_v1_7 = 9,
00292 SettingsVersion_v1_8 = 10,
00297 SettingsVersion_v1_9 = 11,
00302 SettingsVersion_v1_10 = 12,
00307 SettingsVersion_Future = 13,
00308 };
00309
00317 enum AccessMode
00318 {
00319 AccessMode_ReadOnly = 1,
00320 AccessMode_ReadWrite = 2,
00321 };
00322
00440 enum MachineState
00441 {
00446 MachineState_Null = 0,
00454 MachineState_PoweredOff = 1,
00463 MachineState_Saved = 2,
00472 MachineState_Teleported = 3,
00481 MachineState_Aborted = 4,
00488 MachineState_Running = 5,
00495 MachineState_Paused = 6,
00503 MachineState_Stuck = 7,
00513 MachineState_Teleporting = 8,
00524 MachineState_LiveSnapshotting = 9,
00532 MachineState_Starting = 10,
00540 MachineState_Stopping = 11,
00548 MachineState_Saving = 12,
00556 MachineState_Restoring = 13,
00565 MachineState_TeleportingPausedVM = 14,
00572 MachineState_TeleportingIn = 15,
00580 MachineState_DeletingSnapshotOnline = 16,
00588 MachineState_DeletingSnapshotPaused = 17,
00595 MachineState_RestoringSnapshot = 18,
00604 MachineState_DeletingSnapshot = 19,
00611 MachineState_SettingUp = 20,
00618 MachineState_FirstOnline = 5,
00625 MachineState_LastOnline = 17,
00632 MachineState_FirstTransient = 8,
00639 MachineState_LastTransient = 20,
00640 };
00641
00652 enum SessionState
00653 {
00658 SessionState_Null = 0,
00666 SessionState_Closed = 1,
00674 SessionState_Open = 2,
00685 SessionState_Spawning = 3,
00693 SessionState_Closing = 4,
00694 };
00695
00704 enum CPUPropertyType
00705 {
00710 CPUPropertyType_Null = 0,
00719 CPUPropertyType_PAE = 1,
00727 CPUPropertyType_Synthetic = 2,
00728 };
00729
00739 enum HWVirtExPropertyType
00740 {
00745 HWVirtExPropertyType_Null = 0,
00753 HWVirtExPropertyType_Enabled = 1,
00762 HWVirtExPropertyType_Exclusive = 2,
00769 HWVirtExPropertyType_VPID = 3,
00776 HWVirtExPropertyType_NestedPaging = 4,
00783 HWVirtExPropertyType_LargePages = 5,
00791 HWVirtExPropertyType_Force = 6,
00792 };
00793
00802 enum SessionType
00803 {
00808 SessionType_Null = 0,
00816 SessionType_Direct = 1,
00824 SessionType_Remote = 2,
00832 SessionType_Existing = 3,
00833 };
00834
00842 enum DeviceType
00843 {
00851 DeviceType_Null = 0,
00856 DeviceType_Floppy = 1,
00861 DeviceType_DVD = 2,
00866 DeviceType_HardDisk = 3,
00871 DeviceType_Network = 4,
00876 DeviceType_USB = 5,
00881 DeviceType_SharedFolder = 6,
00882 };
00883
00891 enum DeviceActivity
00892 {
00893 DeviceActivity_Null = 0,
00894 DeviceActivity_Idle = 1,
00895 DeviceActivity_Reading = 2,
00896 DeviceActivity_Writing = 3,
00897 };
00898
00906 enum ClipboardMode
00907 {
00908 ClipboardMode_Disabled = 0,
00909 ClipboardMode_HostToGuest = 1,
00910 ClipboardMode_GuestToHost = 2,
00911 ClipboardMode_Bidirectional = 3,
00912 };
00913
00924 enum Scope
00925 {
00926 Scope_Global = 0,
00927 Scope_Machine = 1,
00928 Scope_Session = 2,
00929 };
00930
00938 enum BIOSBootMenuMode
00939 {
00940 BIOSBootMenuMode_Disabled = 0,
00941 BIOSBootMenuMode_MenuOnly = 1,
00942 BIOSBootMenuMode_MessageAndMenu = 2,
00943 };
00944
00952 enum ProcessorFeature
00953 {
00954 ProcessorFeature_HWVirtEx = 0,
00955 ProcessorFeature_PAE = 1,
00956 ProcessorFeature_LongMode = 2,
00957 ProcessorFeature_NestedPaging = 3,
00958 };
00959
00967 enum FirmwareType
00968 {
00973 FirmwareType_BIOS = 1,
00978 FirmwareType_EFI = 2,
00983 FirmwareType_EFI32 = 3,
00988 FirmwareType_EFI64 = 4,
00993 FirmwareType_EFIDUAL = 5,
00994 };
00995
01003 enum PointingHidType
01004 {
01009 PointingHidType_None = 1,
01014 PointingHidType_PS2Mouse = 2,
01019 PointingHidType_USBMouse = 3,
01024 PointingHidType_USBTablet = 4,
01030 PointingHidType_ComboMouse = 5,
01031 };
01032
01040 enum KeyboardHidType
01041 {
01046 KeyboardHidType_None = 1,
01051 KeyboardHidType_PS2Keyboard = 2,
01056 KeyboardHidType_USBKeyboard = 3,
01062 KeyboardHidType_ComboKeyboard = 4,
01063 };
01064
01072 enum VFSType
01073 {
01074 VFSType_File = 1,
01075 VFSType_Cloud = 2,
01076 VFSType_S3 = 3,
01077 VFSType_WebDav = 4,
01078 };
01079
01087 enum VFSFileType
01088 {
01089 VFSFileType_Unknown = 1,
01090 VFSFileType_Fifo = 2,
01091 VFSFileType_DevChar = 3,
01092 VFSFileType_Directory = 4,
01093 VFSFileType_DevBlock = 5,
01094 VFSFileType_File = 6,
01095 VFSFileType_SymLink = 7,
01096 VFSFileType_Socket = 8,
01097 VFSFileType_WhiteOut = 9,
01098 };
01099
01106 enum VirtualSystemDescriptionType
01107 {
01108 VirtualSystemDescriptionType_Ignore = 1,
01109 VirtualSystemDescriptionType_OS = 2,
01110 VirtualSystemDescriptionType_Name = 3,
01111 VirtualSystemDescriptionType_Product = 4,
01112 VirtualSystemDescriptionType_Vendor = 5,
01113 VirtualSystemDescriptionType_Version = 6,
01114 VirtualSystemDescriptionType_ProductUrl = 7,
01115 VirtualSystemDescriptionType_VendorUrl = 8,
01116 VirtualSystemDescriptionType_Description = 9,
01117 VirtualSystemDescriptionType_License = 10,
01118 VirtualSystemDescriptionType_Miscellaneous = 11,
01119 VirtualSystemDescriptionType_CPU = 12,
01120 VirtualSystemDescriptionType_Memory = 13,
01121 VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
01122 VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
01123 VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
01124 VirtualSystemDescriptionType_HardDiskControllerSAS = 17,
01125 VirtualSystemDescriptionType_HardDiskImage = 18,
01126 VirtualSystemDescriptionType_Floppy = 19,
01127 VirtualSystemDescriptionType_CDROM = 20,
01128 VirtualSystemDescriptionType_NetworkAdapter = 21,
01129 VirtualSystemDescriptionType_USBController = 22,
01130 VirtualSystemDescriptionType_SoundCard = 23,
01131 };
01132
01139 enum VirtualSystemDescriptionValueType
01140 {
01141 VirtualSystemDescriptionValueType_Reference = 1,
01142 VirtualSystemDescriptionValueType_Original = 2,
01143 VirtualSystemDescriptionValueType_Auto = 3,
01144 VirtualSystemDescriptionValueType_ExtraConfig = 4,
01145 };
01146
01157 enum HostNetworkInterfaceMediumType
01158 {
01165 HostNetworkInterfaceMediumType_Unknown = 0,
01172 HostNetworkInterfaceMediumType_Ethernet = 1,
01179 HostNetworkInterfaceMediumType_PPP = 2,
01186 HostNetworkInterfaceMediumType_SLIP = 3,
01187 };
01188
01198 enum HostNetworkInterfaceStatus
01199 {
01206 HostNetworkInterfaceStatus_Unknown = 0,
01213 HostNetworkInterfaceStatus_Up = 1,
01220 HostNetworkInterfaceStatus_Down = 2,
01221 };
01222
01230 enum HostNetworkInterfaceType
01231 {
01232 HostNetworkInterfaceType_Bridged = 1,
01233 HostNetworkInterfaceType_HostOnly = 2,
01234 };
01235
01245 enum MediumState
01246 {
01254 MediumState_NotCreated = 0,
01263 MediumState_Created = 1,
01271 MediumState_LockedRead = 2,
01279 MediumState_LockedWrite = 3,
01289 MediumState_Inaccessible = 4,
01296 MediumState_Creating = 5,
01303 MediumState_Deleting = 6,
01304 };
01305
01315 enum MediumType
01316 {
01324 MediumType_Normal = 0,
01332 MediumType_Immutable = 1,
01340 MediumType_Writethrough = 2,
01349 MediumType_Shareable = 3,
01350 };
01351
01361 enum MediumVariant
01362 {
01369 MediumVariant_Standard = 0,
01376 MediumVariant_VmdkSplit2G = 0x01,
01384 MediumVariant_VmdkStreamOptimized = 0x04,
01391 MediumVariant_VmdkESX = 0x08,
01398 MediumVariant_Fixed = 0x10000,
01405 MediumVariant_Diff = 0x20000,
01406 };
01407
01408 enum DataType
01409 {
01410 DataType_Int32 = 0,
01411 DataType_Int8 = 1,
01412 DataType_String = 2,
01413 };
01414
01415 enum DataFlags
01416 {
01417 DataFlags_None = 0x00,
01418 DataFlags_Mandatory = 0x01,
01419 DataFlags_Expert = 0x02,
01420 DataFlags_Array = 0x04,
01421 DataFlags_FlagMask = 0x07,
01422 };
01423
01431 enum MediumFormatCapabilities
01432 {
01439 MediumFormatCapabilities_Uuid = 0x01,
01446 MediumFormatCapabilities_CreateFixed = 0x02,
01454 MediumFormatCapabilities_CreateDynamic = 0x04,
01461 MediumFormatCapabilities_CreateSplit2G = 0x08,
01468 MediumFormatCapabilities_Differencing = 0x10,
01475 MediumFormatCapabilities_Asynchronous = 0x20,
01485 MediumFormatCapabilities_File = 0x40,
01494 MediumFormatCapabilities_Properties = 0x80,
01495 MediumFormatCapabilities_CapabilityMask = 0xFF,
01496 };
01497
01505 enum MouseButtonState
01506 {
01507 MouseButtonState_LeftButton = 0x01,
01508 MouseButtonState_RightButton = 0x02,
01509 MouseButtonState_MiddleButton = 0x04,
01510 MouseButtonState_WheelUp = 0x08,
01511 MouseButtonState_WheelDown = 0x10,
01512 MouseButtonState_XButton1 = 0x20,
01513 MouseButtonState_XButton2 = 0x40,
01514 MouseButtonState_MouseStateMask = 0x7F,
01515 };
01516
01527 enum FramebufferPixelFormat
01528 {
01536 FramebufferPixelFormat_Opaque = 0,
01544 FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
01545 };
01546
01554 enum NetworkAttachmentType
01555 {
01560 NetworkAttachmentType_Null = 0,
01561 NetworkAttachmentType_NAT = 1,
01562 NetworkAttachmentType_Bridged = 2,
01563 NetworkAttachmentType_Internal = 3,
01564 NetworkAttachmentType_HostOnly = 4,
01565 NetworkAttachmentType_VDE = 5,
01566 };
01567
01575 enum NetworkAdapterType
01576 {
01581 NetworkAdapterType_Null = 0,
01586 NetworkAdapterType_Am79C970A = 1,
01591 NetworkAdapterType_Am79C973 = 2,
01596 NetworkAdapterType_I82540EM = 3,
01601 NetworkAdapterType_I82543GC = 4,
01606 NetworkAdapterType_I82545EM = 5,
01611 NetworkAdapterType_Virtio = 6,
01612 };
01613
01622 enum PortMode
01623 {
01628 PortMode_Disconnected = 0,
01633 PortMode_HostPipe = 1,
01638 PortMode_HostDevice = 2,
01643 PortMode_RawFile = 3,
01644 };
01645
01684 enum USBDeviceState
01685 {
01692 USBDeviceState_NotSupported = 0,
01700 USBDeviceState_Unavailable = 1,
01707 USBDeviceState_Busy = 2,
01715 USBDeviceState_Available = 3,
01723 USBDeviceState_Held = 4,
01731 USBDeviceState_Captured = 5,
01732 };
01733
01743 enum USBDeviceFilterAction
01744 {
01749 USBDeviceFilterAction_Null = 0,
01754 USBDeviceFilterAction_Ignore = 1,
01759 USBDeviceFilterAction_Hold = 2,
01760 };
01761
01769 enum AudioDriverType
01770 {
01775 AudioDriverType_Null = 0,
01780 AudioDriverType_WinMM = 1,
01785 AudioDriverType_OSS = 2,
01790 AudioDriverType_ALSA = 3,
01795 AudioDriverType_DirectSound = 4,
01800 AudioDriverType_CoreAudio = 5,
01805 AudioDriverType_MMPM = 6,
01810 AudioDriverType_Pulse = 7,
01815 AudioDriverType_SolAudio = 8,
01816 };
01817
01825 enum AudioControllerType
01826 {
01827 AudioControllerType_AC97 = 0,
01828 AudioControllerType_SB16 = 1,
01829 };
01830
01838 enum VRDPAuthType
01839 {
01844 VRDPAuthType_Null = 0,
01845 VRDPAuthType_External = 1,
01846 VRDPAuthType_Guest = 2,
01847 };
01848
01857 enum StorageBus
01858 {
01863 StorageBus_Null = 0,
01864 StorageBus_IDE = 1,
01865 StorageBus_SATA = 2,
01866 StorageBus_SCSI = 3,
01867 StorageBus_Floppy = 4,
01868 StorageBus_SAS = 5,
01869 };
01870
01879 enum StorageControllerType
01880 {
01885 StorageControllerType_Null = 0,
01890 StorageControllerType_LsiLogic = 1,
01895 StorageControllerType_BusLogic = 2,
01900 StorageControllerType_IntelAhci = 3,
01905 StorageControllerType_PIIX3 = 4,
01910 StorageControllerType_PIIX4 = 5,
01915 StorageControllerType_ICH6 = 6,
01920 StorageControllerType_I82078 = 7,
01925 StorageControllerType_LsiLogicSas = 8,
01926 };
01927
01933 enum NATAliasMode
01934 {
01939 NATAliasMode_AliasLog = 0x1,
01944 NATAliasMode_AliasProxyOnly = 0x02,
01949 NATAliasMode_AliasUseSamePorts = 0x04,
01950 };
01951
01957 enum NATProtocol
01958 {
01963 NATProtocol_UDP = 0,
01968 NATProtocol_TCP = 1,
01969 };
01970
02003 interface IVirtualBoxErrorInfo : $errorinfo
02004 {
02022 readonly attribute long resultCode;
02023
02035 readonly attribute wstringUUID interfaceID;
02036
02047 readonly attribute wstring component;
02048
02059 readonly attribute wstring text;
02060
02071 readonly attribute IVirtualBoxErrorInfo next;
02072
02073 };
02074
02087 interface ILocalOwner : $unknown
02088 {
02097 void setLocalObject (
02098 in $unknown object
02099 );
02100
02101 };
02102
02103 interface IVirtualBoxCallback : $unknown
02104 {
02123 void onMachineStateChange (
02124 in wstringUUID machineId,
02125 in MachineState state
02126 );
02127
02142 void onMachineDataChange (
02143 in wstringUUID machineId
02144 );
02145
02183 void onExtraDataCanChange (
02184 in wstringUUID machineId,
02185 in wstring key,
02186 in wstring value,
02187 out wstring error,
02188 [retval] out boolean allowChange
02189 );
02190
02217 void onExtraDataChange (
02218 in wstringUUID machineId,
02219 in wstring key,
02220 in wstring value
02221 );
02222
02268 void onMediumRegistered (
02269 in wstringUUID mediumId,
02270 in DeviceType mediumType,
02271 in boolean registered
02272 );
02273
02294 void onMachineRegistered (
02295 in wstringUUID machineId,
02296 in boolean registered
02297 );
02298
02317 void onSessionStateChange (
02318 in wstringUUID machineId,
02319 in SessionState state
02320 );
02321
02340 void onSnapshotTaken (
02341 in wstringUUID machineId,
02342 in wstringUUID snapshotId
02343 );
02344
02373 void onSnapshotDeleted (
02374 in wstringUUID machineId,
02375 in wstringUUID snapshotId
02376 );
02377
02396 void onSnapshotChange (
02397 in wstringUUID machineId,
02398 in wstringUUID snapshotId
02399 );
02400
02429 void onGuestPropertyChange (
02430 in wstringUUID machineId,
02431 in wstring name,
02432 in wstring value,
02433 in wstring flags
02434 );
02435
02436 };
02437
02448 interface IDHCPServer : $unknown
02449 {
02455 attribute boolean enabled;
02456
02462 readonly attribute wstring IPAddress;
02463
02469 readonly attribute wstring networkMask;
02470
02476 readonly attribute wstring networkName;
02477
02483 readonly attribute wstring lowerIP;
02484
02490 readonly attribute wstring upperIP;
02491
02520 void setConfiguration (
02521 in wstring IPAddress,
02522 in wstring networkMask,
02523 in wstring FromIPAddress,
02524 in wstring ToIPAddress
02525 );
02526
02551 void start (
02552 in wstring networkName,
02553 in wstring trunkName,
02554 in wstring trunkType
02555 );
02556
02569 void stop();
02570
02571 };
02572
02591 interface IVirtualBox : $unknown
02592 {
02600 readonly attribute wstring version;
02601
02607 readonly attribute unsigned long revision;
02608
02618 readonly attribute wstring packageType;
02619
02635 readonly attribute wstring homeFolder;
02636
02644 readonly attribute wstring settingsFilePath;
02645
02649 readonly attribute IHost host;
02650
02654 readonly attribute ISystemProperties systemProperties;
02655
02661 readonly attribute IMachine[] machines;
02662
02672 readonly attribute IMedium[] hardDisks;
02673
02679 readonly attribute IMedium[] DVDImages;
02680
02686 readonly attribute IMedium[] floppyImages;
02687
02688 readonly attribute IProgress[] progressOperations;
02689
02690 readonly attribute IGuestOSType[] guestOSTypes;
02691
02708 readonly attribute ISharedFolder[] sharedFolders;
02709
02715 readonly attribute IPerformanceCollector performanceCollector;
02716
02722 readonly attribute IDHCPServer[] DHCPServers;
02723
02827 void createMachine (
02828 in wstring name,
02829 in wstring osTypeId,
02830 in wstring baseFolder,
02831 in wstringUUID id,
02832 in boolean override,
02833 [retval] out IMachine machine
02834 );
02835
02899 void createLegacyMachine (
02900 in wstring name,
02901 in wstring osTypeId,
02902 in wstring settingsFile,
02903 in wstringUUID id,
02904 [retval] out IMachine machine
02905 );
02906
02934 void openMachine (
02935 in wstring settingsFile,
02936 [retval] out IMachine machine
02937 );
02938
02971 void registerMachine (
02972 in IMachine machine
02973 );
02974
02990 void getMachine (
02991 in wstringUUID id,
02992 [retval] out IMachine machine
02993 );
02994
03010 void findMachine (
03011 in wstring name,
03012 [retval] out IMachine machine
03013 );
03014
03069 void unregisterMachine (
03070 in wstringUUID id,
03071 [retval] out IMachine machine
03072 );
03073
03083 void createAppliance (
03084 [retval] out IAppliance appliance
03085 );
03086
03152 void createHardDisk (
03153 in wstring format,
03154 in wstring location,
03155 [retval] out IMedium medium
03156 );
03157
03245 void openHardDisk (
03246 in wstring location,
03247 in AccessMode accessMode,
03248 in boolean setImageId,
03249 in wstringUUID imageId,
03250 in boolean setParentId,
03251 in wstringUUID parentId,
03252 [retval] out IMedium medium
03253 );
03254
03276 void getHardDisk (
03277 in wstringUUID id,
03278 [retval] out IMedium medium
03279 );
03280
03313 void findHardDisk (
03314 in wstring location,
03315 [retval] out IMedium medium
03316 );
03317
03367 void openDVDImage (
03368 in wstring location,
03369 in wstringUUID id,
03370 [retval] out IMedium image
03371 );
03372
03393 void getDVDImage (
03394 in wstringUUID id,
03395 [retval] out IMedium image
03396 );
03397
03436 void findDVDImage (
03437 in wstring location,
03438 [retval] out IMedium image
03439 );
03440
03490 void openFloppyImage (
03491 in wstring location,
03492 in wstringUUID id,
03493 [retval] out IMedium image
03494 );
03495
03516 void getFloppyImage (
03517 in wstringUUID id,
03518 [retval] out IMedium image
03519 );
03520
03559 void findFloppyImage (
03560 in wstring location,
03561 [retval] out IMedium image
03562 );
03563
03592 void getGuestOSType (
03593 in wstringUUID id,
03594 [retval] out IGuestOSType type
03595 );
03596
03616 void createSharedFolder (
03617 in wstring name,
03618 in wstring hostPath,
03619 in boolean writable
03620 );
03621
03636 void removeSharedFolder (
03637 in wstring name
03638 );
03639
03648 void getExtraDataKeys (
03649 [retval] out wstring[] value
03650 );
03651
03680 void getExtraData (
03681 in wstring key,
03682 [retval] out wstring value
03683 );
03684
03734 void setExtraData (
03735 in wstring key,
03736 in wstring value
03737 );
03738
03835 void openSession (
03836 in ISession session,
03837 in wstringUUID machineId
03838 );
03839
03973 void openRemoteSession (
03974 in ISession session,
03975 in wstringUUID machineId,
03976 in wstring type,
03977 in wstring environment,
03978 [retval] out IProgress progress
03979 );
03980
04050 void openExistingSession (
04051 in ISession session,
04052 in wstringUUID machineId
04053 );
04054
04072 void registerCallback (
04073 in IVirtualBoxCallback callback
04074 );
04075
04091 void unregisterCallback (
04092 in IVirtualBoxCallback callback
04093 );
04094
04182 void waitForPropertyChange (
04183 in wstring what,
04184 in unsigned long timeout,
04185 out wstring changed,
04186 out wstring values
04187 );
04188
04205 void createDHCPServer (
04206 in wstring name,
04207 [retval] out IDHCPServer server
04208 );
04209
04226 void findDHCPServerByNetworkName (
04227 in wstring name,
04228 [retval] out IDHCPServer server
04229 );
04230
04245 void removeDHCPServer (
04246 in IDHCPServer server
04247 );
04248
04273 void checkFirmwarePresent (
04274 in FirmwareType firmwareType,
04275 in wstring version,
04276 out wstring url,
04277 out wstring file,
04278 [retval] out boolean result
04279 );
04280
04281 };
04282
04293 interface IVFSExplorer : $unknown
04294 {
04298 readonly attribute wstring path;
04299
04303 readonly attribute VFSType type;
04304
04312 void update (
04313 [retval] out IProgress aProgress
04314 );
04315
04323 void cd (
04324 in wstring aDir,
04325 [retval] out IProgress aProgress
04326 );
04327
04333 void cdUp (
04334 [retval] out IProgress aProgress
04335 );
04336
04345 void entryList (
04346 out wstring[] aNames,
04347 out unsigned long[] aTypes
04348 );
04349
04358 void exists (
04359 in wstring[] aNames,
04360 [retval] out wstring[] aExists
04361 );
04362
04370 void remove (
04371 in wstring[] aNames,
04372 [retval] out IProgress aProgress
04373 );
04374
04375 };
04376
04441 interface IAppliance : $unknown
04442 {
04450 readonly attribute wstring path;
04451
04482 readonly attribute wstring[] disks;
04483
04491 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
04492
04509 void read (
04510 in wstring file,
04511 [retval] out IProgress aProgress
04512 );
04513
04530 void interpret();
04531
04549 void importMachines (
04550 [retval] out IProgress aProgress
04551 );
04552
04560 void createVFSExplorer (
04561 in wstring aUri,
04562 [retval] out IVFSExplorer aExplorer
04563 );
04564
04589 void write (
04590 in wstring format,
04591 in wstring path,
04592 [retval] out IProgress aProgress
04593 );
04594
04600 void getWarnings (
04601 [retval] out wstring[] aWarnings
04602 );
04603
04604 };
04605
04617 interface IVirtualSystemDescription : $unknown
04618 {
04622 readonly attribute unsigned long count;
04623
04748 void getDescription (
04749 out VirtualSystemDescriptionType[] aTypes,
04750 out wstring[] aRefs,
04751 out wstring[] aOvfValues,
04752 out wstring[] aVBoxValues,
04753 out wstring[] aExtraConfigValues
04754 );
04755
04772 void getDescriptionByType (
04773 in VirtualSystemDescriptionType aType,
04774 out VirtualSystemDescriptionType[] aTypes,
04775 out wstring[] aRefs,
04776 out wstring[] aOvfValues,
04777 out wstring[] aVBoxValues,
04778 out wstring[] aExtraConfigValues
04779 );
04780
04792 void getValuesByType (
04793 in VirtualSystemDescriptionType aType,
04794 in VirtualSystemDescriptionValueType aWhich,
04795 [retval] out wstring[] aValues
04796 );
04797
04823 void setFinalValues (
04824 in boolean[] aEnabled,
04825 in wstring[] aVBoxValues,
04826 in wstring[] aExtraConfigValues
04827 );
04828
04843 void addDescription (
04844 in VirtualSystemDescriptionType aType,
04845 in wstring aVBoxValue,
04846 in wstring aExtraConfigValue
04847 );
04848
04849 };
04850
04851 interface IInternalMachineControl : $unknown
04852 {
04859 void setRemoveSavedState (
04860 in boolean aRemove
04861 );
04862
04874 void updateState (
04875 in MachineState state
04876 );
04877
04878 void getIPCId (
04879 [retval] out wstring id
04880 );
04881
04893 void beginPowerUp (
04894 in IProgress progress
04895 );
04896
04906 void endPowerUp (
04907 in long result
04908 );
04909
04923 void runUSBDeviceFilters (
04924 in IUSBDevice device,
04925 out boolean matched,
04926 out unsigned long maskedInterfaces
04927 );
04928
04937 void captureUSBDevice (
04938 in wstringUUID id
04939 );
04940
04956 void detachUSBDevice (
04957 in wstringUUID id,
04958 in boolean done
04959 );
04960
04969 void autoCaptureUSBDevices();
04970
04986 void detachAllUSBDevices (
04987 in boolean done
04988 );
04989
05004 void onSessionEnd (
05005 in ISession session,
05006 [retval] out IProgress progress
05007 );
05008
05024 void beginSavingState (
05025 in IProgress progress,
05026 out wstring stateFilePath
05027 );
05028
05055 void endSavingState (
05056 in boolean success
05057 );
05058
05073 void adoptSavedState (
05074 in wstring savedStateFile
05075 );
05076
05125 void beginTakingSnapshot (
05126 in IConsole initiator,
05127 in wstring name,
05128 in wstring description,
05129 in IProgress consoleProgress,
05130 in boolean fTakingSnapshotOnline,
05131 out wstring stateFilePath
05132 );
05133
05143 void endTakingSnapshot (
05144 in boolean success
05145 );
05146
05167 void deleteSnapshot (
05168 in IConsole initiator,
05169 in wstringUUID id,
05170 out MachineState machineState,
05171 [retval] out IProgress progress
05172 );
05173
05192 void finishOnlineMergeMedium (
05193 in IMediumAttachment mediumAttachment,
05194 in IMedium source,
05195 in IMedium target,
05196 in boolean mergeForward,
05197 in IMedium parentForTarget,
05198 in IMedium[] childrenToReparent
05199 );
05200
05214 void restoreSnapshot (
05215 in IConsole initiator,
05216 in ISnapshot snapshot,
05217 out MachineState machineState,
05218 [retval] out IProgress progress
05219 );
05220
05247 void pullGuestProperties (
05248 out wstring[] name,
05249 out wstring[] value,
05250 out unsigned long long[] timestamp,
05251 out wstring[] flags
05252 );
05253
05275 void pushGuestProperty (
05276 in wstring name,
05277 in wstring value,
05278 in unsigned long long timestamp,
05279 in wstring flags
05280 );
05281
05293 void lockMedia();
05294
05304 void unlockMedia();
05305
05306 };
05307
05316 interface IBIOSSettings : $unknown
05317 {
05321 attribute boolean logoFadeIn;
05322
05326 attribute boolean logoFadeOut;
05327
05331 attribute unsigned long logoDisplayTime;
05332
05339 attribute wstring logoImagePath;
05340
05344 attribute BIOSBootMenuMode bootMenuMode;
05345
05349 attribute boolean ACPIEnabled;
05350
05357 attribute boolean IOAPICEnabled;
05358
05368 attribute long long timeOffset;
05369
05376 attribute boolean PXEDebugEnabled;
05377
05378 };
05379
05420 interface IMachine : $unknown
05421 {
05425 readonly attribute IVirtualBox parent;
05426
05476 readonly attribute boolean accessible;
05477
05489 readonly attribute IVirtualBoxErrorInfo accessError;
05490
05536 attribute wstring name;
05537
05548 attribute wstring description;
05549
05553 readonly attribute wstringUUID id;
05554
05569 attribute wstring OSTypeId;
05570
05574 attribute wstring HardwareVersion;
05575
05585 attribute wstringUUID hardwareUUID;
05586
05590 attribute unsigned long CPUCount;
05591
05597 attribute boolean CPUHotPlugEnabled;
05598
05602 attribute unsigned long memorySize;
05603
05607 attribute unsigned long memoryBalloonSize;
05608
05615 attribute boolean PageFusionEnabled;
05616
05620 attribute unsigned long VRAMSize;
05621
05627 attribute boolean accelerate3DEnabled;
05628
05634 attribute boolean accelerate2DVideoEnabled;
05635
05646 attribute unsigned long monitorCount;
05647
05651 readonly attribute IBIOSSettings BIOSSettings;
05652
05657 attribute FirmwareType firmwareType;
05658
05664 attribute PointingHidType pointingHidType;
05665
05671 attribute KeyboardHidType keyboardHidType;
05672
05679 attribute boolean hpetEnabled;
05680
05714 attribute wstring snapshotFolder;
05715
05719 readonly attribute IVRDPServer VRDPServer;
05720
05724 readonly attribute IMediumAttachment[] mediumAttachments;
05725
05737 readonly attribute IUSBController USBController;
05738
05742 readonly attribute IAudioAdapter audioAdapter;
05743
05747 readonly attribute IStorageController[] storageControllers;
05748
05754 readonly attribute wstring settingsFilePath;
05755
05780 readonly attribute boolean settingsModified;
05781
05785 readonly attribute SessionState sessionState;
05786
05799 readonly attribute wstring sessionType;
05800
05812 readonly attribute unsigned long sessionPid;
05813
05817 readonly attribute MachineState state;
05818
05825 readonly attribute long long lastStateChange;
05826
05838 readonly attribute wstring stateFilePath;
05839
05849 readonly attribute wstring logFolder;
05850
05861 readonly attribute ISnapshot currentSnapshot;
05862
05869 readonly attribute unsigned long snapshotCount;
05870
05904 readonly attribute boolean currentStateModified;
05905
05917 readonly attribute ISharedFolder[] sharedFolders;
05918
05925 attribute ClipboardMode clipboardMode;
05926
05934 attribute wstring guestPropertyNotificationPatterns;
05935
05944 attribute boolean teleporterEnabled;
05945
05956 attribute unsigned long teleporterPort;
05957
05964 attribute wstring teleporterAddress;
05965
05973 attribute wstring teleporterPassword;
05974
05982 attribute boolean RTCUseUTC;
05983
05990 attribute boolean ioCacheEnabled;
05991
05997 attribute unsigned long ioCacheSize;
05998
06005 attribute unsigned long ioBandwidthMax;
06006
06044 void setBootOrder (
06045 in unsigned long position,
06046 in DeviceType device
06047 );
06048
06083 void getBootOrder (
06084 in unsigned long position,
06085 [retval] out DeviceType device
06086 );
06087
06177 void attachDevice (
06178 in wstring name,
06179 in long controllerPort,
06180 in long device,
06181 in DeviceType type,
06182 in wstringUUID id
06183 );
06184
06237 void detachDevice (
06238 in wstring name,
06239 in long controllerPort,
06240 in long device
06241 );
06242
06285 void passthroughDevice (
06286 in wstring name,
06287 in long controllerPort,
06288 in long device,
06289 in boolean passthrough
06290 );
06291
06355 void mountMedium (
06356 in wstring name,
06357 in long controllerPort,
06358 in long device,
06359 in wstringUUID medium,
06360 in boolean force
06361 );
06362
06391 void getMedium (
06392 in wstring name,
06393 in long controllerPort,
06394 in long device,
06395 [retval] out IMedium medium
06396 );
06397
06412 void getMediumAttachmentsOfController (
06413 in wstring name,
06414 [retval] out IMediumAttachment[] mediumAttachments
06415 );
06416
06431 void getMediumAttachment (
06432 in wstring name,
06433 in long controllerPort,
06434 in long device,
06435 [retval] out IMediumAttachment attachment
06436 );
06437
06455 void getNetworkAdapter (
06456 in unsigned long slot,
06457 [retval] out INetworkAdapter adapter
06458 );
06459
06492 void addStorageController (
06493 in wstring name,
06494 in StorageBus connectionType,
06495 [retval] out IStorageController controller
06496 );
06497
06511 void getStorageControllerByName (
06512 in wstring name,
06513 [retval] out IStorageController storageController
06514 );
06515
06529 void getStorageControllerByInstance (
06530 in unsigned long instance,
06531 [retval] out IStorageController storageController
06532 );
06533
06547 void removeStorageController (
06548 in wstring name
06549 );
06550
06568 void getSerialPort (
06569 in unsigned long slot,
06570 [retval] out ISerialPort port
06571 );
06572
06590 void getParallelPort (
06591 in unsigned long slot,
06592 [retval] out IParallelPort port
06593 );
06594
06603 void getExtraDataKeys (
06604 [retval] out wstring[] value
06605 );
06606
06635 void getExtraData (
06636 in wstring key,
06637 [retval] out wstring value
06638 );
06639
06689 void setExtraData (
06690 in wstring key,
06691 in wstring value
06692 );
06693
06715 void getCPUProperty (
06716 in CPUPropertyType property,
06717 [retval] out boolean value
06718 );
06719
06741 void setCPUProperty (
06742 in CPUPropertyType property,
06743 in boolean value
06744 );
06745
06785 void getCPUIDLeaf (
06786 in unsigned long id,
06787 out unsigned long valEax,
06788 out unsigned long valEbx,
06789 out unsigned long valEcx,
06790 out unsigned long valEdx
06791 );
06792
06836 void setCPUIDLeaf (
06837 in unsigned long id,
06838 in unsigned long valEax,
06839 in unsigned long valEbx,
06840 in unsigned long valEcx,
06841 in unsigned long valEdx
06842 );
06843
06861 void removeCPUIDLeaf (
06862 in unsigned long id
06863 );
06864
06870 void removeAllCPUIDLeaves();
06871
06893 void getHWVirtExProperty (
06894 in HWVirtExPropertyType property,
06895 [retval] out boolean value
06896 );
06897
06919 void setHWVirtExProperty (
06920 in HWVirtExPropertyType property,
06921 in boolean value
06922 );
06923
06969 void saveSettings();
06970
06994 void discardSettings();
06995
07037 void deleteSettings();
07038
07048 void export (
07049 in IAppliance aAppliance,
07050 [retval] out IVirtualSystemDescription aDescription
07051 );
07052
07074 void getSnapshot (
07075 in wstringUUID id,
07076 [retval] out ISnapshot snapshot
07077 );
07078
07096 void findSnapshot (
07097 in wstring name,
07098 [retval] out ISnapshot snapshot
07099 );
07100
07113 void setCurrentSnapshot (
07114 in wstringUUID id
07115 );
07116
07147 void createSharedFolder (
07148 in wstring name,
07149 in wstring hostPath,
07150 in boolean writable
07151 );
07152
07178 void removeSharedFolder (
07179 in wstring name
07180 );
07181
07205 void canShowConsoleWindow (
07206 [retval] out boolean canShow
07207 );
07208
07243 void showConsoleWindow (
07244 [retval] out unsigned long long winId
07245 );
07246
07279 void getGuestProperty (
07280 in wstring name,
07281 out wstring value,
07282 out unsigned long long timestamp,
07283 out wstring flags
07284 );
07285
07308 void getGuestPropertyValue (
07309 in wstring property,
07310 [retval] out wstring value
07311 );
07312
07335 void getGuestPropertyTimestamp (
07336 in wstring property,
07337 [retval] out unsigned long long value
07338 );
07339
07390 void setGuestProperty (
07391 in wstring property,
07392 in wstring value,
07393 in wstring flags
07394 );
07395
07436 void setGuestPropertyValue (
07437 in wstring property,
07438 in wstring value
07439 );
07440
07471 void enumerateGuestProperties (
07472 in wstring patterns,
07473 out wstring[] name,
07474 out wstring[] value,
07475 out unsigned long long[] timestamp,
07476 out wstring[] flags
07477 );
07478
07500 void querySavedThumbnailSize (
07501 in unsigned long screenId,
07502 out unsigned long size,
07503 out unsigned long width,
07504 out unsigned long height
07505 );
07506
07533 void readSavedThumbnailToArray (
07534 in unsigned long screenId,
07535 in boolean BGR,
07536 out unsigned long width,
07537 out unsigned long height,
07538 [retval] out octet[] data
07539 );
07540
07562 void querySavedScreenshotPNGSize (
07563 in unsigned long screenId,
07564 out unsigned long size,
07565 out unsigned long width,
07566 out unsigned long height
07567 );
07568
07590 void readSavedScreenshotPNGToArray (
07591 in unsigned long screenId,
07592 out unsigned long width,
07593 out unsigned long height,
07594 [retval] out octet[] data
07595 );
07596
07606 void hotPlugCPU (
07607 in unsigned long cpu
07608 );
07609
07619 void hotUnplugCPU (
07620 in unsigned long cpu
07621 );
07622
07636 void getCPUStatus (
07637 in unsigned long cpu,
07638 [retval] out boolean attached
07639 );
07640
07655 void queryLogFilename (
07656 in unsigned long idx,
07657 [retval] out wstring filename
07658 );
07659
07685 void readLog (
07686 in unsigned long idx,
07687 in unsigned long long offset,
07688 in unsigned long long size,
07689 [retval] out octet[] data
07690 );
07691
07692 };
07693
07712 interface IConsoleCallback : $unknown
07713 {
07782 void onMousePointerShapeChange (
07783 in boolean visible,
07784 in boolean alpha,
07785 in unsigned long xHot,
07786 in unsigned long yHot,
07787 in unsigned long width,
07788 in unsigned long height,
07789 in octet[] shape
07790 );
07791
07805 void onMouseCapabilityChange (
07806 in boolean supportsAbsolute,
07807 in boolean supportsRelative,
07808 in boolean needsHostCursor
07809 );
07810
07824 void onKeyboardLedsChange (
07825 in boolean numLock,
07826 in boolean capsLock,
07827 in boolean scrollLock
07828 );
07829
07843 void onStateChange (
07844 in MachineState state
07845 );
07846
07854 void onAdditionsStateChange();
07855
07873 void onNetworkAdapterChange (
07874 in INetworkAdapter networkAdapter
07875 );
07876
07894 void onSerialPortChange (
07895 in ISerialPort serialPort
07896 );
07897
07915 void onParallelPortChange (
07916 in IParallelPort parallelPort
07917 );
07918
07934 void onStorageControllerChange();
07935
07952 void onMediumChange (
07953 in IMediumAttachment mediumAttachment
07954 );
07955
07972 void onCPUChange (
07973 in unsigned long cpu,
07974 in boolean add
07975 );
07976
07992 void onVRDPServerChange();
07993
08008 void onRemoteDisplayInfoChange();
08009
08025 void onUSBControllerChange();
08026
08066 void onUSBDeviceStateChange (
08067 in IUSBDevice device,
08068 in boolean attached,
08069 in IVirtualBoxErrorInfo error
08070 );
08071
08094 void onSharedFolderChange (
08095 in Scope scope
08096 );
08097
08169 void onRuntimeError (
08170 in boolean fatal,
08171 in wstring id,
08172 in wstring message
08173 );
08174
08209 void onCanShowWindow (
08210 [retval] out boolean canShow
08211 );
08212
08266 void onShowWindow (
08267 [retval] out unsigned long long winId
08268 );
08269
08270 };
08271
08280 interface IRemoteDisplayInfo : $unknown
08281 {
08287 readonly attribute boolean active;
08288
08297 readonly attribute long port;
08298
08304 readonly attribute unsigned long numberOfClients;
08305
08311 readonly attribute long long beginTime;
08312
08319 readonly attribute long long endTime;
08320
08326 readonly attribute unsigned long long bytesSent;
08327
08333 readonly attribute unsigned long long bytesSentTotal;
08334
08340 readonly attribute unsigned long long bytesReceived;
08341
08347 readonly attribute unsigned long long bytesReceivedTotal;
08348
08354 readonly attribute wstring user;
08355
08361 readonly attribute wstring domain;
08362
08368 readonly attribute wstring clientName;
08369
08375 readonly attribute wstring clientIP;
08376
08382 readonly attribute unsigned long clientVersion;
08383
08391 readonly attribute unsigned long encryptionStyle;
08392
08393 };
08394
08417 interface IConsole : $unknown
08418 {
08430 readonly attribute IMachine machine;
08431
08445 readonly attribute MachineState state;
08446
08450 readonly attribute IGuest guest;
08451
08462 readonly attribute IKeyboard keyboard;
08463
08474 readonly attribute IMouse mouse;
08475
08485 readonly attribute IDisplay display;
08486
08490 readonly attribute IMachineDebugger debugger;
08491
08502 readonly attribute IUSBDevice[] USBDevices;
08503
08511 readonly attribute IHostUSBDevice[] remoteUSBDevices;
08512
08528 readonly attribute ISharedFolder[] sharedFolders;
08529
08535 readonly attribute IRemoteDisplayInfo remoteDisplayInfo;
08536
08600 void powerUp (
08601 [retval] out IProgress progress
08602 );
08603
08637 void powerUpPaused (
08638 [retval] out IProgress progress
08639 );
08640
08660 void powerDown (
08661 [retval] out IProgress progress
08662 );
08663
08683 void reset();
08684
08704 void pause();
08705
08725 void resume();
08726
08746 void powerButton();
08747
08767 void sleepButton();
08768
08780 void getPowerButtonHandled (
08781 [retval] out boolean handled
08782 );
08783
08797 void getGuestEnteredACPIMode (
08798 [retval] out boolean entered
08799 );
08800
08853 void saveState (
08854 [retval] out IProgress progress
08855 );
08856
08889 void adoptSavedState (
08890 in wstring savedStateFile
08891 );
08892
08915 void forgetSavedState (
08916 in boolean remove
08917 );
08918
08931 void getDeviceActivity (
08932 in DeviceType type,
08933 [retval] out DeviceActivity activity
08934 );
08935
08972 void attachUSBDevice (
08973 in wstringUUID id
08974 );
08975
09009 void detachUSBDevice (
09010 in wstringUUID id,
09011 [retval] out IUSBDevice device
09012 );
09013
09036 void findUSBDeviceByAddress (
09037 in wstring name,
09038 [retval] out IUSBDevice device
09039 );
09040
09060 void findUSBDeviceById (
09061 in wstringUUID id,
09062 [retval] out IUSBDevice device
09063 );
09064
09095 void createSharedFolder (
09096 in wstring name,
09097 in wstring hostPath,
09098 in boolean writable
09099 );
09100
09125 void removeSharedFolder (
09126 in wstring name
09127 );
09128
09166 void takeSnapshot (
09167 in wstring name,
09168 in wstring description,
09169 [retval] out IProgress progress
09170 );
09171
09242 void deleteSnapshot (
09243 in wstringUUID id,
09244 [retval] out IProgress progress
09245 );
09246
09287 void restoreSnapshot (
09288 in ISnapshot snapshot,
09289 [retval] out IProgress progress
09290 );
09291
09330 void teleport (
09331 in wstring hostname,
09332 in unsigned long tcpport,
09333 in wstring password,
09334 in unsigned long maxDowntime,
09335 [retval] out IProgress progress
09336 );
09337
09345 void registerCallback (
09346 in IConsoleCallback callback
09347 );
09348
09362 void unregisterCallback (
09363 in IConsoleCallback callback
09364 );
09365
09366 };
09367
09378 interface IHostNetworkInterface : $unknown
09379 {
09383 readonly attribute wstring name;
09384
09388 readonly attribute wstringUUID id;
09389
09393 readonly attribute wstring networkName;
09394
09398 readonly attribute boolean dhcpEnabled;
09399
09403 readonly attribute wstring IPAddress;
09404
09408 readonly attribute wstring networkMask;
09409
09413 readonly attribute boolean IPV6Supported;
09414
09418 readonly attribute wstring IPV6Address;
09419
09423 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
09424
09428 readonly attribute wstring hardwareAddress;
09429
09433 readonly attribute HostNetworkInterfaceMediumType mediumType;
09434
09438 readonly attribute HostNetworkInterfaceStatus status;
09439
09443 readonly attribute HostNetworkInterfaceType interfaceType;
09444
09456 void enableStaticIpConfig (
09457 in wstring IPAddress,
09458 in wstring networkMask
09459 );
09460
09472 void enableStaticIpConfigV6 (
09473 in wstring IPV6Address,
09474 in unsigned long IPV6NetworkMaskPrefixLength
09475 );
09476
09480 void enableDynamicIpConfig();
09481
09485 void dhcpRediscover();
09486
09487 };
09488
09505 interface IHost : $unknown
09506 {
09510 readonly attribute IMedium[] DVDDrives;
09511
09515 readonly attribute IMedium[] floppyDrives;
09516
09530 readonly attribute IHostUSBDevice[] USBDevices;
09531
09554 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
09555
09559 readonly attribute IHostNetworkInterface[] networkInterfaces;
09560
09564 readonly attribute unsigned long processorCount;
09565
09569 readonly attribute unsigned long processorOnlineCount;
09570
09574 readonly attribute unsigned long processorCoreCount;
09575
09579 readonly attribute unsigned long memorySize;
09580
09584 readonly attribute unsigned long memoryAvailable;
09585
09589 readonly attribute wstring operatingSystem;
09590
09594 readonly attribute wstring OSVersion;
09595
09599 readonly attribute long long UTCTime;
09600
09604 readonly attribute boolean Acceleration3DAvailable;
09605
09620 void getProcessorSpeed (
09621 in unsigned long cpuId,
09622 [retval] out unsigned long speed
09623 );
09624
09636 void getProcessorFeature (
09637 in ProcessorFeature feature,
09638 [retval] out boolean supported
09639 );
09640
09659 void getProcessorDescription (
09660 in unsigned long cpuId,
09661 [retval] out wstring description
09662 );
09663
09704 void getProcessorCPUIDLeaf (
09705 in unsigned long cpuId,
09706 in unsigned long leaf,
09707 in unsigned long subLeaf,
09708 out unsigned long valEax,
09709 out unsigned long valEbx,
09710 out unsigned long valEcx,
09711 out unsigned long valEdx
09712 );
09713
09734 void createHostOnlyNetworkInterface (
09735 out IHostNetworkInterface hostInterface,
09736 [retval] out IProgress progress
09737 );
09738
09759 void removeHostOnlyNetworkInterface (
09760 in wstringUUID id,
09761 [retval] out IProgress progress
09762 );
09763
09784 void createUSBDeviceFilter (
09785 in wstring name,
09786 [retval] out IHostUSBDeviceFilter filter
09787 );
09788
09831 void insertUSBDeviceFilter (
09832 in unsigned long position,
09833 in IHostUSBDeviceFilter filter
09834 );
09835
09863 void removeUSBDeviceFilter (
09864 in unsigned long position
09865 );
09866
09884 void findHostDVDDrive (
09885 in wstring name,
09886 [retval] out IMedium drive
09887 );
09888
09906 void findHostFloppyDrive (
09907 in wstring name,
09908 [retval] out IMedium drive
09909 );
09910
09926 void findHostNetworkInterfaceByName (
09927 in wstring name,
09928 [retval] out IHostNetworkInterface networkInterface
09929 );
09930
09946 void findHostNetworkInterfaceById (
09947 in wstringUUID id,
09948 [retval] out IHostNetworkInterface networkInterface
09949 );
09950
09960 void findHostNetworkInterfacesOfType (
09961 in HostNetworkInterfaceType type,
09962 [retval] out IHostNetworkInterface[] networkInterfaces
09963 );
09964
09984 void findUSBDeviceById (
09985 in wstringUUID id,
09986 [retval] out IHostUSBDevice device
09987 );
09988
10011 void findUSBDeviceByAddress (
10012 in wstring name,
10013 [retval] out IHostUSBDevice device
10014 );
10015
10016 };
10017
10030 interface ISystemProperties : $unknown
10031 {
10035 readonly attribute unsigned long minGuestRAM;
10036
10040 readonly attribute unsigned long maxGuestRAM;
10041
10045 readonly attribute unsigned long minGuestVRAM;
10046
10050 readonly attribute unsigned long maxGuestVRAM;
10051
10055 readonly attribute unsigned long minGuestCPUCount;
10056
10060 readonly attribute unsigned long maxGuestCPUCount;
10061
10065 readonly attribute unsigned long maxGuestMonitors;
10066
10070 readonly attribute unsigned long long maxVDISize;
10071
10078 readonly attribute unsigned long networkAdapterCount;
10079
10086 readonly attribute unsigned long serialPortCount;
10087
10094 readonly attribute unsigned long parallelPortCount;
10095
10105 readonly attribute unsigned long maxBootPosition;
10106
10139 attribute wstring defaultMachineFolder;
10140
10179 attribute wstring defaultHardDiskFolder;
10180
10206 readonly attribute IMediumFormat[] mediumFormats;
10207
10241 attribute wstring defaultHardDiskFormat;
10242
10248 attribute unsigned long long freeDiskSpaceWarning;
10249
10254 attribute unsigned long freeDiskSpacePercentWarning;
10255
10261 attribute unsigned long long freeDiskSpaceError;
10262
10267 attribute unsigned long freeDiskSpacePercentError;
10268
10292 attribute wstring remoteDisplayAuthLibrary;
10293
10322 attribute wstring webServiceAuthLibrary;
10323
10329 attribute unsigned long LogHistoryCount;
10330
10335 readonly attribute AudioDriverType defaultAudioDriver;
10336
10346 void getMaxDevicesPerPortForStorageBus (
10347 in StorageBus bus,
10348 [retval] out unsigned long maxDevicesPerPort
10349 );
10350
10358 void getMinPortCountForStorageBus (
10359 in StorageBus bus,
10360 [retval] out unsigned long minPortCount
10361 );
10362
10370 void getMaxPortCountForStorageBus (
10371 in StorageBus bus,
10372 [retval] out unsigned long maxPortCount
10373 );
10374
10384 void getMaxInstancesOfStorageBus (
10385 in StorageBus bus,
10386 [retval] out unsigned long maxInstances
10387 );
10388
10398 void getDeviceTypesForStorageBus (
10399 in StorageBus bus,
10400 [retval] out DeviceType[] deviceTypes
10401 );
10402
10403 };
10404
10410 interface IGuestOSType : $unknown
10411 {
10415 readonly attribute wstring familyId;
10416
10420 readonly attribute wstring familyDescription;
10421
10425 readonly attribute wstring id;
10426
10430 readonly attribute wstring description;
10431
10435 readonly attribute boolean is64Bit;
10436
10440 readonly attribute boolean recommendedIOAPIC;
10441
10445 readonly attribute boolean recommendedVirtEx;
10446
10450 readonly attribute unsigned long recommendedRAM;
10451
10455 readonly attribute unsigned long recommendedVRAM;
10456
10460 readonly attribute unsigned long recommendedHDD;
10461
10465 readonly attribute NetworkAdapterType adapterType;
10466
10470 readonly attribute boolean recommendedPae;
10471
10475 readonly attribute StorageControllerType recommendedDvdStorageController;
10476
10480 readonly attribute StorageBus recommendedDvdStorageBus;
10481
10485 readonly attribute StorageControllerType recommendedHdStorageController;
10486
10490 readonly attribute StorageBus recommendedHdStorageBus;
10491
10495 readonly attribute FirmwareType recommendedFirmware;
10496
10500 readonly attribute boolean recommendedUsbHid;
10501
10505 readonly attribute boolean recommendedHpet;
10506
10510 readonly attribute boolean recommendedUsbTablet;
10511
10515 readonly attribute boolean recommendedRtcUseUtc;
10516
10517 };
10518
10532 interface IGuest : $unknown
10533 {
10548 readonly attribute wstring OSTypeId;
10549
10557 readonly attribute boolean additionsActive;
10558
10568 readonly attribute wstring additionsVersion;
10569
10576 readonly attribute boolean supportsSeamless;
10577
10586 readonly attribute boolean supportsGraphics;
10587
10591 attribute unsigned long memoryBalloonSize;
10592
10596 attribute boolean pageFusionEnabled;
10597
10601 attribute unsigned long statisticsUpdateInterval;
10602
10634 void internalGetStatistics (
10635 out unsigned long cpuUser,
10636 out unsigned long cpuKernel,
10637 out unsigned long cpuIdle,
10638 out unsigned long memTotal,
10639 out unsigned long memFree,
10640 out unsigned long memBalloon,
10641 out unsigned long memShared,
10642 out unsigned long memCache,
10643 out unsigned long pagedTotal,
10644 out unsigned long memAllocTotal,
10645 out unsigned long memFreeTotal,
10646 out unsigned long memBalloonTotal,
10647 out unsigned long memSharedTotal
10648 );
10649
10679 void setCredentials (
10680 in wstring userName,
10681 in wstring password,
10682 in wstring domain,
10683 in boolean allowInteractiveLogon
10684 );
10685
10739 void executeProcess (
10740 in wstring execName,
10741 in unsigned long flags,
10742 in wstring[] arguments,
10743 in wstring[] environment,
10744 in wstring userName,
10745 in wstring password,
10746 in unsigned long timeoutMS,
10747 out unsigned long pid,
10748 [retval] out IProgress progress
10749 );
10750
10788 void getProcessOutput (
10789 in unsigned long pid,
10790 in unsigned long flags,
10791 in unsigned long timeoutMS,
10792 in unsigned long long size,
10793 [retval] out octet[] data
10794 );
10795
10825 void getProcessStatus (
10826 in unsigned long pid,
10827 out unsigned long exitcode,
10828 out unsigned long flags,
10829 [retval] out unsigned long reason
10830 );
10831
10832 };
10833
10874 interface IProgress : $unknown
10875 {
10879 readonly attribute wstringUUID id;
10880
10884 readonly attribute wstring description;
10885
10889 readonly attribute $unknown initiator;
10890
10894 readonly attribute boolean cancelable;
10895
10903 readonly attribute unsigned long percent;
10904
10918 readonly attribute long timeRemaining;
10919
10923 readonly attribute boolean completed;
10924
10928 readonly attribute boolean canceled;
10929
10936 readonly attribute long resultCode;
10937
10947 readonly attribute IVirtualBoxErrorInfo errorInfo;
10948
10955 readonly attribute unsigned long operationCount;
10956
10960 readonly attribute unsigned long operation;
10961
10967 readonly attribute wstring operationDescription;
10968
10972 readonly attribute unsigned long operationPercent;
10973
10981 attribute unsigned long timeout;
10982
10986 void setCurrentOperationProgress (
10987 in unsigned long percent
10988 );
10989
10993 void setNextOperation (
10994 in wstring nextOperationDescription,
10995 in unsigned long nextOperationsWeight
10996 );
10997
11016 void waitForCompletion (
11017 in long timeout
11018 );
11019
11043 void waitForOperationCompletion (
11044 in unsigned long operation,
11045 in long timeout
11046 );
11047
11064 void cancel();
11065
11066 };
11067
11168 interface ISnapshot : $unknown
11169 {
11173 readonly attribute wstringUUID id;
11174
11182 attribute wstring name;
11183
11191 attribute wstring description;
11192
11198 readonly attribute long long timeStamp;
11199
11211 readonly attribute boolean online;
11212
11224 readonly attribute IMachine machine;
11225
11232 readonly attribute ISnapshot parent;
11233
11242 readonly attribute ISnapshot[] children;
11243
11244 };
11245
11261 interface IMediumAttachment : $unknown
11262 {
11267 readonly attribute IMedium medium;
11268
11274 readonly attribute wstring controller;
11275
11281 readonly attribute long port;
11282
11288 readonly attribute long device;
11289
11293 readonly attribute DeviceType type;
11294
11298 readonly attribute boolean passthrough;
11299
11300 };
11301
11655 interface IMedium : $unknown
11656 {
11670 readonly attribute wstringUUID id;
11671
11690 attribute wstring description;
11691
11707 readonly attribute MediumState state;
11708
11730 attribute wstring location;
11731
11751 readonly attribute wstring name;
11752
11757 readonly attribute DeviceType deviceType;
11758
11762 readonly attribute boolean hostDrive;
11763
11776 readonly attribute unsigned long long size;
11777
11792 readonly attribute wstring format;
11793
11809 readonly attribute IMediumFormat mediumFormat;
11810
11835 attribute MediumType type;
11836
11846 readonly attribute IMedium parent;
11847
11855 readonly attribute IMedium[] children;
11856
11867 readonly attribute IMedium base;
11868
11901 readonly attribute boolean readOnly;
11902
11923 readonly attribute unsigned long long logicalSize;
11924
11952 attribute boolean autoReset;
11953
11968 readonly attribute wstring lastAccessError;
11969
11986 readonly attribute wstringUUID[] machineIds;
11987
12022 void refreshState (
12023 [retval] out MediumState state
12024 );
12025
12052 void getSnapshotIds (
12053 in wstringUUID machineId,
12054 [retval] out wstringUUID[] snapshotIds
12055 );
12056
12116 void lockRead (
12117 [retval] out MediumState state
12118 );
12119
12142 void unlockRead (
12143 [retval] out MediumState state
12144 );
12145
12200 void lockWrite (
12201 [retval] out MediumState state
12202 );
12203
12226 void unlockWrite (
12227 [retval] out MediumState state
12228 );
12229
12278 void close();
12279
12309 void getProperty (
12310 in wstring name,
12311 [retval] out wstring value
12312 );
12313
12345 void setProperty (
12346 in wstring name,
12347 in wstring value
12348 );
12349
12383 void getProperties (
12384 in wstring names,
12385 out wstring[] returnNames,
12386 [retval] out wstring[] returnValues
12387 );
12388
12420 void setProperties (
12421 in wstring[] names,
12422 in wstring[] values
12423 );
12424
12456 void createBaseStorage (
12457 in unsigned long long logicalSize,
12458 in MediumVariant variant,
12459 [retval] out IProgress progress
12460 );
12461
12513 void deleteStorage (
12514 [retval] out IProgress progress
12515 );
12516
12554 void createDiffStorage (
12555 in IMedium target,
12556 in MediumVariant variant,
12557 [retval] out IProgress progress
12558 );
12559
12635 void mergeTo (
12636 in IMedium target,
12637 [retval] out IProgress progress
12638 );
12639
12688 void cloneTo (
12689 in IMedium target,
12690 in MediumVariant variant,
12691 in IMedium parent,
12692 [retval] out IProgress progress
12693 );
12694
12723 void compact (
12724 [retval] out IProgress progress
12725 );
12726
12759 void resize (
12760 in unsigned long long logicalSize,
12761 [retval] out IProgress progress
12762 );
12763
12797 void reset (
12798 [retval] out IProgress progress
12799 );
12800
12801 };
12802
12825 interface IMediumFormat : $unknown
12826 {
12845 readonly attribute wstring id;
12846
12854 readonly attribute wstring name;
12855
12871 readonly attribute wstring[] fileExtensions;
12872
12881 readonly attribute unsigned long capabilities;
12882
12912 void describeProperties (
12913 out wstring[] names,
12914 out wstring[] description,
12915 out DataType[] types,
12916 out unsigned long[] flags,
12917 out wstring[] defaults
12918 );
12919
12920 };
12921
12934 interface IKeyboard : $unknown
12935 {
12948 void putScancode (
12949 in long scancode
12950 );
12951
12964 void putScancodes (
12965 in long[] scancodes,
12966 [retval] out unsigned long codesStored
12967 );
12968
12983 void putCAD();
12984
12985 };
12986
12998 interface IMouse : $unknown
12999 {
13014 readonly attribute boolean absoluteSupported;
13015
13030 readonly attribute boolean relativeSupported;
13031
13046 readonly attribute boolean needsHostCursor;
13047
13113 void putMouseEvent (
13114 in long dx,
13115 in long dy,
13116 in long dz,
13117 in long dw,
13118 in long buttonState
13119 );
13120
13193 void putMouseEventAbsolute (
13194 in long x,
13195 in long y,
13196 in long dz,
13197 in long dw,
13198 in long buttonState
13199 );
13200
13201 };
13202
13203 interface IFramebuffer : $unknown
13204 {
13213 readonly attribute octetPtr address;
13214
13218 readonly attribute unsigned long width;
13219
13223 readonly attribute unsigned long height;
13224
13231 readonly attribute unsigned long bitsPerPixel;
13232
13239 readonly attribute unsigned long bytesPerLine;
13240
13251 readonly attribute unsigned long pixelFormat;
13252
13259 readonly attribute boolean usesGuestVRAM;
13260
13270 readonly attribute unsigned long heightReduction;
13271
13286 readonly attribute IFramebufferOverlay overlay;
13287
13294 readonly attribute unsigned long long winId;
13295
13303 void lock();
13304
13312 void unlock();
13313
13321 void notifyUpdate (
13322 in unsigned long x,
13323 in unsigned long y,
13324 in unsigned long width,
13325 in unsigned long height
13326 );
13327
13440 void requestResize (
13441 in unsigned long screenId,
13442 in unsigned long pixelFormat,
13443 in octetPtr VRAM,
13444 in unsigned long bitsPerPixel,
13445 in unsigned long bytesPerLine,
13446 in unsigned long width,
13447 in unsigned long height,
13448 [retval] out boolean finished
13449 );
13450
13462 void videoModeSupported (
13463 in unsigned long width,
13464 in unsigned long height,
13465 in unsigned long bpp,
13466 [retval] out boolean supported
13467 );
13468
13505 void getVisibleRegion (
13506 in octetPtr rectangles,
13507 in unsigned long count,
13508 [retval] out unsigned long countCopied
13509 );
13510
13545 void setVisibleRegion (
13546 in octetPtr rectangles,
13547 in unsigned long count
13548 );
13549
13570 void processVHWACommand (
13571 in octetPtr command
13572 );
13573
13574 };
13575
13590 interface IFramebufferOverlay : IFramebuffer
13591 {
13595 readonly attribute unsigned long x;
13596
13600 readonly attribute unsigned long y;
13601
13607 attribute boolean visible;
13608
13615 attribute unsigned long alpha;
13616
13622 void move (
13623 in unsigned long x,
13624 in unsigned long y
13625 );
13626
13627 };
13628
13644 interface IDisplay : $unknown
13645 {
13649 void getScreenResolution (
13650 in unsigned long screenId,
13651 out unsigned long width,
13652 out unsigned long height,
13653 out unsigned long bitsPerPixel
13654 );
13655
13661 void setFramebuffer (
13662 in unsigned long screenId,
13663 in IFramebuffer framebuffer
13664 );
13665
13671 void getFramebuffer (
13672 in unsigned long screenId,
13673 out IFramebuffer framebuffer,
13674 out long xOrigin,
13675 out long yOrigin
13676 );
13677
13706 void setVideoModeHint (
13707 in unsigned long width,
13708 in unsigned long height,
13709 in unsigned long bitsPerPixel,
13710 in unsigned long display
13711 );
13712
13723 void setSeamlessMode (
13724 in boolean enabled
13725 );
13726
13760 void takeScreenShot (
13761 in unsigned long screenId,
13762 in octetPtr address,
13763 in unsigned long width,
13764 in unsigned long height
13765 );
13766
13810 void takeScreenShotToArray (
13811 in unsigned long screenId,
13812 in unsigned long width,
13813 in unsigned long height,
13814 [retval] out octet[] screenData
13815 );
13816
13862 void drawToScreen (
13863 in unsigned long screenId,
13864 in octetPtr address,
13865 in unsigned long x,
13866 in unsigned long y,
13867 in unsigned long width,
13868 in unsigned long height
13869 );
13870
13885 void invalidateAndUpdate();
13886
13900 void resizeCompleted (
13901 in unsigned long screenId
13902 );
13903
13916 void completeVHWACommand (
13917 in octetPtr command
13918 );
13919
13920 };
13921
13937 interface INetworkAdapter : $unknown
13938 {
13946 attribute NetworkAdapterType adapterType;
13947
13955 readonly attribute unsigned long slot;
13956
13965 attribute boolean enabled;
13966
13973 attribute wstring MACAddress;
13974
13975 readonly attribute NetworkAttachmentType attachmentType;
13976
13982 attribute wstring hostInterface;
13983
13989 attribute wstring internalNetwork;
13990
13996 attribute wstring NATNetwork;
13997
14003 attribute wstring VDENetwork;
14004
14011 attribute boolean cableConnected;
14012
14018 attribute unsigned long lineSpeed;
14019
14026 attribute boolean traceEnabled;
14027
14034 attribute wstring traceFile;
14035
14043 readonly attribute INATEngine natDriver;
14044
14051 attribute unsigned long bootPriority;
14052
14058 void attachToNAT();
14059
14065 void attachToBridgedInterface();
14066
14072 void attachToInternalNetwork();
14073
14079 void attachToHostOnlyInterface();
14080
14086 void attachToVDE();
14087
14093 void detach();
14094
14095 };
14096
14125 interface ISerialPort : $unknown
14126 {
14134 readonly attribute unsigned long slot;
14135
14142 attribute boolean enabled;
14143
14147 attribute unsigned long IOBase;
14148
14152 attribute unsigned long IRQ;
14153
14164 attribute PortMode hostMode;
14165
14173 attribute boolean server;
14174
14184 attribute wstring path;
14185
14186 };
14187
14207 interface IParallelPort : $unknown
14208 {
14216 readonly attribute unsigned long slot;
14217
14224 attribute boolean enabled;
14225
14229 attribute unsigned long IOBase;
14230
14234 attribute unsigned long IRQ;
14235
14243 attribute wstring path;
14244
14245 };
14246
14247 interface IMachineDebugger : $unknown
14248 {
14252 attribute boolean singlestep;
14253
14257 attribute boolean recompileUser;
14258
14262 attribute boolean recompileSupervisor;
14263
14267 attribute boolean PATMEnabled;
14268
14272 attribute boolean CSAMEnabled;
14273
14277 attribute boolean logEnabled;
14278
14285 readonly attribute boolean HWVirtExEnabled;
14286
14293 readonly attribute boolean HWVirtExNestedPagingEnabled;
14294
14301 readonly attribute boolean HWVirtExVPIDEnabled;
14302
14309 readonly attribute boolean PAEEnabled;
14310
14317 attribute unsigned long virtualTimeRate;
14318
14325 readonly attribute unsigned long long VM;
14326
14334 void resetStats (
14335 in wstring pattern
14336 );
14337
14345 void dumpStats (
14346 in wstring pattern
14347 );
14348
14360 void getStats (
14361 in wstring pattern,
14362 in boolean withDescriptions,
14363 out wstring stats
14364 );
14365
14371 void injectNMI();
14372
14373 };
14374
14375 interface IUSBController : $unknown
14376 {
14385 attribute boolean enabled;
14386
14395 attribute boolean enabledEhci;
14396
14402 readonly attribute boolean proxyAvailable;
14403
14411 readonly attribute unsigned short USBStandard;
14412
14438 readonly attribute IUSBDeviceFilter[] deviceFilters;
14439
14467 void createDeviceFilter (
14468 in wstring name,
14469 [retval] out IUSBDeviceFilter filter
14470 );
14471
14516 void insertDeviceFilter (
14517 in unsigned long position,
14518 in IUSBDeviceFilter filter
14519 );
14520
14553 void removeDeviceFilter (
14554 in unsigned long position,
14555 [retval] out IUSBDeviceFilter filter
14556 );
14557
14558 };
14559
14572 interface IUSBDevice : $unknown
14573 {
14580 readonly attribute wstringUUID id;
14581
14585 readonly attribute unsigned short vendorId;
14586
14590 readonly attribute unsigned short productId;
14591
14599 readonly attribute unsigned short revision;
14600
14604 readonly attribute wstring manufacturer;
14605
14609 readonly attribute wstring product;
14610
14614 readonly attribute wstring serialNumber;
14615
14619 readonly attribute wstring address;
14620
14627 readonly attribute unsigned short port;
14628
14634 readonly attribute unsigned short version;
14635
14643 readonly attribute unsigned short portVersion;
14644
14651 readonly attribute boolean remote;
14652
14653 };
14654
14728 interface IUSBDeviceFilter : $unknown
14729 {
14737 attribute wstring name;
14738
14742 attribute boolean active;
14743
14751 attribute wstring vendorId;
14752
14760 attribute wstring productId;
14761
14775 attribute wstring revision;
14776
14781 attribute wstring manufacturer;
14782
14787 attribute wstring product;
14788
14793 attribute wstring serialNumber;
14794
14799 attribute wstring port;
14800
14810 attribute wstring remote;
14811
14821 attribute unsigned long maskedInterfaces;
14822
14823 };
14824
14840 interface IHostUSBDevice : IUSBDevice
14841 {
14847 readonly attribute USBDeviceState state;
14848
14849 };
14850
14873 interface IHostUSBDeviceFilter : IUSBDeviceFilter
14874 {
14881 attribute USBDeviceFilterAction action;
14882
14883 };
14884
14893 interface IAudioAdapter : $unknown
14894 {
14903 attribute boolean enabled;
14904
14910 attribute AudioControllerType audioController;
14911
14918 attribute AudioDriverType audioDriver;
14919
14920 };
14921
14922 interface IVRDPServer : $unknown
14923 {
14927 attribute boolean enabled;
14928
14938 attribute wstring ports;
14939
14943 attribute wstring netAddress;
14944
14948 attribute VRDPAuthType authType;
14949
14953 attribute unsigned long authTimeout;
14954
14961 attribute boolean allowMultiConnection;
14962
14970 attribute boolean reuseSingleConnection;
14971
14977 attribute boolean videoChannel;
14978
14984 attribute unsigned long videoChannelQuality;
14985
14986 };
14987
15045 interface ISharedFolder : $unknown
15046 {
15050 readonly attribute wstring name;
15051
15055 readonly attribute wstring hostPath;
15056
15066 readonly attribute boolean accessible;
15067
15074 readonly attribute boolean writable;
15075
15088 readonly attribute wstring lastAccessError;
15089
15090 };
15091
15092 interface IInternalSessionControl : $unknown
15093 {
15098 void getPID (
15099 [retval] out unsigned long pid
15100 );
15101
15123 void getRemoteConsole (
15124 [retval] out IConsole console
15125 );
15126
15150 void assignMachine (
15151 in IMachine machine
15152 );
15153
15168 void assignRemoteMachine (
15169 in IMachine machine,
15170 in IConsole console
15171 );
15172
15196 void updateMachineState (
15197 in MachineState aMachineState
15198 );
15199
15215 void uninitialize();
15216
15239 void onNetworkAdapterChange (
15240 in INetworkAdapter networkAdapter,
15241 in boolean changeAdapter
15242 );
15243
15266 void onSerialPortChange (
15267 in ISerialPort serialPort
15268 );
15269
15292 void onParallelPortChange (
15293 in IParallelPort parallelPort
15294 );
15295
15318 void onStorageControllerChange();
15319
15342 void onMediumChange (
15343 in IMediumAttachment mediumAttachment,
15344 in boolean force
15345 );
15346
15356 void onCPUChange (
15357 in unsigned long cpu,
15358 in boolean add
15359 );
15360
15385 void onVRDPServerChange (
15386 in boolean restart
15387 );
15388
15411 void onUSBControllerChange();
15412
15441 void onSharedFolderChange (
15442 in boolean global
15443 );
15444
15470 void onUSBDeviceAttach (
15471 in IUSBDevice device,
15472 in IVirtualBoxErrorInfo error,
15473 in unsigned long maskedInterfaces
15474 );
15475
15501 void onUSBDeviceDetach (
15502 in wstringUUID id,
15503 in IVirtualBoxErrorInfo error
15504 );
15505
15523 void onShowWindow (
15524 in boolean check,
15525 out boolean canShow,
15526 out unsigned long long winId
15527 );
15528
15552 void accessGuestProperty (
15553 in wstring name,
15554 in wstring value,
15555 in wstring flags,
15556 in boolean isSetter,
15557 out wstring retValue,
15558 out unsigned long long retTimestamp,
15559 out wstring retFlags
15560 );
15561
15609 void enumerateGuestProperties (
15610 in wstring patterns,
15611 out wstring[] key,
15612 out wstring[] value,
15613 out unsigned long long[] timestamp,
15614 out wstring[] flags
15615 );
15616
15662 void onlineMergeMedium (
15663 in IMediumAttachment mediumAttachment,
15664 in unsigned long sourceIdx,
15665 in unsigned long targetIdx,
15666 in IMedium source,
15667 in IMedium target,
15668 in boolean mergeForward,
15669 in IMedium parentForTarget,
15670 in IMedium[] childrenToReparent,
15671 in IProgress progress
15672 );
15673
15674 };
15675
15752 interface ISession : $unknown
15753 {
15757 readonly attribute SessionState state;
15758
15766 readonly attribute SessionType type;
15767
15771 readonly attribute IMachine machine;
15772
15776 readonly attribute IConsole console;
15777
15818 void close();
15819
15820 };
15821
15844 interface IStorageController : $unknown
15845 {
15854 readonly attribute wstring name;
15855
15861 readonly attribute unsigned long maxDevicesPerPortCount;
15862
15868 readonly attribute unsigned long minPortCount;
15869
15875 readonly attribute unsigned long maxPortCount;
15876
15882 attribute unsigned long instance;
15883
15892 attribute unsigned long portCount;
15893
15899 readonly attribute StorageBus bus;
15900
15913 attribute StorageControllerType controllerType;
15914
15929 attribute boolean useHostIOCache;
15930
15953 void getIDEEmulationPort (
15954 in long devicePosition,
15955 [retval] out long portNumber
15956 );
15957
15981 void setIDEEmulationPort (
15982 in long devicePosition,
15983 in long portNumber
15984 );
15985
15986 };
15987
16011 interface IManagedObjectRef : $unknown
16012 {
16019 void getInterfaceName (
16020 [retval] out wstring return
16021 );
16022
16030 void release();
16031
16032 };
16033
16042 interface IWebsessionManager : $unknown
16043 {
16052 void logon (
16053 in wstring username,
16054 in wstring password,
16055 [retval] out IVirtualBox return
16056 );
16057
16067 void getSessionObject (
16068 in IVirtualBox refIVirtualBox,
16069 [retval] out ISession return
16070 );
16071
16079 void logoff (
16080 in IVirtualBox refIVirtualBox
16081 );
16082
16083 };
16084
16093 interface IPerformanceMetric : $unknown
16094 {
16100 readonly attribute wstring metricName;
16101
16107 readonly attribute $unknown object;
16108
16114 readonly attribute wstring description;
16115
16121 readonly attribute unsigned long period;
16122
16132 readonly attribute unsigned long count;
16133
16139 readonly attribute wstring unit;
16140
16146 readonly attribute long minimumValue;
16147
16153 readonly attribute long maximumValue;
16154
16155 };
16156
16262 interface IPerformanceCollector : $unknown
16263 {
16274 readonly attribute wstring[] metricNames;
16275
16299 void getMetrics (
16300 in wstring[] metricNames,
16301 in $unknown[] objects,
16302 [retval] out IPerformanceMetric[] metrics
16303 );
16304
16343 void setupMetrics (
16344 in wstring[] metricNames,
16345 in $unknown[] objects,
16346 in unsigned long period,
16347 in unsigned long count,
16348 [retval] out IPerformanceMetric[] affectedMetrics
16349 );
16350
16379 void enableMetrics (
16380 in wstring[] metricNames,
16381 in $unknown[] objects,
16382 [retval] out IPerformanceMetric[] affectedMetrics
16383 );
16384
16413 void disableMetrics (
16414 in wstring[] metricNames,
16415 in $unknown[] objects,
16416 [retval] out IPerformanceMetric[] affectedMetrics
16417 );
16418
16507 void queryMetricsData (
16508 in wstring[] metricNames,
16509 in $unknown[] objects,
16510 out wstring[] returnMetricNames,
16511 out $unknown[] returnObjects,
16512 out wstring[] returnUnits,
16513 out unsigned long[] returnScales,
16514 out unsigned long[] returnSequenceNumbers,
16515 out unsigned long[] returnDataIndices,
16516 out unsigned long[] returnDataLengths,
16517 [retval] out long[] returnData
16518 );
16519
16520 };
16521
16529 interface INATEngine : $unknown
16530 {
16535 attribute wstring network;
16536
16543 attribute wstring hostIP;
16544
16549 attribute wstring tftpPrefix;
16550
16555 attribute wstring tftpBootFile;
16556
16564 attribute wstring tftpNextServer;
16565
16569 attribute unsigned long aliasMode;
16570
16574 attribute boolean dnsPassDomain;
16575
16580 attribute boolean dnsProxy;
16581
16586 attribute boolean dnsUseHostResolver;
16587
16592 readonly attribute wstring[] redirects;
16593
16609 void setNetworkSettings (
16610 in unsigned long mtu,
16611 in unsigned long sockSnd,
16612 in unsigned long sockRcv,
16613 in unsigned long TcpWndSnd,
16614 in unsigned long TcpWndRcv
16615 );
16616
16621 void getNetworkSettings (
16622 out unsigned long mtu,
16623 out unsigned long sockSnd,
16624 out unsigned long sockRcv,
16625 out unsigned long TcpWndSnd,
16626 out unsigned long TcpWndRcv
16627 );
16628
16648 void addRedirect (
16649 in wstring name,
16650 in NATProtocol proto,
16651 in wstring hostIp,
16652 in unsigned short hostPort,
16653 in wstring guestIp,
16654 in unsigned short guestPort
16655 );
16656
16662 void removeRedirect (
16663 in wstring name
16664 );
16665
16666 };
16667
16668