- 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 enum SettingsVersion
    00228 {
    00233     SettingsVersion_Null = 0,
    00238     SettingsVersion_v1_0 = 1,
    00243     SettingsVersion_v1_1 = 2,
    00248     SettingsVersion_v1_2 = 3,
    00253     SettingsVersion_v1_3pre = 4,
    00258     SettingsVersion_v1_3 = 5,
    00263     SettingsVersion_v1_4 = 6,
    00268     SettingsVersion_v1_5 = 7,
    00273     SettingsVersion_v1_6 = 8,
    00278     SettingsVersion_v1_7 = 9,
    00283     SettingsVersion_v1_8 = 10,
    00288     SettingsVersion_v1_9 = 11,
    00293     SettingsVersion_Future = 12,
    00294 };
    00295
    00303 enum AccessMode
    00304 {
    00305     AccessMode_ReadOnly = 1,
    00306     AccessMode_ReadWrite = 2,
    00307 };
    00308
    00426 enum MachineState
    00427 {
    00432     MachineState_Null = 0,
    00440     MachineState_PoweredOff = 1,
    00449     MachineState_Saved = 2,
    00458     MachineState_Teleported = 3,
    00467     MachineState_Aborted = 4,
    00474     MachineState_Running = 5,
    00481     MachineState_Paused = 6,
    00489     MachineState_Stuck = 7,
    00499     MachineState_Teleporting = 8,
    00510     MachineState_LiveSnapshotting = 9,
    00518     MachineState_Starting = 10,
    00526     MachineState_Stopping = 11,
    00534     MachineState_Saving = 12,
    00542     MachineState_Restoring = 13,
    00551     MachineState_TeleportingPausedVM = 14,
    00558     MachineState_TeleportingIn = 15,
    00565     MachineState_RestoringSnapshot = 16,
    00573     MachineState_DeletingSnapshot = 17,
    00580     MachineState_SettingUp = 18,
    00587     MachineState_FirstOnline = 5,
    00594     MachineState_LastOnline = 13,
    00601     MachineState_FirstTransient = 8,
    00608     MachineState_LastTransient = 18,
    00609 };
    00610
    00621 enum SessionState
    00622 {
    00627     SessionState_Null = 0,
    00635     SessionState_Closed = 1,
    00643     SessionState_Open = 2,
    00654     SessionState_Spawning = 3,
    00662     SessionState_Closing = 4,
    00663 };
    00664
    00673 enum CpuPropertyType
    00674 {
    00679     CpuPropertyType_Null = 0,
    00688     CpuPropertyType_PAE = 1,
    00696     CpuPropertyType_Synthetic = 2,
    00697 };
    00698
    00708 enum HWVirtExPropertyType
    00709 {
    00714     HWVirtExPropertyType_Null = 0,
    00722     HWVirtExPropertyType_Enabled = 1,
    00731     HWVirtExPropertyType_Exclusive = 2,
    00738     HWVirtExPropertyType_VPID = 3,
    00745     HWVirtExPropertyType_NestedPaging = 4,
    00746 };
    00747
    00756 enum SessionType
    00757 {
    00762     SessionType_Null = 0,
    00770     SessionType_Direct = 1,
    00778     SessionType_Remote = 2,
    00786     SessionType_Existing = 3,
    00787 };
    00788
    00796 enum DeviceType
    00797 {
    00805     DeviceType_Null = 0,
    00810     DeviceType_Floppy = 1,
    00815     DeviceType_DVD = 2,
    00820     DeviceType_HardDisk = 3,
    00825     DeviceType_Network = 4,
    00830     DeviceType_USB = 5,
    00835     DeviceType_SharedFolder = 6,
    00836 };
    00837
    00845 enum DeviceActivity
    00846 {
    00847     DeviceActivity_Null = 0,
    00848     DeviceActivity_Idle = 1,
    00849     DeviceActivity_Reading = 2,
    00850     DeviceActivity_Writing = 3,
    00851 };
    00852
    00860 enum ClipboardMode
    00861 {
    00862     ClipboardMode_Disabled = 0,
    00863     ClipboardMode_HostToGuest = 1,
    00864     ClipboardMode_GuestToHost = 2,
    00865     ClipboardMode_Bidirectional = 3,
    00866 };
    00867
    00878 enum Scope
    00879 {
    00880     Scope_Global = 0,
    00881     Scope_Machine = 1,
    00882     Scope_Session = 2,
    00883 };
    00884
    00892 enum GuestStatisticType
    00893 {
    00900     GuestStatisticType_CPULoad_Idle = 0,
    00907     GuestStatisticType_CPULoad_Kernel = 1,
    00914     GuestStatisticType_CPULoad_User = 2,
    00921     GuestStatisticType_Threads = 3,
    00928     GuestStatisticType_Processes = 4,
    00935     GuestStatisticType_Handles = 5,
    00942     GuestStatisticType_MemoryLoad = 6,
    00949     GuestStatisticType_PhysMemTotal = 7,
    00956     GuestStatisticType_PhysMemAvailable = 8,
    00963     GuestStatisticType_PhysMemBalloon = 9,
    00970     GuestStatisticType_MemCommitTotal = 10,
    00977     GuestStatisticType_MemKernelTotal = 11,
    00984     GuestStatisticType_MemKernelPaged = 12,
    00991     GuestStatisticType_MemKernelNonpaged = 13,
    00998     GuestStatisticType_MemSystemCache = 14,
    01005     GuestStatisticType_PageFileSize = 15,
    01012     GuestStatisticType_SampleNumber = 16,
    01013     GuestStatisticType_MaxVal = 17,
    01014 };
    01015
    01023 enum BIOSBootMenuMode
    01024 {
    01025     BIOSBootMenuMode_Disabled = 0,
    01026     BIOSBootMenuMode_MenuOnly = 1,
    01027     BIOSBootMenuMode_MessageAndMenu = 2,
    01028 };
    01029
    01037 enum ProcessorFeature
    01038 {
    01039     ProcessorFeature_HWVirtEx = 0,
    01040     ProcessorFeature_PAE = 1,
    01041     ProcessorFeature_LongMode = 2,
    01042     ProcessorFeature_NestedPaging = 3,
    01043 };
    01044
    01052 enum FirmwareType
    01053 {
    01058     FirmwareType_BIOS = 1,
    01063     FirmwareType_EFI = 2,
    01068     FirmwareType_EFI32 = 3,
    01073     FirmwareType_EFI64 = 4,
    01078     FirmwareType_EFIDUAL = 5,
    01079 };
    01080
    01088 enum VFSType
    01089 {
    01090     VFSType_File = 1,
    01091     VFSType_Cloud = 2,
    01092     VFSType_S3 = 3,
    01093     VFSType_WebDav = 4,
    01094 };
    01095
    01103 enum VFSFileType
    01104 {
    01105     VFSFileType_Unknown = 1,
    01106     VFSFileType_Fifo = 2,
    01107     VFSFileType_DevChar = 3,
    01108     VFSFileType_Directory = 4,
    01109     VFSFileType_DevBlock = 5,
    01110     VFSFileType_File = 6,
    01111     VFSFileType_SymLink = 7,
    01112     VFSFileType_Socket = 8,
    01113     VFSFileType_WhiteOut = 9,
    01114 };
    01115
    01122 enum VirtualSystemDescriptionType
    01123 {
    01124     VirtualSystemDescriptionType_Ignore = 1,
    01125     VirtualSystemDescriptionType_OS = 2,
    01126     VirtualSystemDescriptionType_Name = 3,
    01127     VirtualSystemDescriptionType_Product = 4,
    01128     VirtualSystemDescriptionType_Vendor = 5,
    01129     VirtualSystemDescriptionType_Version = 6,
    01130     VirtualSystemDescriptionType_ProductUrl = 7,
    01131     VirtualSystemDescriptionType_VendorUrl = 8,
    01132     VirtualSystemDescriptionType_Description = 9,
    01133     VirtualSystemDescriptionType_License = 10,
    01134     VirtualSystemDescriptionType_Miscellaneous = 11,
    01135     VirtualSystemDescriptionType_CPU = 12,
    01136     VirtualSystemDescriptionType_Memory = 13,
    01137     VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
    01138     VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
    01139     VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
    01140     VirtualSystemDescriptionType_HardDiskImage = 17,
    01141     VirtualSystemDescriptionType_Floppy = 18,
    01142     VirtualSystemDescriptionType_CDROM = 19,
    01143     VirtualSystemDescriptionType_NetworkAdapter = 20,
    01144     VirtualSystemDescriptionType_USBController = 21,
    01145     VirtualSystemDescriptionType_SoundCard = 22,
    01146 };
    01147
    01154 enum VirtualSystemDescriptionValueType
    01155 {
    01156     VirtualSystemDescriptionValueType_Reference = 1,
    01157     VirtualSystemDescriptionValueType_Original = 2,
    01158     VirtualSystemDescriptionValueType_Auto = 3,
    01159     VirtualSystemDescriptionValueType_ExtraConfig = 4,
    01160 };
    01161
    01172 enum HostNetworkInterfaceMediumType
    01173 {
    01180     HostNetworkInterfaceMediumType_Unknown = 0,
    01187     HostNetworkInterfaceMediumType_Ethernet = 1,
    01194     HostNetworkInterfaceMediumType_PPP = 2,
    01201     HostNetworkInterfaceMediumType_SLIP = 3,
    01202 };
    01203
    01213 enum HostNetworkInterfaceStatus
    01214 {
    01221     HostNetworkInterfaceStatus_Unknown = 0,
    01228     HostNetworkInterfaceStatus_Up = 1,
    01235     HostNetworkInterfaceStatus_Down = 2,
    01236 };
    01237
    01245 enum HostNetworkInterfaceType
    01246 {
    01247     HostNetworkInterfaceType_Bridged = 1,
    01248     HostNetworkInterfaceType_HostOnly = 2,
    01249 };
    01250
    01260 enum MediumState
    01261 {
    01269     MediumState_NotCreated = 0,
    01278     MediumState_Created = 1,
    01286     MediumState_LockedRead = 2,
    01294     MediumState_LockedWrite = 3,
    01304     MediumState_Inaccessible = 4,
    01311     MediumState_Creating = 5,
    01318     MediumState_Deleting = 6,
    01319 };
    01320
    01330 enum MediumType
    01331 {
    01339     MediumType_Normal = 0,
    01347     MediumType_Immutable = 1,
    01355     MediumType_Writethrough = 2,
    01356 };
    01357
    01367 enum MediumVariant
    01368 {
    01375     MediumVariant_Standard = 0,
    01382     MediumVariant_VmdkSplit2G = 0x01,
    01390     MediumVariant_VmdkStreamOptimized = 0x04,
    01397     MediumVariant_VmdkESX = 0x08,
    01404     MediumVariant_Fixed = 0x10000,
    01411     MediumVariant_Diff = 0x20000,
    01412 };
    01413
    01414 enum DataType
    01415 {
    01416     DataType_Int32 = 0,
    01417     DataType_Int8 = 1,
    01418     DataType_String = 2,
    01419 };
    01420
    01421 enum DataFlags
    01422 {
    01423     DataFlags_None = 0x00,
    01424     DataFlags_Mandatory = 0x01,
    01425     DataFlags_Expert = 0x02,
    01426     DataFlags_Array = 0x04,
    01427     DataFlags_FlagMask = 0x07,
    01428 };
    01429
    01437 enum MediumFormatCapabilities
    01438 {
    01445     MediumFormatCapabilities_Uuid = 0x01,
    01452     MediumFormatCapabilities_CreateFixed = 0x02,
    01460     MediumFormatCapabilities_CreateDynamic = 0x04,
    01467     MediumFormatCapabilities_CreateSplit2G = 0x08,
    01474     MediumFormatCapabilities_Differencing = 0x10,
    01481     MediumFormatCapabilities_Asynchronous = 0x20,
    01491     MediumFormatCapabilities_File = 0x40,
    01500     MediumFormatCapabilities_Properties = 0x80,
    01501     MediumFormatCapabilities_CapabilityMask = 0xFF,
    01502 };
    01503
    01511 enum MouseButtonState
    01512 {
    01513     MouseButtonState_LeftButton = 0x01,
    01514     MouseButtonState_RightButton = 0x02,
    01515     MouseButtonState_MiddleButton = 0x04,
    01516     MouseButtonState_WheelUp = 0x08,
    01517     MouseButtonState_WheelDown = 0x10,
    01518     MouseButtonState_XButton1 = 0x20,
    01519     MouseButtonState_XButton2 = 0x40,
    01520     MouseButtonState_MouseStateMask = 0x7F,
    01521 };
    01522
    01533 enum FramebufferPixelFormat
    01534 {
    01542     FramebufferPixelFormat_Opaque = 0,
    01550     FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
    01551 };
    01552
    01560 enum NetworkAttachmentType
    01561 {
    01566     NetworkAttachmentType_Null = 0,
    01567     NetworkAttachmentType_NAT = 1,
    01568     NetworkAttachmentType_Bridged = 2,
    01569     NetworkAttachmentType_Internal = 3,
    01570     NetworkAttachmentType_HostOnly = 4,
    01571 };
    01572
    01580 enum NetworkAdapterType
    01581 {
    01586     NetworkAdapterType_Null = 0,
    01591     NetworkAdapterType_Am79C970A = 1,
    01596     NetworkAdapterType_Am79C973 = 2,
    01601     NetworkAdapterType_I82540EM = 3,
    01606     NetworkAdapterType_I82543GC = 4,
    01611     NetworkAdapterType_I82545EM = 5,
    01616     NetworkAdapterType_Virtio = 6,
    01617 };
    01618
    01627 enum PortMode
    01628 {
    01633     PortMode_Disconnected = 0,
    01638     PortMode_HostPipe = 1,
    01643     PortMode_HostDevice = 2,
    01648     PortMode_RawFile = 3,
    01649 };
    01650
    01689 enum USBDeviceState
    01690 {
    01697     USBDeviceState_NotSupported = 0,
    01705     USBDeviceState_Unavailable = 1,
    01712     USBDeviceState_Busy = 2,
    01720     USBDeviceState_Available = 3,
    01728     USBDeviceState_Held = 4,
    01736     USBDeviceState_Captured = 5,
    01737 };
    01738
    01748 enum USBDeviceFilterAction
    01749 {
    01754     USBDeviceFilterAction_Null = 0,
    01759     USBDeviceFilterAction_Ignore = 1,
    01764     USBDeviceFilterAction_Hold = 2,
    01765 };
    01766
    01774 enum AudioDriverType
    01775 {
    01780     AudioDriverType_Null = 0,
    01785     AudioDriverType_WinMM = 1,
    01790     AudioDriverType_OSS = 2,
    01795     AudioDriverType_ALSA = 3,
    01800     AudioDriverType_DirectSound = 4,
    01805     AudioDriverType_CoreAudio = 5,
    01810     AudioDriverType_MMPM = 6,
    01815     AudioDriverType_Pulse = 7,
    01820     AudioDriverType_SolAudio = 8,
    01821 };
    01822
    01830 enum AudioControllerType
    01831 {
    01832     AudioControllerType_AC97 = 0,
    01833     AudioControllerType_SB16 = 1,
    01834 };
    01835
    01843 enum VRDPAuthType
    01844 {
    01849     VRDPAuthType_Null = 0,
    01850     VRDPAuthType_External = 1,
    01851     VRDPAuthType_Guest = 2,
    01852 };
    01853
    01862 enum StorageBus
    01863 {
    01868     StorageBus_Null = 0,
    01869     StorageBus_IDE = 1,
    01870     StorageBus_SATA = 2,
    01871     StorageBus_SCSI = 3,
    01872     StorageBus_Floppy = 4,
    01873 };
    01874
    01883 enum StorageControllerType
    01884 {
    01889     StorageControllerType_Null = 0,
    01894     StorageControllerType_LsiLogic = 1,
    01899     StorageControllerType_BusLogic = 2,
    01904     StorageControllerType_IntelAhci = 3,
    01909     StorageControllerType_PIIX3 = 4,
    01914     StorageControllerType_PIIX4 = 5,
    01919     StorageControllerType_ICH6 = 6,
    01924     StorageControllerType_I82078 = 7,
    01925 };
    01926
    01959 interface IVirtualBoxErrorInfo : $errorinfo
    01960 {
    01978     readonly attribute long resultCode;
    01979
    01991     readonly attribute wstringUUID interfaceID;
    01992
    02003     readonly attribute wstring component;
    02004
    02015     readonly attribute wstring text;
    02016
    02027     readonly attribute IVirtualBoxErrorInfo next;
    02028
    02029 }; /* interface IVirtualBoxErrorInfo */
    02030
    02043 interface ILocalOwner : $dispatched
    02044 {
    02053     void setLocalObject (
    02054         in $unknown object
    02055     );
    02056
    02057 }; /* interface ILocalOwner */
    02058
    02059 interface IVirtualBoxCallback : $unknown
    02060 {
    02072     void onMachineStateChange (
    02073         in wstringUUID machineId,
    02074         in MachineState state
    02075     );
    02076
    02084     void onMachineDataChange (
    02085         in wstringUUID machineId
    02086     );
    02087
    02118     void onExtraDataCanChange (
    02119         in wstringUUID machineId,
    02120         in wstring key,
    02121         in wstring value,
    02122         out wstring error,
    02123         [retval] out boolean allowChange
    02124     );
    02125
    02145     void onExtraDataChange (
    02146         in wstringUUID machineId,
    02147         in wstring key,
    02148         in wstring value
    02149     );
    02150
    02188     void onMediumRegistered (
    02189         in wstringUUID mediumId,
    02190         in DeviceType mediumType,
    02191         in boolean registered
    02192     );
    02193
    02207     void onMachineRegistered (
    02208         in wstringUUID machineId,
    02209         in boolean registered
    02210     );
    02211
    02223     void onSessionStateChange (
    02224         in wstringUUID machineId,
    02225         in SessionState state
    02226     );
    02227
    02239     void onSnapshotTaken (
    02240         in wstringUUID machineId,
    02241         in wstringUUID snapshotId
    02242     );
    02243
    02265     void onSnapshotDiscarded (
    02266         in wstringUUID machineId,
    02267         in wstringUUID snapshotId
    02268     );
    02269
    02281     void onSnapshotChange (
    02282         in wstringUUID machineId,
    02283         in wstringUUID snapshotId
    02284     );
    02285
    02307     void onGuestPropertyChange (
    02308         in wstringUUID machineId,
    02309         in wstring name,
    02310         in wstring value,
    02311         in wstring flags
    02312     );
    02313
    02314 }; /* interface IVirtualBoxCallback */
    02315
    02326 interface IDHCPServer : $unknown
    02327 {
    02333     attribute boolean enabled;
    02334
    02340     readonly attribute wstring IPAddress;
    02341
    02347     readonly attribute wstring networkMask;
    02348
    02354     readonly attribute wstring networkName;
    02355
    02361     readonly attribute wstring lowerIP;
    02362
    02368     readonly attribute wstring upperIP;
    02369
    02398     void setConfiguration (
    02399         in wstring IPAddress,
    02400         in wstring networkMask,
    02401         in wstring FromIPAddress,
    02402         in wstring ToIPAddress
    02403     );
    02404
    02429     void start (
    02430         in wstring networkName,
    02431         in wstring trunkName,
    02432         in wstring trunkType
    02433     );
    02434
    02447     void stop();
    02448
    02449 }; /* interface IDHCPServer */
    02450
    02469 interface IVirtualBox : $dispatched
    02470 {
    02478     readonly attribute wstring version;
    02479
    02485     readonly attribute unsigned long revision;
    02486
    02496     readonly attribute wstring packageType;
    02497
    02513     readonly attribute wstring homeFolder;
    02514
    02522     readonly attribute wstring settingsFilePath;
    02523
    02527     readonly attribute IHost host;
    02528
    02532     readonly attribute ISystemProperties systemProperties;
    02533
    02539     readonly attribute IMachine[] machines;
    02540
    02550     readonly attribute IMedium[] hardDisks;
    02551
    02557     readonly attribute IMedium[] DVDImages;
    02558
    02564     readonly attribute IMedium[] floppyImages;
    02565
    02566     readonly attribute IProgress[] progressOperations;
    02567
    02568     readonly attribute IGuestOSType[] guestOSTypes;
    02569
    02586     readonly attribute ISharedFolder[] sharedFolders;
    02587
    02593     readonly attribute IPerformanceCollector performanceCollector;
    02594
    02600     readonly attribute IDHCPServer[] DHCPServers;
    02601
    02703     void createMachine (
    02704         in wstring name,
    02705         in wstring osTypeId,
    02706         in wstring baseFolder,
    02707         in wstringUUID id,
    02708         [retval] out IMachine machine
    02709     );
    02710
    02774     void createLegacyMachine (
    02775         in wstring name,
    02776         in wstring osTypeId,
    02777         in wstring settingsFile,
    02778         in wstringUUID id,
    02779         [retval] out IMachine machine
    02780     );
    02781
    02809     void openMachine (
    02810         in wstring settingsFile,
    02811         [retval] out IMachine machine
    02812     );
    02813
    02846     void registerMachine (
    02847         in IMachine machine
    02848     );
    02849
    02865     void getMachine (
    02866         in wstringUUID id,
    02867         [retval] out IMachine machine
    02868     );
    02869
    02885     void findMachine (
    02886         in wstring name,
    02887         [retval] out IMachine machine
    02888     );
    02889
    02944     void unregisterMachine (
    02945         in wstringUUID id,
    02946         [retval] out IMachine machine
    02947     );
    02948
    02958     void createAppliance (
    02959         [retval] out IAppliance appliance
    02960     );
    02961
    03027     void createHardDisk (
    03028         in wstring format,
    03029         in wstring location,
    03030         [retval] out IMedium medium
    03031     );
    03032
    03120     void openHardDisk (
    03121         in wstring location,
    03122         in AccessMode accessMode,
    03123         in boolean setImageId,
    03124         in wstringUUID imageId,
    03125         in boolean setParentId,
    03126         in wstringUUID parentId,
    03127         [retval] out IMedium medium
    03128     );
    03129
    03151     void getHardDisk (
    03152         in wstringUUID id,
    03153         [retval] out IMedium medium
    03154     );
    03155
    03188     void findHardDisk (
    03189         in wstring location,
    03190         [retval] out IMedium medium
    03191     );
    03192
    03242     void openDVDImage (
    03243         in wstring location,
    03244         in wstringUUID id,
    03245         [retval] out IMedium image
    03246     );
    03247
    03268     void getDVDImage (
    03269         in wstringUUID id,
    03270         [retval] out IMedium image
    03271     );
    03272
    03311     void findDVDImage (
    03312         in wstring location,
    03313         [retval] out IMedium image
    03314     );
    03315
    03365     void openFloppyImage (
    03366         in wstring location,
    03367         in wstringUUID id,
    03368         [retval] out IMedium image
    03369     );
    03370
    03391     void getFloppyImage (
    03392         in wstringUUID id,
    03393         [retval] out IMedium image
    03394     );
    03395
    03434     void findFloppyImage (
    03435         in wstring location,
    03436         [retval] out IMedium image
    03437     );
    03438
    03467     void getGuestOSType (
    03468         in wstringUUID id,
    03469         [retval] out IGuestOSType type
    03470     );
    03471
    03491     void createSharedFolder (
    03492         in wstring name,
    03493         in wstring hostPath,
    03494         in boolean writable
    03495     );
    03496
    03511     void removeSharedFolder (
    03512         in wstring name
    03513     );
    03514
    03523     void getExtraDataKeys (
    03524         [retval] out wstring[] value
    03525     );
    03526
    03555     void getExtraData (
    03556         in wstring key,
    03557         [retval] out wstring value
    03558     );
    03559
    03609     void setExtraData (
    03610         in wstring key,
    03611         in wstring value
    03612     );
    03613
    03710     void openSession (
    03711         in ISession session,
    03712         in wstringUUID machineId
    03713     );
    03714
    03837     void openRemoteSession (
    03838         in ISession session,
    03839         in wstringUUID machineId,
    03840         in wstring type,
    03841         in wstring environment,
    03842         [retval] out IProgress progress
    03843     );
    03844
    03914     void openExistingSession (
    03915         in ISession session,
    03916         in wstringUUID machineId
    03917     );
    03918
    03936     void registerCallback (
    03937         in IVirtualBoxCallback callback
    03938     );
    03939
    03955     void unregisterCallback (
    03956         in IVirtualBoxCallback callback
    03957     );
    03958
    04046     void waitForPropertyChange (
    04047         in wstring what,
    04048         in unsigned long timeout,
    04049         out wstring changed,
    04050         out wstring values
    04051     );
    04052
    04069     void createDHCPServer (
    04070         in wstring name,
    04071         [retval] out IDHCPServer server
    04072     );
    04073
    04090     void findDHCPServerByNetworkName (
    04091         in wstring name,
    04092         [retval] out IDHCPServer server
    04093     );
    04094
    04109     void removeDHCPServer (
    04110         in IDHCPServer server
    04111     );
    04112
    04137     void checkFirmwarePresent (
    04138         in FirmwareType firmwareType,
    04139         in wstring version,
    04140         out wstring url,
    04141         out wstring file,
    04142         [retval] out boolean result
    04143     );
    04144
    04145 }; /* interface IVirtualBox */
    04146
    04157 interface IVFSExplorer : $unknown
    04158 {
    04162     readonly attribute wstring path;
    04163
    04167     readonly attribute VFSType type;
    04168
    04176     void update (
    04177         [retval] out IProgress aProgress
    04178     );
    04179
    04187     void cd (
    04188         in wstring aDir,
    04189         [retval] out IProgress aProgress
    04190     );
    04191
    04197     void cdUp (
    04198         [retval] out IProgress aProgress
    04199     );
    04200
    04209     void entryList (
    04210         out wstring[] aNames,
    04211         out unsigned long[] aTypes
    04212     );
    04213
    04222     void exists (
    04223         in wstring[] aNames,
    04224         [retval] out wstring[] aExists
    04225     );
    04226
    04234     void remove (
    04235         in wstring[] aNames,
    04236         [retval] out IProgress aProgress
    04237     );
    04238
    04239 }; /* interface IVFSExplorer */
    04240
    04305 interface IAppliance : $unknown
    04306 {
    04314     readonly attribute wstring path;
    04315
    04346     readonly attribute wstring[] disks;
    04347
    04355     readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
    04356
    04373     void read (
    04374         in wstring file,
    04375         [retval] out IProgress aProgress
    04376     );
    04377
    04394     void interpret();
    04395
    04413     void importMachines (
    04414         [retval] out IProgress aProgress
    04415     );
    04416
    04424     void createVFSExplorer (
    04425         in wstring aUri,
    04426         [retval] out IVFSExplorer aExplorer
    04427     );
    04428
    04453     void write (
    04454         in wstring format,
    04455         in wstring path,
    04456         [retval] out IProgress aProgress
    04457     );
    04458
    04464     void getWarnings (
    04465         [retval] out wstring[] aWarnings
    04466     );
    04467
    04468 }; /* interface IAppliance */
    04469
    04480 interface IVirtualSystemDescription : $unknown
    04481 {
    04485     readonly attribute unsigned long count;
    04486
    04601     void getDescription (
    04602         out VirtualSystemDescriptionType[] aTypes,
    04603         out wstring[] aRefs,
    04604         out wstring[] aOvfValues,
    04605         out wstring[] aVBoxValues,
    04606         out wstring[] aExtraConfigValues
    04607     );
    04608
    04625     void getDescriptionByType (
    04626         in VirtualSystemDescriptionType aType,
    04627         out VirtualSystemDescriptionType[] aTypes,
    04628         out wstring[] aRefs,
    04629         out wstring[] aOvfValues,
    04630         out wstring[] aVBoxValues,
    04631         out wstring[] aExtraConfigValues
    04632     );
    04633
    04645     void getValuesByType (
    04646         in VirtualSystemDescriptionType aType,
    04647         in VirtualSystemDescriptionValueType aWhich,
    04648         [retval] out wstring[] aValues
    04649     );
    04650
    04676     void setFinalValues (
    04677         in boolean[] aEnabled,
    04678         in wstring[] aVBoxValues,
    04679         in wstring[] aExtraConfigValues
    04680     );
    04681
    04696     void addDescription (
    04697         in VirtualSystemDescriptionType aType,
    04698         in wstring aVBoxValue,
    04699         in wstring aExtraConfigValue
    04700     );
    04701
    04702 }; /* interface IVirtualSystemDescription */
    04703
    04704 interface IInternalMachineControl : $unknown
    04705 {
    04712     void setRemoveSavedState (
    04713         in boolean aRemove
    04714     );
    04715
    04727     void updateState (
    04728         in MachineState state
    04729     );
    04730
    04731     void getIPCId (
    04732         [retval] out wstring id
    04733     );
    04734
    04748     void runUSBDeviceFilters (
    04749         in IUSBDevice device,
    04750         out boolean matched,
    04751         out unsigned long maskedInterfaces
    04752     );
    04753
    04762     void captureUSBDevice (
    04763         in wstringUUID id
    04764     );
    04765
    04781     void detachUSBDevice (
    04782         in wstringUUID id,
    04783         in boolean done
    04784     );
    04785
    04794     void autoCaptureUSBDevices();
    04795
    04811     void detachAllUSBDevices (
    04812         in boolean done
    04813     );
    04814
    04829     void onSessionEnd (
    04830         in ISession session,
    04831         [retval] out IProgress progress
    04832     );
    04833
    04849     void beginSavingState (
    04850         in IProgress progress,
    04851         out wstring stateFilePath
    04852     );
    04853
    04880     void endSavingState (
    04881         in boolean success
    04882     );
    04883
    04898     void adoptSavedState (
    04899         in wstring savedStateFile
    04900     );
    04901
    04950     void beginTakingSnapshot (
    04951         in IConsole initiator,
    04952         in wstring name,
    04953         in wstring description,
    04954         in IProgress consoleProgress,
    04955         in boolean fTakingSnapshotOnline,
    04956         out wstring stateFilePath
    04957     );
    04958
    04968     void endTakingSnapshot (
    04969         in boolean success
    04970     );
    04971
    04992     void deleteSnapshot (
    04993         in IConsole initiator,
    04994         in wstringUUID id,
    04995         out MachineState machineState,
    04996         [retval] out IProgress progress
    04997     );
    04998
    05012     void restoreSnapshot (
    05013         in IConsole initiator,
    05014         in ISnapshot snapshot,
    05015         out MachineState machineState,
    05016         [retval] out IProgress progress
    05017     );
    05018
    05045     void pullGuestProperties (
    05046         out wstring[] name,
    05047         out wstring[] value,
    05048         out unsigned long long[] timestamp,
    05049         out wstring[] flags
    05050     );
    05051
    05078     void pushGuestProperties (
    05079         in wstring[] name,
    05080         in wstring[] value,
    05081         in unsigned long long[] timestamp,
    05082         in wstring[] flags
    05083     );
    05084
    05106     void pushGuestProperty (
    05107         in wstring name,
    05108         in wstring value,
    05109         in unsigned long long timestamp,
    05110         in wstring flags
    05111     );
    05112
    05124     void lockMedia();
    05125
    05135     void unlockMedia();
    05136
    05137 }; /* interface IInternalMachineControl */
    05138
    05147 interface IBIOSSettings : $unknown
    05148 {
    05152     attribute boolean logoFadeIn;
    05153
    05157     attribute boolean logoFadeOut;
    05158
    05162     attribute unsigned long logoDisplayTime;
    05163
    05170     attribute wstring logoImagePath;
    05171
    05175     attribute BIOSBootMenuMode bootMenuMode;
    05176
    05180     attribute boolean ACPIEnabled;
    05181
    05188     attribute boolean IOAPICEnabled;
    05189
    05199     attribute long long timeOffset;
    05200
    05207     attribute boolean PXEDebugEnabled;
    05208
    05209 }; /* interface IBIOSSettings */
    05210
    05251 interface IMachine : $unknown
    05252 {
    05256     readonly attribute IVirtualBox parent;
    05257
    05307     readonly attribute boolean accessible;
    05308
    05320     readonly attribute IVirtualBoxErrorInfo accessError;
    05321
    05367     attribute wstring name;
    05368
    05379     attribute wstring description;
    05380
    05384     readonly attribute wstringUUID id;
    05385
    05400     attribute wstring OSTypeId;
    05401
    05405     attribute wstring HardwareVersion;
    05406
    05416     attribute wstringUUID hardwareUUID;
    05417
    05421     attribute unsigned long CPUCount;
    05422
    05426     attribute unsigned long memorySize;
    05427
    05431     attribute unsigned long memoryBalloonSize;
    05432
    05436     attribute unsigned long statisticsUpdateInterval;
    05437
    05441     attribute unsigned long VRAMSize;
    05442
    05448     attribute boolean accelerate3DEnabled;
    05449
    05455     attribute boolean accelerate2DVideoEnabled;
    05456
    05467     attribute unsigned long monitorCount;
    05468
    05472     readonly attribute IBIOSSettings BIOSSettings;
    05473
    05478     attribute FirmwareType firmwareType;
    05479
    05513     attribute wstring snapshotFolder;
    05514
    05518     readonly attribute IVRDPServer VRDPServer;
    05519
    05523     readonly attribute IMediumAttachment[] mediumAttachments;
    05524
    05536     readonly attribute IUSBController USBController;
    05537
    05541     readonly attribute IAudioAdapter audioAdapter;
    05542
    05546     readonly attribute IStorageController[] storageControllers;
    05547
    05553     readonly attribute wstring settingsFilePath;
    05554
    05579     readonly attribute boolean settingsModified;
    05580
    05584     readonly attribute SessionState sessionState;
    05585
    05598     readonly attribute wstring sessionType;
    05599
    05611     readonly attribute unsigned long sessionPid;
    05612
    05616     readonly attribute MachineState state;
    05617
    05624     readonly attribute long long lastStateChange;
    05625
    05637     readonly attribute wstring stateFilePath;
    05638
    05648     readonly attribute wstring logFolder;
    05649
    05660     readonly attribute ISnapshot currentSnapshot;
    05661
    05668     readonly attribute unsigned long snapshotCount;
    05669
    05703     readonly attribute boolean currentStateModified;
    05704
    05716     readonly attribute ISharedFolder[] sharedFolders;
    05717
    05724     attribute ClipboardMode clipboardMode;
    05725
    05733     attribute wstring guestPropertyNotificationPatterns;
    05734
    05743     attribute boolean teleporterEnabled;
    05744
    05755     attribute unsigned long teleporterPort;
    05756
    05763     attribute wstring teleporterAddress;
    05764
    05772     attribute wstring teleporterPassword;
    05773
    05811     void setBootOrder (
    05812         in unsigned long position,
    05813         in DeviceType device
    05814     );
    05815
    05850     void getBootOrder (
    05851         in unsigned long position,
    05852         [retval] out DeviceType device
    05853     );
    05854
    05949     void attachDevice (
    05950         in wstring name,
    05951         in long controllerPort,
    05952         in long device,
    05953         in DeviceType type,
    05954         in wstringUUID id
    05955     );
    05956
    06009     void detachDevice (
    06010         in wstring name,
    06011         in long controllerPort,
    06012         in long device
    06013     );
    06014
    06057     void passthroughDevice (
    06058         in wstring name,
    06059         in long controllerPort,
    06060         in long device,
    06061         in boolean passthrough
    06062     );
    06063
    06127     void mountMedium (
    06128         in wstring name,
    06129         in long controllerPort,
    06130         in long device,
    06131         in wstringUUID medium,
    06132         in boolean force
    06133     );
    06134
    06163     void getMedium (
    06164         in wstring name,
    06165         in long controllerPort,
    06166         in long device,
    06167         [retval] out IMedium medium
    06168     );
    06169
    06184     void getMediumAttachmentsOfController (
    06185         in wstring name,
    06186         [retval] out IMediumAttachment[] mediumAttachments
    06187     );
    06188
    06203     void getMediumAttachment (
    06204         in wstring name,
    06205         in long controllerPort,
    06206         in long device,
    06207         [retval] out IMediumAttachment attachment
    06208     );
    06209
    06227     void getNetworkAdapter (
    06228         in unsigned long slot,
    06229         [retval] out INetworkAdapter adapter
    06230     );
    06231
    06264     void addStorageController (
    06265         in wstring name,
    06266         in StorageBus connectionType,
    06267         [retval] out IStorageController controller
    06268     );
    06269
    06283     void getStorageControllerByName (
    06284         in wstring name,
    06285         [retval] out IStorageController storageController
    06286     );
    06287
    06301     void getStorageControllerByInstance (
    06302         in unsigned long instance,
    06303         [retval] out IStorageController storageController
    06304     );
    06305
    06319     void removeStorageController (
    06320         in wstring name
    06321     );
    06322
    06340     void getSerialPort (
    06341         in unsigned long slot,
    06342         [retval] out ISerialPort port
    06343     );
    06344
    06362     void getParallelPort (
    06363         in unsigned long slot,
    06364         [retval] out IParallelPort port
    06365     );
    06366
    06375     void getExtraDataKeys (
    06376         [retval] out wstring[] value
    06377     );
    06378
    06407     void getExtraData (
    06408         in wstring key,
    06409         [retval] out wstring value
    06410     );
    06411
    06461     void setExtraData (
    06462         in wstring key,
    06463         in wstring value
    06464     );
    06465
    06487     void getCpuProperty (
    06488         in CpuPropertyType property,
    06489         [retval] out boolean value
    06490     );
    06491
    06513     void setCpuProperty (
    06514         in CpuPropertyType property,
    06515         in boolean value
    06516     );
    06517
    06557     void getCpuIdLeaf (
    06558         in unsigned long id,
    06559         out unsigned long valEax,
    06560         out unsigned long valEbx,
    06561         out unsigned long valEcx,
    06562         out unsigned long valEdx
    06563     );
    06564
    06608     void setCpuIdLeaf (
    06609         in unsigned long id,
    06610         in unsigned long valEax,
    06611         in unsigned long valEbx,
    06612         in unsigned long valEcx,
    06613         in unsigned long valEdx
    06614     );
    06615
    06633     void removeCpuIdLeaf (
    06634         in unsigned long id
    06635     );
    06636
    06642     void removeAllCpuIdLeafs();
    06643
    06665     void getHWVirtExProperty (
    06666         in HWVirtExPropertyType property,
    06667         [retval] out boolean value
    06668     );
    06669
    06691     void setHWVirtExProperty (
    06692         in HWVirtExPropertyType property,
    06693         in boolean value
    06694     );
    06695
    06741     void saveSettings();
    06742
    06766     void discardSettings();
    06767
    06809     void deleteSettings();
    06810
    06820     void export (
    06821         in IAppliance aAppliance,
    06822         [retval] out IVirtualSystemDescription aDescription
    06823     );
    06824
    06845     void getSnapshot (
    06846         in wstringUUID id,
    06847         [retval] out ISnapshot snapshot
    06848     );
    06849
    06867     void findSnapshot (
    06868         in wstring name,
    06869         [retval] out ISnapshot snapshot
    06870     );
    06871
    06884     void setCurrentSnapshot (
    06885         in wstringUUID id
    06886     );
    06887
    06918     void createSharedFolder (
    06919         in wstring name,
    06920         in wstring hostPath,
    06921         in boolean writable
    06922     );
    06923
    06949     void removeSharedFolder (
    06950         in wstring name
    06951     );
    06952
    06976     void canShowConsoleWindow (
    06977         [retval] out boolean canShow
    06978     );
    06979
    07014     void showConsoleWindow (
    07015         [retval] out unsigned long long winId
    07016     );
    07017
    07050     void getGuestProperty (
    07051         in wstring name,
    07052         out wstring value,
    07053         out unsigned long long timestamp,
    07054         out wstring flags
    07055     );
    07056
    07079     void getGuestPropertyValue (
    07080         in wstring property,
    07081         [retval] out wstring value
    07082     );
    07083
    07106     void getGuestPropertyTimestamp (
    07107         in wstring property,
    07108         [retval] out unsigned long long value
    07109     );
    07110
    07161     void setGuestProperty (
    07162         in wstring property,
    07163         in wstring value,
    07164         in wstring flags
    07165     );
    07166
    07207     void setGuestPropertyValue (
    07208         in wstring property,
    07209         in wstring value
    07210     );
    07211
    07242     void enumerateGuestProperties (
    07243         in wstring patterns,
    07244         out wstring[] name,
    07245         out wstring[] value,
    07246         out unsigned long long[] timestamp,
    07247         out wstring[] flags
    07248     );
    07249
    07267     void querySavedThumbnailSize (
    07268         out unsigned long size,
    07269         out unsigned long width,
    07270         out unsigned long height
    07271     );
    07272
    07295     void readSavedThumbnailToArray (
    07296         in boolean BGR,
    07297         out unsigned long width,
    07298         out unsigned long height,
    07299         [retval] out octet[] data
    07300     );
    07301
    07319     void querySavedScreenshotPNGSize (
    07320         out unsigned long size,
    07321         out unsigned long width,
    07322         out unsigned long height
    07323     );
    07324
    07342     void readSavedScreenshotPNGToArray (
    07343         out unsigned long width,
    07344         out unsigned long height,
    07345         [retval] out octet[] data
    07346     );
    07347
    07348 }; /* interface IMachine */
    07349
    07368 interface IConsoleCallback : $unknown
    07369 {
    07436     void onMousePointerShapeChange (
    07437         in boolean visible,
    07438         in boolean alpha,
    07439         in unsigned long xHot,
    07440         in unsigned long yHot,
    07441         in unsigned long width,
    07442         in unsigned long height,
    07443         in octetPtr shape
    07444     );
    07445
    07452     void onMouseCapabilityChange (
    07453         in boolean supportsAbsolute,
    07454         in boolean needsHostCursor
    07455     );
    07456
    07463     void onKeyboardLedsChange (
    07464         in boolean numLock,
    07465         in boolean capsLock,
    07466         in boolean scrollLock
    07467     );
    07468
    07475     void onStateChange (
    07476         in MachineState state
    07477     );
    07478
    07486     void onAdditionsStateChange();
    07487
    07498     void onNetworkAdapterChange (
    07499         in INetworkAdapter networkAdapter
    07500     );
    07501
    07512     void onSerialPortChange (
    07513         in ISerialPort serialPort
    07514     );
    07515
    07526     void onParallelPortChange (
    07527         in IParallelPort parallelPort
    07528     );
    07529
    07538     void onStorageControllerChange();
    07539
    07549     void onMediumChange (
    07550         in IMediumAttachment mediumAttachment
    07551     );
    07552
    07561     void onVRDPServerChange();
    07562
    07570     void onRemoteDisplayInfoChange();
    07571
    07580     void onUSBControllerChange();
    07581
    07614     void onUSBDeviceStateChange (
    07615         in IUSBDevice device,
    07616         in boolean attached,
    07617         in IVirtualBoxErrorInfo error
    07618     );
    07619
    07635     void onSharedFolderChange (
    07636         in Scope scope
    07637     );
    07638
    07703     void onRuntimeError (
    07704         in boolean fatal,
    07705         in wstring id,
    07706         in wstring message
    07707     );
    07708
    07736     void onCanShowWindow (
    07737         [retval] out boolean canShow
    07738     );
    07739
    07786     void onShowWindow (
    07787         [retval] out unsigned long long winId
    07788     );
    07789
    07790 }; /* interface IConsoleCallback */
    07791
    07800 interface IRemoteDisplayInfo : $unknown
    07801 {
    07807     readonly attribute boolean active;
    07808
    07817     readonly attribute long port;
    07818
    07824     readonly attribute unsigned long numberOfClients;
    07825
    07831     readonly attribute long long beginTime;
    07832
    07839     readonly attribute long long endTime;
    07840
    07846     readonly attribute unsigned long long bytesSent;
    07847
    07853     readonly attribute unsigned long long bytesSentTotal;
    07854
    07860     readonly attribute unsigned long long bytesReceived;
    07861
    07867     readonly attribute unsigned long long bytesReceivedTotal;
    07868
    07874     readonly attribute wstring user;
    07875
    07881     readonly attribute wstring domain;
    07882
    07888     readonly attribute wstring clientName;
    07889
    07895     readonly attribute wstring clientIP;
    07896
    07902     readonly attribute unsigned long clientVersion;
    07903
    07911     readonly attribute unsigned long encryptionStyle;
    07912
    07913 }; /* interface IRemoteDisplayInfo */
    07914
    07937 interface IConsole : $unknown
    07938 {
    07950     readonly attribute IMachine machine;
    07951
    07965     readonly attribute MachineState state;
    07966
    07970     readonly attribute IGuest guest;
    07971
    07982     readonly attribute IKeyboard keyboard;
    07983
    07994     readonly attribute IMouse mouse;
    07995
    08005     readonly attribute IDisplay display;
    08006
    08010     readonly attribute IMachineDebugger debugger;
    08011
    08022     readonly attribute IUSBDevice[] USBDevices;
    08023
    08031     readonly attribute IHostUSBDevice[] remoteUSBDevices;
    08032
    08048     readonly attribute ISharedFolder[] sharedFolders;
    08049
    08055     readonly attribute IRemoteDisplayInfo remoteDisplayInfo;
    08056
    08110     void powerUp (
    08111         [retval] out IProgress progress
    08112     );
    08113
    08147     void powerUpPaused (
    08148         [retval] out IProgress progress
    08149     );
    08150
    08170     void powerDown (
    08171         [retval] out IProgress progress
    08172     );
    08173
    08193     void reset();
    08194
    08214     void pause();
    08215
    08235     void resume();
    08236
    08256     void powerButton();
    08257
    08277     void sleepButton();
    08278
    08290     void getPowerButtonHandled (
    08291         [retval] out boolean handled
    08292     );
    08293
    08307     void getGuestEnteredACPIMode (
    08308         [retval] out boolean entered
    08309     );
    08310
    08363     void saveState (
    08364         [retval] out IProgress progress
    08365     );
    08366
    08399     void adoptSavedState (
    08400         in wstring savedStateFile
    08401     );
    08402
    08425     void forgetSavedState (
    08426         in boolean remove
    08427     );
    08428
    08441     void getDeviceActivity (
    08442         in DeviceType type,
    08443         [retval] out DeviceActivity activity
    08444     );
    08445
    08482     void attachUSBDevice (
    08483         in wstringUUID id
    08484     );
    08485
    08519     void detachUSBDevice (
    08520         in wstringUUID id,
    08521         [retval] out IUSBDevice device
    08522     );
    08523
    08546     void findUSBDeviceByAddress (
    08547         in wstring name,
    08548         [retval] out IUSBDevice device
    08549     );
    08550
    08570     void findUSBDeviceById (
    08571         in wstringUUID id,
    08572         [retval] out IUSBDevice device
    08573     );
    08574
    08605     void createSharedFolder (
    08606         in wstring name,
    08607         in wstring hostPath,
    08608         in boolean writable
    08609     );
    08610
    08635     void removeSharedFolder (
    08636         in wstring name
    08637     );
    08638
    08676     void takeSnapshot (
    08677         in wstring name,
    08678         in wstring description,
    08679         [retval] out IProgress progress
    08680     );
    08681
    08748     void deleteSnapshot (
    08749         in wstringUUID id,
    08750         [retval] out IProgress progress
    08751     );
    08752
    08793     void restoreSnapshot (
    08794         in ISnapshot snapshot,
    08795         [retval] out IProgress progress
    08796     );
    08797
    08836     void teleport (
    08837         in wstring hostname,
    08838         in unsigned long tcpport,
    08839         in wstring password,
    08840         in unsigned long maxDowntime,
    08841         [retval] out IProgress progress
    08842     );
    08843
    08851     void registerCallback (
    08852         in IConsoleCallback callback
    08853     );
    08854
    08868     void unregisterCallback (
    08869         in IConsoleCallback callback
    08870     );
    08871
    08872 }; /* interface IConsole */
    08873
    08884 interface IHostNetworkInterface : $unknown
    08885 {
    08889     readonly attribute wstring name;
    08890
    08894     readonly attribute wstringUUID id;
    08895
    08899     readonly attribute wstring networkName;
    08900
    08904     readonly attribute boolean dhcpEnabled;
    08905
    08909     readonly attribute wstring IPAddress;
    08910
    08914     readonly attribute wstring networkMask;
    08915
    08919     readonly attribute boolean IPV6Supported;
    08920
    08924     readonly attribute wstring IPV6Address;
    08925
    08929     readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
    08930
    08934     readonly attribute wstring hardwareAddress;
    08935
    08939     readonly attribute HostNetworkInterfaceMediumType mediumType;
    08940
    08944     readonly attribute HostNetworkInterfaceStatus status;
    08945
    08949     readonly attribute HostNetworkInterfaceType interfaceType;
    08950
    08962     void enableStaticIpConfig (
    08963         in wstring IPAddress,
    08964         in wstring networkMask
    08965     );
    08966
    08978     void enableStaticIpConfigV6 (
    08979         in wstring IPV6Address,
    08980         in unsigned long IPV6NetworkMaskPrefixLength
    08981     );
    08982
    08986     void enableDynamicIpConfig();
    08987
    08991     void dhcpRediscover();
    08992
    08993 }; /* interface IHostNetworkInterface */
    08994
    09011 interface IHost : $unknown
    09012 {
    09016     readonly attribute IMedium[] DVDDrives;
    09017
    09021     readonly attribute IMedium[] floppyDrives;
    09022
    09036     readonly attribute IHostUSBDevice[] USBDevices;
    09037
    09060     readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
    09061
    09065     readonly attribute IHostNetworkInterface[] networkInterfaces;
    09066
    09070     readonly attribute unsigned long processorCount;
    09071
    09075     readonly attribute unsigned long processorOnlineCount;
    09076
    09080     readonly attribute unsigned long memorySize;
    09081
    09085     readonly attribute unsigned long memoryAvailable;
    09086
    09090     readonly attribute wstring operatingSystem;
    09091
    09095     readonly attribute wstring OSVersion;
    09096
    09100     readonly attribute long long UTCTime;
    09101
    09105     readonly attribute boolean Acceleration3DAvailable;
    09106
    09121     void getProcessorSpeed (
    09122         in unsigned long cpuId,
    09123         [retval] out unsigned long speed
    09124     );
    09125
    09137     void getProcessorFeature (
    09138         in ProcessorFeature feature,
    09139         [retval] out boolean supported
    09140     );
    09141
    09160     void getProcessorDescription (
    09161         in unsigned long cpuId,
    09162         [retval] out wstring description
    09163     );
    09164
    09205     void getProcessorCpuIdLeaf (
    09206         in unsigned long cpuId,
    09207         in unsigned long leaf,
    09208         in unsigned long subLeaf,
    09209         out unsigned long valEax,
    09210         out unsigned long valEbx,
    09211         out unsigned long valEcx,
    09212         out unsigned long valEdx
    09213     );
    09214
    09235     void createHostOnlyNetworkInterface (
    09236         out IHostNetworkInterface hostInterface,
    09237         [retval] out IProgress progress
    09238     );
    09239
    09260     void removeHostOnlyNetworkInterface (
    09261         in wstringUUID id,
    09262         [retval] out IProgress progress
    09263     );
    09264
    09285     void createUSBDeviceFilter (
    09286         in wstring name,
    09287         [retval] out IHostUSBDeviceFilter filter
    09288     );
    09289
    09332     void insertUSBDeviceFilter (
    09333         in unsigned long position,
    09334         in IHostUSBDeviceFilter filter
    09335     );
    09336
    09364     void removeUSBDeviceFilter (
    09365         in unsigned long position
    09366     );
    09367
    09385     void findHostDVDDrive (
    09386         in wstring name,
    09387         [retval] out IMedium drive
    09388     );
    09389
    09407     void findHostFloppyDrive (
    09408         in wstring name,
    09409         [retval] out IMedium drive
    09410     );
    09411
    09427     void findHostNetworkInterfaceByName (
    09428         in wstring name,
    09429         [retval] out IHostNetworkInterface networkInterface
    09430     );
    09431
    09447     void findHostNetworkInterfaceById (
    09448         in wstringUUID id,
    09449         [retval] out IHostNetworkInterface networkInterface
    09450     );
    09451
    09461     void findHostNetworkInterfacesOfType (
    09462         in HostNetworkInterfaceType type,
    09463         [retval] out IHostNetworkInterface[] networkInterfaces
    09464     );
    09465
    09485     void findUSBDeviceById (
    09486         in wstringUUID id,
    09487         [retval] out IHostUSBDevice device
    09488     );
    09489
    09512     void findUSBDeviceByAddress (
    09513         in wstring name,
    09514         [retval] out IHostUSBDevice device
    09515     );
    09516
    09517 }; /* interface IHost */
    09518
    09531 interface ISystemProperties : $unknown
    09532 {
    09536     readonly attribute unsigned long minGuestRAM;
    09537
    09541     readonly attribute unsigned long maxGuestRAM;
    09542
    09546     readonly attribute unsigned long minGuestVRAM;
    09547
    09551     readonly attribute unsigned long maxGuestVRAM;
    09552
    09556     readonly attribute unsigned long minGuestCPUCount;
    09557
    09561     readonly attribute unsigned long maxGuestCPUCount;
    09562
    09566     readonly attribute unsigned long long maxVDISize;
    09567
    09574     readonly attribute unsigned long networkAdapterCount;
    09575
    09582     readonly attribute unsigned long serialPortCount;
    09583
    09590     readonly attribute unsigned long parallelPortCount;
    09591
    09601     readonly attribute unsigned long maxBootPosition;
    09602
    09635     attribute wstring defaultMachineFolder;
    09636
    09675     attribute wstring defaultHardDiskFolder;
    09676
    09702     readonly attribute IMediumFormat[] mediumFormats;
    09703
    09737     attribute wstring defaultHardDiskFormat;
    09738
    09762     attribute wstring remoteDisplayAuthLibrary;
    09763
    09792     attribute wstring webServiceAuthLibrary;
    09793
    09799     attribute unsigned long LogHistoryCount;
    09800
    09805     readonly attribute AudioDriverType defaultAudioDriver;
    09806
    09816     void getMaxDevicesPerPortForStorageBus (
    09817         in StorageBus bus,
    09818         [retval] out unsigned long maxDevicesPerPort
    09819     );
    09820
    09828     void getMinPortCountForStorageBus (
    09829         in StorageBus bus,
    09830         [retval] out unsigned long minPortCount
    09831     );
    09832
    09840     void getMaxPortCountForStorageBus (
    09841         in StorageBus bus,
    09842         [retval] out unsigned long maxPortCount
    09843     );
    09844
    09854     void getMaxInstancesOfStorageBus (
    09855         in StorageBus bus,
    09856         [retval] out unsigned long maxInstances
    09857     );
    09858
    09868     void getDeviceTypesForStorageBus (
    09869         in StorageBus bus,
    09870         [retval] out DeviceType[] deviceTypes
    09871     );
    09872
    09873 }; /* interface ISystemProperties */
    09874
    09880 interface IGuestOSType : $unknown
    09881 {
    09885     readonly attribute wstring familyId;
    09886
    09890     readonly attribute wstring familyDescription;
    09891
    09895     readonly attribute wstring id;
    09896
    09900     readonly attribute wstring description;
    09901
    09905     readonly attribute boolean is64Bit;
    09906
    09910     readonly attribute boolean recommendedIOAPIC;
    09911
    09915     readonly attribute boolean recommendedVirtEx;
    09916
    09920     readonly attribute unsigned long recommendedRAM;
    09921
    09925     readonly attribute unsigned long recommendedVRAM;
    09926
    09930     readonly attribute unsigned long recommendedHDD;
    09931
    09935     readonly attribute NetworkAdapterType adapterType;
    09936
    09937 }; /* interface IGuestOSType */
    09938
    09952 interface IGuest : $unknown
    09953 {
    09968     readonly attribute wstring OSTypeId;
    09969
    09977     readonly attribute boolean additionsActive;
    09978
    09988     readonly attribute wstring additionsVersion;
    09989
    09996     readonly attribute boolean supportsSeamless;
    09997
    10006     readonly attribute boolean supportsGraphics;
    10007
    10011     attribute unsigned long memoryBalloonSize;
    10012
    10016     attribute unsigned long statisticsUpdateInterval;
    10017
    10047     void setCredentials (
    10048         in wstring userName,
    10049         in wstring password,
    10050         in wstring domain,
    10051         in boolean allowInteractiveLogon
    10052     );
    10053
    10065     void getStatistic (
    10066         in unsigned long cpuId,
    10067         in GuestStatisticType statistic,
    10068         [retval] out unsigned long statVal
    10069     );
    10070
    10071 }; /* interface IGuest */
    10072
    10113 interface IProgress : $unknown
    10114 {
    10118     readonly attribute wstringUUID id;
    10119
    10123     readonly attribute wstring description;
    10124
    10128     readonly attribute $unknown initiator;
    10129
    10133     readonly attribute boolean cancelable;
    10134
    10142     readonly attribute unsigned long percent;
    10143
    10157     readonly attribute long timeRemaining;
    10158
    10162     readonly attribute boolean completed;
    10163
    10167     readonly attribute boolean canceled;
    10168
    10175     readonly attribute long resultCode;
    10176
    10186     readonly attribute IVirtualBoxErrorInfo errorInfo;
    10187
    10194     readonly attribute unsigned long operationCount;
    10195
    10199     readonly attribute unsigned long operation;
    10200
    10206     readonly attribute wstring operationDescription;
    10207
    10211     readonly attribute unsigned long operationPercent;
    10212
    10220     attribute unsigned long timeout;
    10221
    10225     void setCurrentOperationProgress (
    10226         in unsigned long percent
    10227     );
    10228
    10232     void setNextOperation (
    10233         in wstring nextOperationDescription,
    10234         in unsigned long nextOperationsWeight
    10235     );
    10236
    10255     void waitForCompletion (
    10256         in long timeout
    10257     );
    10258
    10282     void waitForOperationCompletion (
    10283         in unsigned long operation,
    10284         in long timeout
    10285     );
    10286
    10303     void cancel();
    10304
    10305 }; /* interface IProgress */
    10306
    10398 interface ISnapshot : $unknown
    10399 {
    10403     readonly attribute wstringUUID id;
    10404
    10408     attribute wstring name;
    10409
    10413     attribute wstring description;
    10414
    10420     readonly attribute long long timeStamp;
    10421
    10433     readonly attribute boolean online;
    10434
    10446     readonly attribute IMachine machine;
    10447
    10454     readonly attribute ISnapshot parent;
    10455
    10461     readonly attribute ISnapshot[] children;
    10462
    10463 }; /* interface ISnapshot */
    10464
    10480 interface IMediumAttachment : $unknown
    10481 {
    10486     readonly attribute IMedium medium;
    10487
    10493     readonly attribute wstring controller;
    10494
    10498     readonly attribute long port;
    10499
    10503     readonly attribute long device;
    10504
    10508     readonly attribute DeviceType type;
    10509
    10513     readonly attribute boolean passthrough;
    10514
    10515 }; /* interface IMediumAttachment */
    10516
    10862 interface IMedium : $unknown
    10863 {
    10877     readonly attribute wstringUUID id;
    10878
    10897     attribute wstring description;
    10898
    10914     readonly attribute MediumState state;
    10915
    10937     attribute wstring location;
    10938
    10958     readonly attribute wstring name;
    10959
    10964     readonly attribute DeviceType deviceType;
    10965
    10969     readonly attribute boolean hostDrive;
    10970
    10983     readonly attribute unsigned long long size;
    10984
    10999     readonly attribute wstring format;
    11000
    11025     attribute MediumType type;
    11026
    11036     readonly attribute IMedium parent;
    11037
    11045     readonly attribute IMedium[] children;
    11046
    11057     readonly attribute IMedium base;
    11058
    11091     readonly attribute boolean readOnly;
    11092
    11113     readonly attribute unsigned long long logicalSize;
    11114
    11142     attribute boolean autoReset;
    11143
    11158     readonly attribute wstring lastAccessError;
    11159
    11176     readonly attribute wstringUUID[] machineIds;
    11177
    11212     void refreshState (
    11213         [retval] out MediumState state
    11214     );
    11215
    11242     void getSnapshotIds (
    11243         in wstringUUID machineId,
    11244         [retval] out wstringUUID[] snapshotIds
    11245     );
    11246
    11306     void lockRead (
    11307         [retval] out MediumState state
    11308     );
    11309
    11332     void unlockRead (
    11333         [retval] out MediumState state
    11334     );
    11335
    11390     void lockWrite (
    11391         [retval] out MediumState state
    11392     );
    11393
    11416     void unlockWrite (
    11417         [retval] out MediumState state
    11418     );
    11419
    11468     void close();
    11469
    11499     void getProperty (
    11500         in wstring name,
    11501         [retval] out wstring value
    11502     );
    11503
    11535     void setProperty (
    11536         in wstring name,
    11537         in wstring value
    11538     );
    11539
    11573     void getProperties (
    11574         in wstring names,
    11575         out wstring[] returnNames,
    11576         [retval] out wstring[] returnValues
    11577     );
    11578
    11610     void setProperties (
    11611         in wstring[] names,
    11612         in wstring[] values
    11613     );
    11614
    11646     void createBaseStorage (
    11647         in unsigned long long logicalSize,
    11648         in MediumVariant variant,
    11649         [retval] out IProgress progress
    11650     );
    11651
    11703     void deleteStorage (
    11704         [retval] out IProgress progress
    11705     );
    11706
    11744     void createDiffStorage (
    11745         in IMedium target,
    11746         in MediumVariant variant,
    11747         [retval] out IProgress progress
    11748     );
    11749
    11825     void mergeTo (
    11826         in wstringUUID targetId,
    11827         [retval] out IProgress progress
    11828     );
    11829
    11878     void cloneTo (
    11879         in IMedium target,
    11880         in MediumVariant variant,
    11881         in IMedium parent,
    11882         [retval] out IProgress progress
    11883     );
    11884
    11913     void compact (
    11914         [retval] out IProgress progress
    11915     );
    11916
    11949     void resize (
    11950         in unsigned long long logicalSize,
    11951         [retval] out IProgress progress
    11952     );
    11953
    11987     void reset (
    11988         [retval] out IProgress progress
    11989     );
    11990
    11991 }; /* interface IMedium */
    11992
    12015 interface IMediumFormat : $unknown
    12016 {
    12035     readonly attribute wstring id;
    12036
    12044     readonly attribute wstring name;
    12045
    12061     readonly attribute wstring[] fileExtensions;
    12062
    12071     readonly attribute unsigned long capabilities;
    12072
    12102     void describeProperties (
    12103         out wstring[] names,
    12104         out wstring[] description,
    12105         out DataType[] types,
    12106         out unsigned long[] flags,
    12107         out wstring[] defaults
    12108     );
    12109
    12110 }; /* interface IMediumFormat */
    12111
    12124 interface IKeyboard : $unknown
    12125 {
    12138     void putScancode (
    12139         in long scancode
    12140     );
    12141
    12154     void putScancodes (
    12155         in long[] scancodes,
    12156         [retval] out unsigned long codesStored
    12157     );
    12158
    12173     void putCAD();
    12174
    12175 }; /* interface IKeyboard */
    12176
    12188 interface IMouse : $unknown
    12189 {
    12206     readonly attribute boolean absoluteSupported;
    12207
    12273     void putMouseEvent (
    12274         in long dx,
    12275         in long dy,
    12276         in long dz,
    12277         in long dw,
    12278         in long buttonState
    12279     );
    12280
    12353     void putMouseEventAbsolute (
    12354         in long x,
    12355         in long y,
    12356         in long dz,
    12357         in long dw,
    12358         in long buttonState
    12359     );
    12360
    12361 }; /* interface IMouse */
    12362
    12363 interface IFramebuffer : $unknown
    12364 {
    12373     readonly attribute octetPtr address;
    12374
    12378     readonly attribute unsigned long width;
    12379
    12383     readonly attribute unsigned long height;
    12384
    12391     readonly attribute unsigned long bitsPerPixel;
    12392
    12399     readonly attribute unsigned long bytesPerLine;
    12400
    12411     readonly attribute unsigned long pixelFormat;
    12412
    12419     readonly attribute boolean usesGuestVRAM;
    12420
    12430     readonly attribute unsigned long heightReduction;
    12431
    12446     readonly attribute IFramebufferOverlay overlay;
    12447
    12454     readonly attribute unsigned long long winId;
    12455
    12463     void lock();
    12464
    12472     void unlock();
    12473
    12481     void notifyUpdate (
    12482         in unsigned long x,
    12483         in unsigned long y,
    12484         in unsigned long width,
    12485         in unsigned long height
    12486     );
    12487
    12600     void requestResize (
    12601         in unsigned long screenId,
    12602         in unsigned long pixelFormat,
    12603         in octetPtr VRAM,
    12604         in unsigned long bitsPerPixel,
    12605         in unsigned long bytesPerLine,
    12606         in unsigned long width,
    12607         in unsigned long height,
    12608         [retval] out boolean finished
    12609     );
    12610
    12622     void videoModeSupported (
    12623         in unsigned long width,
    12624         in unsigned long height,
    12625         in unsigned long bpp,
    12626         [retval] out boolean supported
    12627     );
    12628
    12665     void getVisibleRegion (
    12666         in octetPtr rectangles,
    12667         in unsigned long count,
    12668         [retval] out unsigned long countCopied
    12669     );
    12670
    12705     void setVisibleRegion (
    12706         in octetPtr rectangles,
    12707         in unsigned long count
    12708     );
    12709
    12730     void processVHWACommand (
    12731         in octetPtr command
    12732     );
    12733
    12734 }; /* interface IFramebuffer */
    12735
    12750 interface IFramebufferOverlay : IFramebuffer
    12751 {
    12755     readonly attribute unsigned long x;
    12756
    12760     readonly attribute unsigned long y;
    12761
    12767     attribute boolean visible;
    12768
    12775     attribute unsigned long alpha;
    12776
    12782     void move (
    12783         in unsigned long x,
    12784         in unsigned long y
    12785     );
    12786
    12787 }; /* interface IFramebufferOverlay */
    12788
    12804 interface IDisplay : $unknown
    12805 {
    12809     readonly attribute unsigned long width;
    12810
    12814     readonly attribute unsigned long height;
    12815
    12822     readonly attribute unsigned long bitsPerPixel;
    12823
    12829     void setFramebuffer (
    12830         in unsigned long screenId,
    12831         in IFramebuffer framebuffer
    12832     );
    12833
    12839     void getFramebuffer (
    12840         in unsigned long screenId,
    12841         out IFramebuffer framebuffer,
    12842         out long xOrigin,
    12843         out long yOrigin
    12844     );
    12845
    12874     void setVideoModeHint (
    12875         in unsigned long width,
    12876         in unsigned long height,
    12877         in unsigned long bitsPerPixel,
    12878         in unsigned long display
    12879     );
    12880
    12891     void setSeamlessMode (
    12892         in boolean enabled
    12893     );
    12894
    12928     void takeScreenShot (
    12929         in octetPtr address,
    12930         in unsigned long width,
    12931         in unsigned long height
    12932     );
    12933
    12973     void takeScreenShotSlow (
    12974         in unsigned long width,
    12975         in unsigned long height,
    12976         [retval] out octet[] screenData
    12977     );
    12978
    13006     void drawToScreen (
    13007         in octetPtr address,
    13008         in unsigned long x,
    13009         in unsigned long y,
    13010         in unsigned long width,
    13011         in unsigned long height
    13012     );
    13013
    13028     void invalidateAndUpdate();
    13029
    13043     void resizeCompleted (
    13044         in unsigned long screenId
    13045     );
    13046
    13060     void updateCompleted();
    13061
    13074     void completeVHWACommand (
    13075         in octetPtr command
    13076     );
    13077
    13078 }; /* interface IDisplay */
    13079
    13095 interface INetworkAdapter : $unknown
    13096 {
    13104     attribute NetworkAdapterType adapterType;
    13105
    13113     readonly attribute unsigned long slot;
    13114
    13123     attribute boolean enabled;
    13124
    13131     attribute wstring MACAddress;
    13132
    13133     readonly attribute NetworkAttachmentType attachmentType;
    13134
    13140     attribute wstring hostInterface;
    13141
    13147     attribute wstring internalNetwork;
    13148
    13154     attribute wstring NATNetwork;
    13155
    13162     attribute boolean cableConnected;
    13163
    13169     attribute unsigned long lineSpeed;
    13170
    13177     attribute boolean traceEnabled;
    13178
    13185     attribute wstring traceFile;
    13186
    13192     void attachToNAT();
    13193
    13199     void attachToBridgedInterface();
    13200
    13206     void attachToInternalNetwork();
    13207
    13213     void attachToHostOnlyInterface();
    13214
    13220     void detach();
    13221
    13222 }; /* interface INetworkAdapter */
    13223
    13252 interface ISerialPort : $unknown
    13253 {
    13261     readonly attribute unsigned long slot;
    13262
    13269     attribute boolean enabled;
    13270
    13274     attribute unsigned long IOBase;
    13275
    13279     attribute unsigned long IRQ;
    13280
    13291     attribute PortMode hostMode;
    13292
    13300     attribute boolean server;
    13301
    13311     attribute wstring path;
    13312
    13313 }; /* interface ISerialPort */
    13314
    13334 interface IParallelPort : $unknown
    13335 {
    13343     readonly attribute unsigned long slot;
    13344
    13351     attribute boolean enabled;
    13352
    13356     attribute unsigned long IOBase;
    13357
    13361     attribute unsigned long IRQ;
    13362
    13370     attribute wstring path;
    13371
    13372 }; /* interface IParallelPort */
    13373
    13374 interface IMachineDebugger : $unknown
    13375 {
    13379     attribute boolean singlestep;
    13380
    13384     attribute boolean recompileUser;
    13385
    13389     attribute boolean recompileSupervisor;
    13390
    13394     attribute boolean PATMEnabled;
    13395
    13399     attribute boolean CSAMEnabled;
    13400
    13404     attribute boolean logEnabled;
    13405
    13412     readonly attribute boolean HWVirtExEnabled;
    13413
    13420     readonly attribute boolean HWVirtExNestedPagingEnabled;
    13421
    13428     readonly attribute boolean HWVirtExVPIDEnabled;
    13429
    13436     readonly attribute boolean PAEEnabled;
    13437
    13444     attribute unsigned long virtualTimeRate;
    13445
    13452     readonly attribute unsigned long long VM;
    13453
    13461     void resetStats (
    13462         in wstring pattern
    13463     );
    13464
    13472     void dumpStats (
    13473         in wstring pattern
    13474     );
    13475
    13487     void getStats (
    13488         in wstring pattern,
    13489         in boolean withDescriptions,
    13490         out wstring stats
    13491     );
    13492
    13498     void injectNMI();
    13499
    13500 }; /* interface IMachineDebugger */
    13501
    13502 interface IUSBController : $unknown
    13503 {
    13512     attribute boolean enabled;
    13513
    13522     attribute boolean enabledEhci;
    13523
    13531     readonly attribute unsigned short USBStandard;
    13532
    13558     readonly attribute IUSBDeviceFilter[] deviceFilters;
    13559
    13587     void createDeviceFilter (
    13588         in wstring name,
    13589         [retval] out IUSBDeviceFilter filter
    13590     );
    13591
    13636     void insertDeviceFilter (
    13637         in unsigned long position,
    13638         in IUSBDeviceFilter filter
    13639     );
    13640
    13673     void removeDeviceFilter (
    13674         in unsigned long position,
    13675         [retval] out IUSBDeviceFilter filter
    13676     );
    13677
    13678 }; /* interface IUSBController */
    13679
    13692 interface IUSBDevice : $unknown
    13693 {
    13700     readonly attribute wstringUUID id;
    13701
    13705     readonly attribute unsigned short vendorId;
    13706
    13710     readonly attribute unsigned short productId;
    13711
    13719     readonly attribute unsigned short revision;
    13720
    13724     readonly attribute wstring manufacturer;
    13725
    13729     readonly attribute wstring product;
    13730
    13734     readonly attribute wstring serialNumber;
    13735
    13739     readonly attribute wstring address;
    13740
    13747     readonly attribute unsigned short port;
    13748
    13754     readonly attribute unsigned short version;
    13755
    13763     readonly attribute unsigned short portVersion;
    13764
    13771     readonly attribute boolean remote;
    13772
    13773 }; /* interface IUSBDevice */
    13774
    13848 interface IUSBDeviceFilter : $unknown
    13849 {
    13857     attribute wstring name;
    13858
    13862     attribute boolean active;
    13863
    13871     attribute wstring vendorId;
    13872
    13880     attribute wstring productId;
    13881
    13895     attribute wstring revision;
    13896
    13901     attribute wstring manufacturer;
    13902
    13907     attribute wstring product;
    13908
    13913     attribute wstring serialNumber;
    13914
    13919     attribute wstring port;
    13920
    13930     attribute wstring remote;
    13931
    13941     attribute unsigned long maskedInterfaces;
    13942
    13943 }; /* interface IUSBDeviceFilter */
    13944
    13960 interface IHostUSBDevice : IUSBDevice
    13961 {
    13967     readonly attribute USBDeviceState state;
    13968
    13969 }; /* interface IHostUSBDevice */
    13970
    13993 interface IHostUSBDeviceFilter : IUSBDeviceFilter
    13994 {
    14001     attribute USBDeviceFilterAction action;
    14002
    14003 }; /* interface IHostUSBDeviceFilter */
    14004
    14013 interface IAudioAdapter : $unknown
    14014 {
    14023     attribute boolean enabled;
    14024
    14030     attribute AudioControllerType audioController;
    14031
    14038     attribute AudioDriverType audioDriver;
    14039
    14040 }; /* interface IAudioAdapter */
    14041
    14042 interface IVRDPServer : $unknown
    14043 {
    14047     attribute boolean enabled;
    14048
    14058     attribute wstring ports;
    14059
    14063     attribute wstring netAddress;
    14064
    14068     attribute VRDPAuthType authType;
    14069
    14073     attribute unsigned long authTimeout;
    14074
    14081     attribute boolean allowMultiConnection;
    14082
    14090     attribute boolean reuseSingleConnection;
    14091
    14092 }; /* interface IVRDPServer */
    14093
    14151 interface ISharedFolder : $unknown
    14152 {
    14156     readonly attribute wstring name;
    14157
    14161     readonly attribute wstring hostPath;
    14162
    14172     readonly attribute boolean accessible;
    14173
    14180     readonly attribute boolean writable;
    14181
    14194     readonly attribute wstring lastAccessError;
    14195
    14196 }; /* interface ISharedFolder */
    14197
    14198 interface IInternalSessionControl : $unknown
    14199 {
    14204     void getPID (
    14205         [retval] out unsigned long pid
    14206     );
    14207
    14229     void getRemoteConsole (
    14230         [retval] out IConsole console
    14231     );
    14232
    14256     void assignMachine (
    14257         in IMachine machine
    14258     );
    14259
    14274     void assignRemoteMachine (
    14275         in IMachine machine,
    14276         in IConsole console
    14277     );
    14278
    14302     void updateMachineState (
    14303         in MachineState aMachineState
    14304     );
    14305
    14321     void uninitialize();
    14322
    14345     void onNetworkAdapterChange (
    14346         in INetworkAdapter networkAdapter,
    14347         in boolean changeAdapter
    14348     );
    14349
    14372     void onSerialPortChange (
    14373         in ISerialPort serialPort
    14374     );
    14375
    14398     void onParallelPortChange (
    14399         in IParallelPort parallelPort
    14400     );
    14401
    14424     void onStorageControllerChange();
    14425
    14448     void onMediumChange (
    14449         in IMediumAttachment mediumAttachment,
    14450         in boolean force
    14451     );
    14452
    14475     void onVRDPServerChange();
    14476
    14499     void onUSBControllerChange();
    14500
    14529     void onSharedFolderChange (
    14530         in boolean global
    14531     );
    14532
    14558     void onUSBDeviceAttach (
    14559         in IUSBDevice device,
    14560         in IVirtualBoxErrorInfo error,
    14561         in unsigned long maskedInterfaces
    14562     );
    14563
    14589     void onUSBDeviceDetach (
    14590         in wstringUUID id,
    14591         in IVirtualBoxErrorInfo error
    14592     );
    14593
    14611     void onShowWindow (
    14612         in boolean check,
    14613         out boolean canShow,
    14614         out unsigned long long winId
    14615     );
    14616
    14640     void accessGuestProperty (
    14641         in wstring name,
    14642         in wstring value,
    14643         in wstring flags,
    14644         in boolean isSetter,
    14645         out wstring retValue,
    14646         out unsigned long long retTimestamp,
    14647         out wstring retFlags
    14648     );
    14649
    14697     void enumerateGuestProperties (
    14698         in wstring patterns,
    14699         out wstring[] key,
    14700         out wstring[] value,
    14701         out unsigned long long[] timestamp,
    14702         out wstring[] flags
    14703     );
    14704
    14705 }; /* interface IInternalSessionControl */
    14706
    14783 interface ISession : $dispatched
    14784 {
    14788     readonly attribute SessionState state;
    14789
    14797     readonly attribute SessionType type;
    14798
    14802     readonly attribute IMachine machine;
    14803
    14807     readonly attribute IConsole console;
    14808
    14849     void close();
    14850
    14851 }; /* interface ISession */
    14852
    14875 interface IStorageController : $unknown
    14876 {
    14885     readonly attribute wstring name;
    14886
    14892     readonly attribute unsigned long maxDevicesPerPortCount;
    14893
    14899     readonly attribute unsigned long minPortCount;
    14900
    14906     readonly attribute unsigned long maxPortCount;
    14907
    14913     attribute unsigned long instance;
    14914
    14923     attribute unsigned long portCount;
    14924
    14930     readonly attribute StorageBus bus;
    14931
    14944     attribute StorageControllerType controllerType;
    14945
    14968     void GetIDEEmulationPort (
    14969         in long devicePosition,
    14970         [retval] out long portNumber
    14971     );
    14972
    14996     void SetIDEEmulationPort (
    14997         in long devicePosition,
    14998         in long portNumber
    14999     );
    15000
    15001 }; /* interface IStorageController */
    15002
    15026 interface IManagedObjectRef : $unknown
    15027 {
    15034     void getInterfaceName (
    15035         [retval] out wstring return
    15036     );
    15037
    15045     void release();
    15046
    15047 }; /* interface IManagedObjectRef */
    15048
    15057 interface IWebsessionManager : $unknown
    15058 {
    15067     void logon (
    15068         in wstring username,
    15069         in wstring password,
    15070         [retval] out IVirtualBox return
    15071     );
    15072
    15082     void getSessionObject (
    15083         in IVirtualBox refIVirtualBox,
    15084         [retval] out ISession return
    15085     );
    15086
    15094     void logoff (
    15095         in IVirtualBox refIVirtualBox
    15096     );
    15097
    15098 }; /* interface IWebsessionManager */
    15099
    15108 interface IPerformanceMetric : $unknown
    15109 {
    15115     readonly attribute wstring metricName;
    15116
    15122     readonly attribute $unknown object;
    15123
    15129     readonly attribute wstring description;
    15130
    15136     readonly attribute unsigned long period;
    15137
    15147     readonly attribute unsigned long count;
    15148
    15154     readonly attribute wstring unit;
    15155
    15161     readonly attribute long minimumValue;
    15162
    15168     readonly attribute long maximumValue;
    15169
    15170 }; /* interface IPerformanceMetric */
    15171
    15272 interface IPerformanceCollector : $unknown
    15273 {
    15284     readonly attribute wstring[] metricNames;
    15285
    15309     void getMetrics (
    15310         in wstring[] metricNames,
    15311         in $unknown[] objects,
    15312         [retval] out IPerformanceMetric[] metrics
    15313     );
    15314
    15353     void setupMetrics (
    15354         in wstring[] metricNames,
    15355         in $unknown[] objects,
    15356         in unsigned long period,
    15357         in unsigned long count,
    15358         [retval] out IPerformanceMetric[] affectedMetrics
    15359     );
    15360
    15389     void enableMetrics (
    15390         in wstring[] metricNames,
    15391         in $unknown[] objects,
    15392         [retval] out IPerformanceMetric[] affectedMetrics
    15393     );
    15394
    15423     void disableMetrics (
    15424         in wstring[] metricNames,
    15425         in $unknown[] objects,
    15426         [retval] out IPerformanceMetric[] affectedMetrics
    15427     );
    15428
    15517     void queryMetricsData (
    15518         in wstring[] metricNames,
    15519         in $unknown[] objects,
    15520         out wstring[] returnMetricNames,
    15521         out $unknown[] returnObjects,
    15522         out wstring[] returnUnits,
    15523         out unsigned long[] returnScales,
    15524         out unsigned long[] returnSequenceNumbers,
    15525         out unsigned long[] returnDataIndices,
    15526         out unsigned long[] returnDataLengths,
    15527         [retval] out long[] returnData
    15528     );
    15529
    15530 }; /* interface IPerformanceCollector */
    15531
    15532