• 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 
00137 const HRESULT VBOX_E_OBJECT_NOT_FOUND = 0x80BB0001;
00145 const HRESULT VBOX_E_INVALID_VM_STATE = 0x80BB0002;
00153 const HRESULT VBOX_E_VM_ERROR = 0x80BB0003;
00161 const HRESULT VBOX_E_FILE_ERROR = 0x80BB0004;
00169 const HRESULT VBOX_E_IPRT_ERROR = 0x80BB0005;
00177 const HRESULT VBOX_E_PDM_ERROR = 0x80BB0006;
00185 const HRESULT VBOX_E_INVALID_OBJECT_STATE = 0x80BB0007;
00193 const HRESULT VBOX_E_HOST_ERROR = 0x80BB0008;
00201 const HRESULT VBOX_E_NOT_SUPPORTED = 0x80BB0009;
00209 const HRESULT VBOX_E_XML_ERROR = 0x80BB000A;
00217 const HRESULT VBOX_E_INVALID_SESSION_STATE = 0x80BB000B;
00225 const HRESULT VBOX_E_OBJECT_IN_USE = 0x80BB000C;
00235 enum SettingsVersion
00236 {
00241     SettingsVersion_Null = 0,
00246     SettingsVersion_v1_0 = 1,
00251     SettingsVersion_v1_1 = 2,
00256     SettingsVersion_v1_2 = 3,
00261     SettingsVersion_v1_3pre = 4,
00266     SettingsVersion_v1_3 = 5,
00271     SettingsVersion_v1_4 = 6,
00276     SettingsVersion_v1_5 = 7,
00281     SettingsVersion_v1_6 = 8,
00286     SettingsVersion_v1_7 = 9,
00291     SettingsVersion_v1_8 = 10,
00296     SettingsVersion_v1_9 = 11,
00301     SettingsVersion_v1_10 = 12,
00306     SettingsVersion_v1_11 = 13,
00311     SettingsVersion_v1_12 = 14,
00316     SettingsVersion_v1_13 = 15,
00321     SettingsVersion_Future = 99999,
00322 };
00323 
00331 enum AccessMode
00332 {
00333     AccessMode_ReadOnly = 1,
00334     AccessMode_ReadWrite = 2,
00335 };
00336 
00454 enum MachineState
00455 {
00460     MachineState_Null = 0,
00468     MachineState_PoweredOff = 1,
00477     MachineState_Saved = 2,
00486     MachineState_Teleported = 3,
00495     MachineState_Aborted = 4,
00502     MachineState_Running = 5,
00509     MachineState_Paused = 6,
00517     MachineState_Stuck = 7,
00527     MachineState_Teleporting = 8,
00538     MachineState_LiveSnapshotting = 9,
00546     MachineState_Starting = 10,
00554     MachineState_Stopping = 11,
00562     MachineState_Saving = 12,
00570     MachineState_Restoring = 13,
00579     MachineState_TeleportingPausedVM = 14,
00586     MachineState_TeleportingIn = 15,
00593     MachineState_FaultTolerantSyncing = 16,
00601     MachineState_DeletingSnapshotOnline = 17,
00609     MachineState_DeletingSnapshotPaused = 18,
00616     MachineState_RestoringSnapshot = 19,
00625     MachineState_DeletingSnapshot = 20,
00632     MachineState_SettingUp = 21,
00639     MachineState_FirstOnline = 5,
00646     MachineState_LastOnline = 18,
00653     MachineState_FirstTransient = 8,
00660     MachineState_LastTransient = 21,
00661 };
00662 
00672 enum SessionState
00673 {
00678     SessionState_Null = 0,
00689     SessionState_Unlocked = 1,
00703     SessionState_Locked = 2,
00713     SessionState_Spawning = 3,
00720     SessionState_Unlocking = 4,
00721 };
00722 
00731 enum CPUPropertyType
00732 {
00737     CPUPropertyType_Null = 0,
00746     CPUPropertyType_PAE = 1,
00754     CPUPropertyType_Synthetic = 2,
00755 };
00756 
00766 enum HWVirtExPropertyType
00767 {
00772     HWVirtExPropertyType_Null = 0,
00780     HWVirtExPropertyType_Enabled = 1,
00789     HWVirtExPropertyType_Exclusive = 2,
00796     HWVirtExPropertyType_VPID = 3,
00803     HWVirtExPropertyType_NestedPaging = 4,
00810     HWVirtExPropertyType_LargePages = 5,
00818     HWVirtExPropertyType_Force = 6,
00819 };
00820 
00828 enum FaultToleranceState
00829 {
00834     FaultToleranceState_Inactive = 1,
00839     FaultToleranceState_Master = 2,
00844     FaultToleranceState_Standby = 3,
00845 };
00846 
00854 enum LockType
00855 {
00860     LockType_Write = 2,
00865     LockType_Shared = 1,
00871     LockType_VM = 3,
00872 };
00873 
00882 enum SessionType
00883 {
00888     SessionType_Null = 0,
00896     SessionType_WriteLock = 1,
00903     SessionType_Remote = 2,
00910     SessionType_Shared = 3,
00911 };
00912 
00920 enum DeviceType
00921 {
00929     DeviceType_Null = 0,
00934     DeviceType_Floppy = 1,
00939     DeviceType_DVD = 2,
00944     DeviceType_HardDisk = 3,
00949     DeviceType_Network = 4,
00954     DeviceType_USB = 5,
00959     DeviceType_SharedFolder = 6,
00960 };
00961 
00969 enum DeviceActivity
00970 {
00971     DeviceActivity_Null = 0,
00972     DeviceActivity_Idle = 1,
00973     DeviceActivity_Reading = 2,
00974     DeviceActivity_Writing = 3,
00975 };
00976 
00984 enum ClipboardMode
00985 {
00986     ClipboardMode_Disabled = 0,
00987     ClipboardMode_HostToGuest = 1,
00988     ClipboardMode_GuestToHost = 2,
00989     ClipboardMode_Bidirectional = 3,
00990 };
00991 
00999 enum DragAndDropMode
01000 {
01001     DragAndDropMode_Disabled = 0,
01002     DragAndDropMode_HostToGuest = 1,
01003     DragAndDropMode_GuestToHost = 2,
01004     DragAndDropMode_Bidirectional = 3,
01005 };
01006 
01017 enum Scope
01018 {
01019     Scope_Global = 0,
01020     Scope_Machine = 1,
01021     Scope_Session = 2,
01022 };
01023 
01031 enum BIOSBootMenuMode
01032 {
01033     BIOSBootMenuMode_Disabled = 0,
01034     BIOSBootMenuMode_MenuOnly = 1,
01035     BIOSBootMenuMode_MessageAndMenu = 2,
01036 };
01037 
01045 enum ProcessorFeature
01046 {
01047     ProcessorFeature_HWVirtEx = 0,
01048     ProcessorFeature_PAE = 1,
01049     ProcessorFeature_LongMode = 2,
01050     ProcessorFeature_NestedPaging = 3,
01051 };
01052 
01060 enum FirmwareType
01061 {
01066     FirmwareType_BIOS = 1,
01071     FirmwareType_EFI = 2,
01076     FirmwareType_EFI32 = 3,
01081     FirmwareType_EFI64 = 4,
01086     FirmwareType_EFIDUAL = 5,
01087 };
01088 
01096 enum PointingHIDType
01097 {
01102     PointingHIDType_None = 1,
01107     PointingHIDType_PS2Mouse = 2,
01112     PointingHIDType_USBMouse = 3,
01117     PointingHIDType_USBTablet = 4,
01123     PointingHIDType_ComboMouse = 5,
01124 };
01125 
01133 enum KeyboardHIDType
01134 {
01139     KeyboardHIDType_None = 1,
01144     KeyboardHIDType_PS2Keyboard = 2,
01149     KeyboardHIDType_USBKeyboard = 3,
01155     KeyboardHIDType_ComboKeyboard = 4,
01156 };
01157 
01165 enum VFSType
01166 {
01167     VFSType_File = 1,
01168     VFSType_Cloud = 2,
01169     VFSType_S3 = 3,
01170     VFSType_WebDav = 4,
01171 };
01172 
01180 enum VFSFileType
01181 {
01182     VFSFileType_Unknown = 1,
01183     VFSFileType_Fifo = 2,
01184     VFSFileType_DevChar = 3,
01185     VFSFileType_Directory = 4,
01186     VFSFileType_DevBlock = 5,
01187     VFSFileType_File = 6,
01188     VFSFileType_SymLink = 7,
01189     VFSFileType_Socket = 8,
01190     VFSFileType_WhiteOut = 9,
01191 };
01192 
01200 enum ImportOptions
01201 {
01206     ImportOptions_KeepAllMACs = 1,
01211     ImportOptions_KeepNATMACs = 2,
01212 };
01213 
01220 enum VirtualSystemDescriptionType
01221 {
01222     VirtualSystemDescriptionType_Ignore = 1,
01223     VirtualSystemDescriptionType_OS = 2,
01224     VirtualSystemDescriptionType_Name = 3,
01225     VirtualSystemDescriptionType_Product = 4,
01226     VirtualSystemDescriptionType_Vendor = 5,
01227     VirtualSystemDescriptionType_Version = 6,
01228     VirtualSystemDescriptionType_ProductUrl = 7,
01229     VirtualSystemDescriptionType_VendorUrl = 8,
01230     VirtualSystemDescriptionType_Description = 9,
01231     VirtualSystemDescriptionType_License = 10,
01232     VirtualSystemDescriptionType_Miscellaneous = 11,
01233     VirtualSystemDescriptionType_CPU = 12,
01234     VirtualSystemDescriptionType_Memory = 13,
01235     VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
01236     VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
01237     VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
01238     VirtualSystemDescriptionType_HardDiskControllerSAS = 17,
01239     VirtualSystemDescriptionType_HardDiskImage = 18,
01240     VirtualSystemDescriptionType_Floppy = 19,
01241     VirtualSystemDescriptionType_CDROM = 20,
01242     VirtualSystemDescriptionType_NetworkAdapter = 21,
01243     VirtualSystemDescriptionType_USBController = 22,
01244     VirtualSystemDescriptionType_SoundCard = 23,
01249     VirtualSystemDescriptionType_SettingsFile = 24,
01250 };
01251 
01258 enum VirtualSystemDescriptionValueType
01259 {
01260     VirtualSystemDescriptionValueType_Reference = 1,
01261     VirtualSystemDescriptionValueType_Original = 2,
01262     VirtualSystemDescriptionValueType_Auto = 3,
01263     VirtualSystemDescriptionValueType_ExtraConfig = 4,
01264 };
01265 
01272 enum CleanupMode
01273 {
01278     CleanupMode_UnregisterOnly = 1,
01283     CleanupMode_DetachAllReturnNone = 2,
01288     CleanupMode_DetachAllReturnHardDisksOnly = 3,
01293     CleanupMode_Full = 4,
01294 };
01295 
01303 enum CloneMode
01304 {
01309     CloneMode_MachineState = 1,
01314     CloneMode_MachineAndChildStates = 2,
01319     CloneMode_AllStates = 3,
01320 };
01321 
01329 enum CloneOptions
01330 {
01335     CloneOptions_Link = 1,
01340     CloneOptions_KeepAllMACs = 2,
01345     CloneOptions_KeepNATMACs = 3,
01350     CloneOptions_KeepDiskNames = 4,
01351 };
01352 
01360 enum AutostopType
01361 {
01366     AutostopType_Disabled = 1,
01371     AutostopType_SaveState = 2,
01376     AutostopType_PowerOff = 3,
01381     AutostopType_AcpiShutdown = 4,
01382 };
01383 
01394 enum HostNetworkInterfaceMediumType
01395 {
01402     HostNetworkInterfaceMediumType_Unknown = 0,
01409     HostNetworkInterfaceMediumType_Ethernet = 1,
01416     HostNetworkInterfaceMediumType_PPP = 2,
01423     HostNetworkInterfaceMediumType_SLIP = 3,
01424 };
01425 
01435 enum HostNetworkInterfaceStatus
01436 {
01443     HostNetworkInterfaceStatus_Unknown = 0,
01450     HostNetworkInterfaceStatus_Up = 1,
01457     HostNetworkInterfaceStatus_Down = 2,
01458 };
01459 
01467 enum HostNetworkInterfaceType
01468 {
01469     HostNetworkInterfaceType_Bridged = 1,
01470     HostNetworkInterfaceType_HostOnly = 2,
01471 };
01472 
01480 enum AdditionsFacilityType
01481 {
01486     AdditionsFacilityType_None = 0,
01491     AdditionsFacilityType_VBoxGuestDriver = 20,
01496     AdditionsFacilityType_AutoLogon = 90,
01501     AdditionsFacilityType_VBoxService = 100,
01506     AdditionsFacilityType_VBoxTrayClient = 101,
01511     AdditionsFacilityType_Seamless = 1000,
01519     AdditionsFacilityType_Graphics = 1100,
01524     AdditionsFacilityType_All = 2147483646,
01525 };
01526 
01534 enum AdditionsFacilityClass
01535 {
01540     AdditionsFacilityClass_None = 0,
01545     AdditionsFacilityClass_Driver = 10,
01550     AdditionsFacilityClass_Service = 30,
01555     AdditionsFacilityClass_Program = 50,
01560     AdditionsFacilityClass_Feature = 100,
01565     AdditionsFacilityClass_ThirdParty = 999,
01570     AdditionsFacilityClass_All = 2147483646,
01571 };
01572 
01580 enum AdditionsFacilityStatus
01581 {
01586     AdditionsFacilityStatus_Inactive = 0,
01591     AdditionsFacilityStatus_Paused = 1,
01596     AdditionsFacilityStatus_PreInit = 20,
01601     AdditionsFacilityStatus_Init = 30,
01606     AdditionsFacilityStatus_Active = 50,
01611     AdditionsFacilityStatus_Terminating = 100,
01616     AdditionsFacilityStatus_Terminated = 101,
01621     AdditionsFacilityStatus_Failed = 800,
01626     AdditionsFacilityStatus_Unknown = 999,
01627 };
01628 
01636 enum AdditionsRunLevelType
01637 {
01642     AdditionsRunLevelType_None = 0,
01647     AdditionsRunLevelType_System = 1,
01652     AdditionsRunLevelType_Userland = 2,
01657     AdditionsRunLevelType_Desktop = 3,
01658 };
01659 
01667 enum AdditionsUpdateFlag
01668 {
01673     AdditionsUpdateFlag_None = 0,
01679     AdditionsUpdateFlag_WaitForUpdateStartOnly = 1,
01680 };
01681 
01689 enum ExecuteProcessFlag
01690 {
01695     ExecuteProcessFlag_None = 0,
01701     ExecuteProcessFlag_WaitForProcessStartOnly = 1,
01706     ExecuteProcessFlag_IgnoreOrphanedProcesses = 2,
01711     ExecuteProcessFlag_Hidden = 4,
01716     ExecuteProcessFlag_NoProfile = 8,
01721     ExecuteProcessFlag_WaitForStdOut = 16,
01726     ExecuteProcessFlag_WaitForStdErr = 32,
01727 };
01728 
01736 enum ExecuteProcessStatus
01737 {
01742     ExecuteProcessStatus_Undefined = 0,
01747     ExecuteProcessStatus_Started = 1,
01752     ExecuteProcessStatus_TerminatedNormally = 2,
01757     ExecuteProcessStatus_TerminatedSignal = 3,
01762     ExecuteProcessStatus_TerminatedAbnormally = 4,
01767     ExecuteProcessStatus_TimedOutKilled = 5,
01772     ExecuteProcessStatus_TimedOutAbnormally = 6,
01777     ExecuteProcessStatus_Down = 7,
01782     ExecuteProcessStatus_Error = 8,
01783 };
01784 
01792 enum FileSeekType
01793 {
01798     FileSeekType_Set = 0,
01803     FileSeekType_Current = 1,
01804 };
01805 
01813 enum ProcessInputFlag
01814 {
01819     ProcessInputFlag_None = 0,
01824     ProcessInputFlag_EndOfFile = 1,
01825 };
01826 
01835 enum ProcessOutputFlag
01836 {
01841     ProcessOutputFlag_None = 0,
01846     ProcessOutputFlag_StdErr = 1,
01847 };
01848 
01856 enum ProcessWaitForFlag
01857 {
01862     ProcessWaitForFlag_None = 0,
01867     ProcessWaitForFlag_Start = 1,
01872     ProcessWaitForFlag_Terminate = 2,
01877     ProcessWaitForFlag_StdIn = 4,
01882     ProcessWaitForFlag_StdOut = 8,
01887     ProcessWaitForFlag_StdErr = 16,
01888 };
01889 
01897 enum ProcessWaitResult
01898 {
01903     ProcessWaitResult_None = 0,
01908     ProcessWaitResult_Start = 1,
01913     ProcessWaitResult_Terminate = 2,
01918     ProcessWaitResult_Status = 3,
01923     ProcessWaitResult_Error = 4,
01928     ProcessWaitResult_Timeout = 5,
01933     ProcessWaitResult_StdIn = 6,
01938     ProcessWaitResult_StdOut = 7,
01943     ProcessWaitResult_StdErr = 8,
01948     ProcessWaitResult_Any = 9,
01949 };
01950 
01959 enum CopyFileFlag
01960 {
01965     CopyFileFlag_None = 0,
01970     CopyFileFlag_Recursive = 1,
01975     CopyFileFlag_Update = 2,
01980     CopyFileFlag_FollowLinks = 4,
01981 };
01982 
01990 enum DirectoryCreateFlag
01991 {
01996     DirectoryCreateFlag_None = 0,
02001     DirectoryCreateFlag_Parents = 1,
02002 };
02003 
02011 enum DirectoryRemoveRecFlag
02012 {
02017     DirectoryRemoveRecFlag_None = 0,
02022     DirectoryRemoveRecFlag_ContentAndDir = 1,
02027     DirectoryRemoveRecFlag_ContentOnly = 2,
02028 };
02029 
02037 enum PathRenameFlag
02038 {
02043     PathRenameFlag_None = 0,
02048     PathRenameFlag_NoReplace = 1,
02053     PathRenameFlag_Replace = 2,
02058     PathRenameFlag_NoSymlinks = 4,
02059 };
02060 
02068 enum ProcessCreateFlag
02069 {
02074     ProcessCreateFlag_None = 0,
02080     ProcessCreateFlag_WaitForProcessStartOnly = 1,
02085     ProcessCreateFlag_IgnoreOrphanedProcesses = 2,
02090     ProcessCreateFlag_Hidden = 4,
02095     ProcessCreateFlag_NoProfile = 8,
02100     ProcessCreateFlag_WaitForStdOut = 16,
02105     ProcessCreateFlag_WaitForStdErr = 32,
02110     ProcessCreateFlag_ExpandArguments = 64,
02111 };
02112 
02120 enum ProcessPriority
02121 {
02126     ProcessPriority_Invalid = 0,
02131     ProcessPriority_Default = 1,
02132 };
02133 
02141 enum SymlinkType
02142 {
02147     SymlinkType_Unknown = 0,
02152     SymlinkType_Directory = 1,
02157     SymlinkType_File = 2,
02158 };
02159 
02167 enum SymlinkReadFlag
02168 {
02173     SymlinkReadFlag_None = 0,
02178     SymlinkReadFlag_NoSymlinks = 1,
02179 };
02180 
02188 enum ProcessStatus
02189 {
02194     ProcessStatus_Undefined = 0,
02199     ProcessStatus_Starting = 10,
02204     ProcessStatus_Started = 100,
02209     ProcessStatus_Paused = 110,
02214     ProcessStatus_Terminating = 480,
02219     ProcessStatus_TerminatedNormally = 500,
02224     ProcessStatus_TerminatedSignal = 510,
02229     ProcessStatus_TerminatedAbnormally = 511,
02234     ProcessStatus_TimedOutKilled = 512,
02239     ProcessStatus_TimedOutAbnormally = 513,
02244     ProcessStatus_Down = 600,
02249     ProcessStatus_Error = 800,
02250 };
02251 
02259 enum FsObjType
02260 {
02265     FsObjType_Undefined = 0,
02270     FsObjType_FIFO = 1,
02275     FsObjType_DevChar = 10,
02280     FsObjType_DevBlock = 11,
02285     FsObjType_Directory = 50,
02290     FsObjType_File = 80,
02295     FsObjType_Symlink = 100,
02300     FsObjType_Socket = 200,
02305     FsObjType_Whiteout = 400,
02306 };
02307 
02315 enum DragAndDropAction
02316 {
02321     DragAndDropAction_Ignore = 0,
02326     DragAndDropAction_Copy = 1,
02331     DragAndDropAction_Move = 2,
02336     DragAndDropAction_Link = 3,
02337 };
02338 
02346 enum DirectoryOpenFlag
02347 {
02352     DirectoryOpenFlag_None = 0,
02357     DirectoryOpenFlag_NoSymlinks = 1,
02358 };
02359 
02367 enum GuestDirEntryType
02368 {
02373     GuestDirEntryType_Unknown = 0,
02378     GuestDirEntryType_Directory = 4,
02383     GuestDirEntryType_File = 10,
02388     GuestDirEntryType_Symlink = 12,
02389 };
02390 
02400 enum MediumState
02401 {
02409     MediumState_NotCreated = 0,
02418     MediumState_Created = 1,
02426     MediumState_LockedRead = 2,
02434     MediumState_LockedWrite = 3,
02444     MediumState_Inaccessible = 4,
02451     MediumState_Creating = 5,
02458     MediumState_Deleting = 6,
02459 };
02460 
02471 enum MediumType
02472 {
02480     MediumType_Normal = 0,
02488     MediumType_Immutable = 1,
02496     MediumType_Writethrough = 2,
02505     MediumType_Shareable = 3,
02514     MediumType_Readonly = 4,
02526     MediumType_MultiAttach = 5,
02527 };
02528 
02538 enum MediumVariant
02539 {
02546     MediumVariant_Standard = 0,
02553     MediumVariant_VmdkSplit2G = 0x01,
02560     MediumVariant_VmdkRawDisk = 0x02,
02568     MediumVariant_VmdkStreamOptimized = 0x04,
02575     MediumVariant_VmdkESX = 0x08,
02582     MediumVariant_Fixed = 0x10000,
02589     MediumVariant_Diff = 0x20000,
02597     MediumVariant_NoCreateDir = 0x40000000,
02598 };
02599 
02600 enum DataType
02601 {
02602     DataType_Int32 = 0,
02603     DataType_Int8 = 1,
02604     DataType_String = 2,
02605 };
02606 
02607 enum DataFlags
02608 {
02609     DataFlags_None = 0x00,
02610     DataFlags_Mandatory = 0x01,
02611     DataFlags_Expert = 0x02,
02612     DataFlags_Array = 0x04,
02613     DataFlags_FlagMask = 0x07,
02614 };
02615 
02623 enum MediumFormatCapabilities
02624 {
02631     MediumFormatCapabilities_Uuid = 0x01,
02638     MediumFormatCapabilities_CreateFixed = 0x02,
02646     MediumFormatCapabilities_CreateDynamic = 0x04,
02653     MediumFormatCapabilities_CreateSplit2G = 0x08,
02660     MediumFormatCapabilities_Differencing = 0x10,
02667     MediumFormatCapabilities_Asynchronous = 0x20,
02677     MediumFormatCapabilities_File = 0x40,
02686     MediumFormatCapabilities_Properties = 0x80,
02693     MediumFormatCapabilities_TcpNetworking = 0x100,
02700     MediumFormatCapabilities_VFS = 0x200,
02701     MediumFormatCapabilities_CapabilityMask = 0x3FF,
02702 };
02703 
02711 enum MouseButtonState
02712 {
02713     MouseButtonState_LeftButton = 0x01,
02714     MouseButtonState_RightButton = 0x02,
02715     MouseButtonState_MiddleButton = 0x04,
02716     MouseButtonState_WheelUp = 0x08,
02717     MouseButtonState_WheelDown = 0x10,
02718     MouseButtonState_XButton1 = 0x20,
02719     MouseButtonState_XButton2 = 0x40,
02720     MouseButtonState_MouseStateMask = 0x7F,
02721 };
02722 
02733 enum FramebufferPixelFormat
02734 {
02742     FramebufferPixelFormat_Opaque = 0,
02750     FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
02751 };
02752 
02760 enum NetworkAttachmentType
02761 {
02766     NetworkAttachmentType_Null = 0,
02767     NetworkAttachmentType_NAT = 1,
02768     NetworkAttachmentType_Bridged = 2,
02769     NetworkAttachmentType_Internal = 3,
02770     NetworkAttachmentType_HostOnly = 4,
02771     NetworkAttachmentType_Generic = 5,
02772 };
02773 
02781 enum NetworkAdapterType
02782 {
02787     NetworkAdapterType_Null = 0,
02792     NetworkAdapterType_Am79C970A = 1,
02797     NetworkAdapterType_Am79C973 = 2,
02802     NetworkAdapterType_I82540EM = 3,
02807     NetworkAdapterType_I82543GC = 4,
02812     NetworkAdapterType_I82545EM = 5,
02817     NetworkAdapterType_Virtio = 6,
02818 };
02819 
02827 enum NetworkAdapterPromiscModePolicy
02828 {
02833     NetworkAdapterPromiscModePolicy_Deny = 1,
02841     NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
02849     NetworkAdapterPromiscModePolicy_AllowAll = 3,
02850 };
02851 
02860 enum PortMode
02861 {
02866     PortMode_Disconnected = 0,
02871     PortMode_HostPipe = 1,
02876     PortMode_HostDevice = 2,
02881     PortMode_RawFile = 3,
02882 };
02883 
02922 enum USBDeviceState
02923 {
02930     USBDeviceState_NotSupported = 0,
02938     USBDeviceState_Unavailable = 1,
02945     USBDeviceState_Busy = 2,
02953     USBDeviceState_Available = 3,
02961     USBDeviceState_Held = 4,
02969     USBDeviceState_Captured = 5,
02970 };
02971 
02981 enum USBDeviceFilterAction
02982 {
02987     USBDeviceFilterAction_Null = 0,
02992     USBDeviceFilterAction_Ignore = 1,
02997     USBDeviceFilterAction_Hold = 2,
02998 };
02999 
03007 enum AudioDriverType
03008 {
03013     AudioDriverType_Null = 0,
03018     AudioDriverType_WinMM = 1,
03023     AudioDriverType_OSS = 2,
03028     AudioDriverType_ALSA = 3,
03033     AudioDriverType_DirectSound = 4,
03038     AudioDriverType_CoreAudio = 5,
03043     AudioDriverType_MMPM = 6,
03048     AudioDriverType_Pulse = 7,
03053     AudioDriverType_SolAudio = 8,
03054 };
03055 
03063 enum AudioControllerType
03064 {
03065     AudioControllerType_AC97 = 0,
03066     AudioControllerType_SB16 = 1,
03067     AudioControllerType_HDA = 2,
03068 };
03069 
03077 enum AuthType
03078 {
03083     AuthType_Null = 0,
03084     AuthType_External = 1,
03085     AuthType_Guest = 2,
03086 };
03087 
03096 enum StorageBus
03097 {
03102     StorageBus_Null = 0,
03103     StorageBus_IDE = 1,
03104     StorageBus_SATA = 2,
03105     StorageBus_SCSI = 3,
03106     StorageBus_Floppy = 4,
03107     StorageBus_SAS = 5,
03108 };
03109 
03118 enum StorageControllerType
03119 {
03124     StorageControllerType_Null = 0,
03129     StorageControllerType_LsiLogic = 1,
03134     StorageControllerType_BusLogic = 2,
03139     StorageControllerType_IntelAhci = 3,
03144     StorageControllerType_PIIX3 = 4,
03149     StorageControllerType_PIIX4 = 5,
03154     StorageControllerType_ICH6 = 6,
03159     StorageControllerType_I82078 = 7,
03164     StorageControllerType_LsiLogicSas = 8,
03165 };
03166 
03174 enum ChipsetType
03175 {
03180     ChipsetType_Null = 0,
03185     ChipsetType_PIIX3 = 1,
03190     ChipsetType_ICH9 = 2,
03191 };
03192 
03198 enum NATAliasMode
03199 {
03204     NATAliasMode_AliasLog = 0x1,
03209     NATAliasMode_AliasProxyOnly = 0x02,
03214     NATAliasMode_AliasUseSamePorts = 0x04,
03215 };
03216 
03222 enum NATProtocol
03223 {
03228     NATProtocol_UDP = 0,
03233     NATProtocol_TCP = 1,
03234 };
03235 
03243 enum BandwidthGroupType
03244 {
03251     BandwidthGroupType_Null = 0,
03258     BandwidthGroupType_Disk = 1,
03265     BandwidthGroupType_Network = 2,
03266 };
03267 
03276 enum VBoxEventType
03277 {
03284     VBoxEventType_Invalid = 0,
03293     VBoxEventType_Any = 1,
03301     VBoxEventType_Vetoable = 2,
03309     VBoxEventType_MachineEvent = 3,
03317     VBoxEventType_SnapshotEvent = 4,
03326     VBoxEventType_InputEvent = 5,
03333     VBoxEventType_LastWildcard = 31,
03340     VBoxEventType_OnMachineStateChanged = 32,
03347     VBoxEventType_OnMachineDataChanged = 33,
03354     VBoxEventType_OnExtraDataChanged = 34,
03361     VBoxEventType_OnExtraDataCanChange = 35,
03368     VBoxEventType_OnMediumRegistered = 36,
03375     VBoxEventType_OnMachineRegistered = 37,
03382     VBoxEventType_OnSessionStateChanged = 38,
03389     VBoxEventType_OnSnapshotTaken = 39,
03396     VBoxEventType_OnSnapshotDeleted = 40,
03403     VBoxEventType_OnSnapshotChanged = 41,
03410     VBoxEventType_OnGuestPropertyChanged = 42,
03417     VBoxEventType_OnMousePointerShapeChanged = 43,
03424     VBoxEventType_OnMouseCapabilityChanged = 44,
03431     VBoxEventType_OnKeyboardLedsChanged = 45,
03438     VBoxEventType_OnStateChanged = 46,
03445     VBoxEventType_OnAdditionsStateChanged = 47,
03452     VBoxEventType_OnNetworkAdapterChanged = 48,
03459     VBoxEventType_OnSerialPortChanged = 49,
03466     VBoxEventType_OnParallelPortChanged = 50,
03473     VBoxEventType_OnStorageControllerChanged = 51,
03480     VBoxEventType_OnMediumChanged = 52,
03487     VBoxEventType_OnVRDEServerChanged = 53,
03494     VBoxEventType_OnUSBControllerChanged = 54,
03501     VBoxEventType_OnUSBDeviceStateChanged = 55,
03508     VBoxEventType_OnSharedFolderChanged = 56,
03515     VBoxEventType_OnRuntimeError = 57,
03522     VBoxEventType_OnCanShowWindow = 58,
03529     VBoxEventType_OnShowWindow = 59,
03536     VBoxEventType_OnCPUChanged = 60,
03543     VBoxEventType_OnVRDEServerInfoChanged = 61,
03550     VBoxEventType_OnEventSourceChanged = 62,
03557     VBoxEventType_OnCPUExecutionCapChanged = 63,
03564     VBoxEventType_OnGuestKeyboard = 64,
03571     VBoxEventType_OnGuestMouse = 65,
03578     VBoxEventType_OnNATRedirect = 66,
03585     VBoxEventType_OnHostPCIDevicePlug = 67,
03592     VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
03599     VBoxEventType_OnBandwidthGroupChanged = 69,
03606     VBoxEventType_OnGuestMonitorChanged = 70,
03613     VBoxEventType_OnStorageDeviceChanged = 71,
03620     VBoxEventType_OnClipboardModeChanged = 72,
03627     VBoxEventType_OnDragAndDropModeChanged = 73,
03634     VBoxEventType_Last = 74,
03635 };
03636 
03644 enum GuestMonitorChangedEventType
03645 {
03652     GuestMonitorChangedEventType_Enabled = 0,
03659     GuestMonitorChangedEventType_Disabled = 1,
03666     GuestMonitorChangedEventType_NewOrigin = 2,
03667 };
03668 
03702 interface IVirtualBoxErrorInfo : $errorinfo
03703 {
03721     readonly attribute long resultCode;
03722 
03734     readonly attribute wstringUUID interfaceID;
03735 
03746     readonly attribute wstring component;
03747 
03758     readonly attribute wstring text;
03759 
03770     readonly attribute IVirtualBoxErrorInfo next;
03771 
03772 }; /* interface IVirtualBoxErrorInfo */
03773 
03784 interface IDHCPServer : $unknown
03785 {
03791     attribute boolean enabled;
03792 
03798     readonly attribute wstring IPAddress;
03799 
03805     readonly attribute wstring networkMask;
03806 
03812     readonly attribute wstring networkName;
03813 
03819     readonly attribute wstring lowerIP;
03820 
03826     readonly attribute wstring upperIP;
03827 
03856     void setConfiguration (
03857         in wstring IPAddress,
03858         in wstring networkMask,
03859         in wstring FromIPAddress,
03860         in wstring ToIPAddress
03861     );
03862 
03887     void start (
03888         in wstring networkName,
03889         in wstring trunkName,
03890         in wstring trunkType
03891     );
03892 
03905     void stop();
03906 
03907 }; /* interface IDHCPServer */
03908 
03927 interface IVirtualBox : $unknown
03928 {
03941     readonly attribute wstring version;
03942 
03950     readonly attribute wstring versionNormalized;
03951 
03957     readonly attribute unsigned long revision;
03958 
03968     readonly attribute wstring packageType;
03969 
03981     readonly attribute wstring APIVersion;
03982 
03998     readonly attribute wstring homeFolder;
03999 
04007     readonly attribute wstring settingsFilePath;
04008 
04012     readonly attribute IHost host;
04013 
04017     readonly attribute ISystemProperties systemProperties;
04018 
04024     readonly attribute IMachine[] machines;
04025 
04035     readonly attribute wstring[] machineGroups;
04036 
04046     readonly attribute IMedium[] hardDisks;
04047 
04053     readonly attribute IMedium[] DVDImages;
04054 
04060     readonly attribute IMedium[] floppyImages;
04061 
04062     readonly attribute IProgress[] progressOperations;
04063 
04064     readonly attribute IGuestOSType[] guestOSTypes;
04065 
04082     readonly attribute ISharedFolder[] sharedFolders;
04083 
04089     readonly attribute IPerformanceCollector performanceCollector;
04090 
04096     readonly attribute IDHCPServer[] DHCPServers;
04097 
04103     readonly attribute IEventSource eventSource;
04104 
04110     readonly attribute IExtPackManager extensionPackManager;
04111 
04117     readonly attribute wstring[] internalNetworks;
04118 
04124     readonly attribute wstring[] genericNetworkDrivers;
04125 
04174     void composeMachineFilename (
04175         in wstring name,
04176         in wstring group,
04177         in wstring baseFolder,
04178         [retval] out wstring file
04179     );
04180 
04283     void createMachine (
04284         in wstring settingsFile,
04285         in wstring name,
04286         in wstring[] groups,
04287         in wstring osTypeId,
04288         in wstringUUID id,
04289         in boolean forceOverwrite,
04290         [retval] out IMachine machine
04291     );
04292 
04318     void openMachine (
04319         in wstring settingsFile,
04320         [retval] out IMachine machine
04321     );
04322 
04354     void registerMachine (
04355         in IMachine machine
04356     );
04357 
04378     void findMachine (
04379         in wstring nameOrId,
04380         [retval] out IMachine machine
04381     );
04382 
04394     void getMachinesByGroups (
04395         in wstring[] groups,
04396         [retval] out IMachine[] machines
04397     );
04398 
04408     void getMachineStates (
04409         in IMachine[] machines,
04410         [retval] out MachineState[] states
04411     );
04412 
04422     void createAppliance (
04423         [retval] out IAppliance appliance
04424     );
04425 
04488     void createHardDisk (
04489         in wstring format,
04490         in wstring location,
04491         [retval] out IMedium medium
04492     );
04493 
04599     void openMedium (
04600         in wstring location,
04601         in DeviceType deviceType,
04602         in AccessMode accessMode,
04603         in boolean forceNewUuid,
04604         [retval] out IMedium medium
04605     );
04606 
04635     void getGuestOSType (
04636         in wstringUUID id,
04637         [retval] out IGuestOSType type
04638     );
04639 
04662     void createSharedFolder (
04663         in wstring name,
04664         in wstring hostPath,
04665         in boolean writable,
04666         in boolean automount
04667     );
04668 
04683     void removeSharedFolder (
04684         in wstring name
04685     );
04686 
04695     void getExtraDataKeys (
04696         [retval] out wstring[] value
04697     );
04698 
04727     void getExtraData (
04728         in wstring key,
04729         [retval] out wstring value
04730     );
04731 
04781     void setExtraData (
04782         in wstring key,
04783         in wstring value
04784     );
04785 
04804     void setSettingsSecret (
04805         in wstring password
04806     );
04807 
04824     void createDHCPServer (
04825         in wstring name,
04826         [retval] out IDHCPServer server
04827     );
04828 
04845     void findDHCPServerByNetworkName (
04846         in wstring name,
04847         [retval] out IDHCPServer server
04848     );
04849 
04864     void removeDHCPServer (
04865         in IDHCPServer server
04866     );
04867 
04892     void checkFirmwarePresent (
04893         in FirmwareType firmwareType,
04894         in wstring version,
04895         out wstring url,
04896         out wstring file,
04897         [retval] out boolean result
04898     );
04899 
04900 }; /* interface IVirtualBox */
04901 
04912 interface IVFSExplorer : $unknown
04913 {
04917     readonly attribute wstring path;
04918 
04922     readonly attribute VFSType type;
04923 
04931     void update (
04932         [retval] out IProgress aProgress
04933     );
04934 
04942     void cd (
04943         in wstring aDir,
04944         [retval] out IProgress aProgress
04945     );
04946 
04952     void cdUp (
04953         [retval] out IProgress aProgress
04954     );
04955 
04968     void entryList (
04969         out wstring[] aNames,
04970         out unsigned long[] aTypes,
04971         out unsigned long[] aSizes,
04972         out unsigned long[] aModes
04973     );
04974 
04983     void exists (
04984         in wstring[] aNames,
04985         [retval] out wstring[] aExists
04986     );
04987 
04995     void remove (
04996         in wstring[] aNames,
04997         [retval] out IProgress aProgress
04998     );
04999 
05000 }; /* interface IVFSExplorer */
05001 
05067 interface IAppliance : $unknown
05068 {
05076     readonly attribute wstring path;
05077 
05108     readonly attribute wstring[] disks;
05109 
05117     readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
05118 
05126     readonly attribute wstring[] machines;
05127 
05144     void read (
05145         in wstring file,
05146         [retval] out IProgress aProgress
05147     );
05148 
05165     void interpret();
05166 
05189     void importMachines (
05190         in ImportOptions[] options,
05191         [retval] out IProgress aProgress
05192     );
05193 
05201     void createVFSExplorer (
05202         in wstring aUri,
05203         [retval] out IVFSExplorer aExplorer
05204     );
05205 
05235     void write (
05236         in wstring format,
05237         in boolean manifest,
05238         in wstring path,
05239         [retval] out IProgress progress
05240     );
05241 
05247     void getWarnings (
05248         [retval] out wstring[] aWarnings
05249     );
05250 
05251 }; /* interface IAppliance */
05252 
05264 interface IVirtualSystemDescription : $unknown
05265 {
05269     readonly attribute unsigned long count;
05270 
05394     void getDescription (
05395         out VirtualSystemDescriptionType[] aTypes,
05396         out wstring[] aRefs,
05397         out wstring[] aOvfValues,
05398         out wstring[] aVBoxValues,
05399         out wstring[] aExtraConfigValues
05400     );
05401 
05418     void getDescriptionByType (
05419         in VirtualSystemDescriptionType aType,
05420         out VirtualSystemDescriptionType[] aTypes,
05421         out wstring[] aRefs,
05422         out wstring[] aOvfValues,
05423         out wstring[] aVBoxValues,
05424         out wstring[] aExtraConfigValues
05425     );
05426 
05438     void getValuesByType (
05439         in VirtualSystemDescriptionType aType,
05440         in VirtualSystemDescriptionValueType aWhich,
05441         [retval] out wstring[] aValues
05442     );
05443 
05469     void setFinalValues (
05470         in boolean[] aEnabled,
05471         in wstring[] aVBoxValues,
05472         in wstring[] aExtraConfigValues
05473     );
05474 
05489     void addDescription (
05490         in VirtualSystemDescriptionType aType,
05491         in wstring aVBoxValue,
05492         in wstring aExtraConfigValue
05493     );
05494 
05495 }; /* interface IVirtualSystemDescription */
05496 
05497 interface IInternalMachineControl : $unknown
05498 {
05505     void setRemoveSavedStateFile (
05506         in boolean aRemove
05507     );
05508 
05520     void updateState (
05521         in MachineState state
05522     );
05523 
05524     void getIPCId (
05525         [retval] out wstring id
05526     );
05527 
05539     void beginPowerUp (
05540         in IProgress aProgress
05541     );
05542 
05552     void endPowerUp (
05553         in long result
05554     );
05555 
05567     void beginPoweringDown (
05568         out IProgress progress
05569     );
05570 
05600     void endPoweringDown (
05601         in long result,
05602         in wstring errMsg
05603     );
05604 
05618     void runUSBDeviceFilters (
05619         in IUSBDevice device,
05620         out boolean matched,
05621         out unsigned long maskedInterfaces
05622     );
05623 
05632     void captureUSBDevice (
05633         in wstringUUID id
05634     );
05635 
05651     void detachUSBDevice (
05652         in wstringUUID id,
05653         in boolean done
05654     );
05655 
05664     void autoCaptureUSBDevices();
05665 
05681     void detachAllUSBDevices (
05682         in boolean done
05683     );
05684 
05699     void onSessionEnd (
05700         in ISession session,
05701         [retval] out IProgress progress
05702     );
05703 
05719     void beginSavingState (
05720         out IProgress progress,
05721         out wstring stateFilePath
05722     );
05723 
05753     void endSavingState (
05754         in long result,
05755         in wstring errMsg
05756     );
05757 
05772     void adoptSavedState (
05773         in wstring savedStateFile
05774     );
05775 
05824     void beginTakingSnapshot (
05825         in IConsole initiator,
05826         in wstring name,
05827         in wstring description,
05828         in IProgress consoleProgress,
05829         in boolean fTakingSnapshotOnline,
05830         out wstring stateFilePath
05831     );
05832 
05842     void endTakingSnapshot (
05843         in boolean success
05844     );
05845 
05874     void deleteSnapshot (
05875         in IConsole initiator,
05876         in wstringUUID startId,
05877         in wstringUUID endId,
05878         in boolean deleteAllChildren,
05879         out MachineState machineState,
05880         [retval] out IProgress progress
05881     );
05882 
05901     void finishOnlineMergeMedium (
05902         in IMediumAttachment mediumAttachment,
05903         in IMedium source,
05904         in IMedium target,
05905         in boolean mergeForward,
05906         in IMedium parentForTarget,
05907         in IMedium[] childrenToReparent
05908     );
05909 
05923     void restoreSnapshot (
05924         in IConsole initiator,
05925         in ISnapshot snapshot,
05926         out MachineState machineState,
05927         [retval] out IProgress progress
05928     );
05929 
05956     void pullGuestProperties (
05957         out wstring[] name,
05958         out wstring[] value,
05959         out long long[] timestamp,
05960         out wstring[] flags
05961     );
05962 
05984     void pushGuestProperty (
05985         in wstring name,
05986         in wstring value,
05987         in long long timestamp,
05988         in wstring flags
05989     );
05990 
06002     void lockMedia();
06003 
06013     void unlockMedia();
06014 
06030     void ejectMedium (
06031         in IMediumAttachment attachment,
06032         [retval] out IMediumAttachment newAttachment
06033     );
06034 
06071     void reportGuestStatistics (
06072         in unsigned long validStats,
06073         in unsigned long cpuUser,
06074         in unsigned long cpuKernel,
06075         in unsigned long cpuIdle,
06076         in unsigned long memTotal,
06077         in unsigned long memFree,
06078         in unsigned long memBalloon,
06079         in unsigned long memShared,
06080         in unsigned long memCache,
06081         in unsigned long pagedTotal,
06082         in unsigned long memAllocTotal,
06083         in unsigned long memFreeTotal,
06084         in unsigned long memBalloonTotal,
06085         in unsigned long memSharedTotal
06086     );
06087 
06088 }; /* interface IInternalMachineControl */
06089 
06098 interface IBIOSSettings : $unknown
06099 {
06103     attribute boolean logoFadeIn;
06104 
06108     attribute boolean logoFadeOut;
06109 
06113     attribute unsigned long logoDisplayTime;
06114 
06121     attribute wstring logoImagePath;
06122 
06126     attribute BIOSBootMenuMode bootMenuMode;
06127 
06131     attribute boolean ACPIEnabled;
06132 
06139     attribute boolean IOAPICEnabled;
06140 
06150     attribute long long timeOffset;
06151 
06158     attribute boolean PXEDebugEnabled;
06159 
06160 }; /* interface IBIOSSettings */
06161 
06169 interface IPCIAddress : $unknown
06170 {
06176     attribute short bus;
06177 
06183     attribute short device;
06184 
06190     attribute short devFunction;
06191 
06197     void asLong (
06198         [retval] out long result
06199     );
06200 
06206     void fromLong (
06207         in long number
06208     );
06209 
06210 }; /* interface IPCIAddress */
06211 
06219 interface IPCIDeviceAttachment : $unknown
06220 {
06226     readonly attribute wstring name;
06227 
06233     readonly attribute boolean isPhysicalDevice;
06234 
06240     readonly attribute long hostAddress;
06241 
06247     readonly attribute long guestAddress;
06248 
06249 }; /* interface IPCIDeviceAttachment */
06250 
06291 interface IMachine : $unknown
06292 {
06296     readonly attribute IVirtualBox parent;
06297 
06347     readonly attribute boolean accessible;
06348 
06360     readonly attribute IVirtualBoxErrorInfo accessError;
06361 
06401     attribute wstring name;
06402 
06413     attribute wstring description;
06414 
06418     readonly attribute wstringUUID id;
06419 
06430     attribute wstring[] groups;
06431 
06446     attribute wstring OSTypeId;
06447 
06451     attribute wstring hardwareVersion;
06452 
06462     attribute wstringUUID hardwareUUID;
06463 
06467     attribute unsigned long CPUCount;
06468 
06474     attribute boolean CPUHotPlugEnabled;
06475 
06483     attribute unsigned long CPUExecutionCap;
06484 
06488     attribute unsigned long memorySize;
06489 
06493     attribute unsigned long memoryBalloonSize;
06494 
06501     attribute boolean pageFusionEnabled;
06502 
06506     attribute unsigned long VRAMSize;
06507 
06513     attribute boolean accelerate3DEnabled;
06514 
06520     attribute boolean accelerate2DVideoEnabled;
06521 
06532     attribute unsigned long monitorCount;
06533 
06537     readonly attribute IBIOSSettings BIOSSettings;
06538 
06543     attribute FirmwareType firmwareType;
06544 
06550     attribute PointingHIDType pointingHIDType;
06551 
06557     attribute KeyboardHIDType keyboardHIDType;
06558 
06565     attribute boolean HPETEnabled;
06566 
06570     attribute ChipsetType chipsetType;
06571 
06605     attribute wstring snapshotFolder;
06606 
06610     readonly attribute IVRDEServer VRDEServer;
06611 
06612     attribute boolean emulatedUSBWebcameraEnabled;
06613 
06614     attribute boolean emulatedUSBCardReaderEnabled;
06615 
06619     readonly attribute IMediumAttachment[] mediumAttachments;
06620 
06632     readonly attribute IUSBController USBController;
06633 
06637     readonly attribute IAudioAdapter audioAdapter;
06638 
06642     readonly attribute IStorageController[] storageControllers;
06643 
06649     readonly attribute wstring settingsFilePath;
06650 
06675     readonly attribute boolean settingsModified;
06676 
06680     readonly attribute SessionState sessionState;
06681 
06694     readonly attribute wstring sessionType;
06695 
06705     readonly attribute unsigned long sessionPID;
06706 
06710     readonly attribute MachineState state;
06711 
06718     readonly attribute long long lastStateChange;
06719 
06731     readonly attribute wstring stateFilePath;
06732 
06742     readonly attribute wstring logFolder;
06743 
06754     readonly attribute ISnapshot currentSnapshot;
06755 
06762     readonly attribute unsigned long snapshotCount;
06763 
06795     readonly attribute boolean currentStateModified;
06796 
06808     readonly attribute ISharedFolder[] sharedFolders;
06809 
06816     attribute ClipboardMode clipboardMode;
06817 
06823     attribute DragAndDropMode dragAndDropMode;
06824 
06832     attribute wstring guestPropertyNotificationPatterns;
06833 
06842     attribute boolean teleporterEnabled;
06843 
06854     attribute unsigned long teleporterPort;
06855 
06862     attribute wstring teleporterAddress;
06863 
06874     attribute wstring teleporterPassword;
06875 
06883     attribute FaultToleranceState faultToleranceState;
06884 
06891     attribute unsigned long faultTolerancePort;
06892 
06898     attribute wstring faultToleranceAddress;
06899 
06907     attribute wstring faultTolerancePassword;
06908 
06914     attribute unsigned long faultToleranceSyncInterval;
06915 
06923     attribute boolean RTCUseUTC;
06924 
06931     attribute boolean IOCacheEnabled;
06932 
06938     attribute unsigned long IOCacheSize;
06939 
06949     readonly attribute IPCIDeviceAttachment[] PCIDeviceAssignments;
06950 
06956     readonly attribute IBandwidthControl bandwidthControl;
06957 
06966     attribute boolean tracingEnabled;
06967 
06982     attribute wstring tracingConfig;
06983 
06996     attribute boolean allowTracingToAccessVM;
06997 
07003     attribute boolean autostartEnabled;
07004 
07010     attribute unsigned long autostartDelay;
07011 
07017     attribute AutostopType autostopType;
07018 
07124     void lockMachine (
07125         in ISession session,
07126         in LockType lockType
07127     );
07128 
07258     void launchVMProcess (
07259         in ISession session,
07260         in wstring type,
07261         in wstring environment,
07262         [retval] out IProgress progress
07263     );
07264 
07302     void setBootOrder (
07303         in unsigned long position,
07304         in DeviceType device
07305     );
07306 
07341     void getBootOrder (
07342         in unsigned long position,
07343         [retval] out DeviceType device
07344     );
07345 
07447     void attachDevice (
07448         in wstring name,
07449         in long controllerPort,
07450         in long device,
07451         in DeviceType type,
07452         in IMedium medium
07453     );
07454 
07550     void attachDeviceWithoutMedium (
07551         in wstring name,
07552         in long controllerPort,
07553         in long device,
07554         in DeviceType type
07555     );
07556 
07610     void detachDevice (
07611         in wstring name,
07612         in long controllerPort,
07613         in long device
07614     );
07615 
07658     void passthroughDevice (
07659         in wstring name,
07660         in long controllerPort,
07661         in long device,
07662         in boolean passthrough
07663     );
07664 
07707     void temporaryEjectDevice (
07708         in wstring name,
07709         in long controllerPort,
07710         in long device,
07711         in boolean temporaryEject
07712     );
07713 
07759     void nonRotationalDevice (
07760         in wstring name,
07761         in long controllerPort,
07762         in long device,
07763         in boolean nonRotational
07764     );
07765 
07811     void setAutoDiscardForDevice (
07812         in wstring name,
07813         in long controllerPort,
07814         in long device,
07815         in boolean discard
07816     );
07817 
07858     void setBandwidthGroupForDevice (
07859         in wstring name,
07860         in long controllerPort,
07861         in long device,
07862         in IBandwidthGroup bandwidthGroup
07863     );
07864 
07901     void setNoBandwidthGroupForDevice (
07902         in wstring name,
07903         in long controllerPort,
07904         in long device
07905     );
07906 
07971     void unmountMedium (
07972         in wstring name,
07973         in long controllerPort,
07974         in long device,
07975         in boolean force
07976     );
07977 
08040     void mountMedium (
08041         in wstring name,
08042         in long controllerPort,
08043         in long device,
08044         in IMedium medium,
08045         in boolean force
08046     );
08047 
08076     void getMedium (
08077         in wstring name,
08078         in long controllerPort,
08079         in long device,
08080         [retval] out IMedium medium
08081     );
08082 
08097     void getMediumAttachmentsOfController (
08098         in wstring name,
08099         [retval] out IMediumAttachment[] mediumAttachments
08100     );
08101 
08116     void getMediumAttachment (
08117         in wstring name,
08118         in long controllerPort,
08119         in long device,
08120         [retval] out IMediumAttachment attachment
08121     );
08122 
08163     void attachHostPCIDevice (
08164         in long hostAddress,
08165         in long desiredGuestAddress,
08166         in boolean tryToUnbind
08167     );
08168 
08209     void detachHostPCIDevice (
08210         in long hostAddress
08211     );
08212 
08230     void getNetworkAdapter (
08231         in unsigned long slot,
08232         [retval] out INetworkAdapter adapter
08233     );
08234 
08267     void addStorageController (
08268         in wstring name,
08269         in StorageBus connectionType,
08270         [retval] out IStorageController controller
08271     );
08272 
08286     void getStorageControllerByName (
08287         in wstring name,
08288         [retval] out IStorageController storageController
08289     );
08290 
08304     void getStorageControllerByInstance (
08305         in unsigned long instance,
08306         [retval] out IStorageController storageController
08307     );
08308 
08331     void removeStorageController (
08332         in wstring name
08333     );
08334 
08356     void setStorageControllerBootable (
08357         in wstring name,
08358         in boolean bootable
08359     );
08360 
08378     void getSerialPort (
08379         in unsigned long slot,
08380         [retval] out ISerialPort port
08381     );
08382 
08400     void getParallelPort (
08401         in unsigned long slot,
08402         [retval] out IParallelPort port
08403     );
08404 
08413     void getExtraDataKeys (
08414         [retval] out wstring[] value
08415     );
08416 
08445     void getExtraData (
08446         in wstring key,
08447         [retval] out wstring value
08448     );
08449 
08499     void setExtraData (
08500         in wstring key,
08501         in wstring value
08502     );
08503 
08525     void getCPUProperty (
08526         in CPUPropertyType property,
08527         [retval] out boolean value
08528     );
08529 
08551     void setCPUProperty (
08552         in CPUPropertyType property,
08553         in boolean value
08554     );
08555 
08595     void getCPUIDLeaf (
08596         in unsigned long id,
08597         out unsigned long valEax,
08598         out unsigned long valEbx,
08599         out unsigned long valEcx,
08600         out unsigned long valEdx
08601     );
08602 
08646     void setCPUIDLeaf (
08647         in unsigned long id,
08648         in unsigned long valEax,
08649         in unsigned long valEbx,
08650         in unsigned long valEcx,
08651         in unsigned long valEdx
08652     );
08653 
08671     void removeCPUIDLeaf (
08672         in unsigned long id
08673     );
08674 
08680     void removeAllCPUIDLeaves();
08681 
08703     void getHWVirtExProperty (
08704         in HWVirtExPropertyType property,
08705         [retval] out boolean value
08706     );
08707 
08729     void setHWVirtExProperty (
08730         in HWVirtExPropertyType property,
08731         in boolean value
08732     );
08733 
08779     void saveSettings();
08780 
08804     void discardSettings();
08805 
08889     void unregister (
08890         in CleanupMode cleanupMode,
08891         [retval] out IMedium[] aMedia
08892     );
08893 
08950     void delete (
08951         in IMedium[] aMedia,
08952         [retval] out IProgress aProgress
08953     );
08954 
08966     void export (
08967         in IAppliance aAppliance,
08968         in wstring location,
08969         [retval] out IVirtualSystemDescription aDescription
08970     );
08971 
08995     void findSnapshot (
08996         in wstring nameOrId,
08997         [retval] out ISnapshot snapshot
08998     );
08999 
09033     void createSharedFolder (
09034         in wstring name,
09035         in wstring hostPath,
09036         in boolean writable,
09037         in boolean automount
09038     );
09039 
09065     void removeSharedFolder (
09066         in wstring name
09067     );
09068 
09092     void canShowConsoleWindow (
09093         [retval] out boolean canShow
09094     );
09095 
09130     void showConsoleWindow (
09131         [retval] out long long winId
09132     );
09133 
09166     void getGuestProperty (
09167         in wstring name,
09168         out wstring value,
09169         out long long timestamp,
09170         out wstring flags
09171     );
09172 
09195     void getGuestPropertyValue (
09196         in wstring property,
09197         [retval] out wstring value
09198     );
09199 
09222     void getGuestPropertyTimestamp (
09223         in wstring property,
09224         [retval] out long long value
09225     );
09226 
09277     void setGuestProperty (
09278         in wstring property,
09279         in wstring value,
09280         in wstring flags
09281     );
09282 
09323     void setGuestPropertyValue (
09324         in wstring property,
09325         in wstring value
09326     );
09327 
09345     void deleteGuestProperty (
09346         in wstring name
09347     );
09348 
09379     void enumerateGuestProperties (
09380         in wstring patterns,
09381         out wstring[] name,
09382         out wstring[] value,
09383         out long long[] timestamp,
09384         out wstring[] flags
09385     );
09386 
09416     void querySavedGuestScreenInfo (
09417         in unsigned long screenId,
09418         out unsigned long originX,
09419         out unsigned long originY,
09420         out unsigned long width,
09421         out unsigned long height,
09422         out boolean enabled
09423     );
09424 
09446     void querySavedThumbnailSize (
09447         in unsigned long screenId,
09448         out unsigned long size,
09449         out unsigned long width,
09450         out unsigned long height
09451     );
09452 
09479     void readSavedThumbnailToArray (
09480         in unsigned long screenId,
09481         in boolean BGR,
09482         out unsigned long width,
09483         out unsigned long height,
09484         [retval] out octet[] data
09485     );
09486 
09508     void readSavedThumbnailPNGToArray (
09509         in unsigned long screenId,
09510         out unsigned long width,
09511         out unsigned long height,
09512         [retval] out octet[] data
09513     );
09514 
09536     void querySavedScreenshotPNGSize (
09537         in unsigned long screenId,
09538         out unsigned long size,
09539         out unsigned long width,
09540         out unsigned long height
09541     );
09542 
09564     void readSavedScreenshotPNGToArray (
09565         in unsigned long screenId,
09566         out unsigned long width,
09567         out unsigned long height,
09568         [retval] out octet[] data
09569     );
09570 
09580     void hotPlugCPU (
09581         in unsigned long cpu
09582     );
09583 
09593     void hotUnplugCPU (
09594         in unsigned long cpu
09595     );
09596 
09610     void getCPUStatus (
09611         in unsigned long cpu,
09612         [retval] out boolean attached
09613     );
09614 
09629     void queryLogFilename (
09630         in unsigned long idx,
09631         [retval] out wstring filename
09632     );
09633 
09659     void readLog (
09660         in unsigned long idx,
09661         in long long offset,
09662         in long long size,
09663         [retval] out octet[] data
09664     );
09665 
09698     void cloneTo (
09699         in IMachine target,
09700         in CloneMode mode,
09701         in CloneOptions[] options,
09702         [retval] out IProgress progress
09703     );
09704 
09705 }; /* interface IMachine */
09706 
09715 interface IVRDEServerInfo : $unknown
09716 {
09722     readonly attribute boolean active;
09723 
09732     readonly attribute long port;
09733 
09739     readonly attribute unsigned long numberOfClients;
09740 
09746     readonly attribute long long beginTime;
09747 
09754     readonly attribute long long endTime;
09755 
09761     readonly attribute long long bytesSent;
09762 
09768     readonly attribute long long bytesSentTotal;
09769 
09775     readonly attribute long long bytesReceived;
09776 
09782     readonly attribute long long bytesReceivedTotal;
09783 
09789     readonly attribute wstring user;
09790 
09796     readonly attribute wstring domain;
09797 
09803     readonly attribute wstring clientName;
09804 
09810     readonly attribute wstring clientIP;
09811 
09817     readonly attribute unsigned long clientVersion;
09818 
09826     readonly attribute unsigned long encryptionStyle;
09827 
09828 }; /* interface IVRDEServerInfo */
09829 
09851 interface IConsole : $unknown
09852 {
09864     readonly attribute IMachine machine;
09865 
09879     readonly attribute MachineState state;
09880 
09884     readonly attribute IGuest guest;
09885 
09896     readonly attribute IKeyboard keyboard;
09897 
09908     readonly attribute IMouse mouse;
09909 
09919     readonly attribute IDisplay display;
09920 
09924     readonly attribute IMachineDebugger debugger;
09925 
09936     readonly attribute IUSBDevice[] USBDevices;
09937 
09945     readonly attribute IHostUSBDevice[] remoteUSBDevices;
09946 
09962     readonly attribute ISharedFolder[] sharedFolders;
09963 
09969     readonly attribute IVRDEServerInfo VRDEServerInfo;
09970 
09976     readonly attribute IEventSource eventSource;
09977 
09981     readonly attribute IPCIDeviceAttachment[] attachedPCIDevices;
09982 
09991     attribute boolean useHostClipboard;
09992 
10057     void powerUp (
10058         [retval] out IProgress progress
10059     );
10060 
10094     void powerUpPaused (
10095         [retval] out IProgress progress
10096     );
10097 
10117     void powerDown (
10118         [retval] out IProgress progress
10119     );
10120 
10140     void reset();
10141 
10161     void pause();
10162 
10182     void resume();
10183 
10203     void powerButton();
10204 
10224     void sleepButton();
10225 
10237     void getPowerButtonHandled (
10238         [retval] out boolean handled
10239     );
10240 
10254     void getGuestEnteredACPIMode (
10255         [retval] out boolean entered
10256     );
10257 
10310     void saveState (
10311         [retval] out IProgress progress
10312     );
10313 
10346     void adoptSavedState (
10347         in wstring savedStateFile
10348     );
10349 
10380     void discardSavedState (
10381         in boolean fRemoveFile
10382     );
10383 
10396     void getDeviceActivity (
10397         in DeviceType type,
10398         [retval] out DeviceActivity activity
10399     );
10400 
10438     void attachUSBDevice (
10439         in wstringUUID id
10440     );
10441 
10476     void detachUSBDevice (
10477         in wstringUUID id,
10478         [retval] out IUSBDevice device
10479     );
10480 
10503     void findUSBDeviceByAddress (
10504         in wstring name,
10505         [retval] out IUSBDevice device
10506     );
10507 
10527     void findUSBDeviceById (
10528         in wstringUUID id,
10529         [retval] out IUSBDevice device
10530     );
10531 
10565     void createSharedFolder (
10566         in wstring name,
10567         in wstring hostPath,
10568         in boolean writable,
10569         in boolean automount
10570     );
10571 
10596     void removeSharedFolder (
10597         in wstring name
10598     );
10599 
10637     void takeSnapshot (
10638         in wstring name,
10639         in wstring description,
10640         [retval] out IProgress progress
10641     );
10642 
10715     void deleteSnapshot (
10716         in wstringUUID id,
10717         [retval] out IProgress progress
10718     );
10719 
10759     void deleteSnapshotAndAllChildren (
10760         in wstringUUID id,
10761         [retval] out IProgress progress
10762     );
10763 
10807     void deleteSnapshotRange (
10808         in wstringUUID startId,
10809         in wstringUUID endId,
10810         [retval] out IProgress progress
10811     );
10812 
10853     void restoreSnapshot (
10854         in ISnapshot snapshot,
10855         [retval] out IProgress progress
10856     );
10857 
10896     void teleport (
10897         in wstring hostname,
10898         in unsigned long tcpport,
10899         in wstring password,
10900         in unsigned long maxDowntime,
10901         [retval] out IProgress progress
10902     );
10903 
10904 }; /* interface IConsole */
10905 
10916 interface IHostNetworkInterface : $unknown
10917 {
10921     readonly attribute wstring name;
10922 
10926     readonly attribute wstringUUID id;
10927 
10931     readonly attribute wstring networkName;
10932 
10936     readonly attribute boolean DHCPEnabled;
10937 
10941     readonly attribute wstring IPAddress;
10942 
10946     readonly attribute wstring networkMask;
10947 
10951     readonly attribute boolean IPV6Supported;
10952 
10956     readonly attribute wstring IPV6Address;
10957 
10961     readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
10962 
10966     readonly attribute wstring hardwareAddress;
10967 
10971     readonly attribute HostNetworkInterfaceMediumType mediumType;
10972 
10976     readonly attribute HostNetworkInterfaceStatus status;
10977 
10981     readonly attribute HostNetworkInterfaceType interfaceType;
10982 
10994     void enableStaticIPConfig (
10995         in wstring IPAddress,
10996         in wstring networkMask
10997     );
10998 
11010     void enableStaticIPConfigV6 (
11011         in wstring IPV6Address,
11012         in unsigned long IPV6NetworkMaskPrefixLength
11013     );
11014 
11018     void enableDynamicIPConfig();
11019 
11023     void DHCPRediscover();
11024 
11025 }; /* interface IHostNetworkInterface */
11026 
11043 interface IHost : $unknown
11044 {
11048     readonly attribute IMedium[] DVDDrives;
11049 
11053     readonly attribute IMedium[] floppyDrives;
11054 
11068     readonly attribute IHostUSBDevice[] USBDevices;
11069 
11093     readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
11094 
11098     readonly attribute IHostNetworkInterface[] networkInterfaces;
11099 
11103     readonly attribute unsigned long processorCount;
11104 
11108     readonly attribute unsigned long processorOnlineCount;
11109 
11113     readonly attribute unsigned long processorCoreCount;
11114 
11118     readonly attribute unsigned long memorySize;
11119 
11123     readonly attribute unsigned long memoryAvailable;
11124 
11128     readonly attribute wstring operatingSystem;
11129 
11133     readonly attribute wstring OSVersion;
11134 
11138     readonly attribute long long UTCTime;
11139 
11143     readonly attribute boolean acceleration3DAvailable;
11144 
11159     void getProcessorSpeed (
11160         in unsigned long cpuId,
11161         [retval] out unsigned long speed
11162     );
11163 
11175     void getProcessorFeature (
11176         in ProcessorFeature feature,
11177         [retval] out boolean supported
11178     );
11179 
11198     void getProcessorDescription (
11199         in unsigned long cpuId,
11200         [retval] out wstring description
11201     );
11202 
11243     void getProcessorCPUIDLeaf (
11244         in unsigned long cpuId,
11245         in unsigned long leaf,
11246         in unsigned long subLeaf,
11247         out unsigned long valEax,
11248         out unsigned long valEbx,
11249         out unsigned long valEcx,
11250         out unsigned long valEdx
11251     );
11252 
11273     void createHostOnlyNetworkInterface (
11274         out IHostNetworkInterface hostInterface,
11275         [retval] out IProgress progress
11276     );
11277 
11298     void removeHostOnlyNetworkInterface (
11299         in wstringUUID id,
11300         [retval] out IProgress progress
11301     );
11302 
11322     void createUSBDeviceFilter (
11323         in wstring name,
11324         [retval] out IHostUSBDeviceFilter filter
11325     );
11326 
11369     void insertUSBDeviceFilter (
11370         in unsigned long position,
11371         in IHostUSBDeviceFilter filter
11372     );
11373 
11401     void removeUSBDeviceFilter (
11402         in unsigned long position
11403     );
11404 
11422     void findHostDVDDrive (
11423         in wstring name,
11424         [retval] out IMedium drive
11425     );
11426 
11444     void findHostFloppyDrive (
11445         in wstring name,
11446         [retval] out IMedium drive
11447     );
11448 
11464     void findHostNetworkInterfaceByName (
11465         in wstring name,
11466         [retval] out IHostNetworkInterface networkInterface
11467     );
11468 
11484     void findHostNetworkInterfaceById (
11485         in wstringUUID id,
11486         [retval] out IHostNetworkInterface networkInterface
11487     );
11488 
11498     void findHostNetworkInterfacesOfType (
11499         in HostNetworkInterfaceType type,
11500         [retval] out IHostNetworkInterface[] networkInterfaces
11501     );
11502 
11522     void findUSBDeviceById (
11523         in wstringUUID id,
11524         [retval] out IHostUSBDevice device
11525     );
11526 
11549     void findUSBDeviceByAddress (
11550         in wstring name,
11551         [retval] out IHostUSBDevice device
11552     );
11553 
11561     void generateMACAddress (
11562         [retval] out wstring address
11563     );
11564 
11565 }; /* interface IHost */
11566 
11579 interface ISystemProperties : $unknown
11580 {
11584     readonly attribute unsigned long minGuestRAM;
11585 
11589     readonly attribute unsigned long maxGuestRAM;
11590 
11594     readonly attribute unsigned long minGuestVRAM;
11595 
11599     readonly attribute unsigned long maxGuestVRAM;
11600 
11604     readonly attribute unsigned long minGuestCPUCount;
11605 
11609     readonly attribute unsigned long maxGuestCPUCount;
11610 
11614     readonly attribute unsigned long maxGuestMonitors;
11615 
11620     readonly attribute long long infoVDSize;
11621 
11628     readonly attribute unsigned long serialPortCount;
11629 
11636     readonly attribute unsigned long parallelPortCount;
11637 
11647     readonly attribute unsigned long maxBootPosition;
11648 
11672     attribute wstring defaultMachineFolder;
11673 
11698     readonly attribute IMediumFormat[] mediumFormats;
11699 
11733     attribute wstring defaultHardDiskFormat;
11734 
11740     attribute long long freeDiskSpaceWarning;
11741 
11746     attribute unsigned long freeDiskSpacePercentWarning;
11747 
11753     attribute long long freeDiskSpaceError;
11754 
11759     attribute unsigned long freeDiskSpacePercentError;
11760 
11784     attribute wstring VRDEAuthLibrary;
11785 
11814     attribute wstring webServiceAuthLibrary;
11815 
11829     attribute wstring defaultVRDEExtPack;
11830 
11836     attribute unsigned long logHistoryCount;
11837 
11842     readonly attribute AudioDriverType defaultAudioDriver;
11843 
11850     attribute wstring autostartDatabasePath;
11851 
11858     attribute wstring defaultAdditionsISO;
11859 
11870     void getMaxNetworkAdapters (
11871         in ChipsetType chipset,
11872         [retval] out unsigned long maxNetworkAdapters
11873     );
11874 
11888     void getMaxNetworkAdaptersOfType (
11889         in ChipsetType chipset,
11890         in NetworkAttachmentType type,
11891         [retval] out unsigned long maxNetworkAdapters
11892     );
11893 
11903     void getMaxDevicesPerPortForStorageBus (
11904         in StorageBus bus,
11905         [retval] out unsigned long maxDevicesPerPort
11906     );
11907 
11915     void getMinPortCountForStorageBus (
11916         in StorageBus bus,
11917         [retval] out unsigned long minPortCount
11918     );
11919 
11927     void getMaxPortCountForStorageBus (
11928         in StorageBus bus,
11929         [retval] out unsigned long maxPortCount
11930     );
11931 
11944     void getMaxInstancesOfStorageBus (
11945         in ChipsetType chipset,
11946         in StorageBus bus,
11947         [retval] out unsigned long maxInstances
11948     );
11949 
11959     void getDeviceTypesForStorageBus (
11960         in StorageBus bus,
11961         [retval] out DeviceType[] deviceTypes
11962     );
11963 
11972     void getDefaultIoCacheSettingForStorageController (
11973         in StorageControllerType controllerType,
11974         [retval] out boolean enabled
11975     );
11976 
11977 }; /* interface ISystemProperties */
11978 
11984 interface IGuestOSType : $unknown
11985 {
11989     readonly attribute wstring familyId;
11990 
11994     readonly attribute wstring familyDescription;
11995 
11999     readonly attribute wstring id;
12000 
12004     readonly attribute wstring description;
12005 
12009     readonly attribute boolean is64Bit;
12010 
12014     readonly attribute boolean recommendedIOAPIC;
12015 
12019     readonly attribute boolean recommendedVirtEx;
12020 
12024     readonly attribute unsigned long recommendedRAM;
12025 
12029     readonly attribute unsigned long recommendedVRAM;
12030 
12034     readonly attribute boolean recommended2DVideoAcceleration;
12035 
12039     readonly attribute boolean recommended3DAcceleration;
12040 
12044     readonly attribute long long recommendedHDD;
12045 
12049     readonly attribute NetworkAdapterType adapterType;
12050 
12054     readonly attribute boolean recommendedPAE;
12055 
12059     readonly attribute StorageControllerType recommendedDVDStorageController;
12060 
12064     readonly attribute StorageBus recommendedDVDStorageBus;
12065 
12069     readonly attribute StorageControllerType recommendedHDStorageController;
12070 
12074     readonly attribute StorageBus recommendedHDStorageBus;
12075 
12079     readonly attribute FirmwareType recommendedFirmware;
12080 
12084     readonly attribute boolean recommendedUSBHID;
12085 
12089     readonly attribute boolean recommendedHPET;
12090 
12094     readonly attribute boolean recommendedUSBTablet;
12095 
12099     readonly attribute boolean recommendedRTCUseUTC;
12100 
12104     readonly attribute ChipsetType recommendedChipset;
12105 
12109     readonly attribute AudioControllerType recommendedAudioController;
12110 
12114     readonly attribute boolean recommendedFloppy;
12115 
12119     readonly attribute boolean recommendedUSB;
12120 
12121 }; /* interface IGuestOSType */
12122 
12130 interface IAdditionsFacility : $unknown
12131 {
12135     readonly attribute AdditionsFacilityClass classType;
12136 
12143     readonly attribute long long lastUpdated;
12144 
12148     readonly attribute wstring name;
12149 
12153     readonly attribute AdditionsFacilityStatus status;
12154 
12158     readonly attribute AdditionsFacilityType type;
12159 
12160 }; /* interface IAdditionsFacility */
12161 
12169 interface IGuestDirEntry : $unknown
12170 {
12174     readonly attribute long long nodeId;
12175 
12179     readonly attribute wstring name;
12180 
12184     readonly attribute GuestDirEntryType type;
12185 
12186 }; /* interface IGuestDirEntry */
12187 
12188 interface IGuestSession : $unknown
12189 {
12199     readonly attribute wstring user;
12200 
12210     readonly attribute wstring domain;
12211 
12221     readonly attribute wstring name;
12222 
12232     readonly attribute unsigned long id;
12233 
12243     attribute unsigned long timeout;
12244 
12250     attribute wstring[] environment;
12251 
12257     readonly attribute IGuestProcess[] processes;
12258 
12264     readonly attribute IGuestDirectory[] directories;
12265 
12271     readonly attribute IGuestFile[] files;
12272 
12286     void close();
12287 
12309     void copyFrom (
12310         in wstring source,
12311         in wstring dest,
12312         in CopyFileFlag[] flags,
12313         [retval] out IProgress progress
12314     );
12315 
12337     void copyTo (
12338         in wstring source,
12339         in wstring dest,
12340         in CopyFileFlag[] flags,
12341         [retval] out IProgress progress
12342     );
12343 
12365     void directoryCreate (
12366         in wstring path,
12367         in unsigned long mode,
12368         in DirectoryCreateFlag[] flags,
12369         [retval] out IGuestDirectory directory
12370     );
12371 
12423     void directoryCreateTemp (
12424         in wstring templateName,
12425         in unsigned long mode,
12426         in wstring path,
12427         in boolean secure,
12428         [retval] out wstring directory
12429     );
12430 
12448     void directoryExists (
12449         in wstring path,
12450         [retval] out boolean exists
12451     );
12452 
12474     void directoryOpen (
12475         in wstring path,
12476         in wstring filter,
12477         in DirectoryOpenFlag[] flags,
12478         [retval] out IGuestDirectory directory
12479     );
12480 
12498     void directoryQueryInfo (
12499         in wstring path,
12500         [retval] out IGuestFsObjInfo info
12501     );
12502 
12518     void directoryRemove (
12519         in wstring path
12520     );
12521 
12541     void directoryRemoveRecursive (
12542         in wstring path,
12543         in DirectoryRemoveRecFlag[] flags,
12544         [retval] out IProgress progress
12545     );
12546 
12566     void directoryRename (
12567         in wstring source,
12568         in wstring dest,
12569         in PathRenameFlag[] flags
12570     );
12571 
12589     void directorySetACL (
12590         in wstring path,
12591         in wstring acl
12592     );
12593 
12607     void environmentClear();
12608 
12626     void environmentGet (
12627         in wstring name,
12628         [retval] out wstring value
12629     );
12630 
12648     void environmentSet (
12649         in wstring name,
12650         in wstring value
12651     );
12652 
12668     void environmentUnset (
12669         in wstring name
12670     );
12671 
12725     void fileCreateTemp (
12726         in wstring templateName,
12727         in unsigned long mode,
12728         in wstring path,
12729         in boolean secure,
12730         [retval] out IGuestFile file
12731     );
12732 
12750     void fileExists (
12751         in wstring path,
12752         [retval] out boolean exists
12753     );
12754 
12763     void fileRemove (
12764         in wstring path
12765     );
12766 
12792     void fileOpen (
12793         in wstring path,
12794         in wstring openMode,
12795         in wstring disposition,
12796         in unsigned long creationMode,
12797         in long long offset,
12798         [retval] out IGuestFile file
12799     );
12800 
12818     void fileQueryInfo (
12819         in wstring path,
12820         [retval] out IGuestFsObjInfo info
12821     );
12822 
12840     void fileQuerySize (
12841         in wstring path,
12842         [retval] out long long size
12843     );
12844 
12864     void fileRename (
12865         in wstring source,
12866         in wstring dest,
12867         in PathRenameFlag[] flags
12868     );
12869 
12887     void fileSetACL (
12888         in wstring file,
12889         in wstring acl
12890     );
12891 
12917     void processCreate (
12918         in wstring command,
12919         in wstring[] arguments,
12920         in wstring[] environment,
12921         in ProcessCreateFlag[] flags,
12922         in unsigned long timeoutMS,
12923         [retval] out IGuestProcess guestProcess
12924     );
12925 
12955     void processCreateEx (
12956         in wstring command,
12957         in wstring[] arguments,
12958         in wstring[] environment,
12959         in ProcessCreateFlag[] flags,
12960         in unsigned long timeoutMS,
12961         in ProcessPriority priority,
12962         in long[] affinity,
12963         [retval] out IGuestProcess guestProcess
12964     );
12965 
12983     void processGet (
12984         in unsigned long pid,
12985         [retval] out IGuestProcess guestProcess
12986     );
12987 
13007     void symlinkCreate (
13008         in wstring source,
13009         in wstring target,
13010         in SymlinkType type
13011     );
13012 
13030     void symlinkExists (
13031         in wstring symlink,
13032         [retval] out boolean exists
13033     );
13034 
13054     void symlinkRead (
13055         in wstring symlink,
13056         in SymlinkReadFlag[] flags,
13057         [retval] out wstring target
13058     );
13059 
13075     void symlinkRemoveDirectory (
13076         in wstring path
13077     );
13078 
13094     void symlinkRemoveFile (
13095         in wstring file
13096     );
13097 
13098 }; /* interface IGuestSession */
13099 
13107 interface IProcess : $unknown
13108 {
13118     readonly attribute unsigned long PID;
13119 
13129     readonly attribute ProcessStatus status;
13130 
13140     readonly attribute long exitCode;
13141 
13151     readonly attribute wstring[] environment;
13152 
13162     readonly attribute wstring[] arguments;
13163 
13173     readonly attribute wstring executablePath;
13174 
13184     readonly attribute wstring name;
13185 
13205     void waitFor (
13206         in unsigned long waitFor,
13207         in unsigned long timeoutMS,
13208         [retval] out ProcessWaitResult reason
13209     );
13210 
13230     void waitForArray (
13231         in ProcessWaitForFlag[] waitFor,
13232         in unsigned long timeoutMS,
13233         [retval] out ProcessWaitResult reason
13234     );
13235 
13257     void read (
13258         in unsigned long handle,
13259         in unsigned long size,
13260         in unsigned long timeoutMS,
13261         [retval] out octet[] data
13262     );
13263 
13288     void write (
13289         in unsigned long handle,
13290         in unsigned long flags,
13291         in octet[] data,
13292         in unsigned long timeoutMS,
13293         [retval] out unsigned long written
13294     );
13295 
13320     void WriteArray (
13321         in unsigned long handle,
13322         in ProcessInputFlag[] flags,
13323         in octet[] data,
13324         in unsigned long timeoutMS,
13325         [retval] out unsigned long written
13326     );
13327 
13341     void terminate();
13342 
13343 }; /* interface IProcess */
13344 
13352 interface IGuestProcess : IProcess
13353 {
13354 }; /* interface IGuestProcess */
13355 
13363 interface IDirectory : $unknown
13364 {
13374     readonly attribute wstring directoryName;
13375 
13385     readonly attribute wstring filter;
13386 
13400     void close();
13401 
13417     void read (
13418         [retval] out IFsObjInfo objInfo
13419     );
13420 
13421 }; /* interface IDirectory */
13422 
13430 interface IGuestDirectory : IDirectory
13431 {
13432 }; /* interface IGuestDirectory */
13433 
13441 interface IFile : $unknown
13442 {
13452     readonly attribute unsigned long creationMode;
13453 
13463     readonly attribute unsigned long disposition;
13464 
13474     readonly attribute wstring fileName;
13475 
13485     readonly attribute long long initialSize;
13486 
13496     readonly attribute unsigned long openMode;
13497 
13507     readonly attribute long long offset;
13508 
13522     void close();
13523 
13539     void queryInfo (
13540         [retval] out IFsObjInfo objInfo
13541     );
13542 
13562     void read (
13563         in unsigned long toRead,
13564         out unsigned long read,
13565         [retval] out octet[] data
13566     );
13567 
13589     void readAt (
13590         in long long offset,
13591         in unsigned long toRead,
13592         out unsigned long read,
13593         [retval] out octet[] data
13594     );
13595 
13613     void seek (
13614         in long long offset,
13615         in FileSeekType whence
13616     );
13617 
13633     void setACL (
13634         in wstring acl
13635     );
13636 
13654     void write (
13655         in octet[] data,
13656         [retval] out unsigned long written
13657     );
13658 
13678     void writeAt (
13679         in long long offset,
13680         in octet[] data,
13681         [retval] out unsigned long written
13682     );
13683 
13684 }; /* interface IFile */
13685 
13693 interface IGuestFile : IFile
13694 {
13695 }; /* interface IGuestFile */
13696 
13704 interface IFsObjInfo : $unknown
13705 {
13715     readonly attribute long long accessTime;
13716 
13726     readonly attribute long long allocatedSize;
13727 
13737     readonly attribute long long birthTime;
13738 
13748     readonly attribute long long changeTime;
13749 
13759     readonly attribute unsigned long deviceNumber;
13760 
13770     readonly attribute wstring fileAttributes;
13771 
13781     readonly attribute unsigned long generationId;
13782 
13792     readonly attribute unsigned long GID;
13793 
13803     readonly attribute wstring groupName;
13804 
13814     readonly attribute unsigned long hardLinks;
13815 
13825     readonly attribute long long modificationTime;
13826 
13836     readonly attribute wstring name;
13837 
13847     readonly attribute long long nodeId;
13848 
13858     readonly attribute unsigned long nodeIdDevice;
13859 
13869     readonly attribute long long objectSize;
13870 
13880     readonly attribute FsObjType type;
13881 
13891     readonly attribute unsigned long UID;
13892 
13902     readonly attribute unsigned long userFlags;
13903 
13913     readonly attribute wstring userName;
13914 
13915 }; /* interface IFsObjInfo */
13916 
13924 interface IGuestFsObjInfo : IFsObjInfo
13925 {
13926 }; /* interface IGuestFsObjInfo */
13927 
13941 interface IGuest : $unknown
13942 {
13957     readonly attribute wstring OSTypeId;
13958 
13964     readonly attribute AdditionsRunLevelType additionsRunLevel;
13965 
13972     readonly attribute wstring additionsVersion;
13973 
13981     readonly attribute unsigned long additionsRevision;
13982 
13989     readonly attribute IAdditionsFacility[] facilities;
13990 
13994     readonly attribute IGuestSession[] sessions;
13995 
13999     attribute unsigned long memoryBalloonSize;
14000 
14004     attribute unsigned long statisticsUpdateInterval;
14005 
14037     void internalGetStatistics (
14038         out unsigned long cpuUser,
14039         out unsigned long cpuKernel,
14040         out unsigned long cpuIdle,
14041         out unsigned long memTotal,
14042         out unsigned long memFree,
14043         out unsigned long memBalloon,
14044         out unsigned long memShared,
14045         out unsigned long memCache,
14046         out unsigned long pagedTotal,
14047         out unsigned long memAllocTotal,
14048         out unsigned long memFreeTotal,
14049         out unsigned long memBalloonTotal,
14050         out unsigned long memSharedTotal
14051     );
14052 
14064     void getFacilityStatus (
14065         in AdditionsFacilityType facility,
14066         out long long timestamp,
14067         [retval] out AdditionsFacilityStatus status
14068     );
14069 
14087     void getAdditionsStatus (
14088         in AdditionsRunLevelType level,
14089         [retval] out boolean active
14090     );
14091 
14121     void setCredentials (
14122         in wstring userName,
14123         in wstring password,
14124         in wstring domain,
14125         in boolean allowInteractiveLogon
14126     );
14127 
14157     void dragHGEnter (
14158         in unsigned long screenId,
14159         in unsigned long y,
14160         in unsigned long x,
14161         in DragAndDropAction defaultAction,
14162         in DragAndDropAction[] allowedActions,
14163         in wstring[] formats,
14164         [retval] out DragAndDropAction resultAction
14165     );
14166 
14196     void dragHGMove (
14197         in unsigned long screenId,
14198         in unsigned long x,
14199         in unsigned long y,
14200         in DragAndDropAction defaultAction,
14201         in DragAndDropAction[] allowedActions,
14202         in wstring[] formats,
14203         [retval] out DragAndDropAction resultAction
14204     );
14205 
14223     void dragHGLeave (
14224         in unsigned long screenId
14225     );
14226 
14258     void dragHGDrop (
14259         in unsigned long screenId,
14260         in unsigned long x,
14261         in unsigned long y,
14262         in DragAndDropAction defaultAction,
14263         in DragAndDropAction[] allowedActions,
14264         in wstring[] formats,
14265         out wstring format,
14266         [retval] out DragAndDropAction resultAction
14267     );
14268 
14292     void dragHGPutData (
14293         in unsigned long screenId,
14294         in wstring format,
14295         in octet[] data,
14296         [retval] out IProgress progress
14297     );
14298 
14324     void dragGHPending (
14325         in unsigned long screenId,
14326         out wstring[] format,
14327         out DragAndDropAction[] allowedActions,
14328         [retval] out DragAndDropAction defaultAction
14329     );
14330 
14352     void dragGHDropped (
14353         in wstring format,
14354         in DragAndDropAction action,
14355         [retval] out IProgress progress
14356     );
14357 
14375     void dragGHGetData (
14376         [retval] out octet[] data
14377     );
14378 
14404     void createSession (
14405         in wstring user,
14406         in wstring password,
14407         in wstring domain,
14408         in wstring sessionName,
14409         [retval] out IGuestSession guestSession
14410     );
14411 
14425     void findSession (
14426         in wstring sessionName,
14427         [retval] out IGuestSession[] sessions
14428     );
14429 
14499     void executeProcess (
14500         in wstring execName,
14501         in unsigned long flags,
14502         in wstring[] arguments,
14503         in wstring[] environment,
14504         in wstring userName,
14505         in wstring password,
14506         in unsigned long timeoutMS,
14507         out unsigned long pid,
14508         [retval] out IProgress progress
14509     );
14510 
14555     void getProcessOutput (
14556         in unsigned long pid,
14557         in unsigned long flags,
14558         in unsigned long timeoutMS,
14559         in long long size,
14560         [retval] out octet[] data
14561     );
14562 
14596     void getProcessStatus (
14597         in unsigned long pid,
14598         out unsigned long exitcode,
14599         out unsigned long flags,
14600         [retval] out ExecuteProcessStatus reason
14601     );
14602 
14639     void copyFromGuest (
14640         in wstring source,
14641         in wstring dest,
14642         in wstring userName,
14643         in wstring password,
14644         in unsigned long flags,
14645         [retval] out IProgress progress
14646     );
14647 
14684     void copyToGuest (
14685         in wstring source,
14686         in wstring dest,
14687         in wstring userName,
14688         in wstring password,
14689         in unsigned long flags,
14690         [retval] out IProgress progress
14691     );
14692 
14710     void directoryClose (
14711         in unsigned long handle
14712     );
14713 
14748     void directoryCreate (
14749         in wstring directory,
14750         in wstring userName,
14751         in wstring password,
14752         in unsigned long mode,
14753         in unsigned long flags
14754     );
14755 
14795     void directoryOpen (
14796         in wstring directory,
14797         in wstring filter,
14798         in unsigned long flags,
14799         in wstring userName,
14800         in wstring password,
14801         [retval] out unsigned long handle
14802     );
14803 
14833     void directoryRead (
14834         in unsigned long handle,
14835         [retval] out IGuestDirEntry entry
14836     );
14837 
14873     void fileExists (
14874         in wstring file,
14875         in wstring userName,
14876         in wstring password,
14877         [retval] out boolean exists
14878     );
14879 
14911     void fileQuerySize (
14912         in wstring file,
14913         in wstring userName,
14914         in wstring password,
14915         [retval] out long long size
14916     );
14917 
14951     void setProcessInput (
14952         in unsigned long pid,
14953         in unsigned long flags,
14954         in unsigned long timeoutMS,
14955         in octet[] data,
14956         [retval] out unsigned long written
14957     );
14958 
14982     void updateGuestAdditions (
14983         in wstring source,
14984         in AdditionsUpdateFlag[] flags,
14985         [retval] out IProgress progress
14986     );
14987 
14988 }; /* interface IGuest */
14989 
15030 interface IProgress : $unknown
15031 {
15035     readonly attribute wstringUUID id;
15036 
15040     readonly attribute wstring description;
15041 
15045     readonly attribute $unknown initiator;
15046 
15050     readonly attribute boolean cancelable;
15051 
15059     readonly attribute unsigned long percent;
15060 
15074     readonly attribute long timeRemaining;
15075 
15079     readonly attribute boolean completed;
15080 
15084     readonly attribute boolean canceled;
15085 
15092     readonly attribute long resultCode;
15093 
15103     readonly attribute IVirtualBoxErrorInfo errorInfo;
15104 
15111     readonly attribute unsigned long operationCount;
15112 
15116     readonly attribute unsigned long operation;
15117 
15123     readonly attribute wstring operationDescription;
15124 
15128     readonly attribute unsigned long operationPercent;
15129 
15133     readonly attribute unsigned long operationWeight;
15134 
15142     attribute unsigned long timeout;
15143 
15147     void setCurrentOperationProgress (
15148         in unsigned long percent
15149     );
15150 
15154     void setNextOperation (
15155         in wstring nextOperationDescription,
15156         in unsigned long nextOperationsWeight
15157     );
15158 
15185     void waitForCompletion (
15186         in long timeout
15187     );
15188 
15212     void waitForOperationCompletion (
15213         in unsigned long operation,
15214         in long timeout
15215     );
15216 
15242     void waitForAsyncProgressCompletion (
15243         in IProgress pProgressAsync
15244     );
15245 
15262     void cancel();
15263 
15264 }; /* interface IProgress */
15265 
15349 interface ISnapshot : $unknown
15350 {
15354     readonly attribute wstringUUID id;
15355 
15363     attribute wstring name;
15364 
15372     attribute wstring description;
15373 
15379     readonly attribute long long timeStamp;
15380 
15392     readonly attribute boolean online;
15393 
15405     readonly attribute IMachine machine;
15406 
15413     readonly attribute ISnapshot parent;
15414 
15423     readonly attribute ISnapshot[] children;
15424 
15432     void getChildrenCount (
15433         [retval] out unsigned long childrenCount
15434     );
15435 
15436 }; /* interface ISnapshot */
15437 
15624 interface IMediumAttachment : $unknown
15625 {
15630     readonly attribute IMedium medium;
15631 
15637     readonly attribute wstring controller;
15638 
15644     readonly attribute long port;
15645 
15651     readonly attribute long device;
15652 
15656     readonly attribute DeviceType type;
15657 
15661     readonly attribute boolean passthrough;
15662 
15666     readonly attribute boolean temporaryEject;
15667 
15672     readonly attribute boolean isEjected;
15673 
15677     readonly attribute boolean nonRotational;
15678 
15682     readonly attribute boolean discard;
15683 
15687     readonly attribute IBandwidthGroup bandwidthGroup;
15688 
15689 }; /* interface IMediumAttachment */
15690 
15848 interface IMedium : $unknown
15849 {
15863     readonly attribute wstringUUID id;
15864 
15883     attribute wstring description;
15884 
15900     readonly attribute MediumState state;
15901 
15910     readonly attribute unsigned long variant;
15911 
15933     attribute wstring location;
15934 
15954     readonly attribute wstring name;
15955 
15960     readonly attribute DeviceType deviceType;
15961 
15965     readonly attribute boolean hostDrive;
15966 
15979     readonly attribute long long size;
15980 
15995     readonly attribute wstring format;
15996 
16012     readonly attribute IMediumFormat mediumFormat;
16013 
16038     attribute MediumType type;
16039 
16053     readonly attribute MediumType[] allowedTypes;
16054 
16064     readonly attribute IMedium parent;
16065 
16073     readonly attribute IMedium[] children;
16074 
16085     readonly attribute IMedium base;
16086 
16119     readonly attribute boolean readOnly;
16120 
16141     readonly attribute long long logicalSize;
16142 
16170     attribute boolean autoReset;
16171 
16186     readonly attribute wstring lastAccessError;
16187 
16204     readonly attribute wstringUUID[] machineIds;
16205 
16231     void setIds (
16232         in boolean setImageId,
16233         in wstringUUID imageId,
16234         in boolean setParentId,
16235         in wstringUUID parentId
16236     );
16237 
16272     void refreshState (
16273         [retval] out MediumState state
16274     );
16275 
16302     void getSnapshotIds (
16303         in wstringUUID machineId,
16304         [retval] out wstringUUID[] snapshotIds
16305     );
16306 
16366     void lockRead (
16367         [retval] out MediumState state
16368     );
16369 
16392     void unlockRead (
16393         [retval] out MediumState state
16394     );
16395 
16450     void lockWrite (
16451         [retval] out MediumState state
16452     );
16453 
16476     void unlockWrite (
16477         [retval] out MediumState state
16478     );
16479 
16529     void close();
16530 
16560     void getProperty (
16561         in wstring name,
16562         [retval] out wstring value
16563     );
16564 
16596     void setProperty (
16597         in wstring name,
16598         in wstring value
16599     );
16600 
16635     void getProperties (
16636         in wstring names,
16637         out wstring[] returnNames,
16638         [retval] out wstring[] returnValues
16639     );
16640 
16670     void setProperties (
16671         in wstring[] names,
16672         in wstring[] values
16673     );
16674 
16707     void createBaseStorage (
16708         in long long logicalSize,
16709         in unsigned long variant,
16710         [retval] out IProgress progress
16711     );
16712 
16764     void deleteStorage (
16765         [retval] out IProgress progress
16766     );
16767 
16806     void createDiffStorage (
16807         in IMedium target,
16808         in unsigned long variant,
16809         [retval] out IProgress progress
16810     );
16811 
16887     void mergeTo (
16888         in IMedium target,
16889         [retval] out IProgress progress
16890     );
16891 
16941     void cloneTo (
16942         in IMedium target,
16943         in unsigned long variant,
16944         in IMedium parent,
16945         [retval] out IProgress progress
16946     );
16947 
16995     void cloneToBase (
16996         in IMedium target,
16997         in unsigned long variant,
16998         [retval] out IProgress progress
16999     );
17000 
17029     void compact (
17030         [retval] out IProgress progress
17031     );
17032 
17065     void resize (
17066         in long long logicalSize,
17067         [retval] out IProgress progress
17068     );
17069 
17103     void reset (
17104         [retval] out IProgress progress
17105     );
17106 
17107 }; /* interface IMedium */
17108 
17131 interface IMediumFormat : $unknown
17132 {
17151     readonly attribute wstring id;
17152 
17160     readonly attribute wstring name;
17161 
17170     readonly attribute unsigned long capabilities;
17171 
17190     void describeFileExtensions (
17191         out wstring[] extensions,
17192         out DeviceType[] type
17193     );
17194 
17222     void describeProperties (
17223         out wstring[] names,
17224         out wstring[] description,
17225         out DataType[] types,
17226         out unsigned long[] flags,
17227         out wstring[] defaults
17228     );
17229 
17230 }; /* interface IMediumFormat */
17231 
17244 interface IKeyboard : $unknown
17245 {
17251     readonly attribute IEventSource eventSource;
17252 
17265     void putScancode (
17266         in long scancode
17267     );
17268 
17281     void putScancodes (
17282         in long[] scancodes,
17283         [retval] out unsigned long codesStored
17284     );
17285 
17300     void putCAD();
17301 
17302 }; /* interface IKeyboard */
17303 
17315 interface IMouse : $unknown
17316 {
17331     readonly attribute boolean absoluteSupported;
17332 
17347     readonly attribute boolean relativeSupported;
17348 
17363     readonly attribute boolean needsHostCursor;
17364 
17370     readonly attribute IEventSource eventSource;
17371 
17437     void putMouseEvent (
17438         in long dx,
17439         in long dy,
17440         in long dz,
17441         in long dw,
17442         in long buttonState
17443     );
17444 
17517     void putMouseEventAbsolute (
17518         in long x,
17519         in long y,
17520         in long dz,
17521         in long dw,
17522         in long buttonState
17523     );
17524 
17525 }; /* interface IMouse */
17526 
17527 interface IFramebuffer : $unknown
17528 {
17537     readonly attribute octetPtr address;
17538 
17542     readonly attribute unsigned long width;
17543 
17547     readonly attribute unsigned long height;
17548 
17555     readonly attribute unsigned long bitsPerPixel;
17556 
17563     readonly attribute unsigned long bytesPerLine;
17564 
17575     readonly attribute unsigned long pixelFormat;
17576 
17583     readonly attribute boolean usesGuestVRAM;
17584 
17594     readonly attribute unsigned long heightReduction;
17595 
17610     readonly attribute IFramebufferOverlay overlay;
17611 
17618     readonly attribute long long winId;
17619 
17627     void lock();
17628 
17636     void unlock();
17637 
17645     void notifyUpdate (
17646         in unsigned long x,
17647         in unsigned long y,
17648         in unsigned long width,
17649         in unsigned long height
17650     );
17651 
17764     void requestResize (
17765         in unsigned long screenId,
17766         in unsigned long pixelFormat,
17767         in octetPtr VRAM,
17768         in unsigned long bitsPerPixel,
17769         in unsigned long bytesPerLine,
17770         in unsigned long width,
17771         in unsigned long height,
17772         [retval] out boolean finished
17773     );
17774 
17786     void videoModeSupported (
17787         in unsigned long width,
17788         in unsigned long height,
17789         in unsigned long bpp,
17790         [retval] out boolean supported
17791     );
17792 
17829     void getVisibleRegion (
17830         in octetPtr rectangles,
17831         in unsigned long count,
17832         [retval] out unsigned long countCopied
17833     );
17834 
17869     void setVisibleRegion (
17870         in octetPtr rectangles,
17871         in unsigned long count
17872     );
17873 
17894     void processVHWACommand (
17895         in octetPtr command
17896     );
17897 
17898 }; /* interface IFramebuffer */
17899 
17914 interface IFramebufferOverlay : IFramebuffer
17915 {
17919     readonly attribute unsigned long x;
17920 
17924     readonly attribute unsigned long y;
17925 
17931     attribute boolean visible;
17932 
17939     attribute unsigned long alpha;
17940 
17946     void move (
17947         in unsigned long x,
17948         in unsigned long y
17949     );
17950 
17951 }; /* interface IFramebufferOverlay */
17952 
17968 interface IDisplay : $unknown
17969 {
17973     void getScreenResolution (
17974         in unsigned long screenId,
17975         out unsigned long width,
17976         out unsigned long height,
17977         out unsigned long bitsPerPixel
17978     );
17979 
17985     void setFramebuffer (
17986         in unsigned long screenId,
17987         in IFramebuffer framebuffer
17988     );
17989 
17995     void getFramebuffer (
17996         in unsigned long screenId,
17997         out IFramebuffer framebuffer,
17998         out long xOrigin,
17999         out long yOrigin
18000     );
18001 
18052     void setVideoModeHint (
18053         in unsigned long display,
18054         in boolean enabled,
18055         in boolean changeOrigin,
18056         in long originX,
18057         in long originY,
18058         in unsigned long width,
18059         in unsigned long height,
18060         in unsigned long bitsPerPixel
18061     );
18062 
18074     void setSeamlessMode (
18075         in boolean enabled
18076     );
18077 
18113     void takeScreenShot (
18114         in unsigned long screenId,
18115         in octetPtr address,
18116         in unsigned long width,
18117         in unsigned long height
18118     );
18119 
18163     void takeScreenShotToArray (
18164         in unsigned long screenId,
18165         in unsigned long width,
18166         in unsigned long height,
18167         [retval] out octet[] screenData
18168     );
18169 
18208     void takeScreenShotPNGToArray (
18209         in unsigned long screenId,
18210         in unsigned long width,
18211         in unsigned long height,
18212         [retval] out octet[] screenData
18213     );
18214 
18266     void drawToScreen (
18267         in unsigned long screenId,
18268         in octetPtr address,
18269         in unsigned long x,
18270         in unsigned long y,
18271         in unsigned long width,
18272         in unsigned long height
18273     );
18274 
18289     void invalidateAndUpdate();
18290 
18304     void resizeCompleted (
18305         in unsigned long screenId
18306     );
18307 
18320     void completeVHWACommand (
18321         in octetPtr command
18322     );
18323 
18357     void viewportChanged (
18358         in unsigned long screenId,
18359         in unsigned long x,
18360         in unsigned long y,
18361         in unsigned long width,
18362         in unsigned long height
18363     );
18364 
18365 }; /* interface IDisplay */
18366 
18382 interface INetworkAdapter : $unknown
18383 {
18391     attribute NetworkAdapterType adapterType;
18392 
18400     readonly attribute unsigned long slot;
18401 
18410     attribute boolean enabled;
18411 
18418     attribute wstring MACAddress;
18419 
18425     attribute NetworkAttachmentType attachmentType;
18426 
18432     attribute wstring bridgedInterface;
18433 
18439     attribute wstring hostOnlyInterface;
18440 
18446     attribute wstring internalNetwork;
18447 
18453     attribute wstring NATNetwork;
18454 
18460     attribute wstring genericDriver;
18461 
18468     attribute boolean cableConnected;
18469 
18475     attribute unsigned long lineSpeed;
18476 
18483     attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
18484 
18491     attribute boolean traceEnabled;
18492 
18499     attribute wstring traceFile;
18500 
18508     readonly attribute INATEngine NATEngine;
18509 
18516     attribute unsigned long bootPriority;
18517 
18521     attribute IBandwidthGroup bandwidthGroup;
18522 
18541     void getProperty (
18542         in wstring key,
18543         [retval] out wstring value
18544     );
18545 
18564     void setProperty (
18565         in wstring key,
18566         in wstring value
18567     );
18568 
18596     void getProperties (
18597         in wstring names,
18598         out wstring[] returnNames,
18599         [retval] out wstring[] returnValues
18600     );
18601 
18602 }; /* interface INetworkAdapter */
18603 
18632 interface ISerialPort : $unknown
18633 {
18641     readonly attribute unsigned long slot;
18642 
18649     attribute boolean enabled;
18650 
18654     attribute unsigned long IOBase;
18655 
18659     attribute unsigned long IRQ;
18660 
18671     attribute PortMode hostMode;
18672 
18680     attribute boolean server;
18681 
18691     attribute wstring path;
18692 
18693 }; /* interface ISerialPort */
18694 
18714 interface IParallelPort : $unknown
18715 {
18723     readonly attribute unsigned long slot;
18724 
18731     attribute boolean enabled;
18732 
18736     attribute unsigned long IOBase;
18737 
18741     attribute unsigned long IRQ;
18742 
18750     attribute wstring path;
18751 
18752 }; /* interface IParallelPort */
18753 
18754 interface IMachineDebugger : $unknown
18755 {
18759     attribute boolean singleStep;
18760 
18764     attribute boolean recompileUser;
18765 
18769     attribute boolean recompileSupervisor;
18770 
18774     attribute boolean PATMEnabled;
18775 
18779     attribute boolean CSAMEnabled;
18780 
18784     attribute boolean logEnabled;
18785 
18789     readonly attribute wstring logDbgFlags;
18790 
18794     readonly attribute wstring logDbgGroups;
18795 
18799     readonly attribute wstring logDbgDestinations;
18800 
18804     readonly attribute wstring logRelFlags;
18805 
18809     readonly attribute wstring logRelGroups;
18810 
18814     readonly attribute wstring logRelDestinations;
18815 
18822     readonly attribute boolean HWVirtExEnabled;
18823 
18830     readonly attribute boolean HWVirtExNestedPagingEnabled;
18831 
18838     readonly attribute boolean HWVirtExVPIDEnabled;
18839 
18848     readonly attribute wstring OSName;
18849 
18858     readonly attribute wstring OSVersion;
18859 
18866     readonly attribute boolean PAEEnabled;
18867 
18874     attribute unsigned long virtualTimeRate;
18875 
18882     readonly attribute long long VM;
18883 
18899     void dumpGuestCore (
18900         in wstring filename,
18901         in wstring compression
18902     );
18903 
18920     void dumpHostProcessCore (
18921         in wstring filename,
18922         in wstring compression
18923     );
18924 
18945     void info (
18946         in wstring name,
18947         in wstring args,
18948         [retval] out wstring info
18949     );
18950 
18956     void injectNMI();
18957 
18968     void modifyLogGroups (
18969         in wstring settings
18970     );
18971 
18982     void modifyLogFlags (
18983         in wstring settings
18984     );
18985 
18996     void modifyLogDestinations (
18997         in wstring settings
18998     );
18999 
19014     void readPhysicalMemory (
19015         in long long address,
19016         in unsigned long size,
19017         [retval] out octet[] bytes
19018     );
19019 
19034     void writePhysicalMemory (
19035         in long long address,
19036         in unsigned long size,
19037         in octet[] bytes
19038     );
19039 
19056     void readVirtualMemory (
19057         in unsigned long cpuId,
19058         in long long address,
19059         in unsigned long size,
19060         [retval] out octet[] bytes
19061     );
19062 
19079     void writeVirtualMemory (
19080         in unsigned long cpuId,
19081         in long long address,
19082         in unsigned long size,
19083         in octet[] bytes
19084     );
19085 
19098     void detectOS (
19099         [retval] out wstring os
19100     );
19101 
19119     void getRegister (
19120         in unsigned long cpuId,
19121         in wstring name,
19122         [retval] out wstring value
19123     );
19124 
19142     void getRegisters (
19143         in unsigned long cpuId,
19144         out wstring[] names,
19145         out wstring[] values
19146     );
19147 
19166     void setRegister (
19167         in unsigned long cpuId,
19168         in wstring name,
19169         in wstring value
19170     );
19171 
19190     void setRegisters (
19191         in unsigned long cpuId,
19192         in wstring[] names,
19193         in wstring[] values
19194     );
19195 
19208     void dumpGuestStack (
19209         in unsigned long cpuId,
19210         [retval] out wstring stack
19211     );
19212 
19220     void resetStats (
19221         in wstring pattern
19222     );
19223 
19231     void dumpStats (
19232         in wstring pattern
19233     );
19234 
19246     void getStats (
19247         in wstring pattern,
19248         in boolean withDescriptions,
19249         out wstring stats
19250     );
19251 
19252 }; /* interface IMachineDebugger */
19253 
19254 interface IUSBController : $unknown
19255 {
19264     attribute boolean enabled;
19265 
19274     attribute boolean enabledEHCI;
19275 
19281     readonly attribute boolean proxyAvailable;
19282 
19290     readonly attribute unsigned short USBStandard;
19291 
19317     readonly attribute IUSBDeviceFilter[] deviceFilters;
19318 
19346     void createDeviceFilter (
19347         in wstring name,
19348         [retval] out IUSBDeviceFilter filter
19349     );
19350 
19395     void insertDeviceFilter (
19396         in unsigned long position,
19397         in IUSBDeviceFilter filter
19398     );
19399 
19432     void removeDeviceFilter (
19433         in unsigned long position,
19434         [retval] out IUSBDeviceFilter filter
19435     );
19436 
19437 }; /* interface IUSBController */
19438 
19451 interface IUSBDevice : $unknown
19452 {
19459     readonly attribute wstringUUID id;
19460 
19464     readonly attribute unsigned short vendorId;
19465 
19469     readonly attribute unsigned short productId;
19470 
19478     readonly attribute unsigned short revision;
19479 
19483     readonly attribute wstring manufacturer;
19484 
19488     readonly attribute wstring product;
19489 
19493     readonly attribute wstring serialNumber;
19494 
19498     readonly attribute wstring address;
19499 
19506     readonly attribute unsigned short port;
19507 
19513     readonly attribute unsigned short version;
19514 
19522     readonly attribute unsigned short portVersion;
19523 
19530     readonly attribute boolean remote;
19531 
19532 }; /* interface IUSBDevice */
19533 
19608 interface IUSBDeviceFilter : $unknown
19609 {
19617     attribute wstring name;
19618 
19622     attribute boolean active;
19623 
19631     attribute wstring vendorId;
19632 
19640     attribute wstring productId;
19641 
19655     attribute wstring revision;
19656 
19661     attribute wstring manufacturer;
19662 
19667     attribute wstring product;
19668 
19673     attribute wstring serialNumber;
19674 
19679     attribute wstring port;
19680 
19690     attribute wstring remote;
19691 
19701     attribute unsigned long maskedInterfaces;
19702 
19703 }; /* interface IUSBDeviceFilter */
19704 
19721 interface IHostUSBDevice : IUSBDevice
19722 {
19728     readonly attribute USBDeviceState state;
19729 
19730 }; /* interface IHostUSBDevice */
19731 
19754 interface IHostUSBDeviceFilter : IUSBDeviceFilter
19755 {
19762     attribute USBDeviceFilterAction action;
19763 
19764 }; /* interface IHostUSBDeviceFilter */
19765 
19774 interface IAudioAdapter : $unknown
19775 {
19784     attribute boolean enabled;
19785 
19791     attribute AudioControllerType audioController;
19792 
19799     attribute AudioDriverType audioDriver;
19800 
19801 }; /* interface IAudioAdapter */
19802 
19803 interface IVRDEServer : $unknown
19804 {
19808     attribute boolean enabled;
19809 
19813     attribute AuthType authType;
19814 
19818     attribute unsigned long authTimeout;
19819 
19826     attribute boolean allowMultiConnection;
19827 
19835     attribute boolean reuseSingleConnection;
19836 
19843     attribute wstring VRDEExtPack;
19844 
19851     attribute wstring authLibrary;
19852 
19858     readonly attribute wstring[] VRDEProperties;
19859 
19873     void setVRDEProperty (
19874         in wstring key,
19875         in wstring value
19876     );
19877 
19891     void getVRDEProperty (
19892         in wstring key,
19893         [retval] out wstring value
19894     );
19895 
19896 }; /* interface IVRDEServer */
19897 
19955 interface ISharedFolder : $unknown
19956 {
19960     readonly attribute wstring name;
19961 
19965     readonly attribute wstring hostPath;
19966 
19976     readonly attribute boolean accessible;
19977 
19984     readonly attribute boolean writable;
19985 
19991     readonly attribute boolean autoMount;
19992 
20005     readonly attribute wstring lastAccessError;
20006 
20007 }; /* interface ISharedFolder */
20008 
20009 interface IInternalSessionControl : $unknown
20010 {
20015     void getPID (
20016         [retval] out unsigned long pid
20017     );
20018 
20040     void getRemoteConsole (
20041         [retval] out IConsole console
20042     );
20043 
20067     void assignMachine (
20068         in IMachine machine,
20069         in LockType lockType
20070     );
20071 
20086     void assignRemoteMachine (
20087         in IMachine machine,
20088         in IConsole console
20089     );
20090 
20114     void updateMachineState (
20115         in MachineState aMachineState
20116     );
20117 
20133     void uninitialize();
20134 
20157     void onNetworkAdapterChange (
20158         in INetworkAdapter networkAdapter,
20159         in boolean changeAdapter
20160     );
20161 
20184     void onSerialPortChange (
20185         in ISerialPort serialPort
20186     );
20187 
20210     void onParallelPortChange (
20211         in IParallelPort parallelPort
20212     );
20213 
20236     void onStorageControllerChange();
20237 
20264     void onMediumChange (
20265         in IMediumAttachment mediumAttachment,
20266         in boolean force
20267     );
20268 
20295     void onStorageDeviceChange (
20296         in IMediumAttachment mediumAttachment,
20297         in boolean remove
20298     );
20299 
20307     void onClipboardModeChange (
20308         in ClipboardMode clipboardMode
20309     );
20310 
20318     void onDragAndDropModeChange (
20319         in DragAndDropMode dragAndDropMode
20320     );
20321 
20331     void onCPUChange (
20332         in unsigned long cpu,
20333         in boolean add
20334     );
20335 
20343     void onCPUExecutionCapChange (
20344         in unsigned long executionCap
20345     );
20346 
20371     void onVRDEServerChange (
20372         in boolean restart
20373     );
20374 
20397     void onUSBControllerChange();
20398 
20427     void onSharedFolderChange (
20428         in boolean global
20429     );
20430 
20456     void onUSBDeviceAttach (
20457         in IUSBDevice device,
20458         in IVirtualBoxErrorInfo error,
20459         in unsigned long maskedInterfaces
20460     );
20461 
20487     void onUSBDeviceDetach (
20488         in wstringUUID id,
20489         in IVirtualBoxErrorInfo error
20490     );
20491 
20509     void onShowWindow (
20510         in boolean check,
20511         out boolean canShow,
20512         out long long winId
20513     );
20514 
20522     void onBandwidthGroupChange (
20523         in IBandwidthGroup bandwidthGroup
20524     );
20525 
20549     void accessGuestProperty (
20550         in wstring name,
20551         in wstring value,
20552         in wstring flags,
20553         in boolean isSetter,
20554         out wstring retValue,
20555         out long long retTimestamp,
20556         out wstring retFlags
20557     );
20558 
20606     void enumerateGuestProperties (
20607         in wstring patterns,
20608         out wstring[] key,
20609         out wstring[] value,
20610         out long long[] timestamp,
20611         out wstring[] flags
20612     );
20613 
20659     void onlineMergeMedium (
20660         in IMediumAttachment mediumAttachment,
20661         in unsigned long sourceIdx,
20662         in unsigned long targetIdx,
20663         in IMedium source,
20664         in IMedium target,
20665         in boolean mergeForward,
20666         in IMedium parentForTarget,
20667         in IMedium[] childrenToReparent,
20668         in IProgress progress
20669     );
20670 
20694     void enableVMMStatistics (
20695         in boolean enable
20696     );
20697 
20698 }; /* interface IInternalSessionControl */
20699 
20758 interface ISession : $unknown
20759 {
20763     readonly attribute SessionState state;
20764 
20772     readonly attribute SessionType type;
20773 
20777     readonly attribute IMachine machine;
20778 
20782     readonly attribute IConsole console;
20783 
20815     void unlockMachine();
20816 
20817 }; /* interface ISession */
20818 
20841 interface IStorageController : $unknown
20842 {
20851     readonly attribute wstring name;
20852 
20858     readonly attribute unsigned long maxDevicesPerPortCount;
20859 
20865     readonly attribute unsigned long minPortCount;
20866 
20872     readonly attribute unsigned long maxPortCount;
20873 
20879     attribute unsigned long instance;
20880 
20889     attribute unsigned long portCount;
20890 
20896     readonly attribute StorageBus bus;
20897 
20910     attribute StorageControllerType controllerType;
20911 
20926     attribute boolean useHostIOCache;
20927 
20933     readonly attribute boolean bootable;
20934 
20957     void getIDEEmulationPort (
20958         in long devicePosition,
20959         [retval] out long portNumber
20960     );
20961 
20985     void setIDEEmulationPort (
20986         in long devicePosition,
20987         in long portNumber
20988     );
20989 
20990 }; /* interface IStorageController */
20991 
21015 interface IManagedObjectRef : $unknown
21016 {
21023     void getInterfaceName (
21024         [retval] out wstring return
21025     );
21026 
21034     void release();
21035 
21036 }; /* interface IManagedObjectRef */
21037 
21046 interface IWebsessionManager : $unknown
21047 {
21056     void logon (
21057         in wstring username,
21058         in wstring password,
21059         [retval] out IVirtualBox return
21060     );
21061 
21071     void getSessionObject (
21072         in IVirtualBox refIVirtualBox,
21073         [retval] out ISession return
21074     );
21075 
21083     void logoff (
21084         in IVirtualBox refIVirtualBox
21085     );
21086 
21087 }; /* interface IWebsessionManager */
21088 
21097 interface IPerformanceMetric : $unknown
21098 {
21104     readonly attribute wstring metricName;
21105 
21111     readonly attribute $unknown object;
21112 
21118     readonly attribute wstring description;
21119 
21125     readonly attribute unsigned long period;
21126 
21136     readonly attribute unsigned long count;
21137 
21143     readonly attribute wstring unit;
21144 
21150     readonly attribute long minimumValue;
21151 
21157     readonly attribute long maximumValue;
21158 
21159 }; /* interface IPerformanceMetric */
21160 
21267 interface IPerformanceCollector : $unknown
21268 {
21279     readonly attribute wstring[] metricNames;
21280 
21304     void getMetrics (
21305         in wstring[] metricNames,
21306         in $unknown[] objects,
21307         [retval] out IPerformanceMetric[] metrics
21308     );
21309 
21348     void setupMetrics (
21349         in wstring[] metricNames,
21350         in $unknown[] objects,
21351         in unsigned long period,
21352         in unsigned long count,
21353         [retval] out IPerformanceMetric[] affectedMetrics
21354     );
21355 
21384     void enableMetrics (
21385         in wstring[] metricNames,
21386         in $unknown[] objects,
21387         [retval] out IPerformanceMetric[] affectedMetrics
21388     );
21389 
21418     void disableMetrics (
21419         in wstring[] metricNames,
21420         in $unknown[] objects,
21421         [retval] out IPerformanceMetric[] affectedMetrics
21422     );
21423 
21512     void queryMetricsData (
21513         in wstring[] metricNames,
21514         in $unknown[] objects,
21515         out wstring[] returnMetricNames,
21516         out $unknown[] returnObjects,
21517         out wstring[] returnUnits,
21518         out unsigned long[] returnScales,
21519         out unsigned long[] returnSequenceNumbers,
21520         out unsigned long[] returnDataIndices,
21521         out unsigned long[] returnDataLengths,
21522         [retval] out long[] returnData
21523     );
21524 
21525 }; /* interface IPerformanceCollector */
21526 
21534 interface INATEngine : $unknown
21535 {
21540     attribute wstring network;
21541 
21548     attribute wstring hostIP;
21549 
21554     attribute wstring TFTPPrefix;
21555 
21560     attribute wstring TFTPBootFile;
21561 
21569     attribute wstring TFTPNextServer;
21570 
21574     attribute unsigned long aliasMode;
21575 
21579     attribute boolean DNSPassDomain;
21580 
21585     attribute boolean DNSProxy;
21586 
21591     attribute boolean DNSUseHostResolver;
21592 
21597     readonly attribute wstring[] redirects;
21598 
21614     void setNetworkSettings (
21615         in unsigned long mtu,
21616         in unsigned long sockSnd,
21617         in unsigned long sockRcv,
21618         in unsigned long TcpWndSnd,
21619         in unsigned long TcpWndRcv
21620     );
21621 
21626     void getNetworkSettings (
21627         out unsigned long mtu,
21628         out unsigned long sockSnd,
21629         out unsigned long sockRcv,
21630         out unsigned long TcpWndSnd,
21631         out unsigned long TcpWndRcv
21632     );
21633 
21653     void addRedirect (
21654         in wstring name,
21655         in NATProtocol proto,
21656         in wstring hostIP,
21657         in unsigned short hostPort,
21658         in wstring guestIP,
21659         in unsigned short guestPort
21660     );
21661 
21667     void removeRedirect (
21668         in wstring name
21669     );
21670 
21671 }; /* interface INATEngine */
21672 
21681 interface IExtPackPlugIn : $unknown
21682 {
21686     readonly attribute wstring name;
21687 
21691     readonly attribute wstring description;
21692 
21698     readonly attribute wstring frontend;
21699 
21703     readonly attribute wstring modulePath;
21704 
21705 }; /* interface IExtPackPlugIn */
21706 
21715 interface IExtPackBase : $unknown
21716 {
21720     readonly attribute wstring name;
21721 
21725     readonly attribute wstring description;
21726 
21738     readonly attribute wstring version;
21739 
21743     readonly attribute unsigned long revision;
21744 
21754     readonly attribute wstring edition;
21755 
21759     readonly attribute wstring VRDEModule;
21760 
21764     readonly attribute IExtPackPlugIn[] plugIns;
21765 
21775     readonly attribute boolean usable;
21776 
21783     readonly attribute wstring whyUnusable;
21784 
21788     readonly attribute boolean showLicense;
21789 
21798     readonly attribute wstring license;
21799 
21823     void queryLicense (
21824         in wstring preferredLocale,
21825         in wstring preferredLanguage,
21826         in wstring format,
21827         [retval] out wstring licenseText
21828     );
21829 
21830 }; /* interface IExtPackBase */
21831 
21840 interface IExtPack : IExtPackBase
21841 {
21853     void queryObject (
21854         in wstring objUuid,
21855         [retval] out $unknown returnInterface
21856     );
21857 
21858 }; /* interface IExtPack */
21859 
21869 interface IExtPackFile : IExtPackBase
21870 {
21876     readonly attribute wstring filePath;
21877 
21896     void install (
21897         in boolean replace,
21898         in wstring displayInfo,
21899         [retval] out IProgress progess
21900     );
21901 
21902 }; /* interface IExtPackFile */
21903 
21914 interface IExtPackManager : $unknown
21915 {
21921     readonly attribute IExtPack[] installedExtPacks;
21922 
21940     void find (
21941         in wstring name,
21942         [retval] out IExtPack returnData
21943     );
21944 
21956     void openExtPackFile (
21957         in wstring path,
21958         [retval] out IExtPackFile file
21959     );
21960 
21979     void uninstall (
21980         in wstring name,
21981         in boolean forcedRemoval,
21982         in wstring displayInfo,
21983         [retval] out IProgress progess
21984     );
21985 
21989     void cleanup();
21990 
22003     void queryAllPlugInsForFrontend (
22004         in wstring frontendName,
22005         [retval] out wstring[] plugInModules
22006     );
22007 
22015     void isExtPackUsable (
22016         in wstring name,
22017         [retval] out boolean usable
22018     );
22019 
22020 }; /* interface IExtPackManager */
22021 
22027 interface IBandwidthGroup : $unknown
22028 {
22032     readonly attribute wstring name;
22033 
22037     readonly attribute BandwidthGroupType type;
22038 
22042     readonly attribute unsigned long reference;
22043 
22048     attribute long long maxBytesPerSec;
22049 
22050 }; /* interface IBandwidthGroup */
22051 
22060 interface IBandwidthControl : $unknown
22061 {
22067     readonly attribute unsigned long numGroups;
22068 
22081     void createBandwidthGroup (
22082         in wstring name,
22083         in BandwidthGroupType type,
22084         in long long maxBytesPerSec
22085     );
22086 
22094     void deleteBandwidthGroup (
22095         in wstring name
22096     );
22097 
22107     void getBandwidthGroup (
22108         in wstring name,
22109         [retval] out IBandwidthGroup bandwidthGroup
22110     );
22111 
22119     void getAllBandwidthGroups (
22120         [retval] out IBandwidthGroup[] bandwidthGroups
22121     );
22122 
22123 }; /* interface IBandwidthControl */
22124 
22137 interface IVirtualBoxClient : $unknown
22138 {
22144     readonly attribute IVirtualBox virtualBox;
22145 
22151     readonly attribute ISession session;
22152 
22158     readonly attribute IEventSource eventSource;
22159 
22160 }; /* interface IVirtualBoxClient */
22161 
22175 interface IEventSource : $unknown
22176 {
22182     void createListener (
22183         [retval] out IEventListener listener
22184     );
22185 
22201     void createAggregator (
22202         in IEventSource[] subordinates,
22203         [retval] out IEventSource result
22204     );
22205 
22238     void registerListener (
22239         in IEventListener listener,
22240         in VBoxEventType[] interesting,
22241         in boolean active
22242     );
22243 
22252     void unregisterListener (
22253         in IEventListener listener
22254     );
22255 
22270     void fireEvent (
22271         in IEvent event,
22272         in long timeout,
22273         [retval] out boolean result
22274     );
22275 
22300     void getEvent (
22301         in IEventListener listener,
22302         in long timeout,
22303         [retval] out IEvent event
22304     );
22305 
22317     void eventProcessed (
22318         in IEventListener listener,
22319         in IEvent event
22320     );
22321 
22322 }; /* interface IEventSource */
22323 
22333 interface IEventListener : $unknown
22334 {
22347     void handleEvent (
22348         in IEvent event
22349     );
22350 
22351 }; /* interface IEventListener */
22352 
22429 interface IEvent : $unknown
22430 {
22436     readonly attribute VBoxEventType type;
22437 
22443     readonly attribute IEventSource source;
22444 
22455     readonly attribute boolean waitable;
22456 
22463     void setProcessed();
22464 
22478     void waitProcessed (
22479         in long timeout,
22480         [retval] out boolean result
22481     );
22482 
22483 }; /* interface IEvent */
22484 
22490 interface IReusableEvent : IEvent
22491 {
22495     readonly attribute unsigned long generation;
22496 
22503     void reuse();
22504 
22505 }; /* interface IReusableEvent */
22506 
22512 interface IMachineEvent : IEvent
22513 {
22517     readonly attribute wstringUUID machineId;
22518 
22519 }; /* interface IMachineEvent */
22520 
22526 interface IMachineStateChangedEvent : IMachineEvent
22527 {
22531     readonly attribute MachineState state;
22532 
22533 }; /* interface IMachineStateChangedEvent */
22534 
22542 interface IMachineDataChangedEvent : IMachineEvent
22543 {
22550     readonly attribute boolean temporary;
22551 
22552 }; /* interface IMachineDataChangedEvent */
22553 
22562 interface IMediumRegisteredEvent : IEvent
22563 {
22567     readonly attribute wstringUUID mediumId;
22568 
22572     readonly attribute DeviceType mediumType;
22573 
22580     readonly attribute boolean registered;
22581 
22582 }; /* interface IMediumRegisteredEvent */
22583 
22592 interface IMachineRegisteredEvent : IMachineEvent
22593 {
22600     readonly attribute boolean registered;
22601 
22602 }; /* interface IMachineRegisteredEvent */
22603 
22613 interface ISessionStateChangedEvent : IMachineEvent
22614 {
22620     readonly attribute SessionState state;
22621 
22622 }; /* interface ISessionStateChangedEvent */
22623 
22631 interface IGuestPropertyChangedEvent : IMachineEvent
22632 {
22638     readonly attribute wstring name;
22639 
22645     readonly attribute wstring value;
22646 
22652     readonly attribute wstring flags;
22653 
22654 }; /* interface IGuestPropertyChangedEvent */
22655 
22661 interface ISnapshotEvent : IMachineEvent
22662 {
22666     readonly attribute wstringUUID snapshotId;
22667 
22668 }; /* interface ISnapshotEvent */
22669 
22679 interface ISnapshotTakenEvent : ISnapshotEvent
22680 {
22681 }; /* interface ISnapshotTakenEvent */
22682 
22699 interface ISnapshotDeletedEvent : ISnapshotEvent
22700 {
22701 }; /* interface ISnapshotDeletedEvent */
22702 
22712 interface ISnapshotChangedEvent : ISnapshotEvent
22713 {
22714 }; /* interface ISnapshotChangedEvent */
22715 
22724 interface IMousePointerShapeChangedEvent : IEvent
22725 {
22731     readonly attribute boolean visible;
22732 
22738     readonly attribute boolean alpha;
22739 
22745     readonly attribute unsigned long xhot;
22746 
22752     readonly attribute unsigned long yhot;
22753 
22759     readonly attribute unsigned long width;
22760 
22766     readonly attribute unsigned long height;
22767 
22800     readonly attribute octet[] shape;
22801 
22802 }; /* interface IMousePointerShapeChangedEvent */
22803 
22812 interface IMouseCapabilityChangedEvent : IEvent
22813 {
22819     readonly attribute boolean supportsAbsolute;
22820 
22826     readonly attribute boolean supportsRelative;
22827 
22833     readonly attribute boolean needsHostCursor;
22834 
22835 }; /* interface IMouseCapabilityChangedEvent */
22836 
22845 interface IKeyboardLedsChangedEvent : IEvent
22846 {
22852     readonly attribute boolean numLock;
22853 
22859     readonly attribute boolean capsLock;
22860 
22866     readonly attribute boolean scrollLock;
22867 
22868 }; /* interface IKeyboardLedsChangedEvent */
22869 
22878 interface IStateChangedEvent : IEvent
22879 {
22885     readonly attribute MachineState state;
22886 
22887 }; /* interface IStateChangedEvent */
22888 
22898 interface IAdditionsStateChangedEvent : IEvent
22899 {
22900 }; /* interface IAdditionsStateChangedEvent */
22901 
22912 interface INetworkAdapterChangedEvent : IEvent
22913 {
22919     readonly attribute INetworkAdapter networkAdapter;
22920 
22921 }; /* interface INetworkAdapterChangedEvent */
22922 
22933 interface ISerialPortChangedEvent : IEvent
22934 {
22940     readonly attribute ISerialPort serialPort;
22941 
22942 }; /* interface ISerialPortChangedEvent */
22943 
22954 interface IParallelPortChangedEvent : IEvent
22955 {
22961     readonly attribute IParallelPort parallelPort;
22962 
22963 }; /* interface IParallelPortChangedEvent */
22964 
22974 interface IStorageControllerChangedEvent : IEvent
22975 {
22976 }; /* interface IStorageControllerChangedEvent */
22977 
22987 interface IMediumChangedEvent : IEvent
22988 {
22994     readonly attribute IMediumAttachment mediumAttachment;
22995 
22996 }; /* interface IMediumChangedEvent */
22997 
23005 interface IClipboardModeChangedEvent : IEvent
23006 {
23012     readonly attribute ClipboardMode clipboardMode;
23013 
23014 }; /* interface IClipboardModeChangedEvent */
23015 
23023 interface IDragAndDropModeChangedEvent : IEvent
23024 {
23030     readonly attribute DragAndDropMode dragAndDropMode;
23031 
23032 }; /* interface IDragAndDropModeChangedEvent */
23033 
23041 interface ICPUChangedEvent : IEvent
23042 {
23048     readonly attribute unsigned long CPU;
23049 
23055     readonly attribute boolean add;
23056 
23057 }; /* interface ICPUChangedEvent */
23058 
23066 interface ICPUExecutionCapChangedEvent : IEvent
23067 {
23073     readonly attribute unsigned long executionCap;
23074 
23075 }; /* interface ICPUExecutionCapChangedEvent */
23076 
23084 interface IGuestKeyboardEvent : IEvent
23085 {
23091     readonly attribute long[] scancodes;
23092 
23093 }; /* interface IGuestKeyboardEvent */
23094 
23102 interface IGuestMouseEvent : IReusableEvent
23103 {
23109     readonly attribute boolean absolute;
23110 
23116     readonly attribute long x;
23117 
23123     readonly attribute long y;
23124 
23130     readonly attribute long z;
23131 
23137     readonly attribute long w;
23138 
23144     readonly attribute long buttons;
23145 
23146 }; /* interface IGuestMouseEvent */
23147 
23158 interface IVRDEServerChangedEvent : IEvent
23159 {
23160 }; /* interface IVRDEServerChangedEvent */
23161 
23171 interface IVRDEServerInfoChangedEvent : IEvent
23172 {
23173 }; /* interface IVRDEServerInfoChangedEvent */
23174 
23185 interface IUSBControllerChangedEvent : IEvent
23186 {
23187 }; /* interface IUSBControllerChangedEvent */
23188 
23212 interface IUSBDeviceStateChangedEvent : IEvent
23213 {
23219     readonly attribute IUSBDevice device;
23220 
23226     readonly attribute boolean attached;
23227 
23233     readonly attribute IVirtualBoxErrorInfo error;
23234 
23235 }; /* interface IUSBDeviceStateChangedEvent */
23236 
23252 interface ISharedFolderChangedEvent : IEvent
23253 {
23259     readonly attribute Scope scope;
23260 
23261 }; /* interface ISharedFolderChangedEvent */
23262 
23314 interface IRuntimeErrorEvent : IEvent
23315 {
23321     readonly attribute boolean fatal;
23322 
23328     readonly attribute wstring id;
23329 
23335     readonly attribute wstring message;
23336 
23337 }; /* interface IRuntimeErrorEvent */
23338 
23346 interface IEventSourceChangedEvent : IEvent
23347 {
23353     readonly attribute IEventListener listener;
23354 
23360     readonly attribute boolean add;
23361 
23362 }; /* interface IEventSourceChangedEvent */
23363 
23372 interface IExtraDataChangedEvent : IEvent
23373 {
23380     readonly attribute wstringUUID machineId;
23381 
23387     readonly attribute wstring key;
23388 
23394     readonly attribute wstring value;
23395 
23396 }; /* interface IExtraDataChangedEvent */
23397 
23403 interface IVetoEvent : IEvent
23404 {
23414     void addVeto (
23415         in wstring reason
23416     );
23417 
23427     void isVetoed (
23428         [retval] out boolean result
23429     );
23430 
23440     void getVetos (
23441         [retval] out wstring[] result
23442     );
23443 
23444 }; /* interface IVetoEvent */
23445 
23455 interface IExtraDataCanChangeEvent : IVetoEvent
23456 {
23463     readonly attribute wstringUUID machineId;
23464 
23470     readonly attribute wstring key;
23471 
23477     readonly attribute wstring value;
23478 
23479 }; /* interface IExtraDataCanChangeEvent */
23480 
23496 interface ICanShowWindowEvent : IVetoEvent
23497 {
23498 }; /* interface ICanShowWindowEvent */
23499 
23531 interface IShowWindowEvent : IEvent
23532 {
23541     attribute long long winId;
23542 
23543 }; /* interface IShowWindowEvent */
23544 
23552 interface INATRedirectEvent : IMachineEvent
23553 {
23559     readonly attribute unsigned long slot;
23560 
23566     readonly attribute boolean remove;
23567 
23573     readonly attribute wstring name;
23574 
23580     readonly attribute NATProtocol proto;
23581 
23587     readonly attribute wstring hostIP;
23588 
23594     readonly attribute long hostPort;
23595 
23601     readonly attribute wstring guestIP;
23602 
23608     readonly attribute long guestPort;
23609 
23610 }; /* interface INATRedirectEvent */
23611 
23624 interface IHostPCIDevicePlugEvent : IMachineEvent
23625 {
23631     readonly attribute boolean plugged;
23632 
23639     readonly attribute boolean success;
23640 
23646     readonly attribute IPCIDeviceAttachment attachment;
23647 
23653     readonly attribute wstring message;
23654 
23655 }; /* interface IHostPCIDevicePlugEvent */
23656 
23665 interface IVBoxSVCAvailabilityChangedEvent : IEvent
23666 {
23672     readonly attribute boolean available;
23673 
23674 }; /* interface IVBoxSVCAvailabilityChangedEvent */
23675 
23683 interface IBandwidthGroupChangedEvent : IEvent
23684 {
23690     readonly attribute IBandwidthGroup bandwidthGroup;
23691 
23692 }; /* interface IBandwidthGroupChangedEvent */
23693 
23701 interface IGuestMonitorChangedEvent : IEvent
23702 {
23708     readonly attribute GuestMonitorChangedEventType changeType;
23709 
23715     readonly attribute unsigned long screenId;
23716 
23723     readonly attribute unsigned long originX;
23724 
23731     readonly attribute unsigned long originY;
23732 
23739     readonly attribute unsigned long width;
23740 
23747     readonly attribute unsigned long height;
23748 
23749 }; /* interface IGuestMonitorChangedEvent */
23750 
23760 interface IStorageDeviceChangedEvent : IEvent
23761 {
23767     readonly attribute IMediumAttachment storageDevice;
23768 
23774     readonly attribute boolean removed;
23775 
23776 }; /* interface IStorageDeviceChangedEvent */
23777 
23778 

Generated on Mon Aug 13 2012 13:04:24 for VirtualBox Main API by  doxygen 1.7.1