- Main Page
- Related Pages
- Modules
- Classes
- Files

# VirtualBox.idl

Go to the documentation of this file.

    00001
    00002 /*
    00003  *  DO NOT EDIT! This is a generated file.
    00004  *
    00005  *  Doxygen IDL definition for VirtualBox Main API (COM interfaces)
    00006  *  generated from XIDL (XML interface definition).
    00007  *
    00008  *  Source    : src/VBox/Main/idl/VirtualBox.xidl
    00009  *  Generator : src/VBox/Main/idl/doxygen.xsl
    00010  *
    00011  *  This IDL is generated using some generic OMG IDL-like syntax SOLELY
    00012  *  for the purpose of generating the documentation using Doxygen and
    00013  *  is not syntactically valid.
    00014  *
    00015  *  DO NOT USE THIS HEADER IN ANY OTHER WAY!
    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 }; /* interface IVirtualBoxErrorInfo */
    02074
    02087 interface ILocalOwner : $unknown
    02088 {
    02097     void setLocalObject (
    02098         in $unknown object
    02099     );
    02100
    02101 }; /* interface ILocalOwner */
    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 }; /* interface IVirtualBoxCallback */
    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 }; /* interface IDHCPServer */
    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 }; /* interface IVirtualBox */
    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 }; /* interface IVFSExplorer */
    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 }; /* interface IAppliance */
    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 }; /* interface IVirtualSystemDescription */
    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 }; /* interface IInternalMachineControl */
    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 }; /* interface IBIOSSettings */
    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
    07073     void getSnapshot (
    07074         in wstringUUID id,
    07075         [retval] out ISnapshot snapshot
    07076     );
    07077
    07095     void findSnapshot (
    07096         in wstring name,
    07097         [retval] out ISnapshot snapshot
    07098     );
    07099
    07112     void setCurrentSnapshot (
    07113         in wstringUUID id
    07114     );
    07115
    07146     void createSharedFolder (
    07147         in wstring name,
    07148         in wstring hostPath,
    07149         in boolean writable
    07150     );
    07151
    07177     void removeSharedFolder (
    07178         in wstring name
    07179     );
    07180
    07204     void canShowConsoleWindow (
    07205         [retval] out boolean canShow
    07206     );
    07207
    07242     void showConsoleWindow (
    07243         [retval] out unsigned long long winId
    07244     );
    07245
    07278     void getGuestProperty (
    07279         in wstring name,
    07280         out wstring value,
    07281         out unsigned long long timestamp,
    07282         out wstring flags
    07283     );
    07284
    07307     void getGuestPropertyValue (
    07308         in wstring property,
    07309         [retval] out wstring value
    07310     );
    07311
    07334     void getGuestPropertyTimestamp (
    07335         in wstring property,
    07336         [retval] out unsigned long long value
    07337     );
    07338
    07389     void setGuestProperty (
    07390         in wstring property,
    07391         in wstring value,
    07392         in wstring flags
    07393     );
    07394
    07435     void setGuestPropertyValue (
    07436         in wstring property,
    07437         in wstring value
    07438     );
    07439
    07470     void enumerateGuestProperties (
    07471         in wstring patterns,
    07472         out wstring[] name,
    07473         out wstring[] value,
    07474         out unsigned long long[] timestamp,
    07475         out wstring[] flags
    07476     );
    07477
    07499     void querySavedThumbnailSize (
    07500         in unsigned long screenId,
    07501         out unsigned long size,
    07502         out unsigned long width,
    07503         out unsigned long height
    07504     );
    07505
    07532     void readSavedThumbnailToArray (
    07533         in unsigned long screenId,
    07534         in boolean BGR,
    07535         out unsigned long width,
    07536         out unsigned long height,
    07537         [retval] out octet[] data
    07538     );
    07539
    07561     void querySavedScreenshotPNGSize (
    07562         in unsigned long screenId,
    07563         out unsigned long size,
    07564         out unsigned long width,
    07565         out unsigned long height
    07566     );
    07567
    07589     void readSavedScreenshotPNGToArray (
    07590         in unsigned long screenId,
    07591         out unsigned long width,
    07592         out unsigned long height,
    07593         [retval] out octet[] data
    07594     );
    07595
    07605     void hotPlugCPU (
    07606         in unsigned long cpu
    07607     );
    07608
    07618     void hotUnplugCPU (
    07619         in unsigned long cpu
    07620     );
    07621
    07635     void getCPUStatus (
    07636         in unsigned long cpu,
    07637         [retval] out boolean attached
    07638     );
    07639
    07654     void queryLogFilename (
    07655         in unsigned long idx,
    07656         [retval] out wstring filename
    07657     );
    07658
    07684     void readLog (
    07685         in unsigned long idx,
    07686         in unsigned long long offset,
    07687         in unsigned long long size,
    07688         [retval] out octet[] data
    07689     );
    07690
    07691 }; /* interface IMachine */
    07692
    07711 interface IConsoleCallback : $unknown
    07712 {
    07781     void onMousePointerShapeChange (
    07782         in boolean visible,
    07783         in boolean alpha,
    07784         in unsigned long xHot,
    07785         in unsigned long yHot,
    07786         in unsigned long width,
    07787         in unsigned long height,
    07788         in octet[] shape
    07789     );
    07790
    07804     void onMouseCapabilityChange (
    07805         in boolean supportsAbsolute,
    07806         in boolean supportsRelative,
    07807         in boolean needsHostCursor
    07808     );
    07809
    07823     void onKeyboardLedsChange (
    07824         in boolean numLock,
    07825         in boolean capsLock,
    07826         in boolean scrollLock
    07827     );
    07828
    07842     void onStateChange (
    07843         in MachineState state
    07844     );
    07845
    07853     void onAdditionsStateChange();
    07854
    07872     void onNetworkAdapterChange (
    07873         in INetworkAdapter networkAdapter
    07874     );
    07875
    07893     void onSerialPortChange (
    07894         in ISerialPort serialPort
    07895     );
    07896
    07914     void onParallelPortChange (
    07915         in IParallelPort parallelPort
    07916     );
    07917
    07933     void onStorageControllerChange();
    07934
    07951     void onMediumChange (
    07952         in IMediumAttachment mediumAttachment
    07953     );
    07954
    07971     void onCPUChange (
    07972         in unsigned long cpu,
    07973         in boolean add
    07974     );
    07975
    07991     void onVRDPServerChange();
    07992
    08007     void onRemoteDisplayInfoChange();
    08008
    08024     void onUSBControllerChange();
    08025
    08065     void onUSBDeviceStateChange (
    08066         in IUSBDevice device,
    08067         in boolean attached,
    08068         in IVirtualBoxErrorInfo error
    08069     );
    08070
    08093     void onSharedFolderChange (
    08094         in Scope scope
    08095     );
    08096
    08168     void onRuntimeError (
    08169         in boolean fatal,
    08170         in wstring id,
    08171         in wstring message
    08172     );
    08173
    08208     void onCanShowWindow (
    08209         [retval] out boolean canShow
    08210     );
    08211
    08265     void onShowWindow (
    08266         [retval] out unsigned long long winId
    08267     );
    08268
    08269 }; /* interface IConsoleCallback */
    08270
    08279 interface IRemoteDisplayInfo : $unknown
    08280 {
    08286     readonly attribute boolean active;
    08287
    08296     readonly attribute long port;
    08297
    08303     readonly attribute unsigned long numberOfClients;
    08304
    08310     readonly attribute long long beginTime;
    08311
    08318     readonly attribute long long endTime;
    08319
    08325     readonly attribute unsigned long long bytesSent;
    08326
    08332     readonly attribute unsigned long long bytesSentTotal;
    08333
    08339     readonly attribute unsigned long long bytesReceived;
    08340
    08346     readonly attribute unsigned long long bytesReceivedTotal;
    08347
    08353     readonly attribute wstring user;
    08354
    08360     readonly attribute wstring domain;
    08361
    08367     readonly attribute wstring clientName;
    08368
    08374     readonly attribute wstring clientIP;
    08375
    08381     readonly attribute unsigned long clientVersion;
    08382
    08390     readonly attribute unsigned long encryptionStyle;
    08391
    08392 }; /* interface IRemoteDisplayInfo */
    08393
    08416 interface IConsole : $unknown
    08417 {
    08429     readonly attribute IMachine machine;
    08430
    08444     readonly attribute MachineState state;
    08445
    08449     readonly attribute IGuest guest;
    08450
    08461     readonly attribute IKeyboard keyboard;
    08462
    08473     readonly attribute IMouse mouse;
    08474
    08484     readonly attribute IDisplay display;
    08485
    08489     readonly attribute IMachineDebugger debugger;
    08490
    08501     readonly attribute IUSBDevice[] USBDevices;
    08502
    08510     readonly attribute IHostUSBDevice[] remoteUSBDevices;
    08511
    08527     readonly attribute ISharedFolder[] sharedFolders;
    08528
    08534     readonly attribute IRemoteDisplayInfo remoteDisplayInfo;
    08535
    08599     void powerUp (
    08600         [retval] out IProgress progress
    08601     );
    08602
    08636     void powerUpPaused (
    08637         [retval] out IProgress progress
    08638     );
    08639
    08659     void powerDown (
    08660         [retval] out IProgress progress
    08661     );
    08662
    08682     void reset();
    08683
    08703     void pause();
    08704
    08724     void resume();
    08725
    08745     void powerButton();
    08746
    08766     void sleepButton();
    08767
    08779     void getPowerButtonHandled (
    08780         [retval] out boolean handled
    08781     );
    08782
    08796     void getGuestEnteredACPIMode (
    08797         [retval] out boolean entered
    08798     );
    08799
    08852     void saveState (
    08853         [retval] out IProgress progress
    08854     );
    08855
    08888     void adoptSavedState (
    08889         in wstring savedStateFile
    08890     );
    08891
    08914     void forgetSavedState (
    08915         in boolean remove
    08916     );
    08917
    08930     void getDeviceActivity (
    08931         in DeviceType type,
    08932         [retval] out DeviceActivity activity
    08933     );
    08934
    08971     void attachUSBDevice (
    08972         in wstringUUID id
    08973     );
    08974
    09008     void detachUSBDevice (
    09009         in wstringUUID id,
    09010         [retval] out IUSBDevice device
    09011     );
    09012
    09035     void findUSBDeviceByAddress (
    09036         in wstring name,
    09037         [retval] out IUSBDevice device
    09038     );
    09039
    09059     void findUSBDeviceById (
    09060         in wstringUUID id,
    09061         [retval] out IUSBDevice device
    09062     );
    09063
    09094     void createSharedFolder (
    09095         in wstring name,
    09096         in wstring hostPath,
    09097         in boolean writable
    09098     );
    09099
    09124     void removeSharedFolder (
    09125         in wstring name
    09126     );
    09127
    09165     void takeSnapshot (
    09166         in wstring name,
    09167         in wstring description,
    09168         [retval] out IProgress progress
    09169     );
    09170
    09241     void deleteSnapshot (
    09242         in wstringUUID id,
    09243         [retval] out IProgress progress
    09244     );
    09245
    09286     void restoreSnapshot (
    09287         in ISnapshot snapshot,
    09288         [retval] out IProgress progress
    09289     );
    09290
    09329     void teleport (
    09330         in wstring hostname,
    09331         in unsigned long tcpport,
    09332         in wstring password,
    09333         in unsigned long maxDowntime,
    09334         [retval] out IProgress progress
    09335     );
    09336
    09344     void registerCallback (
    09345         in IConsoleCallback callback
    09346     );
    09347
    09361     void unregisterCallback (
    09362         in IConsoleCallback callback
    09363     );
    09364
    09365 }; /* interface IConsole */
    09366
    09377 interface IHostNetworkInterface : $unknown
    09378 {
    09382     readonly attribute wstring name;
    09383
    09387     readonly attribute wstringUUID id;
    09388
    09392     readonly attribute wstring networkName;
    09393
    09397     readonly attribute boolean dhcpEnabled;
    09398
    09402     readonly attribute wstring IPAddress;
    09403
    09407     readonly attribute wstring networkMask;
    09408
    09412     readonly attribute boolean IPV6Supported;
    09413
    09417     readonly attribute wstring IPV6Address;
    09418
    09422     readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
    09423
    09427     readonly attribute wstring hardwareAddress;
    09428
    09432     readonly attribute HostNetworkInterfaceMediumType mediumType;
    09433
    09437     readonly attribute HostNetworkInterfaceStatus status;
    09438
    09442     readonly attribute HostNetworkInterfaceType interfaceType;
    09443
    09455     void enableStaticIpConfig (
    09456         in wstring IPAddress,
    09457         in wstring networkMask
    09458     );
    09459
    09471     void enableStaticIpConfigV6 (
    09472         in wstring IPV6Address,
    09473         in unsigned long IPV6NetworkMaskPrefixLength
    09474     );
    09475
    09479     void enableDynamicIpConfig();
    09480
    09484     void dhcpRediscover();
    09485
    09486 }; /* interface IHostNetworkInterface */
    09487
    09504 interface IHost : $unknown
    09505 {
    09509     readonly attribute IMedium[] DVDDrives;
    09510
    09514     readonly attribute IMedium[] floppyDrives;
    09515
    09529     readonly attribute IHostUSBDevice[] USBDevices;
    09530
    09553     readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
    09554
    09558     readonly attribute IHostNetworkInterface[] networkInterfaces;
    09559
    09563     readonly attribute unsigned long processorCount;
    09564
    09568     readonly attribute unsigned long processorOnlineCount;
    09569
    09573     readonly attribute unsigned long processorCoreCount;
    09574
    09578     readonly attribute unsigned long memorySize;
    09579
    09583     readonly attribute unsigned long memoryAvailable;
    09584
    09588     readonly attribute wstring operatingSystem;
    09589
    09593     readonly attribute wstring OSVersion;
    09594
    09598     readonly attribute long long UTCTime;
    09599
    09603     readonly attribute boolean Acceleration3DAvailable;
    09604
    09619     void getProcessorSpeed (
    09620         in unsigned long cpuId,
    09621         [retval] out unsigned long speed
    09622     );
    09623
    09635     void getProcessorFeature (
    09636         in ProcessorFeature feature,
    09637         [retval] out boolean supported
    09638     );
    09639
    09658     void getProcessorDescription (
    09659         in unsigned long cpuId,
    09660         [retval] out wstring description
    09661     );
    09662
    09703     void getProcessorCPUIDLeaf (
    09704         in unsigned long cpuId,
    09705         in unsigned long leaf,
    09706         in unsigned long subLeaf,
    09707         out unsigned long valEax,
    09708         out unsigned long valEbx,
    09709         out unsigned long valEcx,
    09710         out unsigned long valEdx
    09711     );
    09712
    09733     void createHostOnlyNetworkInterface (
    09734         out IHostNetworkInterface hostInterface,
    09735         [retval] out IProgress progress
    09736     );
    09737
    09758     void removeHostOnlyNetworkInterface (
    09759         in wstringUUID id,
    09760         [retval] out IProgress progress
    09761     );
    09762
    09783     void createUSBDeviceFilter (
    09784         in wstring name,
    09785         [retval] out IHostUSBDeviceFilter filter
    09786     );
    09787
    09830     void insertUSBDeviceFilter (
    09831         in unsigned long position,
    09832         in IHostUSBDeviceFilter filter
    09833     );
    09834
    09862     void removeUSBDeviceFilter (
    09863         in unsigned long position
    09864     );
    09865
    09883     void findHostDVDDrive (
    09884         in wstring name,
    09885         [retval] out IMedium drive
    09886     );
    09887
    09905     void findHostFloppyDrive (
    09906         in wstring name,
    09907         [retval] out IMedium drive
    09908     );
    09909
    09925     void findHostNetworkInterfaceByName (
    09926         in wstring name,
    09927         [retval] out IHostNetworkInterface networkInterface
    09928     );
    09929
    09945     void findHostNetworkInterfaceById (
    09946         in wstringUUID id,
    09947         [retval] out IHostNetworkInterface networkInterface
    09948     );
    09949
    09959     void findHostNetworkInterfacesOfType (
    09960         in HostNetworkInterfaceType type,
    09961         [retval] out IHostNetworkInterface[] networkInterfaces
    09962     );
    09963
    09983     void findUSBDeviceById (
    09984         in wstringUUID id,
    09985         [retval] out IHostUSBDevice device
    09986     );
    09987
    10010     void findUSBDeviceByAddress (
    10011         in wstring name,
    10012         [retval] out IHostUSBDevice device
    10013     );
    10014
    10015 }; /* interface IHost */
    10016
    10029 interface ISystemProperties : $unknown
    10030 {
    10034     readonly attribute unsigned long minGuestRAM;
    10035
    10039     readonly attribute unsigned long maxGuestRAM;
    10040
    10044     readonly attribute unsigned long minGuestVRAM;
    10045
    10049     readonly attribute unsigned long maxGuestVRAM;
    10050
    10054     readonly attribute unsigned long minGuestCPUCount;
    10055
    10059     readonly attribute unsigned long maxGuestCPUCount;
    10060
    10064     readonly attribute unsigned long maxGuestMonitors;
    10065
    10069     readonly attribute unsigned long long maxVDISize;
    10070
    10077     readonly attribute unsigned long networkAdapterCount;
    10078
    10085     readonly attribute unsigned long serialPortCount;
    10086
    10093     readonly attribute unsigned long parallelPortCount;
    10094
    10104     readonly attribute unsigned long maxBootPosition;
    10105
    10138     attribute wstring defaultMachineFolder;
    10139
    10178     attribute wstring defaultHardDiskFolder;
    10179
    10205     readonly attribute IMediumFormat[] mediumFormats;
    10206
    10240     attribute wstring defaultHardDiskFormat;
    10241
    10247     attribute unsigned long long freeDiskSpaceWarning;
    10248
    10253     attribute unsigned long freeDiskSpacePercentWarning;
    10254
    10260     attribute unsigned long long freeDiskSpaceError;
    10261
    10266     attribute unsigned long freeDiskSpacePercentError;
    10267
    10291     attribute wstring remoteDisplayAuthLibrary;
    10292
    10321     attribute wstring webServiceAuthLibrary;
    10322
    10328     attribute unsigned long LogHistoryCount;
    10329
    10334     readonly attribute AudioDriverType defaultAudioDriver;
    10335
    10345     void getMaxDevicesPerPortForStorageBus (
    10346         in StorageBus bus,
    10347         [retval] out unsigned long maxDevicesPerPort
    10348     );
    10349
    10357     void getMinPortCountForStorageBus (
    10358         in StorageBus bus,
    10359         [retval] out unsigned long minPortCount
    10360     );
    10361
    10369     void getMaxPortCountForStorageBus (
    10370         in StorageBus bus,
    10371         [retval] out unsigned long maxPortCount
    10372     );
    10373
    10383     void getMaxInstancesOfStorageBus (
    10384         in StorageBus bus,
    10385         [retval] out unsigned long maxInstances
    10386     );
    10387
    10397     void getDeviceTypesForStorageBus (
    10398         in StorageBus bus,
    10399         [retval] out DeviceType[] deviceTypes
    10400     );
    10401
    10402 }; /* interface ISystemProperties */
    10403
    10409 interface IGuestOSType : $unknown
    10410 {
    10414     readonly attribute wstring familyId;
    10415
    10419     readonly attribute wstring familyDescription;
    10420
    10424     readonly attribute wstring id;
    10425
    10429     readonly attribute wstring description;
    10430
    10434     readonly attribute boolean is64Bit;
    10435
    10439     readonly attribute boolean recommendedIOAPIC;
    10440
    10444     readonly attribute boolean recommendedVirtEx;
    10445
    10449     readonly attribute unsigned long recommendedRAM;
    10450
    10454     readonly attribute unsigned long recommendedVRAM;
    10455
    10459     readonly attribute unsigned long recommendedHDD;
    10460
    10464     readonly attribute NetworkAdapterType adapterType;
    10465
    10469     readonly attribute boolean recommendedPae;
    10470
    10474     readonly attribute StorageControllerType recommendedDvdStorageController;
    10475
    10479     readonly attribute StorageBus recommendedDvdStorageBus;
    10480
    10484     readonly attribute StorageControllerType recommendedHdStorageController;
    10485
    10489     readonly attribute StorageBus recommendedHdStorageBus;
    10490
    10494     readonly attribute FirmwareType recommendedFirmware;
    10495
    10499     readonly attribute boolean recommendedUsbHid;
    10500
    10504     readonly attribute boolean recommendedHpet;
    10505
    10509     readonly attribute boolean recommendedUsbTablet;
    10510
    10514     readonly attribute boolean recommendedRtcUseUtc;
    10515
    10516 }; /* interface IGuestOSType */
    10517
    10531 interface IGuest : $unknown
    10532 {
    10547     readonly attribute wstring OSTypeId;
    10548
    10556     readonly attribute boolean additionsActive;
    10557
    10567     readonly attribute wstring additionsVersion;
    10568
    10575     readonly attribute boolean supportsSeamless;
    10576
    10585     readonly attribute boolean supportsGraphics;
    10586
    10590     attribute unsigned long memoryBalloonSize;
    10591
    10595     attribute boolean pageFusionEnabled;
    10596
    10600     attribute unsigned long statisticsUpdateInterval;
    10601
    10633     void internalGetStatistics (
    10634         out unsigned long cpuUser,
    10635         out unsigned long cpuKernel,
    10636         out unsigned long cpuIdle,
    10637         out unsigned long memTotal,
    10638         out unsigned long memFree,
    10639         out unsigned long memBalloon,
    10640         out unsigned long memShared,
    10641         out unsigned long memCache,
    10642         out unsigned long pagedTotal,
    10643         out unsigned long memAllocTotal,
    10644         out unsigned long memFreeTotal,
    10645         out unsigned long memBalloonTotal,
    10646         out unsigned long memSharedTotal
    10647     );
    10648
    10678     void setCredentials (
    10679         in wstring userName,
    10680         in wstring password,
    10681         in wstring domain,
    10682         in boolean allowInteractiveLogon
    10683     );
    10684
    10738     void executeProcess (
    10739         in wstring execName,
    10740         in unsigned long flags,
    10741         in wstring[] arguments,
    10742         in wstring[] environment,
    10743         in wstring userName,
    10744         in wstring password,
    10745         in unsigned long timeoutMS,
    10746         out unsigned long pid,
    10747         [retval] out IProgress progress
    10748     );
    10749
    10787     void getProcessOutput (
    10788         in unsigned long pid,
    10789         in unsigned long flags,
    10790         in unsigned long timeoutMS,
    10791         in unsigned long long size,
    10792         [retval] out octet[] data
    10793     );
    10794
    10824     void getProcessStatus (
    10825         in unsigned long pid,
    10826         out unsigned long exitcode,
    10827         out unsigned long flags,
    10828         [retval] out unsigned long reason
    10829     );
    10830
    10831 }; /* interface IGuest */
    10832
    10873 interface IProgress : $unknown
    10874 {
    10878     readonly attribute wstringUUID id;
    10879
    10883     readonly attribute wstring description;
    10884
    10888     readonly attribute $unknown initiator;
    10889
    10893     readonly attribute boolean cancelable;
    10894
    10902     readonly attribute unsigned long percent;
    10903
    10917     readonly attribute long timeRemaining;
    10918
    10922     readonly attribute boolean completed;
    10923
    10927     readonly attribute boolean canceled;
    10928
    10935     readonly attribute long resultCode;
    10936
    10946     readonly attribute IVirtualBoxErrorInfo errorInfo;
    10947
    10954     readonly attribute unsigned long operationCount;
    10955
    10959     readonly attribute unsigned long operation;
    10960
    10966     readonly attribute wstring operationDescription;
    10967
    10971     readonly attribute unsigned long operationPercent;
    10972
    10980     attribute unsigned long timeout;
    10981
    10985     void setCurrentOperationProgress (
    10986         in unsigned long percent
    10987     );
    10988
    10992     void setNextOperation (
    10993         in wstring nextOperationDescription,
    10994         in unsigned long nextOperationsWeight
    10995     );
    10996
    11015     void waitForCompletion (
    11016         in long timeout
    11017     );
    11018
    11042     void waitForOperationCompletion (
    11043         in unsigned long operation,
    11044         in long timeout
    11045     );
    11046
    11063     void cancel();
    11064
    11065 }; /* interface IProgress */
    11066
    11158 interface ISnapshot : $unknown
    11159 {
    11163     readonly attribute wstringUUID id;
    11164
    11168     attribute wstring name;
    11169
    11173     attribute wstring description;
    11174
    11180     readonly attribute long long timeStamp;
    11181
    11193     readonly attribute boolean online;
    11194
    11206     readonly attribute IMachine machine;
    11207
    11214     readonly attribute ISnapshot parent;
    11215
    11221     readonly attribute ISnapshot[] children;
    11222
    11223 }; /* interface ISnapshot */
    11224
    11240 interface IMediumAttachment : $unknown
    11241 {
    11246     readonly attribute IMedium medium;
    11247
    11253     readonly attribute wstring controller;
    11254
    11260     readonly attribute long port;
    11261
    11267     readonly attribute long device;
    11268
    11272     readonly attribute DeviceType type;
    11273
    11277     readonly attribute boolean passthrough;
    11278
    11279 }; /* interface IMediumAttachment */
    11280
    11634 interface IMedium : $unknown
    11635 {
    11649     readonly attribute wstringUUID id;
    11650
    11669     attribute wstring description;
    11670
    11686     readonly attribute MediumState state;
    11687
    11709     attribute wstring location;
    11710
    11730     readonly attribute wstring name;
    11731
    11736     readonly attribute DeviceType deviceType;
    11737
    11741     readonly attribute boolean hostDrive;
    11742
    11755     readonly attribute unsigned long long size;
    11756
    11771     readonly attribute wstring format;
    11772
    11788     readonly attribute IMediumFormat mediumFormat;
    11789
    11814     attribute MediumType type;
    11815
    11825     readonly attribute IMedium parent;
    11826
    11834     readonly attribute IMedium[] children;
    11835
    11846     readonly attribute IMedium base;
    11847
    11880     readonly attribute boolean readOnly;
    11881
    11902     readonly attribute unsigned long long logicalSize;
    11903
    11931     attribute boolean autoReset;
    11932
    11947     readonly attribute wstring lastAccessError;
    11948
    11965     readonly attribute wstringUUID[] machineIds;
    11966
    12001     void refreshState (
    12002         [retval] out MediumState state
    12003     );
    12004
    12031     void getSnapshotIds (
    12032         in wstringUUID machineId,
    12033         [retval] out wstringUUID[] snapshotIds
    12034     );
    12035
    12095     void lockRead (
    12096         [retval] out MediumState state
    12097     );
    12098
    12121     void unlockRead (
    12122         [retval] out MediumState state
    12123     );
    12124
    12179     void lockWrite (
    12180         [retval] out MediumState state
    12181     );
    12182
    12205     void unlockWrite (
    12206         [retval] out MediumState state
    12207     );
    12208
    12257     void close();
    12258
    12288     void getProperty (
    12289         in wstring name,
    12290         [retval] out wstring value
    12291     );
    12292
    12324     void setProperty (
    12325         in wstring name,
    12326         in wstring value
    12327     );
    12328
    12362     void getProperties (
    12363         in wstring names,
    12364         out wstring[] returnNames,
    12365         [retval] out wstring[] returnValues
    12366     );
    12367
    12399     void setProperties (
    12400         in wstring[] names,
    12401         in wstring[] values
    12402     );
    12403
    12435     void createBaseStorage (
    12436         in unsigned long long logicalSize,
    12437         in MediumVariant variant,
    12438         [retval] out IProgress progress
    12439     );
    12440
    12492     void deleteStorage (
    12493         [retval] out IProgress progress
    12494     );
    12495
    12533     void createDiffStorage (
    12534         in IMedium target,
    12535         in MediumVariant variant,
    12536         [retval] out IProgress progress
    12537     );
    12538
    12614     void mergeTo (
    12615         in IMedium target,
    12616         [retval] out IProgress progress
    12617     );
    12618
    12667     void cloneTo (
    12668         in IMedium target,
    12669         in MediumVariant variant,
    12670         in IMedium parent,
    12671         [retval] out IProgress progress
    12672     );
    12673
    12702     void compact (
    12703         [retval] out IProgress progress
    12704     );
    12705
    12738     void resize (
    12739         in unsigned long long logicalSize,
    12740         [retval] out IProgress progress
    12741     );
    12742
    12776     void reset (
    12777         [retval] out IProgress progress
    12778     );
    12779
    12780 }; /* interface IMedium */
    12781
    12804 interface IMediumFormat : $unknown
    12805 {
    12824     readonly attribute wstring id;
    12825
    12833     readonly attribute wstring name;
    12834
    12850     readonly attribute wstring[] fileExtensions;
    12851
    12860     readonly attribute unsigned long capabilities;
    12861
    12891     void describeProperties (
    12892         out wstring[] names,
    12893         out wstring[] description,
    12894         out DataType[] types,
    12895         out unsigned long[] flags,
    12896         out wstring[] defaults
    12897     );
    12898
    12899 }; /* interface IMediumFormat */
    12900
    12913 interface IKeyboard : $unknown
    12914 {
    12927     void putScancode (
    12928         in long scancode
    12929     );
    12930
    12943     void putScancodes (
    12944         in long[] scancodes,
    12945         [retval] out unsigned long codesStored
    12946     );
    12947
    12962     void putCAD();
    12963
    12964 }; /* interface IKeyboard */
    12965
    12977 interface IMouse : $unknown
    12978 {
    12993     readonly attribute boolean absoluteSupported;
    12994
    13009     readonly attribute boolean relativeSupported;
    13010
    13025     readonly attribute boolean needsHostCursor;
    13026
    13092     void putMouseEvent (
    13093         in long dx,
    13094         in long dy,
    13095         in long dz,
    13096         in long dw,
    13097         in long buttonState
    13098     );
    13099
    13172     void putMouseEventAbsolute (
    13173         in long x,
    13174         in long y,
    13175         in long dz,
    13176         in long dw,
    13177         in long buttonState
    13178     );
    13179
    13180 }; /* interface IMouse */
    13181
    13182 interface IFramebuffer : $unknown
    13183 {
    13192     readonly attribute octetPtr address;
    13193
    13197     readonly attribute unsigned long width;
    13198
    13202     readonly attribute unsigned long height;
    13203
    13210     readonly attribute unsigned long bitsPerPixel;
    13211
    13218     readonly attribute unsigned long bytesPerLine;
    13219
    13230     readonly attribute unsigned long pixelFormat;
    13231
    13238     readonly attribute boolean usesGuestVRAM;
    13239
    13249     readonly attribute unsigned long heightReduction;
    13250
    13265     readonly attribute IFramebufferOverlay overlay;
    13266
    13273     readonly attribute unsigned long long winId;
    13274
    13282     void lock();
    13283
    13291     void unlock();
    13292
    13300     void notifyUpdate (
    13301         in unsigned long x,
    13302         in unsigned long y,
    13303         in unsigned long width,
    13304         in unsigned long height
    13305     );
    13306
    13419     void requestResize (
    13420         in unsigned long screenId,
    13421         in unsigned long pixelFormat,
    13422         in octetPtr VRAM,
    13423         in unsigned long bitsPerPixel,
    13424         in unsigned long bytesPerLine,
    13425         in unsigned long width,
    13426         in unsigned long height,
    13427         [retval] out boolean finished
    13428     );
    13429
    13441     void videoModeSupported (
    13442         in unsigned long width,
    13443         in unsigned long height,
    13444         in unsigned long bpp,
    13445         [retval] out boolean supported
    13446     );
    13447
    13484     void getVisibleRegion (
    13485         in octetPtr rectangles,
    13486         in unsigned long count,
    13487         [retval] out unsigned long countCopied
    13488     );
    13489
    13524     void setVisibleRegion (
    13525         in octetPtr rectangles,
    13526         in unsigned long count
    13527     );
    13528
    13549     void processVHWACommand (
    13550         in octetPtr command
    13551     );
    13552
    13553 }; /* interface IFramebuffer */
    13554
    13569 interface IFramebufferOverlay : IFramebuffer
    13570 {
    13574     readonly attribute unsigned long x;
    13575
    13579     readonly attribute unsigned long y;
    13580
    13586     attribute boolean visible;
    13587
    13594     attribute unsigned long alpha;
    13595
    13601     void move (
    13602         in unsigned long x,
    13603         in unsigned long y
    13604     );
    13605
    13606 }; /* interface IFramebufferOverlay */
    13607
    13623 interface IDisplay : $unknown
    13624 {
    13628     void getScreenResolution (
    13629         in unsigned long screenId,
    13630         out unsigned long width,
    13631         out unsigned long height,
    13632         out unsigned long bitsPerPixel
    13633     );
    13634
    13640     void setFramebuffer (
    13641         in unsigned long screenId,
    13642         in IFramebuffer framebuffer
    13643     );
    13644
    13650     void getFramebuffer (
    13651         in unsigned long screenId,
    13652         out IFramebuffer framebuffer,
    13653         out long xOrigin,
    13654         out long yOrigin
    13655     );
    13656
    13685     void setVideoModeHint (
    13686         in unsigned long width,
    13687         in unsigned long height,
    13688         in unsigned long bitsPerPixel,
    13689         in unsigned long display
    13690     );
    13691
    13702     void setSeamlessMode (
    13703         in boolean enabled
    13704     );
    13705
    13739     void takeScreenShot (
    13740         in unsigned long screenId,
    13741         in octetPtr address,
    13742         in unsigned long width,
    13743         in unsigned long height
    13744     );
    13745
    13789     void takeScreenShotToArray (
    13790         in unsigned long screenId,
    13791         in unsigned long width,
    13792         in unsigned long height,
    13793         [retval] out octet[] screenData
    13794     );
    13795
    13841     void drawToScreen (
    13842         in unsigned long screenId,
    13843         in octetPtr address,
    13844         in unsigned long x,
    13845         in unsigned long y,
    13846         in unsigned long width,
    13847         in unsigned long height
    13848     );
    13849
    13864     void invalidateAndUpdate();
    13865
    13879     void resizeCompleted (
    13880         in unsigned long screenId
    13881     );
    13882
    13895     void completeVHWACommand (
    13896         in octetPtr command
    13897     );
    13898
    13899 }; /* interface IDisplay */
    13900
    13916 interface INetworkAdapter : $unknown
    13917 {
    13925     attribute NetworkAdapterType adapterType;
    13926
    13934     readonly attribute unsigned long slot;
    13935
    13944     attribute boolean enabled;
    13945
    13952     attribute wstring MACAddress;
    13953
    13954     readonly attribute NetworkAttachmentType attachmentType;
    13955
    13961     attribute wstring hostInterface;
    13962
    13968     attribute wstring internalNetwork;
    13969
    13975     attribute wstring NATNetwork;
    13976
    13982     attribute wstring VDENetwork;
    13983
    13990     attribute boolean cableConnected;
    13991
    13997     attribute unsigned long lineSpeed;
    13998
    14005     attribute boolean traceEnabled;
    14006
    14013     attribute wstring traceFile;
    14014
    14022     readonly attribute INATEngine natDriver;
    14023
    14030     attribute unsigned long bootPriority;
    14031
    14037     void attachToNAT();
    14038
    14044     void attachToBridgedInterface();
    14045
    14051     void attachToInternalNetwork();
    14052
    14058     void attachToHostOnlyInterface();
    14059
    14065     void attachToVDE();
    14066
    14072     void detach();
    14073
    14074 }; /* interface INetworkAdapter */
    14075
    14104 interface ISerialPort : $unknown
    14105 {
    14113     readonly attribute unsigned long slot;
    14114
    14121     attribute boolean enabled;
    14122
    14126     attribute unsigned long IOBase;
    14127
    14131     attribute unsigned long IRQ;
    14132
    14143     attribute PortMode hostMode;
    14144
    14152     attribute boolean server;
    14153
    14163     attribute wstring path;
    14164
    14165 }; /* interface ISerialPort */
    14166
    14186 interface IParallelPort : $unknown
    14187 {
    14195     readonly attribute unsigned long slot;
    14196
    14203     attribute boolean enabled;
    14204
    14208     attribute unsigned long IOBase;
    14209
    14213     attribute unsigned long IRQ;
    14214
    14222     attribute wstring path;
    14223
    14224 }; /* interface IParallelPort */
    14225
    14226 interface IMachineDebugger : $unknown
    14227 {
    14231     attribute boolean singlestep;
    14232
    14236     attribute boolean recompileUser;
    14237
    14241     attribute boolean recompileSupervisor;
    14242
    14246     attribute boolean PATMEnabled;
    14247
    14251     attribute boolean CSAMEnabled;
    14252
    14256     attribute boolean logEnabled;
    14257
    14264     readonly attribute boolean HWVirtExEnabled;
    14265
    14272     readonly attribute boolean HWVirtExNestedPagingEnabled;
    14273
    14280     readonly attribute boolean HWVirtExVPIDEnabled;
    14281
    14288     readonly attribute boolean PAEEnabled;
    14289
    14296     attribute unsigned long virtualTimeRate;
    14297
    14304     readonly attribute unsigned long long VM;
    14305
    14313     void resetStats (
    14314         in wstring pattern
    14315     );
    14316
    14324     void dumpStats (
    14325         in wstring pattern
    14326     );
    14327
    14339     void getStats (
    14340         in wstring pattern,
    14341         in boolean withDescriptions,
    14342         out wstring stats
    14343     );
    14344
    14350     void injectNMI();
    14351
    14352 }; /* interface IMachineDebugger */
    14353
    14354 interface IUSBController : $unknown
    14355 {
    14364     attribute boolean enabled;
    14365
    14374     attribute boolean enabledEhci;
    14375
    14381     readonly attribute boolean proxyAvailable;
    14382
    14390     readonly attribute unsigned short USBStandard;
    14391
    14417     readonly attribute IUSBDeviceFilter[] deviceFilters;
    14418
    14446     void createDeviceFilter (
    14447         in wstring name,
    14448         [retval] out IUSBDeviceFilter filter
    14449     );
    14450
    14495     void insertDeviceFilter (
    14496         in unsigned long position,
    14497         in IUSBDeviceFilter filter
    14498     );
    14499
    14532     void removeDeviceFilter (
    14533         in unsigned long position,
    14534         [retval] out IUSBDeviceFilter filter
    14535     );
    14536
    14537 }; /* interface IUSBController */
    14538
    14551 interface IUSBDevice : $unknown
    14552 {
    14559     readonly attribute wstringUUID id;
    14560
    14564     readonly attribute unsigned short vendorId;
    14565
    14569     readonly attribute unsigned short productId;
    14570
    14578     readonly attribute unsigned short revision;
    14579
    14583     readonly attribute wstring manufacturer;
    14584
    14588     readonly attribute wstring product;
    14589
    14593     readonly attribute wstring serialNumber;
    14594
    14598     readonly attribute wstring address;
    14599
    14606     readonly attribute unsigned short port;
    14607
    14613     readonly attribute unsigned short version;
    14614
    14622     readonly attribute unsigned short portVersion;
    14623
    14630     readonly attribute boolean remote;
    14631
    14632 }; /* interface IUSBDevice */
    14633
    14707 interface IUSBDeviceFilter : $unknown
    14708 {
    14716     attribute wstring name;
    14717
    14721     attribute boolean active;
    14722
    14730     attribute wstring vendorId;
    14731
    14739     attribute wstring productId;
    14740
    14754     attribute wstring revision;
    14755
    14760     attribute wstring manufacturer;
    14761
    14766     attribute wstring product;
    14767
    14772     attribute wstring serialNumber;
    14773
    14778     attribute wstring port;
    14779
    14789     attribute wstring remote;
    14790
    14800     attribute unsigned long maskedInterfaces;
    14801
    14802 }; /* interface IUSBDeviceFilter */
    14803
    14819 interface IHostUSBDevice : IUSBDevice
    14820 {
    14826     readonly attribute USBDeviceState state;
    14827
    14828 }; /* interface IHostUSBDevice */
    14829
    14852 interface IHostUSBDeviceFilter : IUSBDeviceFilter
    14853 {
    14860     attribute USBDeviceFilterAction action;
    14861
    14862 }; /* interface IHostUSBDeviceFilter */
    14863
    14872 interface IAudioAdapter : $unknown
    14873 {
    14882     attribute boolean enabled;
    14883
    14889     attribute AudioControllerType audioController;
    14890
    14897     attribute AudioDriverType audioDriver;
    14898
    14899 }; /* interface IAudioAdapter */
    14900
    14901 interface IVRDPServer : $unknown
    14902 {
    14906     attribute boolean enabled;
    14907
    14917     attribute wstring ports;
    14918
    14922     attribute wstring netAddress;
    14923
    14927     attribute VRDPAuthType authType;
    14928
    14932     attribute unsigned long authTimeout;
    14933
    14940     attribute boolean allowMultiConnection;
    14941
    14949     attribute boolean reuseSingleConnection;
    14950
    14956     attribute boolean videoChannel;
    14957
    14963     attribute unsigned long videoChannelQuality;
    14964
    14965 }; /* interface IVRDPServer */
    14966
    15024 interface ISharedFolder : $unknown
    15025 {
    15029     readonly attribute wstring name;
    15030
    15034     readonly attribute wstring hostPath;
    15035
    15045     readonly attribute boolean accessible;
    15046
    15053     readonly attribute boolean writable;
    15054
    15067     readonly attribute wstring lastAccessError;
    15068
    15069 }; /* interface ISharedFolder */
    15070
    15071 interface IInternalSessionControl : $unknown
    15072 {
    15077     void getPID (
    15078         [retval] out unsigned long pid
    15079     );
    15080
    15102     void getRemoteConsole (
    15103         [retval] out IConsole console
    15104     );
    15105
    15129     void assignMachine (
    15130         in IMachine machine
    15131     );
    15132
    15147     void assignRemoteMachine (
    15148         in IMachine machine,
    15149         in IConsole console
    15150     );
    15151
    15175     void updateMachineState (
    15176         in MachineState aMachineState
    15177     );
    15178
    15194     void uninitialize();
    15195
    15218     void onNetworkAdapterChange (
    15219         in INetworkAdapter networkAdapter,
    15220         in boolean changeAdapter
    15221     );
    15222
    15245     void onSerialPortChange (
    15246         in ISerialPort serialPort
    15247     );
    15248
    15271     void onParallelPortChange (
    15272         in IParallelPort parallelPort
    15273     );
    15274
    15297     void onStorageControllerChange();
    15298
    15321     void onMediumChange (
    15322         in IMediumAttachment mediumAttachment,
    15323         in boolean force
    15324     );
    15325
    15335     void onCPUChange (
    15336         in unsigned long cpu,
    15337         in boolean add
    15338     );
    15339
    15364     void onVRDPServerChange (
    15365         in boolean restart
    15366     );
    15367
    15390     void onUSBControllerChange();
    15391
    15420     void onSharedFolderChange (
    15421         in boolean global
    15422     );
    15423
    15449     void onUSBDeviceAttach (
    15450         in IUSBDevice device,
    15451         in IVirtualBoxErrorInfo error,
    15452         in unsigned long maskedInterfaces
    15453     );
    15454
    15480     void onUSBDeviceDetach (
    15481         in wstringUUID id,
    15482         in IVirtualBoxErrorInfo error
    15483     );
    15484
    15502     void onShowWindow (
    15503         in boolean check,
    15504         out boolean canShow,
    15505         out unsigned long long winId
    15506     );
    15507
    15531     void accessGuestProperty (
    15532         in wstring name,
    15533         in wstring value,
    15534         in wstring flags,
    15535         in boolean isSetter,
    15536         out wstring retValue,
    15537         out unsigned long long retTimestamp,
    15538         out wstring retFlags
    15539     );
    15540
    15588     void enumerateGuestProperties (
    15589         in wstring patterns,
    15590         out wstring[] key,
    15591         out wstring[] value,
    15592         out unsigned long long[] timestamp,
    15593         out wstring[] flags
    15594     );
    15595
    15641     void onlineMergeMedium (
    15642         in IMediumAttachment mediumAttachment,
    15643         in unsigned long sourceIdx,
    15644         in unsigned long targetIdx,
    15645         in IMedium source,
    15646         in IMedium target,
    15647         in boolean mergeForward,
    15648         in IMedium parentForTarget,
    15649         in IMedium[] childrenToReparent,
    15650         in IProgress progress
    15651     );
    15652
    15653 }; /* interface IInternalSessionControl */
    15654
    15731 interface ISession : $unknown
    15732 {
    15736     readonly attribute SessionState state;
    15737
    15745     readonly attribute SessionType type;
    15746
    15750     readonly attribute IMachine machine;
    15751
    15755     readonly attribute IConsole console;
    15756
    15797     void close();
    15798
    15799 }; /* interface ISession */
    15800
    15823 interface IStorageController : $unknown
    15824 {
    15833     readonly attribute wstring name;
    15834
    15840     readonly attribute unsigned long maxDevicesPerPortCount;
    15841
    15847     readonly attribute unsigned long minPortCount;
    15848
    15854     readonly attribute unsigned long maxPortCount;
    15855
    15861     attribute unsigned long instance;
    15862
    15871     attribute unsigned long portCount;
    15872
    15878     readonly attribute StorageBus bus;
    15879
    15892     attribute StorageControllerType controllerType;
    15893
    15908     attribute boolean useHostIOCache;
    15909
    15932     void getIDEEmulationPort (
    15933         in long devicePosition,
    15934         [retval] out long portNumber
    15935     );
    15936
    15960     void setIDEEmulationPort (
    15961         in long devicePosition,
    15962         in long portNumber
    15963     );
    15964
    15965 }; /* interface IStorageController */
    15966
    15990 interface IManagedObjectRef : $unknown
    15991 {
    15998     void getInterfaceName (
    15999         [retval] out wstring return
    16000     );
    16001
    16009     void release();
    16010
    16011 }; /* interface IManagedObjectRef */
    16012
    16021 interface IWebsessionManager : $unknown
    16022 {
    16031     void logon (
    16032         in wstring username,
    16033         in wstring password,
    16034         [retval] out IVirtualBox return
    16035     );
    16036
    16046     void getSessionObject (
    16047         in IVirtualBox refIVirtualBox,
    16048         [retval] out ISession return
    16049     );
    16050
    16058     void logoff (
    16059         in IVirtualBox refIVirtualBox
    16060     );
    16061
    16062 }; /* interface IWebsessionManager */
    16063
    16072 interface IPerformanceMetric : $unknown
    16073 {
    16079     readonly attribute wstring metricName;
    16080
    16086     readonly attribute $unknown object;
    16087
    16093     readonly attribute wstring description;
    16094
    16100     readonly attribute unsigned long period;
    16101
    16111     readonly attribute unsigned long count;
    16112
    16118     readonly attribute wstring unit;
    16119
    16125     readonly attribute long minimumValue;
    16126
    16132     readonly attribute long maximumValue;
    16133
    16134 }; /* interface IPerformanceMetric */
    16135
    16241 interface IPerformanceCollector : $unknown
    16242 {
    16253     readonly attribute wstring[] metricNames;
    16254
    16278     void getMetrics (
    16279         in wstring[] metricNames,
    16280         in $unknown[] objects,
    16281         [retval] out IPerformanceMetric[] metrics
    16282     );
    16283
    16322     void setupMetrics (
    16323         in wstring[] metricNames,
    16324         in $unknown[] objects,
    16325         in unsigned long period,
    16326         in unsigned long count,
    16327         [retval] out IPerformanceMetric[] affectedMetrics
    16328     );
    16329
    16358     void enableMetrics (
    16359         in wstring[] metricNames,
    16360         in $unknown[] objects,
    16361         [retval] out IPerformanceMetric[] affectedMetrics
    16362     );
    16363
    16392     void disableMetrics (
    16393         in wstring[] metricNames,
    16394         in $unknown[] objects,
    16395         [retval] out IPerformanceMetric[] affectedMetrics
    16396     );
    16397
    16486     void queryMetricsData (
    16487         in wstring[] metricNames,
    16488         in $unknown[] objects,
    16489         out wstring[] returnMetricNames,
    16490         out $unknown[] returnObjects,
    16491         out wstring[] returnUnits,
    16492         out unsigned long[] returnScales,
    16493         out unsigned long[] returnSequenceNumbers,
    16494         out unsigned long[] returnDataIndices,
    16495         out unsigned long[] returnDataLengths,
    16496         [retval] out long[] returnData
    16497     );
    16498
    16499 }; /* interface IPerformanceCollector */
    16500
    16508 interface INATEngine : $unknown
    16509 {
    16514     attribute wstring network;
    16515
    16522     attribute wstring hostIP;
    16523
    16528     attribute wstring tftpPrefix;
    16529
    16534     attribute wstring tftpBootFile;
    16535
    16543     attribute wstring tftpNextServer;
    16544
    16548     attribute unsigned long aliasMode;
    16549
    16553     attribute boolean dnsPassDomain;
    16554
    16559     attribute boolean dnsProxy;
    16560
    16565     attribute boolean dnsUseHostResolver;
    16566
    16571     readonly attribute wstring[] redirects;
    16572
    16588     void setNetworkSettings (
    16589         in unsigned long mtu,
    16590         in unsigned long sockSnd,
    16591         in unsigned long sockRcv,
    16592         in unsigned long TcpWndSnd,
    16593         in unsigned long TcpWndRcv
    16594     );
    16595
    16600     void getNetworkSettings (
    16601         out unsigned long mtu,
    16602         out unsigned long sockSnd,
    16603         out unsigned long sockRcv,
    16604         out unsigned long TcpWndSnd,
    16605         out unsigned long TcpWndRcv
    16606     );
    16607
    16627     void addRedirect (
    16628         in wstring name,
    16629         in NATProtocol proto,
    16630         in wstring hostIp,
    16631         in unsigned short hostPort,
    16632         in wstring guestIp,
    16633         in unsigned short guestPort
    16634     );
    16635
    16641     void removeRedirect (
    16642         in wstring name
    16643     );
    16644
    16645 }; /* interface INATEngine */
    16646
    16647