• 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 
05382     void pushGuestProperty (
05383         in wstring name,
05384         in wstring value,
05385         in long long timestamp,
05386         in wstring flags,
05387         [retval] out boolean notify
05388     );
05389 
05401     void lockMedia();
05402 
05412     void unlockMedia();
05413 
05429     void ejectMedium (
05430         in IMediumAttachment attachment,
05431         [retval] out IMediumAttachment newAttachment
05432     );
05433 
05470     void reportGuestStatistics (
05471         in unsigned long validStats,
05472         in unsigned long cpuUser,
05473         in unsigned long cpuKernel,
05474         in unsigned long cpuIdle,
05475         in unsigned long memTotal,
05476         in unsigned long memFree,
05477         in unsigned long memBalloon,
05478         in unsigned long memShared,
05479         in unsigned long memCache,
05480         in unsigned long pagedTotal,
05481         in unsigned long memAllocTotal,
05482         in unsigned long memFreeTotal,
05483         in unsigned long memBalloonTotal,
05484         in unsigned long memSharedTotal
05485     );
05486 
05487 }; /* interface IInternalMachineControl */
05488 
05497 interface IBIOSSettings : $unknown
05498 {
05502     attribute boolean logoFadeIn;
05503 
05507     attribute boolean logoFadeOut;
05508 
05512     attribute unsigned long logoDisplayTime;
05513 
05520     attribute wstring logoImagePath;
05521 
05525     attribute BIOSBootMenuMode bootMenuMode;
05526 
05530     attribute boolean ACPIEnabled;
05531 
05538     attribute boolean IOAPICEnabled;
05539 
05549     attribute long long timeOffset;
05550 
05557     attribute boolean PXEDebugEnabled;
05558 
05559 }; /* interface IBIOSSettings */
05560 
05568 interface IPciAddress : $unknown
05569 {
05575     attribute short bus;
05576 
05582     attribute short device;
05583 
05589     attribute short devFunction;
05590 
05596     void asLong (
05597         [retval] out long result
05598     );
05599 
05605     void fromLong (
05606         in long number
05607     );
05608 
05609 }; /* interface IPciAddress */
05610 
05618 interface IPciDeviceAttachment : $unknown
05619 {
05625     readonly attribute wstring name;
05626 
05632     readonly attribute boolean isPhysicalDevice;
05633 
05639     readonly attribute long hostAddress;
05640 
05646     readonly attribute long guestAddress;
05647 
05648 }; /* interface IPciDeviceAttachment */
05649 
05690 interface IMachine : $unknown
05691 {
05695     readonly attribute IVirtualBox parent;
05696 
05746     readonly attribute boolean accessible;
05747 
05759     readonly attribute IVirtualBoxErrorInfo accessError;
05760 
05800     attribute wstring name;
05801 
05812     attribute wstring description;
05813 
05817     readonly attribute wstringUUID id;
05818 
05833     attribute wstring OSTypeId;
05834 
05838     attribute wstring hardwareVersion;
05839 
05849     attribute wstringUUID hardwareUUID;
05850 
05854     attribute unsigned long CPUCount;
05855 
05861     attribute boolean CPUHotPlugEnabled;
05862 
05870     attribute unsigned long CPUExecutionCap;
05871 
05875     attribute unsigned long memorySize;
05876 
05880     attribute unsigned long memoryBalloonSize;
05881 
05888     attribute boolean pageFusionEnabled;
05889 
05893     attribute unsigned long VRAMSize;
05894 
05900     attribute boolean accelerate3DEnabled;
05901 
05907     attribute boolean accelerate2DVideoEnabled;
05908 
05919     attribute unsigned long monitorCount;
05920 
05924     readonly attribute IBIOSSettings BIOSSettings;
05925 
05930     attribute FirmwareType firmwareType;
05931 
05937     attribute PointingHidType pointingHidType;
05938 
05944     attribute KeyboardHidType keyboardHidType;
05945 
05952     attribute boolean hpetEnabled;
05953 
05957     attribute ChipsetType chipsetType;
05958 
05992     attribute wstring snapshotFolder;
05993 
05997     readonly attribute IVRDEServer VRDEServer;
05998 
05999     attribute boolean emulatedUSBWebcameraEnabled;
06000 
06001     attribute boolean emulatedUSBCardReaderEnabled;
06002 
06006     readonly attribute IMediumAttachment[] mediumAttachments;
06007 
06019     readonly attribute IUSBController USBController;
06020 
06024     readonly attribute IAudioAdapter audioAdapter;
06025 
06029     readonly attribute IStorageController[] storageControllers;
06030 
06036     readonly attribute wstring settingsFilePath;
06037 
06062     readonly attribute boolean settingsModified;
06063 
06067     readonly attribute SessionState sessionState;
06068 
06081     readonly attribute wstring sessionType;
06082 
06092     readonly attribute unsigned long sessionPid;
06093 
06097     readonly attribute MachineState state;
06098 
06105     readonly attribute long long lastStateChange;
06106 
06118     readonly attribute wstring stateFilePath;
06119 
06129     readonly attribute wstring logFolder;
06130 
06141     readonly attribute ISnapshot currentSnapshot;
06142 
06149     readonly attribute unsigned long snapshotCount;
06150 
06182     readonly attribute boolean currentStateModified;
06183 
06195     readonly attribute ISharedFolder[] sharedFolders;
06196 
06203     attribute ClipboardMode clipboardMode;
06204 
06212     attribute wstring guestPropertyNotificationPatterns;
06213 
06222     attribute boolean teleporterEnabled;
06223 
06234     attribute unsigned long teleporterPort;
06235 
06242     attribute wstring teleporterAddress;
06243 
06251     attribute wstring teleporterPassword;
06252 
06260     attribute FaultToleranceState faultToleranceState;
06261 
06268     attribute unsigned long faultTolerancePort;
06269 
06275     attribute wstring faultToleranceAddress;
06276 
06284     attribute wstring faultTolerancePassword;
06285 
06291     attribute unsigned long faultToleranceSyncInterval;
06292 
06300     attribute boolean RTCUseUTC;
06301 
06308     attribute boolean ioCacheEnabled;
06309 
06315     attribute unsigned long ioCacheSize;
06316 
06322     readonly attribute IBandwidthControl bandwidthControl;
06323 
06333     readonly attribute IPciDeviceAttachment[] pciDeviceAssignments;
06334 
06440     void lockMachine (
06441         in ISession session,
06442         in LockType lockType
06443     );
06444 
06574     void launchVMProcess (
06575         in ISession session,
06576         in wstring type,
06577         in wstring environment,
06578         [retval] out IProgress progress
06579     );
06580 
06618     void setBootOrder (
06619         in unsigned long position,
06620         in DeviceType device
06621     );
06622 
06657     void getBootOrder (
06658         in unsigned long position,
06659         [retval] out DeviceType device
06660     );
06661 
06763     void attachDevice (
06764         in wstring name,
06765         in long controllerPort,
06766         in long device,
06767         in DeviceType type,
06768         in IMedium medium
06769     );
06770 
06823     void detachDevice (
06824         in wstring name,
06825         in long controllerPort,
06826         in long device
06827     );
06828 
06871     void passthroughDevice (
06872         in wstring name,
06873         in long controllerPort,
06874         in long device,
06875         in boolean passthrough
06876     );
06877 
06920     void temporaryEjectDevice (
06921         in wstring name,
06922         in long controllerPort,
06923         in long device,
06924         in boolean temporaryEject
06925     );
06926 
06972     void nonRotationalDevice (
06973         in wstring name,
06974         in long controllerPort,
06975         in long device,
06976         in boolean nonRotational
06977     );
06978 
07019     void setBandwidthGroupForDevice (
07020         in wstring name,
07021         in long controllerPort,
07022         in long device,
07023         in IBandwidthGroup bandwidthGroup
07024     );
07025 
07088     void mountMedium (
07089         in wstring name,
07090         in long controllerPort,
07091         in long device,
07092         in IMedium medium,
07093         in boolean force
07094     );
07095 
07124     void getMedium (
07125         in wstring name,
07126         in long controllerPort,
07127         in long device,
07128         [retval] out IMedium medium
07129     );
07130 
07145     void getMediumAttachmentsOfController (
07146         in wstring name,
07147         [retval] out IMediumAttachment[] mediumAttachments
07148     );
07149 
07164     void getMediumAttachment (
07165         in wstring name,
07166         in long controllerPort,
07167         in long device,
07168         [retval] out IMediumAttachment attachment
07169     );
07170 
07211     void attachHostPciDevice (
07212         in long hostAddress,
07213         in long desiredGuestAddress,
07214         in boolean tryToUnbind
07215     );
07216 
07257     void detachHostPciDevice (
07258         in long hostAddress
07259     );
07260 
07278     void getNetworkAdapter (
07279         in unsigned long slot,
07280         [retval] out INetworkAdapter adapter
07281     );
07282 
07315     void addStorageController (
07316         in wstring name,
07317         in StorageBus connectionType,
07318         [retval] out IStorageController controller
07319     );
07320 
07334     void getStorageControllerByName (
07335         in wstring name,
07336         [retval] out IStorageController storageController
07337     );
07338 
07352     void getStorageControllerByInstance (
07353         in unsigned long instance,
07354         [retval] out IStorageController storageController
07355     );
07356 
07370     void removeStorageController (
07371         in wstring name
07372     );
07373 
07395     void setStorageControllerBootable (
07396         in wstring name,
07397         in boolean bootable
07398     );
07399 
07417     void getSerialPort (
07418         in unsigned long slot,
07419         [retval] out ISerialPort port
07420     );
07421 
07439     void getParallelPort (
07440         in unsigned long slot,
07441         [retval] out IParallelPort port
07442     );
07443 
07452     void getExtraDataKeys (
07453         [retval] out wstring[] value
07454     );
07455 
07484     void getExtraData (
07485         in wstring key,
07486         [retval] out wstring value
07487     );
07488 
07538     void setExtraData (
07539         in wstring key,
07540         in wstring value
07541     );
07542 
07564     void getCPUProperty (
07565         in CPUPropertyType property,
07566         [retval] out boolean value
07567     );
07568 
07590     void setCPUProperty (
07591         in CPUPropertyType property,
07592         in boolean value
07593     );
07594 
07634     void getCPUIDLeaf (
07635         in unsigned long id,
07636         out unsigned long valEax,
07637         out unsigned long valEbx,
07638         out unsigned long valEcx,
07639         out unsigned long valEdx
07640     );
07641 
07685     void setCPUIDLeaf (
07686         in unsigned long id,
07687         in unsigned long valEax,
07688         in unsigned long valEbx,
07689         in unsigned long valEcx,
07690         in unsigned long valEdx
07691     );
07692 
07710     void removeCPUIDLeaf (
07711         in unsigned long id
07712     );
07713 
07719     void removeAllCPUIDLeaves();
07720 
07742     void getHWVirtExProperty (
07743         in HWVirtExPropertyType property,
07744         [retval] out boolean value
07745     );
07746 
07768     void setHWVirtExProperty (
07769         in HWVirtExPropertyType property,
07770         in boolean value
07771     );
07772 
07818     void saveSettings();
07819 
07843     void discardSettings();
07844 
07928     void unregister (
07929         in CleanupMode cleanupMode,
07930         [retval] out IMedium[] aMedia
07931     );
07932 
07989     void delete (
07990         in IMedium[] aMedia,
07991         [retval] out IProgress aProgress
07992     );
07993 
08005     void export (
08006         in IAppliance aAppliance,
08007         in wstring location,
08008         [retval] out IVirtualSystemDescription aDescription
08009     );
08010 
08034     void findSnapshot (
08035         in wstring nameOrId,
08036         [retval] out ISnapshot snapshot
08037     );
08038 
08072     void createSharedFolder (
08073         in wstring name,
08074         in wstring hostPath,
08075         in boolean writable,
08076         in boolean automount
08077     );
08078 
08104     void removeSharedFolder (
08105         in wstring name
08106     );
08107 
08131     void canShowConsoleWindow (
08132         [retval] out boolean canShow
08133     );
08134 
08169     void showConsoleWindow (
08170         [retval] out long long winId
08171     );
08172 
08205     void getGuestProperty (
08206         in wstring name,
08207         out wstring value,
08208         out long long timestamp,
08209         out wstring flags
08210     );
08211 
08234     void getGuestPropertyValue (
08235         in wstring property,
08236         [retval] out wstring value
08237     );
08238 
08261     void getGuestPropertyTimestamp (
08262         in wstring property,
08263         [retval] out long long value
08264     );
08265 
08316     void setGuestProperty (
08317         in wstring property,
08318         in wstring value,
08319         in wstring flags
08320     );
08321 
08362     void setGuestPropertyValue (
08363         in wstring property,
08364         in wstring value
08365     );
08366 
08397     void enumerateGuestProperties (
08398         in wstring patterns,
08399         out wstring[] name,
08400         out wstring[] value,
08401         out long long[] timestamp,
08402         out wstring[] flags
08403     );
08404 
08422     void querySavedGuestSize (
08423         in unsigned long screenId,
08424         out unsigned long width,
08425         out unsigned long height
08426     );
08427 
08449     void querySavedThumbnailSize (
08450         in unsigned long screenId,
08451         out unsigned long size,
08452         out unsigned long width,
08453         out unsigned long height
08454     );
08455 
08482     void readSavedThumbnailToArray (
08483         in unsigned long screenId,
08484         in boolean BGR,
08485         out unsigned long width,
08486         out unsigned long height,
08487         [retval] out octet[] data
08488     );
08489 
08511     void readSavedThumbnailPNGToArray (
08512         in unsigned long screenId,
08513         out unsigned long width,
08514         out unsigned long height,
08515         [retval] out octet[] data
08516     );
08517 
08539     void querySavedScreenshotPNGSize (
08540         in unsigned long screenId,
08541         out unsigned long size,
08542         out unsigned long width,
08543         out unsigned long height
08544     );
08545 
08567     void readSavedScreenshotPNGToArray (
08568         in unsigned long screenId,
08569         out unsigned long width,
08570         out unsigned long height,
08571         [retval] out octet[] data
08572     );
08573 
08583     void hotPlugCPU (
08584         in unsigned long cpu
08585     );
08586 
08596     void hotUnplugCPU (
08597         in unsigned long cpu
08598     );
08599 
08613     void getCPUStatus (
08614         in unsigned long cpu,
08615         [retval] out boolean attached
08616     );
08617 
08632     void queryLogFilename (
08633         in unsigned long idx,
08634         [retval] out wstring filename
08635     );
08636 
08662     void readLog (
08663         in unsigned long idx,
08664         in long long offset,
08665         in long long size,
08666         [retval] out octet[] data
08667     );
08668 
08701     void cloneTo (
08702         in IMachine target,
08703         in CloneMode mode,
08704         in CloneOptions[] options,
08705         [retval] out IProgress progress
08706     );
08707 
08708 }; /* interface IMachine */
08709 
08718 interface IVRDEServerInfo : $unknown
08719 {
08725     readonly attribute boolean active;
08726 
08735     readonly attribute long port;
08736 
08742     readonly attribute unsigned long numberOfClients;
08743 
08749     readonly attribute long long beginTime;
08750 
08757     readonly attribute long long endTime;
08758 
08764     readonly attribute long long bytesSent;
08765 
08771     readonly attribute long long bytesSentTotal;
08772 
08778     readonly attribute long long bytesReceived;
08779 
08785     readonly attribute long long bytesReceivedTotal;
08786 
08792     readonly attribute wstring user;
08793 
08799     readonly attribute wstring domain;
08800 
08806     readonly attribute wstring clientName;
08807 
08813     readonly attribute wstring clientIP;
08814 
08820     readonly attribute unsigned long clientVersion;
08821 
08829     readonly attribute unsigned long encryptionStyle;
08830 
08831 }; /* interface IVRDEServerInfo */
08832 
08854 interface IConsole : $unknown
08855 {
08867     readonly attribute IMachine machine;
08868 
08882     readonly attribute MachineState state;
08883 
08887     readonly attribute IGuest guest;
08888 
08899     readonly attribute IKeyboard keyboard;
08900 
08911     readonly attribute IMouse mouse;
08912 
08922     readonly attribute IDisplay display;
08923 
08927     readonly attribute IMachineDebugger debugger;
08928 
08939     readonly attribute IUSBDevice[] USBDevices;
08940 
08948     readonly attribute IHostUSBDevice[] remoteUSBDevices;
08949 
08965     readonly attribute ISharedFolder[] sharedFolders;
08966 
08972     readonly attribute IVRDEServerInfo VRDEServerInfo;
08973 
08979     readonly attribute IEventSource eventSource;
08980 
08984     readonly attribute IPciDeviceAttachment[] attachedPciDevices;
08985 
08994     attribute boolean useHostClipboard;
08995 
09060     void powerUp (
09061         [retval] out IProgress progress
09062     );
09063 
09097     void powerUpPaused (
09098         [retval] out IProgress progress
09099     );
09100 
09120     void powerDown (
09121         [retval] out IProgress progress
09122     );
09123 
09143     void reset();
09144 
09164     void pause();
09165 
09185     void resume();
09186 
09206     void powerButton();
09207 
09227     void sleepButton();
09228 
09240     void getPowerButtonHandled (
09241         [retval] out boolean handled
09242     );
09243 
09257     void getGuestEnteredACPIMode (
09258         [retval] out boolean entered
09259     );
09260 
09313     void saveState (
09314         [retval] out IProgress progress
09315     );
09316 
09349     void adoptSavedState (
09350         in wstring savedStateFile
09351     );
09352 
09383     void discardSavedState (
09384         in boolean fRemoveFile
09385     );
09386 
09399     void getDeviceActivity (
09400         in DeviceType type,
09401         [retval] out DeviceActivity activity
09402     );
09403 
09441     void attachUSBDevice (
09442         in wstringUUID id
09443     );
09444 
09479     void detachUSBDevice (
09480         in wstringUUID id,
09481         [retval] out IUSBDevice device
09482     );
09483 
09506     void findUSBDeviceByAddress (
09507         in wstring name,
09508         [retval] out IUSBDevice device
09509     );
09510 
09530     void findUSBDeviceById (
09531         in wstringUUID id,
09532         [retval] out IUSBDevice device
09533     );
09534 
09568     void createSharedFolder (
09569         in wstring name,
09570         in wstring hostPath,
09571         in boolean writable,
09572         in boolean automount
09573     );
09574 
09599     void removeSharedFolder (
09600         in wstring name
09601     );
09602 
09640     void takeSnapshot (
09641         in wstring name,
09642         in wstring description,
09643         [retval] out IProgress progress
09644     );
09645 
09718     void deleteSnapshot (
09719         in wstringUUID id,
09720         [retval] out IProgress progress
09721     );
09722 
09762     void deleteSnapshotAndAllChildren (
09763         in wstringUUID id,
09764         [retval] out IProgress progress
09765     );
09766 
09810     void deleteSnapshotRange (
09811         in wstringUUID startId,
09812         in wstringUUID endId,
09813         [retval] out IProgress progress
09814     );
09815 
09856     void restoreSnapshot (
09857         in ISnapshot snapshot,
09858         [retval] out IProgress progress
09859     );
09860 
09899     void teleport (
09900         in wstring hostname,
09901         in unsigned long tcpport,
09902         in wstring password,
09903         in unsigned long maxDowntime,
09904         [retval] out IProgress progress
09905     );
09906 
09907 }; /* interface IConsole */
09908 
09919 interface IHostNetworkInterface : $unknown
09920 {
09924     readonly attribute wstring name;
09925 
09929     readonly attribute wstringUUID id;
09930 
09934     readonly attribute wstring networkName;
09935 
09939     readonly attribute boolean dhcpEnabled;
09940 
09944     readonly attribute wstring IPAddress;
09945 
09949     readonly attribute wstring networkMask;
09950 
09954     readonly attribute boolean IPV6Supported;
09955 
09959     readonly attribute wstring IPV6Address;
09960 
09964     readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
09965 
09969     readonly attribute wstring hardwareAddress;
09970 
09974     readonly attribute HostNetworkInterfaceMediumType mediumType;
09975 
09979     readonly attribute HostNetworkInterfaceStatus status;
09980 
09984     readonly attribute HostNetworkInterfaceType interfaceType;
09985 
09997     void enableStaticIpConfig (
09998         in wstring IPAddress,
09999         in wstring networkMask
10000     );
10001 
10013     void enableStaticIpConfigV6 (
10014         in wstring IPV6Address,
10015         in unsigned long IPV6NetworkMaskPrefixLength
10016     );
10017 
10021     void enableDynamicIpConfig();
10022 
10026     void dhcpRediscover();
10027 
10028 }; /* interface IHostNetworkInterface */
10029 
10046 interface IHost : $unknown
10047 {
10051     readonly attribute IMedium[] DVDDrives;
10052 
10056     readonly attribute IMedium[] floppyDrives;
10057 
10071     readonly attribute IHostUSBDevice[] USBDevices;
10072 
10096     readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
10097 
10101     readonly attribute IHostNetworkInterface[] networkInterfaces;
10102 
10106     readonly attribute unsigned long processorCount;
10107 
10111     readonly attribute unsigned long processorOnlineCount;
10112 
10116     readonly attribute unsigned long processorCoreCount;
10117 
10121     readonly attribute unsigned long memorySize;
10122 
10126     readonly attribute unsigned long memoryAvailable;
10127 
10131     readonly attribute wstring operatingSystem;
10132 
10136     readonly attribute wstring OSVersion;
10137 
10141     readonly attribute long long UTCTime;
10142 
10146     readonly attribute boolean Acceleration3DAvailable;
10147 
10162     void getProcessorSpeed (
10163         in unsigned long cpuId,
10164         [retval] out unsigned long speed
10165     );
10166 
10178     void getProcessorFeature (
10179         in ProcessorFeature feature,
10180         [retval] out boolean supported
10181     );
10182 
10201     void getProcessorDescription (
10202         in unsigned long cpuId,
10203         [retval] out wstring description
10204     );
10205 
10246     void getProcessorCPUIDLeaf (
10247         in unsigned long cpuId,
10248         in unsigned long leaf,
10249         in unsigned long subLeaf,
10250         out unsigned long valEax,
10251         out unsigned long valEbx,
10252         out unsigned long valEcx,
10253         out unsigned long valEdx
10254     );
10255 
10276     void createHostOnlyNetworkInterface (
10277         out IHostNetworkInterface hostInterface,
10278         [retval] out IProgress progress
10279     );
10280 
10301     void removeHostOnlyNetworkInterface (
10302         in wstringUUID id,
10303         [retval] out IProgress progress
10304     );
10305 
10325     void createUSBDeviceFilter (
10326         in wstring name,
10327         [retval] out IHostUSBDeviceFilter filter
10328     );
10329 
10372     void insertUSBDeviceFilter (
10373         in unsigned long position,
10374         in IHostUSBDeviceFilter filter
10375     );
10376 
10404     void removeUSBDeviceFilter (
10405         in unsigned long position
10406     );
10407 
10425     void findHostDVDDrive (
10426         in wstring name,
10427         [retval] out IMedium drive
10428     );
10429 
10447     void findHostFloppyDrive (
10448         in wstring name,
10449         [retval] out IMedium drive
10450     );
10451 
10467     void findHostNetworkInterfaceByName (
10468         in wstring name,
10469         [retval] out IHostNetworkInterface networkInterface
10470     );
10471 
10487     void findHostNetworkInterfaceById (
10488         in wstringUUID id,
10489         [retval] out IHostNetworkInterface networkInterface
10490     );
10491 
10501     void findHostNetworkInterfacesOfType (
10502         in HostNetworkInterfaceType type,
10503         [retval] out IHostNetworkInterface[] networkInterfaces
10504     );
10505 
10525     void findUSBDeviceById (
10526         in wstringUUID id,
10527         [retval] out IHostUSBDevice device
10528     );
10529 
10552     void findUSBDeviceByAddress (
10553         in wstring name,
10554         [retval] out IHostUSBDevice device
10555     );
10556 
10564     void generateMACAddress (
10565         [retval] out wstring address
10566     );
10567 
10568 }; /* interface IHost */
10569 
10582 interface ISystemProperties : $unknown
10583 {
10587     readonly attribute unsigned long minGuestRAM;
10588 
10592     readonly attribute unsigned long maxGuestRAM;
10593 
10597     readonly attribute unsigned long minGuestVRAM;
10598 
10602     readonly attribute unsigned long maxGuestVRAM;
10603 
10607     readonly attribute unsigned long minGuestCPUCount;
10608 
10612     readonly attribute unsigned long maxGuestCPUCount;
10613 
10617     readonly attribute unsigned long maxGuestMonitors;
10618 
10623     readonly attribute long long infoVDSize;
10624 
10631     readonly attribute unsigned long serialPortCount;
10632 
10639     readonly attribute unsigned long parallelPortCount;
10640 
10650     readonly attribute unsigned long maxBootPosition;
10651 
10675     attribute wstring defaultMachineFolder;
10676 
10701     readonly attribute IMediumFormat[] mediumFormats;
10702 
10736     attribute wstring defaultHardDiskFormat;
10737 
10743     attribute long long freeDiskSpaceWarning;
10744 
10749     attribute unsigned long freeDiskSpacePercentWarning;
10750 
10756     attribute long long freeDiskSpaceError;
10757 
10762     attribute unsigned long freeDiskSpacePercentError;
10763 
10787     attribute wstring VRDEAuthLibrary;
10788 
10817     attribute wstring webServiceAuthLibrary;
10818 
10832     attribute wstring defaultVRDEExtPack;
10833 
10839     attribute unsigned long logHistoryCount;
10840 
10845     readonly attribute AudioDriverType defaultAudioDriver;
10846 
10857     void getMaxNetworkAdapters (
10858         in ChipsetType chipset,
10859         [retval] out unsigned long maxNetworkAdapters
10860     );
10861 
10875     void getMaxNetworkAdaptersOfType (
10876         in ChipsetType chipset,
10877         in NetworkAttachmentType type,
10878         [retval] out unsigned long maxNetworkAdapters
10879     );
10880 
10890     void getMaxDevicesPerPortForStorageBus (
10891         in StorageBus bus,
10892         [retval] out unsigned long maxDevicesPerPort
10893     );
10894 
10902     void getMinPortCountForStorageBus (
10903         in StorageBus bus,
10904         [retval] out unsigned long minPortCount
10905     );
10906 
10914     void getMaxPortCountForStorageBus (
10915         in StorageBus bus,
10916         [retval] out unsigned long maxPortCount
10917     );
10918 
10931     void getMaxInstancesOfStorageBus (
10932         in ChipsetType chipset,
10933         in StorageBus bus,
10934         [retval] out unsigned long maxInstances
10935     );
10936 
10946     void getDeviceTypesForStorageBus (
10947         in StorageBus bus,
10948         [retval] out DeviceType[] deviceTypes
10949     );
10950 
10959     void getDefaultIoCacheSettingForStorageController (
10960         in StorageControllerType controllerType,
10961         [retval] out boolean enabled
10962     );
10963 
10964 }; /* interface ISystemProperties */
10965 
10971 interface IGuestOSType : $unknown
10972 {
10976     readonly attribute wstring familyId;
10977 
10981     readonly attribute wstring familyDescription;
10982 
10986     readonly attribute wstring id;
10987 
10991     readonly attribute wstring description;
10992 
10996     readonly attribute boolean is64Bit;
10997 
11001     readonly attribute boolean recommendedIOAPIC;
11002 
11006     readonly attribute boolean recommendedVirtEx;
11007 
11011     readonly attribute unsigned long recommendedRAM;
11012 
11016     readonly attribute unsigned long recommendedVRAM;
11017 
11021     readonly attribute long long recommendedHDD;
11022 
11026     readonly attribute NetworkAdapterType adapterType;
11027 
11031     readonly attribute boolean recommendedPae;
11032 
11036     readonly attribute StorageControllerType recommendedDvdStorageController;
11037 
11041     readonly attribute StorageBus recommendedDvdStorageBus;
11042 
11046     readonly attribute StorageControllerType recommendedHdStorageController;
11047 
11051     readonly attribute StorageBus recommendedHdStorageBus;
11052 
11056     readonly attribute FirmwareType recommendedFirmware;
11057 
11061     readonly attribute boolean recommendedUsbHid;
11062 
11066     readonly attribute boolean recommendedHpet;
11067 
11071     readonly attribute boolean recommendedUsbTablet;
11072 
11076     readonly attribute boolean recommendedRtcUseUtc;
11077 
11081     readonly attribute ChipsetType recommendedChipset;
11082 
11086     readonly attribute AudioControllerType recommendedAudioController;
11087 
11088 }; /* interface IGuestOSType */
11089 
11097 interface IAdditionsFacility : $unknown
11098 {
11102     readonly attribute AdditionsFacilityClass classType;
11103 
11110     readonly attribute long long lastUpdated;
11111 
11115     readonly attribute wstring name;
11116 
11120     readonly attribute AdditionsFacilityStatus status;
11121 
11125     readonly attribute AdditionsFacilityType type;
11126 
11127 }; /* interface IAdditionsFacility */
11128 
11136 interface IGuestDirEntry : $unknown
11137 {
11141     readonly attribute long long nodeId;
11142 
11146     readonly attribute wstring name;
11147 
11151     readonly attribute GuestDirEntryType type;
11152 
11153 }; /* interface IGuestDirEntry */
11154 
11168 interface IGuest : $unknown
11169 {
11184     readonly attribute wstring OSTypeId;
11185 
11191     readonly attribute AdditionsRunLevelType additionsRunLevel;
11192 
11200     readonly attribute wstring additionsVersion;
11201 
11208     readonly attribute IAdditionsFacility[] facilities;
11209 
11213     attribute unsigned long memoryBalloonSize;
11214 
11218     attribute unsigned long statisticsUpdateInterval;
11219 
11251     void internalGetStatistics (
11252         out unsigned long cpuUser,
11253         out unsigned long cpuKernel,
11254         out unsigned long cpuIdle,
11255         out unsigned long memTotal,
11256         out unsigned long memFree,
11257         out unsigned long memBalloon,
11258         out unsigned long memShared,
11259         out unsigned long memCache,
11260         out unsigned long pagedTotal,
11261         out unsigned long memAllocTotal,
11262         out unsigned long memFreeTotal,
11263         out unsigned long memBalloonTotal,
11264         out unsigned long memSharedTotal
11265     );
11266 
11278     void getFacilityStatus (
11279         in AdditionsFacilityType facility,
11280         out long long timestamp,
11281         [retval] out AdditionsFacilityStatus status
11282     );
11283 
11301     void getAdditionsStatus (
11302         in AdditionsRunLevelType level,
11303         [retval] out boolean active
11304     );
11305 
11335     void setCredentials (
11336         in wstring userName,
11337         in wstring password,
11338         in wstring domain,
11339         in boolean allowInteractiveLogon
11340     );
11341 
11411     void executeProcess (
11412         in wstring execName,
11413         in unsigned long flags,
11414         in wstring[] arguments,
11415         in wstring[] environment,
11416         in wstring userName,
11417         in wstring password,
11418         in unsigned long timeoutMS,
11419         out unsigned long pid,
11420         [retval] out IProgress progress
11421     );
11422 
11467     void getProcessOutput (
11468         in unsigned long pid,
11469         in unsigned long flags,
11470         in unsigned long timeoutMS,
11471         in long long size,
11472         [retval] out octet[] data
11473     );
11474 
11508     void getProcessStatus (
11509         in unsigned long pid,
11510         out unsigned long exitcode,
11511         out unsigned long flags,
11512         [retval] out ExecuteProcessStatus reason
11513     );
11514 
11551     void copyFromGuest (
11552         in wstring source,
11553         in wstring dest,
11554         in wstring userName,
11555         in wstring password,
11556         in unsigned long flags,
11557         [retval] out IProgress progress
11558     );
11559 
11596     void copyToGuest (
11597         in wstring source,
11598         in wstring dest,
11599         in wstring userName,
11600         in wstring password,
11601         in unsigned long flags,
11602         [retval] out IProgress progress
11603     );
11604 
11622     void directoryClose (
11623         in unsigned long handle
11624     );
11625 
11660     void directoryCreate (
11661         in wstring directory,
11662         in wstring userName,
11663         in wstring password,
11664         in unsigned long mode,
11665         in unsigned long flags
11666     );
11667 
11707     void directoryOpen (
11708         in wstring directory,
11709         in wstring filter,
11710         in unsigned long flags,
11711         in wstring userName,
11712         in wstring password,
11713         [retval] out unsigned long handle
11714     );
11715 
11745     void directoryRead (
11746         in unsigned long handle,
11747         [retval] out IGuestDirEntry entry
11748     );
11749 
11785     void fileExists (
11786         in wstring file,
11787         in wstring userName,
11788         in wstring password,
11789         [retval] out boolean exists
11790     );
11791 
11823     void fileQuerySize (
11824         in wstring file,
11825         in wstring userName,
11826         in wstring password,
11827         [retval] out long long size
11828     );
11829 
11863     void setProcessInput (
11864         in unsigned long pid,
11865         in unsigned long flags,
11866         in unsigned long timeoutMS,
11867         in octet[] data,
11868         [retval] out unsigned long written
11869     );
11870 
11894     void updateGuestAdditions (
11895         in wstring source,
11896         in unsigned long flags,
11897         [retval] out IProgress progress
11898     );
11899 
11900 }; /* interface IGuest */
11901 
11942 interface IProgress : $unknown
11943 {
11947     readonly attribute wstringUUID id;
11948 
11952     readonly attribute wstring description;
11953 
11957     readonly attribute $unknown initiator;
11958 
11962     readonly attribute boolean cancelable;
11963 
11971     readonly attribute unsigned long percent;
11972 
11986     readonly attribute long timeRemaining;
11987 
11991     readonly attribute boolean completed;
11992 
11996     readonly attribute boolean canceled;
11997 
12004     readonly attribute long resultCode;
12005 
12015     readonly attribute IVirtualBoxErrorInfo errorInfo;
12016 
12023     readonly attribute unsigned long operationCount;
12024 
12028     readonly attribute unsigned long operation;
12029 
12035     readonly attribute wstring operationDescription;
12036 
12040     readonly attribute unsigned long operationPercent;
12041 
12045     readonly attribute unsigned long operationWeight;
12046 
12054     attribute unsigned long timeout;
12055 
12059     void setCurrentOperationProgress (
12060         in unsigned long percent
12061     );
12062 
12066     void setNextOperation (
12067         in wstring nextOperationDescription,
12068         in unsigned long nextOperationsWeight
12069     );
12070 
12097     void waitForCompletion (
12098         in long timeout
12099     );
12100 
12124     void waitForOperationCompletion (
12125         in unsigned long operation,
12126         in long timeout
12127     );
12128 
12154     void waitForAsyncProgressCompletion (
12155         in IProgress pProgressAsync
12156     );
12157 
12174     void cancel();
12175 
12176 }; /* interface IProgress */
12177 
12261 interface ISnapshot : $unknown
12262 {
12266     readonly attribute wstringUUID id;
12267 
12275     attribute wstring name;
12276 
12284     attribute wstring description;
12285 
12291     readonly attribute long long timeStamp;
12292 
12304     readonly attribute boolean online;
12305 
12317     readonly attribute IMachine machine;
12318 
12325     readonly attribute ISnapshot parent;
12326 
12335     readonly attribute ISnapshot[] children;
12336 
12344     void getChildrenCount (
12345         [retval] out unsigned long childrenCount
12346     );
12347 
12348 }; /* interface ISnapshot */
12349 
12536 interface IMediumAttachment : $unknown
12537 {
12542     readonly attribute IMedium medium;
12543 
12549     readonly attribute wstring controller;
12550 
12556     readonly attribute long port;
12557 
12563     readonly attribute long device;
12564 
12568     readonly attribute DeviceType type;
12569 
12573     readonly attribute boolean passthrough;
12574 
12578     readonly attribute boolean temporaryEject;
12579 
12584     readonly attribute boolean isEjected;
12585 
12589     readonly attribute boolean nonRotational;
12590 
12594     readonly attribute IBandwidthGroup bandwidthGroup;
12595 
12596 }; /* interface IMediumAttachment */
12597 
12755 interface IMedium : $unknown
12756 {
12770     readonly attribute wstringUUID id;
12771 
12790     attribute wstring description;
12791 
12807     readonly attribute MediumState state;
12808 
12817     readonly attribute unsigned long variant;
12818 
12840     attribute wstring location;
12841 
12861     readonly attribute wstring name;
12862 
12867     readonly attribute DeviceType deviceType;
12868 
12872     readonly attribute boolean hostDrive;
12873 
12886     readonly attribute long long size;
12887 
12902     readonly attribute wstring format;
12903 
12919     readonly attribute IMediumFormat mediumFormat;
12920 
12945     attribute MediumType type;
12946 
12960     readonly attribute MediumType[] allowedTypes;
12961 
12971     readonly attribute IMedium parent;
12972 
12980     readonly attribute IMedium[] children;
12981 
12992     readonly attribute IMedium base;
12993 
13026     readonly attribute boolean readOnly;
13027 
13048     readonly attribute long long logicalSize;
13049 
13077     attribute boolean autoReset;
13078 
13093     readonly attribute wstring lastAccessError;
13094 
13111     readonly attribute wstringUUID[] machineIds;
13112 
13138     void setIDs (
13139         in boolean setImageId,
13140         in wstringUUID imageId,
13141         in boolean setParentId,
13142         in wstringUUID parentId
13143     );
13144 
13179     void refreshState (
13180         [retval] out MediumState state
13181     );
13182 
13209     void getSnapshotIds (
13210         in wstringUUID machineId,
13211         [retval] out wstringUUID[] snapshotIds
13212     );
13213 
13273     void lockRead (
13274         [retval] out MediumState state
13275     );
13276 
13299     void unlockRead (
13300         [retval] out MediumState state
13301     );
13302 
13357     void lockWrite (
13358         [retval] out MediumState state
13359     );
13360 
13383     void unlockWrite (
13384         [retval] out MediumState state
13385     );
13386 
13436     void close();
13437 
13467     void getProperty (
13468         in wstring name,
13469         [retval] out wstring value
13470     );
13471 
13503     void setProperty (
13504         in wstring name,
13505         in wstring value
13506     );
13507 
13542     void getProperties (
13543         in wstring names,
13544         out wstring[] returnNames,
13545         [retval] out wstring[] returnValues
13546     );
13547 
13577     void setProperties (
13578         in wstring[] names,
13579         in wstring[] values
13580     );
13581 
13614     void createBaseStorage (
13615         in long long logicalSize,
13616         in unsigned long variant,
13617         [retval] out IProgress progress
13618     );
13619 
13671     void deleteStorage (
13672         [retval] out IProgress progress
13673     );
13674 
13713     void createDiffStorage (
13714         in IMedium target,
13715         in unsigned long variant,
13716         [retval] out IProgress progress
13717     );
13718 
13794     void mergeTo (
13795         in IMedium target,
13796         [retval] out IProgress progress
13797     );
13798 
13848     void cloneTo (
13849         in IMedium target,
13850         in unsigned long variant,
13851         in IMedium parent,
13852         [retval] out IProgress progress
13853     );
13854 
13883     void compact (
13884         [retval] out IProgress progress
13885     );
13886 
13919     void resize (
13920         in long long logicalSize,
13921         [retval] out IProgress progress
13922     );
13923 
13957     void reset (
13958         [retval] out IProgress progress
13959     );
13960 
13961 }; /* interface IMedium */
13962 
13985 interface IMediumFormat : $unknown
13986 {
14005     readonly attribute wstring id;
14006 
14014     readonly attribute wstring name;
14015 
14024     readonly attribute unsigned long capabilities;
14025 
14044     void describeFileExtensions (
14045         out wstring[] extensions,
14046         out DeviceType[] type
14047     );
14048 
14076     void describeProperties (
14077         out wstring[] names,
14078         out wstring[] description,
14079         out DataType[] types,
14080         out unsigned long[] flags,
14081         out wstring[] defaults
14082     );
14083 
14084 }; /* interface IMediumFormat */
14085 
14098 interface IKeyboard : $unknown
14099 {
14105     readonly attribute IEventSource eventSource;
14106 
14119     void putScancode (
14120         in long scancode
14121     );
14122 
14135     void putScancodes (
14136         in long[] scancodes,
14137         [retval] out unsigned long codesStored
14138     );
14139 
14154     void putCAD();
14155 
14156 }; /* interface IKeyboard */
14157 
14169 interface IMouse : $unknown
14170 {
14185     readonly attribute boolean absoluteSupported;
14186 
14201     readonly attribute boolean relativeSupported;
14202 
14217     readonly attribute boolean needsHostCursor;
14218 
14224     readonly attribute IEventSource eventSource;
14225 
14291     void putMouseEvent (
14292         in long dx,
14293         in long dy,
14294         in long dz,
14295         in long dw,
14296         in long buttonState
14297     );
14298 
14371     void putMouseEventAbsolute (
14372         in long x,
14373         in long y,
14374         in long dz,
14375         in long dw,
14376         in long buttonState
14377     );
14378 
14379 }; /* interface IMouse */
14380 
14381 interface IFramebuffer : $unknown
14382 {
14391     readonly attribute octetPtr address;
14392 
14396     readonly attribute unsigned long width;
14397 
14401     readonly attribute unsigned long height;
14402 
14409     readonly attribute unsigned long bitsPerPixel;
14410 
14417     readonly attribute unsigned long bytesPerLine;
14418 
14429     readonly attribute unsigned long pixelFormat;
14430 
14437     readonly attribute boolean usesGuestVRAM;
14438 
14448     readonly attribute unsigned long heightReduction;
14449 
14464     readonly attribute IFramebufferOverlay overlay;
14465 
14472     readonly attribute long long winId;
14473 
14481     void lock();
14482 
14490     void unlock();
14491 
14499     void notifyUpdate (
14500         in unsigned long x,
14501         in unsigned long y,
14502         in unsigned long width,
14503         in unsigned long height
14504     );
14505 
14618     void requestResize (
14619         in unsigned long screenId,
14620         in unsigned long pixelFormat,
14621         in octetPtr VRAM,
14622         in unsigned long bitsPerPixel,
14623         in unsigned long bytesPerLine,
14624         in unsigned long width,
14625         in unsigned long height,
14626         [retval] out boolean finished
14627     );
14628 
14640     void videoModeSupported (
14641         in unsigned long width,
14642         in unsigned long height,
14643         in unsigned long bpp,
14644         [retval] out boolean supported
14645     );
14646 
14683     void getVisibleRegion (
14684         in octetPtr rectangles,
14685         in unsigned long count,
14686         [retval] out unsigned long countCopied
14687     );
14688 
14723     void setVisibleRegion (
14724         in octetPtr rectangles,
14725         in unsigned long count
14726     );
14727 
14748     void processVHWACommand (
14749         in octetPtr command
14750     );
14751 
14752 }; /* interface IFramebuffer */
14753 
14768 interface IFramebufferOverlay : IFramebuffer
14769 {
14773     readonly attribute unsigned long x;
14774 
14778     readonly attribute unsigned long y;
14779 
14785     attribute boolean visible;
14786 
14793     attribute unsigned long alpha;
14794 
14800     void move (
14801         in unsigned long x,
14802         in unsigned long y
14803     );
14804 
14805 }; /* interface IFramebufferOverlay */
14806 
14822 interface IDisplay : $unknown
14823 {
14827     void getScreenResolution (
14828         in unsigned long screenId,
14829         out unsigned long width,
14830         out unsigned long height,
14831         out unsigned long bitsPerPixel
14832     );
14833 
14839     void setFramebuffer (
14840         in unsigned long screenId,
14841         in IFramebuffer framebuffer
14842     );
14843 
14849     void getFramebuffer (
14850         in unsigned long screenId,
14851         out IFramebuffer framebuffer,
14852         out long xOrigin,
14853         out long yOrigin
14854     );
14855 
14884     void setVideoModeHint (
14885         in unsigned long width,
14886         in unsigned long height,
14887         in unsigned long bitsPerPixel,
14888         in unsigned long display
14889     );
14890 
14902     void setSeamlessMode (
14903         in boolean enabled
14904     );
14905 
14941     void takeScreenShot (
14942         in unsigned long screenId,
14943         in octetPtr address,
14944         in unsigned long width,
14945         in unsigned long height
14946     );
14947 
14991     void takeScreenShotToArray (
14992         in unsigned long screenId,
14993         in unsigned long width,
14994         in unsigned long height,
14995         [retval] out octet[] screenData
14996     );
14997 
15036     void takeScreenShotPNGToArray (
15037         in unsigned long screenId,
15038         in unsigned long width,
15039         in unsigned long height,
15040         [retval] out octet[] screenData
15041     );
15042 
15094     void drawToScreen (
15095         in unsigned long screenId,
15096         in octetPtr address,
15097         in unsigned long x,
15098         in unsigned long y,
15099         in unsigned long width,
15100         in unsigned long height
15101     );
15102 
15117     void invalidateAndUpdate();
15118 
15132     void resizeCompleted (
15133         in unsigned long screenId
15134     );
15135 
15148     void completeVHWACommand (
15149         in octetPtr command
15150     );
15151 
15152 }; /* interface IDisplay */
15153 
15169 interface INetworkAdapter : $unknown
15170 {
15178     attribute NetworkAdapterType adapterType;
15179 
15187     readonly attribute unsigned long slot;
15188 
15197     attribute boolean enabled;
15198 
15205     attribute wstring MACAddress;
15206 
15212     attribute NetworkAttachmentType attachmentType;
15213 
15219     attribute wstring bridgedInterface;
15220 
15226     attribute wstring hostOnlyInterface;
15227 
15233     attribute wstring internalNetwork;
15234 
15240     attribute wstring NATNetwork;
15241 
15247     attribute wstring genericDriver;
15248 
15255     attribute boolean cableConnected;
15256 
15262     attribute unsigned long lineSpeed;
15263 
15270     attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
15271 
15278     attribute boolean traceEnabled;
15279 
15286     attribute wstring traceFile;
15287 
15295     readonly attribute INATEngine natDriver;
15296 
15303     attribute unsigned long bootPriority;
15304 
15308     attribute IBandwidthGroup bandwidthGroup;
15309 
15328     void getProperty (
15329         in wstring key,
15330         [retval] out wstring value
15331     );
15332 
15351     void setProperty (
15352         in wstring key,
15353         in wstring value
15354     );
15355 
15383     void getProperties (
15384         in wstring names,
15385         out wstring[] returnNames,
15386         [retval] out wstring[] returnValues
15387     );
15388 
15389 }; /* interface INetworkAdapter */
15390 
15419 interface ISerialPort : $unknown
15420 {
15428     readonly attribute unsigned long slot;
15429 
15436     attribute boolean enabled;
15437 
15441     attribute unsigned long IOBase;
15442 
15446     attribute unsigned long IRQ;
15447 
15458     attribute PortMode hostMode;
15459 
15467     attribute boolean server;
15468 
15478     attribute wstring path;
15479 
15480 }; /* interface ISerialPort */
15481 
15501 interface IParallelPort : $unknown
15502 {
15510     readonly attribute unsigned long slot;
15511 
15518     attribute boolean enabled;
15519 
15523     attribute unsigned long IOBase;
15524 
15528     attribute unsigned long IRQ;
15529 
15537     attribute wstring path;
15538 
15539 }; /* interface IParallelPort */
15540 
15541 interface IMachineDebugger : $unknown
15542 {
15546     attribute boolean singlestep;
15547 
15551     attribute boolean recompileUser;
15552 
15556     attribute boolean recompileSupervisor;
15557 
15561     attribute boolean PATMEnabled;
15562 
15566     attribute boolean CSAMEnabled;
15567 
15571     attribute boolean logEnabled;
15572 
15576     readonly attribute wstring logFlags;
15577 
15581     readonly attribute wstring logGroups;
15582 
15586     readonly attribute wstring logDestinations;
15587 
15594     readonly attribute boolean HWVirtExEnabled;
15595 
15602     readonly attribute boolean HWVirtExNestedPagingEnabled;
15603 
15610     readonly attribute boolean HWVirtExVPIDEnabled;
15611 
15620     readonly attribute wstring OSName;
15621 
15630     readonly attribute wstring OSVersion;
15631 
15638     readonly attribute boolean PAEEnabled;
15639 
15646     attribute unsigned long virtualTimeRate;
15647 
15654     readonly attribute long long VM;
15655 
15671     void dumpGuestCore (
15672         in wstring filename,
15673         in wstring compression
15674     );
15675 
15692     void dumpHostProcessCore (
15693         in wstring filename,
15694         in wstring compression
15695     );
15696 
15717     void info (
15718         in wstring name,
15719         in wstring args,
15720         [retval] out wstring info
15721     );
15722 
15728     void injectNMI();
15729 
15740     void modifyLogGroups (
15741         in wstring settings
15742     );
15743 
15754     void modifyLogFlags (
15755         in wstring settings
15756     );
15757 
15768     void modifyLogDestinations (
15769         in wstring settings
15770     );
15771 
15786     void readPhysicalMemory (
15787         in long long address,
15788         in unsigned long size,
15789         [retval] out octet[] bytes
15790     );
15791 
15806     void writePhysicalMemory (
15807         in long long address,
15808         in unsigned long size,
15809         in octet[] bytes
15810     );
15811 
15828     void readVirtualMemory (
15829         in unsigned long cpuId,
15830         in long long address,
15831         in unsigned long size,
15832         [retval] out octet[] bytes
15833     );
15834 
15851     void writeVirtualMemory (
15852         in unsigned long cpuId,
15853         in long long address,
15854         in unsigned long size,
15855         in octet[] bytes
15856     );
15857 
15870     void detectOS (
15871         [retval] out wstring os
15872     );
15873 
15891     void getRegister (
15892         in unsigned long cpuId,
15893         in wstring name,
15894         [retval] out wstring value
15895     );
15896 
15914     void getRegisters (
15915         in unsigned long cpuId,
15916         out wstring[] names,
15917         out wstring[] values
15918     );
15919 
15938     void setRegister (
15939         in unsigned long cpuId,
15940         in wstring name,
15941         in wstring value
15942     );
15943 
15962     void setRegisters (
15963         in unsigned long cpuId,
15964         in wstring[] names,
15965         in wstring[] values
15966     );
15967 
15980     void dumpGuestStack (
15981         in unsigned long cpuId,
15982         [retval] out wstring stack
15983     );
15984 
15992     void resetStats (
15993         in wstring pattern
15994     );
15995 
16003     void dumpStats (
16004         in wstring pattern
16005     );
16006 
16018     void getStats (
16019         in wstring pattern,
16020         in boolean withDescriptions,
16021         out wstring stats
16022     );
16023 
16024 }; /* interface IMachineDebugger */
16025 
16026 interface IUSBController : $unknown
16027 {
16036     attribute boolean enabled;
16037 
16046     attribute boolean enabledEhci;
16047 
16053     readonly attribute boolean proxyAvailable;
16054 
16062     readonly attribute unsigned short USBStandard;
16063 
16089     readonly attribute IUSBDeviceFilter[] deviceFilters;
16090 
16118     void createDeviceFilter (
16119         in wstring name,
16120         [retval] out IUSBDeviceFilter filter
16121     );
16122 
16167     void insertDeviceFilter (
16168         in unsigned long position,
16169         in IUSBDeviceFilter filter
16170     );
16171 
16204     void removeDeviceFilter (
16205         in unsigned long position,
16206         [retval] out IUSBDeviceFilter filter
16207     );
16208 
16209 }; /* interface IUSBController */
16210 
16223 interface IUSBDevice : $unknown
16224 {
16231     readonly attribute wstringUUID id;
16232 
16236     readonly attribute unsigned short vendorId;
16237 
16241     readonly attribute unsigned short productId;
16242 
16250     readonly attribute unsigned short revision;
16251 
16255     readonly attribute wstring manufacturer;
16256 
16260     readonly attribute wstring product;
16261 
16265     readonly attribute wstring serialNumber;
16266 
16270     readonly attribute wstring address;
16271 
16278     readonly attribute unsigned short port;
16279 
16285     readonly attribute unsigned short version;
16286 
16294     readonly attribute unsigned short portVersion;
16295 
16302     readonly attribute boolean remote;
16303 
16304 }; /* interface IUSBDevice */
16305 
16380 interface IUSBDeviceFilter : $unknown
16381 {
16389     attribute wstring name;
16390 
16394     attribute boolean active;
16395 
16403     attribute wstring vendorId;
16404 
16412     attribute wstring productId;
16413 
16427     attribute wstring revision;
16428 
16433     attribute wstring manufacturer;
16434 
16439     attribute wstring product;
16440 
16445     attribute wstring serialNumber;
16446 
16451     attribute wstring port;
16452 
16462     attribute wstring remote;
16463 
16473     attribute unsigned long maskedInterfaces;
16474 
16475 }; /* interface IUSBDeviceFilter */
16476 
16493 interface IHostUSBDevice : IUSBDevice
16494 {
16500     readonly attribute USBDeviceState state;
16501 
16502 }; /* interface IHostUSBDevice */
16503 
16526 interface IHostUSBDeviceFilter : IUSBDeviceFilter
16527 {
16534     attribute USBDeviceFilterAction action;
16535 
16536 }; /* interface IHostUSBDeviceFilter */
16537 
16546 interface IAudioAdapter : $unknown
16547 {
16556     attribute boolean enabled;
16557 
16563     attribute AudioControllerType audioController;
16564 
16571     attribute AudioDriverType audioDriver;
16572 
16573 }; /* interface IAudioAdapter */
16574 
16575 interface IVRDEServer : $unknown
16576 {
16580     attribute boolean enabled;
16581 
16585     attribute AuthType authType;
16586 
16590     attribute unsigned long authTimeout;
16591 
16598     attribute boolean allowMultiConnection;
16599 
16607     attribute boolean reuseSingleConnection;
16608 
16615     attribute wstring VRDEExtPack;
16616 
16623     attribute wstring authLibrary;
16624 
16630     readonly attribute wstring[] VRDEProperties;
16631 
16645     void setVRDEProperty (
16646         in wstring key,
16647         in wstring value
16648     );
16649 
16663     void getVRDEProperty (
16664         in wstring key,
16665         [retval] out wstring value
16666     );
16667 
16668 }; /* interface IVRDEServer */
16669 
16727 interface ISharedFolder : $unknown
16728 {
16732     readonly attribute wstring name;
16733 
16737     readonly attribute wstring hostPath;
16738 
16748     readonly attribute boolean accessible;
16749 
16756     readonly attribute boolean writable;
16757 
16763     readonly attribute boolean autoMount;
16764 
16777     readonly attribute wstring lastAccessError;
16778 
16779 }; /* interface ISharedFolder */
16780 
16781 interface IInternalSessionControl : $unknown
16782 {
16787     void getPID (
16788         [retval] out unsigned long pid
16789     );
16790 
16812     void getRemoteConsole (
16813         [retval] out IConsole console
16814     );
16815 
16839     void assignMachine (
16840         in IMachine machine
16841     );
16842 
16857     void assignRemoteMachine (
16858         in IMachine machine,
16859         in IConsole console
16860     );
16861 
16885     void updateMachineState (
16886         in MachineState aMachineState
16887     );
16888 
16904     void uninitialize();
16905 
16928     void onNetworkAdapterChange (
16929         in INetworkAdapter networkAdapter,
16930         in boolean changeAdapter
16931     );
16932 
16955     void onSerialPortChange (
16956         in ISerialPort serialPort
16957     );
16958 
16981     void onParallelPortChange (
16982         in IParallelPort parallelPort
16983     );
16984 
17007     void onStorageControllerChange();
17008 
17035     void onMediumChange (
17036         in IMediumAttachment mediumAttachment,
17037         in boolean force
17038     );
17039 
17066     void onStorageDeviceChange (
17067         in IMediumAttachment mediumAttachment,
17068         in boolean remove
17069     );
17070 
17080     void onCPUChange (
17081         in unsigned long cpu,
17082         in boolean add
17083     );
17084 
17092     void onCPUExecutionCapChange (
17093         in unsigned long executionCap
17094     );
17095 
17120     void onVRDEServerChange (
17121         in boolean restart
17122     );
17123 
17146     void onUSBControllerChange();
17147 
17176     void onSharedFolderChange (
17177         in boolean global
17178     );
17179 
17205     void onUSBDeviceAttach (
17206         in IUSBDevice device,
17207         in IVirtualBoxErrorInfo error,
17208         in unsigned long maskedInterfaces
17209     );
17210 
17236     void onUSBDeviceDetach (
17237         in wstringUUID id,
17238         in IVirtualBoxErrorInfo error
17239     );
17240 
17258     void onShowWindow (
17259         in boolean check,
17260         out boolean canShow,
17261         out long long winId
17262     );
17263 
17271     void onBandwidthGroupChange (
17272         in IBandwidthGroup bandwidthGroup
17273     );
17274 
17298     void accessGuestProperty (
17299         in wstring name,
17300         in wstring value,
17301         in wstring flags,
17302         in boolean isSetter,
17303         out wstring retValue,
17304         out long long retTimestamp,
17305         out wstring retFlags
17306     );
17307 
17355     void enumerateGuestProperties (
17356         in wstring patterns,
17357         out wstring[] key,
17358         out wstring[] value,
17359         out long long[] timestamp,
17360         out wstring[] flags
17361     );
17362 
17408     void onlineMergeMedium (
17409         in IMediumAttachment mediumAttachment,
17410         in unsigned long sourceIdx,
17411         in unsigned long targetIdx,
17412         in IMedium source,
17413         in IMedium target,
17414         in boolean mergeForward,
17415         in IMedium parentForTarget,
17416         in IMedium[] childrenToReparent,
17417         in IProgress progress
17418     );
17419 
17443     void enableVMMStatistics (
17444         in boolean enable
17445     );
17446 
17447 }; /* interface IInternalSessionControl */
17448 
17507 interface ISession : $unknown
17508 {
17512     readonly attribute SessionState state;
17513 
17521     readonly attribute SessionType type;
17522 
17526     readonly attribute IMachine machine;
17527 
17531     readonly attribute IConsole console;
17532 
17564     void unlockMachine();
17565 
17566 }; /* interface ISession */
17567 
17590 interface IStorageController : $unknown
17591 {
17600     readonly attribute wstring name;
17601 
17607     readonly attribute unsigned long maxDevicesPerPortCount;
17608 
17614     readonly attribute unsigned long minPortCount;
17615 
17621     readonly attribute unsigned long maxPortCount;
17622 
17628     attribute unsigned long instance;
17629 
17638     attribute unsigned long portCount;
17639 
17645     readonly attribute StorageBus bus;
17646 
17659     attribute StorageControllerType controllerType;
17660 
17675     attribute boolean useHostIOCache;
17676 
17682     readonly attribute boolean bootable;
17683 
17706     void getIDEEmulationPort (
17707         in long devicePosition,
17708         [retval] out long portNumber
17709     );
17710 
17734     void setIDEEmulationPort (
17735         in long devicePosition,
17736         in long portNumber
17737     );
17738 
17739 }; /* interface IStorageController */
17740 
17764 interface IManagedObjectRef : $unknown
17765 {
17772     void getInterfaceName (
17773         [retval] out wstring return
17774     );
17775 
17783     void release();
17784 
17785 }; /* interface IManagedObjectRef */
17786 
17795 interface IWebsessionManager : $unknown
17796 {
17805     void logon (
17806         in wstring username,
17807         in wstring password,
17808         [retval] out IVirtualBox return
17809     );
17810 
17820     void getSessionObject (
17821         in IVirtualBox refIVirtualBox,
17822         [retval] out ISession return
17823     );
17824 
17832     void logoff (
17833         in IVirtualBox refIVirtualBox
17834     );
17835 
17836 }; /* interface IWebsessionManager */
17837 
17846 interface IPerformanceMetric : $unknown
17847 {
17853     readonly attribute wstring metricName;
17854 
17860     readonly attribute $unknown object;
17861 
17867     readonly attribute wstring description;
17868 
17874     readonly attribute unsigned long period;
17875 
17885     readonly attribute unsigned long count;
17886 
17892     readonly attribute wstring unit;
17893 
17899     readonly attribute long minimumValue;
17900 
17906     readonly attribute long maximumValue;
17907 
17908 }; /* interface IPerformanceMetric */
17909 
18016 interface IPerformanceCollector : $unknown
18017 {
18028     readonly attribute wstring[] metricNames;
18029 
18053     void getMetrics (
18054         in wstring[] metricNames,
18055         in $unknown[] objects,
18056         [retval] out IPerformanceMetric[] metrics
18057     );
18058 
18097     void setupMetrics (
18098         in wstring[] metricNames,
18099         in $unknown[] objects,
18100         in unsigned long period,
18101         in unsigned long count,
18102         [retval] out IPerformanceMetric[] affectedMetrics
18103     );
18104 
18133     void enableMetrics (
18134         in wstring[] metricNames,
18135         in $unknown[] objects,
18136         [retval] out IPerformanceMetric[] affectedMetrics
18137     );
18138 
18167     void disableMetrics (
18168         in wstring[] metricNames,
18169         in $unknown[] objects,
18170         [retval] out IPerformanceMetric[] affectedMetrics
18171     );
18172 
18261     void queryMetricsData (
18262         in wstring[] metricNames,
18263         in $unknown[] objects,
18264         out wstring[] returnMetricNames,
18265         out $unknown[] returnObjects,
18266         out wstring[] returnUnits,
18267         out unsigned long[] returnScales,
18268         out unsigned long[] returnSequenceNumbers,
18269         out unsigned long[] returnDataIndices,
18270         out unsigned long[] returnDataLengths,
18271         [retval] out long[] returnData
18272     );
18273 
18274 }; /* interface IPerformanceCollector */
18275 
18283 interface INATEngine : $unknown
18284 {
18289     attribute wstring network;
18290 
18297     attribute wstring hostIP;
18298 
18303     attribute wstring tftpPrefix;
18304 
18309     attribute wstring tftpBootFile;
18310 
18318     attribute wstring tftpNextServer;
18319 
18323     attribute unsigned long aliasMode;
18324 
18328     attribute boolean dnsPassDomain;
18329 
18334     attribute boolean dnsProxy;
18335 
18340     attribute boolean dnsUseHostResolver;
18341 
18346     readonly attribute wstring[] redirects;
18347 
18363     void setNetworkSettings (
18364         in unsigned long mtu,
18365         in unsigned long sockSnd,
18366         in unsigned long sockRcv,
18367         in unsigned long TcpWndSnd,
18368         in unsigned long TcpWndRcv
18369     );
18370 
18375     void getNetworkSettings (
18376         out unsigned long mtu,
18377         out unsigned long sockSnd,
18378         out unsigned long sockRcv,
18379         out unsigned long TcpWndSnd,
18380         out unsigned long TcpWndRcv
18381     );
18382 
18402     void addRedirect (
18403         in wstring name,
18404         in NATProtocol proto,
18405         in wstring hostIp,
18406         in unsigned short hostPort,
18407         in wstring guestIp,
18408         in unsigned short guestPort
18409     );
18410 
18416     void removeRedirect (
18417         in wstring name
18418     );
18419 
18420 }; /* interface INATEngine */
18421 
18430 interface IExtPackPlugIn : $unknown
18431 {
18435     readonly attribute wstring name;
18436 
18440     readonly attribute wstring description;
18441 
18447     readonly attribute wstring frontend;
18448 
18452     readonly attribute wstring modulePath;
18453 
18454 }; /* interface IExtPackPlugIn */
18455 
18464 interface IExtPackBase : $unknown
18465 {
18469     readonly attribute wstring name;
18470 
18474     readonly attribute wstring description;
18475 
18484     readonly attribute wstring version;
18485 
18489     readonly attribute unsigned long revision;
18490 
18494     readonly attribute wstring VRDEModule;
18495 
18499     readonly attribute IExtPackPlugIn[] plugIns;
18500 
18510     readonly attribute boolean usable;
18511 
18518     readonly attribute wstring whyUnusable;
18519 
18523     readonly attribute boolean showLicense;
18524 
18533     readonly attribute wstring license;
18534 
18558     void queryLicense (
18559         in wstring preferredLocale,
18560         in wstring preferredLanguage,
18561         in wstring format,
18562         [retval] out wstring licenseText
18563     );
18564 
18565 }; /* interface IExtPackBase */
18566 
18575 interface IExtPack : IExtPackBase
18576 {
18588     void queryObject (
18589         in wstring objUuid,
18590         [retval] out $unknown returnInterface
18591     );
18592 
18593 }; /* interface IExtPack */
18594 
18604 interface IExtPackFile : IExtPackBase
18605 {
18611     readonly attribute wstring filePath;
18612 
18631     void install (
18632         in boolean replace,
18633         in wstring displayInfo,
18634         [retval] out IProgress progess
18635     );
18636 
18637 }; /* interface IExtPackFile */
18638 
18649 interface IExtPackManager : $unknown
18650 {
18656     readonly attribute IExtPack[] installedExtPacks;
18657 
18675     void find (
18676         in wstring name,
18677         [retval] out IExtPack returnData
18678     );
18679 
18691     void openExtPackFile (
18692         in wstring path,
18693         [retval] out IExtPackFile file
18694     );
18695 
18714     void uninstall (
18715         in wstring name,
18716         in boolean forcedRemoval,
18717         in wstring displayInfo,
18718         [retval] out IProgress progess
18719     );
18720 
18724     void cleanup();
18725 
18738     void queryAllPlugInsForFrontend (
18739         in wstring frontendName,
18740         [retval] out wstring[] plugInModules
18741     );
18742 
18750     void isExtPackUsable (
18751         in wstring name,
18752         [retval] out boolean usable
18753     );
18754 
18755 }; /* interface IExtPackManager */
18756 
18762 interface IBandwidthGroup : $unknown
18763 {
18767     readonly attribute wstring name;
18768 
18772     readonly attribute BandwidthGroupType type;
18773 
18777     readonly attribute unsigned long reference;
18778 
18783     attribute unsigned long maxMbPerSec;
18784 
18785 }; /* interface IBandwidthGroup */
18786 
18795 interface IBandwidthControl : $unknown
18796 {
18802     readonly attribute unsigned long numGroups;
18803 
18816     void createBandwidthGroup (
18817         in wstring name,
18818         in BandwidthGroupType type,
18819         in unsigned long maxMbPerSec
18820     );
18821 
18829     void deleteBandwidthGroup (
18830         in wstring name
18831     );
18832 
18842     void getBandwidthGroup (
18843         in wstring name,
18844         [retval] out IBandwidthGroup bandwidthGroup
18845     );
18846 
18854     void getAllBandwidthGroups (
18855         [retval] out IBandwidthGroup[] bandwidthGroups
18856     );
18857 
18858 }; /* interface IBandwidthControl */
18859 
18872 interface IVirtualBoxClient : $unknown
18873 {
18879     readonly attribute IVirtualBox virtualBox;
18880 
18886     readonly attribute ISession session;
18887 
18893     readonly attribute IEventSource eventSource;
18894 
18895 }; /* interface IVirtualBoxClient */
18896 
18910 interface IEventSource : $unknown
18911 {
18917     void createListener (
18918         [retval] out IEventListener listener
18919     );
18920 
18936     void createAggregator (
18937         in IEventSource[] subordinates,
18938         [retval] out IEventSource result
18939     );
18940 
18973     void registerListener (
18974         in IEventListener listener,
18975         in VBoxEventType[] interesting,
18976         in boolean active
18977     );
18978 
18987     void unregisterListener (
18988         in IEventListener listener
18989     );
18990 
19005     void fireEvent (
19006         in IEvent event,
19007         in long timeout,
19008         [retval] out boolean result
19009     );
19010 
19035     void getEvent (
19036         in IEventListener listener,
19037         in long timeout,
19038         [retval] out IEvent event
19039     );
19040 
19052     void eventProcessed (
19053         in IEventListener listener,
19054         in IEvent event
19055     );
19056 
19057 }; /* interface IEventSource */
19058 
19068 interface IEventListener : $unknown
19069 {
19082     void handleEvent (
19083         in IEvent event
19084     );
19085 
19086 }; /* interface IEventListener */
19087 
19164 interface IEvent : $unknown
19165 {
19171     readonly attribute VBoxEventType type;
19172 
19178     readonly attribute IEventSource source;
19179 
19190     readonly attribute boolean waitable;
19191 
19198     void setProcessed();
19199 
19213     void waitProcessed (
19214         in long timeout,
19215         [retval] out boolean result
19216     );
19217 
19218 }; /* interface IEvent */
19219 
19225 interface IReusableEvent : IEvent
19226 {
19230     readonly attribute unsigned long generation;
19231 
19238     void reuse();
19239 
19240 }; /* interface IReusableEvent */
19241 
19247 interface IMachineEvent : IEvent
19248 {
19252     readonly attribute wstringUUID machineId;
19253 
19254 }; /* interface IMachineEvent */
19255 
19261 interface IMachineStateChangedEvent : IMachineEvent
19262 {
19266     readonly attribute MachineState state;
19267 
19268 }; /* interface IMachineStateChangedEvent */
19269 
19277 interface IMachineDataChangedEvent : IMachineEvent
19278 {
19285     readonly attribute boolean temporary;
19286 
19287 }; /* interface IMachineDataChangedEvent */
19288 
19297 interface IMediumRegisteredEvent : IEvent
19298 {
19302     readonly attribute wstringUUID mediumId;
19303 
19307     readonly attribute DeviceType mediumType;
19308 
19315     readonly attribute boolean registered;
19316 
19317 }; /* interface IMediumRegisteredEvent */
19318 
19327 interface IMachineRegisteredEvent : IMachineEvent
19328 {
19335     readonly attribute boolean registered;
19336 
19337 }; /* interface IMachineRegisteredEvent */
19338 
19348 interface ISessionStateChangedEvent : IMachineEvent
19349 {
19355     readonly attribute SessionState state;
19356 
19357 }; /* interface ISessionStateChangedEvent */
19358 
19366 interface IGuestPropertyChangedEvent : IMachineEvent
19367 {
19373     readonly attribute wstring name;
19374 
19380     readonly attribute wstring value;
19381 
19387     readonly attribute wstring flags;
19388 
19389 }; /* interface IGuestPropertyChangedEvent */
19390 
19396 interface ISnapshotEvent : IMachineEvent
19397 {
19401     readonly attribute wstringUUID snapshotId;
19402 
19403 }; /* interface ISnapshotEvent */
19404 
19414 interface ISnapshotTakenEvent : ISnapshotEvent
19415 {
19416 }; /* interface ISnapshotTakenEvent */
19417 
19434 interface ISnapshotDeletedEvent : ISnapshotEvent
19435 {
19436 }; /* interface ISnapshotDeletedEvent */
19437 
19447 interface ISnapshotChangedEvent : ISnapshotEvent
19448 {
19449 }; /* interface ISnapshotChangedEvent */
19450 
19459 interface IMousePointerShapeChangedEvent : IEvent
19460 {
19466     readonly attribute boolean visible;
19467 
19473     readonly attribute boolean alpha;
19474 
19480     readonly attribute unsigned long xhot;
19481 
19487     readonly attribute unsigned long yhot;
19488 
19494     readonly attribute unsigned long width;
19495 
19501     readonly attribute unsigned long height;
19502 
19535     readonly attribute octet[] shape;
19536 
19537 }; /* interface IMousePointerShapeChangedEvent */
19538 
19547 interface IMouseCapabilityChangedEvent : IEvent
19548 {
19554     readonly attribute boolean supportsAbsolute;
19555 
19561     readonly attribute boolean supportsRelative;
19562 
19568     readonly attribute boolean needsHostCursor;
19569 
19570 }; /* interface IMouseCapabilityChangedEvent */
19571 
19580 interface IKeyboardLedsChangedEvent : IEvent
19581 {
19587     readonly attribute boolean numLock;
19588 
19594     readonly attribute boolean capsLock;
19595 
19601     readonly attribute boolean scrollLock;
19602 
19603 }; /* interface IKeyboardLedsChangedEvent */
19604 
19613 interface IStateChangedEvent : IEvent
19614 {
19620     readonly attribute MachineState state;
19621 
19622 }; /* interface IStateChangedEvent */
19623 
19633 interface IAdditionsStateChangedEvent : IEvent
19634 {
19635 }; /* interface IAdditionsStateChangedEvent */
19636 
19647 interface INetworkAdapterChangedEvent : IEvent
19648 {
19654     readonly attribute INetworkAdapter networkAdapter;
19655 
19656 }; /* interface INetworkAdapterChangedEvent */
19657 
19668 interface ISerialPortChangedEvent : IEvent
19669 {
19675     readonly attribute ISerialPort serialPort;
19676 
19677 }; /* interface ISerialPortChangedEvent */
19678 
19689 interface IParallelPortChangedEvent : IEvent
19690 {
19696     readonly attribute IParallelPort parallelPort;
19697 
19698 }; /* interface IParallelPortChangedEvent */
19699 
19709 interface IStorageControllerChangedEvent : IEvent
19710 {
19711 }; /* interface IStorageControllerChangedEvent */
19712 
19722 interface IMediumChangedEvent : IEvent
19723 {
19729     readonly attribute IMediumAttachment mediumAttachment;
19730 
19731 }; /* interface IMediumChangedEvent */
19732 
19740 interface ICPUChangedEvent : IEvent
19741 {
19747     readonly attribute unsigned long cpu;
19748 
19754     readonly attribute boolean add;
19755 
19756 }; /* interface ICPUChangedEvent */
19757 
19765 interface ICPUExecutionCapChangedEvent : IEvent
19766 {
19772     readonly attribute unsigned long executionCap;
19773 
19774 }; /* interface ICPUExecutionCapChangedEvent */
19775 
19783 interface IGuestKeyboardEvent : IEvent
19784 {
19790     readonly attribute long[] scancodes;
19791 
19792 }; /* interface IGuestKeyboardEvent */
19793 
19801 interface IGuestMouseEvent : IReusableEvent
19802 {
19808     readonly attribute boolean absolute;
19809 
19815     readonly attribute long x;
19816 
19822     readonly attribute long y;
19823 
19829     readonly attribute long z;
19830 
19836     readonly attribute long w;
19837 
19843     readonly attribute long buttons;
19844 
19845 }; /* interface IGuestMouseEvent */
19846 
19857 interface IVRDEServerChangedEvent : IEvent
19858 {
19859 }; /* interface IVRDEServerChangedEvent */
19860 
19870 interface IVRDEServerInfoChangedEvent : IEvent
19871 {
19872 }; /* interface IVRDEServerInfoChangedEvent */
19873 
19884 interface IUSBControllerChangedEvent : IEvent
19885 {
19886 }; /* interface IUSBControllerChangedEvent */
19887 
19911 interface IUSBDeviceStateChangedEvent : IEvent
19912 {
19918     readonly attribute IUSBDevice device;
19919 
19925     readonly attribute boolean attached;
19926 
19932     readonly attribute IVirtualBoxErrorInfo error;
19933 
19934 }; /* interface IUSBDeviceStateChangedEvent */
19935 
19951 interface ISharedFolderChangedEvent : IEvent
19952 {
19958     readonly attribute Scope scope;
19959 
19960 }; /* interface ISharedFolderChangedEvent */
19961 
20013 interface IRuntimeErrorEvent : IEvent
20014 {
20020     readonly attribute boolean fatal;
20021 
20027     readonly attribute wstring id;
20028 
20034     readonly attribute wstring message;
20035 
20036 }; /* interface IRuntimeErrorEvent */
20037 
20045 interface IEventSourceChangedEvent : IEvent
20046 {
20052     readonly attribute IEventListener listener;
20053 
20059     readonly attribute boolean add;
20060 
20061 }; /* interface IEventSourceChangedEvent */
20062 
20071 interface IExtraDataChangedEvent : IEvent
20072 {
20079     readonly attribute wstringUUID machineId;
20080 
20086     readonly attribute wstring key;
20087 
20093     readonly attribute wstring value;
20094 
20095 }; /* interface IExtraDataChangedEvent */
20096 
20102 interface IVetoEvent : IEvent
20103 {
20113     void addVeto (
20114         in wstring reason
20115     );
20116 
20126     void isVetoed (
20127         [retval] out boolean result
20128     );
20129 
20139     void getVetos (
20140         [retval] out wstring[] result
20141     );
20142 
20143 }; /* interface IVetoEvent */
20144 
20154 interface IExtraDataCanChangeEvent : IVetoEvent
20155 {
20162     readonly attribute wstringUUID machineId;
20163 
20169     readonly attribute wstring key;
20170 
20176     readonly attribute wstring value;
20177 
20178 }; /* interface IExtraDataCanChangeEvent */
20179 
20195 interface ICanShowWindowEvent : IVetoEvent
20196 {
20197 }; /* interface ICanShowWindowEvent */
20198 
20230 interface IShowWindowEvent : IEvent
20231 {
20240     attribute long long winId;
20241 
20242 }; /* interface IShowWindowEvent */
20243 
20251 interface INATRedirectEvent : IMachineEvent
20252 {
20258     readonly attribute unsigned long slot;
20259 
20265     readonly attribute boolean remove;
20266 
20272     readonly attribute wstring name;
20273 
20279     readonly attribute NATProtocol proto;
20280 
20286     readonly attribute wstring hostIp;
20287 
20293     readonly attribute long hostPort;
20294 
20300     readonly attribute wstring guestIp;
20301 
20307     readonly attribute long guestPort;
20308 
20309 }; /* interface INATRedirectEvent */
20310 
20323 interface IHostPciDevicePlugEvent : IMachineEvent
20324 {
20330     readonly attribute boolean plugged;
20331 
20338     readonly attribute boolean success;
20339 
20345     readonly attribute IPciDeviceAttachment attachment;
20346 
20352     readonly attribute wstring message;
20353 
20354 }; /* interface IHostPciDevicePlugEvent */
20355 
20364 interface IVBoxSVCAvailabilityChangedEvent : IEvent
20365 {
20371     readonly attribute boolean available;
20372 
20373 }; /* interface IVBoxSVCAvailabilityChangedEvent */
20374 
20382 interface IBandwidthGroupChangedEvent : IEvent
20383 {
20389     readonly attribute IBandwidthGroup bandwidthGroup;
20390 
20391 }; /* interface IBandwidthGroupChangedEvent */
20392 
20400 interface IGuestMonitorChangedEvent : IEvent
20401 {
20407     readonly attribute GuestMonitorChangedEventType changeType;
20408 
20414     readonly attribute unsigned long screenId;
20415 
20422     readonly attribute unsigned long originX;
20423 
20430     readonly attribute unsigned long originY;
20431 
20438     readonly attribute unsigned long width;
20439 
20446     readonly attribute unsigned long height;
20447 
20448 }; /* interface IGuestMonitorChangedEvent */
20449 
20459 interface IStorageDeviceChangedEvent : IEvent
20460 {
20466     readonly attribute IMediumAttachment storageDevice;
20467 
20473     readonly attribute boolean removed;
20474 
20475 }; /* interface IStorageDeviceChangedEvent */
20476 
20477 

Generated on Wed Oct 14 2015 21:20:40 for VirtualBox Main API by  doxygen 1.7.1