• 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,
02106 };
02107 
02115 enum ProcessPriority
02116 {
02121     ProcessPriority_Invalid = 0,
02126     ProcessPriority_Default = 1,
02127 };
02128 
02136 enum SymlinkType
02137 {
02142     SymlinkType_Unknown = 0,
02147     SymlinkType_Directory = 1,
02152     SymlinkType_File = 2,
02153 };
02154 
02162 enum SymlinkReadFlag
02163 {
02168     SymlinkReadFlag_None = 0,
02173     SymlinkReadFlag_NoSymlinks = 1,
02174 };
02175 
02183 enum ProcessStatus
02184 {
02189     ProcessStatus_Undefined = 0,
02194     ProcessStatus_Starting = 10,
02199     ProcessStatus_Started = 100,
02204     ProcessStatus_Paused = 110,
02209     ProcessStatus_Terminating = 480,
02214     ProcessStatus_TerminatedNormally = 500,
02219     ProcessStatus_TerminatedSignal = 510,
02224     ProcessStatus_TerminatedAbnormally = 511,
02229     ProcessStatus_TimedOutKilled = 512,
02234     ProcessStatus_TimedOutAbnormally = 513,
02239     ProcessStatus_Down = 600,
02244     ProcessStatus_Error = 800,
02245 };
02246 
02254 enum FsObjType
02255 {
02260     FsObjType_Undefined = 0,
02265     FsObjType_FIFO = 1,
02270     FsObjType_DevChar = 10,
02275     FsObjType_DevBlock = 11,
02280     FsObjType_Directory = 50,
02285     FsObjType_File = 80,
02290     FsObjType_Symlink = 100,
02295     FsObjType_Socket = 200,
02300     FsObjType_Whiteout = 400,
02301 };
02302 
02310 enum DragAndDropAction
02311 {
02316     DragAndDropAction_Ignore = 0,
02321     DragAndDropAction_Copy = 1,
02326     DragAndDropAction_Move = 2,
02331     DragAndDropAction_Link = 3,
02332 };
02333 
02341 enum DirectoryOpenFlag
02342 {
02347     DirectoryOpenFlag_None = 0,
02348 };
02349 
02357 enum GuestDirEntryType
02358 {
02363     GuestDirEntryType_Unknown = 0,
02368     GuestDirEntryType_Directory = 4,
02373     GuestDirEntryType_File = 10,
02378     GuestDirEntryType_Symlink = 12,
02379 };
02380 
02390 enum MediumState
02391 {
02399     MediumState_NotCreated = 0,
02408     MediumState_Created = 1,
02416     MediumState_LockedRead = 2,
02424     MediumState_LockedWrite = 3,
02434     MediumState_Inaccessible = 4,
02441     MediumState_Creating = 5,
02448     MediumState_Deleting = 6,
02449 };
02450 
02461 enum MediumType
02462 {
02470     MediumType_Normal = 0,
02478     MediumType_Immutable = 1,
02486     MediumType_Writethrough = 2,
02495     MediumType_Shareable = 3,
02504     MediumType_Readonly = 4,
02516     MediumType_MultiAttach = 5,
02517 };
02518 
02528 enum MediumVariant
02529 {
02536     MediumVariant_Standard = 0,
02543     MediumVariant_VmdkSplit2G = 0x01,
02550     MediumVariant_VmdkRawDisk = 0x02,
02558     MediumVariant_VmdkStreamOptimized = 0x04,
02565     MediumVariant_VmdkESX = 0x08,
02572     MediumVariant_Fixed = 0x10000,
02579     MediumVariant_Diff = 0x20000,
02587     MediumVariant_NoCreateDir = 0x40000000,
02588 };
02589 
02590 enum DataType
02591 {
02592     DataType_Int32 = 0,
02593     DataType_Int8 = 1,
02594     DataType_String = 2,
02595 };
02596 
02597 enum DataFlags
02598 {
02599     DataFlags_None = 0x00,
02600     DataFlags_Mandatory = 0x01,
02601     DataFlags_Expert = 0x02,
02602     DataFlags_Array = 0x04,
02603     DataFlags_FlagMask = 0x07,
02604 };
02605 
02613 enum MediumFormatCapabilities
02614 {
02621     MediumFormatCapabilities_Uuid = 0x01,
02628     MediumFormatCapabilities_CreateFixed = 0x02,
02636     MediumFormatCapabilities_CreateDynamic = 0x04,
02643     MediumFormatCapabilities_CreateSplit2G = 0x08,
02650     MediumFormatCapabilities_Differencing = 0x10,
02657     MediumFormatCapabilities_Asynchronous = 0x20,
02667     MediumFormatCapabilities_File = 0x40,
02676     MediumFormatCapabilities_Properties = 0x80,
02683     MediumFormatCapabilities_TcpNetworking = 0x100,
02690     MediumFormatCapabilities_VFS = 0x200,
02691     MediumFormatCapabilities_CapabilityMask = 0x3FF,
02692 };
02693 
02701 enum MouseButtonState
02702 {
02703     MouseButtonState_LeftButton = 0x01,
02704     MouseButtonState_RightButton = 0x02,
02705     MouseButtonState_MiddleButton = 0x04,
02706     MouseButtonState_WheelUp = 0x08,
02707     MouseButtonState_WheelDown = 0x10,
02708     MouseButtonState_XButton1 = 0x20,
02709     MouseButtonState_XButton2 = 0x40,
02710     MouseButtonState_MouseStateMask = 0x7F,
02711 };
02712 
02723 enum FramebufferPixelFormat
02724 {
02732     FramebufferPixelFormat_Opaque = 0,
02740     FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
02741 };
02742 
02750 enum NetworkAttachmentType
02751 {
02756     NetworkAttachmentType_Null = 0,
02757     NetworkAttachmentType_NAT = 1,
02758     NetworkAttachmentType_Bridged = 2,
02759     NetworkAttachmentType_Internal = 3,
02760     NetworkAttachmentType_HostOnly = 4,
02761     NetworkAttachmentType_Generic = 5,
02762 };
02763 
02771 enum NetworkAdapterType
02772 {
02777     NetworkAdapterType_Null = 0,
02782     NetworkAdapterType_Am79C970A = 1,
02787     NetworkAdapterType_Am79C973 = 2,
02792     NetworkAdapterType_I82540EM = 3,
02797     NetworkAdapterType_I82543GC = 4,
02802     NetworkAdapterType_I82545EM = 5,
02807     NetworkAdapterType_Virtio = 6,
02808 };
02809 
02817 enum NetworkAdapterPromiscModePolicy
02818 {
02823     NetworkAdapterPromiscModePolicy_Deny = 1,
02831     NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
02839     NetworkAdapterPromiscModePolicy_AllowAll = 3,
02840 };
02841 
02850 enum PortMode
02851 {
02856     PortMode_Disconnected = 0,
02861     PortMode_HostPipe = 1,
02866     PortMode_HostDevice = 2,
02871     PortMode_RawFile = 3,
02872 };
02873 
02912 enum USBDeviceState
02913 {
02920     USBDeviceState_NotSupported = 0,
02928     USBDeviceState_Unavailable = 1,
02935     USBDeviceState_Busy = 2,
02943     USBDeviceState_Available = 3,
02951     USBDeviceState_Held = 4,
02959     USBDeviceState_Captured = 5,
02960 };
02961 
02971 enum USBDeviceFilterAction
02972 {
02977     USBDeviceFilterAction_Null = 0,
02982     USBDeviceFilterAction_Ignore = 1,
02987     USBDeviceFilterAction_Hold = 2,
02988 };
02989 
02997 enum AudioDriverType
02998 {
03003     AudioDriverType_Null = 0,
03008     AudioDriverType_WinMM = 1,
03013     AudioDriverType_OSS = 2,
03018     AudioDriverType_ALSA = 3,
03023     AudioDriverType_DirectSound = 4,
03028     AudioDriverType_CoreAudio = 5,
03033     AudioDriverType_MMPM = 6,
03038     AudioDriverType_Pulse = 7,
03043     AudioDriverType_SolAudio = 8,
03044 };
03045 
03053 enum AudioControllerType
03054 {
03055     AudioControllerType_AC97 = 0,
03056     AudioControllerType_SB16 = 1,
03057     AudioControllerType_HDA = 2,
03058 };
03059 
03067 enum AuthType
03068 {
03073     AuthType_Null = 0,
03074     AuthType_External = 1,
03075     AuthType_Guest = 2,
03076 };
03077 
03086 enum StorageBus
03087 {
03092     StorageBus_Null = 0,
03093     StorageBus_IDE = 1,
03094     StorageBus_SATA = 2,
03095     StorageBus_SCSI = 3,
03096     StorageBus_Floppy = 4,
03097     StorageBus_SAS = 5,
03098 };
03099 
03108 enum StorageControllerType
03109 {
03114     StorageControllerType_Null = 0,
03119     StorageControllerType_LsiLogic = 1,
03124     StorageControllerType_BusLogic = 2,
03129     StorageControllerType_IntelAhci = 3,
03134     StorageControllerType_PIIX3 = 4,
03139     StorageControllerType_PIIX4 = 5,
03144     StorageControllerType_ICH6 = 6,
03149     StorageControllerType_I82078 = 7,
03154     StorageControllerType_LsiLogicSas = 8,
03155 };
03156 
03164 enum ChipsetType
03165 {
03170     ChipsetType_Null = 0,
03175     ChipsetType_PIIX3 = 1,
03180     ChipsetType_ICH9 = 2,
03181 };
03182 
03188 enum NATAliasMode
03189 {
03194     NATAliasMode_AliasLog = 0x1,
03199     NATAliasMode_AliasProxyOnly = 0x02,
03204     NATAliasMode_AliasUseSamePorts = 0x04,
03205 };
03206 
03212 enum NATProtocol
03213 {
03218     NATProtocol_UDP = 0,
03223     NATProtocol_TCP = 1,
03224 };
03225 
03233 enum BandwidthGroupType
03234 {
03241     BandwidthGroupType_Null = 0,
03248     BandwidthGroupType_Disk = 1,
03255     BandwidthGroupType_Network = 2,
03256 };
03257 
03266 enum VBoxEventType
03267 {
03274     VBoxEventType_Invalid = 0,
03283     VBoxEventType_Any = 1,
03291     VBoxEventType_Vetoable = 2,
03299     VBoxEventType_MachineEvent = 3,
03307     VBoxEventType_SnapshotEvent = 4,
03316     VBoxEventType_InputEvent = 5,
03323     VBoxEventType_LastWildcard = 31,
03330     VBoxEventType_OnMachineStateChanged = 32,
03337     VBoxEventType_OnMachineDataChanged = 33,
03344     VBoxEventType_OnExtraDataChanged = 34,
03351     VBoxEventType_OnExtraDataCanChange = 35,
03358     VBoxEventType_OnMediumRegistered = 36,
03365     VBoxEventType_OnMachineRegistered = 37,
03372     VBoxEventType_OnSessionStateChanged = 38,
03379     VBoxEventType_OnSnapshotTaken = 39,
03386     VBoxEventType_OnSnapshotDeleted = 40,
03393     VBoxEventType_OnSnapshotChanged = 41,
03400     VBoxEventType_OnGuestPropertyChanged = 42,
03407     VBoxEventType_OnMousePointerShapeChanged = 43,
03414     VBoxEventType_OnMouseCapabilityChanged = 44,
03421     VBoxEventType_OnKeyboardLedsChanged = 45,
03428     VBoxEventType_OnStateChanged = 46,
03435     VBoxEventType_OnAdditionsStateChanged = 47,
03442     VBoxEventType_OnNetworkAdapterChanged = 48,
03449     VBoxEventType_OnSerialPortChanged = 49,
03456     VBoxEventType_OnParallelPortChanged = 50,
03463     VBoxEventType_OnStorageControllerChanged = 51,
03470     VBoxEventType_OnMediumChanged = 52,
03477     VBoxEventType_OnVRDEServerChanged = 53,
03484     VBoxEventType_OnUSBControllerChanged = 54,
03491     VBoxEventType_OnUSBDeviceStateChanged = 55,
03498     VBoxEventType_OnSharedFolderChanged = 56,
03505     VBoxEventType_OnRuntimeError = 57,
03512     VBoxEventType_OnCanShowWindow = 58,
03519     VBoxEventType_OnShowWindow = 59,
03526     VBoxEventType_OnCPUChanged = 60,
03533     VBoxEventType_OnVRDEServerInfoChanged = 61,
03540     VBoxEventType_OnEventSourceChanged = 62,
03547     VBoxEventType_OnCPUExecutionCapChanged = 63,
03554     VBoxEventType_OnGuestKeyboard = 64,
03561     VBoxEventType_OnGuestMouse = 65,
03568     VBoxEventType_OnNATRedirect = 66,
03575     VBoxEventType_OnHostPCIDevicePlug = 67,
03582     VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
03589     VBoxEventType_OnBandwidthGroupChanged = 69,
03596     VBoxEventType_OnGuestMonitorChanged = 70,
03603     VBoxEventType_OnStorageDeviceChanged = 71,
03610     VBoxEventType_OnClipboardModeChanged = 72,
03617     VBoxEventType_OnDragAndDropModeChanged = 73,
03624     VBoxEventType_Last = 74,
03625 };
03626 
03634 enum GuestMonitorChangedEventType
03635 {
03642     GuestMonitorChangedEventType_Enabled = 0,
03649     GuestMonitorChangedEventType_Disabled = 1,
03656     GuestMonitorChangedEventType_NewOrigin = 2,
03657 };
03658 
03692 interface IVirtualBoxErrorInfo : $errorinfo
03693 {
03711     readonly attribute long resultCode;
03712 
03724     readonly attribute wstringUUID interfaceID;
03725 
03736     readonly attribute wstring component;
03737 
03748     readonly attribute wstring text;
03749 
03760     readonly attribute IVirtualBoxErrorInfo next;
03761 
03762 }; /* interface IVirtualBoxErrorInfo */
03763 
03774 interface IDHCPServer : $unknown
03775 {
03781     attribute boolean enabled;
03782 
03788     readonly attribute wstring IPAddress;
03789 
03795     readonly attribute wstring networkMask;
03796 
03802     readonly attribute wstring networkName;
03803 
03809     readonly attribute wstring lowerIP;
03810 
03816     readonly attribute wstring upperIP;
03817 
03846     void setConfiguration (
03847         in wstring IPAddress,
03848         in wstring networkMask,
03849         in wstring FromIPAddress,
03850         in wstring ToIPAddress
03851     );
03852 
03877     void start (
03878         in wstring networkName,
03879         in wstring trunkName,
03880         in wstring trunkType
03881     );
03882 
03895     void stop();
03896 
03897 }; /* interface IDHCPServer */
03898 
03917 interface IVirtualBox : $unknown
03918 {
03931     readonly attribute wstring version;
03932 
03938     readonly attribute unsigned long revision;
03939 
03949     readonly attribute wstring packageType;
03950 
03962     readonly attribute wstring APIVersion;
03963 
03979     readonly attribute wstring homeFolder;
03980 
03988     readonly attribute wstring settingsFilePath;
03989 
03993     readonly attribute IHost host;
03994 
03998     readonly attribute ISystemProperties systemProperties;
03999 
04005     readonly attribute IMachine[] machines;
04006 
04016     readonly attribute wstring[] machineGroups;
04017 
04027     readonly attribute IMedium[] hardDisks;
04028 
04034     readonly attribute IMedium[] DVDImages;
04035 
04041     readonly attribute IMedium[] floppyImages;
04042 
04043     readonly attribute IProgress[] progressOperations;
04044 
04045     readonly attribute IGuestOSType[] guestOSTypes;
04046 
04063     readonly attribute ISharedFolder[] sharedFolders;
04064 
04070     readonly attribute IPerformanceCollector performanceCollector;
04071 
04077     readonly attribute IDHCPServer[] DHCPServers;
04078 
04084     readonly attribute IEventSource eventSource;
04085 
04091     readonly attribute IExtPackManager extensionPackManager;
04092 
04098     readonly attribute wstring[] internalNetworks;
04099 
04105     readonly attribute wstring[] genericNetworkDrivers;
04106 
04155     void composeMachineFilename (
04156         in wstring name,
04157         in wstring group,
04158         in wstring baseFolder,
04159         [retval] out wstring file
04160     );
04161 
04264     void createMachine (
04265         in wstring settingsFile,
04266         in wstring name,
04267         in wstring[] groups,
04268         in wstring osTypeId,
04269         in wstringUUID id,
04270         in boolean forceOverwrite,
04271         [retval] out IMachine machine
04272     );
04273 
04299     void openMachine (
04300         in wstring settingsFile,
04301         [retval] out IMachine machine
04302     );
04303 
04335     void registerMachine (
04336         in IMachine machine
04337     );
04338 
04359     void findMachine (
04360         in wstring nameOrId,
04361         [retval] out IMachine machine
04362     );
04363 
04375     void getMachinesByGroups (
04376         in wstring[] groups,
04377         [retval] out IMachine[] machines
04378     );
04379 
04389     void getMachineStates (
04390         in IMachine[] machines,
04391         [retval] out MachineState[] states
04392     );
04393 
04403     void createAppliance (
04404         [retval] out IAppliance appliance
04405     );
04406 
04469     void createHardDisk (
04470         in wstring format,
04471         in wstring location,
04472         [retval] out IMedium medium
04473     );
04474 
04580     void openMedium (
04581         in wstring location,
04582         in DeviceType deviceType,
04583         in AccessMode accessMode,
04584         in boolean forceNewUuid,
04585         [retval] out IMedium medium
04586     );
04587 
04616     void getGuestOSType (
04617         in wstringUUID id,
04618         [retval] out IGuestOSType type
04619     );
04620 
04643     void createSharedFolder (
04644         in wstring name,
04645         in wstring hostPath,
04646         in boolean writable,
04647         in boolean automount
04648     );
04649 
04664     void removeSharedFolder (
04665         in wstring name
04666     );
04667 
04676     void getExtraDataKeys (
04677         [retval] out wstring[] value
04678     );
04679 
04708     void getExtraData (
04709         in wstring key,
04710         [retval] out wstring value
04711     );
04712 
04762     void setExtraData (
04763         in wstring key,
04764         in wstring value
04765     );
04766 
04785     void setSettingsSecret (
04786         in wstring password
04787     );
04788 
04805     void createDHCPServer (
04806         in wstring name,
04807         [retval] out IDHCPServer server
04808     );
04809 
04826     void findDHCPServerByNetworkName (
04827         in wstring name,
04828         [retval] out IDHCPServer server
04829     );
04830 
04845     void removeDHCPServer (
04846         in IDHCPServer server
04847     );
04848 
04873     void checkFirmwarePresent (
04874         in FirmwareType firmwareType,
04875         in wstring version,
04876         out wstring url,
04877         out wstring file,
04878         [retval] out boolean result
04879     );
04880 
04881 }; /* interface IVirtualBox */
04882 
04893 interface IVFSExplorer : $unknown
04894 {
04898     readonly attribute wstring path;
04899 
04903     readonly attribute VFSType type;
04904 
04912     void update (
04913         [retval] out IProgress aProgress
04914     );
04915 
04923     void cd (
04924         in wstring aDir,
04925         [retval] out IProgress aProgress
04926     );
04927 
04933     void cdUp (
04934         [retval] out IProgress aProgress
04935     );
04936 
04949     void entryList (
04950         out wstring[] aNames,
04951         out unsigned long[] aTypes,
04952         out unsigned long[] aSizes,
04953         out unsigned long[] aModes
04954     );
04955 
04964     void exists (
04965         in wstring[] aNames,
04966         [retval] out wstring[] aExists
04967     );
04968 
04976     void remove (
04977         in wstring[] aNames,
04978         [retval] out IProgress aProgress
04979     );
04980 
04981 }; /* interface IVFSExplorer */
04982 
05048 interface IAppliance : $unknown
05049 {
05057     readonly attribute wstring path;
05058 
05089     readonly attribute wstring[] disks;
05090 
05098     readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
05099 
05107     readonly attribute wstring[] machines;
05108 
05125     void read (
05126         in wstring file,
05127         [retval] out IProgress aProgress
05128     );
05129 
05146     void interpret();
05147 
05170     void importMachines (
05171         in ImportOptions[] options,
05172         [retval] out IProgress aProgress
05173     );
05174 
05182     void createVFSExplorer (
05183         in wstring aUri,
05184         [retval] out IVFSExplorer aExplorer
05185     );
05186 
05216     void write (
05217         in wstring format,
05218         in boolean manifest,
05219         in wstring path,
05220         [retval] out IProgress progress
05221     );
05222 
05228     void getWarnings (
05229         [retval] out wstring[] aWarnings
05230     );
05231 
05232 }; /* interface IAppliance */
05233 
05245 interface IVirtualSystemDescription : $unknown
05246 {
05250     readonly attribute unsigned long count;
05251 
05375     void getDescription (
05376         out VirtualSystemDescriptionType[] aTypes,
05377         out wstring[] aRefs,
05378         out wstring[] aOvfValues,
05379         out wstring[] aVBoxValues,
05380         out wstring[] aExtraConfigValues
05381     );
05382 
05399     void getDescriptionByType (
05400         in VirtualSystemDescriptionType aType,
05401         out VirtualSystemDescriptionType[] aTypes,
05402         out wstring[] aRefs,
05403         out wstring[] aOvfValues,
05404         out wstring[] aVBoxValues,
05405         out wstring[] aExtraConfigValues
05406     );
05407 
05419     void getValuesByType (
05420         in VirtualSystemDescriptionType aType,
05421         in VirtualSystemDescriptionValueType aWhich,
05422         [retval] out wstring[] aValues
05423     );
05424 
05450     void setFinalValues (
05451         in boolean[] aEnabled,
05452         in wstring[] aVBoxValues,
05453         in wstring[] aExtraConfigValues
05454     );
05455 
05470     void addDescription (
05471         in VirtualSystemDescriptionType aType,
05472         in wstring aVBoxValue,
05473         in wstring aExtraConfigValue
05474     );
05475 
05476 }; /* interface IVirtualSystemDescription */
05477 
05478 interface IInternalMachineControl : $unknown
05479 {
05486     void setRemoveSavedStateFile (
05487         in boolean aRemove
05488     );
05489 
05501     void updateState (
05502         in MachineState state
05503     );
05504 
05505     void getIPCId (
05506         [retval] out wstring id
05507     );
05508 
05520     void beginPowerUp (
05521         in IProgress aProgress
05522     );
05523 
05533     void endPowerUp (
05534         in long result
05535     );
05536 
05548     void beginPoweringDown (
05549         out IProgress progress
05550     );
05551 
05581     void endPoweringDown (
05582         in long result,
05583         in wstring errMsg
05584     );
05585 
05599     void runUSBDeviceFilters (
05600         in IUSBDevice device,
05601         out boolean matched,
05602         out unsigned long maskedInterfaces
05603     );
05604 
05613     void captureUSBDevice (
05614         in wstringUUID id
05615     );
05616 
05632     void detachUSBDevice (
05633         in wstringUUID id,
05634         in boolean done
05635     );
05636 
05645     void autoCaptureUSBDevices();
05646 
05662     void detachAllUSBDevices (
05663         in boolean done
05664     );
05665 
05680     void onSessionEnd (
05681         in ISession session,
05682         [retval] out IProgress progress
05683     );
05684 
05700     void beginSavingState (
05701         out IProgress progress,
05702         out wstring stateFilePath
05703     );
05704 
05734     void endSavingState (
05735         in long result,
05736         in wstring errMsg
05737     );
05738 
05753     void adoptSavedState (
05754         in wstring savedStateFile
05755     );
05756 
05805     void beginTakingSnapshot (
05806         in IConsole initiator,
05807         in wstring name,
05808         in wstring description,
05809         in IProgress consoleProgress,
05810         in boolean fTakingSnapshotOnline,
05811         out wstring stateFilePath
05812     );
05813 
05823     void endTakingSnapshot (
05824         in boolean success
05825     );
05826 
05855     void deleteSnapshot (
05856         in IConsole initiator,
05857         in wstringUUID startId,
05858         in wstringUUID endId,
05859         in boolean deleteAllChildren,
05860         out MachineState machineState,
05861         [retval] out IProgress progress
05862     );
05863 
05882     void finishOnlineMergeMedium (
05883         in IMediumAttachment mediumAttachment,
05884         in IMedium source,
05885         in IMedium target,
05886         in boolean mergeForward,
05887         in IMedium parentForTarget,
05888         in IMedium[] childrenToReparent
05889     );
05890 
05904     void restoreSnapshot (
05905         in IConsole initiator,
05906         in ISnapshot snapshot,
05907         out MachineState machineState,
05908         [retval] out IProgress progress
05909     );
05910 
05937     void pullGuestProperties (
05938         out wstring[] name,
05939         out wstring[] value,
05940         out long long[] timestamp,
05941         out wstring[] flags
05942     );
05943 
05965     void pushGuestProperty (
05966         in wstring name,
05967         in wstring value,
05968         in long long timestamp,
05969         in wstring flags
05970     );
05971 
05983     void lockMedia();
05984 
05994     void unlockMedia();
05995 
06011     void ejectMedium (
06012         in IMediumAttachment attachment,
06013         [retval] out IMediumAttachment newAttachment
06014     );
06015 
06052     void reportGuestStatistics (
06053         in unsigned long validStats,
06054         in unsigned long cpuUser,
06055         in unsigned long cpuKernel,
06056         in unsigned long cpuIdle,
06057         in unsigned long memTotal,
06058         in unsigned long memFree,
06059         in unsigned long memBalloon,
06060         in unsigned long memShared,
06061         in unsigned long memCache,
06062         in unsigned long pagedTotal,
06063         in unsigned long memAllocTotal,
06064         in unsigned long memFreeTotal,
06065         in unsigned long memBalloonTotal,
06066         in unsigned long memSharedTotal
06067     );
06068 
06069 }; /* interface IInternalMachineControl */
06070 
06079 interface IBIOSSettings : $unknown
06080 {
06084     attribute boolean logoFadeIn;
06085 
06089     attribute boolean logoFadeOut;
06090 
06094     attribute unsigned long logoDisplayTime;
06095 
06102     attribute wstring logoImagePath;
06103 
06107     attribute BIOSBootMenuMode bootMenuMode;
06108 
06112     attribute boolean ACPIEnabled;
06113 
06120     attribute boolean IOAPICEnabled;
06121 
06131     attribute long long timeOffset;
06132 
06139     attribute boolean PXEDebugEnabled;
06140 
06141 }; /* interface IBIOSSettings */
06142 
06150 interface IPCIAddress : $unknown
06151 {
06157     attribute short bus;
06158 
06164     attribute short device;
06165 
06171     attribute short devFunction;
06172 
06178     void asLong (
06179         [retval] out long result
06180     );
06181 
06187     void fromLong (
06188         in long number
06189     );
06190 
06191 }; /* interface IPCIAddress */
06192 
06200 interface IPCIDeviceAttachment : $unknown
06201 {
06207     readonly attribute wstring name;
06208 
06214     readonly attribute boolean isPhysicalDevice;
06215 
06221     readonly attribute long hostAddress;
06222 
06228     readonly attribute long guestAddress;
06229 
06230 }; /* interface IPCIDeviceAttachment */
06231 
06272 interface IMachine : $unknown
06273 {
06277     readonly attribute IVirtualBox parent;
06278 
06328     readonly attribute boolean accessible;
06329 
06341     readonly attribute IVirtualBoxErrorInfo accessError;
06342 
06382     attribute wstring name;
06383 
06394     attribute wstring description;
06395 
06399     readonly attribute wstringUUID id;
06400 
06411     attribute wstring[] groups;
06412 
06427     attribute wstring OSTypeId;
06428 
06432     attribute wstring hardwareVersion;
06433 
06443     attribute wstringUUID hardwareUUID;
06444 
06448     attribute unsigned long CPUCount;
06449 
06455     attribute boolean CPUHotPlugEnabled;
06456 
06464     attribute unsigned long CPUExecutionCap;
06465 
06469     attribute unsigned long memorySize;
06470 
06474     attribute unsigned long memoryBalloonSize;
06475 
06482     attribute boolean pageFusionEnabled;
06483 
06487     attribute unsigned long VRAMSize;
06488 
06494     attribute boolean accelerate3DEnabled;
06495 
06501     attribute boolean accelerate2DVideoEnabled;
06502 
06513     attribute unsigned long monitorCount;
06514 
06518     readonly attribute IBIOSSettings BIOSSettings;
06519 
06524     attribute FirmwareType firmwareType;
06525 
06531     attribute PointingHIDType pointingHIDType;
06532 
06538     attribute KeyboardHIDType keyboardHIDType;
06539 
06546     attribute boolean HPETEnabled;
06547 
06551     attribute ChipsetType chipsetType;
06552 
06586     attribute wstring snapshotFolder;
06587 
06591     readonly attribute IVRDEServer VRDEServer;
06592 
06593     attribute boolean emulatedUSBWebcameraEnabled;
06594 
06595     attribute boolean emulatedUSBCardReaderEnabled;
06596 
06600     readonly attribute IMediumAttachment[] mediumAttachments;
06601 
06613     readonly attribute IUSBController USBController;
06614 
06618     readonly attribute IAudioAdapter audioAdapter;
06619 
06623     readonly attribute IStorageController[] storageControllers;
06624 
06630     readonly attribute wstring settingsFilePath;
06631 
06656     readonly attribute boolean settingsModified;
06657 
06661     readonly attribute SessionState sessionState;
06662 
06675     readonly attribute wstring sessionType;
06676 
06686     readonly attribute unsigned long sessionPID;
06687 
06691     readonly attribute MachineState state;
06692 
06699     readonly attribute long long lastStateChange;
06700 
06712     readonly attribute wstring stateFilePath;
06713 
06723     readonly attribute wstring logFolder;
06724 
06735     readonly attribute ISnapshot currentSnapshot;
06736 
06743     readonly attribute unsigned long snapshotCount;
06744 
06776     readonly attribute boolean currentStateModified;
06777 
06789     readonly attribute ISharedFolder[] sharedFolders;
06790 
06797     attribute ClipboardMode clipboardMode;
06798 
06804     attribute DragAndDropMode dragAndDropMode;
06805 
06813     attribute wstring guestPropertyNotificationPatterns;
06814 
06823     attribute boolean teleporterEnabled;
06824 
06835     attribute unsigned long teleporterPort;
06836 
06843     attribute wstring teleporterAddress;
06844 
06855     attribute wstring teleporterPassword;
06856 
06864     attribute FaultToleranceState faultToleranceState;
06865 
06872     attribute unsigned long faultTolerancePort;
06873 
06879     attribute wstring faultToleranceAddress;
06880 
06888     attribute wstring faultTolerancePassword;
06889 
06895     attribute unsigned long faultToleranceSyncInterval;
06896 
06904     attribute boolean RTCUseUTC;
06905 
06912     attribute boolean IOCacheEnabled;
06913 
06919     attribute unsigned long IOCacheSize;
06920 
06930     readonly attribute IPCIDeviceAttachment[] PCIDeviceAssignments;
06931 
06937     readonly attribute IBandwidthControl bandwidthControl;
06938 
06947     attribute boolean tracingEnabled;
06948 
06963     attribute wstring tracingConfig;
06964 
06977     attribute boolean allowTracingToAccessVM;
06978 
06984     attribute boolean autostartEnabled;
06985 
06991     attribute unsigned long autostartDelay;
06992 
06998     attribute AutostopType autostopType;
06999 
07105     void lockMachine (
07106         in ISession session,
07107         in LockType lockType
07108     );
07109 
07239     void launchVMProcess (
07240         in ISession session,
07241         in wstring type,
07242         in wstring environment,
07243         [retval] out IProgress progress
07244     );
07245 
07283     void setBootOrder (
07284         in unsigned long position,
07285         in DeviceType device
07286     );
07287 
07322     void getBootOrder (
07323         in unsigned long position,
07324         [retval] out DeviceType device
07325     );
07326 
07428     void attachDevice (
07429         in wstring name,
07430         in long controllerPort,
07431         in long device,
07432         in DeviceType type,
07433         in IMedium medium
07434     );
07435 
07531     void attachDeviceWithoutMedium (
07532         in wstring name,
07533         in long controllerPort,
07534         in long device,
07535         in DeviceType type
07536     );
07537 
07591     void detachDevice (
07592         in wstring name,
07593         in long controllerPort,
07594         in long device
07595     );
07596 
07639     void passthroughDevice (
07640         in wstring name,
07641         in long controllerPort,
07642         in long device,
07643         in boolean passthrough
07644     );
07645 
07688     void temporaryEjectDevice (
07689         in wstring name,
07690         in long controllerPort,
07691         in long device,
07692         in boolean temporaryEject
07693     );
07694 
07740     void nonRotationalDevice (
07741         in wstring name,
07742         in long controllerPort,
07743         in long device,
07744         in boolean nonRotational
07745     );
07746 
07792     void setAutoDiscardForDevice (
07793         in wstring name,
07794         in long controllerPort,
07795         in long device,
07796         in boolean discard
07797     );
07798 
07839     void setBandwidthGroupForDevice (
07840         in wstring name,
07841         in long controllerPort,
07842         in long device,
07843         in IBandwidthGroup bandwidthGroup
07844     );
07845 
07882     void setNoBandwidthGroupForDevice (
07883         in wstring name,
07884         in long controllerPort,
07885         in long device
07886     );
07887 
07952     void unmountMedium (
07953         in wstring name,
07954         in long controllerPort,
07955         in long device,
07956         in boolean force
07957     );
07958 
08021     void mountMedium (
08022         in wstring name,
08023         in long controllerPort,
08024         in long device,
08025         in IMedium medium,
08026         in boolean force
08027     );
08028 
08057     void getMedium (
08058         in wstring name,
08059         in long controllerPort,
08060         in long device,
08061         [retval] out IMedium medium
08062     );
08063 
08078     void getMediumAttachmentsOfController (
08079         in wstring name,
08080         [retval] out IMediumAttachment[] mediumAttachments
08081     );
08082 
08097     void getMediumAttachment (
08098         in wstring name,
08099         in long controllerPort,
08100         in long device,
08101         [retval] out IMediumAttachment attachment
08102     );
08103 
08144     void attachHostPCIDevice (
08145         in long hostAddress,
08146         in long desiredGuestAddress,
08147         in boolean tryToUnbind
08148     );
08149 
08190     void detachHostPCIDevice (
08191         in long hostAddress
08192     );
08193 
08211     void getNetworkAdapter (
08212         in unsigned long slot,
08213         [retval] out INetworkAdapter adapter
08214     );
08215 
08248     void addStorageController (
08249         in wstring name,
08250         in StorageBus connectionType,
08251         [retval] out IStorageController controller
08252     );
08253 
08267     void getStorageControllerByName (
08268         in wstring name,
08269         [retval] out IStorageController storageController
08270     );
08271 
08285     void getStorageControllerByInstance (
08286         in unsigned long instance,
08287         [retval] out IStorageController storageController
08288     );
08289 
08312     void removeStorageController (
08313         in wstring name
08314     );
08315 
08337     void setStorageControllerBootable (
08338         in wstring name,
08339         in boolean bootable
08340     );
08341 
08359     void getSerialPort (
08360         in unsigned long slot,
08361         [retval] out ISerialPort port
08362     );
08363 
08381     void getParallelPort (
08382         in unsigned long slot,
08383         [retval] out IParallelPort port
08384     );
08385 
08394     void getExtraDataKeys (
08395         [retval] out wstring[] value
08396     );
08397 
08426     void getExtraData (
08427         in wstring key,
08428         [retval] out wstring value
08429     );
08430 
08480     void setExtraData (
08481         in wstring key,
08482         in wstring value
08483     );
08484 
08506     void getCPUProperty (
08507         in CPUPropertyType property,
08508         [retval] out boolean value
08509     );
08510 
08532     void setCPUProperty (
08533         in CPUPropertyType property,
08534         in boolean value
08535     );
08536 
08576     void getCPUIDLeaf (
08577         in unsigned long id,
08578         out unsigned long valEax,
08579         out unsigned long valEbx,
08580         out unsigned long valEcx,
08581         out unsigned long valEdx
08582     );
08583 
08627     void setCPUIDLeaf (
08628         in unsigned long id,
08629         in unsigned long valEax,
08630         in unsigned long valEbx,
08631         in unsigned long valEcx,
08632         in unsigned long valEdx
08633     );
08634 
08652     void removeCPUIDLeaf (
08653         in unsigned long id
08654     );
08655 
08661     void removeAllCPUIDLeaves();
08662 
08684     void getHWVirtExProperty (
08685         in HWVirtExPropertyType property,
08686         [retval] out boolean value
08687     );
08688 
08710     void setHWVirtExProperty (
08711         in HWVirtExPropertyType property,
08712         in boolean value
08713     );
08714 
08760     void saveSettings();
08761 
08785     void discardSettings();
08786 
08870     void unregister (
08871         in CleanupMode cleanupMode,
08872         [retval] out IMedium[] aMedia
08873     );
08874 
08931     void delete (
08932         in IMedium[] aMedia,
08933         [retval] out IProgress aProgress
08934     );
08935 
08947     void export (
08948         in IAppliance aAppliance,
08949         in wstring location,
08950         [retval] out IVirtualSystemDescription aDescription
08951     );
08952 
08976     void findSnapshot (
08977         in wstring nameOrId,
08978         [retval] out ISnapshot snapshot
08979     );
08980 
09014     void createSharedFolder (
09015         in wstring name,
09016         in wstring hostPath,
09017         in boolean writable,
09018         in boolean automount
09019     );
09020 
09046     void removeSharedFolder (
09047         in wstring name
09048     );
09049 
09073     void canShowConsoleWindow (
09074         [retval] out boolean canShow
09075     );
09076 
09111     void showConsoleWindow (
09112         [retval] out long long winId
09113     );
09114 
09147     void getGuestProperty (
09148         in wstring name,
09149         out wstring value,
09150         out long long timestamp,
09151         out wstring flags
09152     );
09153 
09176     void getGuestPropertyValue (
09177         in wstring property,
09178         [retval] out wstring value
09179     );
09180 
09203     void getGuestPropertyTimestamp (
09204         in wstring property,
09205         [retval] out long long value
09206     );
09207 
09258     void setGuestProperty (
09259         in wstring property,
09260         in wstring value,
09261         in wstring flags
09262     );
09263 
09304     void setGuestPropertyValue (
09305         in wstring property,
09306         in wstring value
09307     );
09308 
09326     void deleteGuestProperty (
09327         in wstring name
09328     );
09329 
09360     void enumerateGuestProperties (
09361         in wstring patterns,
09362         out wstring[] name,
09363         out wstring[] value,
09364         out long long[] timestamp,
09365         out wstring[] flags
09366     );
09367 
09397     void querySavedGuestScreenInfo (
09398         in unsigned long screenId,
09399         out unsigned long originX,
09400         out unsigned long originY,
09401         out unsigned long width,
09402         out unsigned long height,
09403         out boolean enabled
09404     );
09405 
09427     void querySavedThumbnailSize (
09428         in unsigned long screenId,
09429         out unsigned long size,
09430         out unsigned long width,
09431         out unsigned long height
09432     );
09433 
09460     void readSavedThumbnailToArray (
09461         in unsigned long screenId,
09462         in boolean BGR,
09463         out unsigned long width,
09464         out unsigned long height,
09465         [retval] out octet[] data
09466     );
09467 
09489     void readSavedThumbnailPNGToArray (
09490         in unsigned long screenId,
09491         out unsigned long width,
09492         out unsigned long height,
09493         [retval] out octet[] data
09494     );
09495 
09517     void querySavedScreenshotPNGSize (
09518         in unsigned long screenId,
09519         out unsigned long size,
09520         out unsigned long width,
09521         out unsigned long height
09522     );
09523 
09545     void readSavedScreenshotPNGToArray (
09546         in unsigned long screenId,
09547         out unsigned long width,
09548         out unsigned long height,
09549         [retval] out octet[] data
09550     );
09551 
09561     void hotPlugCPU (
09562         in unsigned long cpu
09563     );
09564 
09574     void hotUnplugCPU (
09575         in unsigned long cpu
09576     );
09577 
09591     void getCPUStatus (
09592         in unsigned long cpu,
09593         [retval] out boolean attached
09594     );
09595 
09610     void queryLogFilename (
09611         in unsigned long idx,
09612         [retval] out wstring filename
09613     );
09614 
09640     void readLog (
09641         in unsigned long idx,
09642         in long long offset,
09643         in long long size,
09644         [retval] out octet[] data
09645     );
09646 
09679     void cloneTo (
09680         in IMachine target,
09681         in CloneMode mode,
09682         in CloneOptions[] options,
09683         [retval] out IProgress progress
09684     );
09685 
09686 }; /* interface IMachine */
09687 
09696 interface IVRDEServerInfo : $unknown
09697 {
09703     readonly attribute boolean active;
09704 
09713     readonly attribute long port;
09714 
09720     readonly attribute unsigned long numberOfClients;
09721 
09727     readonly attribute long long beginTime;
09728 
09735     readonly attribute long long endTime;
09736 
09742     readonly attribute long long bytesSent;
09743 
09749     readonly attribute long long bytesSentTotal;
09750 
09756     readonly attribute long long bytesReceived;
09757 
09763     readonly attribute long long bytesReceivedTotal;
09764 
09770     readonly attribute wstring user;
09771 
09777     readonly attribute wstring domain;
09778 
09784     readonly attribute wstring clientName;
09785 
09791     readonly attribute wstring clientIP;
09792 
09798     readonly attribute unsigned long clientVersion;
09799 
09807     readonly attribute unsigned long encryptionStyle;
09808 
09809 }; /* interface IVRDEServerInfo */
09810 
09832 interface IConsole : $unknown
09833 {
09845     readonly attribute IMachine machine;
09846 
09860     readonly attribute MachineState state;
09861 
09865     readonly attribute IGuest guest;
09866 
09877     readonly attribute IKeyboard keyboard;
09878 
09889     readonly attribute IMouse mouse;
09890 
09900     readonly attribute IDisplay display;
09901 
09905     readonly attribute IMachineDebugger debugger;
09906 
09917     readonly attribute IUSBDevice[] USBDevices;
09918 
09926     readonly attribute IHostUSBDevice[] remoteUSBDevices;
09927 
09943     readonly attribute ISharedFolder[] sharedFolders;
09944 
09950     readonly attribute IVRDEServerInfo VRDEServerInfo;
09951 
09957     readonly attribute IEventSource eventSource;
09958 
09962     readonly attribute IPCIDeviceAttachment[] attachedPCIDevices;
09963 
09972     attribute boolean useHostClipboard;
09973 
10038     void powerUp (
10039         [retval] out IProgress progress
10040     );
10041 
10075     void powerUpPaused (
10076         [retval] out IProgress progress
10077     );
10078 
10098     void powerDown (
10099         [retval] out IProgress progress
10100     );
10101 
10121     void reset();
10122 
10142     void pause();
10143 
10163     void resume();
10164 
10184     void powerButton();
10185 
10205     void sleepButton();
10206 
10218     void getPowerButtonHandled (
10219         [retval] out boolean handled
10220     );
10221 
10235     void getGuestEnteredACPIMode (
10236         [retval] out boolean entered
10237     );
10238 
10291     void saveState (
10292         [retval] out IProgress progress
10293     );
10294 
10327     void adoptSavedState (
10328         in wstring savedStateFile
10329     );
10330 
10361     void discardSavedState (
10362         in boolean fRemoveFile
10363     );
10364 
10377     void getDeviceActivity (
10378         in DeviceType type,
10379         [retval] out DeviceActivity activity
10380     );
10381 
10419     void attachUSBDevice (
10420         in wstringUUID id
10421     );
10422 
10457     void detachUSBDevice (
10458         in wstringUUID id,
10459         [retval] out IUSBDevice device
10460     );
10461 
10484     void findUSBDeviceByAddress (
10485         in wstring name,
10486         [retval] out IUSBDevice device
10487     );
10488 
10508     void findUSBDeviceById (
10509         in wstringUUID id,
10510         [retval] out IUSBDevice device
10511     );
10512 
10546     void createSharedFolder (
10547         in wstring name,
10548         in wstring hostPath,
10549         in boolean writable,
10550         in boolean automount
10551     );
10552 
10577     void removeSharedFolder (
10578         in wstring name
10579     );
10580 
10618     void takeSnapshot (
10619         in wstring name,
10620         in wstring description,
10621         [retval] out IProgress progress
10622     );
10623 
10696     void deleteSnapshot (
10697         in wstringUUID id,
10698         [retval] out IProgress progress
10699     );
10700 
10740     void deleteSnapshotAndAllChildren (
10741         in wstringUUID id,
10742         [retval] out IProgress progress
10743     );
10744 
10788     void deleteSnapshotRange (
10789         in wstringUUID startId,
10790         in wstringUUID endId,
10791         [retval] out IProgress progress
10792     );
10793 
10834     void restoreSnapshot (
10835         in ISnapshot snapshot,
10836         [retval] out IProgress progress
10837     );
10838 
10877     void teleport (
10878         in wstring hostname,
10879         in unsigned long tcpport,
10880         in wstring password,
10881         in unsigned long maxDowntime,
10882         [retval] out IProgress progress
10883     );
10884 
10885 }; /* interface IConsole */
10886 
10897 interface IHostNetworkInterface : $unknown
10898 {
10902     readonly attribute wstring name;
10903 
10907     readonly attribute wstringUUID id;
10908 
10912     readonly attribute wstring networkName;
10913 
10917     readonly attribute boolean DHCPEnabled;
10918 
10922     readonly attribute wstring IPAddress;
10923 
10927     readonly attribute wstring networkMask;
10928 
10932     readonly attribute boolean IPV6Supported;
10933 
10937     readonly attribute wstring IPV6Address;
10938 
10942     readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
10943 
10947     readonly attribute wstring hardwareAddress;
10948 
10952     readonly attribute HostNetworkInterfaceMediumType mediumType;
10953 
10957     readonly attribute HostNetworkInterfaceStatus status;
10958 
10962     readonly attribute HostNetworkInterfaceType interfaceType;
10963 
10975     void enableStaticIPConfig (
10976         in wstring IPAddress,
10977         in wstring networkMask
10978     );
10979 
10991     void enableStaticIPConfigV6 (
10992         in wstring IPV6Address,
10993         in unsigned long IPV6NetworkMaskPrefixLength
10994     );
10995 
10999     void enableDynamicIPConfig();
11000 
11004     void DHCPRediscover();
11005 
11006 }; /* interface IHostNetworkInterface */
11007 
11024 interface IHost : $unknown
11025 {
11029     readonly attribute IMedium[] DVDDrives;
11030 
11034     readonly attribute IMedium[] floppyDrives;
11035 
11049     readonly attribute IHostUSBDevice[] USBDevices;
11050 
11074     readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
11075 
11079     readonly attribute IHostNetworkInterface[] networkInterfaces;
11080 
11084     readonly attribute unsigned long processorCount;
11085 
11089     readonly attribute unsigned long processorOnlineCount;
11090 
11094     readonly attribute unsigned long processorCoreCount;
11095 
11099     readonly attribute unsigned long memorySize;
11100 
11104     readonly attribute unsigned long memoryAvailable;
11105 
11109     readonly attribute wstring operatingSystem;
11110 
11114     readonly attribute wstring OSVersion;
11115 
11119     readonly attribute long long UTCTime;
11120 
11124     readonly attribute boolean acceleration3DAvailable;
11125 
11140     void getProcessorSpeed (
11141         in unsigned long cpuId,
11142         [retval] out unsigned long speed
11143     );
11144 
11156     void getProcessorFeature (
11157         in ProcessorFeature feature,
11158         [retval] out boolean supported
11159     );
11160 
11179     void getProcessorDescription (
11180         in unsigned long cpuId,
11181         [retval] out wstring description
11182     );
11183 
11224     void getProcessorCPUIDLeaf (
11225         in unsigned long cpuId,
11226         in unsigned long leaf,
11227         in unsigned long subLeaf,
11228         out unsigned long valEax,
11229         out unsigned long valEbx,
11230         out unsigned long valEcx,
11231         out unsigned long valEdx
11232     );
11233 
11254     void createHostOnlyNetworkInterface (
11255         out IHostNetworkInterface hostInterface,
11256         [retval] out IProgress progress
11257     );
11258 
11279     void removeHostOnlyNetworkInterface (
11280         in wstringUUID id,
11281         [retval] out IProgress progress
11282     );
11283 
11303     void createUSBDeviceFilter (
11304         in wstring name,
11305         [retval] out IHostUSBDeviceFilter filter
11306     );
11307 
11350     void insertUSBDeviceFilter (
11351         in unsigned long position,
11352         in IHostUSBDeviceFilter filter
11353     );
11354 
11382     void removeUSBDeviceFilter (
11383         in unsigned long position
11384     );
11385 
11403     void findHostDVDDrive (
11404         in wstring name,
11405         [retval] out IMedium drive
11406     );
11407 
11425     void findHostFloppyDrive (
11426         in wstring name,
11427         [retval] out IMedium drive
11428     );
11429 
11445     void findHostNetworkInterfaceByName (
11446         in wstring name,
11447         [retval] out IHostNetworkInterface networkInterface
11448     );
11449 
11465     void findHostNetworkInterfaceById (
11466         in wstringUUID id,
11467         [retval] out IHostNetworkInterface networkInterface
11468     );
11469 
11479     void findHostNetworkInterfacesOfType (
11480         in HostNetworkInterfaceType type,
11481         [retval] out IHostNetworkInterface[] networkInterfaces
11482     );
11483 
11503     void findUSBDeviceById (
11504         in wstringUUID id,
11505         [retval] out IHostUSBDevice device
11506     );
11507 
11530     void findUSBDeviceByAddress (
11531         in wstring name,
11532         [retval] out IHostUSBDevice device
11533     );
11534 
11542     void generateMACAddress (
11543         [retval] out wstring address
11544     );
11545 
11546 }; /* interface IHost */
11547 
11560 interface ISystemProperties : $unknown
11561 {
11565     readonly attribute unsigned long minGuestRAM;
11566 
11570     readonly attribute unsigned long maxGuestRAM;
11571 
11575     readonly attribute unsigned long minGuestVRAM;
11576 
11580     readonly attribute unsigned long maxGuestVRAM;
11581 
11585     readonly attribute unsigned long minGuestCPUCount;
11586 
11590     readonly attribute unsigned long maxGuestCPUCount;
11591 
11595     readonly attribute unsigned long maxGuestMonitors;
11596 
11601     readonly attribute long long infoVDSize;
11602 
11609     readonly attribute unsigned long serialPortCount;
11610 
11617     readonly attribute unsigned long parallelPortCount;
11618 
11628     readonly attribute unsigned long maxBootPosition;
11629 
11653     attribute wstring defaultMachineFolder;
11654 
11679     readonly attribute IMediumFormat[] mediumFormats;
11680 
11714     attribute wstring defaultHardDiskFormat;
11715 
11721     attribute long long freeDiskSpaceWarning;
11722 
11727     attribute unsigned long freeDiskSpacePercentWarning;
11728 
11734     attribute long long freeDiskSpaceError;
11735 
11740     attribute unsigned long freeDiskSpacePercentError;
11741 
11765     attribute wstring VRDEAuthLibrary;
11766 
11795     attribute wstring webServiceAuthLibrary;
11796 
11810     attribute wstring defaultVRDEExtPack;
11811 
11817     attribute unsigned long logHistoryCount;
11818 
11823     readonly attribute AudioDriverType defaultAudioDriver;
11824 
11831     attribute wstring autostartDatabasePath;
11832 
11843     void getMaxNetworkAdapters (
11844         in ChipsetType chipset,
11845         [retval] out unsigned long maxNetworkAdapters
11846     );
11847 
11861     void getMaxNetworkAdaptersOfType (
11862         in ChipsetType chipset,
11863         in NetworkAttachmentType type,
11864         [retval] out unsigned long maxNetworkAdapters
11865     );
11866 
11876     void getMaxDevicesPerPortForStorageBus (
11877         in StorageBus bus,
11878         [retval] out unsigned long maxDevicesPerPort
11879     );
11880 
11888     void getMinPortCountForStorageBus (
11889         in StorageBus bus,
11890         [retval] out unsigned long minPortCount
11891     );
11892 
11900     void getMaxPortCountForStorageBus (
11901         in StorageBus bus,
11902         [retval] out unsigned long maxPortCount
11903     );
11904 
11917     void getMaxInstancesOfStorageBus (
11918         in ChipsetType chipset,
11919         in StorageBus bus,
11920         [retval] out unsigned long maxInstances
11921     );
11922 
11932     void getDeviceTypesForStorageBus (
11933         in StorageBus bus,
11934         [retval] out DeviceType[] deviceTypes
11935     );
11936 
11945     void getDefaultIoCacheSettingForStorageController (
11946         in StorageControllerType controllerType,
11947         [retval] out boolean enabled
11948     );
11949 
11950 }; /* interface ISystemProperties */
11951 
11957 interface IGuestOSType : $unknown
11958 {
11962     readonly attribute wstring familyId;
11963 
11967     readonly attribute wstring familyDescription;
11968 
11972     readonly attribute wstring id;
11973 
11977     readonly attribute wstring description;
11978 
11982     readonly attribute boolean is64Bit;
11983 
11987     readonly attribute boolean recommendedIOAPIC;
11988 
11992     readonly attribute boolean recommendedVirtEx;
11993 
11997     readonly attribute unsigned long recommendedRAM;
11998 
12002     readonly attribute unsigned long recommendedVRAM;
12003 
12007     readonly attribute boolean recommended2DVideoAcceleration;
12008 
12012     readonly attribute boolean recommended3DAcceleration;
12013 
12017     readonly attribute long long recommendedHDD;
12018 
12022     readonly attribute NetworkAdapterType adapterType;
12023 
12027     readonly attribute boolean recommendedPAE;
12028 
12032     readonly attribute StorageControllerType recommendedDVDStorageController;
12033 
12037     readonly attribute StorageBus recommendedDVDStorageBus;
12038 
12042     readonly attribute StorageControllerType recommendedHDStorageController;
12043 
12047     readonly attribute StorageBus recommendedHDStorageBus;
12048 
12052     readonly attribute FirmwareType recommendedFirmware;
12053 
12057     readonly attribute boolean recommendedUSBHID;
12058 
12062     readonly attribute boolean recommendedHPET;
12063 
12067     readonly attribute boolean recommendedUSBTablet;
12068 
12072     readonly attribute boolean recommendedRTCUseUTC;
12073 
12077     readonly attribute ChipsetType recommendedChipset;
12078 
12082     readonly attribute AudioControllerType recommendedAudioController;
12083 
12087     readonly attribute boolean recommendedFloppy;
12088 
12092     readonly attribute boolean recommendedUSB;
12093 
12094 }; /* interface IGuestOSType */
12095 
12103 interface IAdditionsFacility : $unknown
12104 {
12108     readonly attribute AdditionsFacilityClass classType;
12109 
12116     readonly attribute long long lastUpdated;
12117 
12121     readonly attribute wstring name;
12122 
12126     readonly attribute AdditionsFacilityStatus status;
12127 
12131     readonly attribute AdditionsFacilityType type;
12132 
12133 }; /* interface IAdditionsFacility */
12134 
12142 interface IGuestDirEntry : $unknown
12143 {
12147     readonly attribute long long nodeId;
12148 
12152     readonly attribute wstring name;
12153 
12157     readonly attribute GuestDirEntryType type;
12158 
12159 }; /* interface IGuestDirEntry */
12160 
12161 interface IGuestSession : $unknown
12162 {
12172     readonly attribute wstring user;
12173 
12183     readonly attribute wstring domain;
12184 
12194     readonly attribute wstring name;
12195 
12205     readonly attribute unsigned long id;
12206 
12216     attribute unsigned long timeout;
12217 
12223     attribute wstring[] environment;
12224 
12230     readonly attribute IGuestProcess[] processes;
12231 
12237     readonly attribute IGuestDirectory[] directories;
12238 
12244     readonly attribute IGuestFile[] files;
12245 
12259     void close();
12260 
12282     void copyFrom (
12283         in wstring source,
12284         in wstring dest,
12285         in CopyFileFlag[] flags,
12286         [retval] out IProgress progress
12287     );
12288 
12310     void copyTo (
12311         in wstring source,
12312         in wstring dest,
12313         in CopyFileFlag[] flags,
12314         [retval] out IProgress progress
12315     );
12316 
12338     void directoryCreate (
12339         in wstring path,
12340         in unsigned long mode,
12341         in DirectoryCreateFlag[] flags,
12342         [retval] out IGuestDirectory directory
12343     );
12344 
12366     void directoryCreateTemp (
12367         in wstring templateName,
12368         in unsigned long mode,
12369         in wstring path,
12370         [retval] out IGuestDirectory directory
12371     );
12372 
12390     void directoryExists (
12391         in wstring path,
12392         [retval] out boolean exists
12393     );
12394 
12416     void directoryOpen (
12417         in wstring path,
12418         in wstring filter,
12419         in wstring flags,
12420         [retval] out IGuestDirectory directory
12421     );
12422 
12440     void directoryQueryInfo (
12441         in wstring path,
12442         [retval] out IGuestFsObjInfo info
12443     );
12444 
12460     void directoryRemove (
12461         in wstring path
12462     );
12463 
12483     void directoryRemoveRecursive (
12484         in wstring path,
12485         in DirectoryRemoveRecFlag[] flags,
12486         [retval] out IProgress progress
12487     );
12488 
12508     void directoryRename (
12509         in wstring source,
12510         in wstring dest,
12511         in PathRenameFlag[] flags
12512     );
12513 
12531     void directorySetACL (
12532         in wstring path,
12533         in wstring acl
12534     );
12535 
12549     void environmentClear();
12550 
12568     void environmentGet (
12569         in wstring name,
12570         [retval] out wstring value
12571     );
12572 
12590     void environmentSet (
12591         in wstring name,
12592         in wstring value
12593     );
12594 
12610     void environmentUnset (
12611         in wstring name
12612     );
12613 
12635     void fileCreateTemp (
12636         in wstring templateName,
12637         in unsigned long mode,
12638         in wstring path,
12639         [retval] out IGuestFile file
12640     );
12641 
12659     void fileExists (
12660         in wstring path,
12661         [retval] out boolean exists
12662     );
12663 
12689     void fileOpen (
12690         in wstring path,
12691         in wstring openMode,
12692         in wstring disposition,
12693         in unsigned long creationMode,
12694         in long long offset,
12695         [retval] out IGuestFile file
12696     );
12697 
12715     void fileQueryInfo (
12716         in wstring path,
12717         [retval] out IGuestFsObjInfo info
12718     );
12719 
12737     void fileQuerySize (
12738         in wstring path,
12739         [retval] out long long size
12740     );
12741 
12761     void fileRename (
12762         in wstring source,
12763         in wstring dest,
12764         in PathRenameFlag[] flags
12765     );
12766 
12784     void fileSetACL (
12785         in wstring file,
12786         in wstring acl
12787     );
12788 
12814     void processCreate (
12815         in wstring command,
12816         in wstring[] arguments,
12817         in wstring[] environment,
12818         in ProcessCreateFlag[] flags,
12819         in unsigned long timeoutMS,
12820         [retval] out IGuestProcess guestProcess
12821     );
12822 
12852     void processCreateEx (
12853         in wstring command,
12854         in wstring[] arguments,
12855         in wstring[] environment,
12856         in ProcessCreateFlag[] flags,
12857         in unsigned long timeoutMS,
12858         in ProcessPriority priority,
12859         in long[] affinity,
12860         [retval] out IGuestProcess guestProcess
12861     );
12862 
12880     void processGet (
12881         in unsigned long pid,
12882         [retval] out IGuestProcess guestProcess
12883     );
12884 
12904     void symlinkCreate (
12905         in wstring source,
12906         in wstring target,
12907         in SymlinkType type
12908     );
12909 
12927     void symlinkExists (
12928         in wstring symlink,
12929         [retval] out boolean exists
12930     );
12931 
12951     void symlinkRead (
12952         in wstring symlink,
12953         in SymlinkReadFlag[] flags,
12954         [retval] out wstring target
12955     );
12956 
12972     void symlinkRemoveDirectory (
12973         in wstring path
12974     );
12975 
12991     void symlinkRemoveFile (
12992         in wstring file
12993     );
12994 
12995 }; /* interface IGuestSession */
12996 
13004 interface IProcess : $unknown
13005 {
13015     readonly attribute unsigned long PID;
13016 
13026     readonly attribute ProcessStatus status;
13027 
13037     readonly attribute long exitCode;
13038 
13048     readonly attribute wstring[] environment;
13049 
13059     readonly attribute wstring[] arguments;
13060 
13070     readonly attribute wstring executablePath;
13071 
13081     readonly attribute wstring name;
13082 
13102     void waitFor (
13103         in unsigned long waitFor,
13104         in unsigned long timeoutMS,
13105         [retval] out ProcessWaitResult reason
13106     );
13107 
13127     void waitForArray (
13128         in ProcessWaitForFlag[] waitFor,
13129         in unsigned long timeoutMS,
13130         [retval] out ProcessWaitResult reason
13131     );
13132 
13154     void read (
13155         in unsigned long handle,
13156         in unsigned long size,
13157         in unsigned long timeoutMS,
13158         [retval] out octet[] data
13159     );
13160 
13185     void write (
13186         in unsigned long handle,
13187         in unsigned long flags,
13188         in octet[] data,
13189         in unsigned long timeoutMS,
13190         [retval] out unsigned long written
13191     );
13192 
13217     void WriteArray (
13218         in unsigned long handle,
13219         in ProcessInputFlag[] flags,
13220         in octet[] data,
13221         in unsigned long timeoutMS,
13222         [retval] out unsigned long written
13223     );
13224 
13238     void terminate();
13239 
13240 }; /* interface IProcess */
13241 
13249 interface IGuestProcess : IProcess
13250 {
13251 }; /* interface IGuestProcess */
13252 
13260 interface IDirectory : $unknown
13261 {
13271     readonly attribute wstring directoryName;
13272 
13288     void read (
13289         [retval] out IFsObjInfo objInfo
13290     );
13291 
13292 }; /* interface IDirectory */
13293 
13301 interface IGuestDirectory : IDirectory
13302 {
13303 }; /* interface IGuestDirectory */
13304 
13312 interface IFile : $unknown
13313 {
13323     readonly attribute wstring fileName;
13324 
13334     readonly attribute long long initialSize;
13335 
13345     readonly attribute unsigned long openMode;
13346 
13356     readonly attribute long long offset;
13357 
13371     void close();
13372 
13388     void queryInfo (
13389         [retval] out IFsObjInfo objInfo
13390     );
13391 
13411     void read (
13412         in unsigned long toRead,
13413         out unsigned long read,
13414         [retval] out octet[] data
13415     );
13416 
13438     void readAt (
13439         in long long offset,
13440         in unsigned long toRead,
13441         out unsigned long read,
13442         [retval] out octet[] data
13443     );
13444 
13462     void seek (
13463         in long long offset,
13464         in FileSeekType whence
13465     );
13466 
13482     void setACL (
13483         in wstring acl
13484     );
13485 
13503     void write (
13504         in octet[] data,
13505         [retval] out unsigned long written
13506     );
13507 
13527     void writeAt (
13528         in long long offset,
13529         in octet[] data,
13530         [retval] out unsigned long written
13531     );
13532 
13533 }; /* interface IFile */
13534 
13542 interface IGuestFile : IFile
13543 {
13544 }; /* interface IGuestFile */
13545 
13553 interface IFsObjInfo : $unknown
13554 {
13564     readonly attribute long long accessTime;
13565 
13575     readonly attribute long long allocatedSize;
13576 
13586     readonly attribute long long birthTime;
13587 
13597     readonly attribute long long changeTime;
13598 
13608     readonly attribute unsigned long deviceNumber;
13609 
13619     readonly attribute wstring fileAtttributes;
13620 
13630     readonly attribute unsigned long generationId;
13631 
13641     readonly attribute unsigned long GID;
13642 
13652     readonly attribute wstring groupName;
13653 
13663     readonly attribute unsigned long hardLinks;
13664 
13674     readonly attribute long long modificationTime;
13675 
13685     readonly attribute wstring name;
13686 
13696     readonly attribute long long nodeId;
13697 
13707     readonly attribute unsigned long nodeIdDevice;
13708 
13718     readonly attribute long long objectSize;
13719 
13729     readonly attribute FsObjType type;
13730 
13740     readonly attribute unsigned long UID;
13741 
13751     readonly attribute unsigned long userFlags;
13752 
13762     readonly attribute wstring userName;
13763 
13764 }; /* interface IFsObjInfo */
13765 
13773 interface IGuestFsObjInfo : IFsObjInfo
13774 {
13775 }; /* interface IGuestFsObjInfo */
13776 
13790 interface IGuest : $unknown
13791 {
13806     readonly attribute wstring OSTypeId;
13807 
13813     readonly attribute AdditionsRunLevelType additionsRunLevel;
13814 
13821     readonly attribute wstring additionsVersion;
13822 
13830     readonly attribute unsigned long additionsRevision;
13831 
13838     readonly attribute IAdditionsFacility[] facilities;
13839 
13843     readonly attribute IGuestSession[] sessions;
13844 
13848     attribute unsigned long memoryBalloonSize;
13849 
13853     attribute unsigned long statisticsUpdateInterval;
13854 
13886     void internalGetStatistics (
13887         out unsigned long cpuUser,
13888         out unsigned long cpuKernel,
13889         out unsigned long cpuIdle,
13890         out unsigned long memTotal,
13891         out unsigned long memFree,
13892         out unsigned long memBalloon,
13893         out unsigned long memShared,
13894         out unsigned long memCache,
13895         out unsigned long pagedTotal,
13896         out unsigned long memAllocTotal,
13897         out unsigned long memFreeTotal,
13898         out unsigned long memBalloonTotal,
13899         out unsigned long memSharedTotal
13900     );
13901 
13913     void getFacilityStatus (
13914         in AdditionsFacilityType facility,
13915         out long long timestamp,
13916         [retval] out AdditionsFacilityStatus status
13917     );
13918 
13936     void getAdditionsStatus (
13937         in AdditionsRunLevelType level,
13938         [retval] out boolean active
13939     );
13940 
13970     void setCredentials (
13971         in wstring userName,
13972         in wstring password,
13973         in wstring domain,
13974         in boolean allowInteractiveLogon
13975     );
13976 
14006     void dragHGEnter (
14007         in unsigned long screenId,
14008         in unsigned long y,
14009         in unsigned long x,
14010         in DragAndDropAction defaultAction,
14011         in DragAndDropAction[] allowedActions,
14012         in wstring[] formats,
14013         [retval] out DragAndDropAction resultAction
14014     );
14015 
14045     void dragHGMove (
14046         in unsigned long screenId,
14047         in unsigned long x,
14048         in unsigned long y,
14049         in DragAndDropAction defaultAction,
14050         in DragAndDropAction[] allowedActions,
14051         in wstring[] formats,
14052         [retval] out DragAndDropAction resultAction
14053     );
14054 
14072     void dragHGLeave (
14073         in unsigned long screenId
14074     );
14075 
14107     void dragHGDrop (
14108         in unsigned long screenId,
14109         in unsigned long x,
14110         in unsigned long y,
14111         in DragAndDropAction defaultAction,
14112         in DragAndDropAction[] allowedActions,
14113         in wstring[] formats,
14114         out wstring format,
14115         [retval] out DragAndDropAction resultAction
14116     );
14117 
14141     void dragHGPutData (
14142         in unsigned long screenId,
14143         in wstring format,
14144         in octet[] data,
14145         [retval] out IProgress progress
14146     );
14147 
14173     void dragGHPending (
14174         in unsigned long screenId,
14175         out wstring[] format,
14176         out DragAndDropAction[] allowedActions,
14177         [retval] out DragAndDropAction defaultAction
14178     );
14179 
14201     void dragGHDropped (
14202         in wstring format,
14203         in DragAndDropAction action,
14204         [retval] out IProgress progress
14205     );
14206 
14224     void dragGHGetData (
14225         [retval] out octet[] data
14226     );
14227 
14253     void createSession (
14254         in wstring user,
14255         in wstring password,
14256         in wstring domain,
14257         in wstring sessionName,
14258         [retval] out IGuestSession guestSession
14259     );
14260 
14274     void findSession (
14275         in wstring sessionName,
14276         [retval] out IGuestSession[] sessions
14277     );
14278 
14348     void executeProcess (
14349         in wstring execName,
14350         in unsigned long flags,
14351         in wstring[] arguments,
14352         in wstring[] environment,
14353         in wstring userName,
14354         in wstring password,
14355         in unsigned long timeoutMS,
14356         out unsigned long pid,
14357         [retval] out IProgress progress
14358     );
14359 
14404     void getProcessOutput (
14405         in unsigned long pid,
14406         in unsigned long flags,
14407         in unsigned long timeoutMS,
14408         in long long size,
14409         [retval] out octet[] data
14410     );
14411 
14445     void getProcessStatus (
14446         in unsigned long pid,
14447         out unsigned long exitcode,
14448         out unsigned long flags,
14449         [retval] out ExecuteProcessStatus reason
14450     );
14451 
14488     void copyFromGuest (
14489         in wstring source,
14490         in wstring dest,
14491         in wstring userName,
14492         in wstring password,
14493         in unsigned long flags,
14494         [retval] out IProgress progress
14495     );
14496 
14533     void copyToGuest (
14534         in wstring source,
14535         in wstring dest,
14536         in wstring userName,
14537         in wstring password,
14538         in unsigned long flags,
14539         [retval] out IProgress progress
14540     );
14541 
14559     void directoryClose (
14560         in unsigned long handle
14561     );
14562 
14597     void directoryCreate (
14598         in wstring directory,
14599         in wstring userName,
14600         in wstring password,
14601         in unsigned long mode,
14602         in unsigned long flags
14603     );
14604 
14644     void directoryOpen (
14645         in wstring directory,
14646         in wstring filter,
14647         in unsigned long flags,
14648         in wstring userName,
14649         in wstring password,
14650         [retval] out unsigned long handle
14651     );
14652 
14682     void directoryRead (
14683         in unsigned long handle,
14684         [retval] out IGuestDirEntry entry
14685     );
14686 
14722     void fileExists (
14723         in wstring file,
14724         in wstring userName,
14725         in wstring password,
14726         [retval] out boolean exists
14727     );
14728 
14760     void fileQuerySize (
14761         in wstring file,
14762         in wstring userName,
14763         in wstring password,
14764         [retval] out long long size
14765     );
14766 
14800     void setProcessInput (
14801         in unsigned long pid,
14802         in unsigned long flags,
14803         in unsigned long timeoutMS,
14804         in octet[] data,
14805         [retval] out unsigned long written
14806     );
14807 
14831     void updateGuestAdditions (
14832         in wstring source,
14833         in unsigned long flags,
14834         [retval] out IProgress progress
14835     );
14836 
14837 }; /* interface IGuest */
14838 
14879 interface IProgress : $unknown
14880 {
14884     readonly attribute wstringUUID id;
14885 
14889     readonly attribute wstring description;
14890 
14894     readonly attribute $unknown initiator;
14895 
14899     readonly attribute boolean cancelable;
14900 
14908     readonly attribute unsigned long percent;
14909 
14923     readonly attribute long timeRemaining;
14924 
14928     readonly attribute boolean completed;
14929 
14933     readonly attribute boolean canceled;
14934 
14941     readonly attribute long resultCode;
14942 
14952     readonly attribute IVirtualBoxErrorInfo errorInfo;
14953 
14960     readonly attribute unsigned long operationCount;
14961 
14965     readonly attribute unsigned long operation;
14966 
14972     readonly attribute wstring operationDescription;
14973 
14977     readonly attribute unsigned long operationPercent;
14978 
14982     readonly attribute unsigned long operationWeight;
14983 
14991     attribute unsigned long timeout;
14992 
14996     void setCurrentOperationProgress (
14997         in unsigned long percent
14998     );
14999 
15003     void setNextOperation (
15004         in wstring nextOperationDescription,
15005         in unsigned long nextOperationsWeight
15006     );
15007 
15034     void waitForCompletion (
15035         in long timeout
15036     );
15037 
15061     void waitForOperationCompletion (
15062         in unsigned long operation,
15063         in long timeout
15064     );
15065 
15091     void waitForAsyncProgressCompletion (
15092         in IProgress pProgressAsync
15093     );
15094 
15111     void cancel();
15112 
15113 }; /* interface IProgress */
15114 
15198 interface ISnapshot : $unknown
15199 {
15203     readonly attribute wstringUUID id;
15204 
15212     attribute wstring name;
15213 
15221     attribute wstring description;
15222 
15228     readonly attribute long long timeStamp;
15229 
15241     readonly attribute boolean online;
15242 
15254     readonly attribute IMachine machine;
15255 
15262     readonly attribute ISnapshot parent;
15263 
15272     readonly attribute ISnapshot[] children;
15273 
15281     void getChildrenCount (
15282         [retval] out unsigned long childrenCount
15283     );
15284 
15285 }; /* interface ISnapshot */
15286 
15473 interface IMediumAttachment : $unknown
15474 {
15479     readonly attribute IMedium medium;
15480 
15486     readonly attribute wstring controller;
15487 
15493     readonly attribute long port;
15494 
15500     readonly attribute long device;
15501 
15505     readonly attribute DeviceType type;
15506 
15510     readonly attribute boolean passthrough;
15511 
15515     readonly attribute boolean temporaryEject;
15516 
15521     readonly attribute boolean isEjected;
15522 
15526     readonly attribute boolean nonRotational;
15527 
15531     readonly attribute boolean discard;
15532 
15536     readonly attribute IBandwidthGroup bandwidthGroup;
15537 
15538 }; /* interface IMediumAttachment */
15539 
15697 interface IMedium : $unknown
15698 {
15712     readonly attribute wstringUUID id;
15713 
15732     attribute wstring description;
15733 
15749     readonly attribute MediumState state;
15750 
15759     readonly attribute unsigned long variant;
15760 
15782     attribute wstring location;
15783 
15803     readonly attribute wstring name;
15804 
15809     readonly attribute DeviceType deviceType;
15810 
15814     readonly attribute boolean hostDrive;
15815 
15828     readonly attribute long long size;
15829 
15844     readonly attribute wstring format;
15845 
15861     readonly attribute IMediumFormat mediumFormat;
15862 
15887     attribute MediumType type;
15888 
15902     readonly attribute MediumType[] allowedTypes;
15903 
15913     readonly attribute IMedium parent;
15914 
15922     readonly attribute IMedium[] children;
15923 
15934     readonly attribute IMedium base;
15935 
15968     readonly attribute boolean readOnly;
15969 
15990     readonly attribute long long logicalSize;
15991 
16019     attribute boolean autoReset;
16020 
16035     readonly attribute wstring lastAccessError;
16036 
16053     readonly attribute wstringUUID[] machineIds;
16054 
16080     void setIds (
16081         in boolean setImageId,
16082         in wstringUUID imageId,
16083         in boolean setParentId,
16084         in wstringUUID parentId
16085     );
16086 
16121     void refreshState (
16122         [retval] out MediumState state
16123     );
16124 
16151     void getSnapshotIds (
16152         in wstringUUID machineId,
16153         [retval] out wstringUUID[] snapshotIds
16154     );
16155 
16215     void lockRead (
16216         [retval] out MediumState state
16217     );
16218 
16241     void unlockRead (
16242         [retval] out MediumState state
16243     );
16244 
16299     void lockWrite (
16300         [retval] out MediumState state
16301     );
16302 
16325     void unlockWrite (
16326         [retval] out MediumState state
16327     );
16328 
16378     void close();
16379 
16409     void getProperty (
16410         in wstring name,
16411         [retval] out wstring value
16412     );
16413 
16445     void setProperty (
16446         in wstring name,
16447         in wstring value
16448     );
16449 
16484     void getProperties (
16485         in wstring names,
16486         out wstring[] returnNames,
16487         [retval] out wstring[] returnValues
16488     );
16489 
16519     void setProperties (
16520         in wstring[] names,
16521         in wstring[] values
16522     );
16523 
16556     void createBaseStorage (
16557         in long long logicalSize,
16558         in unsigned long variant,
16559         [retval] out IProgress progress
16560     );
16561 
16613     void deleteStorage (
16614         [retval] out IProgress progress
16615     );
16616 
16655     void createDiffStorage (
16656         in IMedium target,
16657         in unsigned long variant,
16658         [retval] out IProgress progress
16659     );
16660 
16736     void mergeTo (
16737         in IMedium target,
16738         [retval] out IProgress progress
16739     );
16740 
16790     void cloneTo (
16791         in IMedium target,
16792         in unsigned long variant,
16793         in IMedium parent,
16794         [retval] out IProgress progress
16795     );
16796 
16844     void cloneToBase (
16845         in IMedium target,
16846         in unsigned long variant,
16847         [retval] out IProgress progress
16848     );
16849 
16878     void compact (
16879         [retval] out IProgress progress
16880     );
16881 
16914     void resize (
16915         in long long logicalSize,
16916         [retval] out IProgress progress
16917     );
16918 
16952     void reset (
16953         [retval] out IProgress progress
16954     );
16955 
16956 }; /* interface IMedium */
16957 
16980 interface IMediumFormat : $unknown
16981 {
17000     readonly attribute wstring id;
17001 
17009     readonly attribute wstring name;
17010 
17019     readonly attribute unsigned long capabilities;
17020 
17039     void describeFileExtensions (
17040         out wstring[] extensions,
17041         out DeviceType[] type
17042     );
17043 
17071     void describeProperties (
17072         out wstring[] names,
17073         out wstring[] description,
17074         out DataType[] types,
17075         out unsigned long[] flags,
17076         out wstring[] defaults
17077     );
17078 
17079 }; /* interface IMediumFormat */
17080 
17093 interface IKeyboard : $unknown
17094 {
17100     readonly attribute IEventSource eventSource;
17101 
17114     void putScancode (
17115         in long scancode
17116     );
17117 
17130     void putScancodes (
17131         in long[] scancodes,
17132         [retval] out unsigned long codesStored
17133     );
17134 
17149     void putCAD();
17150 
17151 }; /* interface IKeyboard */
17152 
17164 interface IMouse : $unknown
17165 {
17180     readonly attribute boolean absoluteSupported;
17181 
17196     readonly attribute boolean relativeSupported;
17197 
17212     readonly attribute boolean needsHostCursor;
17213 
17219     readonly attribute IEventSource eventSource;
17220 
17286     void putMouseEvent (
17287         in long dx,
17288         in long dy,
17289         in long dz,
17290         in long dw,
17291         in long buttonState
17292     );
17293 
17366     void putMouseEventAbsolute (
17367         in long x,
17368         in long y,
17369         in long dz,
17370         in long dw,
17371         in long buttonState
17372     );
17373 
17374 }; /* interface IMouse */
17375 
17376 interface IFramebuffer : $unknown
17377 {
17386     readonly attribute octetPtr address;
17387 
17391     readonly attribute unsigned long width;
17392 
17396     readonly attribute unsigned long height;
17397 
17404     readonly attribute unsigned long bitsPerPixel;
17405 
17412     readonly attribute unsigned long bytesPerLine;
17413 
17424     readonly attribute unsigned long pixelFormat;
17425 
17432     readonly attribute boolean usesGuestVRAM;
17433 
17443     readonly attribute unsigned long heightReduction;
17444 
17459     readonly attribute IFramebufferOverlay overlay;
17460 
17467     readonly attribute long long winId;
17468 
17476     void lock();
17477 
17485     void unlock();
17486 
17494     void notifyUpdate (
17495         in unsigned long x,
17496         in unsigned long y,
17497         in unsigned long width,
17498         in unsigned long height
17499     );
17500 
17613     void requestResize (
17614         in unsigned long screenId,
17615         in unsigned long pixelFormat,
17616         in octetPtr VRAM,
17617         in unsigned long bitsPerPixel,
17618         in unsigned long bytesPerLine,
17619         in unsigned long width,
17620         in unsigned long height,
17621         [retval] out boolean finished
17622     );
17623 
17635     void videoModeSupported (
17636         in unsigned long width,
17637         in unsigned long height,
17638         in unsigned long bpp,
17639         [retval] out boolean supported
17640     );
17641 
17678     void getVisibleRegion (
17679         in octetPtr rectangles,
17680         in unsigned long count,
17681         [retval] out unsigned long countCopied
17682     );
17683 
17718     void setVisibleRegion (
17719         in octetPtr rectangles,
17720         in unsigned long count
17721     );
17722 
17743     void processVHWACommand (
17744         in octetPtr command
17745     );
17746 
17747 }; /* interface IFramebuffer */
17748 
17763 interface IFramebufferOverlay : IFramebuffer
17764 {
17768     readonly attribute unsigned long x;
17769 
17773     readonly attribute unsigned long y;
17774 
17780     attribute boolean visible;
17781 
17788     attribute unsigned long alpha;
17789 
17795     void move (
17796         in unsigned long x,
17797         in unsigned long y
17798     );
17799 
17800 }; /* interface IFramebufferOverlay */
17801 
17817 interface IDisplay : $unknown
17818 {
17822     void getScreenResolution (
17823         in unsigned long screenId,
17824         out unsigned long width,
17825         out unsigned long height,
17826         out unsigned long bitsPerPixel
17827     );
17828 
17834     void setFramebuffer (
17835         in unsigned long screenId,
17836         in IFramebuffer framebuffer
17837     );
17838 
17844     void getFramebuffer (
17845         in unsigned long screenId,
17846         out IFramebuffer framebuffer,
17847         out long xOrigin,
17848         out long yOrigin
17849     );
17850 
17901     void setVideoModeHint (
17902         in unsigned long display,
17903         in boolean enabled,
17904         in boolean changeOrigin,
17905         in long originX,
17906         in long originY,
17907         in unsigned long width,
17908         in unsigned long height,
17909         in unsigned long bitsPerPixel
17910     );
17911 
17923     void setSeamlessMode (
17924         in boolean enabled
17925     );
17926 
17962     void takeScreenShot (
17963         in unsigned long screenId,
17964         in octetPtr address,
17965         in unsigned long width,
17966         in unsigned long height
17967     );
17968 
18012     void takeScreenShotToArray (
18013         in unsigned long screenId,
18014         in unsigned long width,
18015         in unsigned long height,
18016         [retval] out octet[] screenData
18017     );
18018 
18057     void takeScreenShotPNGToArray (
18058         in unsigned long screenId,
18059         in unsigned long width,
18060         in unsigned long height,
18061         [retval] out octet[] screenData
18062     );
18063 
18115     void drawToScreen (
18116         in unsigned long screenId,
18117         in octetPtr address,
18118         in unsigned long x,
18119         in unsigned long y,
18120         in unsigned long width,
18121         in unsigned long height
18122     );
18123 
18138     void invalidateAndUpdate();
18139 
18153     void resizeCompleted (
18154         in unsigned long screenId
18155     );
18156 
18169     void completeVHWACommand (
18170         in octetPtr command
18171     );
18172 
18206     void viewportChanged (
18207         in unsigned long screenId,
18208         in unsigned long x,
18209         in unsigned long y,
18210         in unsigned long width,
18211         in unsigned long height
18212     );
18213 
18214 }; /* interface IDisplay */
18215 
18231 interface INetworkAdapter : $unknown
18232 {
18240     attribute NetworkAdapterType adapterType;
18241 
18249     readonly attribute unsigned long slot;
18250 
18259     attribute boolean enabled;
18260 
18267     attribute wstring MACAddress;
18268 
18274     attribute NetworkAttachmentType attachmentType;
18275 
18281     attribute wstring bridgedInterface;
18282 
18288     attribute wstring hostOnlyInterface;
18289 
18295     attribute wstring internalNetwork;
18296 
18302     attribute wstring NATNetwork;
18303 
18309     attribute wstring genericDriver;
18310 
18317     attribute boolean cableConnected;
18318 
18324     attribute unsigned long lineSpeed;
18325 
18332     attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
18333 
18340     attribute boolean traceEnabled;
18341 
18348     attribute wstring traceFile;
18349 
18357     readonly attribute INATEngine NATEngine;
18358 
18365     attribute unsigned long bootPriority;
18366 
18370     attribute IBandwidthGroup bandwidthGroup;
18371 
18390     void getProperty (
18391         in wstring key,
18392         [retval] out wstring value
18393     );
18394 
18413     void setProperty (
18414         in wstring key,
18415         in wstring value
18416     );
18417 
18445     void getProperties (
18446         in wstring names,
18447         out wstring[] returnNames,
18448         [retval] out wstring[] returnValues
18449     );
18450 
18451 }; /* interface INetworkAdapter */
18452 
18481 interface ISerialPort : $unknown
18482 {
18490     readonly attribute unsigned long slot;
18491 
18498     attribute boolean enabled;
18499 
18503     attribute unsigned long IOBase;
18504 
18508     attribute unsigned long IRQ;
18509 
18520     attribute PortMode hostMode;
18521 
18529     attribute boolean server;
18530 
18540     attribute wstring path;
18541 
18542 }; /* interface ISerialPort */
18543 
18563 interface IParallelPort : $unknown
18564 {
18572     readonly attribute unsigned long slot;
18573 
18580     attribute boolean enabled;
18581 
18585     attribute unsigned long IOBase;
18586 
18590     attribute unsigned long IRQ;
18591 
18599     attribute wstring path;
18600 
18601 }; /* interface IParallelPort */
18602 
18603 interface IMachineDebugger : $unknown
18604 {
18608     attribute boolean singleStep;
18609 
18613     attribute boolean recompileUser;
18614 
18618     attribute boolean recompileSupervisor;
18619 
18623     attribute boolean PATMEnabled;
18624 
18628     attribute boolean CSAMEnabled;
18629 
18633     attribute boolean logEnabled;
18634 
18638     readonly attribute wstring logDbgFlags;
18639 
18643     readonly attribute wstring logDbgGroups;
18644 
18648     readonly attribute wstring logDbgDestinations;
18649 
18653     readonly attribute wstring logRelFlags;
18654 
18658     readonly attribute wstring logRelGroups;
18659 
18663     readonly attribute wstring logRelDestinations;
18664 
18671     readonly attribute boolean HWVirtExEnabled;
18672 
18679     readonly attribute boolean HWVirtExNestedPagingEnabled;
18680 
18687     readonly attribute boolean HWVirtExVPIDEnabled;
18688 
18697     readonly attribute wstring OSName;
18698 
18707     readonly attribute wstring OSVersion;
18708 
18715     readonly attribute boolean PAEEnabled;
18716 
18723     attribute unsigned long virtualTimeRate;
18724 
18731     readonly attribute long long VM;
18732 
18748     void dumpGuestCore (
18749         in wstring filename,
18750         in wstring compression
18751     );
18752 
18769     void dumpHostProcessCore (
18770         in wstring filename,
18771         in wstring compression
18772     );
18773 
18794     void info (
18795         in wstring name,
18796         in wstring args,
18797         [retval] out wstring info
18798     );
18799 
18805     void injectNMI();
18806 
18817     void modifyLogGroups (
18818         in wstring settings
18819     );
18820 
18831     void modifyLogFlags (
18832         in wstring settings
18833     );
18834 
18845     void modifyLogDestinations (
18846         in wstring settings
18847     );
18848 
18863     void readPhysicalMemory (
18864         in long long address,
18865         in unsigned long size,
18866         [retval] out octet[] bytes
18867     );
18868 
18883     void writePhysicalMemory (
18884         in long long address,
18885         in unsigned long size,
18886         in octet[] bytes
18887     );
18888 
18905     void readVirtualMemory (
18906         in unsigned long cpuId,
18907         in long long address,
18908         in unsigned long size,
18909         [retval] out octet[] bytes
18910     );
18911 
18928     void writeVirtualMemory (
18929         in unsigned long cpuId,
18930         in long long address,
18931         in unsigned long size,
18932         in octet[] bytes
18933     );
18934 
18947     void detectOS (
18948         [retval] out wstring os
18949     );
18950 
18968     void getRegister (
18969         in unsigned long cpuId,
18970         in wstring name,
18971         [retval] out wstring value
18972     );
18973 
18991     void getRegisters (
18992         in unsigned long cpuId,
18993         out wstring[] names,
18994         out wstring[] values
18995     );
18996 
19015     void setRegister (
19016         in unsigned long cpuId,
19017         in wstring name,
19018         in wstring value
19019     );
19020 
19039     void setRegisters (
19040         in unsigned long cpuId,
19041         in wstring[] names,
19042         in wstring[] values
19043     );
19044 
19057     void dumpGuestStack (
19058         in unsigned long cpuId,
19059         [retval] out wstring stack
19060     );
19061 
19069     void resetStats (
19070         in wstring pattern
19071     );
19072 
19080     void dumpStats (
19081         in wstring pattern
19082     );
19083 
19095     void getStats (
19096         in wstring pattern,
19097         in boolean withDescriptions,
19098         out wstring stats
19099     );
19100 
19101 }; /* interface IMachineDebugger */
19102 
19103 interface IUSBController : $unknown
19104 {
19113     attribute boolean enabled;
19114 
19123     attribute boolean enabledEHCI;
19124 
19130     readonly attribute boolean proxyAvailable;
19131 
19139     readonly attribute unsigned short USBStandard;
19140 
19166     readonly attribute IUSBDeviceFilter[] deviceFilters;
19167 
19195     void createDeviceFilter (
19196         in wstring name,
19197         [retval] out IUSBDeviceFilter filter
19198     );
19199 
19244     void insertDeviceFilter (
19245         in unsigned long position,
19246         in IUSBDeviceFilter filter
19247     );
19248 
19281     void removeDeviceFilter (
19282         in unsigned long position,
19283         [retval] out IUSBDeviceFilter filter
19284     );
19285 
19286 }; /* interface IUSBController */
19287 
19300 interface IUSBDevice : $unknown
19301 {
19308     readonly attribute wstringUUID id;
19309 
19313     readonly attribute unsigned short vendorId;
19314 
19318     readonly attribute unsigned short productId;
19319 
19327     readonly attribute unsigned short revision;
19328 
19332     readonly attribute wstring manufacturer;
19333 
19337     readonly attribute wstring product;
19338 
19342     readonly attribute wstring serialNumber;
19343 
19347     readonly attribute wstring address;
19348 
19355     readonly attribute unsigned short port;
19356 
19362     readonly attribute unsigned short version;
19363 
19371     readonly attribute unsigned short portVersion;
19372 
19379     readonly attribute boolean remote;
19380 
19381 }; /* interface IUSBDevice */
19382 
19457 interface IUSBDeviceFilter : $unknown
19458 {
19466     attribute wstring name;
19467 
19471     attribute boolean active;
19472 
19480     attribute wstring vendorId;
19481 
19489     attribute wstring productId;
19490 
19504     attribute wstring revision;
19505 
19510     attribute wstring manufacturer;
19511 
19516     attribute wstring product;
19517 
19522     attribute wstring serialNumber;
19523 
19528     attribute wstring port;
19529 
19539     attribute wstring remote;
19540 
19550     attribute unsigned long maskedInterfaces;
19551 
19552 }; /* interface IUSBDeviceFilter */
19553 
19570 interface IHostUSBDevice : IUSBDevice
19571 {
19577     readonly attribute USBDeviceState state;
19578 
19579 }; /* interface IHostUSBDevice */
19580 
19603 interface IHostUSBDeviceFilter : IUSBDeviceFilter
19604 {
19611     attribute USBDeviceFilterAction action;
19612 
19613 }; /* interface IHostUSBDeviceFilter */
19614 
19623 interface IAudioAdapter : $unknown
19624 {
19633     attribute boolean enabled;
19634 
19640     attribute AudioControllerType audioController;
19641 
19648     attribute AudioDriverType audioDriver;
19649 
19650 }; /* interface IAudioAdapter */
19651 
19652 interface IVRDEServer : $unknown
19653 {
19657     attribute boolean enabled;
19658 
19662     attribute AuthType authType;
19663 
19667     attribute unsigned long authTimeout;
19668 
19675     attribute boolean allowMultiConnection;
19676 
19684     attribute boolean reuseSingleConnection;
19685 
19692     attribute wstring VRDEExtPack;
19693 
19700     attribute wstring authLibrary;
19701 
19707     readonly attribute wstring[] VRDEProperties;
19708 
19722     void setVRDEProperty (
19723         in wstring key,
19724         in wstring value
19725     );
19726 
19740     void getVRDEProperty (
19741         in wstring key,
19742         [retval] out wstring value
19743     );
19744 
19745 }; /* interface IVRDEServer */
19746 
19804 interface ISharedFolder : $unknown
19805 {
19809     readonly attribute wstring name;
19810 
19814     readonly attribute wstring hostPath;
19815 
19825     readonly attribute boolean accessible;
19826 
19833     readonly attribute boolean writable;
19834 
19840     readonly attribute boolean autoMount;
19841 
19854     readonly attribute wstring lastAccessError;
19855 
19856 }; /* interface ISharedFolder */
19857 
19858 interface IInternalSessionControl : $unknown
19859 {
19864     void getPID (
19865         [retval] out unsigned long pid
19866     );
19867 
19889     void getRemoteConsole (
19890         [retval] out IConsole console
19891     );
19892 
19916     void assignMachine (
19917         in IMachine machine,
19918         in LockType lockType
19919     );
19920 
19935     void assignRemoteMachine (
19936         in IMachine machine,
19937         in IConsole console
19938     );
19939 
19963     void updateMachineState (
19964         in MachineState aMachineState
19965     );
19966 
19982     void uninitialize();
19983 
20006     void onNetworkAdapterChange (
20007         in INetworkAdapter networkAdapter,
20008         in boolean changeAdapter
20009     );
20010 
20033     void onSerialPortChange (
20034         in ISerialPort serialPort
20035     );
20036 
20059     void onParallelPortChange (
20060         in IParallelPort parallelPort
20061     );
20062 
20085     void onStorageControllerChange();
20086 
20113     void onMediumChange (
20114         in IMediumAttachment mediumAttachment,
20115         in boolean force
20116     );
20117 
20144     void onStorageDeviceChange (
20145         in IMediumAttachment mediumAttachment,
20146         in boolean remove
20147     );
20148 
20156     void onClipboardModeChange (
20157         in ClipboardMode clipboardMode
20158     );
20159 
20167     void onDragAndDropModeChange (
20168         in DragAndDropMode dragAndDropMode
20169     );
20170 
20180     void onCPUChange (
20181         in unsigned long cpu,
20182         in boolean add
20183     );
20184 
20192     void onCPUExecutionCapChange (
20193         in unsigned long executionCap
20194     );
20195 
20220     void onVRDEServerChange (
20221         in boolean restart
20222     );
20223 
20246     void onUSBControllerChange();
20247 
20276     void onSharedFolderChange (
20277         in boolean global
20278     );
20279 
20305     void onUSBDeviceAttach (
20306         in IUSBDevice device,
20307         in IVirtualBoxErrorInfo error,
20308         in unsigned long maskedInterfaces
20309     );
20310 
20336     void onUSBDeviceDetach (
20337         in wstringUUID id,
20338         in IVirtualBoxErrorInfo error
20339     );
20340 
20358     void onShowWindow (
20359         in boolean check,
20360         out boolean canShow,
20361         out long long winId
20362     );
20363 
20371     void onBandwidthGroupChange (
20372         in IBandwidthGroup bandwidthGroup
20373     );
20374 
20398     void accessGuestProperty (
20399         in wstring name,
20400         in wstring value,
20401         in wstring flags,
20402         in boolean isSetter,
20403         out wstring retValue,
20404         out long long retTimestamp,
20405         out wstring retFlags
20406     );
20407 
20455     void enumerateGuestProperties (
20456         in wstring patterns,
20457         out wstring[] key,
20458         out wstring[] value,
20459         out long long[] timestamp,
20460         out wstring[] flags
20461     );
20462 
20508     void onlineMergeMedium (
20509         in IMediumAttachment mediumAttachment,
20510         in unsigned long sourceIdx,
20511         in unsigned long targetIdx,
20512         in IMedium source,
20513         in IMedium target,
20514         in boolean mergeForward,
20515         in IMedium parentForTarget,
20516         in IMedium[] childrenToReparent,
20517         in IProgress progress
20518     );
20519 
20543     void enableVMMStatistics (
20544         in boolean enable
20545     );
20546 
20547 }; /* interface IInternalSessionControl */
20548 
20607 interface ISession : $unknown
20608 {
20612     readonly attribute SessionState state;
20613 
20621     readonly attribute SessionType type;
20622 
20626     readonly attribute IMachine machine;
20627 
20631     readonly attribute IConsole console;
20632 
20664     void unlockMachine();
20665 
20666 }; /* interface ISession */
20667 
20690 interface IStorageController : $unknown
20691 {
20700     readonly attribute wstring name;
20701 
20707     readonly attribute unsigned long maxDevicesPerPortCount;
20708 
20714     readonly attribute unsigned long minPortCount;
20715 
20721     readonly attribute unsigned long maxPortCount;
20722 
20728     attribute unsigned long instance;
20729 
20738     attribute unsigned long portCount;
20739 
20745     readonly attribute StorageBus bus;
20746 
20759     attribute StorageControllerType controllerType;
20760 
20775     attribute boolean useHostIOCache;
20776 
20782     readonly attribute boolean bootable;
20783 
20806     void getIDEEmulationPort (
20807         in long devicePosition,
20808         [retval] out long portNumber
20809     );
20810 
20834     void setIDEEmulationPort (
20835         in long devicePosition,
20836         in long portNumber
20837     );
20838 
20839 }; /* interface IStorageController */
20840 
20864 interface IManagedObjectRef : $unknown
20865 {
20872     void getInterfaceName (
20873         [retval] out wstring return
20874     );
20875 
20883     void release();
20884 
20885 }; /* interface IManagedObjectRef */
20886 
20895 interface IWebsessionManager : $unknown
20896 {
20905     void logon (
20906         in wstring username,
20907         in wstring password,
20908         [retval] out IVirtualBox return
20909     );
20910 
20920     void getSessionObject (
20921         in IVirtualBox refIVirtualBox,
20922         [retval] out ISession return
20923     );
20924 
20932     void logoff (
20933         in IVirtualBox refIVirtualBox
20934     );
20935 
20936 }; /* interface IWebsessionManager */
20937 
20946 interface IPerformanceMetric : $unknown
20947 {
20953     readonly attribute wstring metricName;
20954 
20960     readonly attribute $unknown object;
20961 
20967     readonly attribute wstring description;
20968 
20974     readonly attribute unsigned long period;
20975 
20985     readonly attribute unsigned long count;
20986 
20992     readonly attribute wstring unit;
20993 
20999     readonly attribute long minimumValue;
21000 
21006     readonly attribute long maximumValue;
21007 
21008 }; /* interface IPerformanceMetric */
21009 
21116 interface IPerformanceCollector : $unknown
21117 {
21128     readonly attribute wstring[] metricNames;
21129 
21153     void getMetrics (
21154         in wstring[] metricNames,
21155         in $unknown[] objects,
21156         [retval] out IPerformanceMetric[] metrics
21157     );
21158 
21197     void setupMetrics (
21198         in wstring[] metricNames,
21199         in $unknown[] objects,
21200         in unsigned long period,
21201         in unsigned long count,
21202         [retval] out IPerformanceMetric[] affectedMetrics
21203     );
21204 
21233     void enableMetrics (
21234         in wstring[] metricNames,
21235         in $unknown[] objects,
21236         [retval] out IPerformanceMetric[] affectedMetrics
21237     );
21238 
21267     void disableMetrics (
21268         in wstring[] metricNames,
21269         in $unknown[] objects,
21270         [retval] out IPerformanceMetric[] affectedMetrics
21271     );
21272 
21361     void queryMetricsData (
21362         in wstring[] metricNames,
21363         in $unknown[] objects,
21364         out wstring[] returnMetricNames,
21365         out $unknown[] returnObjects,
21366         out wstring[] returnUnits,
21367         out unsigned long[] returnScales,
21368         out unsigned long[] returnSequenceNumbers,
21369         out unsigned long[] returnDataIndices,
21370         out unsigned long[] returnDataLengths,
21371         [retval] out long[] returnData
21372     );
21373 
21374 }; /* interface IPerformanceCollector */
21375 
21383 interface INATEngine : $unknown
21384 {
21389     attribute wstring network;
21390 
21397     attribute wstring hostIP;
21398 
21403     attribute wstring TFTPPrefix;
21404 
21409     attribute wstring TFTPBootFile;
21410 
21418     attribute wstring TFTPNextServer;
21419 
21423     attribute unsigned long aliasMode;
21424 
21428     attribute boolean DNSPassDomain;
21429 
21434     attribute boolean DNSProxy;
21435 
21440     attribute boolean DNSUseHostResolver;
21441 
21446     readonly attribute wstring[] redirects;
21447 
21463     void setNetworkSettings (
21464         in unsigned long mtu,
21465         in unsigned long sockSnd,
21466         in unsigned long sockRcv,
21467         in unsigned long TcpWndSnd,
21468         in unsigned long TcpWndRcv
21469     );
21470 
21475     void getNetworkSettings (
21476         out unsigned long mtu,
21477         out unsigned long sockSnd,
21478         out unsigned long sockRcv,
21479         out unsigned long TcpWndSnd,
21480         out unsigned long TcpWndRcv
21481     );
21482 
21502     void addRedirect (
21503         in wstring name,
21504         in NATProtocol proto,
21505         in wstring hostIP,
21506         in unsigned short hostPort,
21507         in wstring guestIP,
21508         in unsigned short guestPort
21509     );
21510 
21516     void removeRedirect (
21517         in wstring name
21518     );
21519 
21520 }; /* interface INATEngine */
21521 
21530 interface IExtPackPlugIn : $unknown
21531 {
21535     readonly attribute wstring name;
21536 
21540     readonly attribute wstring description;
21541 
21547     readonly attribute wstring frontend;
21548 
21552     readonly attribute wstring modulePath;
21553 
21554 }; /* interface IExtPackPlugIn */
21555 
21564 interface IExtPackBase : $unknown
21565 {
21569     readonly attribute wstring name;
21570 
21574     readonly attribute wstring description;
21575 
21587     readonly attribute wstring version;
21588 
21592     readonly attribute unsigned long revision;
21593 
21603     readonly attribute wstring edition;
21604 
21608     readonly attribute wstring VRDEModule;
21609 
21613     readonly attribute IExtPackPlugIn[] plugIns;
21614 
21624     readonly attribute boolean usable;
21625 
21632     readonly attribute wstring whyUnusable;
21633 
21637     readonly attribute boolean showLicense;
21638 
21647     readonly attribute wstring license;
21648 
21672     void queryLicense (
21673         in wstring preferredLocale,
21674         in wstring preferredLanguage,
21675         in wstring format,
21676         [retval] out wstring licenseText
21677     );
21678 
21679 }; /* interface IExtPackBase */
21680 
21689 interface IExtPack : IExtPackBase
21690 {
21702     void queryObject (
21703         in wstring objUuid,
21704         [retval] out $unknown returnInterface
21705     );
21706 
21707 }; /* interface IExtPack */
21708 
21718 interface IExtPackFile : IExtPackBase
21719 {
21725     readonly attribute wstring filePath;
21726 
21745     void install (
21746         in boolean replace,
21747         in wstring displayInfo,
21748         [retval] out IProgress progess
21749     );
21750 
21751 }; /* interface IExtPackFile */
21752 
21763 interface IExtPackManager : $unknown
21764 {
21770     readonly attribute IExtPack[] installedExtPacks;
21771 
21789     void find (
21790         in wstring name,
21791         [retval] out IExtPack returnData
21792     );
21793 
21805     void openExtPackFile (
21806         in wstring path,
21807         [retval] out IExtPackFile file
21808     );
21809 
21828     void uninstall (
21829         in wstring name,
21830         in boolean forcedRemoval,
21831         in wstring displayInfo,
21832         [retval] out IProgress progess
21833     );
21834 
21838     void cleanup();
21839 
21852     void queryAllPlugInsForFrontend (
21853         in wstring frontendName,
21854         [retval] out wstring[] plugInModules
21855     );
21856 
21864     void isExtPackUsable (
21865         in wstring name,
21866         [retval] out boolean usable
21867     );
21868 
21869 }; /* interface IExtPackManager */
21870 
21876 interface IBandwidthGroup : $unknown
21877 {
21881     readonly attribute wstring name;
21882 
21886     readonly attribute BandwidthGroupType type;
21887 
21891     readonly attribute unsigned long reference;
21892 
21897     attribute long long maxBytesPerSec;
21898 
21899 }; /* interface IBandwidthGroup */
21900 
21909 interface IBandwidthControl : $unknown
21910 {
21916     readonly attribute unsigned long numGroups;
21917 
21930     void createBandwidthGroup (
21931         in wstring name,
21932         in BandwidthGroupType type,
21933         in long long maxBytesPerSec
21934     );
21935 
21943     void deleteBandwidthGroup (
21944         in wstring name
21945     );
21946 
21956     void getBandwidthGroup (
21957         in wstring name,
21958         [retval] out IBandwidthGroup bandwidthGroup
21959     );
21960 
21968     void getAllBandwidthGroups (
21969         [retval] out IBandwidthGroup[] bandwidthGroups
21970     );
21971 
21972 }; /* interface IBandwidthControl */
21973 
21986 interface IVirtualBoxClient : $unknown
21987 {
21993     readonly attribute IVirtualBox virtualBox;
21994 
22000     readonly attribute ISession session;
22001 
22007     readonly attribute IEventSource eventSource;
22008 
22009 }; /* interface IVirtualBoxClient */
22010 
22024 interface IEventSource : $unknown
22025 {
22031     void createListener (
22032         [retval] out IEventListener listener
22033     );
22034 
22050     void createAggregator (
22051         in IEventSource[] subordinates,
22052         [retval] out IEventSource result
22053     );
22054 
22087     void registerListener (
22088         in IEventListener listener,
22089         in VBoxEventType[] interesting,
22090         in boolean active
22091     );
22092 
22101     void unregisterListener (
22102         in IEventListener listener
22103     );
22104 
22119     void fireEvent (
22120         in IEvent event,
22121         in long timeout,
22122         [retval] out boolean result
22123     );
22124 
22149     void getEvent (
22150         in IEventListener listener,
22151         in long timeout,
22152         [retval] out IEvent event
22153     );
22154 
22166     void eventProcessed (
22167         in IEventListener listener,
22168         in IEvent event
22169     );
22170 
22171 }; /* interface IEventSource */
22172 
22182 interface IEventListener : $unknown
22183 {
22196     void handleEvent (
22197         in IEvent event
22198     );
22199 
22200 }; /* interface IEventListener */
22201 
22278 interface IEvent : $unknown
22279 {
22285     readonly attribute VBoxEventType type;
22286 
22292     readonly attribute IEventSource source;
22293 
22304     readonly attribute boolean waitable;
22305 
22312     void setProcessed();
22313 
22327     void waitProcessed (
22328         in long timeout,
22329         [retval] out boolean result
22330     );
22331 
22332 }; /* interface IEvent */
22333 
22339 interface IReusableEvent : IEvent
22340 {
22344     readonly attribute unsigned long generation;
22345 
22352     void reuse();
22353 
22354 }; /* interface IReusableEvent */
22355 
22361 interface IMachineEvent : IEvent
22362 {
22366     readonly attribute wstringUUID machineId;
22367 
22368 }; /* interface IMachineEvent */
22369 
22375 interface IMachineStateChangedEvent : IMachineEvent
22376 {
22380     readonly attribute MachineState state;
22381 
22382 }; /* interface IMachineStateChangedEvent */
22383 
22391 interface IMachineDataChangedEvent : IMachineEvent
22392 {
22399     readonly attribute boolean temporary;
22400 
22401 }; /* interface IMachineDataChangedEvent */
22402 
22411 interface IMediumRegisteredEvent : IEvent
22412 {
22416     readonly attribute wstringUUID mediumId;
22417 
22421     readonly attribute DeviceType mediumType;
22422 
22429     readonly attribute boolean registered;
22430 
22431 }; /* interface IMediumRegisteredEvent */
22432 
22441 interface IMachineRegisteredEvent : IMachineEvent
22442 {
22449     readonly attribute boolean registered;
22450 
22451 }; /* interface IMachineRegisteredEvent */
22452 
22462 interface ISessionStateChangedEvent : IMachineEvent
22463 {
22469     readonly attribute SessionState state;
22470 
22471 }; /* interface ISessionStateChangedEvent */
22472 
22480 interface IGuestPropertyChangedEvent : IMachineEvent
22481 {
22487     readonly attribute wstring name;
22488 
22494     readonly attribute wstring value;
22495 
22501     readonly attribute wstring flags;
22502 
22503 }; /* interface IGuestPropertyChangedEvent */
22504 
22510 interface ISnapshotEvent : IMachineEvent
22511 {
22515     readonly attribute wstringUUID snapshotId;
22516 
22517 }; /* interface ISnapshotEvent */
22518 
22528 interface ISnapshotTakenEvent : ISnapshotEvent
22529 {
22530 }; /* interface ISnapshotTakenEvent */
22531 
22548 interface ISnapshotDeletedEvent : ISnapshotEvent
22549 {
22550 }; /* interface ISnapshotDeletedEvent */
22551 
22561 interface ISnapshotChangedEvent : ISnapshotEvent
22562 {
22563 }; /* interface ISnapshotChangedEvent */
22564 
22573 interface IMousePointerShapeChangedEvent : IEvent
22574 {
22580     readonly attribute boolean visible;
22581 
22587     readonly attribute boolean alpha;
22588 
22594     readonly attribute unsigned long xhot;
22595 
22601     readonly attribute unsigned long yhot;
22602 
22608     readonly attribute unsigned long width;
22609 
22615     readonly attribute unsigned long height;
22616 
22649     readonly attribute octet[] shape;
22650 
22651 }; /* interface IMousePointerShapeChangedEvent */
22652 
22661 interface IMouseCapabilityChangedEvent : IEvent
22662 {
22668     readonly attribute boolean supportsAbsolute;
22669 
22675     readonly attribute boolean supportsRelative;
22676 
22682     readonly attribute boolean needsHostCursor;
22683 
22684 }; /* interface IMouseCapabilityChangedEvent */
22685 
22694 interface IKeyboardLedsChangedEvent : IEvent
22695 {
22701     readonly attribute boolean numLock;
22702 
22708     readonly attribute boolean capsLock;
22709 
22715     readonly attribute boolean scrollLock;
22716 
22717 }; /* interface IKeyboardLedsChangedEvent */
22718 
22727 interface IStateChangedEvent : IEvent
22728 {
22734     readonly attribute MachineState state;
22735 
22736 }; /* interface IStateChangedEvent */
22737 
22747 interface IAdditionsStateChangedEvent : IEvent
22748 {
22749 }; /* interface IAdditionsStateChangedEvent */
22750 
22761 interface INetworkAdapterChangedEvent : IEvent
22762 {
22768     readonly attribute INetworkAdapter networkAdapter;
22769 
22770 }; /* interface INetworkAdapterChangedEvent */
22771 
22782 interface ISerialPortChangedEvent : IEvent
22783 {
22789     readonly attribute ISerialPort serialPort;
22790 
22791 }; /* interface ISerialPortChangedEvent */
22792 
22803 interface IParallelPortChangedEvent : IEvent
22804 {
22810     readonly attribute IParallelPort parallelPort;
22811 
22812 }; /* interface IParallelPortChangedEvent */
22813 
22823 interface IStorageControllerChangedEvent : IEvent
22824 {
22825 }; /* interface IStorageControllerChangedEvent */
22826 
22836 interface IMediumChangedEvent : IEvent
22837 {
22843     readonly attribute IMediumAttachment mediumAttachment;
22844 
22845 }; /* interface IMediumChangedEvent */
22846 
22854 interface IClipboardModeChangedEvent : IEvent
22855 {
22861     readonly attribute ClipboardMode clipboardMode;
22862 
22863 }; /* interface IClipboardModeChangedEvent */
22864 
22872 interface IDragAndDropModeChangedEvent : IEvent
22873 {
22879     readonly attribute DragAndDropMode dragAndDropMode;
22880 
22881 }; /* interface IDragAndDropModeChangedEvent */
22882 
22890 interface ICPUChangedEvent : IEvent
22891 {
22897     readonly attribute unsigned long CPU;
22898 
22904     readonly attribute boolean add;
22905 
22906 }; /* interface ICPUChangedEvent */
22907 
22915 interface ICPUExecutionCapChangedEvent : IEvent
22916 {
22922     readonly attribute unsigned long executionCap;
22923 
22924 }; /* interface ICPUExecutionCapChangedEvent */
22925 
22933 interface IGuestKeyboardEvent : IEvent
22934 {
22940     readonly attribute long[] scancodes;
22941 
22942 }; /* interface IGuestKeyboardEvent */
22943 
22951 interface IGuestMouseEvent : IReusableEvent
22952 {
22958     readonly attribute boolean absolute;
22959 
22965     readonly attribute long x;
22966 
22972     readonly attribute long y;
22973 
22979     readonly attribute long z;
22980 
22986     readonly attribute long w;
22987 
22993     readonly attribute long buttons;
22994 
22995 }; /* interface IGuestMouseEvent */
22996 
23007 interface IVRDEServerChangedEvent : IEvent
23008 {
23009 }; /* interface IVRDEServerChangedEvent */
23010 
23020 interface IVRDEServerInfoChangedEvent : IEvent
23021 {
23022 }; /* interface IVRDEServerInfoChangedEvent */
23023 
23034 interface IUSBControllerChangedEvent : IEvent
23035 {
23036 }; /* interface IUSBControllerChangedEvent */
23037 
23061 interface IUSBDeviceStateChangedEvent : IEvent
23062 {
23068     readonly attribute IUSBDevice device;
23069 
23075     readonly attribute boolean attached;
23076 
23082     readonly attribute IVirtualBoxErrorInfo error;
23083 
23084 }; /* interface IUSBDeviceStateChangedEvent */
23085 
23101 interface ISharedFolderChangedEvent : IEvent
23102 {
23108     readonly attribute Scope scope;
23109 
23110 }; /* interface ISharedFolderChangedEvent */
23111 
23163 interface IRuntimeErrorEvent : IEvent
23164 {
23170     readonly attribute boolean fatal;
23171 
23177     readonly attribute wstring id;
23178 
23184     readonly attribute wstring message;
23185 
23186 }; /* interface IRuntimeErrorEvent */
23187 
23195 interface IEventSourceChangedEvent : IEvent
23196 {
23202     readonly attribute IEventListener listener;
23203 
23209     readonly attribute boolean add;
23210 
23211 }; /* interface IEventSourceChangedEvent */
23212 
23221 interface IExtraDataChangedEvent : IEvent
23222 {
23229     readonly attribute wstringUUID machineId;
23230 
23236     readonly attribute wstring key;
23237 
23243     readonly attribute wstring value;
23244 
23245 }; /* interface IExtraDataChangedEvent */
23246 
23252 interface IVetoEvent : IEvent
23253 {
23263     void addVeto (
23264         in wstring reason
23265     );
23266 
23276     void isVetoed (
23277         [retval] out boolean result
23278     );
23279 
23289     void getVetos (
23290         [retval] out wstring[] result
23291     );
23292 
23293 }; /* interface IVetoEvent */
23294 
23304 interface IExtraDataCanChangeEvent : IVetoEvent
23305 {
23312     readonly attribute wstringUUID machineId;
23313 
23319     readonly attribute wstring key;
23320 
23326     readonly attribute wstring value;
23327 
23328 }; /* interface IExtraDataCanChangeEvent */
23329 
23345 interface ICanShowWindowEvent : IVetoEvent
23346 {
23347 }; /* interface ICanShowWindowEvent */
23348 
23380 interface IShowWindowEvent : IEvent
23381 {
23390     attribute long long winId;
23391 
23392 }; /* interface IShowWindowEvent */
23393 
23401 interface INATRedirectEvent : IMachineEvent
23402 {
23408     readonly attribute unsigned long slot;
23409 
23415     readonly attribute boolean remove;
23416 
23422     readonly attribute wstring name;
23423 
23429     readonly attribute NATProtocol proto;
23430 
23436     readonly attribute wstring hostIP;
23437 
23443     readonly attribute long hostPort;
23444 
23450     readonly attribute wstring guestIP;
23451 
23457     readonly attribute long guestPort;
23458 
23459 }; /* interface INATRedirectEvent */
23460 
23473 interface IHostPCIDevicePlugEvent : IMachineEvent
23474 {
23480     readonly attribute boolean plugged;
23481 
23488     readonly attribute boolean success;
23489 
23495     readonly attribute IPCIDeviceAttachment attachment;
23496 
23502     readonly attribute wstring message;
23503 
23504 }; /* interface IHostPCIDevicePlugEvent */
23505 
23514 interface IVBoxSVCAvailabilityChangedEvent : IEvent
23515 {
23521     readonly attribute boolean available;
23522 
23523 }; /* interface IVBoxSVCAvailabilityChangedEvent */
23524 
23532 interface IBandwidthGroupChangedEvent : IEvent
23533 {
23539     readonly attribute IBandwidthGroup bandwidthGroup;
23540 
23541 }; /* interface IBandwidthGroupChangedEvent */
23542 
23550 interface IGuestMonitorChangedEvent : IEvent
23551 {
23557     readonly attribute GuestMonitorChangedEventType changeType;
23558 
23564     readonly attribute unsigned long screenId;
23565 
23572     readonly attribute unsigned long originX;
23573 
23580     readonly attribute unsigned long originY;
23581 
23588     readonly attribute unsigned long width;
23589 
23596     readonly attribute unsigned long height;
23597 
23598 }; /* interface IGuestMonitorChangedEvent */
23599 
23609 interface IStorageDeviceChangedEvent : IEvent
23610 {
23616     readonly attribute IMediumAttachment storageDevice;
23617 
23623     readonly attribute boolean removed;
23624 
23625 }; /* interface IStorageDeviceChangedEvent */
23626 
23627 

Generated on Fri Aug 3 2012 14:15:55 for VirtualBox Main API by  doxygen 1.7.1