- 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,
    00579     MachineState_DeletingSnapshotOnline = 16,
    00586     MachineState_DeletingSnapshotPaused = 17,
    00593     MachineState_RestoringSnapshot = 18,
    00601     MachineState_DeletingSnapshot = 19,
    00608     MachineState_SettingUp = 20,
    00615     MachineState_FirstOnline = 5,
    00622     MachineState_LastOnline = 17,
    00629     MachineState_FirstTransient = 8,
    00636     MachineState_LastTransient = 20,
    00637 };
    00638
    00649 enum SessionState
    00650 {
    00655     SessionState_Null = 0,
    00663     SessionState_Closed = 1,
    00671     SessionState_Open = 2,
    00682     SessionState_Spawning = 3,
    00690     SessionState_Closing = 4,
    00691 };
    00692
    00701 enum CPUPropertyType
    00702 {
    00707     CPUPropertyType_Null = 0,
    00716     CPUPropertyType_PAE = 1,
    00724     CPUPropertyType_Synthetic = 2,
    00725 };
    00726
    00736 enum HWVirtExPropertyType
    00737 {
    00742     HWVirtExPropertyType_Null = 0,
    00750     HWVirtExPropertyType_Enabled = 1,
    00759     HWVirtExPropertyType_Exclusive = 2,
    00766     HWVirtExPropertyType_VPID = 3,
    00773     HWVirtExPropertyType_NestedPaging = 4,
    00780     HWVirtExPropertyType_LargePages = 5,
    00781 };
    00782
    00791 enum SessionType
    00792 {
    00797     SessionType_Null = 0,
    00805     SessionType_Direct = 1,
    00813     SessionType_Remote = 2,
    00821     SessionType_Existing = 3,
    00822 };
    00823
    00831 enum DeviceType
    00832 {
    00840     DeviceType_Null = 0,
    00845     DeviceType_Floppy = 1,
    00850     DeviceType_DVD = 2,
    00855     DeviceType_HardDisk = 3,
    00860     DeviceType_Network = 4,
    00865     DeviceType_USB = 5,
    00870     DeviceType_SharedFolder = 6,
    00871 };
    00872
    00880 enum DeviceActivity
    00881 {
    00882     DeviceActivity_Null = 0,
    00883     DeviceActivity_Idle = 1,
    00884     DeviceActivity_Reading = 2,
    00885     DeviceActivity_Writing = 3,
    00886 };
    00887
    00895 enum ClipboardMode
    00896 {
    00897     ClipboardMode_Disabled = 0,
    00898     ClipboardMode_HostToGuest = 1,
    00899     ClipboardMode_GuestToHost = 2,
    00900     ClipboardMode_Bidirectional = 3,
    00901 };
    00902
    00913 enum Scope
    00914 {
    00915     Scope_Global = 0,
    00916     Scope_Machine = 1,
    00917     Scope_Session = 2,
    00918 };
    00919
    00927 enum BIOSBootMenuMode
    00928 {
    00929     BIOSBootMenuMode_Disabled = 0,
    00930     BIOSBootMenuMode_MenuOnly = 1,
    00931     BIOSBootMenuMode_MessageAndMenu = 2,
    00932 };
    00933
    00941 enum ProcessorFeature
    00942 {
    00943     ProcessorFeature_HWVirtEx = 0,
    00944     ProcessorFeature_PAE = 1,
    00945     ProcessorFeature_LongMode = 2,
    00946     ProcessorFeature_NestedPaging = 3,
    00947 };
    00948
    00956 enum FirmwareType
    00957 {
    00962     FirmwareType_BIOS = 1,
    00967     FirmwareType_EFI = 2,
    00972     FirmwareType_EFI32 = 3,
    00977     FirmwareType_EFI64 = 4,
    00982     FirmwareType_EFIDUAL = 5,
    00983 };
    00984
    00992 enum PointingHidType
    00993 {
    00998     PointingHidType_None = 1,
    01003     PointingHidType_PS2Mouse = 2,
    01008     PointingHidType_USBMouse = 3,
    01013     PointingHidType_USBTablet = 4,
    01019     PointingHidType_ComboMouse = 5,
    01020 };
    01021
    01029 enum KeyboardHidType
    01030 {
    01035     KeyboardHidType_None = 1,
    01040     KeyboardHidType_PS2Keyboard = 2,
    01045     KeyboardHidType_USBKeyboard = 3,
    01051     KeyboardHidType_ComboKeyboard = 4,
    01052 };
    01053
    01061 enum VFSType
    01062 {
    01063     VFSType_File = 1,
    01064     VFSType_Cloud = 2,
    01065     VFSType_S3 = 3,
    01066     VFSType_WebDav = 4,
    01067 };
    01068
    01076 enum VFSFileType
    01077 {
    01078     VFSFileType_Unknown = 1,
    01079     VFSFileType_Fifo = 2,
    01080     VFSFileType_DevChar = 3,
    01081     VFSFileType_Directory = 4,
    01082     VFSFileType_DevBlock = 5,
    01083     VFSFileType_File = 6,
    01084     VFSFileType_SymLink = 7,
    01085     VFSFileType_Socket = 8,
    01086     VFSFileType_WhiteOut = 9,
    01087 };
    01088
    01095 enum VirtualSystemDescriptionType
    01096 {
    01097     VirtualSystemDescriptionType_Ignore = 1,
    01098     VirtualSystemDescriptionType_OS = 2,
    01099     VirtualSystemDescriptionType_Name = 3,
    01100     VirtualSystemDescriptionType_Product = 4,
    01101     VirtualSystemDescriptionType_Vendor = 5,
    01102     VirtualSystemDescriptionType_Version = 6,
    01103     VirtualSystemDescriptionType_ProductUrl = 7,
    01104     VirtualSystemDescriptionType_VendorUrl = 8,
    01105     VirtualSystemDescriptionType_Description = 9,
    01106     VirtualSystemDescriptionType_License = 10,
    01107     VirtualSystemDescriptionType_Miscellaneous = 11,
    01108     VirtualSystemDescriptionType_CPU = 12,
    01109     VirtualSystemDescriptionType_Memory = 13,
    01110     VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
    01111     VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
    01112     VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
    01113     VirtualSystemDescriptionType_HardDiskControllerSAS = 17,
    01114     VirtualSystemDescriptionType_HardDiskImage = 18,
    01115     VirtualSystemDescriptionType_Floppy = 19,
    01116     VirtualSystemDescriptionType_CDROM = 20,
    01117     VirtualSystemDescriptionType_NetworkAdapter = 21,
    01118     VirtualSystemDescriptionType_USBController = 22,
    01119     VirtualSystemDescriptionType_SoundCard = 23,
    01120 };
    01121
    01128 enum VirtualSystemDescriptionValueType
    01129 {
    01130     VirtualSystemDescriptionValueType_Reference = 1,
    01131     VirtualSystemDescriptionValueType_Original = 2,
    01132     VirtualSystemDescriptionValueType_Auto = 3,
    01133     VirtualSystemDescriptionValueType_ExtraConfig = 4,
    01134 };
    01135
    01146 enum HostNetworkInterfaceMediumType
    01147 {
    01154     HostNetworkInterfaceMediumType_Unknown = 0,
    01161     HostNetworkInterfaceMediumType_Ethernet = 1,
    01168     HostNetworkInterfaceMediumType_PPP = 2,
    01175     HostNetworkInterfaceMediumType_SLIP = 3,
    01176 };
    01177
    01187 enum HostNetworkInterfaceStatus
    01188 {
    01195     HostNetworkInterfaceStatus_Unknown = 0,
    01202     HostNetworkInterfaceStatus_Up = 1,
    01209     HostNetworkInterfaceStatus_Down = 2,
    01210 };
    01211
    01219 enum HostNetworkInterfaceType
    01220 {
    01221     HostNetworkInterfaceType_Bridged = 1,
    01222     HostNetworkInterfaceType_HostOnly = 2,
    01223 };
    01224
    01234 enum MediumState
    01235 {
    01243     MediumState_NotCreated = 0,
    01252     MediumState_Created = 1,
    01260     MediumState_LockedRead = 2,
    01268     MediumState_LockedWrite = 3,
    01278     MediumState_Inaccessible = 4,
    01285     MediumState_Creating = 5,
    01292     MediumState_Deleting = 6,
    01293 };
    01294
    01304 enum MediumType
    01305 {
    01313     MediumType_Normal = 0,
    01321     MediumType_Immutable = 1,
    01329     MediumType_Writethrough = 2,
    01338     MediumType_Shareable = 3,
    01339 };
    01340
    01350 enum MediumVariant
    01351 {
    01358     MediumVariant_Standard = 0,
    01365     MediumVariant_VmdkSplit2G = 0x01,
    01373     MediumVariant_VmdkStreamOptimized = 0x04,
    01380     MediumVariant_VmdkESX = 0x08,
    01387     MediumVariant_Fixed = 0x10000,
    01394     MediumVariant_Diff = 0x20000,
    01395 };
    01396
    01397 enum DataType
    01398 {
    01399     DataType_Int32 = 0,
    01400     DataType_Int8 = 1,
    01401     DataType_String = 2,
    01402 };
    01403
    01404 enum DataFlags
    01405 {
    01406     DataFlags_None = 0x00,
    01407     DataFlags_Mandatory = 0x01,
    01408     DataFlags_Expert = 0x02,
    01409     DataFlags_Array = 0x04,
    01410     DataFlags_FlagMask = 0x07,
    01411 };
    01412
    01420 enum MediumFormatCapabilities
    01421 {
    01428     MediumFormatCapabilities_Uuid = 0x01,
    01435     MediumFormatCapabilities_CreateFixed = 0x02,
    01443     MediumFormatCapabilities_CreateDynamic = 0x04,
    01450     MediumFormatCapabilities_CreateSplit2G = 0x08,
    01457     MediumFormatCapabilities_Differencing = 0x10,
    01464     MediumFormatCapabilities_Asynchronous = 0x20,
    01474     MediumFormatCapabilities_File = 0x40,
    01483     MediumFormatCapabilities_Properties = 0x80,
    01484     MediumFormatCapabilities_CapabilityMask = 0xFF,
    01485 };
    01486
    01494 enum MouseButtonState
    01495 {
    01496     MouseButtonState_LeftButton = 0x01,
    01497     MouseButtonState_RightButton = 0x02,
    01498     MouseButtonState_MiddleButton = 0x04,
    01499     MouseButtonState_WheelUp = 0x08,
    01500     MouseButtonState_WheelDown = 0x10,
    01501     MouseButtonState_XButton1 = 0x20,
    01502     MouseButtonState_XButton2 = 0x40,
    01503     MouseButtonState_MouseStateMask = 0x7F,
    01504 };
    01505
    01516 enum FramebufferPixelFormat
    01517 {
    01525     FramebufferPixelFormat_Opaque = 0,
    01533     FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
    01534 };
    01535
    01543 enum NetworkAttachmentType
    01544 {
    01549     NetworkAttachmentType_Null = 0,
    01550     NetworkAttachmentType_NAT = 1,
    01551     NetworkAttachmentType_Bridged = 2,
    01552     NetworkAttachmentType_Internal = 3,
    01553     NetworkAttachmentType_HostOnly = 4,
    01554     NetworkAttachmentType_VDE = 5,
    01555 };
    01556
    01564 enum NetworkAdapterType
    01565 {
    01570     NetworkAdapterType_Null = 0,
    01575     NetworkAdapterType_Am79C970A = 1,
    01580     NetworkAdapterType_Am79C973 = 2,
    01585     NetworkAdapterType_I82540EM = 3,
    01590     NetworkAdapterType_I82543GC = 4,
    01595     NetworkAdapterType_I82545EM = 5,
    01600     NetworkAdapterType_Virtio = 6,
    01601 };
    01602
    01611 enum PortMode
    01612 {
    01617     PortMode_Disconnected = 0,
    01622     PortMode_HostPipe = 1,
    01627     PortMode_HostDevice = 2,
    01632     PortMode_RawFile = 3,
    01633 };
    01634
    01673 enum USBDeviceState
    01674 {
    01681     USBDeviceState_NotSupported = 0,
    01689     USBDeviceState_Unavailable = 1,
    01696     USBDeviceState_Busy = 2,
    01704     USBDeviceState_Available = 3,
    01712     USBDeviceState_Held = 4,
    01720     USBDeviceState_Captured = 5,
    01721 };
    01722
    01732 enum USBDeviceFilterAction
    01733 {
    01738     USBDeviceFilterAction_Null = 0,
    01743     USBDeviceFilterAction_Ignore = 1,
    01748     USBDeviceFilterAction_Hold = 2,
    01749 };
    01750
    01758 enum AudioDriverType
    01759 {
    01764     AudioDriverType_Null = 0,
    01769     AudioDriverType_WinMM = 1,
    01774     AudioDriverType_OSS = 2,
    01779     AudioDriverType_ALSA = 3,
    01784     AudioDriverType_DirectSound = 4,
    01789     AudioDriverType_CoreAudio = 5,
    01794     AudioDriverType_MMPM = 6,
    01799     AudioDriverType_Pulse = 7,
    01804     AudioDriverType_SolAudio = 8,
    01805 };
    01806
    01814 enum AudioControllerType
    01815 {
    01816     AudioControllerType_AC97 = 0,
    01817     AudioControllerType_SB16 = 1,
    01818 };
    01819
    01827 enum VRDPAuthType
    01828 {
    01833     VRDPAuthType_Null = 0,
    01834     VRDPAuthType_External = 1,
    01835     VRDPAuthType_Guest = 2,
    01836 };
    01837
    01846 enum StorageBus
    01847 {
    01852     StorageBus_Null = 0,
    01853     StorageBus_IDE = 1,
    01854     StorageBus_SATA = 2,
    01855     StorageBus_SCSI = 3,
    01856     StorageBus_Floppy = 4,
    01857     StorageBus_SAS = 5,
    01858 };
    01859
    01868 enum StorageControllerType
    01869 {
    01874     StorageControllerType_Null = 0,
    01879     StorageControllerType_LsiLogic = 1,
    01884     StorageControllerType_BusLogic = 2,
    01889     StorageControllerType_IntelAhci = 3,
    01894     StorageControllerType_PIIX3 = 4,
    01899     StorageControllerType_PIIX4 = 5,
    01904     StorageControllerType_ICH6 = 6,
    01909     StorageControllerType_I82078 = 7,
    01914     StorageControllerType_LsiLogicSas = 8,
    01915 };
    01916
    01922 enum NATAliasMode
    01923 {
    01928     NATAliasMode_AliasLog = 0x1,
    01933     NATAliasMode_AliasProxyOnly = 0x02,
    01938     NATAliasMode_AliasUseSamePorts = 0x04,
    01939 };
    01940
    01946 enum NATProtocol
    01947 {
    01952     NATProtocol_UDP = 0,
    01957     NATProtocol_TCP = 1,
    01958 };
    01959
    01992 interface IVirtualBoxErrorInfo : $errorinfo
    01993 {
    02011     readonly attribute long resultCode;
    02012
    02024     readonly attribute wstringUUID interfaceID;
    02025
    02036     readonly attribute wstring component;
    02037
    02048     readonly attribute wstring text;
    02049
    02060     readonly attribute IVirtualBoxErrorInfo next;
    02061
    02062 }; /* interface IVirtualBoxErrorInfo */
    02063
    02076 interface ILocalOwner : $unknown
    02077 {
    02086     void setLocalObject (
    02087         in $unknown object
    02088     );
    02089
    02090 }; /* interface ILocalOwner */
    02091
    02092 interface IVirtualBoxCallback : $unknown
    02093 {
    02112     void onMachineStateChange (
    02113         in wstringUUID machineId,
    02114         in MachineState state
    02115     );
    02116
    02131     void onMachineDataChange (
    02132         in wstringUUID machineId
    02133     );
    02134
    02172     void onExtraDataCanChange (
    02173         in wstringUUID machineId,
    02174         in wstring key,
    02175         in wstring value,
    02176         out wstring error,
    02177         [retval] out boolean allowChange
    02178     );
    02179
    02206     void onExtraDataChange (
    02207         in wstringUUID machineId,
    02208         in wstring key,
    02209         in wstring value
    02210     );
    02211
    02257     void onMediumRegistered (
    02258         in wstringUUID mediumId,
    02259         in DeviceType mediumType,
    02260         in boolean registered
    02261     );
    02262
    02283     void onMachineRegistered (
    02284         in wstringUUID machineId,
    02285         in boolean registered
    02286     );
    02287
    02306     void onSessionStateChange (
    02307         in wstringUUID machineId,
    02308         in SessionState state
    02309     );
    02310
    02329     void onSnapshotTaken (
    02330         in wstringUUID machineId,
    02331         in wstringUUID snapshotId
    02332     );
    02333
    02362     void onSnapshotDeleted (
    02363         in wstringUUID machineId,
    02364         in wstringUUID snapshotId
    02365     );
    02366
    02385     void onSnapshotChange (
    02386         in wstringUUID machineId,
    02387         in wstringUUID snapshotId
    02388     );
    02389
    02418     void onGuestPropertyChange (
    02419         in wstringUUID machineId,
    02420         in wstring name,
    02421         in wstring value,
    02422         in wstring flags
    02423     );
    02424
    02425 }; /* interface IVirtualBoxCallback */
    02426
    02437 interface IDHCPServer : $unknown
    02438 {
    02444     attribute boolean enabled;
    02445
    02451     readonly attribute wstring IPAddress;
    02452
    02458     readonly attribute wstring networkMask;
    02459
    02465     readonly attribute wstring networkName;
    02466
    02472     readonly attribute wstring lowerIP;
    02473
    02479     readonly attribute wstring upperIP;
    02480
    02509     void setConfiguration (
    02510         in wstring IPAddress,
    02511         in wstring networkMask,
    02512         in wstring FromIPAddress,
    02513         in wstring ToIPAddress
    02514     );
    02515
    02540     void start (
    02541         in wstring networkName,
    02542         in wstring trunkName,
    02543         in wstring trunkType
    02544     );
    02545
    02558     void stop();
    02559
    02560 }; /* interface IDHCPServer */
    02561
    02580 interface IVirtualBox : $unknown
    02581 {
    02589     readonly attribute wstring version;
    02590
    02596     readonly attribute unsigned long revision;
    02597
    02607     readonly attribute wstring packageType;
    02608
    02624     readonly attribute wstring homeFolder;
    02625
    02633     readonly attribute wstring settingsFilePath;
    02634
    02638     readonly attribute IHost host;
    02639
    02643     readonly attribute ISystemProperties systemProperties;
    02644
    02650     readonly attribute IMachine[] machines;
    02651
    02661     readonly attribute IMedium[] hardDisks;
    02662
    02668     readonly attribute IMedium[] DVDImages;
    02669
    02675     readonly attribute IMedium[] floppyImages;
    02676
    02677     readonly attribute IProgress[] progressOperations;
    02678
    02679     readonly attribute IGuestOSType[] guestOSTypes;
    02680
    02697     readonly attribute ISharedFolder[] sharedFolders;
    02698
    02704     readonly attribute IPerformanceCollector performanceCollector;
    02705
    02711     readonly attribute IDHCPServer[] DHCPServers;
    02712
    02816     void createMachine (
    02817         in wstring name,
    02818         in wstring osTypeId,
    02819         in wstring baseFolder,
    02820         in wstringUUID id,
    02821         in boolean override,
    02822         [retval] out IMachine machine
    02823     );
    02824
    02888     void createLegacyMachine (
    02889         in wstring name,
    02890         in wstring osTypeId,
    02891         in wstring settingsFile,
    02892         in wstringUUID id,
    02893         [retval] out IMachine machine
    02894     );
    02895
    02923     void openMachine (
    02924         in wstring settingsFile,
    02925         [retval] out IMachine machine
    02926     );
    02927
    02960     void registerMachine (
    02961         in IMachine machine
    02962     );
    02963
    02979     void getMachine (
    02980         in wstringUUID id,
    02981         [retval] out IMachine machine
    02982     );
    02983
    02999     void findMachine (
    03000         in wstring name,
    03001         [retval] out IMachine machine
    03002     );
    03003
    03058     void unregisterMachine (
    03059         in wstringUUID id,
    03060         [retval] out IMachine machine
    03061     );
    03062
    03072     void createAppliance (
    03073         [retval] out IAppliance appliance
    03074     );
    03075
    03141     void createHardDisk (
    03142         in wstring format,
    03143         in wstring location,
    03144         [retval] out IMedium medium
    03145     );
    03146
    03234     void openHardDisk (
    03235         in wstring location,
    03236         in AccessMode accessMode,
    03237         in boolean setImageId,
    03238         in wstringUUID imageId,
    03239         in boolean setParentId,
    03240         in wstringUUID parentId,
    03241         [retval] out IMedium medium
    03242     );
    03243
    03265     void getHardDisk (
    03266         in wstringUUID id,
    03267         [retval] out IMedium medium
    03268     );
    03269
    03302     void findHardDisk (
    03303         in wstring location,
    03304         [retval] out IMedium medium
    03305     );
    03306
    03356     void openDVDImage (
    03357         in wstring location,
    03358         in wstringUUID id,
    03359         [retval] out IMedium image
    03360     );
    03361
    03382     void getDVDImage (
    03383         in wstringUUID id,
    03384         [retval] out IMedium image
    03385     );
    03386
    03425     void findDVDImage (
    03426         in wstring location,
    03427         [retval] out IMedium image
    03428     );
    03429
    03479     void openFloppyImage (
    03480         in wstring location,
    03481         in wstringUUID id,
    03482         [retval] out IMedium image
    03483     );
    03484
    03505     void getFloppyImage (
    03506         in wstringUUID id,
    03507         [retval] out IMedium image
    03508     );
    03509
    03548     void findFloppyImage (
    03549         in wstring location,
    03550         [retval] out IMedium image
    03551     );
    03552
    03581     void getGuestOSType (
    03582         in wstringUUID id,
    03583         [retval] out IGuestOSType type
    03584     );
    03585
    03605     void createSharedFolder (
    03606         in wstring name,
    03607         in wstring hostPath,
    03608         in boolean writable
    03609     );
    03610
    03625     void removeSharedFolder (
    03626         in wstring name
    03627     );
    03628
    03637     void getExtraDataKeys (
    03638         [retval] out wstring[] value
    03639     );
    03640
    03669     void getExtraData (
    03670         in wstring key,
    03671         [retval] out wstring value
    03672     );
    03673
    03723     void setExtraData (
    03724         in wstring key,
    03725         in wstring value
    03726     );
    03727
    03824     void openSession (
    03825         in ISession session,
    03826         in wstringUUID machineId
    03827     );
    03828
    03952     void openRemoteSession (
    03953         in ISession session,
    03954         in wstringUUID machineId,
    03955         in wstring type,
    03956         in wstring environment,
    03957         [retval] out IProgress progress
    03958     );
    03959
    04029     void openExistingSession (
    04030         in ISession session,
    04031         in wstringUUID machineId
    04032     );
    04033
    04051     void registerCallback (
    04052         in IVirtualBoxCallback callback
    04053     );
    04054
    04070     void unregisterCallback (
    04071         in IVirtualBoxCallback callback
    04072     );
    04073
    04161     void waitForPropertyChange (
    04162         in wstring what,
    04163         in unsigned long timeout,
    04164         out wstring changed,
    04165         out wstring values
    04166     );
    04167
    04184     void createDHCPServer (
    04185         in wstring name,
    04186         [retval] out IDHCPServer server
    04187     );
    04188
    04205     void findDHCPServerByNetworkName (
    04206         in wstring name,
    04207         [retval] out IDHCPServer server
    04208     );
    04209
    04224     void removeDHCPServer (
    04225         in IDHCPServer server
    04226     );
    04227
    04252     void checkFirmwarePresent (
    04253         in FirmwareType firmwareType,
    04254         in wstring version,
    04255         out wstring url,
    04256         out wstring file,
    04257         [retval] out boolean result
    04258     );
    04259
    04260 }; /* interface IVirtualBox */
    04261
    04272 interface IVFSExplorer : $unknown
    04273 {
    04277     readonly attribute wstring path;
    04278
    04282     readonly attribute VFSType type;
    04283
    04291     void update (
    04292         [retval] out IProgress aProgress
    04293     );
    04294
    04302     void cd (
    04303         in wstring aDir,
    04304         [retval] out IProgress aProgress
    04305     );
    04306
    04312     void cdUp (
    04313         [retval] out IProgress aProgress
    04314     );
    04315
    04324     void entryList (
    04325         out wstring[] aNames,
    04326         out unsigned long[] aTypes
    04327     );
    04328
    04337     void exists (
    04338         in wstring[] aNames,
    04339         [retval] out wstring[] aExists
    04340     );
    04341
    04349     void remove (
    04350         in wstring[] aNames,
    04351         [retval] out IProgress aProgress
    04352     );
    04353
    04354 }; /* interface IVFSExplorer */
    04355
    04420 interface IAppliance : $unknown
    04421 {
    04429     readonly attribute wstring path;
    04430
    04461     readonly attribute wstring[] disks;
    04462
    04470     readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
    04471
    04488     void read (
    04489         in wstring file,
    04490         [retval] out IProgress aProgress
    04491     );
    04492
    04509     void interpret();
    04510
    04528     void importMachines (
    04529         [retval] out IProgress aProgress
    04530     );
    04531
    04539     void createVFSExplorer (
    04540         in wstring aUri,
    04541         [retval] out IVFSExplorer aExplorer
    04542     );
    04543
    04568     void write (
    04569         in wstring format,
    04570         in wstring path,
    04571         [retval] out IProgress aProgress
    04572     );
    04573
    04579     void getWarnings (
    04580         [retval] out wstring[] aWarnings
    04581     );
    04582
    04583 }; /* interface IAppliance */
    04584
    04595 interface IVirtualSystemDescription : $unknown
    04596 {
    04600     readonly attribute unsigned long count;
    04601
    04726     void getDescription (
    04727         out VirtualSystemDescriptionType[] aTypes,
    04728         out wstring[] aRefs,
    04729         out wstring[] aOvfValues,
    04730         out wstring[] aVBoxValues,
    04731         out wstring[] aExtraConfigValues
    04732     );
    04733
    04750     void getDescriptionByType (
    04751         in VirtualSystemDescriptionType aType,
    04752         out VirtualSystemDescriptionType[] aTypes,
    04753         out wstring[] aRefs,
    04754         out wstring[] aOvfValues,
    04755         out wstring[] aVBoxValues,
    04756         out wstring[] aExtraConfigValues
    04757     );
    04758
    04770     void getValuesByType (
    04771         in VirtualSystemDescriptionType aType,
    04772         in VirtualSystemDescriptionValueType aWhich,
    04773         [retval] out wstring[] aValues
    04774     );
    04775
    04801     void setFinalValues (
    04802         in boolean[] aEnabled,
    04803         in wstring[] aVBoxValues,
    04804         in wstring[] aExtraConfigValues
    04805     );
    04806
    04821     void addDescription (
    04822         in VirtualSystemDescriptionType aType,
    04823         in wstring aVBoxValue,
    04824         in wstring aExtraConfigValue
    04825     );
    04826
    04827 }; /* interface IVirtualSystemDescription */
    04828
    04829 interface IInternalMachineControl : $unknown
    04830 {
    04837     void setRemoveSavedState (
    04838         in boolean aRemove
    04839     );
    04840
    04852     void updateState (
    04853         in MachineState state
    04854     );
    04855
    04856     void getIPCId (
    04857         [retval] out wstring id
    04858     );
    04859
    04869     void setPowerUpInfo (
    04870         in IVirtualBoxErrorInfo error
    04871     );
    04872
    04886     void runUSBDeviceFilters (
    04887         in IUSBDevice device,
    04888         out boolean matched,
    04889         out unsigned long maskedInterfaces
    04890     );
    04891
    04900     void captureUSBDevice (
    04901         in wstringUUID id
    04902     );
    04903
    04919     void detachUSBDevice (
    04920         in wstringUUID id,
    04921         in boolean done
    04922     );
    04923
    04932     void autoCaptureUSBDevices();
    04933
    04949     void detachAllUSBDevices (
    04950         in boolean done
    04951     );
    04952
    04967     void onSessionEnd (
    04968         in ISession session,
    04969         [retval] out IProgress progress
    04970     );
    04971
    04987     void beginSavingState (
    04988         in IProgress progress,
    04989         out wstring stateFilePath
    04990     );
    04991
    05018     void endSavingState (
    05019         in boolean success
    05020     );
    05021
    05036     void adoptSavedState (
    05037         in wstring savedStateFile
    05038     );
    05039
    05088     void beginTakingSnapshot (
    05089         in IConsole initiator,
    05090         in wstring name,
    05091         in wstring description,
    05092         in IProgress consoleProgress,
    05093         in boolean fTakingSnapshotOnline,
    05094         out wstring stateFilePath
    05095     );
    05096
    05106     void endTakingSnapshot (
    05107         in boolean success
    05108     );
    05109
    05130     void deleteSnapshot (
    05131         in IConsole initiator,
    05132         in wstringUUID id,
    05133         out MachineState machineState,
    05134         [retval] out IProgress progress
    05135     );
    05136
    05155     void finishOnlineMergeMedium (
    05156         in IMediumAttachment mediumAttachment,
    05157         in IMedium source,
    05158         in IMedium target,
    05159         in boolean mergeForward,
    05160         in IMedium parentForTarget,
    05161         in IMedium[] childrenToReparent
    05162     );
    05163
    05177     void restoreSnapshot (
    05178         in IConsole initiator,
    05179         in ISnapshot snapshot,
    05180         out MachineState machineState,
    05181         [retval] out IProgress progress
    05182     );
    05183
    05210     void pullGuestProperties (
    05211         out wstring[] name,
    05212         out wstring[] value,
    05213         out unsigned long long[] timestamp,
    05214         out wstring[] flags
    05215     );
    05216
    05238     void pushGuestProperty (
    05239         in wstring name,
    05240         in wstring value,
    05241         in unsigned long long timestamp,
    05242         in wstring flags
    05243     );
    05244
    05256     void lockMedia();
    05257
    05267     void unlockMedia();
    05268
    05269 }; /* interface IInternalMachineControl */
    05270
    05279 interface IBIOSSettings : $unknown
    05280 {
    05284     attribute boolean logoFadeIn;
    05285
    05289     attribute boolean logoFadeOut;
    05290
    05294     attribute unsigned long logoDisplayTime;
    05295
    05302     attribute wstring logoImagePath;
    05303
    05307     attribute BIOSBootMenuMode bootMenuMode;
    05308
    05312     attribute boolean ACPIEnabled;
    05313
    05320     attribute boolean IOAPICEnabled;
    05321
    05331     attribute long long timeOffset;
    05332
    05339     attribute boolean PXEDebugEnabled;
    05340
    05341 }; /* interface IBIOSSettings */
    05342
    05383 interface IMachine : $unknown
    05384 {
    05388     readonly attribute IVirtualBox parent;
    05389
    05439     readonly attribute boolean accessible;
    05440
    05452     readonly attribute IVirtualBoxErrorInfo accessError;
    05453
    05499     attribute wstring name;
    05500
    05511     attribute wstring description;
    05512
    05516     readonly attribute wstringUUID id;
    05517
    05532     attribute wstring OSTypeId;
    05533
    05537     attribute wstring HardwareVersion;
    05538
    05548     attribute wstringUUID hardwareUUID;
    05549
    05553     attribute unsigned long CPUCount;
    05554
    05560     attribute boolean CPUHotPlugEnabled;
    05561
    05565     attribute unsigned long memorySize;
    05566
    05570     attribute unsigned long memoryBalloonSize;
    05571
    05578     attribute boolean PageFusionEnabled;
    05579
    05583     attribute unsigned long VRAMSize;
    05584
    05590     attribute boolean accelerate3DEnabled;
    05591
    05597     attribute boolean accelerate2DVideoEnabled;
    05598
    05609     attribute unsigned long monitorCount;
    05610
    05614     readonly attribute IBIOSSettings BIOSSettings;
    05615
    05620     attribute FirmwareType firmwareType;
    05621
    05627     attribute PointingHidType pointingHidType;
    05628
    05634     attribute KeyboardHidType keyboardHidType;
    05635
    05642     attribute boolean hpetEnabled;
    05643
    05677     attribute wstring snapshotFolder;
    05678
    05682     readonly attribute IVRDPServer VRDPServer;
    05683
    05687     readonly attribute IMediumAttachment[] mediumAttachments;
    05688
    05700     readonly attribute IUSBController USBController;
    05701
    05705     readonly attribute IAudioAdapter audioAdapter;
    05706
    05710     readonly attribute IStorageController[] storageControllers;
    05711
    05717     readonly attribute wstring settingsFilePath;
    05718
    05743     readonly attribute boolean settingsModified;
    05744
    05748     readonly attribute SessionState sessionState;
    05749
    05762     readonly attribute wstring sessionType;
    05763
    05775     readonly attribute unsigned long sessionPid;
    05776
    05780     readonly attribute MachineState state;
    05781
    05788     readonly attribute long long lastStateChange;
    05789
    05801     readonly attribute wstring stateFilePath;
    05802
    05812     readonly attribute wstring logFolder;
    05813
    05824     readonly attribute ISnapshot currentSnapshot;
    05825
    05832     readonly attribute unsigned long snapshotCount;
    05833
    05867     readonly attribute boolean currentStateModified;
    05868
    05880     readonly attribute ISharedFolder[] sharedFolders;
    05881
    05888     attribute ClipboardMode clipboardMode;
    05889
    05897     attribute wstring guestPropertyNotificationPatterns;
    05898
    05907     attribute boolean teleporterEnabled;
    05908
    05919     attribute unsigned long teleporterPort;
    05920
    05927     attribute wstring teleporterAddress;
    05928
    05936     attribute wstring teleporterPassword;
    05937
    05945     attribute boolean RTCUseUTC;
    05946
    05953     attribute boolean ioCacheEnabled;
    05954
    05960     attribute unsigned long ioCacheSize;
    05961
    05968     attribute unsigned long ioBandwidthMax;
    05969
    06007     void setBootOrder (
    06008         in unsigned long position,
    06009         in DeviceType device
    06010     );
    06011
    06046     void getBootOrder (
    06047         in unsigned long position,
    06048         [retval] out DeviceType device
    06049     );
    06050
    06140     void attachDevice (
    06141         in wstring name,
    06142         in long controllerPort,
    06143         in long device,
    06144         in DeviceType type,
    06145         in wstringUUID id
    06146     );
    06147
    06200     void detachDevice (
    06201         in wstring name,
    06202         in long controllerPort,
    06203         in long device
    06204     );
    06205
    06248     void passthroughDevice (
    06249         in wstring name,
    06250         in long controllerPort,
    06251         in long device,
    06252         in boolean passthrough
    06253     );
    06254
    06318     void mountMedium (
    06319         in wstring name,
    06320         in long controllerPort,
    06321         in long device,
    06322         in wstringUUID medium,
    06323         in boolean force
    06324     );
    06325
    06354     void getMedium (
    06355         in wstring name,
    06356         in long controllerPort,
    06357         in long device,
    06358         [retval] out IMedium medium
    06359     );
    06360
    06375     void getMediumAttachmentsOfController (
    06376         in wstring name,
    06377         [retval] out IMediumAttachment[] mediumAttachments
    06378     );
    06379
    06394     void getMediumAttachment (
    06395         in wstring name,
    06396         in long controllerPort,
    06397         in long device,
    06398         [retval] out IMediumAttachment attachment
    06399     );
    06400
    06418     void getNetworkAdapter (
    06419         in unsigned long slot,
    06420         [retval] out INetworkAdapter adapter
    06421     );
    06422
    06455     void addStorageController (
    06456         in wstring name,
    06457         in StorageBus connectionType,
    06458         [retval] out IStorageController controller
    06459     );
    06460
    06474     void getStorageControllerByName (
    06475         in wstring name,
    06476         [retval] out IStorageController storageController
    06477     );
    06478
    06492     void getStorageControllerByInstance (
    06493         in unsigned long instance,
    06494         [retval] out IStorageController storageController
    06495     );
    06496
    06510     void removeStorageController (
    06511         in wstring name
    06512     );
    06513
    06531     void getSerialPort (
    06532         in unsigned long slot,
    06533         [retval] out ISerialPort port
    06534     );
    06535
    06553     void getParallelPort (
    06554         in unsigned long slot,
    06555         [retval] out IParallelPort port
    06556     );
    06557
    06566     void getExtraDataKeys (
    06567         [retval] out wstring[] value
    06568     );
    06569
    06598     void getExtraData (
    06599         in wstring key,
    06600         [retval] out wstring value
    06601     );
    06602
    06652     void setExtraData (
    06653         in wstring key,
    06654         in wstring value
    06655     );
    06656
    06678     void getCPUProperty (
    06679         in CPUPropertyType property,
    06680         [retval] out boolean value
    06681     );
    06682
    06704     void setCPUProperty (
    06705         in CPUPropertyType property,
    06706         in boolean value
    06707     );
    06708
    06748     void getCPUIDLeaf (
    06749         in unsigned long id,
    06750         out unsigned long valEax,
    06751         out unsigned long valEbx,
    06752         out unsigned long valEcx,
    06753         out unsigned long valEdx
    06754     );
    06755
    06799     void setCPUIDLeaf (
    06800         in unsigned long id,
    06801         in unsigned long valEax,
    06802         in unsigned long valEbx,
    06803         in unsigned long valEcx,
    06804         in unsigned long valEdx
    06805     );
    06806
    06824     void removeCPUIDLeaf (
    06825         in unsigned long id
    06826     );
    06827
    06833     void removeAllCPUIDLeaves();
    06834
    06856     void getHWVirtExProperty (
    06857         in HWVirtExPropertyType property,
    06858         [retval] out boolean value
    06859     );
    06860
    06882     void setHWVirtExProperty (
    06883         in HWVirtExPropertyType property,
    06884         in boolean value
    06885     );
    06886
    06932     void saveSettings();
    06933
    06957     void discardSettings();
    06958
    07000     void deleteSettings();
    07001
    07011     void export (
    07012         in IAppliance aAppliance,
    07013         [retval] out IVirtualSystemDescription aDescription
    07014     );
    07015
    07036     void getSnapshot (
    07037         in wstringUUID id,
    07038         [retval] out ISnapshot snapshot
    07039     );
    07040
    07058     void findSnapshot (
    07059         in wstring name,
    07060         [retval] out ISnapshot snapshot
    07061     );
    07062
    07075     void setCurrentSnapshot (
    07076         in wstringUUID id
    07077     );
    07078
    07109     void createSharedFolder (
    07110         in wstring name,
    07111         in wstring hostPath,
    07112         in boolean writable
    07113     );
    07114
    07140     void removeSharedFolder (
    07141         in wstring name
    07142     );
    07143
    07167     void canShowConsoleWindow (
    07168         [retval] out boolean canShow
    07169     );
    07170
    07205     void showConsoleWindow (
    07206         [retval] out unsigned long long winId
    07207     );
    07208
    07241     void getGuestProperty (
    07242         in wstring name,
    07243         out wstring value,
    07244         out unsigned long long timestamp,
    07245         out wstring flags
    07246     );
    07247
    07270     void getGuestPropertyValue (
    07271         in wstring property,
    07272         [retval] out wstring value
    07273     );
    07274
    07297     void getGuestPropertyTimestamp (
    07298         in wstring property,
    07299         [retval] out unsigned long long value
    07300     );
    07301
    07352     void setGuestProperty (
    07353         in wstring property,
    07354         in wstring value,
    07355         in wstring flags
    07356     );
    07357
    07398     void setGuestPropertyValue (
    07399         in wstring property,
    07400         in wstring value
    07401     );
    07402
    07433     void enumerateGuestProperties (
    07434         in wstring patterns,
    07435         out wstring[] name,
    07436         out wstring[] value,
    07437         out unsigned long long[] timestamp,
    07438         out wstring[] flags
    07439     );
    07440
    07462     void querySavedThumbnailSize (
    07463         in unsigned long screenId,
    07464         out unsigned long size,
    07465         out unsigned long width,
    07466         out unsigned long height
    07467     );
    07468
    07495     void readSavedThumbnailToArray (
    07496         in unsigned long screenId,
    07497         in boolean BGR,
    07498         out unsigned long width,
    07499         out unsigned long height,
    07500         [retval] out octet[] data
    07501     );
    07502
    07524     void querySavedScreenshotPNGSize (
    07525         in unsigned long screenId,
    07526         out unsigned long size,
    07527         out unsigned long width,
    07528         out unsigned long height
    07529     );
    07530
    07552     void readSavedScreenshotPNGToArray (
    07553         in unsigned long screenId,
    07554         out unsigned long width,
    07555         out unsigned long height,
    07556         [retval] out octet[] data
    07557     );
    07558
    07568     void hotPlugCPU (
    07569         in unsigned long cpu
    07570     );
    07571
    07581     void hotUnplugCPU (
    07582         in unsigned long cpu
    07583     );
    07584
    07598     void getCPUStatus (
    07599         in unsigned long cpu,
    07600         [retval] out boolean attached
    07601     );
    07602
    07617     void queryLogFilename (
    07618         in unsigned long idx,
    07619         [retval] out wstring filename
    07620     );
    07621
    07647     void readLog (
    07648         in unsigned long idx,
    07649         in unsigned long long offset,
    07650         in unsigned long long size,
    07651         [retval] out octet[] data
    07652     );
    07653
    07654 }; /* interface IMachine */
    07655
    07674 interface IConsoleCallback : $unknown
    07675 {
    07744     void onMousePointerShapeChange (
    07745         in boolean visible,
    07746         in boolean alpha,
    07747         in unsigned long xHot,
    07748         in unsigned long yHot,
    07749         in unsigned long width,
    07750         in unsigned long height,
    07751         in octet[] shape
    07752     );
    07753
    07767     void onMouseCapabilityChange (
    07768         in boolean supportsAbsolute,
    07769         in boolean supportsRelative,
    07770         in boolean needsHostCursor
    07771     );
    07772
    07786     void onKeyboardLedsChange (
    07787         in boolean numLock,
    07788         in boolean capsLock,
    07789         in boolean scrollLock
    07790     );
    07791
    07805     void onStateChange (
    07806         in MachineState state
    07807     );
    07808
    07816     void onAdditionsStateChange();
    07817
    07835     void onNetworkAdapterChange (
    07836         in INetworkAdapter networkAdapter
    07837     );
    07838
    07856     void onSerialPortChange (
    07857         in ISerialPort serialPort
    07858     );
    07859
    07877     void onParallelPortChange (
    07878         in IParallelPort parallelPort
    07879     );
    07880
    07896     void onStorageControllerChange();
    07897
    07914     void onMediumChange (
    07915         in IMediumAttachment mediumAttachment
    07916     );
    07917
    07934     void onCPUChange (
    07935         in unsigned long cpu,
    07936         in boolean add
    07937     );
    07938
    07954     void onVRDPServerChange();
    07955
    07970     void onRemoteDisplayInfoChange();
    07971
    07987     void onUSBControllerChange();
    07988
    08028     void onUSBDeviceStateChange (
    08029         in IUSBDevice device,
    08030         in boolean attached,
    08031         in IVirtualBoxErrorInfo error
    08032     );
    08033
    08056     void onSharedFolderChange (
    08057         in Scope scope
    08058     );
    08059
    08131     void onRuntimeError (
    08132         in boolean fatal,
    08133         in wstring id,
    08134         in wstring message
    08135     );
    08136
    08171     void onCanShowWindow (
    08172         [retval] out boolean canShow
    08173     );
    08174
    08228     void onShowWindow (
    08229         [retval] out unsigned long long winId
    08230     );
    08231
    08232 }; /* interface IConsoleCallback */
    08233
    08242 interface IRemoteDisplayInfo : $unknown
    08243 {
    08249     readonly attribute boolean active;
    08250
    08259     readonly attribute long port;
    08260
    08266     readonly attribute unsigned long numberOfClients;
    08267
    08273     readonly attribute long long beginTime;
    08274
    08281     readonly attribute long long endTime;
    08282
    08288     readonly attribute unsigned long long bytesSent;
    08289
    08295     readonly attribute unsigned long long bytesSentTotal;
    08296
    08302     readonly attribute unsigned long long bytesReceived;
    08303
    08309     readonly attribute unsigned long long bytesReceivedTotal;
    08310
    08316     readonly attribute wstring user;
    08317
    08323     readonly attribute wstring domain;
    08324
    08330     readonly attribute wstring clientName;
    08331
    08337     readonly attribute wstring clientIP;
    08338
    08344     readonly attribute unsigned long clientVersion;
    08345
    08353     readonly attribute unsigned long encryptionStyle;
    08354
    08355 }; /* interface IRemoteDisplayInfo */
    08356
    08379 interface IConsole : $unknown
    08380 {
    08392     readonly attribute IMachine machine;
    08393
    08407     readonly attribute MachineState state;
    08408
    08412     readonly attribute IGuest guest;
    08413
    08424     readonly attribute IKeyboard keyboard;
    08425
    08436     readonly attribute IMouse mouse;
    08437
    08447     readonly attribute IDisplay display;
    08448
    08452     readonly attribute IMachineDebugger debugger;
    08453
    08464     readonly attribute IUSBDevice[] USBDevices;
    08465
    08473     readonly attribute IHostUSBDevice[] remoteUSBDevices;
    08474
    08490     readonly attribute ISharedFolder[] sharedFolders;
    08491
    08497     readonly attribute IRemoteDisplayInfo remoteDisplayInfo;
    08498
    08552     void powerUp (
    08553         [retval] out IProgress progress
    08554     );
    08555
    08589     void powerUpPaused (
    08590         [retval] out IProgress progress
    08591     );
    08592
    08612     void powerDown (
    08613         [retval] out IProgress progress
    08614     );
    08615
    08635     void reset();
    08636
    08656     void pause();
    08657
    08677     void resume();
    08678
    08698     void powerButton();
    08699
    08719     void sleepButton();
    08720
    08732     void getPowerButtonHandled (
    08733         [retval] out boolean handled
    08734     );
    08735
    08749     void getGuestEnteredACPIMode (
    08750         [retval] out boolean entered
    08751     );
    08752
    08805     void saveState (
    08806         [retval] out IProgress progress
    08807     );
    08808
    08841     void adoptSavedState (
    08842         in wstring savedStateFile
    08843     );
    08844
    08867     void forgetSavedState (
    08868         in boolean remove
    08869     );
    08870
    08883     void getDeviceActivity (
    08884         in DeviceType type,
    08885         [retval] out DeviceActivity activity
    08886     );
    08887
    08924     void attachUSBDevice (
    08925         in wstringUUID id
    08926     );
    08927
    08961     void detachUSBDevice (
    08962         in wstringUUID id,
    08963         [retval] out IUSBDevice device
    08964     );
    08965
    08988     void findUSBDeviceByAddress (
    08989         in wstring name,
    08990         [retval] out IUSBDevice device
    08991     );
    08992
    09012     void findUSBDeviceById (
    09013         in wstringUUID id,
    09014         [retval] out IUSBDevice device
    09015     );
    09016
    09047     void createSharedFolder (
    09048         in wstring name,
    09049         in wstring hostPath,
    09050         in boolean writable
    09051     );
    09052
    09077     void removeSharedFolder (
    09078         in wstring name
    09079     );
    09080
    09118     void takeSnapshot (
    09119         in wstring name,
    09120         in wstring description,
    09121         [retval] out IProgress progress
    09122     );
    09123
    09190     void deleteSnapshot (
    09191         in wstringUUID id,
    09192         [retval] out IProgress progress
    09193     );
    09194
    09235     void restoreSnapshot (
    09236         in ISnapshot snapshot,
    09237         [retval] out IProgress progress
    09238     );
    09239
    09278     void teleport (
    09279         in wstring hostname,
    09280         in unsigned long tcpport,
    09281         in wstring password,
    09282         in unsigned long maxDowntime,
    09283         [retval] out IProgress progress
    09284     );
    09285
    09293     void registerCallback (
    09294         in IConsoleCallback callback
    09295     );
    09296
    09310     void unregisterCallback (
    09311         in IConsoleCallback callback
    09312     );
    09313
    09314 }; /* interface IConsole */
    09315
    09326 interface IHostNetworkInterface : $unknown
    09327 {
    09331     readonly attribute wstring name;
    09332
    09336     readonly attribute wstringUUID id;
    09337
    09341     readonly attribute wstring networkName;
    09342
    09346     readonly attribute boolean dhcpEnabled;
    09347
    09351     readonly attribute wstring IPAddress;
    09352
    09356     readonly attribute wstring networkMask;
    09357
    09361     readonly attribute boolean IPV6Supported;
    09362
    09366     readonly attribute wstring IPV6Address;
    09367
    09371     readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
    09372
    09376     readonly attribute wstring hardwareAddress;
    09377
    09381     readonly attribute HostNetworkInterfaceMediumType mediumType;
    09382
    09386     readonly attribute HostNetworkInterfaceStatus status;
    09387
    09391     readonly attribute HostNetworkInterfaceType interfaceType;
    09392
    09404     void enableStaticIpConfig (
    09405         in wstring IPAddress,
    09406         in wstring networkMask
    09407     );
    09408
    09420     void enableStaticIpConfigV6 (
    09421         in wstring IPV6Address,
    09422         in unsigned long IPV6NetworkMaskPrefixLength
    09423     );
    09424
    09428     void enableDynamicIpConfig();
    09429
    09433     void dhcpRediscover();
    09434
    09435 }; /* interface IHostNetworkInterface */
    09436
    09453 interface IHost : $unknown
    09454 {
    09458     readonly attribute IMedium[] DVDDrives;
    09459
    09463     readonly attribute IMedium[] floppyDrives;
    09464
    09478     readonly attribute IHostUSBDevice[] USBDevices;
    09479
    09502     readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
    09503
    09507     readonly attribute IHostNetworkInterface[] networkInterfaces;
    09508
    09512     readonly attribute unsigned long processorCount;
    09513
    09517     readonly attribute unsigned long processorOnlineCount;
    09518
    09522     readonly attribute unsigned long processorCoreCount;
    09523
    09527     readonly attribute unsigned long memorySize;
    09528
    09532     readonly attribute unsigned long memoryAvailable;
    09533
    09537     readonly attribute wstring operatingSystem;
    09538
    09542     readonly attribute wstring OSVersion;
    09543
    09547     readonly attribute long long UTCTime;
    09548
    09552     readonly attribute boolean Acceleration3DAvailable;
    09553
    09568     void getProcessorSpeed (
    09569         in unsigned long cpuId,
    09570         [retval] out unsigned long speed
    09571     );
    09572
    09584     void getProcessorFeature (
    09585         in ProcessorFeature feature,
    09586         [retval] out boolean supported
    09587     );
    09588
    09607     void getProcessorDescription (
    09608         in unsigned long cpuId,
    09609         [retval] out wstring description
    09610     );
    09611
    09652     void getProcessorCPUIDLeaf (
    09653         in unsigned long cpuId,
    09654         in unsigned long leaf,
    09655         in unsigned long subLeaf,
    09656         out unsigned long valEax,
    09657         out unsigned long valEbx,
    09658         out unsigned long valEcx,
    09659         out unsigned long valEdx
    09660     );
    09661
    09682     void createHostOnlyNetworkInterface (
    09683         out IHostNetworkInterface hostInterface,
    09684         [retval] out IProgress progress
    09685     );
    09686
    09707     void removeHostOnlyNetworkInterface (
    09708         in wstringUUID id,
    09709         [retval] out IProgress progress
    09710     );
    09711
    09732     void createUSBDeviceFilter (
    09733         in wstring name,
    09734         [retval] out IHostUSBDeviceFilter filter
    09735     );
    09736
    09779     void insertUSBDeviceFilter (
    09780         in unsigned long position,
    09781         in IHostUSBDeviceFilter filter
    09782     );
    09783
    09811     void removeUSBDeviceFilter (
    09812         in unsigned long position
    09813     );
    09814
    09832     void findHostDVDDrive (
    09833         in wstring name,
    09834         [retval] out IMedium drive
    09835     );
    09836
    09854     void findHostFloppyDrive (
    09855         in wstring name,
    09856         [retval] out IMedium drive
    09857     );
    09858
    09874     void findHostNetworkInterfaceByName (
    09875         in wstring name,
    09876         [retval] out IHostNetworkInterface networkInterface
    09877     );
    09878
    09894     void findHostNetworkInterfaceById (
    09895         in wstringUUID id,
    09896         [retval] out IHostNetworkInterface networkInterface
    09897     );
    09898
    09908     void findHostNetworkInterfacesOfType (
    09909         in HostNetworkInterfaceType type,
    09910         [retval] out IHostNetworkInterface[] networkInterfaces
    09911     );
    09912
    09932     void findUSBDeviceById (
    09933         in wstringUUID id,
    09934         [retval] out IHostUSBDevice device
    09935     );
    09936
    09959     void findUSBDeviceByAddress (
    09960         in wstring name,
    09961         [retval] out IHostUSBDevice device
    09962     );
    09963
    09964 }; /* interface IHost */
    09965
    09978 interface ISystemProperties : $unknown
    09979 {
    09983     readonly attribute unsigned long minGuestRAM;
    09984
    09988     readonly attribute unsigned long maxGuestRAM;
    09989
    09993     readonly attribute unsigned long minGuestVRAM;
    09994
    09998     readonly attribute unsigned long maxGuestVRAM;
    09999
    10003     readonly attribute unsigned long minGuestCPUCount;
    10004
    10008     readonly attribute unsigned long maxGuestCPUCount;
    10009
    10013     readonly attribute unsigned long maxGuestMonitors;
    10014
    10018     readonly attribute unsigned long long maxVDISize;
    10019
    10026     readonly attribute unsigned long networkAdapterCount;
    10027
    10034     readonly attribute unsigned long serialPortCount;
    10035
    10042     readonly attribute unsigned long parallelPortCount;
    10043
    10053     readonly attribute unsigned long maxBootPosition;
    10054
    10087     attribute wstring defaultMachineFolder;
    10088
    10127     attribute wstring defaultHardDiskFolder;
    10128
    10154     readonly attribute IMediumFormat[] mediumFormats;
    10155
    10189     attribute wstring defaultHardDiskFormat;
    10190
    10196     attribute unsigned long long freeDiskSpaceWarning;
    10197
    10202     attribute unsigned long freeDiskSpacePercentWarning;
    10203
    10209     attribute unsigned long long freeDiskSpaceError;
    10210
    10215     attribute unsigned long freeDiskSpacePercentError;
    10216
    10240     attribute wstring remoteDisplayAuthLibrary;
    10241
    10270     attribute wstring webServiceAuthLibrary;
    10271
    10277     attribute unsigned long LogHistoryCount;
    10278
    10283     readonly attribute AudioDriverType defaultAudioDriver;
    10284
    10294     void getMaxDevicesPerPortForStorageBus (
    10295         in StorageBus bus,
    10296         [retval] out unsigned long maxDevicesPerPort
    10297     );
    10298
    10306     void getMinPortCountForStorageBus (
    10307         in StorageBus bus,
    10308         [retval] out unsigned long minPortCount
    10309     );
    10310
    10318     void getMaxPortCountForStorageBus (
    10319         in StorageBus bus,
    10320         [retval] out unsigned long maxPortCount
    10321     );
    10322
    10332     void getMaxInstancesOfStorageBus (
    10333         in StorageBus bus,
    10334         [retval] out unsigned long maxInstances
    10335     );
    10336
    10346     void getDeviceTypesForStorageBus (
    10347         in StorageBus bus,
    10348         [retval] out DeviceType[] deviceTypes
    10349     );
    10350
    10351 }; /* interface ISystemProperties */
    10352
    10358 interface IGuestOSType : $unknown
    10359 {
    10363     readonly attribute wstring familyId;
    10364
    10368     readonly attribute wstring familyDescription;
    10369
    10373     readonly attribute wstring id;
    10374
    10378     readonly attribute wstring description;
    10379
    10383     readonly attribute boolean is64Bit;
    10384
    10388     readonly attribute boolean recommendedIOAPIC;
    10389
    10393     readonly attribute boolean recommendedVirtEx;
    10394
    10398     readonly attribute unsigned long recommendedRAM;
    10399
    10403     readonly attribute unsigned long recommendedVRAM;
    10404
    10408     readonly attribute unsigned long recommendedHDD;
    10409
    10413     readonly attribute NetworkAdapterType adapterType;
    10414
    10418     readonly attribute boolean recommendedPae;
    10419
    10423     readonly attribute StorageControllerType recommendedDvdStorageController;
    10424
    10428     readonly attribute StorageBus recommendedDvdStorageBus;
    10429
    10433     readonly attribute StorageControllerType recommendedHdStorageController;
    10434
    10438     readonly attribute StorageBus recommendedHdStorageBus;
    10439
    10443     readonly attribute FirmwareType recommendedFirmware;
    10444
    10448     readonly attribute boolean recommendedUsbHid;
    10449
    10453     readonly attribute boolean recommendedHpet;
    10454
    10458     readonly attribute boolean recommendedUsbTablet;
    10459
    10463     readonly attribute boolean recommendedRtcUseUtc;
    10464
    10465 }; /* interface IGuestOSType */
    10466
    10480 interface IGuest : $unknown
    10481 {
    10496     readonly attribute wstring OSTypeId;
    10497
    10505     readonly attribute boolean additionsActive;
    10506
    10516     readonly attribute wstring additionsVersion;
    10517
    10524     readonly attribute boolean supportsSeamless;
    10525
    10534     readonly attribute boolean supportsGraphics;
    10535
    10539     attribute unsigned long memoryBalloonSize;
    10540
    10544     attribute boolean pageFusionEnabled;
    10545
    10549     attribute unsigned long statisticsUpdateInterval;
    10550
    10582     void internalGetStatistics (
    10583         out unsigned long cpuUser,
    10584         out unsigned long cpuKernel,
    10585         out unsigned long cpuIdle,
    10586         out unsigned long memTotal,
    10587         out unsigned long memFree,
    10588         out unsigned long memBalloon,
    10589         out unsigned long memShared,
    10590         out unsigned long memCache,
    10591         out unsigned long pagedTotal,
    10592         out unsigned long memAllocTotal,
    10593         out unsigned long memFreeTotal,
    10594         out unsigned long memBalloonTotal,
    10595         out unsigned long memSharedTotal
    10596     );
    10597
    10627     void setCredentials (
    10628         in wstring userName,
    10629         in wstring password,
    10630         in wstring domain,
    10631         in boolean allowInteractiveLogon
    10632     );
    10633
    10687     void executeProcess (
    10688         in wstring execName,
    10689         in unsigned long flags,
    10690         in wstring[] arguments,
    10691         in wstring[] environment,
    10692         in wstring userName,
    10693         in wstring password,
    10694         in unsigned long timeoutMS,
    10695         out unsigned long pid,
    10696         [retval] out IProgress progress
    10697     );
    10698
    10736     void getProcessOutput (
    10737         in unsigned long pid,
    10738         in unsigned long flags,
    10739         in unsigned long timeoutMS,
    10740         in unsigned long long size,
    10741         [retval] out octet[] data
    10742     );
    10743
    10773     void getProcessStatus (
    10774         in unsigned long pid,
    10775         out unsigned long exitcode,
    10776         out unsigned long flags,
    10777         [retval] out unsigned long reason
    10778     );
    10779
    10780 }; /* interface IGuest */
    10781
    10822 interface IProgress : $unknown
    10823 {
    10827     readonly attribute wstringUUID id;
    10828
    10832     readonly attribute wstring description;
    10833
    10837     readonly attribute $unknown initiator;
    10838
    10842     readonly attribute boolean cancelable;
    10843
    10851     readonly attribute unsigned long percent;
    10852
    10866     readonly attribute long timeRemaining;
    10867
    10871     readonly attribute boolean completed;
    10872
    10876     readonly attribute boolean canceled;
    10877
    10884     readonly attribute long resultCode;
    10885
    10895     readonly attribute IVirtualBoxErrorInfo errorInfo;
    10896
    10903     readonly attribute unsigned long operationCount;
    10904
    10908     readonly attribute unsigned long operation;
    10909
    10915     readonly attribute wstring operationDescription;
    10916
    10920     readonly attribute unsigned long operationPercent;
    10921
    10929     attribute unsigned long timeout;
    10930
    10934     void setCurrentOperationProgress (
    10935         in unsigned long percent
    10936     );
    10937
    10941     void setNextOperation (
    10942         in wstring nextOperationDescription,
    10943         in unsigned long nextOperationsWeight
    10944     );
    10945
    10964     void waitForCompletion (
    10965         in long timeout
    10966     );
    10967
    10991     void waitForOperationCompletion (
    10992         in unsigned long operation,
    10993         in long timeout
    10994     );
    10995
    11012     void cancel();
    11013
    11014 }; /* interface IProgress */
    11015
    11107 interface ISnapshot : $unknown
    11108 {
    11112     readonly attribute wstringUUID id;
    11113
    11117     attribute wstring name;
    11118
    11122     attribute wstring description;
    11123
    11129     readonly attribute long long timeStamp;
    11130
    11142     readonly attribute boolean online;
    11143
    11155     readonly attribute IMachine machine;
    11156
    11163     readonly attribute ISnapshot parent;
    11164
    11170     readonly attribute ISnapshot[] children;
    11171
    11172 }; /* interface ISnapshot */
    11173
    11189 interface IMediumAttachment : $unknown
    11190 {
    11195     readonly attribute IMedium medium;
    11196
    11202     readonly attribute wstring controller;
    11203
    11209     readonly attribute long port;
    11210
    11216     readonly attribute long device;
    11217
    11221     readonly attribute DeviceType type;
    11222
    11226     readonly attribute boolean passthrough;
    11227
    11228 }; /* interface IMediumAttachment */
    11229
    11575 interface IMedium : $unknown
    11576 {
    11590     readonly attribute wstringUUID id;
    11591
    11610     attribute wstring description;
    11611
    11627     readonly attribute MediumState state;
    11628
    11650     attribute wstring location;
    11651
    11671     readonly attribute wstring name;
    11672
    11677     readonly attribute DeviceType deviceType;
    11678
    11682     readonly attribute boolean hostDrive;
    11683
    11696     readonly attribute unsigned long long size;
    11697
    11712     readonly attribute wstring format;
    11713
    11729     readonly attribute IMediumFormat mediumFormat;
    11730
    11755     attribute MediumType type;
    11756
    11766     readonly attribute IMedium parent;
    11767
    11775     readonly attribute IMedium[] children;
    11776
    11787     readonly attribute IMedium base;
    11788
    11821     readonly attribute boolean readOnly;
    11822
    11843     readonly attribute unsigned long long logicalSize;
    11844
    11872     attribute boolean autoReset;
    11873
    11888     readonly attribute wstring lastAccessError;
    11889
    11906     readonly attribute wstringUUID[] machineIds;
    11907
    11942     void refreshState (
    11943         [retval] out MediumState state
    11944     );
    11945
    11972     void getSnapshotIds (
    11973         in wstringUUID machineId,
    11974         [retval] out wstringUUID[] snapshotIds
    11975     );
    11976
    12036     void lockRead (
    12037         [retval] out MediumState state
    12038     );
    12039
    12062     void unlockRead (
    12063         [retval] out MediumState state
    12064     );
    12065
    12120     void lockWrite (
    12121         [retval] out MediumState state
    12122     );
    12123
    12146     void unlockWrite (
    12147         [retval] out MediumState state
    12148     );
    12149
    12198     void close();
    12199
    12229     void getProperty (
    12230         in wstring name,
    12231         [retval] out wstring value
    12232     );
    12233
    12265     void setProperty (
    12266         in wstring name,
    12267         in wstring value
    12268     );
    12269
    12303     void getProperties (
    12304         in wstring names,
    12305         out wstring[] returnNames,
    12306         [retval] out wstring[] returnValues
    12307     );
    12308
    12340     void setProperties (
    12341         in wstring[] names,
    12342         in wstring[] values
    12343     );
    12344
    12376     void createBaseStorage (
    12377         in unsigned long long logicalSize,
    12378         in MediumVariant variant,
    12379         [retval] out IProgress progress
    12380     );
    12381
    12433     void deleteStorage (
    12434         [retval] out IProgress progress
    12435     );
    12436
    12474     void createDiffStorage (
    12475         in IMedium target,
    12476         in MediumVariant variant,
    12477         [retval] out IProgress progress
    12478     );
    12479
    12555     void mergeTo (
    12556         in IMedium target,
    12557         [retval] out IProgress progress
    12558     );
    12559
    12608     void cloneTo (
    12609         in IMedium target,
    12610         in MediumVariant variant,
    12611         in IMedium parent,
    12612         [retval] out IProgress progress
    12613     );
    12614
    12643     void compact (
    12644         [retval] out IProgress progress
    12645     );
    12646
    12679     void resize (
    12680         in unsigned long long logicalSize,
    12681         [retval] out IProgress progress
    12682     );
    12683
    12717     void reset (
    12718         [retval] out IProgress progress
    12719     );
    12720
    12721 }; /* interface IMedium */
    12722
    12745 interface IMediumFormat : $unknown
    12746 {
    12765     readonly attribute wstring id;
    12766
    12774     readonly attribute wstring name;
    12775
    12791     readonly attribute wstring[] fileExtensions;
    12792
    12801     readonly attribute unsigned long capabilities;
    12802
    12832     void describeProperties (
    12833         out wstring[] names,
    12834         out wstring[] description,
    12835         out DataType[] types,
    12836         out unsigned long[] flags,
    12837         out wstring[] defaults
    12838     );
    12839
    12840 }; /* interface IMediumFormat */
    12841
    12854 interface IKeyboard : $unknown
    12855 {
    12868     void putScancode (
    12869         in long scancode
    12870     );
    12871
    12884     void putScancodes (
    12885         in long[] scancodes,
    12886         [retval] out unsigned long codesStored
    12887     );
    12888
    12903     void putCAD();
    12904
    12905 }; /* interface IKeyboard */
    12906
    12918 interface IMouse : $unknown
    12919 {
    12934     readonly attribute boolean absoluteSupported;
    12935
    12950     readonly attribute boolean relativeSupported;
    12951
    12966     readonly attribute boolean needsHostCursor;
    12967
    13033     void putMouseEvent (
    13034         in long dx,
    13035         in long dy,
    13036         in long dz,
    13037         in long dw,
    13038         in long buttonState
    13039     );
    13040
    13113     void putMouseEventAbsolute (
    13114         in long x,
    13115         in long y,
    13116         in long dz,
    13117         in long dw,
    13118         in long buttonState
    13119     );
    13120
    13121 }; /* interface IMouse */
    13122
    13123 interface IFramebuffer : $unknown
    13124 {
    13133     readonly attribute octetPtr address;
    13134
    13138     readonly attribute unsigned long width;
    13139
    13143     readonly attribute unsigned long height;
    13144
    13151     readonly attribute unsigned long bitsPerPixel;
    13152
    13159     readonly attribute unsigned long bytesPerLine;
    13160
    13171     readonly attribute unsigned long pixelFormat;
    13172
    13179     readonly attribute boolean usesGuestVRAM;
    13180
    13190     readonly attribute unsigned long heightReduction;
    13191
    13206     readonly attribute IFramebufferOverlay overlay;
    13207
    13214     readonly attribute unsigned long long winId;
    13215
    13223     void lock();
    13224
    13232     void unlock();
    13233
    13241     void notifyUpdate (
    13242         in unsigned long x,
    13243         in unsigned long y,
    13244         in unsigned long width,
    13245         in unsigned long height
    13246     );
    13247
    13360     void requestResize (
    13361         in unsigned long screenId,
    13362         in unsigned long pixelFormat,
    13363         in octetPtr VRAM,
    13364         in unsigned long bitsPerPixel,
    13365         in unsigned long bytesPerLine,
    13366         in unsigned long width,
    13367         in unsigned long height,
    13368         [retval] out boolean finished
    13369     );
    13370
    13382     void videoModeSupported (
    13383         in unsigned long width,
    13384         in unsigned long height,
    13385         in unsigned long bpp,
    13386         [retval] out boolean supported
    13387     );
    13388
    13425     void getVisibleRegion (
    13426         in octetPtr rectangles,
    13427         in unsigned long count,
    13428         [retval] out unsigned long countCopied
    13429     );
    13430
    13465     void setVisibleRegion (
    13466         in octetPtr rectangles,
    13467         in unsigned long count
    13468     );
    13469
    13490     void processVHWACommand (
    13491         in octetPtr command
    13492     );
    13493
    13494 }; /* interface IFramebuffer */
    13495
    13510 interface IFramebufferOverlay : IFramebuffer
    13511 {
    13515     readonly attribute unsigned long x;
    13516
    13520     readonly attribute unsigned long y;
    13521
    13527     attribute boolean visible;
    13528
    13535     attribute unsigned long alpha;
    13536
    13542     void move (
    13543         in unsigned long x,
    13544         in unsigned long y
    13545     );
    13546
    13547 }; /* interface IFramebufferOverlay */
    13548
    13564 interface IDisplay : $unknown
    13565 {
    13569     void getScreenResolution (
    13570         in unsigned long screenId,
    13571         out unsigned long width,
    13572         out unsigned long height,
    13573         out unsigned long bitsPerPixel
    13574     );
    13575
    13581     void setFramebuffer (
    13582         in unsigned long screenId,
    13583         in IFramebuffer framebuffer
    13584     );
    13585
    13591     void getFramebuffer (
    13592         in unsigned long screenId,
    13593         out IFramebuffer framebuffer,
    13594         out long xOrigin,
    13595         out long yOrigin
    13596     );
    13597
    13626     void setVideoModeHint (
    13627         in unsigned long width,
    13628         in unsigned long height,
    13629         in unsigned long bitsPerPixel,
    13630         in unsigned long display
    13631     );
    13632
    13643     void setSeamlessMode (
    13644         in boolean enabled
    13645     );
    13646
    13680     void takeScreenShot (
    13681         in unsigned long screenId,
    13682         in octetPtr address,
    13683         in unsigned long width,
    13684         in unsigned long height
    13685     );
    13686
    13730     void takeScreenShotToArray (
    13731         in unsigned long screenId,
    13732         in unsigned long width,
    13733         in unsigned long height,
    13734         [retval] out octet[] screenData
    13735     );
    13736
    13768     void drawToScreen (
    13769         in unsigned long screenId,
    13770         in octetPtr address,
    13771         in unsigned long x,
    13772         in unsigned long y,
    13773         in unsigned long width,
    13774         in unsigned long height
    13775     );
    13776
    13791     void invalidateAndUpdate();
    13792
    13806     void resizeCompleted (
    13807         in unsigned long screenId
    13808     );
    13809
    13822     void completeVHWACommand (
    13823         in octetPtr command
    13824     );
    13825
    13826 }; /* interface IDisplay */
    13827
    13843 interface INetworkAdapter : $unknown
    13844 {
    13852     attribute NetworkAdapterType adapterType;
    13853
    13861     readonly attribute unsigned long slot;
    13862
    13871     attribute boolean enabled;
    13872
    13879     attribute wstring MACAddress;
    13880
    13881     readonly attribute NetworkAttachmentType attachmentType;
    13882
    13888     attribute wstring hostInterface;
    13889
    13895     attribute wstring internalNetwork;
    13896
    13902     attribute wstring NATNetwork;
    13903
    13909     attribute wstring VDENetwork;
    13910
    13917     attribute boolean cableConnected;
    13918
    13924     attribute unsigned long lineSpeed;
    13925
    13932     attribute boolean traceEnabled;
    13933
    13940     attribute wstring traceFile;
    13941
    13949     readonly attribute INATEngine natDriver;
    13950
    13957     attribute unsigned long bootPriority;
    13958
    13964     void attachToNAT();
    13965
    13971     void attachToBridgedInterface();
    13972
    13978     void attachToInternalNetwork();
    13979
    13985     void attachToHostOnlyInterface();
    13986
    13992     void attachToVDE();
    13993
    13999     void detach();
    14000
    14001 }; /* interface INetworkAdapter */
    14002
    14031 interface ISerialPort : $unknown
    14032 {
    14040     readonly attribute unsigned long slot;
    14041
    14048     attribute boolean enabled;
    14049
    14053     attribute unsigned long IOBase;
    14054
    14058     attribute unsigned long IRQ;
    14059
    14070     attribute PortMode hostMode;
    14071
    14079     attribute boolean server;
    14080
    14090     attribute wstring path;
    14091
    14092 }; /* interface ISerialPort */
    14093
    14113 interface IParallelPort : $unknown
    14114 {
    14122     readonly attribute unsigned long slot;
    14123
    14130     attribute boolean enabled;
    14131
    14135     attribute unsigned long IOBase;
    14136
    14140     attribute unsigned long IRQ;
    14141
    14149     attribute wstring path;
    14150
    14151 }; /* interface IParallelPort */
    14152
    14153 interface IMachineDebugger : $unknown
    14154 {
    14158     attribute boolean singlestep;
    14159
    14163     attribute boolean recompileUser;
    14164
    14168     attribute boolean recompileSupervisor;
    14169
    14173     attribute boolean PATMEnabled;
    14174
    14178     attribute boolean CSAMEnabled;
    14179
    14183     attribute boolean logEnabled;
    14184
    14191     readonly attribute boolean HWVirtExEnabled;
    14192
    14199     readonly attribute boolean HWVirtExNestedPagingEnabled;
    14200
    14207     readonly attribute boolean HWVirtExVPIDEnabled;
    14208
    14215     readonly attribute boolean PAEEnabled;
    14216
    14223     attribute unsigned long virtualTimeRate;
    14224
    14231     readonly attribute unsigned long long VM;
    14232
    14240     void resetStats (
    14241         in wstring pattern
    14242     );
    14243
    14251     void dumpStats (
    14252         in wstring pattern
    14253     );
    14254
    14266     void getStats (
    14267         in wstring pattern,
    14268         in boolean withDescriptions,
    14269         out wstring stats
    14270     );
    14271
    14277     void injectNMI();
    14278
    14279 }; /* interface IMachineDebugger */
    14280
    14281 interface IUSBController : $unknown
    14282 {
    14291     attribute boolean enabled;
    14292
    14301     attribute boolean enabledEhci;
    14302
    14308     readonly attribute boolean proxyAvailable;
    14309
    14317     readonly attribute unsigned short USBStandard;
    14318
    14344     readonly attribute IUSBDeviceFilter[] deviceFilters;
    14345
    14373     void createDeviceFilter (
    14374         in wstring name,
    14375         [retval] out IUSBDeviceFilter filter
    14376     );
    14377
    14422     void insertDeviceFilter (
    14423         in unsigned long position,
    14424         in IUSBDeviceFilter filter
    14425     );
    14426
    14459     void removeDeviceFilter (
    14460         in unsigned long position,
    14461         [retval] out IUSBDeviceFilter filter
    14462     );
    14463
    14464 }; /* interface IUSBController */
    14465
    14478 interface IUSBDevice : $unknown
    14479 {
    14486     readonly attribute wstringUUID id;
    14487
    14491     readonly attribute unsigned short vendorId;
    14492
    14496     readonly attribute unsigned short productId;
    14497
    14505     readonly attribute unsigned short revision;
    14506
    14510     readonly attribute wstring manufacturer;
    14511
    14515     readonly attribute wstring product;
    14516
    14520     readonly attribute wstring serialNumber;
    14521
    14525     readonly attribute wstring address;
    14526
    14533     readonly attribute unsigned short port;
    14534
    14540     readonly attribute unsigned short version;
    14541
    14549     readonly attribute unsigned short portVersion;
    14550
    14557     readonly attribute boolean remote;
    14558
    14559 }; /* interface IUSBDevice */
    14560
    14634 interface IUSBDeviceFilter : $unknown
    14635 {
    14643     attribute wstring name;
    14644
    14648     attribute boolean active;
    14649
    14657     attribute wstring vendorId;
    14658
    14666     attribute wstring productId;
    14667
    14681     attribute wstring revision;
    14682
    14687     attribute wstring manufacturer;
    14688
    14693     attribute wstring product;
    14694
    14699     attribute wstring serialNumber;
    14700
    14705     attribute wstring port;
    14706
    14716     attribute wstring remote;
    14717
    14727     attribute unsigned long maskedInterfaces;
    14728
    14729 }; /* interface IUSBDeviceFilter */
    14730
    14746 interface IHostUSBDevice : IUSBDevice
    14747 {
    14753     readonly attribute USBDeviceState state;
    14754
    14755 }; /* interface IHostUSBDevice */
    14756
    14779 interface IHostUSBDeviceFilter : IUSBDeviceFilter
    14780 {
    14787     attribute USBDeviceFilterAction action;
    14788
    14789 }; /* interface IHostUSBDeviceFilter */
    14790
    14799 interface IAudioAdapter : $unknown
    14800 {
    14809     attribute boolean enabled;
    14810
    14816     attribute AudioControllerType audioController;
    14817
    14824     attribute AudioDriverType audioDriver;
    14825
    14826 }; /* interface IAudioAdapter */
    14827
    14828 interface IVRDPServer : $unknown
    14829 {
    14833     attribute boolean enabled;
    14834
    14844     attribute wstring ports;
    14845
    14849     attribute wstring netAddress;
    14850
    14854     attribute VRDPAuthType authType;
    14855
    14859     attribute unsigned long authTimeout;
    14860
    14867     attribute boolean allowMultiConnection;
    14868
    14876     attribute boolean reuseSingleConnection;
    14877
    14883     attribute boolean videoChannel;
    14884
    14890     attribute unsigned long videoChannelQuality;
    14891
    14892 }; /* interface IVRDPServer */
    14893
    14951 interface ISharedFolder : $unknown
    14952 {
    14956     readonly attribute wstring name;
    14957
    14961     readonly attribute wstring hostPath;
    14962
    14972     readonly attribute boolean accessible;
    14973
    14980     readonly attribute boolean writable;
    14981
    14994     readonly attribute wstring lastAccessError;
    14995
    14996 }; /* interface ISharedFolder */
    14997
    14998 interface IInternalSessionControl : $unknown
    14999 {
    15004     void getPID (
    15005         [retval] out unsigned long pid
    15006     );
    15007
    15029     void getRemoteConsole (
    15030         [retval] out IConsole console
    15031     );
    15032
    15056     void assignMachine (
    15057         in IMachine machine
    15058     );
    15059
    15074     void assignRemoteMachine (
    15075         in IMachine machine,
    15076         in IConsole console
    15077     );
    15078
    15102     void updateMachineState (
    15103         in MachineState aMachineState
    15104     );
    15105
    15121     void uninitialize();
    15122
    15145     void onNetworkAdapterChange (
    15146         in INetworkAdapter networkAdapter,
    15147         in boolean changeAdapter
    15148     );
    15149
    15172     void onSerialPortChange (
    15173         in ISerialPort serialPort
    15174     );
    15175
    15198     void onParallelPortChange (
    15199         in IParallelPort parallelPort
    15200     );
    15201
    15224     void onStorageControllerChange();
    15225
    15248     void onMediumChange (
    15249         in IMediumAttachment mediumAttachment,
    15250         in boolean force
    15251     );
    15252
    15262     void onCPUChange (
    15263         in unsigned long cpu,
    15264         in boolean add
    15265     );
    15266
    15291     void onVRDPServerChange (
    15292         in boolean restart
    15293     );
    15294
    15317     void onUSBControllerChange();
    15318
    15347     void onSharedFolderChange (
    15348         in boolean global
    15349     );
    15350
    15376     void onUSBDeviceAttach (
    15377         in IUSBDevice device,
    15378         in IVirtualBoxErrorInfo error,
    15379         in unsigned long maskedInterfaces
    15380     );
    15381
    15407     void onUSBDeviceDetach (
    15408         in wstringUUID id,
    15409         in IVirtualBoxErrorInfo error
    15410     );
    15411
    15429     void onShowWindow (
    15430         in boolean check,
    15431         out boolean canShow,
    15432         out unsigned long long winId
    15433     );
    15434
    15458     void accessGuestProperty (
    15459         in wstring name,
    15460         in wstring value,
    15461         in wstring flags,
    15462         in boolean isSetter,
    15463         out wstring retValue,
    15464         out unsigned long long retTimestamp,
    15465         out wstring retFlags
    15466     );
    15467
    15515     void enumerateGuestProperties (
    15516         in wstring patterns,
    15517         out wstring[] key,
    15518         out wstring[] value,
    15519         out unsigned long long[] timestamp,
    15520         out wstring[] flags
    15521     );
    15522
    15568     void onlineMergeMedium (
    15569         in IMediumAttachment mediumAttachment,
    15570         in unsigned long sourceIdx,
    15571         in unsigned long targetIdx,
    15572         in IMedium source,
    15573         in IMedium target,
    15574         in boolean mergeForward,
    15575         in IMedium parentForTarget,
    15576         in IMedium[] childrenToReparent,
    15577         in IProgress progress
    15578     );
    15579
    15580 }; /* interface IInternalSessionControl */
    15581
    15658 interface ISession : $unknown
    15659 {
    15663     readonly attribute SessionState state;
    15664
    15672     readonly attribute SessionType type;
    15673
    15677     readonly attribute IMachine machine;
    15678
    15682     readonly attribute IConsole console;
    15683
    15724     void close();
    15725
    15726 }; /* interface ISession */
    15727
    15750 interface IStorageController : $unknown
    15751 {
    15760     readonly attribute wstring name;
    15761
    15767     readonly attribute unsigned long maxDevicesPerPortCount;
    15768
    15774     readonly attribute unsigned long minPortCount;
    15775
    15781     readonly attribute unsigned long maxPortCount;
    15782
    15788     attribute unsigned long instance;
    15789
    15798     attribute unsigned long portCount;
    15799
    15805     readonly attribute StorageBus bus;
    15806
    15819     attribute StorageControllerType controllerType;
    15820
    15835     attribute boolean useHostIOCache;
    15836
    15859     void getIDEEmulationPort (
    15860         in long devicePosition,
    15861         [retval] out long portNumber
    15862     );
    15863
    15887     void setIDEEmulationPort (
    15888         in long devicePosition,
    15889         in long portNumber
    15890     );
    15891
    15892 }; /* interface IStorageController */
    15893
    15917 interface IManagedObjectRef : $unknown
    15918 {
    15925     void getInterfaceName (
    15926         [retval] out wstring return
    15927     );
    15928
    15936     void release();
    15937
    15938 }; /* interface IManagedObjectRef */
    15939
    15948 interface IWebsessionManager : $unknown
    15949 {
    15958     void logon (
    15959         in wstring username,
    15960         in wstring password,
    15961         [retval] out IVirtualBox return
    15962     );
    15963
    15973     void getSessionObject (
    15974         in IVirtualBox refIVirtualBox,
    15975         [retval] out ISession return
    15976     );
    15977
    15985     void logoff (
    15986         in IVirtualBox refIVirtualBox
    15987     );
    15988
    15989 }; /* interface IWebsessionManager */
    15990
    15999 interface IPerformanceMetric : $unknown
    16000 {
    16006     readonly attribute wstring metricName;
    16007
    16013     readonly attribute $unknown object;
    16014
    16020     readonly attribute wstring description;
    16021
    16027     readonly attribute unsigned long period;
    16028
    16038     readonly attribute unsigned long count;
    16039
    16045     readonly attribute wstring unit;
    16046
    16052     readonly attribute long minimumValue;
    16053
    16059     readonly attribute long maximumValue;
    16060
    16061 }; /* interface IPerformanceMetric */
    16062
    16168 interface IPerformanceCollector : $unknown
    16169 {
    16180     readonly attribute wstring[] metricNames;
    16181
    16205     void getMetrics (
    16206         in wstring[] metricNames,
    16207         in $unknown[] objects,
    16208         [retval] out IPerformanceMetric[] metrics
    16209     );
    16210
    16249     void setupMetrics (
    16250         in wstring[] metricNames,
    16251         in $unknown[] objects,
    16252         in unsigned long period,
    16253         in unsigned long count,
    16254         [retval] out IPerformanceMetric[] affectedMetrics
    16255     );
    16256
    16285     void enableMetrics (
    16286         in wstring[] metricNames,
    16287         in $unknown[] objects,
    16288         [retval] out IPerformanceMetric[] affectedMetrics
    16289     );
    16290
    16319     void disableMetrics (
    16320         in wstring[] metricNames,
    16321         in $unknown[] objects,
    16322         [retval] out IPerformanceMetric[] affectedMetrics
    16323     );
    16324
    16413     void queryMetricsData (
    16414         in wstring[] metricNames,
    16415         in $unknown[] objects,
    16416         out wstring[] returnMetricNames,
    16417         out $unknown[] returnObjects,
    16418         out wstring[] returnUnits,
    16419         out unsigned long[] returnScales,
    16420         out unsigned long[] returnSequenceNumbers,
    16421         out unsigned long[] returnDataIndices,
    16422         out unsigned long[] returnDataLengths,
    16423         [retval] out long[] returnData
    16424     );
    16425
    16426 }; /* interface IPerformanceCollector */
    16427
    16435 interface INATEngine : $unknown
    16436 {
    16441     attribute wstring network;
    16442
    16449     attribute wstring hostIP;
    16450
    16455     attribute wstring tftpPrefix;
    16456
    16461     attribute wstring tftpBootFile;
    16462
    16470     attribute wstring tftpNextServer;
    16471
    16475     attribute unsigned long aliasMode;
    16476
    16480     attribute boolean dnsPassDomain;
    16481
    16486     attribute boolean dnsProxy;
    16487
    16492     attribute boolean dnsUseHostResolver;
    16493
    16498     readonly attribute wstring[] redirects;
    16499
    16515     void setNetworkSettings (
    16516         in unsigned long mtu,
    16517         in unsigned long sockSnd,
    16518         in unsigned long sockRcv,
    16519         in unsigned long TcpWndSnd,
    16520         in unsigned long TcpWndRcv
    16521     );
    16522
    16527     void getNetworkSettings (
    16528         out unsigned long mtu,
    16529         out unsigned long sockSnd,
    16530         out unsigned long sockRcv,
    16531         out unsigned long TcpWndSnd,
    16532         out unsigned long TcpWndRcv
    16533     );
    16534
    16554     void addRedirect (
    16555         in wstring name,
    16556         in NATProtocol proto,
    16557         in wstring hostIp,
    16558         in unsigned short hostPort,
    16559         in wstring guestIp,
    16560         in unsigned short guestPort
    16561     );
    16562
    16568     void removeRedirect (
    16569         in wstring name
    16570     );
    16571
    16572 }; /* interface INATEngine */
    16573
    16574