• 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,
01681     AdditionsUpdateFlag_WaitForUpdateStartOnly = 1,
01682 };
01683 
01691 enum FileSeekType
01692 {
01697     FileSeekType_Set = 0,
01702     FileSeekType_Current = 1,
01703 };
01704 
01712 enum ProcessInputFlag
01713 {
01718     ProcessInputFlag_None = 0,
01723     ProcessInputFlag_EndOfFile = 1,
01724 };
01725 
01734 enum ProcessOutputFlag
01735 {
01740     ProcessOutputFlag_None = 0,
01745     ProcessOutputFlag_StdErr = 1,
01746 };
01747 
01755 enum ProcessWaitForFlag
01756 {
01761     ProcessWaitForFlag_None = 0,
01766     ProcessWaitForFlag_Start = 1,
01771     ProcessWaitForFlag_Terminate = 2,
01776     ProcessWaitForFlag_StdIn = 4,
01781     ProcessWaitForFlag_StdOut = 8,
01786     ProcessWaitForFlag_StdErr = 16,
01787 };
01788 
01807 enum ProcessWaitResult
01808 {
01813     ProcessWaitResult_None = 0,
01818     ProcessWaitResult_Start = 1,
01823     ProcessWaitResult_Terminate = 2,
01831     ProcessWaitResult_Status = 3,
01836     ProcessWaitResult_Error = 4,
01845     ProcessWaitResult_Timeout = 5,
01852     ProcessWaitResult_StdIn = 6,
01857     ProcessWaitResult_StdOut = 7,
01862     ProcessWaitResult_StdErr = 8,
01870     ProcessWaitResult_WaitFlagNotSupported = 9,
01871 };
01872 
01880 enum CopyFileFlag
01881 {
01886     CopyFileFlag_None = 0,
01891     CopyFileFlag_Recursive = 1,
01896     CopyFileFlag_Update = 2,
01901     CopyFileFlag_FollowLinks = 4,
01902 };
01903 
01911 enum DirectoryCreateFlag
01912 {
01917     DirectoryCreateFlag_None = 0,
01922     DirectoryCreateFlag_Parents = 1,
01923 };
01924 
01932 enum DirectoryRemoveRecFlag
01933 {
01938     DirectoryRemoveRecFlag_None = 0,
01943     DirectoryRemoveRecFlag_ContentAndDir = 1,
01948     DirectoryRemoveRecFlag_ContentOnly = 2,
01949 };
01950 
01958 enum PathRenameFlag
01959 {
01964     PathRenameFlag_None = 0,
01969     PathRenameFlag_NoReplace = 1,
01974     PathRenameFlag_Replace = 2,
01979     PathRenameFlag_NoSymlinks = 4,
01980 };
01981 
01989 enum ProcessCreateFlag
01990 {
01995     ProcessCreateFlag_None = 0,
02001     ProcessCreateFlag_WaitForProcessStartOnly = 1,
02006     ProcessCreateFlag_IgnoreOrphanedProcesses = 2,
02011     ProcessCreateFlag_Hidden = 4,
02016     ProcessCreateFlag_NoProfile = 8,
02021     ProcessCreateFlag_WaitForStdOut = 16,
02026     ProcessCreateFlag_WaitForStdErr = 32,
02031     ProcessCreateFlag_ExpandArguments = 64,
02032 };
02033 
02041 enum ProcessPriority
02042 {
02047     ProcessPriority_Invalid = 0,
02052     ProcessPriority_Default = 1,
02053 };
02054 
02062 enum SymlinkType
02063 {
02068     SymlinkType_Unknown = 0,
02073     SymlinkType_Directory = 1,
02078     SymlinkType_File = 2,
02079 };
02080 
02088 enum SymlinkReadFlag
02089 {
02094     SymlinkReadFlag_None = 0,
02099     SymlinkReadFlag_NoSymlinks = 1,
02100 };
02101 
02109 enum ProcessStatus
02110 {
02115     ProcessStatus_Undefined = 0,
02120     ProcessStatus_Starting = 10,
02125     ProcessStatus_Started = 100,
02130     ProcessStatus_Paused = 110,
02135     ProcessStatus_Terminating = 480,
02140     ProcessStatus_TerminatedNormally = 500,
02145     ProcessStatus_TerminatedSignal = 510,
02150     ProcessStatus_TerminatedAbnormally = 511,
02155     ProcessStatus_TimedOutKilled = 512,
02160     ProcessStatus_TimedOutAbnormally = 513,
02165     ProcessStatus_Down = 600,
02170     ProcessStatus_Error = 800,
02171 };
02172 
02180 enum FsObjType
02181 {
02186     FsObjType_Undefined = 0,
02191     FsObjType_FIFO = 1,
02196     FsObjType_DevChar = 10,
02201     FsObjType_DevBlock = 11,
02206     FsObjType_Directory = 50,
02211     FsObjType_File = 80,
02216     FsObjType_Symlink = 100,
02221     FsObjType_Socket = 200,
02226     FsObjType_Whiteout = 400,
02227 };
02228 
02236 enum DragAndDropAction
02237 {
02242     DragAndDropAction_Ignore = 0,
02247     DragAndDropAction_Copy = 1,
02252     DragAndDropAction_Move = 2,
02257     DragAndDropAction_Link = 3,
02258 };
02259 
02267 enum DirectoryOpenFlag
02268 {
02273     DirectoryOpenFlag_None = 0,
02278     DirectoryOpenFlag_NoSymlinks = 1,
02279 };
02280 
02290 enum MediumState
02291 {
02299     MediumState_NotCreated = 0,
02308     MediumState_Created = 1,
02316     MediumState_LockedRead = 2,
02324     MediumState_LockedWrite = 3,
02334     MediumState_Inaccessible = 4,
02341     MediumState_Creating = 5,
02348     MediumState_Deleting = 6,
02349 };
02350 
02361 enum MediumType
02362 {
02370     MediumType_Normal = 0,
02378     MediumType_Immutable = 1,
02386     MediumType_Writethrough = 2,
02395     MediumType_Shareable = 3,
02404     MediumType_Readonly = 4,
02416     MediumType_MultiAttach = 5,
02417 };
02418 
02428 enum MediumVariant
02429 {
02436     MediumVariant_Standard = 0,
02443     MediumVariant_VmdkSplit2G = 0x01,
02450     MediumVariant_VmdkRawDisk = 0x02,
02458     MediumVariant_VmdkStreamOptimized = 0x04,
02465     MediumVariant_VmdkESX = 0x08,
02472     MediumVariant_Fixed = 0x10000,
02479     MediumVariant_Diff = 0x20000,
02487     MediumVariant_NoCreateDir = 0x40000000,
02488 };
02489 
02490 enum DataType
02491 {
02492     DataType_Int32 = 0,
02493     DataType_Int8 = 1,
02494     DataType_String = 2,
02495 };
02496 
02497 enum DataFlags
02498 {
02499     DataFlags_None = 0x00,
02500     DataFlags_Mandatory = 0x01,
02501     DataFlags_Expert = 0x02,
02502     DataFlags_Array = 0x04,
02503     DataFlags_FlagMask = 0x07,
02504 };
02505 
02513 enum MediumFormatCapabilities
02514 {
02521     MediumFormatCapabilities_Uuid = 0x01,
02528     MediumFormatCapabilities_CreateFixed = 0x02,
02536     MediumFormatCapabilities_CreateDynamic = 0x04,
02543     MediumFormatCapabilities_CreateSplit2G = 0x08,
02550     MediumFormatCapabilities_Differencing = 0x10,
02557     MediumFormatCapabilities_Asynchronous = 0x20,
02567     MediumFormatCapabilities_File = 0x40,
02576     MediumFormatCapabilities_Properties = 0x80,
02583     MediumFormatCapabilities_TcpNetworking = 0x100,
02590     MediumFormatCapabilities_VFS = 0x200,
02591     MediumFormatCapabilities_CapabilityMask = 0x3FF,
02592 };
02593 
02601 enum MouseButtonState
02602 {
02603     MouseButtonState_LeftButton = 0x01,
02604     MouseButtonState_RightButton = 0x02,
02605     MouseButtonState_MiddleButton = 0x04,
02606     MouseButtonState_WheelUp = 0x08,
02607     MouseButtonState_WheelDown = 0x10,
02608     MouseButtonState_XButton1 = 0x20,
02609     MouseButtonState_XButton2 = 0x40,
02610     MouseButtonState_MouseStateMask = 0x7F,
02611 };
02612 
02623 enum FramebufferPixelFormat
02624 {
02632     FramebufferPixelFormat_Opaque = 0,
02640     FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
02641 };
02642 
02650 enum NetworkAttachmentType
02651 {
02656     NetworkAttachmentType_Null = 0,
02657     NetworkAttachmentType_NAT = 1,
02658     NetworkAttachmentType_Bridged = 2,
02659     NetworkAttachmentType_Internal = 3,
02660     NetworkAttachmentType_HostOnly = 4,
02661     NetworkAttachmentType_Generic = 5,
02662 };
02663 
02671 enum NetworkAdapterType
02672 {
02677     NetworkAdapterType_Null = 0,
02682     NetworkAdapterType_Am79C970A = 1,
02687     NetworkAdapterType_Am79C973 = 2,
02692     NetworkAdapterType_I82540EM = 3,
02697     NetworkAdapterType_I82543GC = 4,
02702     NetworkAdapterType_I82545EM = 5,
02707     NetworkAdapterType_Virtio = 6,
02708 };
02709 
02717 enum NetworkAdapterPromiscModePolicy
02718 {
02723     NetworkAdapterPromiscModePolicy_Deny = 1,
02731     NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
02739     NetworkAdapterPromiscModePolicy_AllowAll = 3,
02740 };
02741 
02750 enum PortMode
02751 {
02756     PortMode_Disconnected = 0,
02761     PortMode_HostPipe = 1,
02766     PortMode_HostDevice = 2,
02771     PortMode_RawFile = 3,
02772 };
02773 
02812 enum USBDeviceState
02813 {
02820     USBDeviceState_NotSupported = 0,
02828     USBDeviceState_Unavailable = 1,
02835     USBDeviceState_Busy = 2,
02843     USBDeviceState_Available = 3,
02851     USBDeviceState_Held = 4,
02859     USBDeviceState_Captured = 5,
02860 };
02861 
02871 enum USBDeviceFilterAction
02872 {
02877     USBDeviceFilterAction_Null = 0,
02882     USBDeviceFilterAction_Ignore = 1,
02887     USBDeviceFilterAction_Hold = 2,
02888 };
02889 
02897 enum AudioDriverType
02898 {
02903     AudioDriverType_Null = 0,
02908     AudioDriverType_WinMM = 1,
02913     AudioDriverType_OSS = 2,
02918     AudioDriverType_ALSA = 3,
02923     AudioDriverType_DirectSound = 4,
02928     AudioDriverType_CoreAudio = 5,
02933     AudioDriverType_MMPM = 6,
02938     AudioDriverType_Pulse = 7,
02943     AudioDriverType_SolAudio = 8,
02944 };
02945 
02953 enum AudioControllerType
02954 {
02955     AudioControllerType_AC97 = 0,
02956     AudioControllerType_SB16 = 1,
02957     AudioControllerType_HDA = 2,
02958 };
02959 
02967 enum AuthType
02968 {
02973     AuthType_Null = 0,
02974     AuthType_External = 1,
02975     AuthType_Guest = 2,
02976 };
02977 
02985 enum Reason
02986 {
02991     Reason_Unspecified = 0,
02996     Reason_HostSuspend = 1,
03001     Reason_HostResume = 2,
03006     Reason_HostBatteryLow = 3,
03007 };
03008 
03017 enum StorageBus
03018 {
03023     StorageBus_Null = 0,
03024     StorageBus_IDE = 1,
03025     StorageBus_SATA = 2,
03026     StorageBus_SCSI = 3,
03027     StorageBus_Floppy = 4,
03028     StorageBus_SAS = 5,
03029 };
03030 
03039 enum StorageControllerType
03040 {
03045     StorageControllerType_Null = 0,
03050     StorageControllerType_LsiLogic = 1,
03055     StorageControllerType_BusLogic = 2,
03060     StorageControllerType_IntelAhci = 3,
03065     StorageControllerType_PIIX3 = 4,
03070     StorageControllerType_PIIX4 = 5,
03075     StorageControllerType_ICH6 = 6,
03080     StorageControllerType_I82078 = 7,
03085     StorageControllerType_LsiLogicSas = 8,
03086 };
03087 
03095 enum ChipsetType
03096 {
03101     ChipsetType_Null = 0,
03106     ChipsetType_PIIX3 = 1,
03111     ChipsetType_ICH9 = 2,
03112 };
03113 
03119 enum NATAliasMode
03120 {
03125     NATAliasMode_AliasLog = 0x1,
03130     NATAliasMode_AliasProxyOnly = 0x02,
03135     NATAliasMode_AliasUseSamePorts = 0x04,
03136 };
03137 
03143 enum NATProtocol
03144 {
03149     NATProtocol_UDP = 0,
03154     NATProtocol_TCP = 1,
03155 };
03156 
03164 enum BandwidthGroupType
03165 {
03172     BandwidthGroupType_Null = 0,
03179     BandwidthGroupType_Disk = 1,
03186     BandwidthGroupType_Network = 2,
03187 };
03188 
03197 enum VBoxEventType
03198 {
03205     VBoxEventType_Invalid = 0,
03214     VBoxEventType_Any = 1,
03222     VBoxEventType_Vetoable = 2,
03230     VBoxEventType_MachineEvent = 3,
03238     VBoxEventType_SnapshotEvent = 4,
03247     VBoxEventType_InputEvent = 5,
03254     VBoxEventType_LastWildcard = 31,
03261     VBoxEventType_OnMachineStateChanged = 32,
03268     VBoxEventType_OnMachineDataChanged = 33,
03275     VBoxEventType_OnExtraDataChanged = 34,
03282     VBoxEventType_OnExtraDataCanChange = 35,
03289     VBoxEventType_OnMediumRegistered = 36,
03296     VBoxEventType_OnMachineRegistered = 37,
03303     VBoxEventType_OnSessionStateChanged = 38,
03310     VBoxEventType_OnSnapshotTaken = 39,
03317     VBoxEventType_OnSnapshotDeleted = 40,
03324     VBoxEventType_OnSnapshotChanged = 41,
03331     VBoxEventType_OnGuestPropertyChanged = 42,
03338     VBoxEventType_OnMousePointerShapeChanged = 43,
03345     VBoxEventType_OnMouseCapabilityChanged = 44,
03352     VBoxEventType_OnKeyboardLedsChanged = 45,
03359     VBoxEventType_OnStateChanged = 46,
03366     VBoxEventType_OnAdditionsStateChanged = 47,
03373     VBoxEventType_OnNetworkAdapterChanged = 48,
03380     VBoxEventType_OnSerialPortChanged = 49,
03387     VBoxEventType_OnParallelPortChanged = 50,
03394     VBoxEventType_OnStorageControllerChanged = 51,
03401     VBoxEventType_OnMediumChanged = 52,
03408     VBoxEventType_OnVRDEServerChanged = 53,
03415     VBoxEventType_OnUSBControllerChanged = 54,
03422     VBoxEventType_OnUSBDeviceStateChanged = 55,
03429     VBoxEventType_OnSharedFolderChanged = 56,
03436     VBoxEventType_OnRuntimeError = 57,
03443     VBoxEventType_OnCanShowWindow = 58,
03450     VBoxEventType_OnShowWindow = 59,
03457     VBoxEventType_OnCPUChanged = 60,
03464     VBoxEventType_OnVRDEServerInfoChanged = 61,
03471     VBoxEventType_OnEventSourceChanged = 62,
03478     VBoxEventType_OnCPUExecutionCapChanged = 63,
03485     VBoxEventType_OnGuestKeyboard = 64,
03492     VBoxEventType_OnGuestMouse = 65,
03499     VBoxEventType_OnNATRedirect = 66,
03506     VBoxEventType_OnHostPCIDevicePlug = 67,
03513     VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
03520     VBoxEventType_OnBandwidthGroupChanged = 69,
03527     VBoxEventType_OnGuestMonitorChanged = 70,
03534     VBoxEventType_OnStorageDeviceChanged = 71,
03541     VBoxEventType_OnClipboardModeChanged = 72,
03548     VBoxEventType_OnDragAndDropModeChanged = 73,
03555     VBoxEventType_Last = 74,
03556 };
03557 
03565 enum GuestMonitorChangedEventType
03566 {
03573     GuestMonitorChangedEventType_Enabled = 0,
03580     GuestMonitorChangedEventType_Disabled = 1,
03587     GuestMonitorChangedEventType_NewOrigin = 2,
03588 };
03589 
03623 interface IVirtualBoxErrorInfo : $errorinfo
03624 {
03642     readonly attribute long resultCode;
03643 
03655     readonly attribute wstringUUID interfaceID;
03656 
03667     readonly attribute wstring component;
03668 
03679     readonly attribute wstring text;
03680 
03691     readonly attribute IVirtualBoxErrorInfo next;
03692 
03693 }; /* interface IVirtualBoxErrorInfo */
03694 
03705 interface IDHCPServer : $unknown
03706 {
03712     attribute boolean enabled;
03713 
03719     readonly attribute wstring IPAddress;
03720 
03726     readonly attribute wstring networkMask;
03727 
03733     readonly attribute wstring networkName;
03734 
03740     readonly attribute wstring lowerIP;
03741 
03747     readonly attribute wstring upperIP;
03748 
03777     void setConfiguration (
03778         in wstring IPAddress,
03779         in wstring networkMask,
03780         in wstring FromIPAddress,
03781         in wstring ToIPAddress
03782     );
03783 
03808     void start (
03809         in wstring networkName,
03810         in wstring trunkName,
03811         in wstring trunkType
03812     );
03813 
03826     void stop();
03827 
03828 }; /* interface IDHCPServer */
03829 
03848 interface IVirtualBox : $unknown
03849 {
03862     readonly attribute wstring version;
03863 
03871     readonly attribute wstring versionNormalized;
03872 
03878     readonly attribute unsigned long revision;
03879 
03889     readonly attribute wstring packageType;
03890 
03902     readonly attribute wstring APIVersion;
03903 
03919     readonly attribute wstring homeFolder;
03920 
03928     readonly attribute wstring settingsFilePath;
03929 
03933     readonly attribute IHost host;
03934 
03938     readonly attribute ISystemProperties systemProperties;
03939 
03945     readonly attribute IMachine[] machines;
03946 
03956     readonly attribute wstring[] machineGroups;
03957 
03967     readonly attribute IMedium[] hardDisks;
03968 
03974     readonly attribute IMedium[] DVDImages;
03975 
03981     readonly attribute IMedium[] floppyImages;
03982 
03983     readonly attribute IProgress[] progressOperations;
03984 
03985     readonly attribute IGuestOSType[] guestOSTypes;
03986 
04003     readonly attribute ISharedFolder[] sharedFolders;
04004 
04010     readonly attribute IPerformanceCollector performanceCollector;
04011 
04017     readonly attribute IDHCPServer[] DHCPServers;
04018 
04024     readonly attribute IEventSource eventSource;
04025 
04031     readonly attribute IExtPackManager extensionPackManager;
04032 
04038     readonly attribute wstring[] internalNetworks;
04039 
04045     readonly attribute wstring[] genericNetworkDrivers;
04046 
04097     void composeMachineFilename (
04098         in wstring name,
04099         in wstring group,
04100         in wstring createFlags,
04101         in wstring baseFolder,
04102         [retval] out wstring file
04103     );
04104 
04206     void createMachine (
04207         in wstring settingsFile,
04208         in wstring name,
04209         in wstring[] groups,
04210         in wstring osTypeId,
04211         in wstring flags,
04212         [retval] out IMachine machine
04213     );
04214 
04240     void openMachine (
04241         in wstring settingsFile,
04242         [retval] out IMachine machine
04243     );
04244 
04276     void registerMachine (
04277         in IMachine machine
04278     );
04279 
04300     void findMachine (
04301         in wstring nameOrId,
04302         [retval] out IMachine machine
04303     );
04304 
04316     void getMachinesByGroups (
04317         in wstring[] groups,
04318         [retval] out IMachine[] machines
04319     );
04320 
04330     void getMachineStates (
04331         in IMachine[] machines,
04332         [retval] out MachineState[] states
04333     );
04334 
04344     void createAppliance (
04345         [retval] out IAppliance appliance
04346     );
04347 
04410     void createHardDisk (
04411         in wstring format,
04412         in wstring location,
04413         [retval] out IMedium medium
04414     );
04415 
04521     void openMedium (
04522         in wstring location,
04523         in DeviceType deviceType,
04524         in AccessMode accessMode,
04525         in boolean forceNewUuid,
04526         [retval] out IMedium medium
04527     );
04528 
04557     void getGuestOSType (
04558         in wstringUUID id,
04559         [retval] out IGuestOSType type
04560     );
04561 
04584     void createSharedFolder (
04585         in wstring name,
04586         in wstring hostPath,
04587         in boolean writable,
04588         in boolean automount
04589     );
04590 
04605     void removeSharedFolder (
04606         in wstring name
04607     );
04608 
04617     void getExtraDataKeys (
04618         [retval] out wstring[] value
04619     );
04620 
04649     void getExtraData (
04650         in wstring key,
04651         [retval] out wstring value
04652     );
04653 
04703     void setExtraData (
04704         in wstring key,
04705         in wstring value
04706     );
04707 
04726     void setSettingsSecret (
04727         in wstring password
04728     );
04729 
04746     void createDHCPServer (
04747         in wstring name,
04748         [retval] out IDHCPServer server
04749     );
04750 
04767     void findDHCPServerByNetworkName (
04768         in wstring name,
04769         [retval] out IDHCPServer server
04770     );
04771 
04786     void removeDHCPServer (
04787         in IDHCPServer server
04788     );
04789 
04814     void checkFirmwarePresent (
04815         in FirmwareType firmwareType,
04816         in wstring version,
04817         out wstring url,
04818         out wstring file,
04819         [retval] out boolean result
04820     );
04821 
04822 }; /* interface IVirtualBox */
04823 
04834 interface IVFSExplorer : $unknown
04835 {
04839     readonly attribute wstring path;
04840 
04844     readonly attribute VFSType type;
04845 
04853     void update (
04854         [retval] out IProgress aProgress
04855     );
04856 
04864     void cd (
04865         in wstring aDir,
04866         [retval] out IProgress aProgress
04867     );
04868 
04874     void cdUp (
04875         [retval] out IProgress aProgress
04876     );
04877 
04890     void entryList (
04891         out wstring[] aNames,
04892         out unsigned long[] aTypes,
04893         out unsigned long[] aSizes,
04894         out unsigned long[] aModes
04895     );
04896 
04905     void exists (
04906         in wstring[] aNames,
04907         [retval] out wstring[] aExists
04908     );
04909 
04917     void remove (
04918         in wstring[] aNames,
04919         [retval] out IProgress aProgress
04920     );
04921 
04922 }; /* interface IVFSExplorer */
04923 
04989 interface IAppliance : $unknown
04990 {
04998     readonly attribute wstring path;
04999 
05030     readonly attribute wstring[] disks;
05031 
05039     readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
05040 
05048     readonly attribute wstring[] machines;
05049 
05066     void read (
05067         in wstring file,
05068         [retval] out IProgress aProgress
05069     );
05070 
05087     void interpret();
05088 
05111     void importMachines (
05112         in ImportOptions[] options,
05113         [retval] out IProgress aProgress
05114     );
05115 
05123     void createVFSExplorer (
05124         in wstring aUri,
05125         [retval] out IVFSExplorer aExplorer
05126     );
05127 
05157     void write (
05158         in wstring format,
05159         in boolean manifest,
05160         in wstring path,
05161         [retval] out IProgress progress
05162     );
05163 
05169     void getWarnings (
05170         [retval] out wstring[] aWarnings
05171     );
05172 
05173 }; /* interface IAppliance */
05174 
05186 interface IVirtualSystemDescription : $unknown
05187 {
05191     readonly attribute unsigned long count;
05192 
05316     void getDescription (
05317         out VirtualSystemDescriptionType[] aTypes,
05318         out wstring[] aRefs,
05319         out wstring[] aOvfValues,
05320         out wstring[] aVBoxValues,
05321         out wstring[] aExtraConfigValues
05322     );
05323 
05340     void getDescriptionByType (
05341         in VirtualSystemDescriptionType aType,
05342         out VirtualSystemDescriptionType[] aTypes,
05343         out wstring[] aRefs,
05344         out wstring[] aOvfValues,
05345         out wstring[] aVBoxValues,
05346         out wstring[] aExtraConfigValues
05347     );
05348 
05360     void getValuesByType (
05361         in VirtualSystemDescriptionType aType,
05362         in VirtualSystemDescriptionValueType aWhich,
05363         [retval] out wstring[] aValues
05364     );
05365 
05391     void setFinalValues (
05392         in boolean[] aEnabled,
05393         in wstring[] aVBoxValues,
05394         in wstring[] aExtraConfigValues
05395     );
05396 
05411     void addDescription (
05412         in VirtualSystemDescriptionType aType,
05413         in wstring aVBoxValue,
05414         in wstring aExtraConfigValue
05415     );
05416 
05417 }; /* interface IVirtualSystemDescription */
05418 
05419 interface IInternalMachineControl : $unknown
05420 {
05427     void setRemoveSavedStateFile (
05428         in boolean aRemove
05429     );
05430 
05442     void updateState (
05443         in MachineState state
05444     );
05445 
05446     void getIPCId (
05447         [retval] out wstring id
05448     );
05449 
05461     void beginPowerUp (
05462         in IProgress aProgress
05463     );
05464 
05474     void endPowerUp (
05475         in long result
05476     );
05477 
05489     void beginPoweringDown (
05490         out IProgress progress
05491     );
05492 
05522     void endPoweringDown (
05523         in long result,
05524         in wstring errMsg
05525     );
05526 
05540     void runUSBDeviceFilters (
05541         in IUSBDevice device,
05542         out boolean matched,
05543         out unsigned long maskedInterfaces
05544     );
05545 
05554     void captureUSBDevice (
05555         in wstringUUID id
05556     );
05557 
05573     void detachUSBDevice (
05574         in wstringUUID id,
05575         in boolean done
05576     );
05577 
05586     void autoCaptureUSBDevices();
05587 
05603     void detachAllUSBDevices (
05604         in boolean done
05605     );
05606 
05621     void onSessionEnd (
05622         in ISession session,
05623         [retval] out IProgress progress
05624     );
05625 
05641     void beginSavingState (
05642         out IProgress progress,
05643         out wstring stateFilePath
05644     );
05645 
05675     void endSavingState (
05676         in long result,
05677         in wstring errMsg
05678     );
05679 
05694     void adoptSavedState (
05695         in wstring savedStateFile
05696     );
05697 
05746     void beginTakingSnapshot (
05747         in IConsole initiator,
05748         in wstring name,
05749         in wstring description,
05750         in IProgress consoleProgress,
05751         in boolean fTakingSnapshotOnline,
05752         out wstring stateFilePath
05753     );
05754 
05764     void endTakingSnapshot (
05765         in boolean success
05766     );
05767 
05796     void deleteSnapshot (
05797         in IConsole initiator,
05798         in wstringUUID startId,
05799         in wstringUUID endId,
05800         in boolean deleteAllChildren,
05801         out MachineState machineState,
05802         [retval] out IProgress progress
05803     );
05804 
05823     void finishOnlineMergeMedium (
05824         in IMediumAttachment mediumAttachment,
05825         in IMedium source,
05826         in IMedium target,
05827         in boolean mergeForward,
05828         in IMedium parentForTarget,
05829         in IMedium[] childrenToReparent
05830     );
05831 
05845     void restoreSnapshot (
05846         in IConsole initiator,
05847         in ISnapshot snapshot,
05848         out MachineState machineState,
05849         [retval] out IProgress progress
05850     );
05851 
05878     void pullGuestProperties (
05879         out wstring[] name,
05880         out wstring[] value,
05881         out long long[] timestamp,
05882         out wstring[] flags
05883     );
05884 
05906     void pushGuestProperty (
05907         in wstring name,
05908         in wstring value,
05909         in long long timestamp,
05910         in wstring flags
05911     );
05912 
05924     void lockMedia();
05925 
05935     void unlockMedia();
05936 
05952     void ejectMedium (
05953         in IMediumAttachment attachment,
05954         [retval] out IMediumAttachment newAttachment
05955     );
05956 
05997     void reportVmStatistics (
05998         in unsigned long validStats,
05999         in unsigned long cpuUser,
06000         in unsigned long cpuKernel,
06001         in unsigned long cpuIdle,
06002         in unsigned long memTotal,
06003         in unsigned long memFree,
06004         in unsigned long memBalloon,
06005         in unsigned long memShared,
06006         in unsigned long memCache,
06007         in unsigned long pagedTotal,
06008         in unsigned long memAllocTotal,
06009         in unsigned long memFreeTotal,
06010         in unsigned long memBalloonTotal,
06011         in unsigned long memSharedTotal,
06012         in unsigned long vmNetRx,
06013         in unsigned long vmNetTx
06014     );
06015 
06016 }; /* interface IInternalMachineControl */
06017 
06026 interface IBIOSSettings : $unknown
06027 {
06031     attribute boolean logoFadeIn;
06032 
06036     attribute boolean logoFadeOut;
06037 
06041     attribute unsigned long logoDisplayTime;
06042 
06049     attribute wstring logoImagePath;
06050 
06054     attribute BIOSBootMenuMode bootMenuMode;
06055 
06059     attribute boolean ACPIEnabled;
06060 
06067     attribute boolean IOAPICEnabled;
06068 
06078     attribute long long timeOffset;
06079 
06086     attribute boolean PXEDebugEnabled;
06087 
06088 }; /* interface IBIOSSettings */
06089 
06097 interface IPCIAddress : $unknown
06098 {
06104     attribute short bus;
06105 
06111     attribute short device;
06112 
06118     attribute short devFunction;
06119 
06125     void asLong (
06126         [retval] out long result
06127     );
06128 
06134     void fromLong (
06135         in long number
06136     );
06137 
06138 }; /* interface IPCIAddress */
06139 
06147 interface IPCIDeviceAttachment : $unknown
06148 {
06154     readonly attribute wstring name;
06155 
06161     readonly attribute boolean isPhysicalDevice;
06162 
06168     readonly attribute long hostAddress;
06169 
06175     readonly attribute long guestAddress;
06176 
06177 }; /* interface IPCIDeviceAttachment */
06178 
06219 interface IMachine : $unknown
06220 {
06224     readonly attribute IVirtualBox parent;
06225 
06275     readonly attribute boolean accessible;
06276 
06288     readonly attribute IVirtualBoxErrorInfo accessError;
06289 
06329     attribute wstring name;
06330 
06341     attribute wstring description;
06342 
06346     readonly attribute wstringUUID id;
06347 
06358     attribute wstring[] groups;
06359 
06374     attribute wstring OSTypeId;
06375 
06379     attribute wstring hardwareVersion;
06380 
06390     attribute wstringUUID hardwareUUID;
06391 
06395     attribute unsigned long CPUCount;
06396 
06402     attribute boolean CPUHotPlugEnabled;
06403 
06411     attribute unsigned long CPUExecutionCap;
06412 
06416     attribute unsigned long memorySize;
06417 
06421     attribute unsigned long memoryBalloonSize;
06422 
06429     attribute boolean pageFusionEnabled;
06430 
06434     attribute unsigned long VRAMSize;
06435 
06441     attribute boolean accelerate3DEnabled;
06442 
06448     attribute boolean accelerate2DVideoEnabled;
06449 
06460     attribute unsigned long monitorCount;
06461 
06467     attribute boolean VideoCaptureEnabled;
06468 
06474     attribute wstring VideoCaptureFile;
06475 
06481     attribute unsigned long VideoCaptureWidth;
06482 
06488     attribute unsigned long VideoCaptureHeight;
06489 
06493     readonly attribute IBIOSSettings BIOSSettings;
06494 
06499     attribute FirmwareType firmwareType;
06500 
06506     attribute PointingHIDType pointingHIDType;
06507 
06513     attribute KeyboardHIDType keyboardHIDType;
06514 
06521     attribute boolean HPETEnabled;
06522 
06526     attribute ChipsetType chipsetType;
06527 
06561     attribute wstring snapshotFolder;
06562 
06566     readonly attribute IVRDEServer VRDEServer;
06567 
06568     attribute boolean emulatedUSBWebcameraEnabled;
06569 
06570     attribute boolean emulatedUSBCardReaderEnabled;
06571 
06575     readonly attribute IMediumAttachment[] mediumAttachments;
06576 
06588     readonly attribute IUSBController USBController;
06589 
06593     readonly attribute IAudioAdapter audioAdapter;
06594 
06598     readonly attribute IStorageController[] storageControllers;
06599 
06605     readonly attribute wstring settingsFilePath;
06606 
06631     readonly attribute boolean settingsModified;
06632 
06636     readonly attribute SessionState sessionState;
06637 
06650     readonly attribute wstring sessionType;
06651 
06661     readonly attribute unsigned long sessionPID;
06662 
06666     readonly attribute MachineState state;
06667 
06674     readonly attribute long long lastStateChange;
06675 
06687     readonly attribute wstring stateFilePath;
06688 
06698     readonly attribute wstring logFolder;
06699 
06710     readonly attribute ISnapshot currentSnapshot;
06711 
06718     readonly attribute unsigned long snapshotCount;
06719 
06751     readonly attribute boolean currentStateModified;
06752 
06764     readonly attribute ISharedFolder[] sharedFolders;
06765 
06772     attribute ClipboardMode clipboardMode;
06773 
06779     attribute DragAndDropMode dragAndDropMode;
06780 
06788     attribute wstring guestPropertyNotificationPatterns;
06789 
06798     attribute boolean teleporterEnabled;
06799 
06810     attribute unsigned long teleporterPort;
06811 
06818     attribute wstring teleporterAddress;
06819 
06830     attribute wstring teleporterPassword;
06831 
06839     attribute FaultToleranceState faultToleranceState;
06840 
06847     attribute unsigned long faultTolerancePort;
06848 
06854     attribute wstring faultToleranceAddress;
06855 
06863     attribute wstring faultTolerancePassword;
06864 
06870     attribute unsigned long faultToleranceSyncInterval;
06871 
06879     attribute boolean RTCUseUTC;
06880 
06887     attribute boolean IOCacheEnabled;
06888 
06894     attribute unsigned long IOCacheSize;
06895 
06905     readonly attribute IPCIDeviceAttachment[] PCIDeviceAssignments;
06906 
06912     readonly attribute IBandwidthControl bandwidthControl;
06913 
06922     attribute boolean tracingEnabled;
06923 
06938     attribute wstring tracingConfig;
06939 
06952     attribute boolean allowTracingToAccessVM;
06953 
06959     attribute boolean autostartEnabled;
06960 
06966     attribute unsigned long autostartDelay;
06967 
06973     attribute AutostopType autostopType;
06974 
07080     void lockMachine (
07081         in ISession session,
07082         in LockType lockType
07083     );
07084 
07214     void launchVMProcess (
07215         in ISession session,
07216         in wstring type,
07217         in wstring environment,
07218         [retval] out IProgress progress
07219     );
07220 
07258     void setBootOrder (
07259         in unsigned long position,
07260         in DeviceType device
07261     );
07262 
07297     void getBootOrder (
07298         in unsigned long position,
07299         [retval] out DeviceType device
07300     );
07301 
07403     void attachDevice (
07404         in wstring name,
07405         in long controllerPort,
07406         in long device,
07407         in DeviceType type,
07408         in IMedium medium
07409     );
07410 
07506     void attachDeviceWithoutMedium (
07507         in wstring name,
07508         in long controllerPort,
07509         in long device,
07510         in DeviceType type
07511     );
07512 
07566     void detachDevice (
07567         in wstring name,
07568         in long controllerPort,
07569         in long device
07570     );
07571 
07614     void passthroughDevice (
07615         in wstring name,
07616         in long controllerPort,
07617         in long device,
07618         in boolean passthrough
07619     );
07620 
07663     void temporaryEjectDevice (
07664         in wstring name,
07665         in long controllerPort,
07666         in long device,
07667         in boolean temporaryEject
07668     );
07669 
07715     void nonRotationalDevice (
07716         in wstring name,
07717         in long controllerPort,
07718         in long device,
07719         in boolean nonRotational
07720     );
07721 
07767     void setAutoDiscardForDevice (
07768         in wstring name,
07769         in long controllerPort,
07770         in long device,
07771         in boolean discard
07772     );
07773 
07814     void setBandwidthGroupForDevice (
07815         in wstring name,
07816         in long controllerPort,
07817         in long device,
07818         in IBandwidthGroup bandwidthGroup
07819     );
07820 
07857     void setNoBandwidthGroupForDevice (
07858         in wstring name,
07859         in long controllerPort,
07860         in long device
07861     );
07862 
07927     void unmountMedium (
07928         in wstring name,
07929         in long controllerPort,
07930         in long device,
07931         in boolean force
07932     );
07933 
07996     void mountMedium (
07997         in wstring name,
07998         in long controllerPort,
07999         in long device,
08000         in IMedium medium,
08001         in boolean force
08002     );
08003 
08032     void getMedium (
08033         in wstring name,
08034         in long controllerPort,
08035         in long device,
08036         [retval] out IMedium medium
08037     );
08038 
08053     void getMediumAttachmentsOfController (
08054         in wstring name,
08055         [retval] out IMediumAttachment[] mediumAttachments
08056     );
08057 
08072     void getMediumAttachment (
08073         in wstring name,
08074         in long controllerPort,
08075         in long device,
08076         [retval] out IMediumAttachment attachment
08077     );
08078 
08119     void attachHostPCIDevice (
08120         in long hostAddress,
08121         in long desiredGuestAddress,
08122         in boolean tryToUnbind
08123     );
08124 
08165     void detachHostPCIDevice (
08166         in long hostAddress
08167     );
08168 
08186     void getNetworkAdapter (
08187         in unsigned long slot,
08188         [retval] out INetworkAdapter adapter
08189     );
08190 
08223     void addStorageController (
08224         in wstring name,
08225         in StorageBus connectionType,
08226         [retval] out IStorageController controller
08227     );
08228 
08242     void getStorageControllerByName (
08243         in wstring name,
08244         [retval] out IStorageController storageController
08245     );
08246 
08260     void getStorageControllerByInstance (
08261         in unsigned long instance,
08262         [retval] out IStorageController storageController
08263     );
08264 
08287     void removeStorageController (
08288         in wstring name
08289     );
08290 
08312     void setStorageControllerBootable (
08313         in wstring name,
08314         in boolean bootable
08315     );
08316 
08334     void getSerialPort (
08335         in unsigned long slot,
08336         [retval] out ISerialPort port
08337     );
08338 
08356     void getParallelPort (
08357         in unsigned long slot,
08358         [retval] out IParallelPort port
08359     );
08360 
08369     void getExtraDataKeys (
08370         [retval] out wstring[] value
08371     );
08372 
08401     void getExtraData (
08402         in wstring key,
08403         [retval] out wstring value
08404     );
08405 
08455     void setExtraData (
08456         in wstring key,
08457         in wstring value
08458     );
08459 
08481     void getCPUProperty (
08482         in CPUPropertyType property,
08483         [retval] out boolean value
08484     );
08485 
08507     void setCPUProperty (
08508         in CPUPropertyType property,
08509         in boolean value
08510     );
08511 
08551     void getCPUIDLeaf (
08552         in unsigned long id,
08553         out unsigned long valEax,
08554         out unsigned long valEbx,
08555         out unsigned long valEcx,
08556         out unsigned long valEdx
08557     );
08558 
08602     void setCPUIDLeaf (
08603         in unsigned long id,
08604         in unsigned long valEax,
08605         in unsigned long valEbx,
08606         in unsigned long valEcx,
08607         in unsigned long valEdx
08608     );
08609 
08627     void removeCPUIDLeaf (
08628         in unsigned long id
08629     );
08630 
08636     void removeAllCPUIDLeaves();
08637 
08659     void getHWVirtExProperty (
08660         in HWVirtExPropertyType property,
08661         [retval] out boolean value
08662     );
08663 
08685     void setHWVirtExProperty (
08686         in HWVirtExPropertyType property,
08687         in boolean value
08688     );
08689 
08735     void saveSettings();
08736 
08760     void discardSettings();
08761 
08845     void unregister (
08846         in CleanupMode cleanupMode,
08847         [retval] out IMedium[] aMedia
08848     );
08849 
08906     void delete (
08907         in IMedium[] aMedia,
08908         [retval] out IProgress aProgress
08909     );
08910 
08922     void export (
08923         in IAppliance aAppliance,
08924         in wstring location,
08925         [retval] out IVirtualSystemDescription aDescription
08926     );
08927 
08951     void findSnapshot (
08952         in wstring nameOrId,
08953         [retval] out ISnapshot snapshot
08954     );
08955 
08989     void createSharedFolder (
08990         in wstring name,
08991         in wstring hostPath,
08992         in boolean writable,
08993         in boolean automount
08994     );
08995 
09021     void removeSharedFolder (
09022         in wstring name
09023     );
09024 
09048     void canShowConsoleWindow (
09049         [retval] out boolean canShow
09050     );
09051 
09086     void showConsoleWindow (
09087         [retval] out long long winId
09088     );
09089 
09122     void getGuestProperty (
09123         in wstring name,
09124         out wstring value,
09125         out long long timestamp,
09126         out wstring flags
09127     );
09128 
09151     void getGuestPropertyValue (
09152         in wstring property,
09153         [retval] out wstring value
09154     );
09155 
09178     void getGuestPropertyTimestamp (
09179         in wstring property,
09180         [retval] out long long value
09181     );
09182 
09233     void setGuestProperty (
09234         in wstring property,
09235         in wstring value,
09236         in wstring flags
09237     );
09238 
09279     void setGuestPropertyValue (
09280         in wstring property,
09281         in wstring value
09282     );
09283 
09301     void deleteGuestProperty (
09302         in wstring name
09303     );
09304 
09335     void enumerateGuestProperties (
09336         in wstring patterns,
09337         out wstring[] name,
09338         out wstring[] value,
09339         out long long[] timestamp,
09340         out wstring[] flags
09341     );
09342 
09372     void querySavedGuestScreenInfo (
09373         in unsigned long screenId,
09374         out unsigned long originX,
09375         out unsigned long originY,
09376         out unsigned long width,
09377         out unsigned long height,
09378         out boolean enabled
09379     );
09380 
09402     void querySavedThumbnailSize (
09403         in unsigned long screenId,
09404         out unsigned long size,
09405         out unsigned long width,
09406         out unsigned long height
09407     );
09408 
09435     void readSavedThumbnailToArray (
09436         in unsigned long screenId,
09437         in boolean BGR,
09438         out unsigned long width,
09439         out unsigned long height,
09440         [retval] out octet[] data
09441     );
09442 
09464     void readSavedThumbnailPNGToArray (
09465         in unsigned long screenId,
09466         out unsigned long width,
09467         out unsigned long height,
09468         [retval] out octet[] data
09469     );
09470 
09492     void querySavedScreenshotPNGSize (
09493         in unsigned long screenId,
09494         out unsigned long size,
09495         out unsigned long width,
09496         out unsigned long height
09497     );
09498 
09520     void readSavedScreenshotPNGToArray (
09521         in unsigned long screenId,
09522         out unsigned long width,
09523         out unsigned long height,
09524         [retval] out octet[] data
09525     );
09526 
09536     void hotPlugCPU (
09537         in unsigned long cpu
09538     );
09539 
09549     void hotUnplugCPU (
09550         in unsigned long cpu
09551     );
09552 
09566     void getCPUStatus (
09567         in unsigned long cpu,
09568         [retval] out boolean attached
09569     );
09570 
09585     void queryLogFilename (
09586         in unsigned long idx,
09587         [retval] out wstring filename
09588     );
09589 
09615     void readLog (
09616         in unsigned long idx,
09617         in long long offset,
09618         in long long size,
09619         [retval] out octet[] data
09620     );
09621 
09654     void cloneTo (
09655         in IMachine target,
09656         in CloneMode mode,
09657         in CloneOptions[] options,
09658         [retval] out IProgress progress
09659     );
09660 
09661 }; /* interface IMachine */
09662 
09671 interface IVRDEServerInfo : $unknown
09672 {
09678     readonly attribute boolean active;
09679 
09688     readonly attribute long port;
09689 
09695     readonly attribute unsigned long numberOfClients;
09696 
09702     readonly attribute long long beginTime;
09703 
09710     readonly attribute long long endTime;
09711 
09717     readonly attribute long long bytesSent;
09718 
09724     readonly attribute long long bytesSentTotal;
09725 
09731     readonly attribute long long bytesReceived;
09732 
09738     readonly attribute long long bytesReceivedTotal;
09739 
09745     readonly attribute wstring user;
09746 
09752     readonly attribute wstring domain;
09753 
09759     readonly attribute wstring clientName;
09760 
09766     readonly attribute wstring clientIP;
09767 
09773     readonly attribute unsigned long clientVersion;
09774 
09782     readonly attribute unsigned long encryptionStyle;
09783 
09784 }; /* interface IVRDEServerInfo */
09785 
09807 interface IConsole : $unknown
09808 {
09820     readonly attribute IMachine machine;
09821 
09835     readonly attribute MachineState state;
09836 
09840     readonly attribute IGuest guest;
09841 
09852     readonly attribute IKeyboard keyboard;
09853 
09864     readonly attribute IMouse mouse;
09865 
09875     readonly attribute IDisplay display;
09876 
09880     readonly attribute IMachineDebugger debugger;
09881 
09892     readonly attribute IUSBDevice[] USBDevices;
09893 
09901     readonly attribute IHostUSBDevice[] remoteUSBDevices;
09902 
09918     readonly attribute ISharedFolder[] sharedFolders;
09919 
09925     readonly attribute IVRDEServerInfo VRDEServerInfo;
09926 
09932     readonly attribute IEventSource eventSource;
09933 
09937     readonly attribute IPCIDeviceAttachment[] attachedPCIDevices;
09938 
09947     attribute boolean useHostClipboard;
09948 
10013     void powerUp (
10014         [retval] out IProgress progress
10015     );
10016 
10050     void powerUpPaused (
10051         [retval] out IProgress progress
10052     );
10053 
10073     void powerDown (
10074         [retval] out IProgress progress
10075     );
10076 
10096     void reset();
10097 
10117     void pause();
10118 
10138     void resume();
10139 
10159     void powerButton();
10160 
10180     void sleepButton();
10181 
10193     void getPowerButtonHandled (
10194         [retval] out boolean handled
10195     );
10196 
10210     void getGuestEnteredACPIMode (
10211         [retval] out boolean entered
10212     );
10213 
10266     void saveState (
10267         [retval] out IProgress progress
10268     );
10269 
10302     void adoptSavedState (
10303         in wstring savedStateFile
10304     );
10305 
10336     void discardSavedState (
10337         in boolean fRemoveFile
10338     );
10339 
10352     void getDeviceActivity (
10353         in DeviceType type,
10354         [retval] out DeviceActivity activity
10355     );
10356 
10394     void attachUSBDevice (
10395         in wstringUUID id
10396     );
10397 
10432     void detachUSBDevice (
10433         in wstringUUID id,
10434         [retval] out IUSBDevice device
10435     );
10436 
10459     void findUSBDeviceByAddress (
10460         in wstring name,
10461         [retval] out IUSBDevice device
10462     );
10463 
10483     void findUSBDeviceById (
10484         in wstringUUID id,
10485         [retval] out IUSBDevice device
10486     );
10487 
10521     void createSharedFolder (
10522         in wstring name,
10523         in wstring hostPath,
10524         in boolean writable,
10525         in boolean automount
10526     );
10527 
10552     void removeSharedFolder (
10553         in wstring name
10554     );
10555 
10593     void takeSnapshot (
10594         in wstring name,
10595         in wstring description,
10596         [retval] out IProgress progress
10597     );
10598 
10671     void deleteSnapshot (
10672         in wstringUUID id,
10673         [retval] out IProgress progress
10674     );
10675 
10715     void deleteSnapshotAndAllChildren (
10716         in wstringUUID id,
10717         [retval] out IProgress progress
10718     );
10719 
10763     void deleteSnapshotRange (
10764         in wstringUUID startId,
10765         in wstringUUID endId,
10766         [retval] out IProgress progress
10767     );
10768 
10809     void restoreSnapshot (
10810         in ISnapshot snapshot,
10811         [retval] out IProgress progress
10812     );
10813 
10852     void teleport (
10853         in wstring hostname,
10854         in unsigned long tcpport,
10855         in wstring password,
10856         in unsigned long maxDowntime,
10857         [retval] out IProgress progress
10858     );
10859 
10860 }; /* interface IConsole */
10861 
10872 interface IHostNetworkInterface : $unknown
10873 {
10877     readonly attribute wstring name;
10878 
10882     readonly attribute wstringUUID id;
10883 
10887     readonly attribute wstring networkName;
10888 
10892     readonly attribute boolean DHCPEnabled;
10893 
10897     readonly attribute wstring IPAddress;
10898 
10902     readonly attribute wstring networkMask;
10903 
10907     readonly attribute boolean IPV6Supported;
10908 
10912     readonly attribute wstring IPV6Address;
10913 
10917     readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
10918 
10922     readonly attribute wstring hardwareAddress;
10923 
10927     readonly attribute HostNetworkInterfaceMediumType mediumType;
10928 
10932     readonly attribute HostNetworkInterfaceStatus status;
10933 
10937     readonly attribute HostNetworkInterfaceType interfaceType;
10938 
10950     void enableStaticIPConfig (
10951         in wstring IPAddress,
10952         in wstring networkMask
10953     );
10954 
10966     void enableStaticIPConfigV6 (
10967         in wstring IPV6Address,
10968         in unsigned long IPV6NetworkMaskPrefixLength
10969     );
10970 
10974     void enableDynamicIPConfig();
10975 
10979     void DHCPRediscover();
10980 
10981 }; /* interface IHostNetworkInterface */
10982 
10999 interface IHost : $unknown
11000 {
11004     readonly attribute IMedium[] DVDDrives;
11005 
11009     readonly attribute IMedium[] floppyDrives;
11010 
11024     readonly attribute IHostUSBDevice[] USBDevices;
11025 
11049     readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
11050 
11054     readonly attribute IHostNetworkInterface[] networkInterfaces;
11055 
11059     readonly attribute unsigned long processorCount;
11060 
11064     readonly attribute unsigned long processorOnlineCount;
11065 
11069     readonly attribute unsigned long processorCoreCount;
11070 
11074     readonly attribute unsigned long memorySize;
11075 
11079     readonly attribute unsigned long memoryAvailable;
11080 
11084     readonly attribute wstring operatingSystem;
11085 
11089     readonly attribute wstring OSVersion;
11090 
11094     readonly attribute long long UTCTime;
11095 
11099     readonly attribute boolean acceleration3DAvailable;
11100 
11115     void getProcessorSpeed (
11116         in unsigned long cpuId,
11117         [retval] out unsigned long speed
11118     );
11119 
11131     void getProcessorFeature (
11132         in ProcessorFeature feature,
11133         [retval] out boolean supported
11134     );
11135 
11154     void getProcessorDescription (
11155         in unsigned long cpuId,
11156         [retval] out wstring description
11157     );
11158 
11199     void getProcessorCPUIDLeaf (
11200         in unsigned long cpuId,
11201         in unsigned long leaf,
11202         in unsigned long subLeaf,
11203         out unsigned long valEax,
11204         out unsigned long valEbx,
11205         out unsigned long valEcx,
11206         out unsigned long valEdx
11207     );
11208 
11229     void createHostOnlyNetworkInterface (
11230         out IHostNetworkInterface hostInterface,
11231         [retval] out IProgress progress
11232     );
11233 
11254     void removeHostOnlyNetworkInterface (
11255         in wstringUUID id,
11256         [retval] out IProgress progress
11257     );
11258 
11278     void createUSBDeviceFilter (
11279         in wstring name,
11280         [retval] out IHostUSBDeviceFilter filter
11281     );
11282 
11325     void insertUSBDeviceFilter (
11326         in unsigned long position,
11327         in IHostUSBDeviceFilter filter
11328     );
11329 
11357     void removeUSBDeviceFilter (
11358         in unsigned long position
11359     );
11360 
11378     void findHostDVDDrive (
11379         in wstring name,
11380         [retval] out IMedium drive
11381     );
11382 
11400     void findHostFloppyDrive (
11401         in wstring name,
11402         [retval] out IMedium drive
11403     );
11404 
11420     void findHostNetworkInterfaceByName (
11421         in wstring name,
11422         [retval] out IHostNetworkInterface networkInterface
11423     );
11424 
11440     void findHostNetworkInterfaceById (
11441         in wstringUUID id,
11442         [retval] out IHostNetworkInterface networkInterface
11443     );
11444 
11454     void findHostNetworkInterfacesOfType (
11455         in HostNetworkInterfaceType type,
11456         [retval] out IHostNetworkInterface[] networkInterfaces
11457     );
11458 
11478     void findUSBDeviceById (
11479         in wstringUUID id,
11480         [retval] out IHostUSBDevice device
11481     );
11482 
11505     void findUSBDeviceByAddress (
11506         in wstring name,
11507         [retval] out IHostUSBDevice device
11508     );
11509 
11517     void generateMACAddress (
11518         [retval] out wstring address
11519     );
11520 
11521 }; /* interface IHost */
11522 
11535 interface ISystemProperties : $unknown
11536 {
11540     readonly attribute unsigned long minGuestRAM;
11541 
11545     readonly attribute unsigned long maxGuestRAM;
11546 
11550     readonly attribute unsigned long minGuestVRAM;
11551 
11555     readonly attribute unsigned long maxGuestVRAM;
11556 
11560     readonly attribute unsigned long minGuestCPUCount;
11561 
11565     readonly attribute unsigned long maxGuestCPUCount;
11566 
11570     readonly attribute unsigned long maxGuestMonitors;
11571 
11576     readonly attribute long long infoVDSize;
11577 
11584     readonly attribute unsigned long serialPortCount;
11585 
11592     readonly attribute unsigned long parallelPortCount;
11593 
11603     readonly attribute unsigned long maxBootPosition;
11604 
11628     attribute wstring defaultMachineFolder;
11629 
11654     readonly attribute IMediumFormat[] mediumFormats;
11655 
11689     attribute wstring defaultHardDiskFormat;
11690 
11696     attribute long long freeDiskSpaceWarning;
11697 
11702     attribute unsigned long freeDiskSpacePercentWarning;
11703 
11709     attribute long long freeDiskSpaceError;
11710 
11715     attribute unsigned long freeDiskSpacePercentError;
11716 
11740     attribute wstring VRDEAuthLibrary;
11741 
11770     attribute wstring webServiceAuthLibrary;
11771 
11785     attribute wstring defaultVRDEExtPack;
11786 
11792     attribute unsigned long logHistoryCount;
11793 
11798     readonly attribute AudioDriverType defaultAudioDriver;
11799 
11806     attribute wstring autostartDatabasePath;
11807 
11814     attribute wstring defaultAdditionsISO;
11815 
11826     void getMaxNetworkAdapters (
11827         in ChipsetType chipset,
11828         [retval] out unsigned long maxNetworkAdapters
11829     );
11830 
11844     void getMaxNetworkAdaptersOfType (
11845         in ChipsetType chipset,
11846         in NetworkAttachmentType type,
11847         [retval] out unsigned long maxNetworkAdapters
11848     );
11849 
11859     void getMaxDevicesPerPortForStorageBus (
11860         in StorageBus bus,
11861         [retval] out unsigned long maxDevicesPerPort
11862     );
11863 
11871     void getMinPortCountForStorageBus (
11872         in StorageBus bus,
11873         [retval] out unsigned long minPortCount
11874     );
11875 
11883     void getMaxPortCountForStorageBus (
11884         in StorageBus bus,
11885         [retval] out unsigned long maxPortCount
11886     );
11887 
11900     void getMaxInstancesOfStorageBus (
11901         in ChipsetType chipset,
11902         in StorageBus bus,
11903         [retval] out unsigned long maxInstances
11904     );
11905 
11915     void getDeviceTypesForStorageBus (
11916         in StorageBus bus,
11917         [retval] out DeviceType[] deviceTypes
11918     );
11919 
11928     void getDefaultIoCacheSettingForStorageController (
11929         in StorageControllerType controllerType,
11930         [retval] out boolean enabled
11931     );
11932 
11933 }; /* interface ISystemProperties */
11934 
11940 interface IGuestOSType : $unknown
11941 {
11945     readonly attribute wstring familyId;
11946 
11950     readonly attribute wstring familyDescription;
11951 
11955     readonly attribute wstring id;
11956 
11960     readonly attribute wstring description;
11961 
11965     readonly attribute boolean is64Bit;
11966 
11970     readonly attribute boolean recommendedIOAPIC;
11971 
11975     readonly attribute boolean recommendedVirtEx;
11976 
11980     readonly attribute unsigned long recommendedRAM;
11981 
11985     readonly attribute unsigned long recommendedVRAM;
11986 
11990     readonly attribute boolean recommended2DVideoAcceleration;
11991 
11995     readonly attribute boolean recommended3DAcceleration;
11996 
12000     readonly attribute long long recommendedHDD;
12001 
12005     readonly attribute NetworkAdapterType adapterType;
12006 
12010     readonly attribute boolean recommendedPAE;
12011 
12015     readonly attribute StorageControllerType recommendedDVDStorageController;
12016 
12020     readonly attribute StorageBus recommendedDVDStorageBus;
12021 
12025     readonly attribute StorageControllerType recommendedHDStorageController;
12026 
12030     readonly attribute StorageBus recommendedHDStorageBus;
12031 
12035     readonly attribute FirmwareType recommendedFirmware;
12036 
12040     readonly attribute boolean recommendedUSBHID;
12041 
12045     readonly attribute boolean recommendedHPET;
12046 
12050     readonly attribute boolean recommendedUSBTablet;
12051 
12055     readonly attribute boolean recommendedRTCUseUTC;
12056 
12060     readonly attribute ChipsetType recommendedChipset;
12061 
12065     readonly attribute AudioControllerType recommendedAudioController;
12066 
12070     readonly attribute boolean recommendedFloppy;
12071 
12075     readonly attribute boolean recommendedUSB;
12076 
12077 }; /* interface IGuestOSType */
12078 
12086 interface IAdditionsFacility : $unknown
12087 {
12091     readonly attribute AdditionsFacilityClass classType;
12092 
12099     readonly attribute long long lastUpdated;
12100 
12104     readonly attribute wstring name;
12105 
12109     readonly attribute AdditionsFacilityStatus status;
12110 
12114     readonly attribute AdditionsFacilityType type;
12115 
12116 }; /* interface IAdditionsFacility */
12117 
12143 interface IGuestSession : $unknown
12144 {
12150     readonly attribute wstring user;
12151 
12157     readonly attribute wstring domain;
12158 
12162     readonly attribute wstring name;
12163 
12167     readonly attribute unsigned long id;
12168 
12181     attribute unsigned long timeout;
12182 
12188     attribute wstring[] environment;
12189 
12195     readonly attribute IGuestProcess[] processes;
12196 
12202     readonly attribute IGuestDirectory[] directories;
12203 
12209     readonly attribute IGuestFile[] files;
12210 
12218     void close();
12219 
12241     void copyFrom (
12242         in wstring source,
12243         in wstring dest,
12244         in CopyFileFlag[] flags,
12245         [retval] out IProgress progress
12246     );
12247 
12269     void copyTo (
12270         in wstring source,
12271         in wstring dest,
12272         in CopyFileFlag[] flags,
12273         [retval] out IProgress progress
12274     );
12275 
12295     void directoryCreate (
12296         in wstring path,
12297         in unsigned long mode,
12298         in DirectoryCreateFlag[] flags
12299     );
12300 
12352     void directoryCreateTemp (
12353         in wstring templateName,
12354         in unsigned long mode,
12355         in wstring path,
12356         in boolean secure,
12357         [retval] out wstring directory
12358     );
12359 
12377     void directoryExists (
12378         in wstring path,
12379         [retval] out boolean exists
12380     );
12381 
12412     void directoryOpen (
12413         in wstring path,
12414         in wstring filter,
12415         in DirectoryOpenFlag[] flags,
12416         [retval] out IGuestDirectory directory
12417     );
12418 
12444     void directoryQueryInfo (
12445         in wstring path,
12446         [retval] out IGuestFsObjInfo info
12447     );
12448 
12464     void directoryRemove (
12465         in wstring path
12466     );
12467 
12487     void directoryRemoveRecursive (
12488         in wstring path,
12489         in DirectoryRemoveRecFlag[] flags,
12490         [retval] out IProgress progress
12491     );
12492 
12512     void directoryRename (
12513         in wstring source,
12514         in wstring dest,
12515         in PathRenameFlag[] flags
12516     );
12517 
12535     void directorySetACL (
12536         in wstring path,
12537         in wstring acl
12538     );
12539 
12553     void environmentClear();
12554 
12575     void environmentGet (
12576         in wstring name,
12577         [retval] out wstring value
12578     );
12579 
12597     void environmentSet (
12598         in wstring name,
12599         in wstring value
12600     );
12601 
12617     void environmentUnset (
12618         in wstring name
12619     );
12620 
12674     void fileCreateTemp (
12675         in wstring templateName,
12676         in unsigned long mode,
12677         in wstring path,
12678         in boolean secure,
12679         [retval] out IGuestFile file
12680     );
12681 
12699     void fileExists (
12700         in wstring path,
12701         [retval] out boolean exists
12702     );
12703 
12727     void fileRemove (
12728         in wstring path
12729     );
12730 
12765     void fileOpen (
12766         in wstring path,
12767         in wstring openMode,
12768         in wstring disposition,
12769         in unsigned long creationMode,
12770         in long long offset,
12771         [retval] out IGuestFile file
12772     );
12773 
12799     void fileQueryInfo (
12800         in wstring path,
12801         [retval] out IGuestFsObjInfo info
12802     );
12803 
12829     void fileQuerySize (
12830         in wstring path,
12831         [retval] out long long size
12832     );
12833 
12853     void fileRename (
12854         in wstring source,
12855         in wstring dest,
12856         in PathRenameFlag[] flags
12857     );
12858 
12876     void fileSetACL (
12877         in wstring file,
12878         in wstring acl
12879     );
12880 
12940     void processCreate (
12941         in wstring command,
12942         in wstring[] arguments,
12943         in wstring[] environment,
12944         in ProcessCreateFlag[] flags,
12945         in unsigned long timeoutMS,
12946         [retval] out IGuestProcess guestProcess
12947     );
12948 
13018     void processCreateEx (
13019         in wstring command,
13020         in wstring[] arguments,
13021         in wstring[] environment,
13022         in ProcessCreateFlag[] flags,
13023         in unsigned long timeoutMS,
13024         in ProcessPriority priority,
13025         in long[] affinity,
13026         [retval] out IGuestProcess guestProcess
13027     );
13028 
13038     void processGet (
13039         in unsigned long pid,
13040         [retval] out IGuestProcess guestProcess
13041     );
13042 
13065     void symlinkCreate (
13066         in wstring source,
13067         in wstring target,
13068         in SymlinkType type
13069     );
13070 
13088     void symlinkExists (
13089         in wstring symlink,
13090         [retval] out boolean exists
13091     );
13092 
13116     void symlinkRead (
13117         in wstring symlink,
13118         in SymlinkReadFlag[] flags,
13119         [retval] out wstring target
13120     );
13121 
13137     void symlinkRemoveDirectory (
13138         in wstring path
13139     );
13140 
13156     void symlinkRemoveFile (
13157         in wstring file
13158     );
13159 
13160 }; /* interface IGuestSession */
13161 
13169 interface IProcess : $unknown
13170 {
13176     readonly attribute unsigned long PID;
13177 
13184     readonly attribute ProcessStatus status;
13185 
13192     readonly attribute long exitCode;
13193 
13199     readonly attribute wstring[] environment;
13200 
13206     readonly attribute wstring[] arguments;
13207 
13211     readonly attribute wstring executablePath;
13212 
13216     readonly attribute wstring name;
13217 
13238     void waitFor (
13239         in unsigned long waitFor,
13240         in unsigned long timeoutMS,
13241         [retval] out ProcessWaitResult reason
13242     );
13243 
13265     void waitForArray (
13266         in ProcessWaitForFlag[] waitFor,
13267         in unsigned long timeoutMS,
13268         [retval] out ProcessWaitResult reason
13269     );
13270 
13287     void read (
13288         in unsigned long handle,
13289         in unsigned long toRead,
13290         in unsigned long timeoutMS,
13291         [retval] out octet[] data
13292     );
13293 
13317     void write (
13318         in unsigned long handle,
13319         in unsigned long flags,
13320         in octet[] data,
13321         in unsigned long timeoutMS,
13322         [retval] out unsigned long written
13323     );
13324 
13349     void writeArray (
13350         in unsigned long handle,
13351         in ProcessInputFlag[] flags,
13352         in octet[] data,
13353         in unsigned long timeoutMS,
13354         [retval] out unsigned long written
13355     );
13356 
13362     void terminate();
13363 
13364 }; /* interface IProcess */
13365 
13374 interface IGuestProcess : IProcess
13375 {
13376 }; /* interface IGuestProcess */
13377 
13385 interface IDirectory : $unknown
13386 {
13392     readonly attribute wstring directoryName;
13393 
13399     readonly attribute wstring filter;
13400 
13407     void close();
13408 
13423     void read (
13424         [retval] out IFsObjInfo objInfo
13425     );
13426 
13427 }; /* interface IDirectory */
13428 
13437 interface IGuestDirectory : IDirectory
13438 {
13439 }; /* interface IGuestDirectory */
13440 
13448 interface IFile : $unknown
13449 {
13455     readonly attribute unsigned long creationMode;
13456 
13462     readonly attribute unsigned long disposition;
13463 
13469     readonly attribute wstring fileName;
13470 
13476     readonly attribute long long initialSize;
13477 
13483     readonly attribute unsigned long openMode;
13484 
13490     readonly attribute long long offset;
13491 
13498     void close();
13499 
13515     void queryInfo (
13516         [retval] out IFsObjInfo objInfo
13517     );
13518 
13541     void read (
13542         in unsigned long toRead,
13543         in unsigned long timeoutMS,
13544         [retval] out octet[] data
13545     );
13546 
13571     void readAt (
13572         in long long offset,
13573         in unsigned long toRead,
13574         in unsigned long timeoutMS,
13575         [retval] out octet[] data
13576     );
13577 
13597     void seek (
13598         in long long offset,
13599         in FileSeekType whence
13600     );
13601 
13617     void setACL (
13618         in wstring acl
13619     );
13620 
13638     void write (
13639         in octet[] data,
13640         in unsigned long timeoutMS,
13641         [retval] out unsigned long written
13642     );
13643 
13671     void writeAt (
13672         in long long offset,
13673         in octet[] data,
13674         in unsigned long timeoutMS,
13675         [retval] out unsigned long written
13676     );
13677 
13678 }; /* interface IFile */
13679 
13688 interface IGuestFile : IFile
13689 {
13690 }; /* interface IGuestFile */
13691 
13700 interface IFsObjInfo : $unknown
13701 {
13707     readonly attribute long long accessTime;
13708 
13714     readonly attribute long long allocatedSize;
13715 
13721     readonly attribute long long birthTime;
13722 
13728     readonly attribute long long changeTime;
13729 
13735     readonly attribute unsigned long deviceNumber;
13736 
13742     readonly attribute wstring fileAttributes;
13743 
13749     readonly attribute unsigned long generationId;
13750 
13756     readonly attribute unsigned long GID;
13757 
13763     readonly attribute wstring groupName;
13764 
13770     readonly attribute unsigned long hardLinks;
13771 
13777     readonly attribute long long modificationTime;
13778 
13784     readonly attribute wstring name;
13785 
13791     readonly attribute long long nodeId;
13792 
13798     readonly attribute unsigned long nodeIdDevice;
13799 
13807     readonly attribute long long objectSize;
13808 
13814     readonly attribute FsObjType type;
13815 
13821     readonly attribute unsigned long UID;
13822 
13828     readonly attribute unsigned long userFlags;
13829 
13835     readonly attribute wstring userName;
13836 
13837 }; /* interface IFsObjInfo */
13838 
13847 interface IGuestFsObjInfo : IFsObjInfo
13848 {
13849 }; /* interface IGuestFsObjInfo */
13850 
13864 interface IGuest : $unknown
13865 {
13880     readonly attribute wstring OSTypeId;
13881 
13887     readonly attribute AdditionsRunLevelType additionsRunLevel;
13888 
13895     readonly attribute wstring additionsVersion;
13896 
13904     readonly attribute unsigned long additionsRevision;
13905 
13912     readonly attribute IAdditionsFacility[] facilities;
13913 
13917     readonly attribute IGuestSession[] sessions;
13918 
13922     attribute unsigned long memoryBalloonSize;
13923 
13927     attribute unsigned long statisticsUpdateInterval;
13928 
13960     void internalGetStatistics (
13961         out unsigned long cpuUser,
13962         out unsigned long cpuKernel,
13963         out unsigned long cpuIdle,
13964         out unsigned long memTotal,
13965         out unsigned long memFree,
13966         out unsigned long memBalloon,
13967         out unsigned long memShared,
13968         out unsigned long memCache,
13969         out unsigned long pagedTotal,
13970         out unsigned long memAllocTotal,
13971         out unsigned long memFreeTotal,
13972         out unsigned long memBalloonTotal,
13973         out unsigned long memSharedTotal
13974     );
13975 
13987     void getFacilityStatus (
13988         in AdditionsFacilityType facility,
13989         out long long timestamp,
13990         [retval] out AdditionsFacilityStatus status
13991     );
13992 
14010     void getAdditionsStatus (
14011         in AdditionsRunLevelType level,
14012         [retval] out boolean active
14013     );
14014 
14044     void setCredentials (
14045         in wstring userName,
14046         in wstring password,
14047         in wstring domain,
14048         in boolean allowInteractiveLogon
14049     );
14050 
14080     void dragHGEnter (
14081         in unsigned long screenId,
14082         in unsigned long y,
14083         in unsigned long x,
14084         in DragAndDropAction defaultAction,
14085         in DragAndDropAction[] allowedActions,
14086         in wstring[] formats,
14087         [retval] out DragAndDropAction resultAction
14088     );
14089 
14119     void dragHGMove (
14120         in unsigned long screenId,
14121         in unsigned long x,
14122         in unsigned long y,
14123         in DragAndDropAction defaultAction,
14124         in DragAndDropAction[] allowedActions,
14125         in wstring[] formats,
14126         [retval] out DragAndDropAction resultAction
14127     );
14128 
14146     void dragHGLeave (
14147         in unsigned long screenId
14148     );
14149 
14181     void dragHGDrop (
14182         in unsigned long screenId,
14183         in unsigned long x,
14184         in unsigned long y,
14185         in DragAndDropAction defaultAction,
14186         in DragAndDropAction[] allowedActions,
14187         in wstring[] formats,
14188         out wstring format,
14189         [retval] out DragAndDropAction resultAction
14190     );
14191 
14215     void dragHGPutData (
14216         in unsigned long screenId,
14217         in wstring format,
14218         in octet[] data,
14219         [retval] out IProgress progress
14220     );
14221 
14247     void dragGHPending (
14248         in unsigned long screenId,
14249         out wstring[] format,
14250         out DragAndDropAction[] allowedActions,
14251         [retval] out DragAndDropAction defaultAction
14252     );
14253 
14275     void dragGHDropped (
14276         in wstring format,
14277         in DragAndDropAction action,
14278         [retval] out IProgress progress
14279     );
14280 
14298     void dragGHGetData (
14299         [retval] out octet[] data
14300     );
14301 
14356     void createSession (
14357         in wstring user,
14358         in wstring password,
14359         in wstring domain,
14360         in wstring sessionName,
14361         [retval] out IGuestSession guestSession
14362     );
14363 
14378     void findSession (
14379         in wstring sessionName,
14380         [retval] out IGuestSession[] sessions
14381     );
14382 
14426     void updateGuestAdditions (
14427         in wstring source,
14428         in AdditionsUpdateFlag[] flags,
14429         [retval] out IProgress progress
14430     );
14431 
14432 }; /* interface IGuest */
14433 
14474 interface IProgress : $unknown
14475 {
14479     readonly attribute wstringUUID id;
14480 
14484     readonly attribute wstring description;
14485 
14489     readonly attribute $unknown initiator;
14490 
14494     readonly attribute boolean cancelable;
14495 
14503     readonly attribute unsigned long percent;
14504 
14518     readonly attribute long timeRemaining;
14519 
14523     readonly attribute boolean completed;
14524 
14528     readonly attribute boolean canceled;
14529 
14536     readonly attribute long resultCode;
14537 
14547     readonly attribute IVirtualBoxErrorInfo errorInfo;
14548 
14555     readonly attribute unsigned long operationCount;
14556 
14560     readonly attribute unsigned long operation;
14561 
14567     readonly attribute wstring operationDescription;
14568 
14572     readonly attribute unsigned long operationPercent;
14573 
14577     readonly attribute unsigned long operationWeight;
14578 
14586     attribute unsigned long timeout;
14587 
14591     void setCurrentOperationProgress (
14592         in unsigned long percent
14593     );
14594 
14598     void setNextOperation (
14599         in wstring nextOperationDescription,
14600         in unsigned long nextOperationsWeight
14601     );
14602 
14629     void waitForCompletion (
14630         in long timeout
14631     );
14632 
14656     void waitForOperationCompletion (
14657         in unsigned long operation,
14658         in long timeout
14659     );
14660 
14686     void waitForAsyncProgressCompletion (
14687         in IProgress pProgressAsync
14688     );
14689 
14706     void cancel();
14707 
14708 }; /* interface IProgress */
14709 
14793 interface ISnapshot : $unknown
14794 {
14798     readonly attribute wstringUUID id;
14799 
14807     attribute wstring name;
14808 
14816     attribute wstring description;
14817 
14823     readonly attribute long long timeStamp;
14824 
14836     readonly attribute boolean online;
14837 
14849     readonly attribute IMachine machine;
14850 
14857     readonly attribute ISnapshot parent;
14858 
14867     readonly attribute ISnapshot[] children;
14868 
14876     void getChildrenCount (
14877         [retval] out unsigned long childrenCount
14878     );
14879 
14880 }; /* interface ISnapshot */
14881 
15068 interface IMediumAttachment : $unknown
15069 {
15074     readonly attribute IMedium medium;
15075 
15081     readonly attribute wstring controller;
15082 
15088     readonly attribute long port;
15089 
15095     readonly attribute long device;
15096 
15100     readonly attribute DeviceType type;
15101 
15105     readonly attribute boolean passthrough;
15106 
15110     readonly attribute boolean temporaryEject;
15111 
15116     readonly attribute boolean isEjected;
15117 
15121     readonly attribute boolean nonRotational;
15122 
15126     readonly attribute boolean discard;
15127 
15131     readonly attribute IBandwidthGroup bandwidthGroup;
15132 
15133 }; /* interface IMediumAttachment */
15134 
15292 interface IMedium : $unknown
15293 {
15307     readonly attribute wstringUUID id;
15308 
15327     attribute wstring description;
15328 
15344     readonly attribute MediumState state;
15345 
15354     readonly attribute unsigned long variant;
15355 
15377     attribute wstring location;
15378 
15398     readonly attribute wstring name;
15399 
15404     readonly attribute DeviceType deviceType;
15405 
15409     readonly attribute boolean hostDrive;
15410 
15423     readonly attribute long long size;
15424 
15439     readonly attribute wstring format;
15440 
15456     readonly attribute IMediumFormat mediumFormat;
15457 
15482     attribute MediumType type;
15483 
15497     readonly attribute MediumType[] allowedTypes;
15498 
15508     readonly attribute IMedium parent;
15509 
15517     readonly attribute IMedium[] children;
15518 
15529     readonly attribute IMedium base;
15530 
15563     readonly attribute boolean readOnly;
15564 
15585     readonly attribute long long logicalSize;
15586 
15614     attribute boolean autoReset;
15615 
15630     readonly attribute wstring lastAccessError;
15631 
15648     readonly attribute wstringUUID[] machineIds;
15649 
15675     void setIds (
15676         in boolean setImageId,
15677         in wstringUUID imageId,
15678         in boolean setParentId,
15679         in wstringUUID parentId
15680     );
15681 
15716     void refreshState (
15717         [retval] out MediumState state
15718     );
15719 
15746     void getSnapshotIds (
15747         in wstringUUID machineId,
15748         [retval] out wstringUUID[] snapshotIds
15749     );
15750 
15810     void lockRead (
15811         [retval] out MediumState state
15812     );
15813 
15836     void unlockRead (
15837         [retval] out MediumState state
15838     );
15839 
15894     void lockWrite (
15895         [retval] out MediumState state
15896     );
15897 
15920     void unlockWrite (
15921         [retval] out MediumState state
15922     );
15923 
15973     void close();
15974 
16004     void getProperty (
16005         in wstring name,
16006         [retval] out wstring value
16007     );
16008 
16040     void setProperty (
16041         in wstring name,
16042         in wstring value
16043     );
16044 
16079     void getProperties (
16080         in wstring names,
16081         out wstring[] returnNames,
16082         [retval] out wstring[] returnValues
16083     );
16084 
16114     void setProperties (
16115         in wstring[] names,
16116         in wstring[] values
16117     );
16118 
16151     void createBaseStorage (
16152         in long long logicalSize,
16153         in unsigned long variant,
16154         [retval] out IProgress progress
16155     );
16156 
16208     void deleteStorage (
16209         [retval] out IProgress progress
16210     );
16211 
16250     void createDiffStorage (
16251         in IMedium target,
16252         in unsigned long variant,
16253         [retval] out IProgress progress
16254     );
16255 
16331     void mergeTo (
16332         in IMedium target,
16333         [retval] out IProgress progress
16334     );
16335 
16385     void cloneTo (
16386         in IMedium target,
16387         in unsigned long variant,
16388         in IMedium parent,
16389         [retval] out IProgress progress
16390     );
16391 
16439     void cloneToBase (
16440         in IMedium target,
16441         in unsigned long variant,
16442         [retval] out IProgress progress
16443     );
16444 
16473     void compact (
16474         [retval] out IProgress progress
16475     );
16476 
16509     void resize (
16510         in long long logicalSize,
16511         [retval] out IProgress progress
16512     );
16513 
16547     void reset (
16548         [retval] out IProgress progress
16549     );
16550 
16551 }; /* interface IMedium */
16552 
16575 interface IMediumFormat : $unknown
16576 {
16595     readonly attribute wstring id;
16596 
16604     readonly attribute wstring name;
16605 
16614     readonly attribute unsigned long capabilities;
16615 
16634     void describeFileExtensions (
16635         out wstring[] extensions,
16636         out DeviceType[] type
16637     );
16638 
16666     void describeProperties (
16667         out wstring[] names,
16668         out wstring[] description,
16669         out DataType[] types,
16670         out unsigned long[] flags,
16671         out wstring[] defaults
16672     );
16673 
16674 }; /* interface IMediumFormat */
16675 
16688 interface IKeyboard : $unknown
16689 {
16695     readonly attribute IEventSource eventSource;
16696 
16709     void putScancode (
16710         in long scancode
16711     );
16712 
16725     void putScancodes (
16726         in long[] scancodes,
16727         [retval] out unsigned long codesStored
16728     );
16729 
16744     void putCAD();
16745 
16746 }; /* interface IKeyboard */
16747 
16759 interface IMouse : $unknown
16760 {
16775     readonly attribute boolean absoluteSupported;
16776 
16791     readonly attribute boolean relativeSupported;
16792 
16807     readonly attribute boolean needsHostCursor;
16808 
16814     readonly attribute IEventSource eventSource;
16815 
16881     void putMouseEvent (
16882         in long dx,
16883         in long dy,
16884         in long dz,
16885         in long dw,
16886         in long buttonState
16887     );
16888 
16961     void putMouseEventAbsolute (
16962         in long x,
16963         in long y,
16964         in long dz,
16965         in long dw,
16966         in long buttonState
16967     );
16968 
16969 }; /* interface IMouse */
16970 
16971 interface IFramebuffer : $unknown
16972 {
16981     readonly attribute octetPtr address;
16982 
16986     readonly attribute unsigned long width;
16987 
16991     readonly attribute unsigned long height;
16992 
16999     readonly attribute unsigned long bitsPerPixel;
17000 
17007     readonly attribute unsigned long bytesPerLine;
17008 
17019     readonly attribute unsigned long pixelFormat;
17020 
17027     readonly attribute boolean usesGuestVRAM;
17028 
17038     readonly attribute unsigned long heightReduction;
17039 
17054     readonly attribute IFramebufferOverlay overlay;
17055 
17062     readonly attribute long long winId;
17063 
17071     void lock();
17072 
17080     void unlock();
17081 
17089     void notifyUpdate (
17090         in unsigned long x,
17091         in unsigned long y,
17092         in unsigned long width,
17093         in unsigned long height
17094     );
17095 
17208     void requestResize (
17209         in unsigned long screenId,
17210         in unsigned long pixelFormat,
17211         in octetPtr VRAM,
17212         in unsigned long bitsPerPixel,
17213         in unsigned long bytesPerLine,
17214         in unsigned long width,
17215         in unsigned long height,
17216         [retval] out boolean finished
17217     );
17218 
17230     void videoModeSupported (
17231         in unsigned long width,
17232         in unsigned long height,
17233         in unsigned long bpp,
17234         [retval] out boolean supported
17235     );
17236 
17273     void getVisibleRegion (
17274         in octetPtr rectangles,
17275         in unsigned long count,
17276         [retval] out unsigned long countCopied
17277     );
17278 
17313     void setVisibleRegion (
17314         in octetPtr rectangles,
17315         in unsigned long count
17316     );
17317 
17338     void processVHWACommand (
17339         in octetPtr command
17340     );
17341 
17342 }; /* interface IFramebuffer */
17343 
17358 interface IFramebufferOverlay : IFramebuffer
17359 {
17363     readonly attribute unsigned long x;
17364 
17368     readonly attribute unsigned long y;
17369 
17375     attribute boolean visible;
17376 
17383     attribute unsigned long alpha;
17384 
17390     void move (
17391         in unsigned long x,
17392         in unsigned long y
17393     );
17394 
17395 }; /* interface IFramebufferOverlay */
17396 
17412 interface IDisplay : $unknown
17413 {
17417     void getScreenResolution (
17418         in unsigned long screenId,
17419         out unsigned long width,
17420         out unsigned long height,
17421         out unsigned long bitsPerPixel
17422     );
17423 
17429     void setFramebuffer (
17430         in unsigned long screenId,
17431         in IFramebuffer framebuffer
17432     );
17433 
17439     void getFramebuffer (
17440         in unsigned long screenId,
17441         out IFramebuffer framebuffer,
17442         out long xOrigin,
17443         out long yOrigin
17444     );
17445 
17496     void setVideoModeHint (
17497         in unsigned long display,
17498         in boolean enabled,
17499         in boolean changeOrigin,
17500         in long originX,
17501         in long originY,
17502         in unsigned long width,
17503         in unsigned long height,
17504         in unsigned long bitsPerPixel
17505     );
17506 
17518     void setSeamlessMode (
17519         in boolean enabled
17520     );
17521 
17557     void takeScreenShot (
17558         in unsigned long screenId,
17559         in octetPtr address,
17560         in unsigned long width,
17561         in unsigned long height
17562     );
17563 
17607     void takeScreenShotToArray (
17608         in unsigned long screenId,
17609         in unsigned long width,
17610         in unsigned long height,
17611         [retval] out octet[] screenData
17612     );
17613 
17652     void takeScreenShotPNGToArray (
17653         in unsigned long screenId,
17654         in unsigned long width,
17655         in unsigned long height,
17656         [retval] out octet[] screenData
17657     );
17658 
17710     void drawToScreen (
17711         in unsigned long screenId,
17712         in octetPtr address,
17713         in unsigned long x,
17714         in unsigned long y,
17715         in unsigned long width,
17716         in unsigned long height
17717     );
17718 
17733     void invalidateAndUpdate();
17734 
17748     void resizeCompleted (
17749         in unsigned long screenId
17750     );
17751 
17764     void completeVHWACommand (
17765         in octetPtr command
17766     );
17767 
17801     void viewportChanged (
17802         in unsigned long screenId,
17803         in unsigned long x,
17804         in unsigned long y,
17805         in unsigned long width,
17806         in unsigned long height
17807     );
17808 
17809 }; /* interface IDisplay */
17810 
17826 interface INetworkAdapter : $unknown
17827 {
17835     attribute NetworkAdapterType adapterType;
17836 
17844     readonly attribute unsigned long slot;
17845 
17854     attribute boolean enabled;
17855 
17862     attribute wstring MACAddress;
17863 
17869     attribute NetworkAttachmentType attachmentType;
17870 
17876     attribute wstring bridgedInterface;
17877 
17883     attribute wstring hostOnlyInterface;
17884 
17890     attribute wstring internalNetwork;
17891 
17897     attribute wstring NATNetwork;
17898 
17904     attribute wstring genericDriver;
17905 
17912     attribute boolean cableConnected;
17913 
17919     attribute unsigned long lineSpeed;
17920 
17927     attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
17928 
17935     attribute boolean traceEnabled;
17936 
17943     attribute wstring traceFile;
17944 
17952     readonly attribute INATEngine NATEngine;
17953 
17960     attribute unsigned long bootPriority;
17961 
17965     attribute IBandwidthGroup bandwidthGroup;
17966 
17985     void getProperty (
17986         in wstring key,
17987         [retval] out wstring value
17988     );
17989 
18008     void setProperty (
18009         in wstring key,
18010         in wstring value
18011     );
18012 
18040     void getProperties (
18041         in wstring names,
18042         out wstring[] returnNames,
18043         [retval] out wstring[] returnValues
18044     );
18045 
18046 }; /* interface INetworkAdapter */
18047 
18076 interface ISerialPort : $unknown
18077 {
18085     readonly attribute unsigned long slot;
18086 
18093     attribute boolean enabled;
18094 
18098     attribute unsigned long IOBase;
18099 
18103     attribute unsigned long IRQ;
18104 
18115     attribute PortMode hostMode;
18116 
18124     attribute boolean server;
18125 
18135     attribute wstring path;
18136 
18137 }; /* interface ISerialPort */
18138 
18158 interface IParallelPort : $unknown
18159 {
18167     readonly attribute unsigned long slot;
18168 
18175     attribute boolean enabled;
18176 
18180     attribute unsigned long IOBase;
18181 
18185     attribute unsigned long IRQ;
18186 
18194     attribute wstring path;
18195 
18196 }; /* interface IParallelPort */
18197 
18198 interface IMachineDebugger : $unknown
18199 {
18203     attribute boolean singleStep;
18204 
18208     attribute boolean recompileUser;
18209 
18213     attribute boolean recompileSupervisor;
18214 
18218     attribute boolean PATMEnabled;
18219 
18223     attribute boolean CSAMEnabled;
18224 
18228     attribute boolean logEnabled;
18229 
18233     readonly attribute wstring logDbgFlags;
18234 
18238     readonly attribute wstring logDbgGroups;
18239 
18243     readonly attribute wstring logDbgDestinations;
18244 
18248     readonly attribute wstring logRelFlags;
18249 
18253     readonly attribute wstring logRelGroups;
18254 
18258     readonly attribute wstring logRelDestinations;
18259 
18266     readonly attribute boolean HWVirtExEnabled;
18267 
18274     readonly attribute boolean HWVirtExNestedPagingEnabled;
18275 
18282     readonly attribute boolean HWVirtExVPIDEnabled;
18283 
18292     readonly attribute wstring OSName;
18293 
18302     readonly attribute wstring OSVersion;
18303 
18310     readonly attribute boolean PAEEnabled;
18311 
18318     attribute unsigned long virtualTimeRate;
18319 
18326     readonly attribute long long VM;
18327 
18343     void dumpGuestCore (
18344         in wstring filename,
18345         in wstring compression
18346     );
18347 
18364     void dumpHostProcessCore (
18365         in wstring filename,
18366         in wstring compression
18367     );
18368 
18389     void info (
18390         in wstring name,
18391         in wstring args,
18392         [retval] out wstring info
18393     );
18394 
18400     void injectNMI();
18401 
18412     void modifyLogGroups (
18413         in wstring settings
18414     );
18415 
18426     void modifyLogFlags (
18427         in wstring settings
18428     );
18429 
18440     void modifyLogDestinations (
18441         in wstring settings
18442     );
18443 
18458     void readPhysicalMemory (
18459         in long long address,
18460         in unsigned long size,
18461         [retval] out octet[] bytes
18462     );
18463 
18478     void writePhysicalMemory (
18479         in long long address,
18480         in unsigned long size,
18481         in octet[] bytes
18482     );
18483 
18500     void readVirtualMemory (
18501         in unsigned long cpuId,
18502         in long long address,
18503         in unsigned long size,
18504         [retval] out octet[] bytes
18505     );
18506 
18523     void writeVirtualMemory (
18524         in unsigned long cpuId,
18525         in long long address,
18526         in unsigned long size,
18527         in octet[] bytes
18528     );
18529 
18542     void detectOS (
18543         [retval] out wstring os
18544     );
18545 
18563     void getRegister (
18564         in unsigned long cpuId,
18565         in wstring name,
18566         [retval] out wstring value
18567     );
18568 
18586     void getRegisters (
18587         in unsigned long cpuId,
18588         out wstring[] names,
18589         out wstring[] values
18590     );
18591 
18610     void setRegister (
18611         in unsigned long cpuId,
18612         in wstring name,
18613         in wstring value
18614     );
18615 
18634     void setRegisters (
18635         in unsigned long cpuId,
18636         in wstring[] names,
18637         in wstring[] values
18638     );
18639 
18652     void dumpGuestStack (
18653         in unsigned long cpuId,
18654         [retval] out wstring stack
18655     );
18656 
18664     void resetStats (
18665         in wstring pattern
18666     );
18667 
18675     void dumpStats (
18676         in wstring pattern
18677     );
18678 
18690     void getStats (
18691         in wstring pattern,
18692         in boolean withDescriptions,
18693         out wstring stats
18694     );
18695 
18696 }; /* interface IMachineDebugger */
18697 
18698 interface IUSBController : $unknown
18699 {
18708     attribute boolean enabled;
18709 
18718     attribute boolean enabledEHCI;
18719 
18725     readonly attribute boolean proxyAvailable;
18726 
18734     readonly attribute unsigned short USBStandard;
18735 
18761     readonly attribute IUSBDeviceFilter[] deviceFilters;
18762 
18790     void createDeviceFilter (
18791         in wstring name,
18792         [retval] out IUSBDeviceFilter filter
18793     );
18794 
18839     void insertDeviceFilter (
18840         in unsigned long position,
18841         in IUSBDeviceFilter filter
18842     );
18843 
18876     void removeDeviceFilter (
18877         in unsigned long position,
18878         [retval] out IUSBDeviceFilter filter
18879     );
18880 
18881 }; /* interface IUSBController */
18882 
18895 interface IUSBDevice : $unknown
18896 {
18903     readonly attribute wstringUUID id;
18904 
18908     readonly attribute unsigned short vendorId;
18909 
18913     readonly attribute unsigned short productId;
18914 
18922     readonly attribute unsigned short revision;
18923 
18927     readonly attribute wstring manufacturer;
18928 
18932     readonly attribute wstring product;
18933 
18937     readonly attribute wstring serialNumber;
18938 
18942     readonly attribute wstring address;
18943 
18950     readonly attribute unsigned short port;
18951 
18957     readonly attribute unsigned short version;
18958 
18966     readonly attribute unsigned short portVersion;
18967 
18974     readonly attribute boolean remote;
18975 
18976 }; /* interface IUSBDevice */
18977 
19052 interface IUSBDeviceFilter : $unknown
19053 {
19061     attribute wstring name;
19062 
19066     attribute boolean active;
19067 
19075     attribute wstring vendorId;
19076 
19084     attribute wstring productId;
19085 
19099     attribute wstring revision;
19100 
19105     attribute wstring manufacturer;
19106 
19111     attribute wstring product;
19112 
19117     attribute wstring serialNumber;
19118 
19123     attribute wstring port;
19124 
19134     attribute wstring remote;
19135 
19145     attribute unsigned long maskedInterfaces;
19146 
19147 }; /* interface IUSBDeviceFilter */
19148 
19165 interface IHostUSBDevice : IUSBDevice
19166 {
19172     readonly attribute USBDeviceState state;
19173 
19174 }; /* interface IHostUSBDevice */
19175 
19198 interface IHostUSBDeviceFilter : IUSBDeviceFilter
19199 {
19206     attribute USBDeviceFilterAction action;
19207 
19208 }; /* interface IHostUSBDeviceFilter */
19209 
19218 interface IAudioAdapter : $unknown
19219 {
19228     attribute boolean enabled;
19229 
19235     attribute AudioControllerType audioController;
19236 
19243     attribute AudioDriverType audioDriver;
19244 
19245 }; /* interface IAudioAdapter */
19246 
19247 interface IVRDEServer : $unknown
19248 {
19252     attribute boolean enabled;
19253 
19257     attribute AuthType authType;
19258 
19262     attribute unsigned long authTimeout;
19263 
19270     attribute boolean allowMultiConnection;
19271 
19279     attribute boolean reuseSingleConnection;
19280 
19287     attribute wstring VRDEExtPack;
19288 
19295     attribute wstring authLibrary;
19296 
19302     readonly attribute wstring[] VRDEProperties;
19303 
19317     void setVRDEProperty (
19318         in wstring key,
19319         in wstring value
19320     );
19321 
19335     void getVRDEProperty (
19336         in wstring key,
19337         [retval] out wstring value
19338     );
19339 
19340 }; /* interface IVRDEServer */
19341 
19399 interface ISharedFolder : $unknown
19400 {
19404     readonly attribute wstring name;
19405 
19409     readonly attribute wstring hostPath;
19410 
19420     readonly attribute boolean accessible;
19421 
19428     readonly attribute boolean writable;
19429 
19435     readonly attribute boolean autoMount;
19436 
19449     readonly attribute wstring lastAccessError;
19450 
19451 }; /* interface ISharedFolder */
19452 
19453 interface IInternalSessionControl : $unknown
19454 {
19459     void getPID (
19460         [retval] out unsigned long pid
19461     );
19462 
19484     void getRemoteConsole (
19485         [retval] out IConsole console
19486     );
19487 
19511     void assignMachine (
19512         in IMachine machine,
19513         in LockType lockType
19514     );
19515 
19530     void assignRemoteMachine (
19531         in IMachine machine,
19532         in IConsole console
19533     );
19534 
19558     void updateMachineState (
19559         in MachineState aMachineState
19560     );
19561 
19577     void uninitialize();
19578 
19601     void onNetworkAdapterChange (
19602         in INetworkAdapter networkAdapter,
19603         in boolean changeAdapter
19604     );
19605 
19628     void onSerialPortChange (
19629         in ISerialPort serialPort
19630     );
19631 
19654     void onParallelPortChange (
19655         in IParallelPort parallelPort
19656     );
19657 
19680     void onStorageControllerChange();
19681 
19708     void onMediumChange (
19709         in IMediumAttachment mediumAttachment,
19710         in boolean force
19711     );
19712 
19742     void onStorageDeviceChange (
19743         in IMediumAttachment mediumAttachment,
19744         in boolean remove,
19745         in boolean silent
19746     );
19747 
19755     void onClipboardModeChange (
19756         in ClipboardMode clipboardMode
19757     );
19758 
19766     void onDragAndDropModeChange (
19767         in DragAndDropMode dragAndDropMode
19768     );
19769 
19779     void onCPUChange (
19780         in unsigned long cpu,
19781         in boolean add
19782     );
19783 
19791     void onCPUExecutionCapChange (
19792         in unsigned long executionCap
19793     );
19794 
19819     void onVRDEServerChange (
19820         in boolean restart
19821     );
19822 
19845     void onUSBControllerChange();
19846 
19875     void onSharedFolderChange (
19876         in boolean global
19877     );
19878 
19904     void onUSBDeviceAttach (
19905         in IUSBDevice device,
19906         in IVirtualBoxErrorInfo error,
19907         in unsigned long maskedInterfaces
19908     );
19909 
19935     void onUSBDeviceDetach (
19936         in wstringUUID id,
19937         in IVirtualBoxErrorInfo error
19938     );
19939 
19957     void onShowWindow (
19958         in boolean check,
19959         out boolean canShow,
19960         out long long winId
19961     );
19962 
19970     void onBandwidthGroupChange (
19971         in IBandwidthGroup bandwidthGroup
19972     );
19973 
19997     void accessGuestProperty (
19998         in wstring name,
19999         in wstring value,
20000         in wstring flags,
20001         in boolean isSetter,
20002         out wstring retValue,
20003         out long long retTimestamp,
20004         out wstring retFlags
20005     );
20006 
20054     void enumerateGuestProperties (
20055         in wstring patterns,
20056         out wstring[] key,
20057         out wstring[] value,
20058         out long long[] timestamp,
20059         out wstring[] flags
20060     );
20061 
20107     void onlineMergeMedium (
20108         in IMediumAttachment mediumAttachment,
20109         in unsigned long sourceIdx,
20110         in unsigned long targetIdx,
20111         in IMedium source,
20112         in IMedium target,
20113         in boolean mergeForward,
20114         in IMedium parentForTarget,
20115         in IMedium[] childrenToReparent,
20116         in IProgress progress
20117     );
20118 
20142     void enableVMMStatistics (
20143         in boolean enable
20144     );
20145 
20173     void pauseWithReason (
20174         in Reason reason
20175     );
20176 
20204     void resumeWithReason (
20205         in Reason reason
20206     );
20207 
20237     void saveStateWithReason (
20238         in Reason reason,
20239         [retval] out IProgress progress
20240     );
20241 
20242 }; /* interface IInternalSessionControl */
20243 
20302 interface ISession : $unknown
20303 {
20307     readonly attribute SessionState state;
20308 
20316     readonly attribute SessionType type;
20317 
20321     readonly attribute IMachine machine;
20322 
20326     readonly attribute IConsole console;
20327 
20359     void unlockMachine();
20360 
20361 }; /* interface ISession */
20362 
20385 interface IStorageController : $unknown
20386 {
20395     readonly attribute wstring name;
20396 
20402     readonly attribute unsigned long maxDevicesPerPortCount;
20403 
20409     readonly attribute unsigned long minPortCount;
20410 
20416     readonly attribute unsigned long maxPortCount;
20417 
20423     attribute unsigned long instance;
20424 
20433     attribute unsigned long portCount;
20434 
20440     readonly attribute StorageBus bus;
20441 
20454     attribute StorageControllerType controllerType;
20455 
20470     attribute boolean useHostIOCache;
20471 
20477     readonly attribute boolean bootable;
20478 
20479 }; /* interface IStorageController */
20480 
20504 interface IManagedObjectRef : $unknown
20505 {
20512     void getInterfaceName (
20513         [retval] out wstring return
20514     );
20515 
20523     void release();
20524 
20525 }; /* interface IManagedObjectRef */
20526 
20535 interface IWebsessionManager : $unknown
20536 {
20545     void logon (
20546         in wstring username,
20547         in wstring password,
20548         [retval] out IVirtualBox return
20549     );
20550 
20560     void getSessionObject (
20561         in IVirtualBox refIVirtualBox,
20562         [retval] out ISession return
20563     );
20564 
20572     void logoff (
20573         in IVirtualBox refIVirtualBox
20574     );
20575 
20576 }; /* interface IWebsessionManager */
20577 
20586 interface IPerformanceMetric : $unknown
20587 {
20593     readonly attribute wstring metricName;
20594 
20600     readonly attribute $unknown object;
20601 
20607     readonly attribute wstring description;
20608 
20614     readonly attribute unsigned long period;
20615 
20625     readonly attribute unsigned long count;
20626 
20632     readonly attribute wstring unit;
20633 
20639     readonly attribute long minimumValue;
20640 
20646     readonly attribute long maximumValue;
20647 
20648 }; /* interface IPerformanceMetric */
20649 
20756 interface IPerformanceCollector : $unknown
20757 {
20768     readonly attribute wstring[] metricNames;
20769 
20793     void getMetrics (
20794         in wstring[] metricNames,
20795         in $unknown[] objects,
20796         [retval] out IPerformanceMetric[] metrics
20797     );
20798 
20837     void setupMetrics (
20838         in wstring[] metricNames,
20839         in $unknown[] objects,
20840         in unsigned long period,
20841         in unsigned long count,
20842         [retval] out IPerformanceMetric[] affectedMetrics
20843     );
20844 
20873     void enableMetrics (
20874         in wstring[] metricNames,
20875         in $unknown[] objects,
20876         [retval] out IPerformanceMetric[] affectedMetrics
20877     );
20878 
20907     void disableMetrics (
20908         in wstring[] metricNames,
20909         in $unknown[] objects,
20910         [retval] out IPerformanceMetric[] affectedMetrics
20911     );
20912 
21001     void queryMetricsData (
21002         in wstring[] metricNames,
21003         in $unknown[] objects,
21004         out wstring[] returnMetricNames,
21005         out $unknown[] returnObjects,
21006         out wstring[] returnUnits,
21007         out unsigned long[] returnScales,
21008         out unsigned long[] returnSequenceNumbers,
21009         out unsigned long[] returnDataIndices,
21010         out unsigned long[] returnDataLengths,
21011         [retval] out long[] returnData
21012     );
21013 
21014 }; /* interface IPerformanceCollector */
21015 
21023 interface INATEngine : $unknown
21024 {
21029     attribute wstring network;
21030 
21037     attribute wstring hostIP;
21038 
21043     attribute wstring TFTPPrefix;
21044 
21049     attribute wstring TFTPBootFile;
21050 
21058     attribute wstring TFTPNextServer;
21059 
21063     attribute unsigned long aliasMode;
21064 
21068     attribute boolean DNSPassDomain;
21069 
21074     attribute boolean DNSProxy;
21075 
21080     attribute boolean DNSUseHostResolver;
21081 
21086     readonly attribute wstring[] redirects;
21087 
21103     void setNetworkSettings (
21104         in unsigned long mtu,
21105         in unsigned long sockSnd,
21106         in unsigned long sockRcv,
21107         in unsigned long TcpWndSnd,
21108         in unsigned long TcpWndRcv
21109     );
21110 
21115     void getNetworkSettings (
21116         out unsigned long mtu,
21117         out unsigned long sockSnd,
21118         out unsigned long sockRcv,
21119         out unsigned long TcpWndSnd,
21120         out unsigned long TcpWndRcv
21121     );
21122 
21142     void addRedirect (
21143         in wstring name,
21144         in NATProtocol proto,
21145         in wstring hostIP,
21146         in unsigned short hostPort,
21147         in wstring guestIP,
21148         in unsigned short guestPort
21149     );
21150 
21156     void removeRedirect (
21157         in wstring name
21158     );
21159 
21160 }; /* interface INATEngine */
21161 
21170 interface IExtPackPlugIn : $unknown
21171 {
21175     readonly attribute wstring name;
21176 
21180     readonly attribute wstring description;
21181 
21187     readonly attribute wstring frontend;
21188 
21192     readonly attribute wstring modulePath;
21193 
21194 }; /* interface IExtPackPlugIn */
21195 
21204 interface IExtPackBase : $unknown
21205 {
21209     readonly attribute wstring name;
21210 
21214     readonly attribute wstring description;
21215 
21227     readonly attribute wstring version;
21228 
21232     readonly attribute unsigned long revision;
21233 
21243     readonly attribute wstring edition;
21244 
21248     readonly attribute wstring VRDEModule;
21249 
21253     readonly attribute IExtPackPlugIn[] plugIns;
21254 
21264     readonly attribute boolean usable;
21265 
21272     readonly attribute wstring whyUnusable;
21273 
21277     readonly attribute boolean showLicense;
21278 
21287     readonly attribute wstring license;
21288 
21312     void queryLicense (
21313         in wstring preferredLocale,
21314         in wstring preferredLanguage,
21315         in wstring format,
21316         [retval] out wstring licenseText
21317     );
21318 
21319 }; /* interface IExtPackBase */
21320 
21329 interface IExtPack : IExtPackBase
21330 {
21342     void queryObject (
21343         in wstring objUuid,
21344         [retval] out $unknown returnInterface
21345     );
21346 
21347 }; /* interface IExtPack */
21348 
21358 interface IExtPackFile : IExtPackBase
21359 {
21365     readonly attribute wstring filePath;
21366 
21385     void install (
21386         in boolean replace,
21387         in wstring displayInfo,
21388         [retval] out IProgress progess
21389     );
21390 
21391 }; /* interface IExtPackFile */
21392 
21403 interface IExtPackManager : $unknown
21404 {
21410     readonly attribute IExtPack[] installedExtPacks;
21411 
21429     void find (
21430         in wstring name,
21431         [retval] out IExtPack returnData
21432     );
21433 
21445     void openExtPackFile (
21446         in wstring path,
21447         [retval] out IExtPackFile file
21448     );
21449 
21468     void uninstall (
21469         in wstring name,
21470         in boolean forcedRemoval,
21471         in wstring displayInfo,
21472         [retval] out IProgress progess
21473     );
21474 
21478     void cleanup();
21479 
21492     void queryAllPlugInsForFrontend (
21493         in wstring frontendName,
21494         [retval] out wstring[] plugInModules
21495     );
21496 
21504     void isExtPackUsable (
21505         in wstring name,
21506         [retval] out boolean usable
21507     );
21508 
21509 }; /* interface IExtPackManager */
21510 
21516 interface IBandwidthGroup : $unknown
21517 {
21521     readonly attribute wstring name;
21522 
21526     readonly attribute BandwidthGroupType type;
21527 
21531     readonly attribute unsigned long reference;
21532 
21537     attribute long long maxBytesPerSec;
21538 
21539 }; /* interface IBandwidthGroup */
21540 
21549 interface IBandwidthControl : $unknown
21550 {
21556     readonly attribute unsigned long numGroups;
21557 
21570     void createBandwidthGroup (
21571         in wstring name,
21572         in BandwidthGroupType type,
21573         in long long maxBytesPerSec
21574     );
21575 
21583     void deleteBandwidthGroup (
21584         in wstring name
21585     );
21586 
21596     void getBandwidthGroup (
21597         in wstring name,
21598         [retval] out IBandwidthGroup bandwidthGroup
21599     );
21600 
21608     void getAllBandwidthGroups (
21609         [retval] out IBandwidthGroup[] bandwidthGroups
21610     );
21611 
21612 }; /* interface IBandwidthControl */
21613 
21626 interface IVirtualBoxClient : $unknown
21627 {
21633     readonly attribute IVirtualBox virtualBox;
21634 
21640     readonly attribute ISession session;
21641 
21647     readonly attribute IEventSource eventSource;
21648 
21649 }; /* interface IVirtualBoxClient */
21650 
21664 interface IEventSource : $unknown
21665 {
21671     void createListener (
21672         [retval] out IEventListener listener
21673     );
21674 
21690     void createAggregator (
21691         in IEventSource[] subordinates,
21692         [retval] out IEventSource result
21693     );
21694 
21727     void registerListener (
21728         in IEventListener listener,
21729         in VBoxEventType[] interesting,
21730         in boolean active
21731     );
21732 
21741     void unregisterListener (
21742         in IEventListener listener
21743     );
21744 
21759     void fireEvent (
21760         in IEvent event,
21761         in long timeout,
21762         [retval] out boolean result
21763     );
21764 
21789     void getEvent (
21790         in IEventListener listener,
21791         in long timeout,
21792         [retval] out IEvent event
21793     );
21794 
21806     void eventProcessed (
21807         in IEventListener listener,
21808         in IEvent event
21809     );
21810 
21811 }; /* interface IEventSource */
21812 
21822 interface IEventListener : $unknown
21823 {
21836     void handleEvent (
21837         in IEvent event
21838     );
21839 
21840 }; /* interface IEventListener */
21841 
21918 interface IEvent : $unknown
21919 {
21925     readonly attribute VBoxEventType type;
21926 
21932     readonly attribute IEventSource source;
21933 
21944     readonly attribute boolean waitable;
21945 
21952     void setProcessed();
21953 
21967     void waitProcessed (
21968         in long timeout,
21969         [retval] out boolean result
21970     );
21971 
21972 }; /* interface IEvent */
21973 
21979 interface IReusableEvent : IEvent
21980 {
21984     readonly attribute unsigned long generation;
21985 
21992     void reuse();
21993 
21994 }; /* interface IReusableEvent */
21995 
22001 interface IMachineEvent : IEvent
22002 {
22006     readonly attribute wstringUUID machineId;
22007 
22008 }; /* interface IMachineEvent */
22009 
22015 interface IMachineStateChangedEvent : IMachineEvent
22016 {
22020     readonly attribute MachineState state;
22021 
22022 }; /* interface IMachineStateChangedEvent */
22023 
22031 interface IMachineDataChangedEvent : IMachineEvent
22032 {
22039     readonly attribute boolean temporary;
22040 
22041 }; /* interface IMachineDataChangedEvent */
22042 
22051 interface IMediumRegisteredEvent : IEvent
22052 {
22056     readonly attribute wstringUUID mediumId;
22057 
22061     readonly attribute DeviceType mediumType;
22062 
22069     readonly attribute boolean registered;
22070 
22071 }; /* interface IMediumRegisteredEvent */
22072 
22081 interface IMachineRegisteredEvent : IMachineEvent
22082 {
22089     readonly attribute boolean registered;
22090 
22091 }; /* interface IMachineRegisteredEvent */
22092 
22102 interface ISessionStateChangedEvent : IMachineEvent
22103 {
22109     readonly attribute SessionState state;
22110 
22111 }; /* interface ISessionStateChangedEvent */
22112 
22120 interface IGuestPropertyChangedEvent : IMachineEvent
22121 {
22127     readonly attribute wstring name;
22128 
22134     readonly attribute wstring value;
22135 
22141     readonly attribute wstring flags;
22142 
22143 }; /* interface IGuestPropertyChangedEvent */
22144 
22150 interface ISnapshotEvent : IMachineEvent
22151 {
22155     readonly attribute wstringUUID snapshotId;
22156 
22157 }; /* interface ISnapshotEvent */
22158 
22168 interface ISnapshotTakenEvent : ISnapshotEvent
22169 {
22170 }; /* interface ISnapshotTakenEvent */
22171 
22188 interface ISnapshotDeletedEvent : ISnapshotEvent
22189 {
22190 }; /* interface ISnapshotDeletedEvent */
22191 
22201 interface ISnapshotChangedEvent : ISnapshotEvent
22202 {
22203 }; /* interface ISnapshotChangedEvent */
22204 
22213 interface IMousePointerShapeChangedEvent : IEvent
22214 {
22220     readonly attribute boolean visible;
22221 
22227     readonly attribute boolean alpha;
22228 
22234     readonly attribute unsigned long xhot;
22235 
22241     readonly attribute unsigned long yhot;
22242 
22248     readonly attribute unsigned long width;
22249 
22255     readonly attribute unsigned long height;
22256 
22289     readonly attribute octet[] shape;
22290 
22291 }; /* interface IMousePointerShapeChangedEvent */
22292 
22301 interface IMouseCapabilityChangedEvent : IEvent
22302 {
22308     readonly attribute boolean supportsAbsolute;
22309 
22315     readonly attribute boolean supportsRelative;
22316 
22322     readonly attribute boolean needsHostCursor;
22323 
22324 }; /* interface IMouseCapabilityChangedEvent */
22325 
22334 interface IKeyboardLedsChangedEvent : IEvent
22335 {
22341     readonly attribute boolean numLock;
22342 
22348     readonly attribute boolean capsLock;
22349 
22355     readonly attribute boolean scrollLock;
22356 
22357 }; /* interface IKeyboardLedsChangedEvent */
22358 
22367 interface IStateChangedEvent : IEvent
22368 {
22374     readonly attribute MachineState state;
22375 
22376 }; /* interface IStateChangedEvent */
22377 
22387 interface IAdditionsStateChangedEvent : IEvent
22388 {
22389 }; /* interface IAdditionsStateChangedEvent */
22390 
22401 interface INetworkAdapterChangedEvent : IEvent
22402 {
22408     readonly attribute INetworkAdapter networkAdapter;
22409 
22410 }; /* interface INetworkAdapterChangedEvent */
22411 
22422 interface ISerialPortChangedEvent : IEvent
22423 {
22429     readonly attribute ISerialPort serialPort;
22430 
22431 }; /* interface ISerialPortChangedEvent */
22432 
22443 interface IParallelPortChangedEvent : IEvent
22444 {
22450     readonly attribute IParallelPort parallelPort;
22451 
22452 }; /* interface IParallelPortChangedEvent */
22453 
22463 interface IStorageControllerChangedEvent : IEvent
22464 {
22465 }; /* interface IStorageControllerChangedEvent */
22466 
22476 interface IMediumChangedEvent : IEvent
22477 {
22483     readonly attribute IMediumAttachment mediumAttachment;
22484 
22485 }; /* interface IMediumChangedEvent */
22486 
22494 interface IClipboardModeChangedEvent : IEvent
22495 {
22501     readonly attribute ClipboardMode clipboardMode;
22502 
22503 }; /* interface IClipboardModeChangedEvent */
22504 
22512 interface IDragAndDropModeChangedEvent : IEvent
22513 {
22519     readonly attribute DragAndDropMode dragAndDropMode;
22520 
22521 }; /* interface IDragAndDropModeChangedEvent */
22522 
22530 interface ICPUChangedEvent : IEvent
22531 {
22537     readonly attribute unsigned long CPU;
22538 
22544     readonly attribute boolean add;
22545 
22546 }; /* interface ICPUChangedEvent */
22547 
22555 interface ICPUExecutionCapChangedEvent : IEvent
22556 {
22562     readonly attribute unsigned long executionCap;
22563 
22564 }; /* interface ICPUExecutionCapChangedEvent */
22565 
22573 interface IGuestKeyboardEvent : IEvent
22574 {
22580     readonly attribute long[] scancodes;
22581 
22582 }; /* interface IGuestKeyboardEvent */
22583 
22591 interface IGuestMouseEvent : IReusableEvent
22592 {
22598     readonly attribute boolean absolute;
22599 
22605     readonly attribute long x;
22606 
22612     readonly attribute long y;
22613 
22619     readonly attribute long z;
22620 
22626     readonly attribute long w;
22627 
22633     readonly attribute long buttons;
22634 
22635 }; /* interface IGuestMouseEvent */
22636 
22647 interface IVRDEServerChangedEvent : IEvent
22648 {
22649 }; /* interface IVRDEServerChangedEvent */
22650 
22660 interface IVRDEServerInfoChangedEvent : IEvent
22661 {
22662 }; /* interface IVRDEServerInfoChangedEvent */
22663 
22674 interface IUSBControllerChangedEvent : IEvent
22675 {
22676 }; /* interface IUSBControllerChangedEvent */
22677 
22701 interface IUSBDeviceStateChangedEvent : IEvent
22702 {
22708     readonly attribute IUSBDevice device;
22709 
22715     readonly attribute boolean attached;
22716 
22722     readonly attribute IVirtualBoxErrorInfo error;
22723 
22724 }; /* interface IUSBDeviceStateChangedEvent */
22725 
22741 interface ISharedFolderChangedEvent : IEvent
22742 {
22748     readonly attribute Scope scope;
22749 
22750 }; /* interface ISharedFolderChangedEvent */
22751 
22803 interface IRuntimeErrorEvent : IEvent
22804 {
22810     readonly attribute boolean fatal;
22811 
22817     readonly attribute wstring id;
22818 
22824     readonly attribute wstring message;
22825 
22826 }; /* interface IRuntimeErrorEvent */
22827 
22835 interface IEventSourceChangedEvent : IEvent
22836 {
22842     readonly attribute IEventListener listener;
22843 
22849     readonly attribute boolean add;
22850 
22851 }; /* interface IEventSourceChangedEvent */
22852 
22861 interface IExtraDataChangedEvent : IEvent
22862 {
22869     readonly attribute wstringUUID machineId;
22870 
22876     readonly attribute wstring key;
22877 
22883     readonly attribute wstring value;
22884 
22885 }; /* interface IExtraDataChangedEvent */
22886 
22892 interface IVetoEvent : IEvent
22893 {
22903     void addVeto (
22904         in wstring reason
22905     );
22906 
22916     void isVetoed (
22917         [retval] out boolean result
22918     );
22919 
22929     void getVetos (
22930         [retval] out wstring[] result
22931     );
22932 
22933 }; /* interface IVetoEvent */
22934 
22944 interface IExtraDataCanChangeEvent : IVetoEvent
22945 {
22952     readonly attribute wstringUUID machineId;
22953 
22959     readonly attribute wstring key;
22960 
22966     readonly attribute wstring value;
22967 
22968 }; /* interface IExtraDataCanChangeEvent */
22969 
22985 interface ICanShowWindowEvent : IVetoEvent
22986 {
22987 }; /* interface ICanShowWindowEvent */
22988 
23020 interface IShowWindowEvent : IEvent
23021 {
23030     attribute long long winId;
23031 
23032 }; /* interface IShowWindowEvent */
23033 
23041 interface INATRedirectEvent : IMachineEvent
23042 {
23048     readonly attribute unsigned long slot;
23049 
23055     readonly attribute boolean remove;
23056 
23062     readonly attribute wstring name;
23063 
23069     readonly attribute NATProtocol proto;
23070 
23076     readonly attribute wstring hostIP;
23077 
23083     readonly attribute long hostPort;
23084 
23090     readonly attribute wstring guestIP;
23091 
23097     readonly attribute long guestPort;
23098 
23099 }; /* interface INATRedirectEvent */
23100 
23113 interface IHostPCIDevicePlugEvent : IMachineEvent
23114 {
23120     readonly attribute boolean plugged;
23121 
23128     readonly attribute boolean success;
23129 
23135     readonly attribute IPCIDeviceAttachment attachment;
23136 
23142     readonly attribute wstring message;
23143 
23144 }; /* interface IHostPCIDevicePlugEvent */
23145 
23154 interface IVBoxSVCAvailabilityChangedEvent : IEvent
23155 {
23161     readonly attribute boolean available;
23162 
23163 }; /* interface IVBoxSVCAvailabilityChangedEvent */
23164 
23172 interface IBandwidthGroupChangedEvent : IEvent
23173 {
23179     readonly attribute IBandwidthGroup bandwidthGroup;
23180 
23181 }; /* interface IBandwidthGroupChangedEvent */
23182 
23190 interface IGuestMonitorChangedEvent : IEvent
23191 {
23197     readonly attribute GuestMonitorChangedEventType changeType;
23198 
23204     readonly attribute unsigned long screenId;
23205 
23212     readonly attribute unsigned long originX;
23213 
23220     readonly attribute unsigned long originY;
23221 
23228     readonly attribute unsigned long width;
23229 
23236     readonly attribute unsigned long height;
23237 
23238 }; /* interface IGuestMonitorChangedEvent */
23239 
23249 interface IStorageDeviceChangedEvent : IEvent
23250 {
23256     readonly attribute IMediumAttachment storageDevice;
23257 
23263     readonly attribute boolean removed;
23264 
23265 }; /* interface IStorageDeviceChangedEvent */
23266 
23267 

Generated on Thu Mar 13 2014 17:33:19 for VirtualBox Main API by  doxygen 1.7.1