• 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 
05910     void pushGuestProperty (
05911         in wstring name,
05912         in wstring value,
05913         in long long timestamp,
05914         in wstring flags,
05915         [retval] out boolean notify
05916     );
05917 
05929     void lockMedia();
05930 
05940     void unlockMedia();
05941 
05957     void ejectMedium (
05958         in IMediumAttachment attachment,
05959         [retval] out IMediumAttachment newAttachment
05960     );
05961 
06002     void reportVmStatistics (
06003         in unsigned long validStats,
06004         in unsigned long cpuUser,
06005         in unsigned long cpuKernel,
06006         in unsigned long cpuIdle,
06007         in unsigned long memTotal,
06008         in unsigned long memFree,
06009         in unsigned long memBalloon,
06010         in unsigned long memShared,
06011         in unsigned long memCache,
06012         in unsigned long pagedTotal,
06013         in unsigned long memAllocTotal,
06014         in unsigned long memFreeTotal,
06015         in unsigned long memBalloonTotal,
06016         in unsigned long memSharedTotal,
06017         in unsigned long vmNetRx,
06018         in unsigned long vmNetTx
06019     );
06020 
06021 }; /* interface IInternalMachineControl */
06022 
06031 interface IBIOSSettings : $unknown
06032 {
06036     attribute boolean logoFadeIn;
06037 
06041     attribute boolean logoFadeOut;
06042 
06046     attribute unsigned long logoDisplayTime;
06047 
06054     attribute wstring logoImagePath;
06055 
06059     attribute BIOSBootMenuMode bootMenuMode;
06060 
06064     attribute boolean ACPIEnabled;
06065 
06072     attribute boolean IOAPICEnabled;
06073 
06083     attribute long long timeOffset;
06084 
06091     attribute boolean PXEDebugEnabled;
06092 
06093 }; /* interface IBIOSSettings */
06094 
06102 interface IPCIAddress : $unknown
06103 {
06109     attribute short bus;
06110 
06116     attribute short device;
06117 
06123     attribute short devFunction;
06124 
06130     void asLong (
06131         [retval] out long result
06132     );
06133 
06139     void fromLong (
06140         in long number
06141     );
06142 
06143 }; /* interface IPCIAddress */
06144 
06152 interface IPCIDeviceAttachment : $unknown
06153 {
06159     readonly attribute wstring name;
06160 
06166     readonly attribute boolean isPhysicalDevice;
06167 
06173     readonly attribute long hostAddress;
06174 
06180     readonly attribute long guestAddress;
06181 
06182 }; /* interface IPCIDeviceAttachment */
06183 
06224 interface IMachine : $unknown
06225 {
06229     readonly attribute IVirtualBox parent;
06230 
06280     readonly attribute boolean accessible;
06281 
06293     readonly attribute IVirtualBoxErrorInfo accessError;
06294 
06334     attribute wstring name;
06335 
06346     attribute wstring description;
06347 
06351     readonly attribute wstringUUID id;
06352 
06363     attribute wstring[] groups;
06364 
06379     attribute wstring OSTypeId;
06380 
06384     attribute wstring hardwareVersion;
06385 
06395     attribute wstringUUID hardwareUUID;
06396 
06400     attribute unsigned long CPUCount;
06401 
06407     attribute boolean CPUHotPlugEnabled;
06408 
06416     attribute unsigned long CPUExecutionCap;
06417 
06421     attribute unsigned long memorySize;
06422 
06426     attribute unsigned long memoryBalloonSize;
06427 
06434     attribute boolean pageFusionEnabled;
06435 
06439     attribute unsigned long VRAMSize;
06440 
06446     attribute boolean accelerate3DEnabled;
06447 
06453     attribute boolean accelerate2DVideoEnabled;
06454 
06465     attribute unsigned long monitorCount;
06466 
06472     attribute boolean VideoCaptureEnabled;
06473 
06479     attribute wstring VideoCaptureFile;
06480 
06486     attribute unsigned long VideoCaptureWidth;
06487 
06493     attribute unsigned long VideoCaptureHeight;
06494 
06498     readonly attribute IBIOSSettings BIOSSettings;
06499 
06504     attribute FirmwareType firmwareType;
06505 
06511     attribute PointingHIDType pointingHIDType;
06512 
06518     attribute KeyboardHIDType keyboardHIDType;
06519 
06526     attribute boolean HPETEnabled;
06527 
06531     attribute ChipsetType chipsetType;
06532 
06566     attribute wstring snapshotFolder;
06567 
06571     readonly attribute IVRDEServer VRDEServer;
06572 
06573     attribute boolean emulatedUSBWebcameraEnabled;
06574 
06575     attribute boolean emulatedUSBCardReaderEnabled;
06576 
06580     readonly attribute IMediumAttachment[] mediumAttachments;
06581 
06593     readonly attribute IUSBController USBController;
06594 
06598     readonly attribute IAudioAdapter audioAdapter;
06599 
06603     readonly attribute IStorageController[] storageControllers;
06604 
06610     readonly attribute wstring settingsFilePath;
06611 
06636     readonly attribute boolean settingsModified;
06637 
06641     readonly attribute SessionState sessionState;
06642 
06655     readonly attribute wstring sessionType;
06656 
06666     readonly attribute unsigned long sessionPID;
06667 
06671     readonly attribute MachineState state;
06672 
06679     readonly attribute long long lastStateChange;
06680 
06692     readonly attribute wstring stateFilePath;
06693 
06703     readonly attribute wstring logFolder;
06704 
06715     readonly attribute ISnapshot currentSnapshot;
06716 
06723     readonly attribute unsigned long snapshotCount;
06724 
06756     readonly attribute boolean currentStateModified;
06757 
06769     readonly attribute ISharedFolder[] sharedFolders;
06770 
06777     attribute ClipboardMode clipboardMode;
06778 
06784     attribute DragAndDropMode dragAndDropMode;
06785 
06793     attribute wstring guestPropertyNotificationPatterns;
06794 
06803     attribute boolean teleporterEnabled;
06804 
06815     attribute unsigned long teleporterPort;
06816 
06823     attribute wstring teleporterAddress;
06824 
06835     attribute wstring teleporterPassword;
06836 
06844     attribute FaultToleranceState faultToleranceState;
06845 
06852     attribute unsigned long faultTolerancePort;
06853 
06859     attribute wstring faultToleranceAddress;
06860 
06868     attribute wstring faultTolerancePassword;
06869 
06875     attribute unsigned long faultToleranceSyncInterval;
06876 
06884     attribute boolean RTCUseUTC;
06885 
06892     attribute boolean IOCacheEnabled;
06893 
06899     attribute unsigned long IOCacheSize;
06900 
06910     readonly attribute IPCIDeviceAttachment[] PCIDeviceAssignments;
06911 
06917     readonly attribute IBandwidthControl bandwidthControl;
06918 
06927     attribute boolean tracingEnabled;
06928 
06943     attribute wstring tracingConfig;
06944 
06957     attribute boolean allowTracingToAccessVM;
06958 
06964     attribute boolean autostartEnabled;
06965 
06971     attribute unsigned long autostartDelay;
06972 
06978     attribute AutostopType autostopType;
06979 
07085     void lockMachine (
07086         in ISession session,
07087         in LockType lockType
07088     );
07089 
07219     void launchVMProcess (
07220         in ISession session,
07221         in wstring type,
07222         in wstring environment,
07223         [retval] out IProgress progress
07224     );
07225 
07263     void setBootOrder (
07264         in unsigned long position,
07265         in DeviceType device
07266     );
07267 
07302     void getBootOrder (
07303         in unsigned long position,
07304         [retval] out DeviceType device
07305     );
07306 
07408     void attachDevice (
07409         in wstring name,
07410         in long controllerPort,
07411         in long device,
07412         in DeviceType type,
07413         in IMedium medium
07414     );
07415 
07511     void attachDeviceWithoutMedium (
07512         in wstring name,
07513         in long controllerPort,
07514         in long device,
07515         in DeviceType type
07516     );
07517 
07571     void detachDevice (
07572         in wstring name,
07573         in long controllerPort,
07574         in long device
07575     );
07576 
07619     void passthroughDevice (
07620         in wstring name,
07621         in long controllerPort,
07622         in long device,
07623         in boolean passthrough
07624     );
07625 
07668     void temporaryEjectDevice (
07669         in wstring name,
07670         in long controllerPort,
07671         in long device,
07672         in boolean temporaryEject
07673     );
07674 
07720     void nonRotationalDevice (
07721         in wstring name,
07722         in long controllerPort,
07723         in long device,
07724         in boolean nonRotational
07725     );
07726 
07772     void setAutoDiscardForDevice (
07773         in wstring name,
07774         in long controllerPort,
07775         in long device,
07776         in boolean discard
07777     );
07778 
07819     void setBandwidthGroupForDevice (
07820         in wstring name,
07821         in long controllerPort,
07822         in long device,
07823         in IBandwidthGroup bandwidthGroup
07824     );
07825 
07862     void setNoBandwidthGroupForDevice (
07863         in wstring name,
07864         in long controllerPort,
07865         in long device
07866     );
07867 
07932     void unmountMedium (
07933         in wstring name,
07934         in long controllerPort,
07935         in long device,
07936         in boolean force
07937     );
07938 
08001     void mountMedium (
08002         in wstring name,
08003         in long controllerPort,
08004         in long device,
08005         in IMedium medium,
08006         in boolean force
08007     );
08008 
08037     void getMedium (
08038         in wstring name,
08039         in long controllerPort,
08040         in long device,
08041         [retval] out IMedium medium
08042     );
08043 
08058     void getMediumAttachmentsOfController (
08059         in wstring name,
08060         [retval] out IMediumAttachment[] mediumAttachments
08061     );
08062 
08077     void getMediumAttachment (
08078         in wstring name,
08079         in long controllerPort,
08080         in long device,
08081         [retval] out IMediumAttachment attachment
08082     );
08083 
08124     void attachHostPCIDevice (
08125         in long hostAddress,
08126         in long desiredGuestAddress,
08127         in boolean tryToUnbind
08128     );
08129 
08170     void detachHostPCIDevice (
08171         in long hostAddress
08172     );
08173 
08191     void getNetworkAdapter (
08192         in unsigned long slot,
08193         [retval] out INetworkAdapter adapter
08194     );
08195 
08228     void addStorageController (
08229         in wstring name,
08230         in StorageBus connectionType,
08231         [retval] out IStorageController controller
08232     );
08233 
08247     void getStorageControllerByName (
08248         in wstring name,
08249         [retval] out IStorageController storageController
08250     );
08251 
08265     void getStorageControllerByInstance (
08266         in unsigned long instance,
08267         [retval] out IStorageController storageController
08268     );
08269 
08292     void removeStorageController (
08293         in wstring name
08294     );
08295 
08317     void setStorageControllerBootable (
08318         in wstring name,
08319         in boolean bootable
08320     );
08321 
08339     void getSerialPort (
08340         in unsigned long slot,
08341         [retval] out ISerialPort port
08342     );
08343 
08361     void getParallelPort (
08362         in unsigned long slot,
08363         [retval] out IParallelPort port
08364     );
08365 
08374     void getExtraDataKeys (
08375         [retval] out wstring[] value
08376     );
08377 
08406     void getExtraData (
08407         in wstring key,
08408         [retval] out wstring value
08409     );
08410 
08460     void setExtraData (
08461         in wstring key,
08462         in wstring value
08463     );
08464 
08486     void getCPUProperty (
08487         in CPUPropertyType property,
08488         [retval] out boolean value
08489     );
08490 
08512     void setCPUProperty (
08513         in CPUPropertyType property,
08514         in boolean value
08515     );
08516 
08556     void getCPUIDLeaf (
08557         in unsigned long id,
08558         out unsigned long valEax,
08559         out unsigned long valEbx,
08560         out unsigned long valEcx,
08561         out unsigned long valEdx
08562     );
08563 
08607     void setCPUIDLeaf (
08608         in unsigned long id,
08609         in unsigned long valEax,
08610         in unsigned long valEbx,
08611         in unsigned long valEcx,
08612         in unsigned long valEdx
08613     );
08614 
08632     void removeCPUIDLeaf (
08633         in unsigned long id
08634     );
08635 
08641     void removeAllCPUIDLeaves();
08642 
08664     void getHWVirtExProperty (
08665         in HWVirtExPropertyType property,
08666         [retval] out boolean value
08667     );
08668 
08690     void setHWVirtExProperty (
08691         in HWVirtExPropertyType property,
08692         in boolean value
08693     );
08694 
08740     void saveSettings();
08741 
08765     void discardSettings();
08766 
08850     void unregister (
08851         in CleanupMode cleanupMode,
08852         [retval] out IMedium[] aMedia
08853     );
08854 
08911     void delete (
08912         in IMedium[] aMedia,
08913         [retval] out IProgress aProgress
08914     );
08915 
08927     void export (
08928         in IAppliance aAppliance,
08929         in wstring location,
08930         [retval] out IVirtualSystemDescription aDescription
08931     );
08932 
08956     void findSnapshot (
08957         in wstring nameOrId,
08958         [retval] out ISnapshot snapshot
08959     );
08960 
08994     void createSharedFolder (
08995         in wstring name,
08996         in wstring hostPath,
08997         in boolean writable,
08998         in boolean automount
08999     );
09000 
09026     void removeSharedFolder (
09027         in wstring name
09028     );
09029 
09053     void canShowConsoleWindow (
09054         [retval] out boolean canShow
09055     );
09056 
09091     void showConsoleWindow (
09092         [retval] out long long winId
09093     );
09094 
09127     void getGuestProperty (
09128         in wstring name,
09129         out wstring value,
09130         out long long timestamp,
09131         out wstring flags
09132     );
09133 
09156     void getGuestPropertyValue (
09157         in wstring property,
09158         [retval] out wstring value
09159     );
09160 
09183     void getGuestPropertyTimestamp (
09184         in wstring property,
09185         [retval] out long long value
09186     );
09187 
09238     void setGuestProperty (
09239         in wstring property,
09240         in wstring value,
09241         in wstring flags
09242     );
09243 
09284     void setGuestPropertyValue (
09285         in wstring property,
09286         in wstring value
09287     );
09288 
09306     void deleteGuestProperty (
09307         in wstring name
09308     );
09309 
09340     void enumerateGuestProperties (
09341         in wstring patterns,
09342         out wstring[] name,
09343         out wstring[] value,
09344         out long long[] timestamp,
09345         out wstring[] flags
09346     );
09347 
09377     void querySavedGuestScreenInfo (
09378         in unsigned long screenId,
09379         out unsigned long originX,
09380         out unsigned long originY,
09381         out unsigned long width,
09382         out unsigned long height,
09383         out boolean enabled
09384     );
09385 
09407     void querySavedThumbnailSize (
09408         in unsigned long screenId,
09409         out unsigned long size,
09410         out unsigned long width,
09411         out unsigned long height
09412     );
09413 
09440     void readSavedThumbnailToArray (
09441         in unsigned long screenId,
09442         in boolean BGR,
09443         out unsigned long width,
09444         out unsigned long height,
09445         [retval] out octet[] data
09446     );
09447 
09469     void readSavedThumbnailPNGToArray (
09470         in unsigned long screenId,
09471         out unsigned long width,
09472         out unsigned long height,
09473         [retval] out octet[] data
09474     );
09475 
09497     void querySavedScreenshotPNGSize (
09498         in unsigned long screenId,
09499         out unsigned long size,
09500         out unsigned long width,
09501         out unsigned long height
09502     );
09503 
09525     void readSavedScreenshotPNGToArray (
09526         in unsigned long screenId,
09527         out unsigned long width,
09528         out unsigned long height,
09529         [retval] out octet[] data
09530     );
09531 
09541     void hotPlugCPU (
09542         in unsigned long cpu
09543     );
09544 
09554     void hotUnplugCPU (
09555         in unsigned long cpu
09556     );
09557 
09571     void getCPUStatus (
09572         in unsigned long cpu,
09573         [retval] out boolean attached
09574     );
09575 
09590     void queryLogFilename (
09591         in unsigned long idx,
09592         [retval] out wstring filename
09593     );
09594 
09620     void readLog (
09621         in unsigned long idx,
09622         in long long offset,
09623         in long long size,
09624         [retval] out octet[] data
09625     );
09626 
09659     void cloneTo (
09660         in IMachine target,
09661         in CloneMode mode,
09662         in CloneOptions[] options,
09663         [retval] out IProgress progress
09664     );
09665 
09666 }; /* interface IMachine */
09667 
09676 interface IVRDEServerInfo : $unknown
09677 {
09683     readonly attribute boolean active;
09684 
09693     readonly attribute long port;
09694 
09700     readonly attribute unsigned long numberOfClients;
09701 
09707     readonly attribute long long beginTime;
09708 
09715     readonly attribute long long endTime;
09716 
09722     readonly attribute long long bytesSent;
09723 
09729     readonly attribute long long bytesSentTotal;
09730 
09736     readonly attribute long long bytesReceived;
09737 
09743     readonly attribute long long bytesReceivedTotal;
09744 
09750     readonly attribute wstring user;
09751 
09757     readonly attribute wstring domain;
09758 
09764     readonly attribute wstring clientName;
09765 
09771     readonly attribute wstring clientIP;
09772 
09778     readonly attribute unsigned long clientVersion;
09779 
09787     readonly attribute unsigned long encryptionStyle;
09788 
09789 }; /* interface IVRDEServerInfo */
09790 
09812 interface IConsole : $unknown
09813 {
09825     readonly attribute IMachine machine;
09826 
09840     readonly attribute MachineState state;
09841 
09845     readonly attribute IGuest guest;
09846 
09857     readonly attribute IKeyboard keyboard;
09858 
09869     readonly attribute IMouse mouse;
09870 
09880     readonly attribute IDisplay display;
09881 
09885     readonly attribute IMachineDebugger debugger;
09886 
09897     readonly attribute IUSBDevice[] USBDevices;
09898 
09906     readonly attribute IHostUSBDevice[] remoteUSBDevices;
09907 
09923     readonly attribute ISharedFolder[] sharedFolders;
09924 
09930     readonly attribute IVRDEServerInfo VRDEServerInfo;
09931 
09937     readonly attribute IEventSource eventSource;
09938 
09942     readonly attribute IPCIDeviceAttachment[] attachedPCIDevices;
09943 
09952     attribute boolean useHostClipboard;
09953 
10018     void powerUp (
10019         [retval] out IProgress progress
10020     );
10021 
10055     void powerUpPaused (
10056         [retval] out IProgress progress
10057     );
10058 
10078     void powerDown (
10079         [retval] out IProgress progress
10080     );
10081 
10101     void reset();
10102 
10122     void pause();
10123 
10143     void resume();
10144 
10164     void powerButton();
10165 
10185     void sleepButton();
10186 
10198     void getPowerButtonHandled (
10199         [retval] out boolean handled
10200     );
10201 
10215     void getGuestEnteredACPIMode (
10216         [retval] out boolean entered
10217     );
10218 
10271     void saveState (
10272         [retval] out IProgress progress
10273     );
10274 
10307     void adoptSavedState (
10308         in wstring savedStateFile
10309     );
10310 
10341     void discardSavedState (
10342         in boolean fRemoveFile
10343     );
10344 
10357     void getDeviceActivity (
10358         in DeviceType type,
10359         [retval] out DeviceActivity activity
10360     );
10361 
10399     void attachUSBDevice (
10400         in wstringUUID id
10401     );
10402 
10437     void detachUSBDevice (
10438         in wstringUUID id,
10439         [retval] out IUSBDevice device
10440     );
10441 
10464     void findUSBDeviceByAddress (
10465         in wstring name,
10466         [retval] out IUSBDevice device
10467     );
10468 
10488     void findUSBDeviceById (
10489         in wstringUUID id,
10490         [retval] out IUSBDevice device
10491     );
10492 
10526     void createSharedFolder (
10527         in wstring name,
10528         in wstring hostPath,
10529         in boolean writable,
10530         in boolean automount
10531     );
10532 
10557     void removeSharedFolder (
10558         in wstring name
10559     );
10560 
10598     void takeSnapshot (
10599         in wstring name,
10600         in wstring description,
10601         [retval] out IProgress progress
10602     );
10603 
10676     void deleteSnapshot (
10677         in wstringUUID id,
10678         [retval] out IProgress progress
10679     );
10680 
10720     void deleteSnapshotAndAllChildren (
10721         in wstringUUID id,
10722         [retval] out IProgress progress
10723     );
10724 
10768     void deleteSnapshotRange (
10769         in wstringUUID startId,
10770         in wstringUUID endId,
10771         [retval] out IProgress progress
10772     );
10773 
10814     void restoreSnapshot (
10815         in ISnapshot snapshot,
10816         [retval] out IProgress progress
10817     );
10818 
10857     void teleport (
10858         in wstring hostname,
10859         in unsigned long tcpport,
10860         in wstring password,
10861         in unsigned long maxDowntime,
10862         [retval] out IProgress progress
10863     );
10864 
10865 }; /* interface IConsole */
10866 
10877 interface IHostNetworkInterface : $unknown
10878 {
10882     readonly attribute wstring name;
10883 
10887     readonly attribute wstringUUID id;
10888 
10892     readonly attribute wstring networkName;
10893 
10897     readonly attribute boolean DHCPEnabled;
10898 
10902     readonly attribute wstring IPAddress;
10903 
10907     readonly attribute wstring networkMask;
10908 
10912     readonly attribute boolean IPV6Supported;
10913 
10917     readonly attribute wstring IPV6Address;
10918 
10922     readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
10923 
10927     readonly attribute wstring hardwareAddress;
10928 
10932     readonly attribute HostNetworkInterfaceMediumType mediumType;
10933 
10937     readonly attribute HostNetworkInterfaceStatus status;
10938 
10942     readonly attribute HostNetworkInterfaceType interfaceType;
10943 
10955     void enableStaticIPConfig (
10956         in wstring IPAddress,
10957         in wstring networkMask
10958     );
10959 
10971     void enableStaticIPConfigV6 (
10972         in wstring IPV6Address,
10973         in unsigned long IPV6NetworkMaskPrefixLength
10974     );
10975 
10979     void enableDynamicIPConfig();
10980 
10984     void DHCPRediscover();
10985 
10986 }; /* interface IHostNetworkInterface */
10987 
11004 interface IHost : $unknown
11005 {
11009     readonly attribute IMedium[] DVDDrives;
11010 
11014     readonly attribute IMedium[] floppyDrives;
11015 
11029     readonly attribute IHostUSBDevice[] USBDevices;
11030 
11054     readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
11055 
11059     readonly attribute IHostNetworkInterface[] networkInterfaces;
11060 
11064     readonly attribute unsigned long processorCount;
11065 
11069     readonly attribute unsigned long processorOnlineCount;
11070 
11074     readonly attribute unsigned long processorCoreCount;
11075 
11079     readonly attribute unsigned long memorySize;
11080 
11084     readonly attribute unsigned long memoryAvailable;
11085 
11089     readonly attribute wstring operatingSystem;
11090 
11094     readonly attribute wstring OSVersion;
11095 
11099     readonly attribute long long UTCTime;
11100 
11104     readonly attribute boolean acceleration3DAvailable;
11105 
11120     void getProcessorSpeed (
11121         in unsigned long cpuId,
11122         [retval] out unsigned long speed
11123     );
11124 
11136     void getProcessorFeature (
11137         in ProcessorFeature feature,
11138         [retval] out boolean supported
11139     );
11140 
11159     void getProcessorDescription (
11160         in unsigned long cpuId,
11161         [retval] out wstring description
11162     );
11163 
11204     void getProcessorCPUIDLeaf (
11205         in unsigned long cpuId,
11206         in unsigned long leaf,
11207         in unsigned long subLeaf,
11208         out unsigned long valEax,
11209         out unsigned long valEbx,
11210         out unsigned long valEcx,
11211         out unsigned long valEdx
11212     );
11213 
11234     void createHostOnlyNetworkInterface (
11235         out IHostNetworkInterface hostInterface,
11236         [retval] out IProgress progress
11237     );
11238 
11259     void removeHostOnlyNetworkInterface (
11260         in wstringUUID id,
11261         [retval] out IProgress progress
11262     );
11263 
11283     void createUSBDeviceFilter (
11284         in wstring name,
11285         [retval] out IHostUSBDeviceFilter filter
11286     );
11287 
11330     void insertUSBDeviceFilter (
11331         in unsigned long position,
11332         in IHostUSBDeviceFilter filter
11333     );
11334 
11362     void removeUSBDeviceFilter (
11363         in unsigned long position
11364     );
11365 
11383     void findHostDVDDrive (
11384         in wstring name,
11385         [retval] out IMedium drive
11386     );
11387 
11405     void findHostFloppyDrive (
11406         in wstring name,
11407         [retval] out IMedium drive
11408     );
11409 
11425     void findHostNetworkInterfaceByName (
11426         in wstring name,
11427         [retval] out IHostNetworkInterface networkInterface
11428     );
11429 
11445     void findHostNetworkInterfaceById (
11446         in wstringUUID id,
11447         [retval] out IHostNetworkInterface networkInterface
11448     );
11449 
11459     void findHostNetworkInterfacesOfType (
11460         in HostNetworkInterfaceType type,
11461         [retval] out IHostNetworkInterface[] networkInterfaces
11462     );
11463 
11483     void findUSBDeviceById (
11484         in wstringUUID id,
11485         [retval] out IHostUSBDevice device
11486     );
11487 
11510     void findUSBDeviceByAddress (
11511         in wstring name,
11512         [retval] out IHostUSBDevice device
11513     );
11514 
11522     void generateMACAddress (
11523         [retval] out wstring address
11524     );
11525 
11526 }; /* interface IHost */
11527 
11540 interface ISystemProperties : $unknown
11541 {
11545     readonly attribute unsigned long minGuestRAM;
11546 
11550     readonly attribute unsigned long maxGuestRAM;
11551 
11555     readonly attribute unsigned long minGuestVRAM;
11556 
11560     readonly attribute unsigned long maxGuestVRAM;
11561 
11565     readonly attribute unsigned long minGuestCPUCount;
11566 
11570     readonly attribute unsigned long maxGuestCPUCount;
11571 
11575     readonly attribute unsigned long maxGuestMonitors;
11576 
11581     readonly attribute long long infoVDSize;
11582 
11589     readonly attribute unsigned long serialPortCount;
11590 
11597     readonly attribute unsigned long parallelPortCount;
11598 
11608     readonly attribute unsigned long maxBootPosition;
11609 
11633     attribute wstring defaultMachineFolder;
11634 
11659     readonly attribute IMediumFormat[] mediumFormats;
11660 
11694     attribute wstring defaultHardDiskFormat;
11695 
11701     attribute long long freeDiskSpaceWarning;
11702 
11707     attribute unsigned long freeDiskSpacePercentWarning;
11708 
11714     attribute long long freeDiskSpaceError;
11715 
11720     attribute unsigned long freeDiskSpacePercentError;
11721 
11745     attribute wstring VRDEAuthLibrary;
11746 
11775     attribute wstring webServiceAuthLibrary;
11776 
11790     attribute wstring defaultVRDEExtPack;
11791 
11797     attribute unsigned long logHistoryCount;
11798 
11803     readonly attribute AudioDriverType defaultAudioDriver;
11804 
11811     attribute wstring autostartDatabasePath;
11812 
11819     attribute wstring defaultAdditionsISO;
11820 
11831     void getMaxNetworkAdapters (
11832         in ChipsetType chipset,
11833         [retval] out unsigned long maxNetworkAdapters
11834     );
11835 
11849     void getMaxNetworkAdaptersOfType (
11850         in ChipsetType chipset,
11851         in NetworkAttachmentType type,
11852         [retval] out unsigned long maxNetworkAdapters
11853     );
11854 
11864     void getMaxDevicesPerPortForStorageBus (
11865         in StorageBus bus,
11866         [retval] out unsigned long maxDevicesPerPort
11867     );
11868 
11876     void getMinPortCountForStorageBus (
11877         in StorageBus bus,
11878         [retval] out unsigned long minPortCount
11879     );
11880 
11888     void getMaxPortCountForStorageBus (
11889         in StorageBus bus,
11890         [retval] out unsigned long maxPortCount
11891     );
11892 
11905     void getMaxInstancesOfStorageBus (
11906         in ChipsetType chipset,
11907         in StorageBus bus,
11908         [retval] out unsigned long maxInstances
11909     );
11910 
11920     void getDeviceTypesForStorageBus (
11921         in StorageBus bus,
11922         [retval] out DeviceType[] deviceTypes
11923     );
11924 
11933     void getDefaultIoCacheSettingForStorageController (
11934         in StorageControllerType controllerType,
11935         [retval] out boolean enabled
11936     );
11937 
11938 }; /* interface ISystemProperties */
11939 
11945 interface IGuestOSType : $unknown
11946 {
11950     readonly attribute wstring familyId;
11951 
11955     readonly attribute wstring familyDescription;
11956 
11960     readonly attribute wstring id;
11961 
11965     readonly attribute wstring description;
11966 
11970     readonly attribute boolean is64Bit;
11971 
11975     readonly attribute boolean recommendedIOAPIC;
11976 
11980     readonly attribute boolean recommendedVirtEx;
11981 
11985     readonly attribute unsigned long recommendedRAM;
11986 
11990     readonly attribute unsigned long recommendedVRAM;
11991 
11995     readonly attribute boolean recommended2DVideoAcceleration;
11996 
12000     readonly attribute boolean recommended3DAcceleration;
12001 
12005     readonly attribute long long recommendedHDD;
12006 
12010     readonly attribute NetworkAdapterType adapterType;
12011 
12015     readonly attribute boolean recommendedPAE;
12016 
12020     readonly attribute StorageControllerType recommendedDVDStorageController;
12021 
12025     readonly attribute StorageBus recommendedDVDStorageBus;
12026 
12030     readonly attribute StorageControllerType recommendedHDStorageController;
12031 
12035     readonly attribute StorageBus recommendedHDStorageBus;
12036 
12040     readonly attribute FirmwareType recommendedFirmware;
12041 
12045     readonly attribute boolean recommendedUSBHID;
12046 
12050     readonly attribute boolean recommendedHPET;
12051 
12055     readonly attribute boolean recommendedUSBTablet;
12056 
12060     readonly attribute boolean recommendedRTCUseUTC;
12061 
12065     readonly attribute ChipsetType recommendedChipset;
12066 
12070     readonly attribute AudioControllerType recommendedAudioController;
12071 
12075     readonly attribute boolean recommendedFloppy;
12076 
12080     readonly attribute boolean recommendedUSB;
12081 
12082 }; /* interface IGuestOSType */
12083 
12091 interface IAdditionsFacility : $unknown
12092 {
12096     readonly attribute AdditionsFacilityClass classType;
12097 
12104     readonly attribute long long lastUpdated;
12105 
12109     readonly attribute wstring name;
12110 
12114     readonly attribute AdditionsFacilityStatus status;
12115 
12119     readonly attribute AdditionsFacilityType type;
12120 
12121 }; /* interface IAdditionsFacility */
12122 
12148 interface IGuestSession : $unknown
12149 {
12155     readonly attribute wstring user;
12156 
12162     readonly attribute wstring domain;
12163 
12167     readonly attribute wstring name;
12168 
12172     readonly attribute unsigned long id;
12173 
12186     attribute unsigned long timeout;
12187 
12193     attribute wstring[] environment;
12194 
12200     readonly attribute IGuestProcess[] processes;
12201 
12207     readonly attribute IGuestDirectory[] directories;
12208 
12214     readonly attribute IGuestFile[] files;
12215 
12223     void close();
12224 
12246     void copyFrom (
12247         in wstring source,
12248         in wstring dest,
12249         in CopyFileFlag[] flags,
12250         [retval] out IProgress progress
12251     );
12252 
12274     void copyTo (
12275         in wstring source,
12276         in wstring dest,
12277         in CopyFileFlag[] flags,
12278         [retval] out IProgress progress
12279     );
12280 
12300     void directoryCreate (
12301         in wstring path,
12302         in unsigned long mode,
12303         in DirectoryCreateFlag[] flags
12304     );
12305 
12357     void directoryCreateTemp (
12358         in wstring templateName,
12359         in unsigned long mode,
12360         in wstring path,
12361         in boolean secure,
12362         [retval] out wstring directory
12363     );
12364 
12382     void directoryExists (
12383         in wstring path,
12384         [retval] out boolean exists
12385     );
12386 
12417     void directoryOpen (
12418         in wstring path,
12419         in wstring filter,
12420         in DirectoryOpenFlag[] flags,
12421         [retval] out IGuestDirectory directory
12422     );
12423 
12449     void directoryQueryInfo (
12450         in wstring path,
12451         [retval] out IGuestFsObjInfo info
12452     );
12453 
12469     void directoryRemove (
12470         in wstring path
12471     );
12472 
12492     void directoryRemoveRecursive (
12493         in wstring path,
12494         in DirectoryRemoveRecFlag[] flags,
12495         [retval] out IProgress progress
12496     );
12497 
12517     void directoryRename (
12518         in wstring source,
12519         in wstring dest,
12520         in PathRenameFlag[] flags
12521     );
12522 
12540     void directorySetACL (
12541         in wstring path,
12542         in wstring acl
12543     );
12544 
12558     void environmentClear();
12559 
12580     void environmentGet (
12581         in wstring name,
12582         [retval] out wstring value
12583     );
12584 
12602     void environmentSet (
12603         in wstring name,
12604         in wstring value
12605     );
12606 
12622     void environmentUnset (
12623         in wstring name
12624     );
12625 
12679     void fileCreateTemp (
12680         in wstring templateName,
12681         in unsigned long mode,
12682         in wstring path,
12683         in boolean secure,
12684         [retval] out IGuestFile file
12685     );
12686 
12704     void fileExists (
12705         in wstring path,
12706         [retval] out boolean exists
12707     );
12708 
12732     void fileRemove (
12733         in wstring path
12734     );
12735 
12770     void fileOpen (
12771         in wstring path,
12772         in wstring openMode,
12773         in wstring disposition,
12774         in unsigned long creationMode,
12775         in long long offset,
12776         [retval] out IGuestFile file
12777     );
12778 
12804     void fileQueryInfo (
12805         in wstring path,
12806         [retval] out IGuestFsObjInfo info
12807     );
12808 
12834     void fileQuerySize (
12835         in wstring path,
12836         [retval] out long long size
12837     );
12838 
12858     void fileRename (
12859         in wstring source,
12860         in wstring dest,
12861         in PathRenameFlag[] flags
12862     );
12863 
12881     void fileSetACL (
12882         in wstring file,
12883         in wstring acl
12884     );
12885 
12945     void processCreate (
12946         in wstring command,
12947         in wstring[] arguments,
12948         in wstring[] environment,
12949         in ProcessCreateFlag[] flags,
12950         in unsigned long timeoutMS,
12951         [retval] out IGuestProcess guestProcess
12952     );
12953 
13023     void processCreateEx (
13024         in wstring command,
13025         in wstring[] arguments,
13026         in wstring[] environment,
13027         in ProcessCreateFlag[] flags,
13028         in unsigned long timeoutMS,
13029         in ProcessPriority priority,
13030         in long[] affinity,
13031         [retval] out IGuestProcess guestProcess
13032     );
13033 
13043     void processGet (
13044         in unsigned long pid,
13045         [retval] out IGuestProcess guestProcess
13046     );
13047 
13070     void symlinkCreate (
13071         in wstring source,
13072         in wstring target,
13073         in SymlinkType type
13074     );
13075 
13093     void symlinkExists (
13094         in wstring symlink,
13095         [retval] out boolean exists
13096     );
13097 
13121     void symlinkRead (
13122         in wstring symlink,
13123         in SymlinkReadFlag[] flags,
13124         [retval] out wstring target
13125     );
13126 
13142     void symlinkRemoveDirectory (
13143         in wstring path
13144     );
13145 
13161     void symlinkRemoveFile (
13162         in wstring file
13163     );
13164 
13165 }; /* interface IGuestSession */
13166 
13174 interface IProcess : $unknown
13175 {
13181     readonly attribute unsigned long PID;
13182 
13189     readonly attribute ProcessStatus status;
13190 
13197     readonly attribute long exitCode;
13198 
13204     readonly attribute wstring[] environment;
13205 
13211     readonly attribute wstring[] arguments;
13212 
13216     readonly attribute wstring executablePath;
13217 
13221     readonly attribute wstring name;
13222 
13243     void waitFor (
13244         in unsigned long waitFor,
13245         in unsigned long timeoutMS,
13246         [retval] out ProcessWaitResult reason
13247     );
13248 
13270     void waitForArray (
13271         in ProcessWaitForFlag[] waitFor,
13272         in unsigned long timeoutMS,
13273         [retval] out ProcessWaitResult reason
13274     );
13275 
13292     void read (
13293         in unsigned long handle,
13294         in unsigned long toRead,
13295         in unsigned long timeoutMS,
13296         [retval] out octet[] data
13297     );
13298 
13322     void write (
13323         in unsigned long handle,
13324         in unsigned long flags,
13325         in octet[] data,
13326         in unsigned long timeoutMS,
13327         [retval] out unsigned long written
13328     );
13329 
13354     void writeArray (
13355         in unsigned long handle,
13356         in ProcessInputFlag[] flags,
13357         in octet[] data,
13358         in unsigned long timeoutMS,
13359         [retval] out unsigned long written
13360     );
13361 
13367     void terminate();
13368 
13369 }; /* interface IProcess */
13370 
13379 interface IGuestProcess : IProcess
13380 {
13381 }; /* interface IGuestProcess */
13382 
13390 interface IDirectory : $unknown
13391 {
13397     readonly attribute wstring directoryName;
13398 
13404     readonly attribute wstring filter;
13405 
13412     void close();
13413 
13428     void read (
13429         [retval] out IFsObjInfo objInfo
13430     );
13431 
13432 }; /* interface IDirectory */
13433 
13442 interface IGuestDirectory : IDirectory
13443 {
13444 }; /* interface IGuestDirectory */
13445 
13453 interface IFile : $unknown
13454 {
13460     readonly attribute unsigned long creationMode;
13461 
13467     readonly attribute unsigned long disposition;
13468 
13474     readonly attribute wstring fileName;
13475 
13481     readonly attribute long long initialSize;
13482 
13488     readonly attribute unsigned long openMode;
13489 
13495     readonly attribute long long offset;
13496 
13503     void close();
13504 
13520     void queryInfo (
13521         [retval] out IFsObjInfo objInfo
13522     );
13523 
13546     void read (
13547         in unsigned long toRead,
13548         in unsigned long timeoutMS,
13549         [retval] out octet[] data
13550     );
13551 
13576     void readAt (
13577         in long long offset,
13578         in unsigned long toRead,
13579         in unsigned long timeoutMS,
13580         [retval] out octet[] data
13581     );
13582 
13602     void seek (
13603         in long long offset,
13604         in FileSeekType whence
13605     );
13606 
13622     void setACL (
13623         in wstring acl
13624     );
13625 
13643     void write (
13644         in octet[] data,
13645         in unsigned long timeoutMS,
13646         [retval] out unsigned long written
13647     );
13648 
13676     void writeAt (
13677         in long long offset,
13678         in octet[] data,
13679         in unsigned long timeoutMS,
13680         [retval] out unsigned long written
13681     );
13682 
13683 }; /* interface IFile */
13684 
13693 interface IGuestFile : IFile
13694 {
13695 }; /* interface IGuestFile */
13696 
13705 interface IFsObjInfo : $unknown
13706 {
13712     readonly attribute long long accessTime;
13713 
13719     readonly attribute long long allocatedSize;
13720 
13726     readonly attribute long long birthTime;
13727 
13733     readonly attribute long long changeTime;
13734 
13740     readonly attribute unsigned long deviceNumber;
13741 
13747     readonly attribute wstring fileAttributes;
13748 
13754     readonly attribute unsigned long generationId;
13755 
13761     readonly attribute unsigned long GID;
13762 
13768     readonly attribute wstring groupName;
13769 
13775     readonly attribute unsigned long hardLinks;
13776 
13782     readonly attribute long long modificationTime;
13783 
13789     readonly attribute wstring name;
13790 
13796     readonly attribute long long nodeId;
13797 
13803     readonly attribute unsigned long nodeIdDevice;
13804 
13812     readonly attribute long long objectSize;
13813 
13819     readonly attribute FsObjType type;
13820 
13826     readonly attribute unsigned long UID;
13827 
13833     readonly attribute unsigned long userFlags;
13834 
13840     readonly attribute wstring userName;
13841 
13842 }; /* interface IFsObjInfo */
13843 
13852 interface IGuestFsObjInfo : IFsObjInfo
13853 {
13854 }; /* interface IGuestFsObjInfo */
13855 
13869 interface IGuest : $unknown
13870 {
13885     readonly attribute wstring OSTypeId;
13886 
13892     readonly attribute AdditionsRunLevelType additionsRunLevel;
13893 
13900     readonly attribute wstring additionsVersion;
13901 
13909     readonly attribute unsigned long additionsRevision;
13910 
13917     readonly attribute IAdditionsFacility[] facilities;
13918 
13922     readonly attribute IGuestSession[] sessions;
13923 
13927     attribute unsigned long memoryBalloonSize;
13928 
13932     attribute unsigned long statisticsUpdateInterval;
13933 
13965     void internalGetStatistics (
13966         out unsigned long cpuUser,
13967         out unsigned long cpuKernel,
13968         out unsigned long cpuIdle,
13969         out unsigned long memTotal,
13970         out unsigned long memFree,
13971         out unsigned long memBalloon,
13972         out unsigned long memShared,
13973         out unsigned long memCache,
13974         out unsigned long pagedTotal,
13975         out unsigned long memAllocTotal,
13976         out unsigned long memFreeTotal,
13977         out unsigned long memBalloonTotal,
13978         out unsigned long memSharedTotal
13979     );
13980 
13992     void getFacilityStatus (
13993         in AdditionsFacilityType facility,
13994         out long long timestamp,
13995         [retval] out AdditionsFacilityStatus status
13996     );
13997 
14015     void getAdditionsStatus (
14016         in AdditionsRunLevelType level,
14017         [retval] out boolean active
14018     );
14019 
14049     void setCredentials (
14050         in wstring userName,
14051         in wstring password,
14052         in wstring domain,
14053         in boolean allowInteractiveLogon
14054     );
14055 
14085     void dragHGEnter (
14086         in unsigned long screenId,
14087         in unsigned long y,
14088         in unsigned long x,
14089         in DragAndDropAction defaultAction,
14090         in DragAndDropAction[] allowedActions,
14091         in wstring[] formats,
14092         [retval] out DragAndDropAction resultAction
14093     );
14094 
14124     void dragHGMove (
14125         in unsigned long screenId,
14126         in unsigned long x,
14127         in unsigned long y,
14128         in DragAndDropAction defaultAction,
14129         in DragAndDropAction[] allowedActions,
14130         in wstring[] formats,
14131         [retval] out DragAndDropAction resultAction
14132     );
14133 
14151     void dragHGLeave (
14152         in unsigned long screenId
14153     );
14154 
14186     void dragHGDrop (
14187         in unsigned long screenId,
14188         in unsigned long x,
14189         in unsigned long y,
14190         in DragAndDropAction defaultAction,
14191         in DragAndDropAction[] allowedActions,
14192         in wstring[] formats,
14193         out wstring format,
14194         [retval] out DragAndDropAction resultAction
14195     );
14196 
14220     void dragHGPutData (
14221         in unsigned long screenId,
14222         in wstring format,
14223         in octet[] data,
14224         [retval] out IProgress progress
14225     );
14226 
14252     void dragGHPending (
14253         in unsigned long screenId,
14254         out wstring[] format,
14255         out DragAndDropAction[] allowedActions,
14256         [retval] out DragAndDropAction defaultAction
14257     );
14258 
14280     void dragGHDropped (
14281         in wstring format,
14282         in DragAndDropAction action,
14283         [retval] out IProgress progress
14284     );
14285 
14303     void dragGHGetData (
14304         [retval] out octet[] data
14305     );
14306 
14361     void createSession (
14362         in wstring user,
14363         in wstring password,
14364         in wstring domain,
14365         in wstring sessionName,
14366         [retval] out IGuestSession guestSession
14367     );
14368 
14383     void findSession (
14384         in wstring sessionName,
14385         [retval] out IGuestSession[] sessions
14386     );
14387 
14431     void updateGuestAdditions (
14432         in wstring source,
14433         in AdditionsUpdateFlag[] flags,
14434         [retval] out IProgress progress
14435     );
14436 
14437 }; /* interface IGuest */
14438 
14479 interface IProgress : $unknown
14480 {
14484     readonly attribute wstringUUID id;
14485 
14489     readonly attribute wstring description;
14490 
14494     readonly attribute $unknown initiator;
14495 
14499     readonly attribute boolean cancelable;
14500 
14508     readonly attribute unsigned long percent;
14509 
14523     readonly attribute long timeRemaining;
14524 
14528     readonly attribute boolean completed;
14529 
14533     readonly attribute boolean canceled;
14534 
14541     readonly attribute long resultCode;
14542 
14552     readonly attribute IVirtualBoxErrorInfo errorInfo;
14553 
14560     readonly attribute unsigned long operationCount;
14561 
14565     readonly attribute unsigned long operation;
14566 
14572     readonly attribute wstring operationDescription;
14573 
14577     readonly attribute unsigned long operationPercent;
14578 
14582     readonly attribute unsigned long operationWeight;
14583 
14591     attribute unsigned long timeout;
14592 
14596     void setCurrentOperationProgress (
14597         in unsigned long percent
14598     );
14599 
14603     void setNextOperation (
14604         in wstring nextOperationDescription,
14605         in unsigned long nextOperationsWeight
14606     );
14607 
14634     void waitForCompletion (
14635         in long timeout
14636     );
14637 
14661     void waitForOperationCompletion (
14662         in unsigned long operation,
14663         in long timeout
14664     );
14665 
14691     void waitForAsyncProgressCompletion (
14692         in IProgress pProgressAsync
14693     );
14694 
14711     void cancel();
14712 
14713 }; /* interface IProgress */
14714 
14798 interface ISnapshot : $unknown
14799 {
14803     readonly attribute wstringUUID id;
14804 
14812     attribute wstring name;
14813 
14821     attribute wstring description;
14822 
14828     readonly attribute long long timeStamp;
14829 
14841     readonly attribute boolean online;
14842 
14854     readonly attribute IMachine machine;
14855 
14862     readonly attribute ISnapshot parent;
14863 
14872     readonly attribute ISnapshot[] children;
14873 
14881     void getChildrenCount (
14882         [retval] out unsigned long childrenCount
14883     );
14884 
14885 }; /* interface ISnapshot */
14886 
15073 interface IMediumAttachment : $unknown
15074 {
15079     readonly attribute IMedium medium;
15080 
15086     readonly attribute wstring controller;
15087 
15093     readonly attribute long port;
15094 
15100     readonly attribute long device;
15101 
15105     readonly attribute DeviceType type;
15106 
15110     readonly attribute boolean passthrough;
15111 
15115     readonly attribute boolean temporaryEject;
15116 
15121     readonly attribute boolean isEjected;
15122 
15126     readonly attribute boolean nonRotational;
15127 
15131     readonly attribute boolean discard;
15132 
15136     readonly attribute IBandwidthGroup bandwidthGroup;
15137 
15138 }; /* interface IMediumAttachment */
15139 
15297 interface IMedium : $unknown
15298 {
15312     readonly attribute wstringUUID id;
15313 
15332     attribute wstring description;
15333 
15349     readonly attribute MediumState state;
15350 
15359     readonly attribute unsigned long variant;
15360 
15382     attribute wstring location;
15383 
15403     readonly attribute wstring name;
15404 
15409     readonly attribute DeviceType deviceType;
15410 
15414     readonly attribute boolean hostDrive;
15415 
15428     readonly attribute long long size;
15429 
15444     readonly attribute wstring format;
15445 
15461     readonly attribute IMediumFormat mediumFormat;
15462 
15487     attribute MediumType type;
15488 
15502     readonly attribute MediumType[] allowedTypes;
15503 
15513     readonly attribute IMedium parent;
15514 
15522     readonly attribute IMedium[] children;
15523 
15534     readonly attribute IMedium base;
15535 
15568     readonly attribute boolean readOnly;
15569 
15590     readonly attribute long long logicalSize;
15591 
15619     attribute boolean autoReset;
15620 
15635     readonly attribute wstring lastAccessError;
15636 
15653     readonly attribute wstringUUID[] machineIds;
15654 
15680     void setIds (
15681         in boolean setImageId,
15682         in wstringUUID imageId,
15683         in boolean setParentId,
15684         in wstringUUID parentId
15685     );
15686 
15721     void refreshState (
15722         [retval] out MediumState state
15723     );
15724 
15751     void getSnapshotIds (
15752         in wstringUUID machineId,
15753         [retval] out wstringUUID[] snapshotIds
15754     );
15755 
15815     void lockRead (
15816         [retval] out MediumState state
15817     );
15818 
15841     void unlockRead (
15842         [retval] out MediumState state
15843     );
15844 
15899     void lockWrite (
15900         [retval] out MediumState state
15901     );
15902 
15925     void unlockWrite (
15926         [retval] out MediumState state
15927     );
15928 
15978     void close();
15979 
16009     void getProperty (
16010         in wstring name,
16011         [retval] out wstring value
16012     );
16013 
16045     void setProperty (
16046         in wstring name,
16047         in wstring value
16048     );
16049 
16084     void getProperties (
16085         in wstring names,
16086         out wstring[] returnNames,
16087         [retval] out wstring[] returnValues
16088     );
16089 
16119     void setProperties (
16120         in wstring[] names,
16121         in wstring[] values
16122     );
16123 
16156     void createBaseStorage (
16157         in long long logicalSize,
16158         in unsigned long variant,
16159         [retval] out IProgress progress
16160     );
16161 
16213     void deleteStorage (
16214         [retval] out IProgress progress
16215     );
16216 
16255     void createDiffStorage (
16256         in IMedium target,
16257         in unsigned long variant,
16258         [retval] out IProgress progress
16259     );
16260 
16336     void mergeTo (
16337         in IMedium target,
16338         [retval] out IProgress progress
16339     );
16340 
16390     void cloneTo (
16391         in IMedium target,
16392         in unsigned long variant,
16393         in IMedium parent,
16394         [retval] out IProgress progress
16395     );
16396 
16444     void cloneToBase (
16445         in IMedium target,
16446         in unsigned long variant,
16447         [retval] out IProgress progress
16448     );
16449 
16478     void compact (
16479         [retval] out IProgress progress
16480     );
16481 
16514     void resize (
16515         in long long logicalSize,
16516         [retval] out IProgress progress
16517     );
16518 
16552     void reset (
16553         [retval] out IProgress progress
16554     );
16555 
16556 }; /* interface IMedium */
16557 
16580 interface IMediumFormat : $unknown
16581 {
16600     readonly attribute wstring id;
16601 
16609     readonly attribute wstring name;
16610 
16619     readonly attribute unsigned long capabilities;
16620 
16639     void describeFileExtensions (
16640         out wstring[] extensions,
16641         out DeviceType[] type
16642     );
16643 
16671     void describeProperties (
16672         out wstring[] names,
16673         out wstring[] description,
16674         out DataType[] types,
16675         out unsigned long[] flags,
16676         out wstring[] defaults
16677     );
16678 
16679 }; /* interface IMediumFormat */
16680 
16693 interface IKeyboard : $unknown
16694 {
16700     readonly attribute IEventSource eventSource;
16701 
16714     void putScancode (
16715         in long scancode
16716     );
16717 
16730     void putScancodes (
16731         in long[] scancodes,
16732         [retval] out unsigned long codesStored
16733     );
16734 
16749     void putCAD();
16750 
16751 }; /* interface IKeyboard */
16752 
16764 interface IMouse : $unknown
16765 {
16780     readonly attribute boolean absoluteSupported;
16781 
16796     readonly attribute boolean relativeSupported;
16797 
16812     readonly attribute boolean needsHostCursor;
16813 
16819     readonly attribute IEventSource eventSource;
16820 
16886     void putMouseEvent (
16887         in long dx,
16888         in long dy,
16889         in long dz,
16890         in long dw,
16891         in long buttonState
16892     );
16893 
16966     void putMouseEventAbsolute (
16967         in long x,
16968         in long y,
16969         in long dz,
16970         in long dw,
16971         in long buttonState
16972     );
16973 
16974 }; /* interface IMouse */
16975 
16976 interface IFramebuffer : $unknown
16977 {
16986     readonly attribute octetPtr address;
16987 
16991     readonly attribute unsigned long width;
16992 
16996     readonly attribute unsigned long height;
16997 
17004     readonly attribute unsigned long bitsPerPixel;
17005 
17012     readonly attribute unsigned long bytesPerLine;
17013 
17024     readonly attribute unsigned long pixelFormat;
17025 
17032     readonly attribute boolean usesGuestVRAM;
17033 
17043     readonly attribute unsigned long heightReduction;
17044 
17059     readonly attribute IFramebufferOverlay overlay;
17060 
17067     readonly attribute long long winId;
17068 
17076     void lock();
17077 
17085     void unlock();
17086 
17094     void notifyUpdate (
17095         in unsigned long x,
17096         in unsigned long y,
17097         in unsigned long width,
17098         in unsigned long height
17099     );
17100 
17213     void requestResize (
17214         in unsigned long screenId,
17215         in unsigned long pixelFormat,
17216         in octetPtr VRAM,
17217         in unsigned long bitsPerPixel,
17218         in unsigned long bytesPerLine,
17219         in unsigned long width,
17220         in unsigned long height,
17221         [retval] out boolean finished
17222     );
17223 
17235     void videoModeSupported (
17236         in unsigned long width,
17237         in unsigned long height,
17238         in unsigned long bpp,
17239         [retval] out boolean supported
17240     );
17241 
17278     void getVisibleRegion (
17279         in octetPtr rectangles,
17280         in unsigned long count,
17281         [retval] out unsigned long countCopied
17282     );
17283 
17318     void setVisibleRegion (
17319         in octetPtr rectangles,
17320         in unsigned long count
17321     );
17322 
17343     void processVHWACommand (
17344         in octetPtr command
17345     );
17346 
17347 }; /* interface IFramebuffer */
17348 
17363 interface IFramebufferOverlay : IFramebuffer
17364 {
17368     readonly attribute unsigned long x;
17369 
17373     readonly attribute unsigned long y;
17374 
17380     attribute boolean visible;
17381 
17388     attribute unsigned long alpha;
17389 
17395     void move (
17396         in unsigned long x,
17397         in unsigned long y
17398     );
17399 
17400 }; /* interface IFramebufferOverlay */
17401 
17417 interface IDisplay : $unknown
17418 {
17422     void getScreenResolution (
17423         in unsigned long screenId,
17424         out unsigned long width,
17425         out unsigned long height,
17426         out unsigned long bitsPerPixel
17427     );
17428 
17434     void setFramebuffer (
17435         in unsigned long screenId,
17436         in IFramebuffer framebuffer
17437     );
17438 
17444     void getFramebuffer (
17445         in unsigned long screenId,
17446         out IFramebuffer framebuffer,
17447         out long xOrigin,
17448         out long yOrigin
17449     );
17450 
17501     void setVideoModeHint (
17502         in unsigned long display,
17503         in boolean enabled,
17504         in boolean changeOrigin,
17505         in long originX,
17506         in long originY,
17507         in unsigned long width,
17508         in unsigned long height,
17509         in unsigned long bitsPerPixel
17510     );
17511 
17523     void setSeamlessMode (
17524         in boolean enabled
17525     );
17526 
17562     void takeScreenShot (
17563         in unsigned long screenId,
17564         in octetPtr address,
17565         in unsigned long width,
17566         in unsigned long height
17567     );
17568 
17612     void takeScreenShotToArray (
17613         in unsigned long screenId,
17614         in unsigned long width,
17615         in unsigned long height,
17616         [retval] out octet[] screenData
17617     );
17618 
17657     void takeScreenShotPNGToArray (
17658         in unsigned long screenId,
17659         in unsigned long width,
17660         in unsigned long height,
17661         [retval] out octet[] screenData
17662     );
17663 
17715     void drawToScreen (
17716         in unsigned long screenId,
17717         in octetPtr address,
17718         in unsigned long x,
17719         in unsigned long y,
17720         in unsigned long width,
17721         in unsigned long height
17722     );
17723 
17738     void invalidateAndUpdate();
17739 
17753     void resizeCompleted (
17754         in unsigned long screenId
17755     );
17756 
17769     void completeVHWACommand (
17770         in octetPtr command
17771     );
17772 
17806     void viewportChanged (
17807         in unsigned long screenId,
17808         in unsigned long x,
17809         in unsigned long y,
17810         in unsigned long width,
17811         in unsigned long height
17812     );
17813 
17814 }; /* interface IDisplay */
17815 
17831 interface INetworkAdapter : $unknown
17832 {
17840     attribute NetworkAdapterType adapterType;
17841 
17849     readonly attribute unsigned long slot;
17850 
17859     attribute boolean enabled;
17860 
17867     attribute wstring MACAddress;
17868 
17874     attribute NetworkAttachmentType attachmentType;
17875 
17881     attribute wstring bridgedInterface;
17882 
17888     attribute wstring hostOnlyInterface;
17889 
17895     attribute wstring internalNetwork;
17896 
17902     attribute wstring NATNetwork;
17903 
17909     attribute wstring genericDriver;
17910 
17917     attribute boolean cableConnected;
17918 
17924     attribute unsigned long lineSpeed;
17925 
17932     attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
17933 
17940     attribute boolean traceEnabled;
17941 
17948     attribute wstring traceFile;
17949 
17957     readonly attribute INATEngine NATEngine;
17958 
17965     attribute unsigned long bootPriority;
17966 
17970     attribute IBandwidthGroup bandwidthGroup;
17971 
17990     void getProperty (
17991         in wstring key,
17992         [retval] out wstring value
17993     );
17994 
18013     void setProperty (
18014         in wstring key,
18015         in wstring value
18016     );
18017 
18045     void getProperties (
18046         in wstring names,
18047         out wstring[] returnNames,
18048         [retval] out wstring[] returnValues
18049     );
18050 
18051 }; /* interface INetworkAdapter */
18052 
18081 interface ISerialPort : $unknown
18082 {
18090     readonly attribute unsigned long slot;
18091 
18098     attribute boolean enabled;
18099 
18103     attribute unsigned long IOBase;
18104 
18108     attribute unsigned long IRQ;
18109 
18120     attribute PortMode hostMode;
18121 
18129     attribute boolean server;
18130 
18140     attribute wstring path;
18141 
18142 }; /* interface ISerialPort */
18143 
18163 interface IParallelPort : $unknown
18164 {
18172     readonly attribute unsigned long slot;
18173 
18180     attribute boolean enabled;
18181 
18185     attribute unsigned long IOBase;
18186 
18190     attribute unsigned long IRQ;
18191 
18199     attribute wstring path;
18200 
18201 }; /* interface IParallelPort */
18202 
18203 interface IMachineDebugger : $unknown
18204 {
18208     attribute boolean singleStep;
18209 
18213     attribute boolean recompileUser;
18214 
18218     attribute boolean recompileSupervisor;
18219 
18223     attribute boolean PATMEnabled;
18224 
18228     attribute boolean CSAMEnabled;
18229 
18233     attribute boolean logEnabled;
18234 
18238     readonly attribute wstring logDbgFlags;
18239 
18243     readonly attribute wstring logDbgGroups;
18244 
18248     readonly attribute wstring logDbgDestinations;
18249 
18253     readonly attribute wstring logRelFlags;
18254 
18258     readonly attribute wstring logRelGroups;
18259 
18263     readonly attribute wstring logRelDestinations;
18264 
18271     readonly attribute boolean HWVirtExEnabled;
18272 
18279     readonly attribute boolean HWVirtExNestedPagingEnabled;
18280 
18287     readonly attribute boolean HWVirtExVPIDEnabled;
18288 
18297     readonly attribute wstring OSName;
18298 
18307     readonly attribute wstring OSVersion;
18308 
18315     readonly attribute boolean PAEEnabled;
18316 
18323     attribute unsigned long virtualTimeRate;
18324 
18331     readonly attribute long long VM;
18332 
18348     void dumpGuestCore (
18349         in wstring filename,
18350         in wstring compression
18351     );
18352 
18369     void dumpHostProcessCore (
18370         in wstring filename,
18371         in wstring compression
18372     );
18373 
18394     void info (
18395         in wstring name,
18396         in wstring args,
18397         [retval] out wstring info
18398     );
18399 
18405     void injectNMI();
18406 
18417     void modifyLogGroups (
18418         in wstring settings
18419     );
18420 
18431     void modifyLogFlags (
18432         in wstring settings
18433     );
18434 
18445     void modifyLogDestinations (
18446         in wstring settings
18447     );
18448 
18463     void readPhysicalMemory (
18464         in long long address,
18465         in unsigned long size,
18466         [retval] out octet[] bytes
18467     );
18468 
18483     void writePhysicalMemory (
18484         in long long address,
18485         in unsigned long size,
18486         in octet[] bytes
18487     );
18488 
18505     void readVirtualMemory (
18506         in unsigned long cpuId,
18507         in long long address,
18508         in unsigned long size,
18509         [retval] out octet[] bytes
18510     );
18511 
18528     void writeVirtualMemory (
18529         in unsigned long cpuId,
18530         in long long address,
18531         in unsigned long size,
18532         in octet[] bytes
18533     );
18534 
18547     void detectOS (
18548         [retval] out wstring os
18549     );
18550 
18568     void getRegister (
18569         in unsigned long cpuId,
18570         in wstring name,
18571         [retval] out wstring value
18572     );
18573 
18591     void getRegisters (
18592         in unsigned long cpuId,
18593         out wstring[] names,
18594         out wstring[] values
18595     );
18596 
18615     void setRegister (
18616         in unsigned long cpuId,
18617         in wstring name,
18618         in wstring value
18619     );
18620 
18639     void setRegisters (
18640         in unsigned long cpuId,
18641         in wstring[] names,
18642         in wstring[] values
18643     );
18644 
18657     void dumpGuestStack (
18658         in unsigned long cpuId,
18659         [retval] out wstring stack
18660     );
18661 
18669     void resetStats (
18670         in wstring pattern
18671     );
18672 
18680     void dumpStats (
18681         in wstring pattern
18682     );
18683 
18695     void getStats (
18696         in wstring pattern,
18697         in boolean withDescriptions,
18698         out wstring stats
18699     );
18700 
18701 }; /* interface IMachineDebugger */
18702 
18703 interface IUSBController : $unknown
18704 {
18713     attribute boolean enabled;
18714 
18723     attribute boolean enabledEHCI;
18724 
18730     readonly attribute boolean proxyAvailable;
18731 
18739     readonly attribute unsigned short USBStandard;
18740 
18766     readonly attribute IUSBDeviceFilter[] deviceFilters;
18767 
18795     void createDeviceFilter (
18796         in wstring name,
18797         [retval] out IUSBDeviceFilter filter
18798     );
18799 
18844     void insertDeviceFilter (
18845         in unsigned long position,
18846         in IUSBDeviceFilter filter
18847     );
18848 
18881     void removeDeviceFilter (
18882         in unsigned long position,
18883         [retval] out IUSBDeviceFilter filter
18884     );
18885 
18886 }; /* interface IUSBController */
18887 
18900 interface IUSBDevice : $unknown
18901 {
18908     readonly attribute wstringUUID id;
18909 
18913     readonly attribute unsigned short vendorId;
18914 
18918     readonly attribute unsigned short productId;
18919 
18927     readonly attribute unsigned short revision;
18928 
18932     readonly attribute wstring manufacturer;
18933 
18937     readonly attribute wstring product;
18938 
18942     readonly attribute wstring serialNumber;
18943 
18947     readonly attribute wstring address;
18948 
18955     readonly attribute unsigned short port;
18956 
18962     readonly attribute unsigned short version;
18963 
18971     readonly attribute unsigned short portVersion;
18972 
18979     readonly attribute boolean remote;
18980 
18981 }; /* interface IUSBDevice */
18982 
19057 interface IUSBDeviceFilter : $unknown
19058 {
19066     attribute wstring name;
19067 
19071     attribute boolean active;
19072 
19080     attribute wstring vendorId;
19081 
19089     attribute wstring productId;
19090 
19104     attribute wstring revision;
19105 
19110     attribute wstring manufacturer;
19111 
19116     attribute wstring product;
19117 
19122     attribute wstring serialNumber;
19123 
19128     attribute wstring port;
19129 
19139     attribute wstring remote;
19140 
19150     attribute unsigned long maskedInterfaces;
19151 
19152 }; /* interface IUSBDeviceFilter */
19153 
19170 interface IHostUSBDevice : IUSBDevice
19171 {
19177     readonly attribute USBDeviceState state;
19178 
19179 }; /* interface IHostUSBDevice */
19180 
19203 interface IHostUSBDeviceFilter : IUSBDeviceFilter
19204 {
19211     attribute USBDeviceFilterAction action;
19212 
19213 }; /* interface IHostUSBDeviceFilter */
19214 
19223 interface IAudioAdapter : $unknown
19224 {
19233     attribute boolean enabled;
19234 
19240     attribute AudioControllerType audioController;
19241 
19248     attribute AudioDriverType audioDriver;
19249 
19250 }; /* interface IAudioAdapter */
19251 
19252 interface IVRDEServer : $unknown
19253 {
19257     attribute boolean enabled;
19258 
19262     attribute AuthType authType;
19263 
19267     attribute unsigned long authTimeout;
19268 
19275     attribute boolean allowMultiConnection;
19276 
19284     attribute boolean reuseSingleConnection;
19285 
19292     attribute wstring VRDEExtPack;
19293 
19300     attribute wstring authLibrary;
19301 
19307     readonly attribute wstring[] VRDEProperties;
19308 
19322     void setVRDEProperty (
19323         in wstring key,
19324         in wstring value
19325     );
19326 
19340     void getVRDEProperty (
19341         in wstring key,
19342         [retval] out wstring value
19343     );
19344 
19345 }; /* interface IVRDEServer */
19346 
19404 interface ISharedFolder : $unknown
19405 {
19409     readonly attribute wstring name;
19410 
19414     readonly attribute wstring hostPath;
19415 
19425     readonly attribute boolean accessible;
19426 
19433     readonly attribute boolean writable;
19434 
19440     readonly attribute boolean autoMount;
19441 
19454     readonly attribute wstring lastAccessError;
19455 
19456 }; /* interface ISharedFolder */
19457 
19458 interface IInternalSessionControl : $unknown
19459 {
19464     void getPID (
19465         [retval] out unsigned long pid
19466     );
19467 
19489     void getRemoteConsole (
19490         [retval] out IConsole console
19491     );
19492 
19516     void assignMachine (
19517         in IMachine machine,
19518         in LockType lockType
19519     );
19520 
19535     void assignRemoteMachine (
19536         in IMachine machine,
19537         in IConsole console
19538     );
19539 
19563     void updateMachineState (
19564         in MachineState aMachineState
19565     );
19566 
19582     void uninitialize();
19583 
19606     void onNetworkAdapterChange (
19607         in INetworkAdapter networkAdapter,
19608         in boolean changeAdapter
19609     );
19610 
19633     void onSerialPortChange (
19634         in ISerialPort serialPort
19635     );
19636 
19659     void onParallelPortChange (
19660         in IParallelPort parallelPort
19661     );
19662 
19685     void onStorageControllerChange();
19686 
19713     void onMediumChange (
19714         in IMediumAttachment mediumAttachment,
19715         in boolean force
19716     );
19717 
19747     void onStorageDeviceChange (
19748         in IMediumAttachment mediumAttachment,
19749         in boolean remove,
19750         in boolean silent
19751     );
19752 
19760     void onClipboardModeChange (
19761         in ClipboardMode clipboardMode
19762     );
19763 
19771     void onDragAndDropModeChange (
19772         in DragAndDropMode dragAndDropMode
19773     );
19774 
19784     void onCPUChange (
19785         in unsigned long cpu,
19786         in boolean add
19787     );
19788 
19796     void onCPUExecutionCapChange (
19797         in unsigned long executionCap
19798     );
19799 
19824     void onVRDEServerChange (
19825         in boolean restart
19826     );
19827 
19850     void onUSBControllerChange();
19851 
19880     void onSharedFolderChange (
19881         in boolean global
19882     );
19883 
19909     void onUSBDeviceAttach (
19910         in IUSBDevice device,
19911         in IVirtualBoxErrorInfo error,
19912         in unsigned long maskedInterfaces
19913     );
19914 
19940     void onUSBDeviceDetach (
19941         in wstringUUID id,
19942         in IVirtualBoxErrorInfo error
19943     );
19944 
19962     void onShowWindow (
19963         in boolean check,
19964         out boolean canShow,
19965         out long long winId
19966     );
19967 
19975     void onBandwidthGroupChange (
19976         in IBandwidthGroup bandwidthGroup
19977     );
19978 
20002     void accessGuestProperty (
20003         in wstring name,
20004         in wstring value,
20005         in wstring flags,
20006         in boolean isSetter,
20007         out wstring retValue,
20008         out long long retTimestamp,
20009         out wstring retFlags
20010     );
20011 
20059     void enumerateGuestProperties (
20060         in wstring patterns,
20061         out wstring[] key,
20062         out wstring[] value,
20063         out long long[] timestamp,
20064         out wstring[] flags
20065     );
20066 
20112     void onlineMergeMedium (
20113         in IMediumAttachment mediumAttachment,
20114         in unsigned long sourceIdx,
20115         in unsigned long targetIdx,
20116         in IMedium source,
20117         in IMedium target,
20118         in boolean mergeForward,
20119         in IMedium parentForTarget,
20120         in IMedium[] childrenToReparent,
20121         in IProgress progress
20122     );
20123 
20147     void enableVMMStatistics (
20148         in boolean enable
20149     );
20150 
20178     void pauseWithReason (
20179         in Reason reason
20180     );
20181 
20209     void resumeWithReason (
20210         in Reason reason
20211     );
20212 
20242     void saveStateWithReason (
20243         in Reason reason,
20244         [retval] out IProgress progress
20245     );
20246 
20247 }; /* interface IInternalSessionControl */
20248 
20307 interface ISession : $unknown
20308 {
20312     readonly attribute SessionState state;
20313 
20321     readonly attribute SessionType type;
20322 
20326     readonly attribute IMachine machine;
20327 
20331     readonly attribute IConsole console;
20332 
20364     void unlockMachine();
20365 
20366 }; /* interface ISession */
20367 
20390 interface IStorageController : $unknown
20391 {
20400     readonly attribute wstring name;
20401 
20407     readonly attribute unsigned long maxDevicesPerPortCount;
20408 
20414     readonly attribute unsigned long minPortCount;
20415 
20421     readonly attribute unsigned long maxPortCount;
20422 
20428     attribute unsigned long instance;
20429 
20438     attribute unsigned long portCount;
20439 
20445     readonly attribute StorageBus bus;
20446 
20459     attribute StorageControllerType controllerType;
20460 
20475     attribute boolean useHostIOCache;
20476 
20482     readonly attribute boolean bootable;
20483 
20484 }; /* interface IStorageController */
20485 
20509 interface IManagedObjectRef : $unknown
20510 {
20517     void getInterfaceName (
20518         [retval] out wstring return
20519     );
20520 
20528     void release();
20529 
20530 }; /* interface IManagedObjectRef */
20531 
20540 interface IWebsessionManager : $unknown
20541 {
20550     void logon (
20551         in wstring username,
20552         in wstring password,
20553         [retval] out IVirtualBox return
20554     );
20555 
20565     void getSessionObject (
20566         in IVirtualBox refIVirtualBox,
20567         [retval] out ISession return
20568     );
20569 
20577     void logoff (
20578         in IVirtualBox refIVirtualBox
20579     );
20580 
20581 }; /* interface IWebsessionManager */
20582 
20591 interface IPerformanceMetric : $unknown
20592 {
20598     readonly attribute wstring metricName;
20599 
20605     readonly attribute $unknown object;
20606 
20612     readonly attribute wstring description;
20613 
20619     readonly attribute unsigned long period;
20620 
20630     readonly attribute unsigned long count;
20631 
20637     readonly attribute wstring unit;
20638 
20644     readonly attribute long minimumValue;
20645 
20651     readonly attribute long maximumValue;
20652 
20653 }; /* interface IPerformanceMetric */
20654 
20761 interface IPerformanceCollector : $unknown
20762 {
20773     readonly attribute wstring[] metricNames;
20774 
20798     void getMetrics (
20799         in wstring[] metricNames,
20800         in $unknown[] objects,
20801         [retval] out IPerformanceMetric[] metrics
20802     );
20803 
20842     void setupMetrics (
20843         in wstring[] metricNames,
20844         in $unknown[] objects,
20845         in unsigned long period,
20846         in unsigned long count,
20847         [retval] out IPerformanceMetric[] affectedMetrics
20848     );
20849 
20878     void enableMetrics (
20879         in wstring[] metricNames,
20880         in $unknown[] objects,
20881         [retval] out IPerformanceMetric[] affectedMetrics
20882     );
20883 
20912     void disableMetrics (
20913         in wstring[] metricNames,
20914         in $unknown[] objects,
20915         [retval] out IPerformanceMetric[] affectedMetrics
20916     );
20917 
21006     void queryMetricsData (
21007         in wstring[] metricNames,
21008         in $unknown[] objects,
21009         out wstring[] returnMetricNames,
21010         out $unknown[] returnObjects,
21011         out wstring[] returnUnits,
21012         out unsigned long[] returnScales,
21013         out unsigned long[] returnSequenceNumbers,
21014         out unsigned long[] returnDataIndices,
21015         out unsigned long[] returnDataLengths,
21016         [retval] out long[] returnData
21017     );
21018 
21019 }; /* interface IPerformanceCollector */
21020 
21028 interface INATEngine : $unknown
21029 {
21034     attribute wstring network;
21035 
21042     attribute wstring hostIP;
21043 
21048     attribute wstring TFTPPrefix;
21049 
21054     attribute wstring TFTPBootFile;
21055 
21063     attribute wstring TFTPNextServer;
21064 
21068     attribute unsigned long aliasMode;
21069 
21073     attribute boolean DNSPassDomain;
21074 
21079     attribute boolean DNSProxy;
21080 
21085     attribute boolean DNSUseHostResolver;
21086 
21091     readonly attribute wstring[] redirects;
21092 
21108     void setNetworkSettings (
21109         in unsigned long mtu,
21110         in unsigned long sockSnd,
21111         in unsigned long sockRcv,
21112         in unsigned long TcpWndSnd,
21113         in unsigned long TcpWndRcv
21114     );
21115 
21120     void getNetworkSettings (
21121         out unsigned long mtu,
21122         out unsigned long sockSnd,
21123         out unsigned long sockRcv,
21124         out unsigned long TcpWndSnd,
21125         out unsigned long TcpWndRcv
21126     );
21127 
21147     void addRedirect (
21148         in wstring name,
21149         in NATProtocol proto,
21150         in wstring hostIP,
21151         in unsigned short hostPort,
21152         in wstring guestIP,
21153         in unsigned short guestPort
21154     );
21155 
21161     void removeRedirect (
21162         in wstring name
21163     );
21164 
21165 }; /* interface INATEngine */
21166 
21175 interface IExtPackPlugIn : $unknown
21176 {
21180     readonly attribute wstring name;
21181 
21185     readonly attribute wstring description;
21186 
21192     readonly attribute wstring frontend;
21193 
21197     readonly attribute wstring modulePath;
21198 
21199 }; /* interface IExtPackPlugIn */
21200 
21209 interface IExtPackBase : $unknown
21210 {
21214     readonly attribute wstring name;
21215 
21219     readonly attribute wstring description;
21220 
21232     readonly attribute wstring version;
21233 
21237     readonly attribute unsigned long revision;
21238 
21248     readonly attribute wstring edition;
21249 
21253     readonly attribute wstring VRDEModule;
21254 
21258     readonly attribute IExtPackPlugIn[] plugIns;
21259 
21269     readonly attribute boolean usable;
21270 
21277     readonly attribute wstring whyUnusable;
21278 
21282     readonly attribute boolean showLicense;
21283 
21292     readonly attribute wstring license;
21293 
21317     void queryLicense (
21318         in wstring preferredLocale,
21319         in wstring preferredLanguage,
21320         in wstring format,
21321         [retval] out wstring licenseText
21322     );
21323 
21324 }; /* interface IExtPackBase */
21325 
21334 interface IExtPack : IExtPackBase
21335 {
21347     void queryObject (
21348         in wstring objUuid,
21349         [retval] out $unknown returnInterface
21350     );
21351 
21352 }; /* interface IExtPack */
21353 
21363 interface IExtPackFile : IExtPackBase
21364 {
21370     readonly attribute wstring filePath;
21371 
21390     void install (
21391         in boolean replace,
21392         in wstring displayInfo,
21393         [retval] out IProgress progess
21394     );
21395 
21396 }; /* interface IExtPackFile */
21397 
21408 interface IExtPackManager : $unknown
21409 {
21415     readonly attribute IExtPack[] installedExtPacks;
21416 
21434     void find (
21435         in wstring name,
21436         [retval] out IExtPack returnData
21437     );
21438 
21450     void openExtPackFile (
21451         in wstring path,
21452         [retval] out IExtPackFile file
21453     );
21454 
21473     void uninstall (
21474         in wstring name,
21475         in boolean forcedRemoval,
21476         in wstring displayInfo,
21477         [retval] out IProgress progess
21478     );
21479 
21483     void cleanup();
21484 
21497     void queryAllPlugInsForFrontend (
21498         in wstring frontendName,
21499         [retval] out wstring[] plugInModules
21500     );
21501 
21509     void isExtPackUsable (
21510         in wstring name,
21511         [retval] out boolean usable
21512     );
21513 
21514 }; /* interface IExtPackManager */
21515 
21521 interface IBandwidthGroup : $unknown
21522 {
21526     readonly attribute wstring name;
21527 
21531     readonly attribute BandwidthGroupType type;
21532 
21536     readonly attribute unsigned long reference;
21537 
21542     attribute long long maxBytesPerSec;
21543 
21544 }; /* interface IBandwidthGroup */
21545 
21554 interface IBandwidthControl : $unknown
21555 {
21561     readonly attribute unsigned long numGroups;
21562 
21575     void createBandwidthGroup (
21576         in wstring name,
21577         in BandwidthGroupType type,
21578         in long long maxBytesPerSec
21579     );
21580 
21588     void deleteBandwidthGroup (
21589         in wstring name
21590     );
21591 
21601     void getBandwidthGroup (
21602         in wstring name,
21603         [retval] out IBandwidthGroup bandwidthGroup
21604     );
21605 
21613     void getAllBandwidthGroups (
21614         [retval] out IBandwidthGroup[] bandwidthGroups
21615     );
21616 
21617 }; /* interface IBandwidthControl */
21618 
21631 interface IVirtualBoxClient : $unknown
21632 {
21638     readonly attribute IVirtualBox virtualBox;
21639 
21645     readonly attribute ISession session;
21646 
21652     readonly attribute IEventSource eventSource;
21653 
21654 }; /* interface IVirtualBoxClient */
21655 
21669 interface IEventSource : $unknown
21670 {
21676     void createListener (
21677         [retval] out IEventListener listener
21678     );
21679 
21695     void createAggregator (
21696         in IEventSource[] subordinates,
21697         [retval] out IEventSource result
21698     );
21699 
21732     void registerListener (
21733         in IEventListener listener,
21734         in VBoxEventType[] interesting,
21735         in boolean active
21736     );
21737 
21746     void unregisterListener (
21747         in IEventListener listener
21748     );
21749 
21764     void fireEvent (
21765         in IEvent event,
21766         in long timeout,
21767         [retval] out boolean result
21768     );
21769 
21794     void getEvent (
21795         in IEventListener listener,
21796         in long timeout,
21797         [retval] out IEvent event
21798     );
21799 
21811     void eventProcessed (
21812         in IEventListener listener,
21813         in IEvent event
21814     );
21815 
21816 }; /* interface IEventSource */
21817 
21827 interface IEventListener : $unknown
21828 {
21841     void handleEvent (
21842         in IEvent event
21843     );
21844 
21845 }; /* interface IEventListener */
21846 
21923 interface IEvent : $unknown
21924 {
21930     readonly attribute VBoxEventType type;
21931 
21937     readonly attribute IEventSource source;
21938 
21949     readonly attribute boolean waitable;
21950 
21957     void setProcessed();
21958 
21972     void waitProcessed (
21973         in long timeout,
21974         [retval] out boolean result
21975     );
21976 
21977 }; /* interface IEvent */
21978 
21984 interface IReusableEvent : IEvent
21985 {
21989     readonly attribute unsigned long generation;
21990 
21997     void reuse();
21998 
21999 }; /* interface IReusableEvent */
22000 
22006 interface IMachineEvent : IEvent
22007 {
22011     readonly attribute wstringUUID machineId;
22012 
22013 }; /* interface IMachineEvent */
22014 
22020 interface IMachineStateChangedEvent : IMachineEvent
22021 {
22025     readonly attribute MachineState state;
22026 
22027 }; /* interface IMachineStateChangedEvent */
22028 
22036 interface IMachineDataChangedEvent : IMachineEvent
22037 {
22044     readonly attribute boolean temporary;
22045 
22046 }; /* interface IMachineDataChangedEvent */
22047 
22056 interface IMediumRegisteredEvent : IEvent
22057 {
22061     readonly attribute wstringUUID mediumId;
22062 
22066     readonly attribute DeviceType mediumType;
22067 
22074     readonly attribute boolean registered;
22075 
22076 }; /* interface IMediumRegisteredEvent */
22077 
22086 interface IMachineRegisteredEvent : IMachineEvent
22087 {
22094     readonly attribute boolean registered;
22095 
22096 }; /* interface IMachineRegisteredEvent */
22097 
22107 interface ISessionStateChangedEvent : IMachineEvent
22108 {
22114     readonly attribute SessionState state;
22115 
22116 }; /* interface ISessionStateChangedEvent */
22117 
22125 interface IGuestPropertyChangedEvent : IMachineEvent
22126 {
22132     readonly attribute wstring name;
22133 
22139     readonly attribute wstring value;
22140 
22146     readonly attribute wstring flags;
22147 
22148 }; /* interface IGuestPropertyChangedEvent */
22149 
22155 interface ISnapshotEvent : IMachineEvent
22156 {
22160     readonly attribute wstringUUID snapshotId;
22161 
22162 }; /* interface ISnapshotEvent */
22163 
22173 interface ISnapshotTakenEvent : ISnapshotEvent
22174 {
22175 }; /* interface ISnapshotTakenEvent */
22176 
22193 interface ISnapshotDeletedEvent : ISnapshotEvent
22194 {
22195 }; /* interface ISnapshotDeletedEvent */
22196 
22206 interface ISnapshotChangedEvent : ISnapshotEvent
22207 {
22208 }; /* interface ISnapshotChangedEvent */
22209 
22218 interface IMousePointerShapeChangedEvent : IEvent
22219 {
22225     readonly attribute boolean visible;
22226 
22232     readonly attribute boolean alpha;
22233 
22239     readonly attribute unsigned long xhot;
22240 
22246     readonly attribute unsigned long yhot;
22247 
22253     readonly attribute unsigned long width;
22254 
22260     readonly attribute unsigned long height;
22261 
22294     readonly attribute octet[] shape;
22295 
22296 }; /* interface IMousePointerShapeChangedEvent */
22297 
22306 interface IMouseCapabilityChangedEvent : IEvent
22307 {
22313     readonly attribute boolean supportsAbsolute;
22314 
22320     readonly attribute boolean supportsRelative;
22321 
22327     readonly attribute boolean needsHostCursor;
22328 
22329 }; /* interface IMouseCapabilityChangedEvent */
22330 
22339 interface IKeyboardLedsChangedEvent : IEvent
22340 {
22346     readonly attribute boolean numLock;
22347 
22353     readonly attribute boolean capsLock;
22354 
22360     readonly attribute boolean scrollLock;
22361 
22362 }; /* interface IKeyboardLedsChangedEvent */
22363 
22372 interface IStateChangedEvent : IEvent
22373 {
22379     readonly attribute MachineState state;
22380 
22381 }; /* interface IStateChangedEvent */
22382 
22392 interface IAdditionsStateChangedEvent : IEvent
22393 {
22394 }; /* interface IAdditionsStateChangedEvent */
22395 
22406 interface INetworkAdapterChangedEvent : IEvent
22407 {
22413     readonly attribute INetworkAdapter networkAdapter;
22414 
22415 }; /* interface INetworkAdapterChangedEvent */
22416 
22427 interface ISerialPortChangedEvent : IEvent
22428 {
22434     readonly attribute ISerialPort serialPort;
22435 
22436 }; /* interface ISerialPortChangedEvent */
22437 
22448 interface IParallelPortChangedEvent : IEvent
22449 {
22455     readonly attribute IParallelPort parallelPort;
22456 
22457 }; /* interface IParallelPortChangedEvent */
22458 
22468 interface IStorageControllerChangedEvent : IEvent
22469 {
22470 }; /* interface IStorageControllerChangedEvent */
22471 
22481 interface IMediumChangedEvent : IEvent
22482 {
22488     readonly attribute IMediumAttachment mediumAttachment;
22489 
22490 }; /* interface IMediumChangedEvent */
22491 
22499 interface IClipboardModeChangedEvent : IEvent
22500 {
22506     readonly attribute ClipboardMode clipboardMode;
22507 
22508 }; /* interface IClipboardModeChangedEvent */
22509 
22517 interface IDragAndDropModeChangedEvent : IEvent
22518 {
22524     readonly attribute DragAndDropMode dragAndDropMode;
22525 
22526 }; /* interface IDragAndDropModeChangedEvent */
22527 
22535 interface ICPUChangedEvent : IEvent
22536 {
22542     readonly attribute unsigned long CPU;
22543 
22549     readonly attribute boolean add;
22550 
22551 }; /* interface ICPUChangedEvent */
22552 
22560 interface ICPUExecutionCapChangedEvent : IEvent
22561 {
22567     readonly attribute unsigned long executionCap;
22568 
22569 }; /* interface ICPUExecutionCapChangedEvent */
22570 
22578 interface IGuestKeyboardEvent : IEvent
22579 {
22585     readonly attribute long[] scancodes;
22586 
22587 }; /* interface IGuestKeyboardEvent */
22588 
22596 interface IGuestMouseEvent : IReusableEvent
22597 {
22603     readonly attribute boolean absolute;
22604 
22610     readonly attribute long x;
22611 
22617     readonly attribute long y;
22618 
22624     readonly attribute long z;
22625 
22631     readonly attribute long w;
22632 
22638     readonly attribute long buttons;
22639 
22640 }; /* interface IGuestMouseEvent */
22641 
22652 interface IVRDEServerChangedEvent : IEvent
22653 {
22654 }; /* interface IVRDEServerChangedEvent */
22655 
22665 interface IVRDEServerInfoChangedEvent : IEvent
22666 {
22667 }; /* interface IVRDEServerInfoChangedEvent */
22668 
22679 interface IUSBControllerChangedEvent : IEvent
22680 {
22681 }; /* interface IUSBControllerChangedEvent */
22682 
22706 interface IUSBDeviceStateChangedEvent : IEvent
22707 {
22713     readonly attribute IUSBDevice device;
22714 
22720     readonly attribute boolean attached;
22721 
22727     readonly attribute IVirtualBoxErrorInfo error;
22728 
22729 }; /* interface IUSBDeviceStateChangedEvent */
22730 
22746 interface ISharedFolderChangedEvent : IEvent
22747 {
22753     readonly attribute Scope scope;
22754 
22755 }; /* interface ISharedFolderChangedEvent */
22756 
22808 interface IRuntimeErrorEvent : IEvent
22809 {
22815     readonly attribute boolean fatal;
22816 
22822     readonly attribute wstring id;
22823 
22829     readonly attribute wstring message;
22830 
22831 }; /* interface IRuntimeErrorEvent */
22832 
22840 interface IEventSourceChangedEvent : IEvent
22841 {
22847     readonly attribute IEventListener listener;
22848 
22854     readonly attribute boolean add;
22855 
22856 }; /* interface IEventSourceChangedEvent */
22857 
22866 interface IExtraDataChangedEvent : IEvent
22867 {
22874     readonly attribute wstringUUID machineId;
22875 
22881     readonly attribute wstring key;
22882 
22888     readonly attribute wstring value;
22889 
22890 }; /* interface IExtraDataChangedEvent */
22891 
22897 interface IVetoEvent : IEvent
22898 {
22908     void addVeto (
22909         in wstring reason
22910     );
22911 
22921     void isVetoed (
22922         [retval] out boolean result
22923     );
22924 
22934     void getVetos (
22935         [retval] out wstring[] result
22936     );
22937 
22938 }; /* interface IVetoEvent */
22939 
22949 interface IExtraDataCanChangeEvent : IVetoEvent
22950 {
22957     readonly attribute wstringUUID machineId;
22958 
22964     readonly attribute wstring key;
22965 
22971     readonly attribute wstring value;
22972 
22973 }; /* interface IExtraDataCanChangeEvent */
22974 
22990 interface ICanShowWindowEvent : IVetoEvent
22991 {
22992 }; /* interface ICanShowWindowEvent */
22993 
23025 interface IShowWindowEvent : IEvent
23026 {
23035     attribute long long winId;
23036 
23037 }; /* interface IShowWindowEvent */
23038 
23046 interface INATRedirectEvent : IMachineEvent
23047 {
23053     readonly attribute unsigned long slot;
23054 
23060     readonly attribute boolean remove;
23061 
23067     readonly attribute wstring name;
23068 
23074     readonly attribute NATProtocol proto;
23075 
23081     readonly attribute wstring hostIP;
23082 
23088     readonly attribute long hostPort;
23089 
23095     readonly attribute wstring guestIP;
23096 
23102     readonly attribute long guestPort;
23103 
23104 }; /* interface INATRedirectEvent */
23105 
23118 interface IHostPCIDevicePlugEvent : IMachineEvent
23119 {
23125     readonly attribute boolean plugged;
23126 
23133     readonly attribute boolean success;
23134 
23140     readonly attribute IPCIDeviceAttachment attachment;
23141 
23147     readonly attribute wstring message;
23148 
23149 }; /* interface IHostPCIDevicePlugEvent */
23150 
23159 interface IVBoxSVCAvailabilityChangedEvent : IEvent
23160 {
23166     readonly attribute boolean available;
23167 
23168 }; /* interface IVBoxSVCAvailabilityChangedEvent */
23169 
23177 interface IBandwidthGroupChangedEvent : IEvent
23178 {
23184     readonly attribute IBandwidthGroup bandwidthGroup;
23185 
23186 }; /* interface IBandwidthGroupChangedEvent */
23187 
23195 interface IGuestMonitorChangedEvent : IEvent
23196 {
23202     readonly attribute GuestMonitorChangedEventType changeType;
23203 
23209     readonly attribute unsigned long screenId;
23210 
23217     readonly attribute unsigned long originX;
23218 
23225     readonly attribute unsigned long originY;
23226 
23233     readonly attribute unsigned long width;
23234 
23241     readonly attribute unsigned long height;
23242 
23243 }; /* interface IGuestMonitorChangedEvent */
23244 
23254 interface IStorageDeviceChangedEvent : IEvent
23255 {
23261     readonly attribute IMediumAttachment storageDevice;
23262 
23268     readonly attribute boolean removed;
23269 
23270 }; /* interface IStorageDeviceChangedEvent */
23271 
23272 

Generated on Thu Oct 15 2015 11:11:45 for VirtualBox Main API by  doxygen 1.7.1