• Main Page
  • Related Pages
  • Modules
  • Classes
  • Files
  • File List
  • File Members

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;
00228 enum SettingsVersion
00229 {
00234     SettingsVersion_Null = 0,
00239     SettingsVersion_v1_0 = 1,
00244     SettingsVersion_v1_1 = 2,
00249     SettingsVersion_v1_2 = 3,
00254     SettingsVersion_v1_3pre = 4,
00259     SettingsVersion_v1_3 = 5,
00264     SettingsVersion_v1_4 = 6,
00269     SettingsVersion_v1_5 = 7,
00274     SettingsVersion_v1_6 = 8,
00279     SettingsVersion_v1_7 = 9,
00284     SettingsVersion_v1_8 = 10,
00289     SettingsVersion_v1_9 = 11,
00294     SettingsVersion_v1_10 = 12,
00299     SettingsVersion_v1_11 = 13,
00304     SettingsVersion_v1_12 = 14,
00309     SettingsVersion_Future = 99999,
00310 };
00311 
00319 enum AccessMode
00320 {
00321     AccessMode_ReadOnly = 1,
00322     AccessMode_ReadWrite = 2,
00323 };
00324 
00442 enum MachineState
00443 {
00448     MachineState_Null = 0,
00456     MachineState_PoweredOff = 1,
00465     MachineState_Saved = 2,
00474     MachineState_Teleported = 3,
00483     MachineState_Aborted = 4,
00490     MachineState_Running = 5,
00497     MachineState_Paused = 6,
00505     MachineState_Stuck = 7,
00515     MachineState_Teleporting = 8,
00526     MachineState_LiveSnapshotting = 9,
00534     MachineState_Starting = 10,
00542     MachineState_Stopping = 11,
00550     MachineState_Saving = 12,
00558     MachineState_Restoring = 13,
00567     MachineState_TeleportingPausedVM = 14,
00574     MachineState_TeleportingIn = 15,
00581     MachineState_FaultTolerantSyncing = 16,
00589     MachineState_DeletingSnapshotOnline = 17,
00597     MachineState_DeletingSnapshotPaused = 18,
00604     MachineState_RestoringSnapshot = 19,
00613     MachineState_DeletingSnapshot = 20,
00620     MachineState_SettingUp = 21,
00627     MachineState_FirstOnline = 5,
00634     MachineState_LastOnline = 18,
00641     MachineState_FirstTransient = 8,
00648     MachineState_LastTransient = 21,
00649 };
00650 
00660 enum SessionState
00661 {
00666     SessionState_Null = 0,
00677     SessionState_Unlocked = 1,
00691     SessionState_Locked = 2,
00701     SessionState_Spawning = 3,
00708     SessionState_Unlocking = 4,
00709 };
00710 
00719 enum CPUPropertyType
00720 {
00725     CPUPropertyType_Null = 0,
00734     CPUPropertyType_PAE = 1,
00742     CPUPropertyType_Synthetic = 2,
00743 };
00744 
00754 enum HWVirtExPropertyType
00755 {
00760     HWVirtExPropertyType_Null = 0,
00768     HWVirtExPropertyType_Enabled = 1,
00777     HWVirtExPropertyType_Exclusive = 2,
00784     HWVirtExPropertyType_VPID = 3,
00791     HWVirtExPropertyType_NestedPaging = 4,
00798     HWVirtExPropertyType_LargePages = 5,
00806     HWVirtExPropertyType_Force = 6,
00807 };
00808 
00816 enum FaultToleranceState
00817 {
00822     FaultToleranceState_Inactive = 1,
00827     FaultToleranceState_Master = 2,
00832     FaultToleranceState_Standby = 3,
00833 };
00834 
00842 enum LockType
00843 {
00848     LockType_Write = 2,
00853     LockType_Shared = 1,
00854 };
00855 
00864 enum SessionType
00865 {
00870     SessionType_Null = 0,
00878     SessionType_WriteLock = 1,
00885     SessionType_Remote = 2,
00892     SessionType_Shared = 3,
00893 };
00894 
00902 enum DeviceType
00903 {
00911     DeviceType_Null = 0,
00916     DeviceType_Floppy = 1,
00921     DeviceType_DVD = 2,
00926     DeviceType_HardDisk = 3,
00931     DeviceType_Network = 4,
00936     DeviceType_USB = 5,
00941     DeviceType_SharedFolder = 6,
00942 };
00943 
00951 enum DeviceActivity
00952 {
00953     DeviceActivity_Null = 0,
00954     DeviceActivity_Idle = 1,
00955     DeviceActivity_Reading = 2,
00956     DeviceActivity_Writing = 3,
00957 };
00958 
00966 enum ClipboardMode
00967 {
00968     ClipboardMode_Disabled = 0,
00969     ClipboardMode_HostToGuest = 1,
00970     ClipboardMode_GuestToHost = 2,
00971     ClipboardMode_Bidirectional = 3,
00972 };
00973 
00984 enum Scope
00985 {
00986     Scope_Global = 0,
00987     Scope_Machine = 1,
00988     Scope_Session = 2,
00989 };
00990 
00998 enum BIOSBootMenuMode
00999 {
01000     BIOSBootMenuMode_Disabled = 0,
01001     BIOSBootMenuMode_MenuOnly = 1,
01002     BIOSBootMenuMode_MessageAndMenu = 2,
01003 };
01004 
01012 enum ProcessorFeature
01013 {
01014     ProcessorFeature_HWVirtEx = 0,
01015     ProcessorFeature_PAE = 1,
01016     ProcessorFeature_LongMode = 2,
01017     ProcessorFeature_NestedPaging = 3,
01018 };
01019 
01027 enum FirmwareType
01028 {
01033     FirmwareType_BIOS = 1,
01038     FirmwareType_EFI = 2,
01043     FirmwareType_EFI32 = 3,
01048     FirmwareType_EFI64 = 4,
01053     FirmwareType_EFIDUAL = 5,
01054 };
01055 
01063 enum PointingHidType
01064 {
01069     PointingHidType_None = 1,
01074     PointingHidType_PS2Mouse = 2,
01079     PointingHidType_USBMouse = 3,
01084     PointingHidType_USBTablet = 4,
01090     PointingHidType_ComboMouse = 5,
01091 };
01092 
01100 enum KeyboardHidType
01101 {
01106     KeyboardHidType_None = 1,
01111     KeyboardHidType_PS2Keyboard = 2,
01116     KeyboardHidType_USBKeyboard = 3,
01122     KeyboardHidType_ComboKeyboard = 4,
01123 };
01124 
01132 enum VFSType
01133 {
01134     VFSType_File = 1,
01135     VFSType_Cloud = 2,
01136     VFSType_S3 = 3,
01137     VFSType_WebDav = 4,
01138 };
01139 
01147 enum VFSFileType
01148 {
01149     VFSFileType_Unknown = 1,
01150     VFSFileType_Fifo = 2,
01151     VFSFileType_DevChar = 3,
01152     VFSFileType_Directory = 4,
01153     VFSFileType_DevBlock = 5,
01154     VFSFileType_File = 6,
01155     VFSFileType_SymLink = 7,
01156     VFSFileType_Socket = 8,
01157     VFSFileType_WhiteOut = 9,
01158 };
01159 
01167 enum ImportOptions
01168 {
01173     ImportOptions_KeepAllMACs = 1,
01178     ImportOptions_KeepNATMACs = 2,
01179 };
01180 
01187 enum VirtualSystemDescriptionType
01188 {
01189     VirtualSystemDescriptionType_Ignore = 1,
01190     VirtualSystemDescriptionType_OS = 2,
01191     VirtualSystemDescriptionType_Name = 3,
01192     VirtualSystemDescriptionType_Product = 4,
01193     VirtualSystemDescriptionType_Vendor = 5,
01194     VirtualSystemDescriptionType_Version = 6,
01195     VirtualSystemDescriptionType_ProductUrl = 7,
01196     VirtualSystemDescriptionType_VendorUrl = 8,
01197     VirtualSystemDescriptionType_Description = 9,
01198     VirtualSystemDescriptionType_License = 10,
01199     VirtualSystemDescriptionType_Miscellaneous = 11,
01200     VirtualSystemDescriptionType_CPU = 12,
01201     VirtualSystemDescriptionType_Memory = 13,
01202     VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
01203     VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
01204     VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
01205     VirtualSystemDescriptionType_HardDiskControllerSAS = 17,
01206     VirtualSystemDescriptionType_HardDiskImage = 18,
01207     VirtualSystemDescriptionType_Floppy = 19,
01208     VirtualSystemDescriptionType_CDROM = 20,
01209     VirtualSystemDescriptionType_NetworkAdapter = 21,
01210     VirtualSystemDescriptionType_USBController = 22,
01211     VirtualSystemDescriptionType_SoundCard = 23,
01216     VirtualSystemDescriptionType_SettingsFile = 24,
01217 };
01218 
01225 enum VirtualSystemDescriptionValueType
01226 {
01227     VirtualSystemDescriptionValueType_Reference = 1,
01228     VirtualSystemDescriptionValueType_Original = 2,
01229     VirtualSystemDescriptionValueType_Auto = 3,
01230     VirtualSystemDescriptionValueType_ExtraConfig = 4,
01231 };
01232 
01239 enum CleanupMode
01240 {
01245     CleanupMode_UnregisterOnly = 1,
01250     CleanupMode_DetachAllReturnNone = 2,
01255     CleanupMode_DetachAllReturnHardDisksOnly = 3,
01260     CleanupMode_Full = 4,
01261 };
01262 
01270 enum CloneMode
01271 {
01276     CloneMode_MachineState = 1,
01281     CloneMode_MachineAndChildStates = 2,
01286     CloneMode_AllStates = 3,
01287 };
01288 
01296 enum CloneOptions
01297 {
01302     CloneOptions_Link = 1,
01307     CloneOptions_KeepAllMACs = 2,
01312     CloneOptions_KeepNATMACs = 3,
01317     CloneOptions_KeepDiskNames = 4,
01318 };
01319 
01330 enum HostNetworkInterfaceMediumType
01331 {
01338     HostNetworkInterfaceMediumType_Unknown = 0,
01345     HostNetworkInterfaceMediumType_Ethernet = 1,
01352     HostNetworkInterfaceMediumType_PPP = 2,
01359     HostNetworkInterfaceMediumType_SLIP = 3,
01360 };
01361 
01371 enum HostNetworkInterfaceStatus
01372 {
01379     HostNetworkInterfaceStatus_Unknown = 0,
01386     HostNetworkInterfaceStatus_Up = 1,
01393     HostNetworkInterfaceStatus_Down = 2,
01394 };
01395 
01403 enum HostNetworkInterfaceType
01404 {
01405     HostNetworkInterfaceType_Bridged = 1,
01406     HostNetworkInterfaceType_HostOnly = 2,
01407 };
01408 
01416 enum AdditionsFacilityType
01417 {
01422     AdditionsFacilityType_None = 0,
01427     AdditionsFacilityType_VBoxGuestDriver = 20,
01432     AdditionsFacilityType_AutoLogon = 90,
01437     AdditionsFacilityType_VBoxService = 100,
01442     AdditionsFacilityType_VBoxTrayClient = 101,
01447     AdditionsFacilityType_Seamless = 1000,
01455     AdditionsFacilityType_Graphics = 1100,
01460     AdditionsFacilityType_All = 2147483646,
01461 };
01462 
01470 enum AdditionsFacilityClass
01471 {
01476     AdditionsFacilityClass_None = 0,
01481     AdditionsFacilityClass_Driver = 10,
01486     AdditionsFacilityClass_Service = 30,
01491     AdditionsFacilityClass_Program = 50,
01496     AdditionsFacilityClass_Feature = 100,
01501     AdditionsFacilityClass_ThirdParty = 999,
01506     AdditionsFacilityClass_All = 2147483646,
01507 };
01508 
01516 enum AdditionsFacilityStatus
01517 {
01522     AdditionsFacilityStatus_Inactive = 0,
01527     AdditionsFacilityStatus_Paused = 1,
01532     AdditionsFacilityStatus_PreInit = 20,
01537     AdditionsFacilityStatus_Init = 30,
01542     AdditionsFacilityStatus_Active = 50,
01547     AdditionsFacilityStatus_Terminating = 100,
01552     AdditionsFacilityStatus_Terminated = 101,
01557     AdditionsFacilityStatus_Failed = 800,
01562     AdditionsFacilityStatus_Unknown = 999,
01563 };
01564 
01572 enum AdditionsRunLevelType
01573 {
01578     AdditionsRunLevelType_None = 0,
01583     AdditionsRunLevelType_System = 1,
01588     AdditionsRunLevelType_Userland = 2,
01593     AdditionsRunLevelType_Desktop = 3,
01594 };
01595 
01603 enum AdditionsUpdateFlag
01604 {
01609     AdditionsUpdateFlag_None = 0,
01615     AdditionsUpdateFlag_WaitForUpdateStartOnly = 1,
01616 };
01617 
01625 enum ExecuteProcessFlag
01626 {
01631     ExecuteProcessFlag_None = 0,
01637     ExecuteProcessFlag_WaitForProcessStartOnly = 1,
01642     ExecuteProcessFlag_IgnoreOrphanedProcesses = 2,
01647     ExecuteProcessFlag_Hidden = 4,
01652     ExecuteProcessFlag_NoProfile = 8,
01657     ExecuteProcessFlag_WaitForStdOut = 16,
01662     ExecuteProcessFlag_WaitForStdErr = 32,
01663 };
01664 
01672 enum ExecuteProcessStatus
01673 {
01678     ExecuteProcessStatus_Undefined = 0,
01683     ExecuteProcessStatus_Started = 1,
01688     ExecuteProcessStatus_TerminatedNormally = 2,
01693     ExecuteProcessStatus_TerminatedSignal = 3,
01698     ExecuteProcessStatus_TerminatedAbnormally = 4,
01703     ExecuteProcessStatus_TimedOutKilled = 5,
01708     ExecuteProcessStatus_TimedOutAbnormally = 6,
01713     ExecuteProcessStatus_Down = 7,
01718     ExecuteProcessStatus_Error = 8,
01719 };
01720 
01728 enum ProcessInputFlag
01729 {
01734     ProcessInputFlag_None = 0,
01739     ProcessInputFlag_EndOfFile = 1,
01740 };
01741 
01750 enum ProcessOutputFlag
01751 {
01756     ProcessOutputFlag_None = 0,
01761     ProcessOutputFlag_StdErr = 1,
01762 };
01763 
01772 enum CopyFileFlag
01773 {
01778     CopyFileFlag_None = 0,
01783     CopyFileFlag_Recursive = 1,
01788     CopyFileFlag_Update = 2,
01793     CopyFileFlag_FollowLinks = 4,
01794 };
01795 
01803 enum DirectoryCreateFlag
01804 {
01809     DirectoryCreateFlag_None = 0,
01814     DirectoryCreateFlag_Parents = 1,
01815 };
01816 
01824 enum DirectoryOpenFlag
01825 {
01830     DirectoryOpenFlag_None = 0,
01831 };
01832 
01840 enum GuestDirEntryType
01841 {
01846     GuestDirEntryType_Unknown = 0,
01851     GuestDirEntryType_Directory = 4,
01856     GuestDirEntryType_File = 10,
01861     GuestDirEntryType_Symlink = 12,
01862 };
01863 
01873 enum MediumState
01874 {
01882     MediumState_NotCreated = 0,
01891     MediumState_Created = 1,
01899     MediumState_LockedRead = 2,
01907     MediumState_LockedWrite = 3,
01917     MediumState_Inaccessible = 4,
01924     MediumState_Creating = 5,
01931     MediumState_Deleting = 6,
01932 };
01933 
01944 enum MediumType
01945 {
01953     MediumType_Normal = 0,
01961     MediumType_Immutable = 1,
01969     MediumType_Writethrough = 2,
01978     MediumType_Shareable = 3,
01987     MediumType_Readonly = 4,
01999     MediumType_MultiAttach = 5,
02000 };
02001 
02011 enum MediumVariant
02012 {
02019     MediumVariant_Standard = 0,
02026     MediumVariant_VmdkSplit2G = 0x01,
02034     MediumVariant_VmdkStreamOptimized = 0x04,
02041     MediumVariant_VmdkESX = 0x08,
02048     MediumVariant_Fixed = 0x10000,
02055     MediumVariant_Diff = 0x20000,
02063     MediumVariant_NoCreateDir = 0x40000000,
02064 };
02065 
02066 enum DataType
02067 {
02068     DataType_Int32 = 0,
02069     DataType_Int8 = 1,
02070     DataType_String = 2,
02071 };
02072 
02073 enum DataFlags
02074 {
02075     DataFlags_None = 0x00,
02076     DataFlags_Mandatory = 0x01,
02077     DataFlags_Expert = 0x02,
02078     DataFlags_Array = 0x04,
02079     DataFlags_FlagMask = 0x07,
02080 };
02081 
02089 enum MediumFormatCapabilities
02090 {
02097     MediumFormatCapabilities_Uuid = 0x01,
02104     MediumFormatCapabilities_CreateFixed = 0x02,
02112     MediumFormatCapabilities_CreateDynamic = 0x04,
02119     MediumFormatCapabilities_CreateSplit2G = 0x08,
02126     MediumFormatCapabilities_Differencing = 0x10,
02133     MediumFormatCapabilities_Asynchronous = 0x20,
02143     MediumFormatCapabilities_File = 0x40,
02152     MediumFormatCapabilities_Properties = 0x80,
02159     MediumFormatCapabilities_TcpNetworking = 0x100,
02166     MediumFormatCapabilities_VFS = 0x200,
02167     MediumFormatCapabilities_CapabilityMask = 0x3FF,
02168 };
02169 
02177 enum MouseButtonState
02178 {
02179     MouseButtonState_LeftButton = 0x01,
02180     MouseButtonState_RightButton = 0x02,
02181     MouseButtonState_MiddleButton = 0x04,
02182     MouseButtonState_WheelUp = 0x08,
02183     MouseButtonState_WheelDown = 0x10,
02184     MouseButtonState_XButton1 = 0x20,
02185     MouseButtonState_XButton2 = 0x40,
02186     MouseButtonState_MouseStateMask = 0x7F,
02187 };
02188 
02199 enum FramebufferPixelFormat
02200 {
02208     FramebufferPixelFormat_Opaque = 0,
02216     FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
02217 };
02218 
02226 enum NetworkAttachmentType
02227 {
02232     NetworkAttachmentType_Null = 0,
02233     NetworkAttachmentType_NAT = 1,
02234     NetworkAttachmentType_Bridged = 2,
02235     NetworkAttachmentType_Internal = 3,
02236     NetworkAttachmentType_HostOnly = 4,
02237     NetworkAttachmentType_Generic = 5,
02238 };
02239 
02247 enum NetworkAdapterType
02248 {
02253     NetworkAdapterType_Null = 0,
02258     NetworkAdapterType_Am79C970A = 1,
02263     NetworkAdapterType_Am79C973 = 2,
02268     NetworkAdapterType_I82540EM = 3,
02273     NetworkAdapterType_I82543GC = 4,
02278     NetworkAdapterType_I82545EM = 5,
02283     NetworkAdapterType_Virtio = 6,
02284 };
02285 
02293 enum NetworkAdapterPromiscModePolicy
02294 {
02299     NetworkAdapterPromiscModePolicy_Deny = 1,
02307     NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
02315     NetworkAdapterPromiscModePolicy_AllowAll = 3,
02316 };
02317 
02326 enum PortMode
02327 {
02332     PortMode_Disconnected = 0,
02337     PortMode_HostPipe = 1,
02342     PortMode_HostDevice = 2,
02347     PortMode_RawFile = 3,
02348 };
02349 
02388 enum USBDeviceState
02389 {
02396     USBDeviceState_NotSupported = 0,
02404     USBDeviceState_Unavailable = 1,
02411     USBDeviceState_Busy = 2,
02419     USBDeviceState_Available = 3,
02427     USBDeviceState_Held = 4,
02435     USBDeviceState_Captured = 5,
02436 };
02437 
02447 enum USBDeviceFilterAction
02448 {
02453     USBDeviceFilterAction_Null = 0,
02458     USBDeviceFilterAction_Ignore = 1,
02463     USBDeviceFilterAction_Hold = 2,
02464 };
02465 
02473 enum AudioDriverType
02474 {
02479     AudioDriverType_Null = 0,
02484     AudioDriverType_WinMM = 1,
02489     AudioDriverType_OSS = 2,
02494     AudioDriverType_ALSA = 3,
02499     AudioDriverType_DirectSound = 4,
02504     AudioDriverType_CoreAudio = 5,
02509     AudioDriverType_MMPM = 6,
02514     AudioDriverType_Pulse = 7,
02519     AudioDriverType_SolAudio = 8,
02520 };
02521 
02529 enum AudioControllerType
02530 {
02531     AudioControllerType_AC97 = 0,
02532     AudioControllerType_SB16 = 1,
02533     AudioControllerType_HDA = 2,
02534 };
02535 
02543 enum AuthType
02544 {
02549     AuthType_Null = 0,
02550     AuthType_External = 1,
02551     AuthType_Guest = 2,
02552 };
02553 
02562 enum StorageBus
02563 {
02568     StorageBus_Null = 0,
02569     StorageBus_IDE = 1,
02570     StorageBus_SATA = 2,
02571     StorageBus_SCSI = 3,
02572     StorageBus_Floppy = 4,
02573     StorageBus_SAS = 5,
02574 };
02575 
02584 enum StorageControllerType
02585 {
02590     StorageControllerType_Null = 0,
02595     StorageControllerType_LsiLogic = 1,
02600     StorageControllerType_BusLogic = 2,
02605     StorageControllerType_IntelAhci = 3,
02610     StorageControllerType_PIIX3 = 4,
02615     StorageControllerType_PIIX4 = 5,
02620     StorageControllerType_ICH6 = 6,
02625     StorageControllerType_I82078 = 7,
02630     StorageControllerType_LsiLogicSas = 8,
02631 };
02632 
02640 enum ChipsetType
02641 {
02646     ChipsetType_Null = 0,
02651     ChipsetType_PIIX3 = 1,
02656     ChipsetType_ICH9 = 2,
02657 };
02658 
02664 enum NATAliasMode
02665 {
02670     NATAliasMode_AliasLog = 0x1,
02675     NATAliasMode_AliasProxyOnly = 0x02,
02680     NATAliasMode_AliasUseSamePorts = 0x04,
02681 };
02682 
02688 enum NATProtocol
02689 {
02694     NATProtocol_UDP = 0,
02699     NATProtocol_TCP = 1,
02700 };
02701 
02709 enum BandwidthGroupType
02710 {
02717     BandwidthGroupType_Null = 0,
02724     BandwidthGroupType_Disk = 1,
02731     BandwidthGroupType_Network = 2,
02732 };
02733 
02742 enum VBoxEventType
02743 {
02750     VBoxEventType_Invalid = 0,
02759     VBoxEventType_Any = 1,
02767     VBoxEventType_Vetoable = 2,
02775     VBoxEventType_MachineEvent = 3,
02783     VBoxEventType_SnapshotEvent = 4,
02792     VBoxEventType_InputEvent = 5,
02799     VBoxEventType_LastWildcard = 31,
02806     VBoxEventType_OnMachineStateChanged = 32,
02813     VBoxEventType_OnMachineDataChanged = 33,
02820     VBoxEventType_OnExtraDataChanged = 34,
02827     VBoxEventType_OnExtraDataCanChange = 35,
02834     VBoxEventType_OnMediumRegistered = 36,
02841     VBoxEventType_OnMachineRegistered = 37,
02848     VBoxEventType_OnSessionStateChanged = 38,
02855     VBoxEventType_OnSnapshotTaken = 39,
02862     VBoxEventType_OnSnapshotDeleted = 40,
02869     VBoxEventType_OnSnapshotChanged = 41,
02876     VBoxEventType_OnGuestPropertyChanged = 42,
02883     VBoxEventType_OnMousePointerShapeChanged = 43,
02890     VBoxEventType_OnMouseCapabilityChanged = 44,
02897     VBoxEventType_OnKeyboardLedsChanged = 45,
02904     VBoxEventType_OnStateChanged = 46,
02911     VBoxEventType_OnAdditionsStateChanged = 47,
02918     VBoxEventType_OnNetworkAdapterChanged = 48,
02925     VBoxEventType_OnSerialPortChanged = 49,
02932     VBoxEventType_OnParallelPortChanged = 50,
02939     VBoxEventType_OnStorageControllerChanged = 51,
02946     VBoxEventType_OnMediumChanged = 52,
02953     VBoxEventType_OnVRDEServerChanged = 53,
02960     VBoxEventType_OnUSBControllerChanged = 54,
02967     VBoxEventType_OnUSBDeviceStateChanged = 55,
02974     VBoxEventType_OnSharedFolderChanged = 56,
02981     VBoxEventType_OnRuntimeError = 57,
02988     VBoxEventType_OnCanShowWindow = 58,
02995     VBoxEventType_OnShowWindow = 59,
03002     VBoxEventType_OnCPUChanged = 60,
03009     VBoxEventType_OnVRDEServerInfoChanged = 61,
03016     VBoxEventType_OnEventSourceChanged = 62,
03023     VBoxEventType_OnCPUExecutionCapChanged = 63,
03030     VBoxEventType_OnGuestKeyboard = 64,
03037     VBoxEventType_OnGuestMouse = 65,
03044     VBoxEventType_OnNATRedirect = 66,
03051     VBoxEventType_OnHostPciDevicePlug = 67,
03058     VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
03065     VBoxEventType_OnBandwidthGroupChanged = 69,
03072     VBoxEventType_OnGuestMonitorChanged = 70,
03079     VBoxEventType_OnStorageDeviceChanged = 71,
03086     VBoxEventType_Last = 72,
03087 };
03088 
03096 enum GuestMonitorChangedEventType
03097 {
03104     GuestMonitorChangedEventType_Enabled = 0,
03111     GuestMonitorChangedEventType_Disabled = 1,
03118     GuestMonitorChangedEventType_NewOrigin = 2,
03119 };
03120 
03154 interface IVirtualBoxErrorInfo : $errorinfo
03155 {
03173     readonly attribute long resultCode;
03174 
03186     readonly attribute wstringUUID interfaceID;
03187 
03198     readonly attribute wstring component;
03199 
03210     readonly attribute wstring text;
03211 
03222     readonly attribute IVirtualBoxErrorInfo next;
03223 
03224 }; /* interface IVirtualBoxErrorInfo */
03225 
03236 interface IDHCPServer : $unknown
03237 {
03243     attribute boolean enabled;
03244 
03250     readonly attribute wstring IPAddress;
03251 
03257     readonly attribute wstring networkMask;
03258 
03264     readonly attribute wstring networkName;
03265 
03271     readonly attribute wstring lowerIP;
03272 
03278     readonly attribute wstring upperIP;
03279 
03308     void setConfiguration (
03309         in wstring IPAddress,
03310         in wstring networkMask,
03311         in wstring FromIPAddress,
03312         in wstring ToIPAddress
03313     );
03314 
03339     void start (
03340         in wstring networkName,
03341         in wstring trunkName,
03342         in wstring trunkType
03343     );
03344 
03357     void stop();
03358 
03359 }; /* interface IDHCPServer */
03360 
03379 interface IVirtualBox : $unknown
03380 {
03388     readonly attribute wstring version;
03389 
03395     readonly attribute unsigned long revision;
03396 
03406     readonly attribute wstring packageType;
03407 
03419     readonly attribute wstring APIVersion;
03420 
03436     readonly attribute wstring homeFolder;
03437 
03445     readonly attribute wstring settingsFilePath;
03446 
03450     readonly attribute IHost host;
03451 
03455     readonly attribute ISystemProperties systemProperties;
03456 
03462     readonly attribute IMachine[] machines;
03463 
03473     readonly attribute IMedium[] hardDisks;
03474 
03480     readonly attribute IMedium[] DVDImages;
03481 
03487     readonly attribute IMedium[] floppyImages;
03488 
03489     readonly attribute IProgress[] progressOperations;
03490 
03491     readonly attribute IGuestOSType[] guestOSTypes;
03492 
03509     readonly attribute ISharedFolder[] sharedFolders;
03510 
03516     readonly attribute IPerformanceCollector performanceCollector;
03517 
03523     readonly attribute IDHCPServer[] DHCPServers;
03524 
03530     readonly attribute IEventSource eventSource;
03531 
03537     readonly attribute IExtPackManager extensionPackManager;
03538 
03544     readonly attribute wstring[] internalNetworks;
03545 
03551     readonly attribute wstring[] genericNetworkDrivers;
03552 
03592     void composeMachineFilename (
03593         in wstring name,
03594         in wstring baseFolder,
03595         [retval] out wstring file
03596     );
03597 
03694     void createMachine (
03695         in wstring settingsFile,
03696         in wstring name,
03697         in wstring osTypeId,
03698         in wstringUUID id,
03699         in boolean forceOverwrite,
03700         [retval] out IMachine machine
03701     );
03702 
03728     void openMachine (
03729         in wstring settingsFile,
03730         [retval] out IMachine machine
03731     );
03732 
03764     void registerMachine (
03765         in IMachine machine
03766     );
03767 
03788     void findMachine (
03789         in wstring nameOrId,
03790         [retval] out IMachine machine
03791     );
03792 
03802     void createAppliance (
03803         [retval] out IAppliance appliance
03804     );
03805 
03868     void createHardDisk (
03869         in wstring format,
03870         in wstring location,
03871         [retval] out IMedium medium
03872     );
03873 
03978     void openMedium (
03979         in wstring location,
03980         in DeviceType deviceType,
03981         in AccessMode accessMode,
03982         in boolean forceNewUuid,
03983         [retval] out IMedium medium
03984     );
03985 
04017     void findMedium (
04018         in wstring location,
04019         in DeviceType type,
04020         [retval] out IMedium medium
04021     );
04022 
04051     void getGuestOSType (
04052         in wstringUUID id,
04053         [retval] out IGuestOSType type
04054     );
04055 
04078     void createSharedFolder (
04079         in wstring name,
04080         in wstring hostPath,
04081         in boolean writable,
04082         in boolean automount
04083     );
04084 
04099     void removeSharedFolder (
04100         in wstring name
04101     );
04102 
04111     void getExtraDataKeys (
04112         [retval] out wstring[] value
04113     );
04114 
04143     void getExtraData (
04144         in wstring key,
04145         [retval] out wstring value
04146     );
04147 
04197     void setExtraData (
04198         in wstring key,
04199         in wstring value
04200     );
04201 
04218     void createDHCPServer (
04219         in wstring name,
04220         [retval] out IDHCPServer server
04221     );
04222 
04239     void findDHCPServerByNetworkName (
04240         in wstring name,
04241         [retval] out IDHCPServer server
04242     );
04243 
04258     void removeDHCPServer (
04259         in IDHCPServer server
04260     );
04261 
04286     void checkFirmwarePresent (
04287         in FirmwareType firmwareType,
04288         in wstring version,
04289         out wstring url,
04290         out wstring file,
04291         [retval] out boolean result
04292     );
04293 
04294 }; /* interface IVirtualBox */
04295 
04306 interface IVFSExplorer : $unknown
04307 {
04311     readonly attribute wstring path;
04312 
04316     readonly attribute VFSType type;
04317 
04325     void update (
04326         [retval] out IProgress aProgress
04327     );
04328 
04336     void cd (
04337         in wstring aDir,
04338         [retval] out IProgress aProgress
04339     );
04340 
04346     void cdUp (
04347         [retval] out IProgress aProgress
04348     );
04349 
04362     void entryList (
04363         out wstring[] aNames,
04364         out unsigned long[] aTypes,
04365         out unsigned long[] aSizes,
04366         out unsigned long[] aModes
04367     );
04368 
04377     void exists (
04378         in wstring[] aNames,
04379         [retval] out wstring[] aExists
04380     );
04381 
04389     void remove (
04390         in wstring[] aNames,
04391         [retval] out IProgress aProgress
04392     );
04393 
04394 }; /* interface IVFSExplorer */
04395 
04461 interface IAppliance : $unknown
04462 {
04470     readonly attribute wstring path;
04471 
04502     readonly attribute wstring[] disks;
04503 
04511     readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
04512 
04520     readonly attribute wstring[] machines;
04521 
04538     void read (
04539         in wstring file,
04540         [retval] out IProgress aProgress
04541     );
04542 
04559     void interpret();
04560 
04583     void importMachines (
04584         in ImportOptions[] options,
04585         [retval] out IProgress aProgress
04586     );
04587 
04595     void createVFSExplorer (
04596         in wstring aUri,
04597         [retval] out IVFSExplorer aExplorer
04598     );
04599 
04629     void write (
04630         in wstring format,
04631         in boolean manifest,
04632         in wstring path,
04633         [retval] out IProgress progress
04634     );
04635 
04641     void getWarnings (
04642         [retval] out wstring[] aWarnings
04643     );
04644 
04645 }; /* interface IAppliance */
04646 
04658 interface IVirtualSystemDescription : $unknown
04659 {
04663     readonly attribute unsigned long count;
04664 
04788     void getDescription (
04789         out VirtualSystemDescriptionType[] aTypes,
04790         out wstring[] aRefs,
04791         out wstring[] aOvfValues,
04792         out wstring[] aVBoxValues,
04793         out wstring[] aExtraConfigValues
04794     );
04795 
04812     void getDescriptionByType (
04813         in VirtualSystemDescriptionType aType,
04814         out VirtualSystemDescriptionType[] aTypes,
04815         out wstring[] aRefs,
04816         out wstring[] aOvfValues,
04817         out wstring[] aVBoxValues,
04818         out wstring[] aExtraConfigValues
04819     );
04820 
04832     void getValuesByType (
04833         in VirtualSystemDescriptionType aType,
04834         in VirtualSystemDescriptionValueType aWhich,
04835         [retval] out wstring[] aValues
04836     );
04837 
04863     void setFinalValues (
04864         in boolean[] aEnabled,
04865         in wstring[] aVBoxValues,
04866         in wstring[] aExtraConfigValues
04867     );
04868 
04883     void addDescription (
04884         in VirtualSystemDescriptionType aType,
04885         in wstring aVBoxValue,
04886         in wstring aExtraConfigValue
04887     );
04888 
04889 }; /* interface IVirtualSystemDescription */
04890 
04891 interface IInternalMachineControl : $unknown
04892 {
04899     void setRemoveSavedStateFile (
04900         in boolean aRemove
04901     );
04902 
04914     void updateState (
04915         in MachineState state
04916     );
04917 
04918     void getIPCId (
04919         [retval] out wstring id
04920     );
04921 
04933     void beginPowerUp (
04934         in IProgress aProgress
04935     );
04936 
04946     void endPowerUp (
04947         in long result
04948     );
04949 
04961     void beginPoweringDown (
04962         out IProgress progress
04963     );
04964 
04994     void endPoweringDown (
04995         in long result,
04996         in wstring errMsg
04997     );
04998 
05012     void runUSBDeviceFilters (
05013         in IUSBDevice device,
05014         out boolean matched,
05015         out unsigned long maskedInterfaces
05016     );
05017 
05026     void captureUSBDevice (
05027         in wstringUUID id
05028     );
05029 
05045     void detachUSBDevice (
05046         in wstringUUID id,
05047         in boolean done
05048     );
05049 
05058     void autoCaptureUSBDevices();
05059 
05075     void detachAllUSBDevices (
05076         in boolean done
05077     );
05078 
05093     void onSessionEnd (
05094         in ISession session,
05095         [retval] out IProgress progress
05096     );
05097 
05113     void beginSavingState (
05114         out IProgress progress,
05115         out wstring stateFilePath
05116     );
05117 
05147     void endSavingState (
05148         in long result,
05149         in wstring errMsg
05150     );
05151 
05166     void adoptSavedState (
05167         in wstring savedStateFile
05168     );
05169 
05218     void beginTakingSnapshot (
05219         in IConsole initiator,
05220         in wstring name,
05221         in wstring description,
05222         in IProgress consoleProgress,
05223         in boolean fTakingSnapshotOnline,
05224         out wstring stateFilePath
05225     );
05226 
05236     void endTakingSnapshot (
05237         in boolean success
05238     );
05239 
05268     void deleteSnapshot (
05269         in IConsole initiator,
05270         in wstringUUID startId,
05271         in wstringUUID endId,
05272         in boolean deleteAllChildren,
05273         out MachineState machineState,
05274         [retval] out IProgress progress
05275     );
05276 
05295     void finishOnlineMergeMedium (
05296         in IMediumAttachment mediumAttachment,
05297         in IMedium source,
05298         in IMedium target,
05299         in boolean mergeForward,
05300         in IMedium parentForTarget,
05301         in IMedium[] childrenToReparent
05302     );
05303 
05317     void restoreSnapshot (
05318         in IConsole initiator,
05319         in ISnapshot snapshot,
05320         out MachineState machineState,
05321         [retval] out IProgress progress
05322     );
05323 
05350     void pullGuestProperties (
05351         out wstring[] name,
05352         out wstring[] value,
05353         out long long[] timestamp,
05354         out wstring[] flags
05355     );
05356 
05378     void pushGuestProperty (
05379         in wstring name,
05380         in wstring value,
05381         in long long timestamp,
05382         in wstring flags
05383     );
05384 
05396     void lockMedia();
05397 
05407     void unlockMedia();
05408 
05424     void ejectMedium (
05425         in IMediumAttachment attachment,
05426         [retval] out IMediumAttachment newAttachment
05427     );
05428 
05465     void reportGuestStatistics (
05466         in unsigned long validStats,
05467         in unsigned long cpuUser,
05468         in unsigned long cpuKernel,
05469         in unsigned long cpuIdle,
05470         in unsigned long memTotal,
05471         in unsigned long memFree,
05472         in unsigned long memBalloon,
05473         in unsigned long memShared,
05474         in unsigned long memCache,
05475         in unsigned long pagedTotal,
05476         in unsigned long memAllocTotal,
05477         in unsigned long memFreeTotal,
05478         in unsigned long memBalloonTotal,
05479         in unsigned long memSharedTotal
05480     );
05481 
05482 }; /* interface IInternalMachineControl */
05483 
05492 interface IBIOSSettings : $unknown
05493 {
05497     attribute boolean logoFadeIn;
05498 
05502     attribute boolean logoFadeOut;
05503 
05507     attribute unsigned long logoDisplayTime;
05508 
05515     attribute wstring logoImagePath;
05516 
05520     attribute BIOSBootMenuMode bootMenuMode;
05521 
05525     attribute boolean ACPIEnabled;
05526 
05533     attribute boolean IOAPICEnabled;
05534 
05544     attribute long long timeOffset;
05545 
05552     attribute boolean PXEDebugEnabled;
05553 
05554 }; /* interface IBIOSSettings */
05555 
05563 interface IPciAddress : $unknown
05564 {
05570     attribute short bus;
05571 
05577     attribute short device;
05578 
05584     attribute short devFunction;
05585 
05591     void asLong (
05592         [retval] out long result
05593     );
05594 
05600     void fromLong (
05601         in long number
05602     );
05603 
05604 }; /* interface IPciAddress */
05605 
05613 interface IPciDeviceAttachment : $unknown
05614 {
05620     readonly attribute wstring name;
05621 
05627     readonly attribute boolean isPhysicalDevice;
05628 
05634     readonly attribute long hostAddress;
05635 
05641     readonly attribute long guestAddress;
05642 
05643 }; /* interface IPciDeviceAttachment */
05644 
05685 interface IMachine : $unknown
05686 {
05690     readonly attribute IVirtualBox parent;
05691 
05741     readonly attribute boolean accessible;
05742 
05754     readonly attribute IVirtualBoxErrorInfo accessError;
05755 
05795     attribute wstring name;
05796 
05807     attribute wstring description;
05808 
05812     readonly attribute wstringUUID id;
05813 
05828     attribute wstring OSTypeId;
05829 
05833     attribute wstring hardwareVersion;
05834 
05844     attribute wstringUUID hardwareUUID;
05845 
05849     attribute unsigned long CPUCount;
05850 
05856     attribute boolean CPUHotPlugEnabled;
05857 
05865     attribute unsigned long CPUExecutionCap;
05866 
05870     attribute unsigned long memorySize;
05871 
05875     attribute unsigned long memoryBalloonSize;
05876 
05883     attribute boolean pageFusionEnabled;
05884 
05888     attribute unsigned long VRAMSize;
05889 
05895     attribute boolean accelerate3DEnabled;
05896 
05902     attribute boolean accelerate2DVideoEnabled;
05903 
05914     attribute unsigned long monitorCount;
05915 
05919     readonly attribute IBIOSSettings BIOSSettings;
05920 
05925     attribute FirmwareType firmwareType;
05926 
05932     attribute PointingHidType pointingHidType;
05933 
05939     attribute KeyboardHidType keyboardHidType;
05940 
05947     attribute boolean hpetEnabled;
05948 
05952     attribute ChipsetType chipsetType;
05953 
05987     attribute wstring snapshotFolder;
05988 
05992     readonly attribute IVRDEServer VRDEServer;
05993 
05994     attribute boolean emulatedUSBWebcameraEnabled;
05995 
05996     attribute boolean emulatedUSBCardReaderEnabled;
05997 
06001     readonly attribute IMediumAttachment[] mediumAttachments;
06002 
06014     readonly attribute IUSBController USBController;
06015 
06019     readonly attribute IAudioAdapter audioAdapter;
06020 
06024     readonly attribute IStorageController[] storageControllers;
06025 
06031     readonly attribute wstring settingsFilePath;
06032 
06057     readonly attribute boolean settingsModified;
06058 
06062     readonly attribute SessionState sessionState;
06063 
06076     readonly attribute wstring sessionType;
06077 
06087     readonly attribute unsigned long sessionPid;
06088 
06092     readonly attribute MachineState state;
06093 
06100     readonly attribute long long lastStateChange;
06101 
06113     readonly attribute wstring stateFilePath;
06114 
06124     readonly attribute wstring logFolder;
06125 
06136     readonly attribute ISnapshot currentSnapshot;
06137 
06144     readonly attribute unsigned long snapshotCount;
06145 
06177     readonly attribute boolean currentStateModified;
06178 
06190     readonly attribute ISharedFolder[] sharedFolders;
06191 
06198     attribute ClipboardMode clipboardMode;
06199 
06207     attribute wstring guestPropertyNotificationPatterns;
06208 
06217     attribute boolean teleporterEnabled;
06218 
06229     attribute unsigned long teleporterPort;
06230 
06237     attribute wstring teleporterAddress;
06238 
06246     attribute wstring teleporterPassword;
06247 
06255     attribute FaultToleranceState faultToleranceState;
06256 
06263     attribute unsigned long faultTolerancePort;
06264 
06270     attribute wstring faultToleranceAddress;
06271 
06279     attribute wstring faultTolerancePassword;
06280 
06286     attribute unsigned long faultToleranceSyncInterval;
06287 
06295     attribute boolean RTCUseUTC;
06296 
06303     attribute boolean ioCacheEnabled;
06304 
06310     attribute unsigned long ioCacheSize;
06311 
06317     readonly attribute IBandwidthControl bandwidthControl;
06318 
06328     readonly attribute IPciDeviceAttachment[] pciDeviceAssignments;
06329 
06435     void lockMachine (
06436         in ISession session,
06437         in LockType lockType
06438     );
06439 
06569     void launchVMProcess (
06570         in ISession session,
06571         in wstring type,
06572         in wstring environment,
06573         [retval] out IProgress progress
06574     );
06575 
06613     void setBootOrder (
06614         in unsigned long position,
06615         in DeviceType device
06616     );
06617 
06652     void getBootOrder (
06653         in unsigned long position,
06654         [retval] out DeviceType device
06655     );
06656 
06758     void attachDevice (
06759         in wstring name,
06760         in long controllerPort,
06761         in long device,
06762         in DeviceType type,
06763         in IMedium medium
06764     );
06765 
06818     void detachDevice (
06819         in wstring name,
06820         in long controllerPort,
06821         in long device
06822     );
06823 
06866     void passthroughDevice (
06867         in wstring name,
06868         in long controllerPort,
06869         in long device,
06870         in boolean passthrough
06871     );
06872 
06915     void temporaryEjectDevice (
06916         in wstring name,
06917         in long controllerPort,
06918         in long device,
06919         in boolean temporaryEject
06920     );
06921 
06967     void nonRotationalDevice (
06968         in wstring name,
06969         in long controllerPort,
06970         in long device,
06971         in boolean nonRotational
06972     );
06973 
07014     void setBandwidthGroupForDevice (
07015         in wstring name,
07016         in long controllerPort,
07017         in long device,
07018         in IBandwidthGroup bandwidthGroup
07019     );
07020 
07083     void mountMedium (
07084         in wstring name,
07085         in long controllerPort,
07086         in long device,
07087         in IMedium medium,
07088         in boolean force
07089     );
07090 
07119     void getMedium (
07120         in wstring name,
07121         in long controllerPort,
07122         in long device,
07123         [retval] out IMedium medium
07124     );
07125 
07140     void getMediumAttachmentsOfController (
07141         in wstring name,
07142         [retval] out IMediumAttachment[] mediumAttachments
07143     );
07144 
07159     void getMediumAttachment (
07160         in wstring name,
07161         in long controllerPort,
07162         in long device,
07163         [retval] out IMediumAttachment attachment
07164     );
07165 
07206     void attachHostPciDevice (
07207         in long hostAddress,
07208         in long desiredGuestAddress,
07209         in boolean tryToUnbind
07210     );
07211 
07252     void detachHostPciDevice (
07253         in long hostAddress
07254     );
07255 
07273     void getNetworkAdapter (
07274         in unsigned long slot,
07275         [retval] out INetworkAdapter adapter
07276     );
07277 
07310     void addStorageController (
07311         in wstring name,
07312         in StorageBus connectionType,
07313         [retval] out IStorageController controller
07314     );
07315 
07329     void getStorageControllerByName (
07330         in wstring name,
07331         [retval] out IStorageController storageController
07332     );
07333 
07347     void getStorageControllerByInstance (
07348         in unsigned long instance,
07349         [retval] out IStorageController storageController
07350     );
07351 
07365     void removeStorageController (
07366         in wstring name
07367     );
07368 
07390     void setStorageControllerBootable (
07391         in wstring name,
07392         in boolean bootable
07393     );
07394 
07412     void getSerialPort (
07413         in unsigned long slot,
07414         [retval] out ISerialPort port
07415     );
07416 
07434     void getParallelPort (
07435         in unsigned long slot,
07436         [retval] out IParallelPort port
07437     );
07438 
07447     void getExtraDataKeys (
07448         [retval] out wstring[] value
07449     );
07450 
07479     void getExtraData (
07480         in wstring key,
07481         [retval] out wstring value
07482     );
07483 
07533     void setExtraData (
07534         in wstring key,
07535         in wstring value
07536     );
07537 
07559     void getCPUProperty (
07560         in CPUPropertyType property,
07561         [retval] out boolean value
07562     );
07563 
07585     void setCPUProperty (
07586         in CPUPropertyType property,
07587         in boolean value
07588     );
07589 
07629     void getCPUIDLeaf (
07630         in unsigned long id,
07631         out unsigned long valEax,
07632         out unsigned long valEbx,
07633         out unsigned long valEcx,
07634         out unsigned long valEdx
07635     );
07636 
07680     void setCPUIDLeaf (
07681         in unsigned long id,
07682         in unsigned long valEax,
07683         in unsigned long valEbx,
07684         in unsigned long valEcx,
07685         in unsigned long valEdx
07686     );
07687 
07705     void removeCPUIDLeaf (
07706         in unsigned long id
07707     );
07708 
07714     void removeAllCPUIDLeaves();
07715 
07737     void getHWVirtExProperty (
07738         in HWVirtExPropertyType property,
07739         [retval] out boolean value
07740     );
07741 
07763     void setHWVirtExProperty (
07764         in HWVirtExPropertyType property,
07765         in boolean value
07766     );
07767 
07813     void saveSettings();
07814 
07838     void discardSettings();
07839 
07923     void unregister (
07924         in CleanupMode cleanupMode,
07925         [retval] out IMedium[] aMedia
07926     );
07927 
07984     void delete (
07985         in IMedium[] aMedia,
07986         [retval] out IProgress aProgress
07987     );
07988 
08000     void export (
08001         in IAppliance aAppliance,
08002         in wstring location,
08003         [retval] out IVirtualSystemDescription aDescription
08004     );
08005 
08029     void findSnapshot (
08030         in wstring nameOrId,
08031         [retval] out ISnapshot snapshot
08032     );
08033 
08067     void createSharedFolder (
08068         in wstring name,
08069         in wstring hostPath,
08070         in boolean writable,
08071         in boolean automount
08072     );
08073 
08099     void removeSharedFolder (
08100         in wstring name
08101     );
08102 
08126     void canShowConsoleWindow (
08127         [retval] out boolean canShow
08128     );
08129 
08164     void showConsoleWindow (
08165         [retval] out long long winId
08166     );
08167 
08200     void getGuestProperty (
08201         in wstring name,
08202         out wstring value,
08203         out long long timestamp,
08204         out wstring flags
08205     );
08206 
08229     void getGuestPropertyValue (
08230         in wstring property,
08231         [retval] out wstring value
08232     );
08233 
08256     void getGuestPropertyTimestamp (
08257         in wstring property,
08258         [retval] out long long value
08259     );
08260 
08311     void setGuestProperty (
08312         in wstring property,
08313         in wstring value,
08314         in wstring flags
08315     );
08316 
08357     void setGuestPropertyValue (
08358         in wstring property,
08359         in wstring value
08360     );
08361 
08392     void enumerateGuestProperties (
08393         in wstring patterns,
08394         out wstring[] name,
08395         out wstring[] value,
08396         out long long[] timestamp,
08397         out wstring[] flags
08398     );
08399 
08417     void querySavedGuestSize (
08418         in unsigned long screenId,
08419         out unsigned long width,
08420         out unsigned long height
08421     );
08422 
08444     void querySavedThumbnailSize (
08445         in unsigned long screenId,
08446         out unsigned long size,
08447         out unsigned long width,
08448         out unsigned long height
08449     );
08450 
08477     void readSavedThumbnailToArray (
08478         in unsigned long screenId,
08479         in boolean BGR,
08480         out unsigned long width,
08481         out unsigned long height,
08482         [retval] out octet[] data
08483     );
08484 
08506     void readSavedThumbnailPNGToArray (
08507         in unsigned long screenId,
08508         out unsigned long width,
08509         out unsigned long height,
08510         [retval] out octet[] data
08511     );
08512 
08534     void querySavedScreenshotPNGSize (
08535         in unsigned long screenId,
08536         out unsigned long size,
08537         out unsigned long width,
08538         out unsigned long height
08539     );
08540 
08562     void readSavedScreenshotPNGToArray (
08563         in unsigned long screenId,
08564         out unsigned long width,
08565         out unsigned long height,
08566         [retval] out octet[] data
08567     );
08568 
08578     void hotPlugCPU (
08579         in unsigned long cpu
08580     );
08581 
08591     void hotUnplugCPU (
08592         in unsigned long cpu
08593     );
08594 
08608     void getCPUStatus (
08609         in unsigned long cpu,
08610         [retval] out boolean attached
08611     );
08612 
08627     void queryLogFilename (
08628         in unsigned long idx,
08629         [retval] out wstring filename
08630     );
08631 
08657     void readLog (
08658         in unsigned long idx,
08659         in long long offset,
08660         in long long size,
08661         [retval] out octet[] data
08662     );
08663 
08696     void cloneTo (
08697         in IMachine target,
08698         in CloneMode mode,
08699         in CloneOptions[] options,
08700         [retval] out IProgress progress
08701     );
08702 
08703 }; /* interface IMachine */
08704 
08713 interface IVRDEServerInfo : $unknown
08714 {
08720     readonly attribute boolean active;
08721 
08730     readonly attribute long port;
08731 
08737     readonly attribute unsigned long numberOfClients;
08738 
08744     readonly attribute long long beginTime;
08745 
08752     readonly attribute long long endTime;
08753 
08759     readonly attribute long long bytesSent;
08760 
08766     readonly attribute long long bytesSentTotal;
08767 
08773     readonly attribute long long bytesReceived;
08774 
08780     readonly attribute long long bytesReceivedTotal;
08781 
08787     readonly attribute wstring user;
08788 
08794     readonly attribute wstring domain;
08795 
08801     readonly attribute wstring clientName;
08802 
08808     readonly attribute wstring clientIP;
08809 
08815     readonly attribute unsigned long clientVersion;
08816 
08824     readonly attribute unsigned long encryptionStyle;
08825 
08826 }; /* interface IVRDEServerInfo */
08827 
08849 interface IConsole : $unknown
08850 {
08862     readonly attribute IMachine machine;
08863 
08877     readonly attribute MachineState state;
08878 
08882     readonly attribute IGuest guest;
08883 
08894     readonly attribute IKeyboard keyboard;
08895 
08906     readonly attribute IMouse mouse;
08907 
08917     readonly attribute IDisplay display;
08918 
08922     readonly attribute IMachineDebugger debugger;
08923 
08934     readonly attribute IUSBDevice[] USBDevices;
08935 
08943     readonly attribute IHostUSBDevice[] remoteUSBDevices;
08944 
08960     readonly attribute ISharedFolder[] sharedFolders;
08961 
08967     readonly attribute IVRDEServerInfo VRDEServerInfo;
08968 
08974     readonly attribute IEventSource eventSource;
08975 
08979     readonly attribute IPciDeviceAttachment[] attachedPciDevices;
08980 
08989     attribute boolean useHostClipboard;
08990 
09055     void powerUp (
09056         [retval] out IProgress progress
09057     );
09058 
09092     void powerUpPaused (
09093         [retval] out IProgress progress
09094     );
09095 
09115     void powerDown (
09116         [retval] out IProgress progress
09117     );
09118 
09138     void reset();
09139 
09159     void pause();
09160 
09180     void resume();
09181 
09201     void powerButton();
09202 
09222     void sleepButton();
09223 
09235     void getPowerButtonHandled (
09236         [retval] out boolean handled
09237     );
09238 
09252     void getGuestEnteredACPIMode (
09253         [retval] out boolean entered
09254     );
09255 
09308     void saveState (
09309         [retval] out IProgress progress
09310     );
09311 
09344     void adoptSavedState (
09345         in wstring savedStateFile
09346     );
09347 
09378     void discardSavedState (
09379         in boolean fRemoveFile
09380     );
09381 
09394     void getDeviceActivity (
09395         in DeviceType type,
09396         [retval] out DeviceActivity activity
09397     );
09398 
09436     void attachUSBDevice (
09437         in wstringUUID id
09438     );
09439 
09474     void detachUSBDevice (
09475         in wstringUUID id,
09476         [retval] out IUSBDevice device
09477     );
09478 
09501     void findUSBDeviceByAddress (
09502         in wstring name,
09503         [retval] out IUSBDevice device
09504     );
09505 
09525     void findUSBDeviceById (
09526         in wstringUUID id,
09527         [retval] out IUSBDevice device
09528     );
09529 
09563     void createSharedFolder (
09564         in wstring name,
09565         in wstring hostPath,
09566         in boolean writable,
09567         in boolean automount
09568     );
09569 
09594     void removeSharedFolder (
09595         in wstring name
09596     );
09597 
09635     void takeSnapshot (
09636         in wstring name,
09637         in wstring description,
09638         [retval] out IProgress progress
09639     );
09640 
09713     void deleteSnapshot (
09714         in wstringUUID id,
09715         [retval] out IProgress progress
09716     );
09717 
09757     void deleteSnapshotAndAllChildren (
09758         in wstringUUID id,
09759         [retval] out IProgress progress
09760     );
09761 
09805     void deleteSnapshotRange (
09806         in wstringUUID startId,
09807         in wstringUUID endId,
09808         [retval] out IProgress progress
09809     );
09810 
09851     void restoreSnapshot (
09852         in ISnapshot snapshot,
09853         [retval] out IProgress progress
09854     );
09855 
09894     void teleport (
09895         in wstring hostname,
09896         in unsigned long tcpport,
09897         in wstring password,
09898         in unsigned long maxDowntime,
09899         [retval] out IProgress progress
09900     );
09901 
09902 }; /* interface IConsole */
09903 
09914 interface IHostNetworkInterface : $unknown
09915 {
09919     readonly attribute wstring name;
09920 
09924     readonly attribute wstringUUID id;
09925 
09929     readonly attribute wstring networkName;
09930 
09934     readonly attribute boolean dhcpEnabled;
09935 
09939     readonly attribute wstring IPAddress;
09940 
09944     readonly attribute wstring networkMask;
09945 
09949     readonly attribute boolean IPV6Supported;
09950 
09954     readonly attribute wstring IPV6Address;
09955 
09959     readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
09960 
09964     readonly attribute wstring hardwareAddress;
09965 
09969     readonly attribute HostNetworkInterfaceMediumType mediumType;
09970 
09974     readonly attribute HostNetworkInterfaceStatus status;
09975 
09979     readonly attribute HostNetworkInterfaceType interfaceType;
09980 
09992     void enableStaticIpConfig (
09993         in wstring IPAddress,
09994         in wstring networkMask
09995     );
09996 
10008     void enableStaticIpConfigV6 (
10009         in wstring IPV6Address,
10010         in unsigned long IPV6NetworkMaskPrefixLength
10011     );
10012 
10016     void enableDynamicIpConfig();
10017 
10021     void dhcpRediscover();
10022 
10023 }; /* interface IHostNetworkInterface */
10024 
10041 interface IHost : $unknown
10042 {
10046     readonly attribute IMedium[] DVDDrives;
10047 
10051     readonly attribute IMedium[] floppyDrives;
10052 
10066     readonly attribute IHostUSBDevice[] USBDevices;
10067 
10091     readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
10092 
10096     readonly attribute IHostNetworkInterface[] networkInterfaces;
10097 
10101     readonly attribute unsigned long processorCount;
10102 
10106     readonly attribute unsigned long processorOnlineCount;
10107 
10111     readonly attribute unsigned long processorCoreCount;
10112 
10116     readonly attribute unsigned long memorySize;
10117 
10121     readonly attribute unsigned long memoryAvailable;
10122 
10126     readonly attribute wstring operatingSystem;
10127 
10131     readonly attribute wstring OSVersion;
10132 
10136     readonly attribute long long UTCTime;
10137 
10141     readonly attribute boolean Acceleration3DAvailable;
10142 
10157     void getProcessorSpeed (
10158         in unsigned long cpuId,
10159         [retval] out unsigned long speed
10160     );
10161 
10173     void getProcessorFeature (
10174         in ProcessorFeature feature,
10175         [retval] out boolean supported
10176     );
10177 
10196     void getProcessorDescription (
10197         in unsigned long cpuId,
10198         [retval] out wstring description
10199     );
10200 
10241     void getProcessorCPUIDLeaf (
10242         in unsigned long cpuId,
10243         in unsigned long leaf,
10244         in unsigned long subLeaf,
10245         out unsigned long valEax,
10246         out unsigned long valEbx,
10247         out unsigned long valEcx,
10248         out unsigned long valEdx
10249     );
10250 
10271     void createHostOnlyNetworkInterface (
10272         out IHostNetworkInterface hostInterface,
10273         [retval] out IProgress progress
10274     );
10275 
10296     void removeHostOnlyNetworkInterface (
10297         in wstringUUID id,
10298         [retval] out IProgress progress
10299     );
10300 
10320     void createUSBDeviceFilter (
10321         in wstring name,
10322         [retval] out IHostUSBDeviceFilter filter
10323     );
10324 
10367     void insertUSBDeviceFilter (
10368         in unsigned long position,
10369         in IHostUSBDeviceFilter filter
10370     );
10371 
10399     void removeUSBDeviceFilter (
10400         in unsigned long position
10401     );
10402 
10420     void findHostDVDDrive (
10421         in wstring name,
10422         [retval] out IMedium drive
10423     );
10424 
10442     void findHostFloppyDrive (
10443         in wstring name,
10444         [retval] out IMedium drive
10445     );
10446 
10462     void findHostNetworkInterfaceByName (
10463         in wstring name,
10464         [retval] out IHostNetworkInterface networkInterface
10465     );
10466 
10482     void findHostNetworkInterfaceById (
10483         in wstringUUID id,
10484         [retval] out IHostNetworkInterface networkInterface
10485     );
10486 
10496     void findHostNetworkInterfacesOfType (
10497         in HostNetworkInterfaceType type,
10498         [retval] out IHostNetworkInterface[] networkInterfaces
10499     );
10500 
10520     void findUSBDeviceById (
10521         in wstringUUID id,
10522         [retval] out IHostUSBDevice device
10523     );
10524 
10547     void findUSBDeviceByAddress (
10548         in wstring name,
10549         [retval] out IHostUSBDevice device
10550     );
10551 
10559     void generateMACAddress (
10560         [retval] out wstring address
10561     );
10562 
10563 }; /* interface IHost */
10564 
10577 interface ISystemProperties : $unknown
10578 {
10582     readonly attribute unsigned long minGuestRAM;
10583 
10587     readonly attribute unsigned long maxGuestRAM;
10588 
10592     readonly attribute unsigned long minGuestVRAM;
10593 
10597     readonly attribute unsigned long maxGuestVRAM;
10598 
10602     readonly attribute unsigned long minGuestCPUCount;
10603 
10607     readonly attribute unsigned long maxGuestCPUCount;
10608 
10612     readonly attribute unsigned long maxGuestMonitors;
10613 
10618     readonly attribute long long infoVDSize;
10619 
10626     readonly attribute unsigned long serialPortCount;
10627 
10634     readonly attribute unsigned long parallelPortCount;
10635 
10645     readonly attribute unsigned long maxBootPosition;
10646 
10670     attribute wstring defaultMachineFolder;
10671 
10696     readonly attribute IMediumFormat[] mediumFormats;
10697 
10731     attribute wstring defaultHardDiskFormat;
10732 
10738     attribute long long freeDiskSpaceWarning;
10739 
10744     attribute unsigned long freeDiskSpacePercentWarning;
10745 
10751     attribute long long freeDiskSpaceError;
10752 
10757     attribute unsigned long freeDiskSpacePercentError;
10758 
10782     attribute wstring VRDEAuthLibrary;
10783 
10812     attribute wstring webServiceAuthLibrary;
10813 
10827     attribute wstring defaultVRDEExtPack;
10828 
10834     attribute unsigned long logHistoryCount;
10835 
10840     readonly attribute AudioDriverType defaultAudioDriver;
10841 
10852     void getMaxNetworkAdapters (
10853         in ChipsetType chipset,
10854         [retval] out unsigned long maxNetworkAdapters
10855     );
10856 
10870     void getMaxNetworkAdaptersOfType (
10871         in ChipsetType chipset,
10872         in NetworkAttachmentType type,
10873         [retval] out unsigned long maxNetworkAdapters
10874     );
10875 
10885     void getMaxDevicesPerPortForStorageBus (
10886         in StorageBus bus,
10887         [retval] out unsigned long maxDevicesPerPort
10888     );
10889 
10897     void getMinPortCountForStorageBus (
10898         in StorageBus bus,
10899         [retval] out unsigned long minPortCount
10900     );
10901 
10909     void getMaxPortCountForStorageBus (
10910         in StorageBus bus,
10911         [retval] out unsigned long maxPortCount
10912     );
10913 
10926     void getMaxInstancesOfStorageBus (
10927         in ChipsetType chipset,
10928         in StorageBus bus,
10929         [retval] out unsigned long maxInstances
10930     );
10931 
10941     void getDeviceTypesForStorageBus (
10942         in StorageBus bus,
10943         [retval] out DeviceType[] deviceTypes
10944     );
10945 
10954     void getDefaultIoCacheSettingForStorageController (
10955         in StorageControllerType controllerType,
10956         [retval] out boolean enabled
10957     );
10958 
10959 }; /* interface ISystemProperties */
10960 
10966 interface IGuestOSType : $unknown
10967 {
10971     readonly attribute wstring familyId;
10972 
10976     readonly attribute wstring familyDescription;
10977 
10981     readonly attribute wstring id;
10982 
10986     readonly attribute wstring description;
10987 
10991     readonly attribute boolean is64Bit;
10992 
10996     readonly attribute boolean recommendedIOAPIC;
10997 
11001     readonly attribute boolean recommendedVirtEx;
11002 
11006     readonly attribute unsigned long recommendedRAM;
11007 
11011     readonly attribute unsigned long recommendedVRAM;
11012 
11016     readonly attribute long long recommendedHDD;
11017 
11021     readonly attribute NetworkAdapterType adapterType;
11022 
11026     readonly attribute boolean recommendedPae;
11027 
11031     readonly attribute StorageControllerType recommendedDvdStorageController;
11032 
11036     readonly attribute StorageBus recommendedDvdStorageBus;
11037 
11041     readonly attribute StorageControllerType recommendedHdStorageController;
11042 
11046     readonly attribute StorageBus recommendedHdStorageBus;
11047 
11051     readonly attribute FirmwareType recommendedFirmware;
11052 
11056     readonly attribute boolean recommendedUsbHid;
11057 
11061     readonly attribute boolean recommendedHpet;
11062 
11066     readonly attribute boolean recommendedUsbTablet;
11067 
11071     readonly attribute boolean recommendedRtcUseUtc;
11072 
11076     readonly attribute ChipsetType recommendedChipset;
11077 
11081     readonly attribute AudioControllerType recommendedAudioController;
11082 
11083 }; /* interface IGuestOSType */
11084 
11092 interface IAdditionsFacility : $unknown
11093 {
11097     readonly attribute AdditionsFacilityClass classType;
11098 
11105     readonly attribute long long lastUpdated;
11106 
11110     readonly attribute wstring name;
11111 
11115     readonly attribute AdditionsFacilityStatus status;
11116 
11120     readonly attribute AdditionsFacilityType type;
11121 
11122 }; /* interface IAdditionsFacility */
11123 
11131 interface IGuestDirEntry : $unknown
11132 {
11136     readonly attribute long long nodeId;
11137 
11141     readonly attribute wstring name;
11142 
11146     readonly attribute GuestDirEntryType type;
11147 
11148 }; /* interface IGuestDirEntry */
11149 
11163 interface IGuest : $unknown
11164 {
11179     readonly attribute wstring OSTypeId;
11180 
11186     readonly attribute AdditionsRunLevelType additionsRunLevel;
11187 
11195     readonly attribute wstring additionsVersion;
11196 
11203     readonly attribute IAdditionsFacility[] facilities;
11204 
11208     attribute unsigned long memoryBalloonSize;
11209 
11213     attribute unsigned long statisticsUpdateInterval;
11214 
11246     void internalGetStatistics (
11247         out unsigned long cpuUser,
11248         out unsigned long cpuKernel,
11249         out unsigned long cpuIdle,
11250         out unsigned long memTotal,
11251         out unsigned long memFree,
11252         out unsigned long memBalloon,
11253         out unsigned long memShared,
11254         out unsigned long memCache,
11255         out unsigned long pagedTotal,
11256         out unsigned long memAllocTotal,
11257         out unsigned long memFreeTotal,
11258         out unsigned long memBalloonTotal,
11259         out unsigned long memSharedTotal
11260     );
11261 
11273     void getFacilityStatus (
11274         in AdditionsFacilityType facility,
11275         out long long timestamp,
11276         [retval] out AdditionsFacilityStatus status
11277     );
11278 
11296     void getAdditionsStatus (
11297         in AdditionsRunLevelType level,
11298         [retval] out boolean active
11299     );
11300 
11330     void setCredentials (
11331         in wstring userName,
11332         in wstring password,
11333         in wstring domain,
11334         in boolean allowInteractiveLogon
11335     );
11336 
11406     void executeProcess (
11407         in wstring execName,
11408         in unsigned long flags,
11409         in wstring[] arguments,
11410         in wstring[] environment,
11411         in wstring userName,
11412         in wstring password,
11413         in unsigned long timeoutMS,
11414         out unsigned long pid,
11415         [retval] out IProgress progress
11416     );
11417 
11462     void getProcessOutput (
11463         in unsigned long pid,
11464         in unsigned long flags,
11465         in unsigned long timeoutMS,
11466         in long long size,
11467         [retval] out octet[] data
11468     );
11469 
11503     void getProcessStatus (
11504         in unsigned long pid,
11505         out unsigned long exitcode,
11506         out unsigned long flags,
11507         [retval] out ExecuteProcessStatus reason
11508     );
11509 
11546     void copyFromGuest (
11547         in wstring source,
11548         in wstring dest,
11549         in wstring userName,
11550         in wstring password,
11551         in unsigned long flags,
11552         [retval] out IProgress progress
11553     );
11554 
11591     void copyToGuest (
11592         in wstring source,
11593         in wstring dest,
11594         in wstring userName,
11595         in wstring password,
11596         in unsigned long flags,
11597         [retval] out IProgress progress
11598     );
11599 
11617     void directoryClose (
11618         in unsigned long handle
11619     );
11620 
11655     void directoryCreate (
11656         in wstring directory,
11657         in wstring userName,
11658         in wstring password,
11659         in unsigned long mode,
11660         in unsigned long flags
11661     );
11662 
11702     void directoryOpen (
11703         in wstring directory,
11704         in wstring filter,
11705         in unsigned long flags,
11706         in wstring userName,
11707         in wstring password,
11708         [retval] out unsigned long handle
11709     );
11710 
11740     void directoryRead (
11741         in unsigned long handle,
11742         [retval] out IGuestDirEntry entry
11743     );
11744 
11780     void fileExists (
11781         in wstring file,
11782         in wstring userName,
11783         in wstring password,
11784         [retval] out boolean exists
11785     );
11786 
11818     void fileQuerySize (
11819         in wstring file,
11820         in wstring userName,
11821         in wstring password,
11822         [retval] out long long size
11823     );
11824 
11858     void setProcessInput (
11859         in unsigned long pid,
11860         in unsigned long flags,
11861         in unsigned long timeoutMS,
11862         in octet[] data,
11863         [retval] out unsigned long written
11864     );
11865 
11889     void updateGuestAdditions (
11890         in wstring source,
11891         in unsigned long flags,
11892         [retval] out IProgress progress
11893     );
11894 
11895 }; /* interface IGuest */
11896 
11937 interface IProgress : $unknown
11938 {
11942     readonly attribute wstringUUID id;
11943 
11947     readonly attribute wstring description;
11948 
11952     readonly attribute $unknown initiator;
11953 
11957     readonly attribute boolean cancelable;
11958 
11966     readonly attribute unsigned long percent;
11967 
11981     readonly attribute long timeRemaining;
11982 
11986     readonly attribute boolean completed;
11987 
11991     readonly attribute boolean canceled;
11992 
11999     readonly attribute long resultCode;
12000 
12010     readonly attribute IVirtualBoxErrorInfo errorInfo;
12011 
12018     readonly attribute unsigned long operationCount;
12019 
12023     readonly attribute unsigned long operation;
12024 
12030     readonly attribute wstring operationDescription;
12031 
12035     readonly attribute unsigned long operationPercent;
12036 
12040     readonly attribute unsigned long operationWeight;
12041 
12049     attribute unsigned long timeout;
12050 
12054     void setCurrentOperationProgress (
12055         in unsigned long percent
12056     );
12057 
12061     void setNextOperation (
12062         in wstring nextOperationDescription,
12063         in unsigned long nextOperationsWeight
12064     );
12065 
12092     void waitForCompletion (
12093         in long timeout
12094     );
12095 
12119     void waitForOperationCompletion (
12120         in unsigned long operation,
12121         in long timeout
12122     );
12123 
12149     void waitForAsyncProgressCompletion (
12150         in IProgress pProgressAsync
12151     );
12152 
12169     void cancel();
12170 
12171 }; /* interface IProgress */
12172 
12256 interface ISnapshot : $unknown
12257 {
12261     readonly attribute wstringUUID id;
12262 
12270     attribute wstring name;
12271 
12279     attribute wstring description;
12280 
12286     readonly attribute long long timeStamp;
12287 
12299     readonly attribute boolean online;
12300 
12312     readonly attribute IMachine machine;
12313 
12320     readonly attribute ISnapshot parent;
12321 
12330     readonly attribute ISnapshot[] children;
12331 
12339     void getChildrenCount (
12340         [retval] out unsigned long childrenCount
12341     );
12342 
12343 }; /* interface ISnapshot */
12344 
12531 interface IMediumAttachment : $unknown
12532 {
12537     readonly attribute IMedium medium;
12538 
12544     readonly attribute wstring controller;
12545 
12551     readonly attribute long port;
12552 
12558     readonly attribute long device;
12559 
12563     readonly attribute DeviceType type;
12564 
12568     readonly attribute boolean passthrough;
12569 
12573     readonly attribute boolean temporaryEject;
12574 
12579     readonly attribute boolean isEjected;
12580 
12584     readonly attribute boolean nonRotational;
12585 
12589     readonly attribute IBandwidthGroup bandwidthGroup;
12590 
12591 }; /* interface IMediumAttachment */
12592 
12750 interface IMedium : $unknown
12751 {
12765     readonly attribute wstringUUID id;
12766 
12785     attribute wstring description;
12786 
12802     readonly attribute MediumState state;
12803 
12812     readonly attribute unsigned long variant;
12813 
12835     attribute wstring location;
12836 
12856     readonly attribute wstring name;
12857 
12862     readonly attribute DeviceType deviceType;
12863 
12867     readonly attribute boolean hostDrive;
12868 
12881     readonly attribute long long size;
12882 
12897     readonly attribute wstring format;
12898 
12914     readonly attribute IMediumFormat mediumFormat;
12915 
12940     attribute MediumType type;
12941 
12955     readonly attribute MediumType[] allowedTypes;
12956 
12966     readonly attribute IMedium parent;
12967 
12975     readonly attribute IMedium[] children;
12976 
12987     readonly attribute IMedium base;
12988 
13021     readonly attribute boolean readOnly;
13022 
13043     readonly attribute long long logicalSize;
13044 
13072     attribute boolean autoReset;
13073 
13088     readonly attribute wstring lastAccessError;
13089 
13106     readonly attribute wstringUUID[] machineIds;
13107 
13133     void setIDs (
13134         in boolean setImageId,
13135         in wstringUUID imageId,
13136         in boolean setParentId,
13137         in wstringUUID parentId
13138     );
13139 
13174     void refreshState (
13175         [retval] out MediumState state
13176     );
13177 
13204     void getSnapshotIds (
13205         in wstringUUID machineId,
13206         [retval] out wstringUUID[] snapshotIds
13207     );
13208 
13268     void lockRead (
13269         [retval] out MediumState state
13270     );
13271 
13294     void unlockRead (
13295         [retval] out MediumState state
13296     );
13297 
13352     void lockWrite (
13353         [retval] out MediumState state
13354     );
13355 
13378     void unlockWrite (
13379         [retval] out MediumState state
13380     );
13381 
13431     void close();
13432 
13462     void getProperty (
13463         in wstring name,
13464         [retval] out wstring value
13465     );
13466 
13498     void setProperty (
13499         in wstring name,
13500         in wstring value
13501     );
13502 
13537     void getProperties (
13538         in wstring names,
13539         out wstring[] returnNames,
13540         [retval] out wstring[] returnValues
13541     );
13542 
13572     void setProperties (
13573         in wstring[] names,
13574         in wstring[] values
13575     );
13576 
13609     void createBaseStorage (
13610         in long long logicalSize,
13611         in unsigned long variant,
13612         [retval] out IProgress progress
13613     );
13614 
13666     void deleteStorage (
13667         [retval] out IProgress progress
13668     );
13669 
13708     void createDiffStorage (
13709         in IMedium target,
13710         in unsigned long variant,
13711         [retval] out IProgress progress
13712     );
13713 
13789     void mergeTo (
13790         in IMedium target,
13791         [retval] out IProgress progress
13792     );
13793 
13843     void cloneTo (
13844         in IMedium target,
13845         in unsigned long variant,
13846         in IMedium parent,
13847         [retval] out IProgress progress
13848     );
13849 
13878     void compact (
13879         [retval] out IProgress progress
13880     );
13881 
13914     void resize (
13915         in long long logicalSize,
13916         [retval] out IProgress progress
13917     );
13918 
13952     void reset (
13953         [retval] out IProgress progress
13954     );
13955 
13956 }; /* interface IMedium */
13957 
13980 interface IMediumFormat : $unknown
13981 {
14000     readonly attribute wstring id;
14001 
14009     readonly attribute wstring name;
14010 
14019     readonly attribute unsigned long capabilities;
14020 
14039     void describeFileExtensions (
14040         out wstring[] extensions,
14041         out DeviceType[] type
14042     );
14043 
14071     void describeProperties (
14072         out wstring[] names,
14073         out wstring[] description,
14074         out DataType[] types,
14075         out unsigned long[] flags,
14076         out wstring[] defaults
14077     );
14078 
14079 }; /* interface IMediumFormat */
14080 
14093 interface IKeyboard : $unknown
14094 {
14100     readonly attribute IEventSource eventSource;
14101 
14114     void putScancode (
14115         in long scancode
14116     );
14117 
14130     void putScancodes (
14131         in long[] scancodes,
14132         [retval] out unsigned long codesStored
14133     );
14134 
14149     void putCAD();
14150 
14151 }; /* interface IKeyboard */
14152 
14164 interface IMouse : $unknown
14165 {
14180     readonly attribute boolean absoluteSupported;
14181 
14196     readonly attribute boolean relativeSupported;
14197 
14212     readonly attribute boolean needsHostCursor;
14213 
14219     readonly attribute IEventSource eventSource;
14220 
14286     void putMouseEvent (
14287         in long dx,
14288         in long dy,
14289         in long dz,
14290         in long dw,
14291         in long buttonState
14292     );
14293 
14366     void putMouseEventAbsolute (
14367         in long x,
14368         in long y,
14369         in long dz,
14370         in long dw,
14371         in long buttonState
14372     );
14373 
14374 }; /* interface IMouse */
14375 
14376 interface IFramebuffer : $unknown
14377 {
14386     readonly attribute octetPtr address;
14387 
14391     readonly attribute unsigned long width;
14392 
14396     readonly attribute unsigned long height;
14397 
14404     readonly attribute unsigned long bitsPerPixel;
14405 
14412     readonly attribute unsigned long bytesPerLine;
14413 
14424     readonly attribute unsigned long pixelFormat;
14425 
14432     readonly attribute boolean usesGuestVRAM;
14433 
14443     readonly attribute unsigned long heightReduction;
14444 
14459     readonly attribute IFramebufferOverlay overlay;
14460 
14467     readonly attribute long long winId;
14468 
14476     void lock();
14477 
14485     void unlock();
14486 
14494     void notifyUpdate (
14495         in unsigned long x,
14496         in unsigned long y,
14497         in unsigned long width,
14498         in unsigned long height
14499     );
14500 
14613     void requestResize (
14614         in unsigned long screenId,
14615         in unsigned long pixelFormat,
14616         in octetPtr VRAM,
14617         in unsigned long bitsPerPixel,
14618         in unsigned long bytesPerLine,
14619         in unsigned long width,
14620         in unsigned long height,
14621         [retval] out boolean finished
14622     );
14623 
14635     void videoModeSupported (
14636         in unsigned long width,
14637         in unsigned long height,
14638         in unsigned long bpp,
14639         [retval] out boolean supported
14640     );
14641 
14678     void getVisibleRegion (
14679         in octetPtr rectangles,
14680         in unsigned long count,
14681         [retval] out unsigned long countCopied
14682     );
14683 
14718     void setVisibleRegion (
14719         in octetPtr rectangles,
14720         in unsigned long count
14721     );
14722 
14743     void processVHWACommand (
14744         in octetPtr command
14745     );
14746 
14747 }; /* interface IFramebuffer */
14748 
14763 interface IFramebufferOverlay : IFramebuffer
14764 {
14768     readonly attribute unsigned long x;
14769 
14773     readonly attribute unsigned long y;
14774 
14780     attribute boolean visible;
14781 
14788     attribute unsigned long alpha;
14789 
14795     void move (
14796         in unsigned long x,
14797         in unsigned long y
14798     );
14799 
14800 }; /* interface IFramebufferOverlay */
14801 
14817 interface IDisplay : $unknown
14818 {
14822     void getScreenResolution (
14823         in unsigned long screenId,
14824         out unsigned long width,
14825         out unsigned long height,
14826         out unsigned long bitsPerPixel
14827     );
14828 
14834     void setFramebuffer (
14835         in unsigned long screenId,
14836         in IFramebuffer framebuffer
14837     );
14838 
14844     void getFramebuffer (
14845         in unsigned long screenId,
14846         out IFramebuffer framebuffer,
14847         out long xOrigin,
14848         out long yOrigin
14849     );
14850 
14879     void setVideoModeHint (
14880         in unsigned long width,
14881         in unsigned long height,
14882         in unsigned long bitsPerPixel,
14883         in unsigned long display
14884     );
14885 
14897     void setSeamlessMode (
14898         in boolean enabled
14899     );
14900 
14936     void takeScreenShot (
14937         in unsigned long screenId,
14938         in octetPtr address,
14939         in unsigned long width,
14940         in unsigned long height
14941     );
14942 
14986     void takeScreenShotToArray (
14987         in unsigned long screenId,
14988         in unsigned long width,
14989         in unsigned long height,
14990         [retval] out octet[] screenData
14991     );
14992 
15031     void takeScreenShotPNGToArray (
15032         in unsigned long screenId,
15033         in unsigned long width,
15034         in unsigned long height,
15035         [retval] out octet[] screenData
15036     );
15037 
15089     void drawToScreen (
15090         in unsigned long screenId,
15091         in octetPtr address,
15092         in unsigned long x,
15093         in unsigned long y,
15094         in unsigned long width,
15095         in unsigned long height
15096     );
15097 
15112     void invalidateAndUpdate();
15113 
15127     void resizeCompleted (
15128         in unsigned long screenId
15129     );
15130 
15143     void completeVHWACommand (
15144         in octetPtr command
15145     );
15146 
15147 }; /* interface IDisplay */
15148 
15164 interface INetworkAdapter : $unknown
15165 {
15173     attribute NetworkAdapterType adapterType;
15174 
15182     readonly attribute unsigned long slot;
15183 
15192     attribute boolean enabled;
15193 
15200     attribute wstring MACAddress;
15201 
15207     attribute NetworkAttachmentType attachmentType;
15208 
15214     attribute wstring bridgedInterface;
15215 
15221     attribute wstring hostOnlyInterface;
15222 
15228     attribute wstring internalNetwork;
15229 
15235     attribute wstring NATNetwork;
15236 
15242     attribute wstring genericDriver;
15243 
15250     attribute boolean cableConnected;
15251 
15257     attribute unsigned long lineSpeed;
15258 
15265     attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
15266 
15273     attribute boolean traceEnabled;
15274 
15281     attribute wstring traceFile;
15282 
15290     readonly attribute INATEngine natDriver;
15291 
15298     attribute unsigned long bootPriority;
15299 
15303     attribute IBandwidthGroup bandwidthGroup;
15304 
15323     void getProperty (
15324         in wstring key,
15325         [retval] out wstring value
15326     );
15327 
15346     void setProperty (
15347         in wstring key,
15348         in wstring value
15349     );
15350 
15378     void getProperties (
15379         in wstring names,
15380         out wstring[] returnNames,
15381         [retval] out wstring[] returnValues
15382     );
15383 
15384 }; /* interface INetworkAdapter */
15385 
15414 interface ISerialPort : $unknown
15415 {
15423     readonly attribute unsigned long slot;
15424 
15431     attribute boolean enabled;
15432 
15436     attribute unsigned long IOBase;
15437 
15441     attribute unsigned long IRQ;
15442 
15453     attribute PortMode hostMode;
15454 
15462     attribute boolean server;
15463 
15473     attribute wstring path;
15474 
15475 }; /* interface ISerialPort */
15476 
15496 interface IParallelPort : $unknown
15497 {
15505     readonly attribute unsigned long slot;
15506 
15513     attribute boolean enabled;
15514 
15518     attribute unsigned long IOBase;
15519 
15523     attribute unsigned long IRQ;
15524 
15532     attribute wstring path;
15533 
15534 }; /* interface IParallelPort */
15535 
15536 interface IMachineDebugger : $unknown
15537 {
15541     attribute boolean singlestep;
15542 
15546     attribute boolean recompileUser;
15547 
15551     attribute boolean recompileSupervisor;
15552 
15556     attribute boolean PATMEnabled;
15557 
15561     attribute boolean CSAMEnabled;
15562 
15566     attribute boolean logEnabled;
15567 
15571     readonly attribute wstring logFlags;
15572 
15576     readonly attribute wstring logGroups;
15577 
15581     readonly attribute wstring logDestinations;
15582 
15589     readonly attribute boolean HWVirtExEnabled;
15590 
15597     readonly attribute boolean HWVirtExNestedPagingEnabled;
15598 
15605     readonly attribute boolean HWVirtExVPIDEnabled;
15606 
15615     readonly attribute wstring OSName;
15616 
15625     readonly attribute wstring OSVersion;
15626 
15633     readonly attribute boolean PAEEnabled;
15634 
15641     attribute unsigned long virtualTimeRate;
15642 
15649     readonly attribute long long VM;
15650 
15666     void dumpGuestCore (
15667         in wstring filename,
15668         in wstring compression
15669     );
15670 
15687     void dumpHostProcessCore (
15688         in wstring filename,
15689         in wstring compression
15690     );
15691 
15712     void info (
15713         in wstring name,
15714         in wstring args,
15715         [retval] out wstring info
15716     );
15717 
15723     void injectNMI();
15724 
15735     void modifyLogGroups (
15736         in wstring settings
15737     );
15738 
15749     void modifyLogFlags (
15750         in wstring settings
15751     );
15752 
15763     void modifyLogDestinations (
15764         in wstring settings
15765     );
15766 
15781     void readPhysicalMemory (
15782         in long long address,
15783         in unsigned long size,
15784         [retval] out octet[] bytes
15785     );
15786 
15801     void writePhysicalMemory (
15802         in long long address,
15803         in unsigned long size,
15804         in octet[] bytes
15805     );
15806 
15823     void readVirtualMemory (
15824         in unsigned long cpuId,
15825         in long long address,
15826         in unsigned long size,
15827         [retval] out octet[] bytes
15828     );
15829 
15846     void writeVirtualMemory (
15847         in unsigned long cpuId,
15848         in long long address,
15849         in unsigned long size,
15850         in octet[] bytes
15851     );
15852 
15865     void detectOS (
15866         [retval] out wstring os
15867     );
15868 
15886     void getRegister (
15887         in unsigned long cpuId,
15888         in wstring name,
15889         [retval] out wstring value
15890     );
15891 
15909     void getRegisters (
15910         in unsigned long cpuId,
15911         out wstring[] names,
15912         out wstring[] values
15913     );
15914 
15933     void setRegister (
15934         in unsigned long cpuId,
15935         in wstring name,
15936         in wstring value
15937     );
15938 
15957     void setRegisters (
15958         in unsigned long cpuId,
15959         in wstring[] names,
15960         in wstring[] values
15961     );
15962 
15975     void dumpGuestStack (
15976         in unsigned long cpuId,
15977         [retval] out wstring stack
15978     );
15979 
15987     void resetStats (
15988         in wstring pattern
15989     );
15990 
15998     void dumpStats (
15999         in wstring pattern
16000     );
16001 
16013     void getStats (
16014         in wstring pattern,
16015         in boolean withDescriptions,
16016         out wstring stats
16017     );
16018 
16019 }; /* interface IMachineDebugger */
16020 
16021 interface IUSBController : $unknown
16022 {
16031     attribute boolean enabled;
16032 
16041     attribute boolean enabledEhci;
16042 
16048     readonly attribute boolean proxyAvailable;
16049 
16057     readonly attribute unsigned short USBStandard;
16058 
16084     readonly attribute IUSBDeviceFilter[] deviceFilters;
16085 
16113     void createDeviceFilter (
16114         in wstring name,
16115         [retval] out IUSBDeviceFilter filter
16116     );
16117 
16162     void insertDeviceFilter (
16163         in unsigned long position,
16164         in IUSBDeviceFilter filter
16165     );
16166 
16199     void removeDeviceFilter (
16200         in unsigned long position,
16201         [retval] out IUSBDeviceFilter filter
16202     );
16203 
16204 }; /* interface IUSBController */
16205 
16218 interface IUSBDevice : $unknown
16219 {
16226     readonly attribute wstringUUID id;
16227 
16231     readonly attribute unsigned short vendorId;
16232 
16236     readonly attribute unsigned short productId;
16237 
16245     readonly attribute unsigned short revision;
16246 
16250     readonly attribute wstring manufacturer;
16251 
16255     readonly attribute wstring product;
16256 
16260     readonly attribute wstring serialNumber;
16261 
16265     readonly attribute wstring address;
16266 
16273     readonly attribute unsigned short port;
16274 
16280     readonly attribute unsigned short version;
16281 
16289     readonly attribute unsigned short portVersion;
16290 
16297     readonly attribute boolean remote;
16298 
16299 }; /* interface IUSBDevice */
16300 
16375 interface IUSBDeviceFilter : $unknown
16376 {
16384     attribute wstring name;
16385 
16389     attribute boolean active;
16390 
16398     attribute wstring vendorId;
16399 
16407     attribute wstring productId;
16408 
16422     attribute wstring revision;
16423 
16428     attribute wstring manufacturer;
16429 
16434     attribute wstring product;
16435 
16440     attribute wstring serialNumber;
16441 
16446     attribute wstring port;
16447 
16457     attribute wstring remote;
16458 
16468     attribute unsigned long maskedInterfaces;
16469 
16470 }; /* interface IUSBDeviceFilter */
16471 
16488 interface IHostUSBDevice : IUSBDevice
16489 {
16495     readonly attribute USBDeviceState state;
16496 
16497 }; /* interface IHostUSBDevice */
16498 
16521 interface IHostUSBDeviceFilter : IUSBDeviceFilter
16522 {
16529     attribute USBDeviceFilterAction action;
16530 
16531 }; /* interface IHostUSBDeviceFilter */
16532 
16541 interface IAudioAdapter : $unknown
16542 {
16551     attribute boolean enabled;
16552 
16558     attribute AudioControllerType audioController;
16559 
16566     attribute AudioDriverType audioDriver;
16567 
16568 }; /* interface IAudioAdapter */
16569 
16570 interface IVRDEServer : $unknown
16571 {
16575     attribute boolean enabled;
16576 
16580     attribute AuthType authType;
16581 
16585     attribute unsigned long authTimeout;
16586 
16593     attribute boolean allowMultiConnection;
16594 
16602     attribute boolean reuseSingleConnection;
16603 
16610     attribute wstring VRDEExtPack;
16611 
16618     attribute wstring authLibrary;
16619 
16625     readonly attribute wstring[] VRDEProperties;
16626 
16640     void setVRDEProperty (
16641         in wstring key,
16642         in wstring value
16643     );
16644 
16658     void getVRDEProperty (
16659         in wstring key,
16660         [retval] out wstring value
16661     );
16662 
16663 }; /* interface IVRDEServer */
16664 
16722 interface ISharedFolder : $unknown
16723 {
16727     readonly attribute wstring name;
16728 
16732     readonly attribute wstring hostPath;
16733 
16743     readonly attribute boolean accessible;
16744 
16751     readonly attribute boolean writable;
16752 
16758     readonly attribute boolean autoMount;
16759 
16772     readonly attribute wstring lastAccessError;
16773 
16774 }; /* interface ISharedFolder */
16775 
16776 interface IInternalSessionControl : $unknown
16777 {
16782     void getPID (
16783         [retval] out unsigned long pid
16784     );
16785 
16807     void getRemoteConsole (
16808         [retval] out IConsole console
16809     );
16810 
16834     void assignMachine (
16835         in IMachine machine
16836     );
16837 
16852     void assignRemoteMachine (
16853         in IMachine machine,
16854         in IConsole console
16855     );
16856 
16880     void updateMachineState (
16881         in MachineState aMachineState
16882     );
16883 
16899     void uninitialize();
16900 
16923     void onNetworkAdapterChange (
16924         in INetworkAdapter networkAdapter,
16925         in boolean changeAdapter
16926     );
16927 
16950     void onSerialPortChange (
16951         in ISerialPort serialPort
16952     );
16953 
16976     void onParallelPortChange (
16977         in IParallelPort parallelPort
16978     );
16979 
17002     void onStorageControllerChange();
17003 
17030     void onMediumChange (
17031         in IMediumAttachment mediumAttachment,
17032         in boolean force
17033     );
17034 
17061     void onStorageDeviceChange (
17062         in IMediumAttachment mediumAttachment,
17063         in boolean remove
17064     );
17065 
17075     void onCPUChange (
17076         in unsigned long cpu,
17077         in boolean add
17078     );
17079 
17087     void onCPUExecutionCapChange (
17088         in unsigned long executionCap
17089     );
17090 
17115     void onVRDEServerChange (
17116         in boolean restart
17117     );
17118 
17141     void onUSBControllerChange();
17142 
17171     void onSharedFolderChange (
17172         in boolean global
17173     );
17174 
17200     void onUSBDeviceAttach (
17201         in IUSBDevice device,
17202         in IVirtualBoxErrorInfo error,
17203         in unsigned long maskedInterfaces
17204     );
17205 
17231     void onUSBDeviceDetach (
17232         in wstringUUID id,
17233         in IVirtualBoxErrorInfo error
17234     );
17235 
17253     void onShowWindow (
17254         in boolean check,
17255         out boolean canShow,
17256         out long long winId
17257     );
17258 
17266     void onBandwidthGroupChange (
17267         in IBandwidthGroup bandwidthGroup
17268     );
17269 
17293     void accessGuestProperty (
17294         in wstring name,
17295         in wstring value,
17296         in wstring flags,
17297         in boolean isSetter,
17298         out wstring retValue,
17299         out long long retTimestamp,
17300         out wstring retFlags
17301     );
17302 
17350     void enumerateGuestProperties (
17351         in wstring patterns,
17352         out wstring[] key,
17353         out wstring[] value,
17354         out long long[] timestamp,
17355         out wstring[] flags
17356     );
17357 
17403     void onlineMergeMedium (
17404         in IMediumAttachment mediumAttachment,
17405         in unsigned long sourceIdx,
17406         in unsigned long targetIdx,
17407         in IMedium source,
17408         in IMedium target,
17409         in boolean mergeForward,
17410         in IMedium parentForTarget,
17411         in IMedium[] childrenToReparent,
17412         in IProgress progress
17413     );
17414 
17438     void enableVMMStatistics (
17439         in boolean enable
17440     );
17441 
17442 }; /* interface IInternalSessionControl */
17443 
17502 interface ISession : $unknown
17503 {
17507     readonly attribute SessionState state;
17508 
17516     readonly attribute SessionType type;
17517 
17521     readonly attribute IMachine machine;
17522 
17526     readonly attribute IConsole console;
17527 
17559     void unlockMachine();
17560 
17561 }; /* interface ISession */
17562 
17585 interface IStorageController : $unknown
17586 {
17595     readonly attribute wstring name;
17596 
17602     readonly attribute unsigned long maxDevicesPerPortCount;
17603 
17609     readonly attribute unsigned long minPortCount;
17610 
17616     readonly attribute unsigned long maxPortCount;
17617 
17623     attribute unsigned long instance;
17624 
17633     attribute unsigned long portCount;
17634 
17640     readonly attribute StorageBus bus;
17641 
17654     attribute StorageControllerType controllerType;
17655 
17670     attribute boolean useHostIOCache;
17671 
17677     readonly attribute boolean bootable;
17678 
17701     void getIDEEmulationPort (
17702         in long devicePosition,
17703         [retval] out long portNumber
17704     );
17705 
17729     void setIDEEmulationPort (
17730         in long devicePosition,
17731         in long portNumber
17732     );
17733 
17734 }; /* interface IStorageController */
17735 
17759 interface IManagedObjectRef : $unknown
17760 {
17767     void getInterfaceName (
17768         [retval] out wstring return
17769     );
17770 
17778     void release();
17779 
17780 }; /* interface IManagedObjectRef */
17781 
17790 interface IWebsessionManager : $unknown
17791 {
17800     void logon (
17801         in wstring username,
17802         in wstring password,
17803         [retval] out IVirtualBox return
17804     );
17805 
17815     void getSessionObject (
17816         in IVirtualBox refIVirtualBox,
17817         [retval] out ISession return
17818     );
17819 
17827     void logoff (
17828         in IVirtualBox refIVirtualBox
17829     );
17830 
17831 }; /* interface IWebsessionManager */
17832 
17841 interface IPerformanceMetric : $unknown
17842 {
17848     readonly attribute wstring metricName;
17849 
17855     readonly attribute $unknown object;
17856 
17862     readonly attribute wstring description;
17863 
17869     readonly attribute unsigned long period;
17870 
17880     readonly attribute unsigned long count;
17881 
17887     readonly attribute wstring unit;
17888 
17894     readonly attribute long minimumValue;
17895 
17901     readonly attribute long maximumValue;
17902 
17903 }; /* interface IPerformanceMetric */
17904 
18011 interface IPerformanceCollector : $unknown
18012 {
18023     readonly attribute wstring[] metricNames;
18024 
18048     void getMetrics (
18049         in wstring[] metricNames,
18050         in $unknown[] objects,
18051         [retval] out IPerformanceMetric[] metrics
18052     );
18053 
18092     void setupMetrics (
18093         in wstring[] metricNames,
18094         in $unknown[] objects,
18095         in unsigned long period,
18096         in unsigned long count,
18097         [retval] out IPerformanceMetric[] affectedMetrics
18098     );
18099 
18128     void enableMetrics (
18129         in wstring[] metricNames,
18130         in $unknown[] objects,
18131         [retval] out IPerformanceMetric[] affectedMetrics
18132     );
18133 
18162     void disableMetrics (
18163         in wstring[] metricNames,
18164         in $unknown[] objects,
18165         [retval] out IPerformanceMetric[] affectedMetrics
18166     );
18167 
18256     void queryMetricsData (
18257         in wstring[] metricNames,
18258         in $unknown[] objects,
18259         out wstring[] returnMetricNames,
18260         out $unknown[] returnObjects,
18261         out wstring[] returnUnits,
18262         out unsigned long[] returnScales,
18263         out unsigned long[] returnSequenceNumbers,
18264         out unsigned long[] returnDataIndices,
18265         out unsigned long[] returnDataLengths,
18266         [retval] out long[] returnData
18267     );
18268 
18269 }; /* interface IPerformanceCollector */
18270 
18278 interface INATEngine : $unknown
18279 {
18284     attribute wstring network;
18285 
18292     attribute wstring hostIP;
18293 
18298     attribute wstring tftpPrefix;
18299 
18304     attribute wstring tftpBootFile;
18305 
18313     attribute wstring tftpNextServer;
18314 
18318     attribute unsigned long aliasMode;
18319 
18323     attribute boolean dnsPassDomain;
18324 
18329     attribute boolean dnsProxy;
18330 
18335     attribute boolean dnsUseHostResolver;
18336 
18341     readonly attribute wstring[] redirects;
18342 
18358     void setNetworkSettings (
18359         in unsigned long mtu,
18360         in unsigned long sockSnd,
18361         in unsigned long sockRcv,
18362         in unsigned long TcpWndSnd,
18363         in unsigned long TcpWndRcv
18364     );
18365 
18370     void getNetworkSettings (
18371         out unsigned long mtu,
18372         out unsigned long sockSnd,
18373         out unsigned long sockRcv,
18374         out unsigned long TcpWndSnd,
18375         out unsigned long TcpWndRcv
18376     );
18377 
18397     void addRedirect (
18398         in wstring name,
18399         in NATProtocol proto,
18400         in wstring hostIp,
18401         in unsigned short hostPort,
18402         in wstring guestIp,
18403         in unsigned short guestPort
18404     );
18405 
18411     void removeRedirect (
18412         in wstring name
18413     );
18414 
18415 }; /* interface INATEngine */
18416 
18425 interface IExtPackPlugIn : $unknown
18426 {
18430     readonly attribute wstring name;
18431 
18435     readonly attribute wstring description;
18436 
18442     readonly attribute wstring frontend;
18443 
18447     readonly attribute wstring modulePath;
18448 
18449 }; /* interface IExtPackPlugIn */
18450 
18459 interface IExtPackBase : $unknown
18460 {
18464     readonly attribute wstring name;
18465 
18469     readonly attribute wstring description;
18470 
18479     readonly attribute wstring version;
18480 
18484     readonly attribute unsigned long revision;
18485 
18489     readonly attribute wstring VRDEModule;
18490 
18494     readonly attribute IExtPackPlugIn[] plugIns;
18495 
18505     readonly attribute boolean usable;
18506 
18513     readonly attribute wstring whyUnusable;
18514 
18518     readonly attribute boolean showLicense;
18519 
18528     readonly attribute wstring license;
18529 
18553     void queryLicense (
18554         in wstring preferredLocale,
18555         in wstring preferredLanguage,
18556         in wstring format,
18557         [retval] out wstring licenseText
18558     );
18559 
18560 }; /* interface IExtPackBase */
18561 
18570 interface IExtPack : IExtPackBase
18571 {
18583     void queryObject (
18584         in wstring objUuid,
18585         [retval] out $unknown returnInterface
18586     );
18587 
18588 }; /* interface IExtPack */
18589 
18599 interface IExtPackFile : IExtPackBase
18600 {
18606     readonly attribute wstring filePath;
18607 
18626     void install (
18627         in boolean replace,
18628         in wstring displayInfo,
18629         [retval] out IProgress progess
18630     );
18631 
18632 }; /* interface IExtPackFile */
18633 
18644 interface IExtPackManager : $unknown
18645 {
18651     readonly attribute IExtPack[] installedExtPacks;
18652 
18670     void find (
18671         in wstring name,
18672         [retval] out IExtPack returnData
18673     );
18674 
18686     void openExtPackFile (
18687         in wstring path,
18688         [retval] out IExtPackFile file
18689     );
18690 
18709     void uninstall (
18710         in wstring name,
18711         in boolean forcedRemoval,
18712         in wstring displayInfo,
18713         [retval] out IProgress progess
18714     );
18715 
18719     void cleanup();
18720 
18733     void queryAllPlugInsForFrontend (
18734         in wstring frontendName,
18735         [retval] out wstring[] plugInModules
18736     );
18737 
18745     void isExtPackUsable (
18746         in wstring name,
18747         [retval] out boolean usable
18748     );
18749 
18750 }; /* interface IExtPackManager */
18751 
18757 interface IBandwidthGroup : $unknown
18758 {
18762     readonly attribute wstring name;
18763 
18767     readonly attribute BandwidthGroupType type;
18768 
18772     readonly attribute unsigned long reference;
18773 
18778     attribute unsigned long maxMbPerSec;
18779 
18780 }; /* interface IBandwidthGroup */
18781 
18790 interface IBandwidthControl : $unknown
18791 {
18797     readonly attribute unsigned long numGroups;
18798 
18811     void createBandwidthGroup (
18812         in wstring name,
18813         in BandwidthGroupType type,
18814         in unsigned long maxMbPerSec
18815     );
18816 
18824     void deleteBandwidthGroup (
18825         in wstring name
18826     );
18827 
18837     void getBandwidthGroup (
18838         in wstring name,
18839         [retval] out IBandwidthGroup bandwidthGroup
18840     );
18841 
18849     void getAllBandwidthGroups (
18850         [retval] out IBandwidthGroup[] bandwidthGroups
18851     );
18852 
18853 }; /* interface IBandwidthControl */
18854 
18867 interface IVirtualBoxClient : $unknown
18868 {
18874     readonly attribute IVirtualBox virtualBox;
18875 
18881     readonly attribute ISession session;
18882 
18888     readonly attribute IEventSource eventSource;
18889 
18890 }; /* interface IVirtualBoxClient */
18891 
18905 interface IEventSource : $unknown
18906 {
18912     void createListener (
18913         [retval] out IEventListener listener
18914     );
18915 
18931     void createAggregator (
18932         in IEventSource[] subordinates,
18933         [retval] out IEventSource result
18934     );
18935 
18968     void registerListener (
18969         in IEventListener listener,
18970         in VBoxEventType[] interesting,
18971         in boolean active
18972     );
18973 
18982     void unregisterListener (
18983         in IEventListener listener
18984     );
18985 
19000     void fireEvent (
19001         in IEvent event,
19002         in long timeout,
19003         [retval] out boolean result
19004     );
19005 
19030     void getEvent (
19031         in IEventListener listener,
19032         in long timeout,
19033         [retval] out IEvent event
19034     );
19035 
19047     void eventProcessed (
19048         in IEventListener listener,
19049         in IEvent event
19050     );
19051 
19052 }; /* interface IEventSource */
19053 
19063 interface IEventListener : $unknown
19064 {
19077     void handleEvent (
19078         in IEvent event
19079     );
19080 
19081 }; /* interface IEventListener */
19082 
19159 interface IEvent : $unknown
19160 {
19166     readonly attribute VBoxEventType type;
19167 
19173     readonly attribute IEventSource source;
19174 
19185     readonly attribute boolean waitable;
19186 
19193     void setProcessed();
19194 
19208     void waitProcessed (
19209         in long timeout,
19210         [retval] out boolean result
19211     );
19212 
19213 }; /* interface IEvent */
19214 
19220 interface IReusableEvent : IEvent
19221 {
19225     readonly attribute unsigned long generation;
19226 
19233     void reuse();
19234 
19235 }; /* interface IReusableEvent */
19236 
19242 interface IMachineEvent : IEvent
19243 {
19247     readonly attribute wstringUUID machineId;
19248 
19249 }; /* interface IMachineEvent */
19250 
19256 interface IMachineStateChangedEvent : IMachineEvent
19257 {
19261     readonly attribute MachineState state;
19262 
19263 }; /* interface IMachineStateChangedEvent */
19264 
19272 interface IMachineDataChangedEvent : IMachineEvent
19273 {
19280     readonly attribute boolean temporary;
19281 
19282 }; /* interface IMachineDataChangedEvent */
19283 
19292 interface IMediumRegisteredEvent : IEvent
19293 {
19297     readonly attribute wstringUUID mediumId;
19298 
19302     readonly attribute DeviceType mediumType;
19303 
19310     readonly attribute boolean registered;
19311 
19312 }; /* interface IMediumRegisteredEvent */
19313 
19322 interface IMachineRegisteredEvent : IMachineEvent
19323 {
19330     readonly attribute boolean registered;
19331 
19332 }; /* interface IMachineRegisteredEvent */
19333 
19343 interface ISessionStateChangedEvent : IMachineEvent
19344 {
19350     readonly attribute SessionState state;
19351 
19352 }; /* interface ISessionStateChangedEvent */
19353 
19361 interface IGuestPropertyChangedEvent : IMachineEvent
19362 {
19368     readonly attribute wstring name;
19369 
19375     readonly attribute wstring value;
19376 
19382     readonly attribute wstring flags;
19383 
19384 }; /* interface IGuestPropertyChangedEvent */
19385 
19391 interface ISnapshotEvent : IMachineEvent
19392 {
19396     readonly attribute wstringUUID snapshotId;
19397 
19398 }; /* interface ISnapshotEvent */
19399 
19409 interface ISnapshotTakenEvent : ISnapshotEvent
19410 {
19411 }; /* interface ISnapshotTakenEvent */
19412 
19429 interface ISnapshotDeletedEvent : ISnapshotEvent
19430 {
19431 }; /* interface ISnapshotDeletedEvent */
19432 
19442 interface ISnapshotChangedEvent : ISnapshotEvent
19443 {
19444 }; /* interface ISnapshotChangedEvent */
19445 
19454 interface IMousePointerShapeChangedEvent : IEvent
19455 {
19461     readonly attribute boolean visible;
19462 
19468     readonly attribute boolean alpha;
19469 
19475     readonly attribute unsigned long xhot;
19476 
19482     readonly attribute unsigned long yhot;
19483 
19489     readonly attribute unsigned long width;
19490 
19496     readonly attribute unsigned long height;
19497 
19530     readonly attribute octet[] shape;
19531 
19532 }; /* interface IMousePointerShapeChangedEvent */
19533 
19542 interface IMouseCapabilityChangedEvent : IEvent
19543 {
19549     readonly attribute boolean supportsAbsolute;
19550 
19556     readonly attribute boolean supportsRelative;
19557 
19563     readonly attribute boolean needsHostCursor;
19564 
19565 }; /* interface IMouseCapabilityChangedEvent */
19566 
19575 interface IKeyboardLedsChangedEvent : IEvent
19576 {
19582     readonly attribute boolean numLock;
19583 
19589     readonly attribute boolean capsLock;
19590 
19596     readonly attribute boolean scrollLock;
19597 
19598 }; /* interface IKeyboardLedsChangedEvent */
19599 
19608 interface IStateChangedEvent : IEvent
19609 {
19615     readonly attribute MachineState state;
19616 
19617 }; /* interface IStateChangedEvent */
19618 
19628 interface IAdditionsStateChangedEvent : IEvent
19629 {
19630 }; /* interface IAdditionsStateChangedEvent */
19631 
19642 interface INetworkAdapterChangedEvent : IEvent
19643 {
19649     readonly attribute INetworkAdapter networkAdapter;
19650 
19651 }; /* interface INetworkAdapterChangedEvent */
19652 
19663 interface ISerialPortChangedEvent : IEvent
19664 {
19670     readonly attribute ISerialPort serialPort;
19671 
19672 }; /* interface ISerialPortChangedEvent */
19673 
19684 interface IParallelPortChangedEvent : IEvent
19685 {
19691     readonly attribute IParallelPort parallelPort;
19692 
19693 }; /* interface IParallelPortChangedEvent */
19694 
19704 interface IStorageControllerChangedEvent : IEvent
19705 {
19706 }; /* interface IStorageControllerChangedEvent */
19707 
19717 interface IMediumChangedEvent : IEvent
19718 {
19724     readonly attribute IMediumAttachment mediumAttachment;
19725 
19726 }; /* interface IMediumChangedEvent */
19727 
19735 interface ICPUChangedEvent : IEvent
19736 {
19742     readonly attribute unsigned long cpu;
19743 
19749     readonly attribute boolean add;
19750 
19751 }; /* interface ICPUChangedEvent */
19752 
19760 interface ICPUExecutionCapChangedEvent : IEvent
19761 {
19767     readonly attribute unsigned long executionCap;
19768 
19769 }; /* interface ICPUExecutionCapChangedEvent */
19770 
19778 interface IGuestKeyboardEvent : IEvent
19779 {
19785     readonly attribute long[] scancodes;
19786 
19787 }; /* interface IGuestKeyboardEvent */
19788 
19796 interface IGuestMouseEvent : IReusableEvent
19797 {
19803     readonly attribute boolean absolute;
19804 
19810     readonly attribute long x;
19811 
19817     readonly attribute long y;
19818 
19824     readonly attribute long z;
19825 
19831     readonly attribute long w;
19832 
19838     readonly attribute long buttons;
19839 
19840 }; /* interface IGuestMouseEvent */
19841 
19852 interface IVRDEServerChangedEvent : IEvent
19853 {
19854 }; /* interface IVRDEServerChangedEvent */
19855 
19865 interface IVRDEServerInfoChangedEvent : IEvent
19866 {
19867 }; /* interface IVRDEServerInfoChangedEvent */
19868 
19879 interface IUSBControllerChangedEvent : IEvent
19880 {
19881 }; /* interface IUSBControllerChangedEvent */
19882 
19906 interface IUSBDeviceStateChangedEvent : IEvent
19907 {
19913     readonly attribute IUSBDevice device;
19914 
19920     readonly attribute boolean attached;
19921 
19927     readonly attribute IVirtualBoxErrorInfo error;
19928 
19929 }; /* interface IUSBDeviceStateChangedEvent */
19930 
19946 interface ISharedFolderChangedEvent : IEvent
19947 {
19953     readonly attribute Scope scope;
19954 
19955 }; /* interface ISharedFolderChangedEvent */
19956 
20008 interface IRuntimeErrorEvent : IEvent
20009 {
20015     readonly attribute boolean fatal;
20016 
20022     readonly attribute wstring id;
20023 
20029     readonly attribute wstring message;
20030 
20031 }; /* interface IRuntimeErrorEvent */
20032 
20040 interface IEventSourceChangedEvent : IEvent
20041 {
20047     readonly attribute IEventListener listener;
20048 
20054     readonly attribute boolean add;
20055 
20056 }; /* interface IEventSourceChangedEvent */
20057 
20066 interface IExtraDataChangedEvent : IEvent
20067 {
20074     readonly attribute wstringUUID machineId;
20075 
20081     readonly attribute wstring key;
20082 
20088     readonly attribute wstring value;
20089 
20090 }; /* interface IExtraDataChangedEvent */
20091 
20097 interface IVetoEvent : IEvent
20098 {
20108     void addVeto (
20109         in wstring reason
20110     );
20111 
20121     void isVetoed (
20122         [retval] out boolean result
20123     );
20124 
20134     void getVetos (
20135         [retval] out wstring[] result
20136     );
20137 
20138 }; /* interface IVetoEvent */
20139 
20149 interface IExtraDataCanChangeEvent : IVetoEvent
20150 {
20157     readonly attribute wstringUUID machineId;
20158 
20164     readonly attribute wstring key;
20165 
20171     readonly attribute wstring value;
20172 
20173 }; /* interface IExtraDataCanChangeEvent */
20174 
20190 interface ICanShowWindowEvent : IVetoEvent
20191 {
20192 }; /* interface ICanShowWindowEvent */
20193 
20225 interface IShowWindowEvent : IEvent
20226 {
20235     attribute long long winId;
20236 
20237 }; /* interface IShowWindowEvent */
20238 
20246 interface INATRedirectEvent : IMachineEvent
20247 {
20253     readonly attribute unsigned long slot;
20254 
20260     readonly attribute boolean remove;
20261 
20267     readonly attribute wstring name;
20268 
20274     readonly attribute NATProtocol proto;
20275 
20281     readonly attribute wstring hostIp;
20282 
20288     readonly attribute long hostPort;
20289 
20295     readonly attribute wstring guestIp;
20296 
20302     readonly attribute long guestPort;
20303 
20304 }; /* interface INATRedirectEvent */
20305 
20318 interface IHostPciDevicePlugEvent : IMachineEvent
20319 {
20325     readonly attribute boolean plugged;
20326 
20333     readonly attribute boolean success;
20334 
20340     readonly attribute IPciDeviceAttachment attachment;
20341 
20347     readonly attribute wstring message;
20348 
20349 }; /* interface IHostPciDevicePlugEvent */
20350 
20359 interface IVBoxSVCAvailabilityChangedEvent : IEvent
20360 {
20366     readonly attribute boolean available;
20367 
20368 }; /* interface IVBoxSVCAvailabilityChangedEvent */
20369 
20377 interface IBandwidthGroupChangedEvent : IEvent
20378 {
20384     readonly attribute IBandwidthGroup bandwidthGroup;
20385 
20386 }; /* interface IBandwidthGroupChangedEvent */
20387 
20395 interface IGuestMonitorChangedEvent : IEvent
20396 {
20402     readonly attribute GuestMonitorChangedEventType changeType;
20403 
20409     readonly attribute unsigned long screenId;
20410 
20417     readonly attribute unsigned long originX;
20418 
20425     readonly attribute unsigned long originY;
20426 
20433     readonly attribute unsigned long width;
20434 
20441     readonly attribute unsigned long height;
20442 
20443 }; /* interface IGuestMonitorChangedEvent */
20444 
20454 interface IStorageDeviceChangedEvent : IEvent
20455 {
20461     readonly attribute IMediumAttachment storageDevice;
20462 
20468     readonly attribute boolean removed;
20469 
20470 }; /* interface IStorageDeviceChangedEvent */
20471 
20472 

Generated on Thu Jul 9 2015 19:56:22 for VirtualBox Main API by  doxygen 1.7.1