• 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 
02986 enum StorageBus
02987 {
02992     StorageBus_Null = 0,
02993     StorageBus_IDE = 1,
02994     StorageBus_SATA = 2,
02995     StorageBus_SCSI = 3,
02996     StorageBus_Floppy = 4,
02997     StorageBus_SAS = 5,
02998 };
02999 
03008 enum StorageControllerType
03009 {
03014     StorageControllerType_Null = 0,
03019     StorageControllerType_LsiLogic = 1,
03024     StorageControllerType_BusLogic = 2,
03029     StorageControllerType_IntelAhci = 3,
03034     StorageControllerType_PIIX3 = 4,
03039     StorageControllerType_PIIX4 = 5,
03044     StorageControllerType_ICH6 = 6,
03049     StorageControllerType_I82078 = 7,
03054     StorageControllerType_LsiLogicSas = 8,
03055 };
03056 
03064 enum ChipsetType
03065 {
03070     ChipsetType_Null = 0,
03075     ChipsetType_PIIX3 = 1,
03080     ChipsetType_ICH9 = 2,
03081 };
03082 
03088 enum NATAliasMode
03089 {
03094     NATAliasMode_AliasLog = 0x1,
03099     NATAliasMode_AliasProxyOnly = 0x02,
03104     NATAliasMode_AliasUseSamePorts = 0x04,
03105 };
03106 
03112 enum NATProtocol
03113 {
03118     NATProtocol_UDP = 0,
03123     NATProtocol_TCP = 1,
03124 };
03125 
03133 enum BandwidthGroupType
03134 {
03141     BandwidthGroupType_Null = 0,
03148     BandwidthGroupType_Disk = 1,
03155     BandwidthGroupType_Network = 2,
03156 };
03157 
03166 enum VBoxEventType
03167 {
03174     VBoxEventType_Invalid = 0,
03183     VBoxEventType_Any = 1,
03191     VBoxEventType_Vetoable = 2,
03199     VBoxEventType_MachineEvent = 3,
03207     VBoxEventType_SnapshotEvent = 4,
03216     VBoxEventType_InputEvent = 5,
03223     VBoxEventType_LastWildcard = 31,
03230     VBoxEventType_OnMachineStateChanged = 32,
03237     VBoxEventType_OnMachineDataChanged = 33,
03244     VBoxEventType_OnExtraDataChanged = 34,
03251     VBoxEventType_OnExtraDataCanChange = 35,
03258     VBoxEventType_OnMediumRegistered = 36,
03265     VBoxEventType_OnMachineRegistered = 37,
03272     VBoxEventType_OnSessionStateChanged = 38,
03279     VBoxEventType_OnSnapshotTaken = 39,
03286     VBoxEventType_OnSnapshotDeleted = 40,
03293     VBoxEventType_OnSnapshotChanged = 41,
03300     VBoxEventType_OnGuestPropertyChanged = 42,
03307     VBoxEventType_OnMousePointerShapeChanged = 43,
03314     VBoxEventType_OnMouseCapabilityChanged = 44,
03321     VBoxEventType_OnKeyboardLedsChanged = 45,
03328     VBoxEventType_OnStateChanged = 46,
03335     VBoxEventType_OnAdditionsStateChanged = 47,
03342     VBoxEventType_OnNetworkAdapterChanged = 48,
03349     VBoxEventType_OnSerialPortChanged = 49,
03356     VBoxEventType_OnParallelPortChanged = 50,
03363     VBoxEventType_OnStorageControllerChanged = 51,
03370     VBoxEventType_OnMediumChanged = 52,
03377     VBoxEventType_OnVRDEServerChanged = 53,
03384     VBoxEventType_OnUSBControllerChanged = 54,
03391     VBoxEventType_OnUSBDeviceStateChanged = 55,
03398     VBoxEventType_OnSharedFolderChanged = 56,
03405     VBoxEventType_OnRuntimeError = 57,
03412     VBoxEventType_OnCanShowWindow = 58,
03419     VBoxEventType_OnShowWindow = 59,
03426     VBoxEventType_OnCPUChanged = 60,
03433     VBoxEventType_OnVRDEServerInfoChanged = 61,
03440     VBoxEventType_OnEventSourceChanged = 62,
03447     VBoxEventType_OnCPUExecutionCapChanged = 63,
03454     VBoxEventType_OnGuestKeyboard = 64,
03461     VBoxEventType_OnGuestMouse = 65,
03468     VBoxEventType_OnNATRedirect = 66,
03475     VBoxEventType_OnHostPCIDevicePlug = 67,
03482     VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
03489     VBoxEventType_OnBandwidthGroupChanged = 69,
03496     VBoxEventType_OnGuestMonitorChanged = 70,
03503     VBoxEventType_OnStorageDeviceChanged = 71,
03510     VBoxEventType_OnClipboardModeChanged = 72,
03517     VBoxEventType_OnDragAndDropModeChanged = 73,
03524     VBoxEventType_Last = 74,
03525 };
03526 
03534 enum GuestMonitorChangedEventType
03535 {
03542     GuestMonitorChangedEventType_Enabled = 0,
03549     GuestMonitorChangedEventType_Disabled = 1,
03556     GuestMonitorChangedEventType_NewOrigin = 2,
03557 };
03558 
03592 interface IVirtualBoxErrorInfo : $errorinfo
03593 {
03611     readonly attribute long resultCode;
03612 
03624     readonly attribute wstringUUID interfaceID;
03625 
03636     readonly attribute wstring component;
03637 
03648     readonly attribute wstring text;
03649 
03660     readonly attribute IVirtualBoxErrorInfo next;
03661 
03662 }; /* interface IVirtualBoxErrorInfo */
03663 
03674 interface IDHCPServer : $unknown
03675 {
03681     attribute boolean enabled;
03682 
03688     readonly attribute wstring IPAddress;
03689 
03695     readonly attribute wstring networkMask;
03696 
03702     readonly attribute wstring networkName;
03703 
03709     readonly attribute wstring lowerIP;
03710 
03716     readonly attribute wstring upperIP;
03717 
03746     void setConfiguration (
03747         in wstring IPAddress,
03748         in wstring networkMask,
03749         in wstring FromIPAddress,
03750         in wstring ToIPAddress
03751     );
03752 
03777     void start (
03778         in wstring networkName,
03779         in wstring trunkName,
03780         in wstring trunkType
03781     );
03782 
03795     void stop();
03796 
03797 }; /* interface IDHCPServer */
03798 
03817 interface IVirtualBox : $unknown
03818 {
03831     readonly attribute wstring version;
03832 
03840     readonly attribute wstring versionNormalized;
03841 
03847     readonly attribute unsigned long revision;
03848 
03858     readonly attribute wstring packageType;
03859 
03871     readonly attribute wstring APIVersion;
03872 
03888     readonly attribute wstring homeFolder;
03889 
03897     readonly attribute wstring settingsFilePath;
03898 
03902     readonly attribute IHost host;
03903 
03907     readonly attribute ISystemProperties systemProperties;
03908 
03914     readonly attribute IMachine[] machines;
03915 
03925     readonly attribute wstring[] machineGroups;
03926 
03936     readonly attribute IMedium[] hardDisks;
03937 
03943     readonly attribute IMedium[] DVDImages;
03944 
03950     readonly attribute IMedium[] floppyImages;
03951 
03952     readonly attribute IProgress[] progressOperations;
03953 
03954     readonly attribute IGuestOSType[] guestOSTypes;
03955 
03972     readonly attribute ISharedFolder[] sharedFolders;
03973 
03979     readonly attribute IPerformanceCollector performanceCollector;
03980 
03986     readonly attribute IDHCPServer[] DHCPServers;
03987 
03993     readonly attribute IEventSource eventSource;
03994 
04000     readonly attribute IExtPackManager extensionPackManager;
04001 
04007     readonly attribute wstring[] internalNetworks;
04008 
04014     readonly attribute wstring[] genericNetworkDrivers;
04015 
04066     void composeMachineFilename (
04067         in wstring name,
04068         in wstring group,
04069         in wstring createFlags,
04070         in wstring baseFolder,
04071         [retval] out wstring file
04072     );
04073 
04175     void createMachine (
04176         in wstring settingsFile,
04177         in wstring name,
04178         in wstring[] groups,
04179         in wstring osTypeId,
04180         in wstring flags,
04181         [retval] out IMachine machine
04182     );
04183 
04209     void openMachine (
04210         in wstring settingsFile,
04211         [retval] out IMachine machine
04212     );
04213 
04245     void registerMachine (
04246         in IMachine machine
04247     );
04248 
04269     void findMachine (
04270         in wstring nameOrId,
04271         [retval] out IMachine machine
04272     );
04273 
04285     void getMachinesByGroups (
04286         in wstring[] groups,
04287         [retval] out IMachine[] machines
04288     );
04289 
04299     void getMachineStates (
04300         in IMachine[] machines,
04301         [retval] out MachineState[] states
04302     );
04303 
04313     void createAppliance (
04314         [retval] out IAppliance appliance
04315     );
04316 
04379     void createHardDisk (
04380         in wstring format,
04381         in wstring location,
04382         [retval] out IMedium medium
04383     );
04384 
04490     void openMedium (
04491         in wstring location,
04492         in DeviceType deviceType,
04493         in AccessMode accessMode,
04494         in boolean forceNewUuid,
04495         [retval] out IMedium medium
04496     );
04497 
04526     void getGuestOSType (
04527         in wstringUUID id,
04528         [retval] out IGuestOSType type
04529     );
04530 
04553     void createSharedFolder (
04554         in wstring name,
04555         in wstring hostPath,
04556         in boolean writable,
04557         in boolean automount
04558     );
04559 
04574     void removeSharedFolder (
04575         in wstring name
04576     );
04577 
04586     void getExtraDataKeys (
04587         [retval] out wstring[] value
04588     );
04589 
04618     void getExtraData (
04619         in wstring key,
04620         [retval] out wstring value
04621     );
04622 
04672     void setExtraData (
04673         in wstring key,
04674         in wstring value
04675     );
04676 
04695     void setSettingsSecret (
04696         in wstring password
04697     );
04698 
04715     void createDHCPServer (
04716         in wstring name,
04717         [retval] out IDHCPServer server
04718     );
04719 
04736     void findDHCPServerByNetworkName (
04737         in wstring name,
04738         [retval] out IDHCPServer server
04739     );
04740 
04755     void removeDHCPServer (
04756         in IDHCPServer server
04757     );
04758 
04783     void checkFirmwarePresent (
04784         in FirmwareType firmwareType,
04785         in wstring version,
04786         out wstring url,
04787         out wstring file,
04788         [retval] out boolean result
04789     );
04790 
04791 }; /* interface IVirtualBox */
04792 
04803 interface IVFSExplorer : $unknown
04804 {
04808     readonly attribute wstring path;
04809 
04813     readonly attribute VFSType type;
04814 
04822     void update (
04823         [retval] out IProgress aProgress
04824     );
04825 
04833     void cd (
04834         in wstring aDir,
04835         [retval] out IProgress aProgress
04836     );
04837 
04843     void cdUp (
04844         [retval] out IProgress aProgress
04845     );
04846 
04859     void entryList (
04860         out wstring[] aNames,
04861         out unsigned long[] aTypes,
04862         out unsigned long[] aSizes,
04863         out unsigned long[] aModes
04864     );
04865 
04874     void exists (
04875         in wstring[] aNames,
04876         [retval] out wstring[] aExists
04877     );
04878 
04886     void remove (
04887         in wstring[] aNames,
04888         [retval] out IProgress aProgress
04889     );
04890 
04891 }; /* interface IVFSExplorer */
04892 
04958 interface IAppliance : $unknown
04959 {
04967     readonly attribute wstring path;
04968 
04999     readonly attribute wstring[] disks;
05000 
05008     readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
05009 
05017     readonly attribute wstring[] machines;
05018 
05035     void read (
05036         in wstring file,
05037         [retval] out IProgress aProgress
05038     );
05039 
05056     void interpret();
05057 
05080     void importMachines (
05081         in ImportOptions[] options,
05082         [retval] out IProgress aProgress
05083     );
05084 
05092     void createVFSExplorer (
05093         in wstring aUri,
05094         [retval] out IVFSExplorer aExplorer
05095     );
05096 
05126     void write (
05127         in wstring format,
05128         in boolean manifest,
05129         in wstring path,
05130         [retval] out IProgress progress
05131     );
05132 
05138     void getWarnings (
05139         [retval] out wstring[] aWarnings
05140     );
05141 
05142 }; /* interface IAppliance */
05143 
05155 interface IVirtualSystemDescription : $unknown
05156 {
05160     readonly attribute unsigned long count;
05161 
05285     void getDescription (
05286         out VirtualSystemDescriptionType[] aTypes,
05287         out wstring[] aRefs,
05288         out wstring[] aOvfValues,
05289         out wstring[] aVBoxValues,
05290         out wstring[] aExtraConfigValues
05291     );
05292 
05309     void getDescriptionByType (
05310         in VirtualSystemDescriptionType aType,
05311         out VirtualSystemDescriptionType[] aTypes,
05312         out wstring[] aRefs,
05313         out wstring[] aOvfValues,
05314         out wstring[] aVBoxValues,
05315         out wstring[] aExtraConfigValues
05316     );
05317 
05329     void getValuesByType (
05330         in VirtualSystemDescriptionType aType,
05331         in VirtualSystemDescriptionValueType aWhich,
05332         [retval] out wstring[] aValues
05333     );
05334 
05360     void setFinalValues (
05361         in boolean[] aEnabled,
05362         in wstring[] aVBoxValues,
05363         in wstring[] aExtraConfigValues
05364     );
05365 
05380     void addDescription (
05381         in VirtualSystemDescriptionType aType,
05382         in wstring aVBoxValue,
05383         in wstring aExtraConfigValue
05384     );
05385 
05386 }; /* interface IVirtualSystemDescription */
05387 
05388 interface IInternalMachineControl : $unknown
05389 {
05396     void setRemoveSavedStateFile (
05397         in boolean aRemove
05398     );
05399 
05411     void updateState (
05412         in MachineState state
05413     );
05414 
05415     void getIPCId (
05416         [retval] out wstring id
05417     );
05418 
05430     void beginPowerUp (
05431         in IProgress aProgress
05432     );
05433 
05443     void endPowerUp (
05444         in long result
05445     );
05446 
05458     void beginPoweringDown (
05459         out IProgress progress
05460     );
05461 
05491     void endPoweringDown (
05492         in long result,
05493         in wstring errMsg
05494     );
05495 
05509     void runUSBDeviceFilters (
05510         in IUSBDevice device,
05511         out boolean matched,
05512         out unsigned long maskedInterfaces
05513     );
05514 
05523     void captureUSBDevice (
05524         in wstringUUID id
05525     );
05526 
05542     void detachUSBDevice (
05543         in wstringUUID id,
05544         in boolean done
05545     );
05546 
05555     void autoCaptureUSBDevices();
05556 
05572     void detachAllUSBDevices (
05573         in boolean done
05574     );
05575 
05590     void onSessionEnd (
05591         in ISession session,
05592         [retval] out IProgress progress
05593     );
05594 
05610     void beginSavingState (
05611         out IProgress progress,
05612         out wstring stateFilePath
05613     );
05614 
05644     void endSavingState (
05645         in long result,
05646         in wstring errMsg
05647     );
05648 
05663     void adoptSavedState (
05664         in wstring savedStateFile
05665     );
05666 
05715     void beginTakingSnapshot (
05716         in IConsole initiator,
05717         in wstring name,
05718         in wstring description,
05719         in IProgress consoleProgress,
05720         in boolean fTakingSnapshotOnline,
05721         out wstring stateFilePath
05722     );
05723 
05733     void endTakingSnapshot (
05734         in boolean success
05735     );
05736 
05765     void deleteSnapshot (
05766         in IConsole initiator,
05767         in wstringUUID startId,
05768         in wstringUUID endId,
05769         in boolean deleteAllChildren,
05770         out MachineState machineState,
05771         [retval] out IProgress progress
05772     );
05773 
05792     void finishOnlineMergeMedium (
05793         in IMediumAttachment mediumAttachment,
05794         in IMedium source,
05795         in IMedium target,
05796         in boolean mergeForward,
05797         in IMedium parentForTarget,
05798         in IMedium[] childrenToReparent
05799     );
05800 
05814     void restoreSnapshot (
05815         in IConsole initiator,
05816         in ISnapshot snapshot,
05817         out MachineState machineState,
05818         [retval] out IProgress progress
05819     );
05820 
05847     void pullGuestProperties (
05848         out wstring[] name,
05849         out wstring[] value,
05850         out long long[] timestamp,
05851         out wstring[] flags
05852     );
05853 
05875     void pushGuestProperty (
05876         in wstring name,
05877         in wstring value,
05878         in long long timestamp,
05879         in wstring flags
05880     );
05881 
05893     void lockMedia();
05894 
05904     void unlockMedia();
05905 
05921     void ejectMedium (
05922         in IMediumAttachment attachment,
05923         [retval] out IMediumAttachment newAttachment
05924     );
05925 
05966     void reportVmStatistics (
05967         in unsigned long validStats,
05968         in unsigned long cpuUser,
05969         in unsigned long cpuKernel,
05970         in unsigned long cpuIdle,
05971         in unsigned long memTotal,
05972         in unsigned long memFree,
05973         in unsigned long memBalloon,
05974         in unsigned long memShared,
05975         in unsigned long memCache,
05976         in unsigned long pagedTotal,
05977         in unsigned long memAllocTotal,
05978         in unsigned long memFreeTotal,
05979         in unsigned long memBalloonTotal,
05980         in unsigned long memSharedTotal,
05981         in unsigned long vmNetRx,
05982         in unsigned long vmNetTx
05983     );
05984 
05985 }; /* interface IInternalMachineControl */
05986 
05995 interface IBIOSSettings : $unknown
05996 {
06000     attribute boolean logoFadeIn;
06001 
06005     attribute boolean logoFadeOut;
06006 
06010     attribute unsigned long logoDisplayTime;
06011 
06018     attribute wstring logoImagePath;
06019 
06023     attribute BIOSBootMenuMode bootMenuMode;
06024 
06028     attribute boolean ACPIEnabled;
06029 
06036     attribute boolean IOAPICEnabled;
06037 
06047     attribute long long timeOffset;
06048 
06055     attribute boolean PXEDebugEnabled;
06056 
06057 }; /* interface IBIOSSettings */
06058 
06066 interface IPCIAddress : $unknown
06067 {
06073     attribute short bus;
06074 
06080     attribute short device;
06081 
06087     attribute short devFunction;
06088 
06094     void asLong (
06095         [retval] out long result
06096     );
06097 
06103     void fromLong (
06104         in long number
06105     );
06106 
06107 }; /* interface IPCIAddress */
06108 
06116 interface IPCIDeviceAttachment : $unknown
06117 {
06123     readonly attribute wstring name;
06124 
06130     readonly attribute boolean isPhysicalDevice;
06131 
06137     readonly attribute long hostAddress;
06138 
06144     readonly attribute long guestAddress;
06145 
06146 }; /* interface IPCIDeviceAttachment */
06147 
06188 interface IMachine : $unknown
06189 {
06193     readonly attribute IVirtualBox parent;
06194 
06244     readonly attribute boolean accessible;
06245 
06257     readonly attribute IVirtualBoxErrorInfo accessError;
06258 
06298     attribute wstring name;
06299 
06310     attribute wstring description;
06311 
06315     readonly attribute wstringUUID id;
06316 
06327     attribute wstring[] groups;
06328 
06343     attribute wstring OSTypeId;
06344 
06348     attribute wstring hardwareVersion;
06349 
06359     attribute wstringUUID hardwareUUID;
06360 
06364     attribute unsigned long CPUCount;
06365 
06371     attribute boolean CPUHotPlugEnabled;
06372 
06380     attribute unsigned long CPUExecutionCap;
06381 
06385     attribute unsigned long memorySize;
06386 
06390     attribute unsigned long memoryBalloonSize;
06391 
06398     attribute boolean pageFusionEnabled;
06399 
06403     attribute unsigned long VRAMSize;
06404 
06410     attribute boolean accelerate3DEnabled;
06411 
06417     attribute boolean accelerate2DVideoEnabled;
06418 
06429     attribute unsigned long monitorCount;
06430 
06436     attribute boolean VideoCaptureEnabled;
06437 
06443     attribute wstring VideoCaptureFile;
06444 
06450     attribute unsigned long VideoCaptureWidth;
06451 
06457     attribute unsigned long VideoCaptureHeight;
06458 
06462     readonly attribute IBIOSSettings BIOSSettings;
06463 
06468     attribute FirmwareType firmwareType;
06469 
06475     attribute PointingHIDType pointingHIDType;
06476 
06482     attribute KeyboardHIDType keyboardHIDType;
06483 
06490     attribute boolean HPETEnabled;
06491 
06495     attribute ChipsetType chipsetType;
06496 
06530     attribute wstring snapshotFolder;
06531 
06535     readonly attribute IVRDEServer VRDEServer;
06536 
06537     attribute boolean emulatedUSBWebcameraEnabled;
06538 
06539     attribute boolean emulatedUSBCardReaderEnabled;
06540 
06544     readonly attribute IMediumAttachment[] mediumAttachments;
06545 
06557     readonly attribute IUSBController USBController;
06558 
06562     readonly attribute IAudioAdapter audioAdapter;
06563 
06567     readonly attribute IStorageController[] storageControllers;
06568 
06574     readonly attribute wstring settingsFilePath;
06575 
06600     readonly attribute boolean settingsModified;
06601 
06605     readonly attribute SessionState sessionState;
06606 
06619     readonly attribute wstring sessionType;
06620 
06630     readonly attribute unsigned long sessionPID;
06631 
06635     readonly attribute MachineState state;
06636 
06643     readonly attribute long long lastStateChange;
06644 
06656     readonly attribute wstring stateFilePath;
06657 
06667     readonly attribute wstring logFolder;
06668 
06679     readonly attribute ISnapshot currentSnapshot;
06680 
06687     readonly attribute unsigned long snapshotCount;
06688 
06720     readonly attribute boolean currentStateModified;
06721 
06733     readonly attribute ISharedFolder[] sharedFolders;
06734 
06741     attribute ClipboardMode clipboardMode;
06742 
06748     attribute DragAndDropMode dragAndDropMode;
06749 
06757     attribute wstring guestPropertyNotificationPatterns;
06758 
06767     attribute boolean teleporterEnabled;
06768 
06779     attribute unsigned long teleporterPort;
06780 
06787     attribute wstring teleporterAddress;
06788 
06799     attribute wstring teleporterPassword;
06800 
06808     attribute FaultToleranceState faultToleranceState;
06809 
06816     attribute unsigned long faultTolerancePort;
06817 
06823     attribute wstring faultToleranceAddress;
06824 
06832     attribute wstring faultTolerancePassword;
06833 
06839     attribute unsigned long faultToleranceSyncInterval;
06840 
06848     attribute boolean RTCUseUTC;
06849 
06856     attribute boolean IOCacheEnabled;
06857 
06863     attribute unsigned long IOCacheSize;
06864 
06874     readonly attribute IPCIDeviceAttachment[] PCIDeviceAssignments;
06875 
06881     readonly attribute IBandwidthControl bandwidthControl;
06882 
06891     attribute boolean tracingEnabled;
06892 
06907     attribute wstring tracingConfig;
06908 
06921     attribute boolean allowTracingToAccessVM;
06922 
06928     attribute boolean autostartEnabled;
06929 
06935     attribute unsigned long autostartDelay;
06936 
06942     attribute AutostopType autostopType;
06943 
07049     void lockMachine (
07050         in ISession session,
07051         in LockType lockType
07052     );
07053 
07183     void launchVMProcess (
07184         in ISession session,
07185         in wstring type,
07186         in wstring environment,
07187         [retval] out IProgress progress
07188     );
07189 
07227     void setBootOrder (
07228         in unsigned long position,
07229         in DeviceType device
07230     );
07231 
07266     void getBootOrder (
07267         in unsigned long position,
07268         [retval] out DeviceType device
07269     );
07270 
07372     void attachDevice (
07373         in wstring name,
07374         in long controllerPort,
07375         in long device,
07376         in DeviceType type,
07377         in IMedium medium
07378     );
07379 
07475     void attachDeviceWithoutMedium (
07476         in wstring name,
07477         in long controllerPort,
07478         in long device,
07479         in DeviceType type
07480     );
07481 
07535     void detachDevice (
07536         in wstring name,
07537         in long controllerPort,
07538         in long device
07539     );
07540 
07583     void passthroughDevice (
07584         in wstring name,
07585         in long controllerPort,
07586         in long device,
07587         in boolean passthrough
07588     );
07589 
07632     void temporaryEjectDevice (
07633         in wstring name,
07634         in long controllerPort,
07635         in long device,
07636         in boolean temporaryEject
07637     );
07638 
07684     void nonRotationalDevice (
07685         in wstring name,
07686         in long controllerPort,
07687         in long device,
07688         in boolean nonRotational
07689     );
07690 
07736     void setAutoDiscardForDevice (
07737         in wstring name,
07738         in long controllerPort,
07739         in long device,
07740         in boolean discard
07741     );
07742 
07783     void setBandwidthGroupForDevice (
07784         in wstring name,
07785         in long controllerPort,
07786         in long device,
07787         in IBandwidthGroup bandwidthGroup
07788     );
07789 
07826     void setNoBandwidthGroupForDevice (
07827         in wstring name,
07828         in long controllerPort,
07829         in long device
07830     );
07831 
07896     void unmountMedium (
07897         in wstring name,
07898         in long controllerPort,
07899         in long device,
07900         in boolean force
07901     );
07902 
07965     void mountMedium (
07966         in wstring name,
07967         in long controllerPort,
07968         in long device,
07969         in IMedium medium,
07970         in boolean force
07971     );
07972 
08001     void getMedium (
08002         in wstring name,
08003         in long controllerPort,
08004         in long device,
08005         [retval] out IMedium medium
08006     );
08007 
08022     void getMediumAttachmentsOfController (
08023         in wstring name,
08024         [retval] out IMediumAttachment[] mediumAttachments
08025     );
08026 
08041     void getMediumAttachment (
08042         in wstring name,
08043         in long controllerPort,
08044         in long device,
08045         [retval] out IMediumAttachment attachment
08046     );
08047 
08088     void attachHostPCIDevice (
08089         in long hostAddress,
08090         in long desiredGuestAddress,
08091         in boolean tryToUnbind
08092     );
08093 
08134     void detachHostPCIDevice (
08135         in long hostAddress
08136     );
08137 
08155     void getNetworkAdapter (
08156         in unsigned long slot,
08157         [retval] out INetworkAdapter adapter
08158     );
08159 
08192     void addStorageController (
08193         in wstring name,
08194         in StorageBus connectionType,
08195         [retval] out IStorageController controller
08196     );
08197 
08211     void getStorageControllerByName (
08212         in wstring name,
08213         [retval] out IStorageController storageController
08214     );
08215 
08229     void getStorageControllerByInstance (
08230         in unsigned long instance,
08231         [retval] out IStorageController storageController
08232     );
08233 
08256     void removeStorageController (
08257         in wstring name
08258     );
08259 
08281     void setStorageControllerBootable (
08282         in wstring name,
08283         in boolean bootable
08284     );
08285 
08303     void getSerialPort (
08304         in unsigned long slot,
08305         [retval] out ISerialPort port
08306     );
08307 
08325     void getParallelPort (
08326         in unsigned long slot,
08327         [retval] out IParallelPort port
08328     );
08329 
08338     void getExtraDataKeys (
08339         [retval] out wstring[] value
08340     );
08341 
08370     void getExtraData (
08371         in wstring key,
08372         [retval] out wstring value
08373     );
08374 
08424     void setExtraData (
08425         in wstring key,
08426         in wstring value
08427     );
08428 
08450     void getCPUProperty (
08451         in CPUPropertyType property,
08452         [retval] out boolean value
08453     );
08454 
08476     void setCPUProperty (
08477         in CPUPropertyType property,
08478         in boolean value
08479     );
08480 
08520     void getCPUIDLeaf (
08521         in unsigned long id,
08522         out unsigned long valEax,
08523         out unsigned long valEbx,
08524         out unsigned long valEcx,
08525         out unsigned long valEdx
08526     );
08527 
08571     void setCPUIDLeaf (
08572         in unsigned long id,
08573         in unsigned long valEax,
08574         in unsigned long valEbx,
08575         in unsigned long valEcx,
08576         in unsigned long valEdx
08577     );
08578 
08596     void removeCPUIDLeaf (
08597         in unsigned long id
08598     );
08599 
08605     void removeAllCPUIDLeaves();
08606 
08628     void getHWVirtExProperty (
08629         in HWVirtExPropertyType property,
08630         [retval] out boolean value
08631     );
08632 
08654     void setHWVirtExProperty (
08655         in HWVirtExPropertyType property,
08656         in boolean value
08657     );
08658 
08704     void saveSettings();
08705 
08729     void discardSettings();
08730 
08814     void unregister (
08815         in CleanupMode cleanupMode,
08816         [retval] out IMedium[] aMedia
08817     );
08818 
08875     void delete (
08876         in IMedium[] aMedia,
08877         [retval] out IProgress aProgress
08878     );
08879 
08891     void export (
08892         in IAppliance aAppliance,
08893         in wstring location,
08894         [retval] out IVirtualSystemDescription aDescription
08895     );
08896 
08920     void findSnapshot (
08921         in wstring nameOrId,
08922         [retval] out ISnapshot snapshot
08923     );
08924 
08958     void createSharedFolder (
08959         in wstring name,
08960         in wstring hostPath,
08961         in boolean writable,
08962         in boolean automount
08963     );
08964 
08990     void removeSharedFolder (
08991         in wstring name
08992     );
08993 
09017     void canShowConsoleWindow (
09018         [retval] out boolean canShow
09019     );
09020 
09055     void showConsoleWindow (
09056         [retval] out long long winId
09057     );
09058 
09091     void getGuestProperty (
09092         in wstring name,
09093         out wstring value,
09094         out long long timestamp,
09095         out wstring flags
09096     );
09097 
09120     void getGuestPropertyValue (
09121         in wstring property,
09122         [retval] out wstring value
09123     );
09124 
09147     void getGuestPropertyTimestamp (
09148         in wstring property,
09149         [retval] out long long value
09150     );
09151 
09202     void setGuestProperty (
09203         in wstring property,
09204         in wstring value,
09205         in wstring flags
09206     );
09207 
09248     void setGuestPropertyValue (
09249         in wstring property,
09250         in wstring value
09251     );
09252 
09270     void deleteGuestProperty (
09271         in wstring name
09272     );
09273 
09304     void enumerateGuestProperties (
09305         in wstring patterns,
09306         out wstring[] name,
09307         out wstring[] value,
09308         out long long[] timestamp,
09309         out wstring[] flags
09310     );
09311 
09341     void querySavedGuestScreenInfo (
09342         in unsigned long screenId,
09343         out unsigned long originX,
09344         out unsigned long originY,
09345         out unsigned long width,
09346         out unsigned long height,
09347         out boolean enabled
09348     );
09349 
09371     void querySavedThumbnailSize (
09372         in unsigned long screenId,
09373         out unsigned long size,
09374         out unsigned long width,
09375         out unsigned long height
09376     );
09377 
09404     void readSavedThumbnailToArray (
09405         in unsigned long screenId,
09406         in boolean BGR,
09407         out unsigned long width,
09408         out unsigned long height,
09409         [retval] out octet[] data
09410     );
09411 
09433     void readSavedThumbnailPNGToArray (
09434         in unsigned long screenId,
09435         out unsigned long width,
09436         out unsigned long height,
09437         [retval] out octet[] data
09438     );
09439 
09461     void querySavedScreenshotPNGSize (
09462         in unsigned long screenId,
09463         out unsigned long size,
09464         out unsigned long width,
09465         out unsigned long height
09466     );
09467 
09489     void readSavedScreenshotPNGToArray (
09490         in unsigned long screenId,
09491         out unsigned long width,
09492         out unsigned long height,
09493         [retval] out octet[] data
09494     );
09495 
09505     void hotPlugCPU (
09506         in unsigned long cpu
09507     );
09508 
09518     void hotUnplugCPU (
09519         in unsigned long cpu
09520     );
09521 
09535     void getCPUStatus (
09536         in unsigned long cpu,
09537         [retval] out boolean attached
09538     );
09539 
09554     void queryLogFilename (
09555         in unsigned long idx,
09556         [retval] out wstring filename
09557     );
09558 
09584     void readLog (
09585         in unsigned long idx,
09586         in long long offset,
09587         in long long size,
09588         [retval] out octet[] data
09589     );
09590 
09623     void cloneTo (
09624         in IMachine target,
09625         in CloneMode mode,
09626         in CloneOptions[] options,
09627         [retval] out IProgress progress
09628     );
09629 
09630 }; /* interface IMachine */
09631 
09640 interface IVRDEServerInfo : $unknown
09641 {
09647     readonly attribute boolean active;
09648 
09657     readonly attribute long port;
09658 
09664     readonly attribute unsigned long numberOfClients;
09665 
09671     readonly attribute long long beginTime;
09672 
09679     readonly attribute long long endTime;
09680 
09686     readonly attribute long long bytesSent;
09687 
09693     readonly attribute long long bytesSentTotal;
09694 
09700     readonly attribute long long bytesReceived;
09701 
09707     readonly attribute long long bytesReceivedTotal;
09708 
09714     readonly attribute wstring user;
09715 
09721     readonly attribute wstring domain;
09722 
09728     readonly attribute wstring clientName;
09729 
09735     readonly attribute wstring clientIP;
09736 
09742     readonly attribute unsigned long clientVersion;
09743 
09751     readonly attribute unsigned long encryptionStyle;
09752 
09753 }; /* interface IVRDEServerInfo */
09754 
09776 interface IConsole : $unknown
09777 {
09789     readonly attribute IMachine machine;
09790 
09804     readonly attribute MachineState state;
09805 
09809     readonly attribute IGuest guest;
09810 
09821     readonly attribute IKeyboard keyboard;
09822 
09833     readonly attribute IMouse mouse;
09834 
09844     readonly attribute IDisplay display;
09845 
09849     readonly attribute IMachineDebugger debugger;
09850 
09861     readonly attribute IUSBDevice[] USBDevices;
09862 
09870     readonly attribute IHostUSBDevice[] remoteUSBDevices;
09871 
09887     readonly attribute ISharedFolder[] sharedFolders;
09888 
09894     readonly attribute IVRDEServerInfo VRDEServerInfo;
09895 
09901     readonly attribute IEventSource eventSource;
09902 
09906     readonly attribute IPCIDeviceAttachment[] attachedPCIDevices;
09907 
09916     attribute boolean useHostClipboard;
09917 
09982     void powerUp (
09983         [retval] out IProgress progress
09984     );
09985 
10019     void powerUpPaused (
10020         [retval] out IProgress progress
10021     );
10022 
10042     void powerDown (
10043         [retval] out IProgress progress
10044     );
10045 
10065     void reset();
10066 
10086     void pause();
10087 
10107     void resume();
10108 
10128     void powerButton();
10129 
10149     void sleepButton();
10150 
10162     void getPowerButtonHandled (
10163         [retval] out boolean handled
10164     );
10165 
10179     void getGuestEnteredACPIMode (
10180         [retval] out boolean entered
10181     );
10182 
10235     void saveState (
10236         [retval] out IProgress progress
10237     );
10238 
10271     void adoptSavedState (
10272         in wstring savedStateFile
10273     );
10274 
10305     void discardSavedState (
10306         in boolean fRemoveFile
10307     );
10308 
10321     void getDeviceActivity (
10322         in DeviceType type,
10323         [retval] out DeviceActivity activity
10324     );
10325 
10363     void attachUSBDevice (
10364         in wstringUUID id
10365     );
10366 
10401     void detachUSBDevice (
10402         in wstringUUID id,
10403         [retval] out IUSBDevice device
10404     );
10405 
10428     void findUSBDeviceByAddress (
10429         in wstring name,
10430         [retval] out IUSBDevice device
10431     );
10432 
10452     void findUSBDeviceById (
10453         in wstringUUID id,
10454         [retval] out IUSBDevice device
10455     );
10456 
10490     void createSharedFolder (
10491         in wstring name,
10492         in wstring hostPath,
10493         in boolean writable,
10494         in boolean automount
10495     );
10496 
10521     void removeSharedFolder (
10522         in wstring name
10523     );
10524 
10562     void takeSnapshot (
10563         in wstring name,
10564         in wstring description,
10565         [retval] out IProgress progress
10566     );
10567 
10640     void deleteSnapshot (
10641         in wstringUUID id,
10642         [retval] out IProgress progress
10643     );
10644 
10684     void deleteSnapshotAndAllChildren (
10685         in wstringUUID id,
10686         [retval] out IProgress progress
10687     );
10688 
10732     void deleteSnapshotRange (
10733         in wstringUUID startId,
10734         in wstringUUID endId,
10735         [retval] out IProgress progress
10736     );
10737 
10778     void restoreSnapshot (
10779         in ISnapshot snapshot,
10780         [retval] out IProgress progress
10781     );
10782 
10821     void teleport (
10822         in wstring hostname,
10823         in unsigned long tcpport,
10824         in wstring password,
10825         in unsigned long maxDowntime,
10826         [retval] out IProgress progress
10827     );
10828 
10829 }; /* interface IConsole */
10830 
10841 interface IHostNetworkInterface : $unknown
10842 {
10846     readonly attribute wstring name;
10847 
10851     readonly attribute wstringUUID id;
10852 
10856     readonly attribute wstring networkName;
10857 
10861     readonly attribute boolean DHCPEnabled;
10862 
10866     readonly attribute wstring IPAddress;
10867 
10871     readonly attribute wstring networkMask;
10872 
10876     readonly attribute boolean IPV6Supported;
10877 
10881     readonly attribute wstring IPV6Address;
10882 
10886     readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
10887 
10891     readonly attribute wstring hardwareAddress;
10892 
10896     readonly attribute HostNetworkInterfaceMediumType mediumType;
10897 
10901     readonly attribute HostNetworkInterfaceStatus status;
10902 
10906     readonly attribute HostNetworkInterfaceType interfaceType;
10907 
10919     void enableStaticIPConfig (
10920         in wstring IPAddress,
10921         in wstring networkMask
10922     );
10923 
10935     void enableStaticIPConfigV6 (
10936         in wstring IPV6Address,
10937         in unsigned long IPV6NetworkMaskPrefixLength
10938     );
10939 
10943     void enableDynamicIPConfig();
10944 
10948     void DHCPRediscover();
10949 
10950 }; /* interface IHostNetworkInterface */
10951 
10968 interface IHost : $unknown
10969 {
10973     readonly attribute IMedium[] DVDDrives;
10974 
10978     readonly attribute IMedium[] floppyDrives;
10979 
10993     readonly attribute IHostUSBDevice[] USBDevices;
10994 
11018     readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
11019 
11023     readonly attribute IHostNetworkInterface[] networkInterfaces;
11024 
11028     readonly attribute unsigned long processorCount;
11029 
11033     readonly attribute unsigned long processorOnlineCount;
11034 
11038     readonly attribute unsigned long processorCoreCount;
11039 
11043     readonly attribute unsigned long memorySize;
11044 
11048     readonly attribute unsigned long memoryAvailable;
11049 
11053     readonly attribute wstring operatingSystem;
11054 
11058     readonly attribute wstring OSVersion;
11059 
11063     readonly attribute long long UTCTime;
11064 
11068     readonly attribute boolean acceleration3DAvailable;
11069 
11084     void getProcessorSpeed (
11085         in unsigned long cpuId,
11086         [retval] out unsigned long speed
11087     );
11088 
11100     void getProcessorFeature (
11101         in ProcessorFeature feature,
11102         [retval] out boolean supported
11103     );
11104 
11123     void getProcessorDescription (
11124         in unsigned long cpuId,
11125         [retval] out wstring description
11126     );
11127 
11168     void getProcessorCPUIDLeaf (
11169         in unsigned long cpuId,
11170         in unsigned long leaf,
11171         in unsigned long subLeaf,
11172         out unsigned long valEax,
11173         out unsigned long valEbx,
11174         out unsigned long valEcx,
11175         out unsigned long valEdx
11176     );
11177 
11198     void createHostOnlyNetworkInterface (
11199         out IHostNetworkInterface hostInterface,
11200         [retval] out IProgress progress
11201     );
11202 
11223     void removeHostOnlyNetworkInterface (
11224         in wstringUUID id,
11225         [retval] out IProgress progress
11226     );
11227 
11247     void createUSBDeviceFilter (
11248         in wstring name,
11249         [retval] out IHostUSBDeviceFilter filter
11250     );
11251 
11294     void insertUSBDeviceFilter (
11295         in unsigned long position,
11296         in IHostUSBDeviceFilter filter
11297     );
11298 
11326     void removeUSBDeviceFilter (
11327         in unsigned long position
11328     );
11329 
11347     void findHostDVDDrive (
11348         in wstring name,
11349         [retval] out IMedium drive
11350     );
11351 
11369     void findHostFloppyDrive (
11370         in wstring name,
11371         [retval] out IMedium drive
11372     );
11373 
11389     void findHostNetworkInterfaceByName (
11390         in wstring name,
11391         [retval] out IHostNetworkInterface networkInterface
11392     );
11393 
11409     void findHostNetworkInterfaceById (
11410         in wstringUUID id,
11411         [retval] out IHostNetworkInterface networkInterface
11412     );
11413 
11423     void findHostNetworkInterfacesOfType (
11424         in HostNetworkInterfaceType type,
11425         [retval] out IHostNetworkInterface[] networkInterfaces
11426     );
11427 
11447     void findUSBDeviceById (
11448         in wstringUUID id,
11449         [retval] out IHostUSBDevice device
11450     );
11451 
11474     void findUSBDeviceByAddress (
11475         in wstring name,
11476         [retval] out IHostUSBDevice device
11477     );
11478 
11486     void generateMACAddress (
11487         [retval] out wstring address
11488     );
11489 
11490 }; /* interface IHost */
11491 
11504 interface ISystemProperties : $unknown
11505 {
11509     readonly attribute unsigned long minGuestRAM;
11510 
11514     readonly attribute unsigned long maxGuestRAM;
11515 
11519     readonly attribute unsigned long minGuestVRAM;
11520 
11524     readonly attribute unsigned long maxGuestVRAM;
11525 
11529     readonly attribute unsigned long minGuestCPUCount;
11530 
11534     readonly attribute unsigned long maxGuestCPUCount;
11535 
11539     readonly attribute unsigned long maxGuestMonitors;
11540 
11545     readonly attribute long long infoVDSize;
11546 
11553     readonly attribute unsigned long serialPortCount;
11554 
11561     readonly attribute unsigned long parallelPortCount;
11562 
11572     readonly attribute unsigned long maxBootPosition;
11573 
11597     attribute wstring defaultMachineFolder;
11598 
11623     readonly attribute IMediumFormat[] mediumFormats;
11624 
11658     attribute wstring defaultHardDiskFormat;
11659 
11665     attribute long long freeDiskSpaceWarning;
11666 
11671     attribute unsigned long freeDiskSpacePercentWarning;
11672 
11678     attribute long long freeDiskSpaceError;
11679 
11684     attribute unsigned long freeDiskSpacePercentError;
11685 
11709     attribute wstring VRDEAuthLibrary;
11710 
11739     attribute wstring webServiceAuthLibrary;
11740 
11754     attribute wstring defaultVRDEExtPack;
11755 
11761     attribute unsigned long logHistoryCount;
11762 
11767     readonly attribute AudioDriverType defaultAudioDriver;
11768 
11775     attribute wstring autostartDatabasePath;
11776 
11783     attribute wstring defaultAdditionsISO;
11784 
11795     void getMaxNetworkAdapters (
11796         in ChipsetType chipset,
11797         [retval] out unsigned long maxNetworkAdapters
11798     );
11799 
11813     void getMaxNetworkAdaptersOfType (
11814         in ChipsetType chipset,
11815         in NetworkAttachmentType type,
11816         [retval] out unsigned long maxNetworkAdapters
11817     );
11818 
11828     void getMaxDevicesPerPortForStorageBus (
11829         in StorageBus bus,
11830         [retval] out unsigned long maxDevicesPerPort
11831     );
11832 
11840     void getMinPortCountForStorageBus (
11841         in StorageBus bus,
11842         [retval] out unsigned long minPortCount
11843     );
11844 
11852     void getMaxPortCountForStorageBus (
11853         in StorageBus bus,
11854         [retval] out unsigned long maxPortCount
11855     );
11856 
11869     void getMaxInstancesOfStorageBus (
11870         in ChipsetType chipset,
11871         in StorageBus bus,
11872         [retval] out unsigned long maxInstances
11873     );
11874 
11884     void getDeviceTypesForStorageBus (
11885         in StorageBus bus,
11886         [retval] out DeviceType[] deviceTypes
11887     );
11888 
11897     void getDefaultIoCacheSettingForStorageController (
11898         in StorageControllerType controllerType,
11899         [retval] out boolean enabled
11900     );
11901 
11902 }; /* interface ISystemProperties */
11903 
11909 interface IGuestOSType : $unknown
11910 {
11914     readonly attribute wstring familyId;
11915 
11919     readonly attribute wstring familyDescription;
11920 
11924     readonly attribute wstring id;
11925 
11929     readonly attribute wstring description;
11930 
11934     readonly attribute boolean is64Bit;
11935 
11939     readonly attribute boolean recommendedIOAPIC;
11940 
11944     readonly attribute boolean recommendedVirtEx;
11945 
11949     readonly attribute unsigned long recommendedRAM;
11950 
11954     readonly attribute unsigned long recommendedVRAM;
11955 
11959     readonly attribute boolean recommended2DVideoAcceleration;
11960 
11964     readonly attribute boolean recommended3DAcceleration;
11965 
11969     readonly attribute long long recommendedHDD;
11970 
11974     readonly attribute NetworkAdapterType adapterType;
11975 
11979     readonly attribute boolean recommendedPAE;
11980 
11984     readonly attribute StorageControllerType recommendedDVDStorageController;
11985 
11989     readonly attribute StorageBus recommendedDVDStorageBus;
11990 
11994     readonly attribute StorageControllerType recommendedHDStorageController;
11995 
11999     readonly attribute StorageBus recommendedHDStorageBus;
12000 
12004     readonly attribute FirmwareType recommendedFirmware;
12005 
12009     readonly attribute boolean recommendedUSBHID;
12010 
12014     readonly attribute boolean recommendedHPET;
12015 
12019     readonly attribute boolean recommendedUSBTablet;
12020 
12024     readonly attribute boolean recommendedRTCUseUTC;
12025 
12029     readonly attribute ChipsetType recommendedChipset;
12030 
12034     readonly attribute AudioControllerType recommendedAudioController;
12035 
12039     readonly attribute boolean recommendedFloppy;
12040 
12044     readonly attribute boolean recommendedUSB;
12045 
12046 }; /* interface IGuestOSType */
12047 
12055 interface IAdditionsFacility : $unknown
12056 {
12060     readonly attribute AdditionsFacilityClass classType;
12061 
12068     readonly attribute long long lastUpdated;
12069 
12073     readonly attribute wstring name;
12074 
12078     readonly attribute AdditionsFacilityStatus status;
12079 
12083     readonly attribute AdditionsFacilityType type;
12084 
12085 }; /* interface IAdditionsFacility */
12086 
12112 interface IGuestSession : $unknown
12113 {
12119     readonly attribute wstring user;
12120 
12126     readonly attribute wstring domain;
12127 
12131     readonly attribute wstring name;
12132 
12136     readonly attribute unsigned long id;
12137 
12150     attribute unsigned long timeout;
12151 
12157     attribute wstring[] environment;
12158 
12164     readonly attribute IGuestProcess[] processes;
12165 
12171     readonly attribute IGuestDirectory[] directories;
12172 
12178     readonly attribute IGuestFile[] files;
12179 
12187     void close();
12188 
12210     void copyFrom (
12211         in wstring source,
12212         in wstring dest,
12213         in CopyFileFlag[] flags,
12214         [retval] out IProgress progress
12215     );
12216 
12238     void copyTo (
12239         in wstring source,
12240         in wstring dest,
12241         in CopyFileFlag[] flags,
12242         [retval] out IProgress progress
12243     );
12244 
12264     void directoryCreate (
12265         in wstring path,
12266         in unsigned long mode,
12267         in DirectoryCreateFlag[] flags
12268     );
12269 
12321     void directoryCreateTemp (
12322         in wstring templateName,
12323         in unsigned long mode,
12324         in wstring path,
12325         in boolean secure,
12326         [retval] out wstring directory
12327     );
12328 
12346     void directoryExists (
12347         in wstring path,
12348         [retval] out boolean exists
12349     );
12350 
12381     void directoryOpen (
12382         in wstring path,
12383         in wstring filter,
12384         in DirectoryOpenFlag[] flags,
12385         [retval] out IGuestDirectory directory
12386     );
12387 
12413     void directoryQueryInfo (
12414         in wstring path,
12415         [retval] out IGuestFsObjInfo info
12416     );
12417 
12433     void directoryRemove (
12434         in wstring path
12435     );
12436 
12456     void directoryRemoveRecursive (
12457         in wstring path,
12458         in DirectoryRemoveRecFlag[] flags,
12459         [retval] out IProgress progress
12460     );
12461 
12481     void directoryRename (
12482         in wstring source,
12483         in wstring dest,
12484         in PathRenameFlag[] flags
12485     );
12486 
12504     void directorySetACL (
12505         in wstring path,
12506         in wstring acl
12507     );
12508 
12522     void environmentClear();
12523 
12544     void environmentGet (
12545         in wstring name,
12546         [retval] out wstring value
12547     );
12548 
12566     void environmentSet (
12567         in wstring name,
12568         in wstring value
12569     );
12570 
12586     void environmentUnset (
12587         in wstring name
12588     );
12589 
12643     void fileCreateTemp (
12644         in wstring templateName,
12645         in unsigned long mode,
12646         in wstring path,
12647         in boolean secure,
12648         [retval] out IGuestFile file
12649     );
12650 
12668     void fileExists (
12669         in wstring path,
12670         [retval] out boolean exists
12671     );
12672 
12696     void fileRemove (
12697         in wstring path
12698     );
12699 
12734     void fileOpen (
12735         in wstring path,
12736         in wstring openMode,
12737         in wstring disposition,
12738         in unsigned long creationMode,
12739         in long long offset,
12740         [retval] out IGuestFile file
12741     );
12742 
12768     void fileQueryInfo (
12769         in wstring path,
12770         [retval] out IGuestFsObjInfo info
12771     );
12772 
12798     void fileQuerySize (
12799         in wstring path,
12800         [retval] out long long size
12801     );
12802 
12822     void fileRename (
12823         in wstring source,
12824         in wstring dest,
12825         in PathRenameFlag[] flags
12826     );
12827 
12845     void fileSetACL (
12846         in wstring file,
12847         in wstring acl
12848     );
12849 
12909     void processCreate (
12910         in wstring command,
12911         in wstring[] arguments,
12912         in wstring[] environment,
12913         in ProcessCreateFlag[] flags,
12914         in unsigned long timeoutMS,
12915         [retval] out IGuestProcess guestProcess
12916     );
12917 
12987     void processCreateEx (
12988         in wstring command,
12989         in wstring[] arguments,
12990         in wstring[] environment,
12991         in ProcessCreateFlag[] flags,
12992         in unsigned long timeoutMS,
12993         in ProcessPriority priority,
12994         in long[] affinity,
12995         [retval] out IGuestProcess guestProcess
12996     );
12997 
13007     void processGet (
13008         in unsigned long pid,
13009         [retval] out IGuestProcess guestProcess
13010     );
13011 
13034     void symlinkCreate (
13035         in wstring source,
13036         in wstring target,
13037         in SymlinkType type
13038     );
13039 
13057     void symlinkExists (
13058         in wstring symlink,
13059         [retval] out boolean exists
13060     );
13061 
13085     void symlinkRead (
13086         in wstring symlink,
13087         in SymlinkReadFlag[] flags,
13088         [retval] out wstring target
13089     );
13090 
13106     void symlinkRemoveDirectory (
13107         in wstring path
13108     );
13109 
13125     void symlinkRemoveFile (
13126         in wstring file
13127     );
13128 
13129 }; /* interface IGuestSession */
13130 
13138 interface IProcess : $unknown
13139 {
13145     readonly attribute unsigned long PID;
13146 
13153     readonly attribute ProcessStatus status;
13154 
13161     readonly attribute long exitCode;
13162 
13168     readonly attribute wstring[] environment;
13169 
13175     readonly attribute wstring[] arguments;
13176 
13180     readonly attribute wstring executablePath;
13181 
13185     readonly attribute wstring name;
13186 
13207     void waitFor (
13208         in unsigned long waitFor,
13209         in unsigned long timeoutMS,
13210         [retval] out ProcessWaitResult reason
13211     );
13212 
13234     void waitForArray (
13235         in ProcessWaitForFlag[] waitFor,
13236         in unsigned long timeoutMS,
13237         [retval] out ProcessWaitResult reason
13238     );
13239 
13256     void read (
13257         in unsigned long handle,
13258         in unsigned long toRead,
13259         in unsigned long timeoutMS,
13260         [retval] out octet[] data
13261     );
13262 
13286     void write (
13287         in unsigned long handle,
13288         in unsigned long flags,
13289         in octet[] data,
13290         in unsigned long timeoutMS,
13291         [retval] out unsigned long written
13292     );
13293 
13318     void writeArray (
13319         in unsigned long handle,
13320         in ProcessInputFlag[] flags,
13321         in octet[] data,
13322         in unsigned long timeoutMS,
13323         [retval] out unsigned long written
13324     );
13325 
13331     void terminate();
13332 
13333 }; /* interface IProcess */
13334 
13343 interface IGuestProcess : IProcess
13344 {
13345 }; /* interface IGuestProcess */
13346 
13354 interface IDirectory : $unknown
13355 {
13361     readonly attribute wstring directoryName;
13362 
13368     readonly attribute wstring filter;
13369 
13376     void close();
13377 
13392     void read (
13393         [retval] out IFsObjInfo objInfo
13394     );
13395 
13396 }; /* interface IDirectory */
13397 
13406 interface IGuestDirectory : IDirectory
13407 {
13408 }; /* interface IGuestDirectory */
13409 
13417 interface IFile : $unknown
13418 {
13424     readonly attribute unsigned long creationMode;
13425 
13431     readonly attribute unsigned long disposition;
13432 
13438     readonly attribute wstring fileName;
13439 
13445     readonly attribute long long initialSize;
13446 
13452     readonly attribute unsigned long openMode;
13453 
13459     readonly attribute long long offset;
13460 
13467     void close();
13468 
13484     void queryInfo (
13485         [retval] out IFsObjInfo objInfo
13486     );
13487 
13510     void read (
13511         in unsigned long toRead,
13512         in unsigned long timeoutMS,
13513         [retval] out octet[] data
13514     );
13515 
13540     void readAt (
13541         in long long offset,
13542         in unsigned long toRead,
13543         in unsigned long timeoutMS,
13544         [retval] out octet[] data
13545     );
13546 
13566     void seek (
13567         in long long offset,
13568         in FileSeekType whence
13569     );
13570 
13586     void setACL (
13587         in wstring acl
13588     );
13589 
13607     void write (
13608         in octet[] data,
13609         in unsigned long timeoutMS,
13610         [retval] out unsigned long written
13611     );
13612 
13640     void writeAt (
13641         in long long offset,
13642         in octet[] data,
13643         in unsigned long timeoutMS,
13644         [retval] out unsigned long written
13645     );
13646 
13647 }; /* interface IFile */
13648 
13657 interface IGuestFile : IFile
13658 {
13659 }; /* interface IGuestFile */
13660 
13669 interface IFsObjInfo : $unknown
13670 {
13676     readonly attribute long long accessTime;
13677 
13683     readonly attribute long long allocatedSize;
13684 
13690     readonly attribute long long birthTime;
13691 
13697     readonly attribute long long changeTime;
13698 
13704     readonly attribute unsigned long deviceNumber;
13705 
13711     readonly attribute wstring fileAttributes;
13712 
13718     readonly attribute unsigned long generationId;
13719 
13725     readonly attribute unsigned long GID;
13726 
13732     readonly attribute wstring groupName;
13733 
13739     readonly attribute unsigned long hardLinks;
13740 
13746     readonly attribute long long modificationTime;
13747 
13753     readonly attribute wstring name;
13754 
13760     readonly attribute long long nodeId;
13761 
13767     readonly attribute unsigned long nodeIdDevice;
13768 
13776     readonly attribute long long objectSize;
13777 
13783     readonly attribute FsObjType type;
13784 
13790     readonly attribute unsigned long UID;
13791 
13797     readonly attribute unsigned long userFlags;
13798 
13804     readonly attribute wstring userName;
13805 
13806 }; /* interface IFsObjInfo */
13807 
13816 interface IGuestFsObjInfo : IFsObjInfo
13817 {
13818 }; /* interface IGuestFsObjInfo */
13819 
13833 interface IGuest : $unknown
13834 {
13849     readonly attribute wstring OSTypeId;
13850 
13856     readonly attribute AdditionsRunLevelType additionsRunLevel;
13857 
13864     readonly attribute wstring additionsVersion;
13865 
13873     readonly attribute unsigned long additionsRevision;
13874 
13881     readonly attribute IAdditionsFacility[] facilities;
13882 
13886     readonly attribute IGuestSession[] sessions;
13887 
13891     attribute unsigned long memoryBalloonSize;
13892 
13896     attribute unsigned long statisticsUpdateInterval;
13897 
13929     void internalGetStatistics (
13930         out unsigned long cpuUser,
13931         out unsigned long cpuKernel,
13932         out unsigned long cpuIdle,
13933         out unsigned long memTotal,
13934         out unsigned long memFree,
13935         out unsigned long memBalloon,
13936         out unsigned long memShared,
13937         out unsigned long memCache,
13938         out unsigned long pagedTotal,
13939         out unsigned long memAllocTotal,
13940         out unsigned long memFreeTotal,
13941         out unsigned long memBalloonTotal,
13942         out unsigned long memSharedTotal
13943     );
13944 
13956     void getFacilityStatus (
13957         in AdditionsFacilityType facility,
13958         out long long timestamp,
13959         [retval] out AdditionsFacilityStatus status
13960     );
13961 
13979     void getAdditionsStatus (
13980         in AdditionsRunLevelType level,
13981         [retval] out boolean active
13982     );
13983 
14013     void setCredentials (
14014         in wstring userName,
14015         in wstring password,
14016         in wstring domain,
14017         in boolean allowInteractiveLogon
14018     );
14019 
14049     void dragHGEnter (
14050         in unsigned long screenId,
14051         in unsigned long y,
14052         in unsigned long x,
14053         in DragAndDropAction defaultAction,
14054         in DragAndDropAction[] allowedActions,
14055         in wstring[] formats,
14056         [retval] out DragAndDropAction resultAction
14057     );
14058 
14088     void dragHGMove (
14089         in unsigned long screenId,
14090         in unsigned long x,
14091         in unsigned long y,
14092         in DragAndDropAction defaultAction,
14093         in DragAndDropAction[] allowedActions,
14094         in wstring[] formats,
14095         [retval] out DragAndDropAction resultAction
14096     );
14097 
14115     void dragHGLeave (
14116         in unsigned long screenId
14117     );
14118 
14150     void dragHGDrop (
14151         in unsigned long screenId,
14152         in unsigned long x,
14153         in unsigned long y,
14154         in DragAndDropAction defaultAction,
14155         in DragAndDropAction[] allowedActions,
14156         in wstring[] formats,
14157         out wstring format,
14158         [retval] out DragAndDropAction resultAction
14159     );
14160 
14184     void dragHGPutData (
14185         in unsigned long screenId,
14186         in wstring format,
14187         in octet[] data,
14188         [retval] out IProgress progress
14189     );
14190 
14216     void dragGHPending (
14217         in unsigned long screenId,
14218         out wstring[] format,
14219         out DragAndDropAction[] allowedActions,
14220         [retval] out DragAndDropAction defaultAction
14221     );
14222 
14244     void dragGHDropped (
14245         in wstring format,
14246         in DragAndDropAction action,
14247         [retval] out IProgress progress
14248     );
14249 
14267     void dragGHGetData (
14268         [retval] out octet[] data
14269     );
14270 
14325     void createSession (
14326         in wstring user,
14327         in wstring password,
14328         in wstring domain,
14329         in wstring sessionName,
14330         [retval] out IGuestSession guestSession
14331     );
14332 
14347     void findSession (
14348         in wstring sessionName,
14349         [retval] out IGuestSession[] sessions
14350     );
14351 
14395     void updateGuestAdditions (
14396         in wstring source,
14397         in AdditionsUpdateFlag[] flags,
14398         [retval] out IProgress progress
14399     );
14400 
14401 }; /* interface IGuest */
14402 
14443 interface IProgress : $unknown
14444 {
14448     readonly attribute wstringUUID id;
14449 
14453     readonly attribute wstring description;
14454 
14458     readonly attribute $unknown initiator;
14459 
14463     readonly attribute boolean cancelable;
14464 
14472     readonly attribute unsigned long percent;
14473 
14487     readonly attribute long timeRemaining;
14488 
14492     readonly attribute boolean completed;
14493 
14497     readonly attribute boolean canceled;
14498 
14505     readonly attribute long resultCode;
14506 
14516     readonly attribute IVirtualBoxErrorInfo errorInfo;
14517 
14524     readonly attribute unsigned long operationCount;
14525 
14529     readonly attribute unsigned long operation;
14530 
14536     readonly attribute wstring operationDescription;
14537 
14541     readonly attribute unsigned long operationPercent;
14542 
14546     readonly attribute unsigned long operationWeight;
14547 
14555     attribute unsigned long timeout;
14556 
14560     void setCurrentOperationProgress (
14561         in unsigned long percent
14562     );
14563 
14567     void setNextOperation (
14568         in wstring nextOperationDescription,
14569         in unsigned long nextOperationsWeight
14570     );
14571 
14598     void waitForCompletion (
14599         in long timeout
14600     );
14601 
14625     void waitForOperationCompletion (
14626         in unsigned long operation,
14627         in long timeout
14628     );
14629 
14655     void waitForAsyncProgressCompletion (
14656         in IProgress pProgressAsync
14657     );
14658 
14675     void cancel();
14676 
14677 }; /* interface IProgress */
14678 
14762 interface ISnapshot : $unknown
14763 {
14767     readonly attribute wstringUUID id;
14768 
14776     attribute wstring name;
14777 
14785     attribute wstring description;
14786 
14792     readonly attribute long long timeStamp;
14793 
14805     readonly attribute boolean online;
14806 
14818     readonly attribute IMachine machine;
14819 
14826     readonly attribute ISnapshot parent;
14827 
14836     readonly attribute ISnapshot[] children;
14837 
14845     void getChildrenCount (
14846         [retval] out unsigned long childrenCount
14847     );
14848 
14849 }; /* interface ISnapshot */
14850 
15037 interface IMediumAttachment : $unknown
15038 {
15043     readonly attribute IMedium medium;
15044 
15050     readonly attribute wstring controller;
15051 
15057     readonly attribute long port;
15058 
15064     readonly attribute long device;
15065 
15069     readonly attribute DeviceType type;
15070 
15074     readonly attribute boolean passthrough;
15075 
15079     readonly attribute boolean temporaryEject;
15080 
15085     readonly attribute boolean isEjected;
15086 
15090     readonly attribute boolean nonRotational;
15091 
15095     readonly attribute boolean discard;
15096 
15100     readonly attribute IBandwidthGroup bandwidthGroup;
15101 
15102 }; /* interface IMediumAttachment */
15103 
15261 interface IMedium : $unknown
15262 {
15276     readonly attribute wstringUUID id;
15277 
15296     attribute wstring description;
15297 
15313     readonly attribute MediumState state;
15314 
15323     readonly attribute unsigned long variant;
15324 
15346     attribute wstring location;
15347 
15367     readonly attribute wstring name;
15368 
15373     readonly attribute DeviceType deviceType;
15374 
15378     readonly attribute boolean hostDrive;
15379 
15392     readonly attribute long long size;
15393 
15408     readonly attribute wstring format;
15409 
15425     readonly attribute IMediumFormat mediumFormat;
15426 
15451     attribute MediumType type;
15452 
15466     readonly attribute MediumType[] allowedTypes;
15467 
15477     readonly attribute IMedium parent;
15478 
15486     readonly attribute IMedium[] children;
15487 
15498     readonly attribute IMedium base;
15499 
15532     readonly attribute boolean readOnly;
15533 
15554     readonly attribute long long logicalSize;
15555 
15583     attribute boolean autoReset;
15584 
15599     readonly attribute wstring lastAccessError;
15600 
15617     readonly attribute wstringUUID[] machineIds;
15618 
15644     void setIds (
15645         in boolean setImageId,
15646         in wstringUUID imageId,
15647         in boolean setParentId,
15648         in wstringUUID parentId
15649     );
15650 
15685     void refreshState (
15686         [retval] out MediumState state
15687     );
15688 
15715     void getSnapshotIds (
15716         in wstringUUID machineId,
15717         [retval] out wstringUUID[] snapshotIds
15718     );
15719 
15779     void lockRead (
15780         [retval] out MediumState state
15781     );
15782 
15805     void unlockRead (
15806         [retval] out MediumState state
15807     );
15808 
15863     void lockWrite (
15864         [retval] out MediumState state
15865     );
15866 
15889     void unlockWrite (
15890         [retval] out MediumState state
15891     );
15892 
15942     void close();
15943 
15973     void getProperty (
15974         in wstring name,
15975         [retval] out wstring value
15976     );
15977 
16009     void setProperty (
16010         in wstring name,
16011         in wstring value
16012     );
16013 
16048     void getProperties (
16049         in wstring names,
16050         out wstring[] returnNames,
16051         [retval] out wstring[] returnValues
16052     );
16053 
16083     void setProperties (
16084         in wstring[] names,
16085         in wstring[] values
16086     );
16087 
16120     void createBaseStorage (
16121         in long long logicalSize,
16122         in unsigned long variant,
16123         [retval] out IProgress progress
16124     );
16125 
16177     void deleteStorage (
16178         [retval] out IProgress progress
16179     );
16180 
16219     void createDiffStorage (
16220         in IMedium target,
16221         in unsigned long variant,
16222         [retval] out IProgress progress
16223     );
16224 
16300     void mergeTo (
16301         in IMedium target,
16302         [retval] out IProgress progress
16303     );
16304 
16354     void cloneTo (
16355         in IMedium target,
16356         in unsigned long variant,
16357         in IMedium parent,
16358         [retval] out IProgress progress
16359     );
16360 
16408     void cloneToBase (
16409         in IMedium target,
16410         in unsigned long variant,
16411         [retval] out IProgress progress
16412     );
16413 
16442     void compact (
16443         [retval] out IProgress progress
16444     );
16445 
16478     void resize (
16479         in long long logicalSize,
16480         [retval] out IProgress progress
16481     );
16482 
16516     void reset (
16517         [retval] out IProgress progress
16518     );
16519 
16520 }; /* interface IMedium */
16521 
16544 interface IMediumFormat : $unknown
16545 {
16564     readonly attribute wstring id;
16565 
16573     readonly attribute wstring name;
16574 
16583     readonly attribute unsigned long capabilities;
16584 
16603     void describeFileExtensions (
16604         out wstring[] extensions,
16605         out DeviceType[] type
16606     );
16607 
16635     void describeProperties (
16636         out wstring[] names,
16637         out wstring[] description,
16638         out DataType[] types,
16639         out unsigned long[] flags,
16640         out wstring[] defaults
16641     );
16642 
16643 }; /* interface IMediumFormat */
16644 
16657 interface IKeyboard : $unknown
16658 {
16664     readonly attribute IEventSource eventSource;
16665 
16678     void putScancode (
16679         in long scancode
16680     );
16681 
16694     void putScancodes (
16695         in long[] scancodes,
16696         [retval] out unsigned long codesStored
16697     );
16698 
16713     void putCAD();
16714 
16715 }; /* interface IKeyboard */
16716 
16728 interface IMouse : $unknown
16729 {
16744     readonly attribute boolean absoluteSupported;
16745 
16760     readonly attribute boolean relativeSupported;
16761 
16776     readonly attribute boolean needsHostCursor;
16777 
16783     readonly attribute IEventSource eventSource;
16784 
16850     void putMouseEvent (
16851         in long dx,
16852         in long dy,
16853         in long dz,
16854         in long dw,
16855         in long buttonState
16856     );
16857 
16930     void putMouseEventAbsolute (
16931         in long x,
16932         in long y,
16933         in long dz,
16934         in long dw,
16935         in long buttonState
16936     );
16937 
16938 }; /* interface IMouse */
16939 
16940 interface IFramebuffer : $unknown
16941 {
16950     readonly attribute octetPtr address;
16951 
16955     readonly attribute unsigned long width;
16956 
16960     readonly attribute unsigned long height;
16961 
16968     readonly attribute unsigned long bitsPerPixel;
16969 
16976     readonly attribute unsigned long bytesPerLine;
16977 
16988     readonly attribute unsigned long pixelFormat;
16989 
16996     readonly attribute boolean usesGuestVRAM;
16997 
17007     readonly attribute unsigned long heightReduction;
17008 
17023     readonly attribute IFramebufferOverlay overlay;
17024 
17031     readonly attribute long long winId;
17032 
17040     void lock();
17041 
17049     void unlock();
17050 
17058     void notifyUpdate (
17059         in unsigned long x,
17060         in unsigned long y,
17061         in unsigned long width,
17062         in unsigned long height
17063     );
17064 
17177     void requestResize (
17178         in unsigned long screenId,
17179         in unsigned long pixelFormat,
17180         in octetPtr VRAM,
17181         in unsigned long bitsPerPixel,
17182         in unsigned long bytesPerLine,
17183         in unsigned long width,
17184         in unsigned long height,
17185         [retval] out boolean finished
17186     );
17187 
17199     void videoModeSupported (
17200         in unsigned long width,
17201         in unsigned long height,
17202         in unsigned long bpp,
17203         [retval] out boolean supported
17204     );
17205 
17242     void getVisibleRegion (
17243         in octetPtr rectangles,
17244         in unsigned long count,
17245         [retval] out unsigned long countCopied
17246     );
17247 
17282     void setVisibleRegion (
17283         in octetPtr rectangles,
17284         in unsigned long count
17285     );
17286 
17307     void processVHWACommand (
17308         in octetPtr command
17309     );
17310 
17311 }; /* interface IFramebuffer */
17312 
17327 interface IFramebufferOverlay : IFramebuffer
17328 {
17332     readonly attribute unsigned long x;
17333 
17337     readonly attribute unsigned long y;
17338 
17344     attribute boolean visible;
17345 
17352     attribute unsigned long alpha;
17353 
17359     void move (
17360         in unsigned long x,
17361         in unsigned long y
17362     );
17363 
17364 }; /* interface IFramebufferOverlay */
17365 
17381 interface IDisplay : $unknown
17382 {
17386     void getScreenResolution (
17387         in unsigned long screenId,
17388         out unsigned long width,
17389         out unsigned long height,
17390         out unsigned long bitsPerPixel
17391     );
17392 
17398     void setFramebuffer (
17399         in unsigned long screenId,
17400         in IFramebuffer framebuffer
17401     );
17402 
17408     void getFramebuffer (
17409         in unsigned long screenId,
17410         out IFramebuffer framebuffer,
17411         out long xOrigin,
17412         out long yOrigin
17413     );
17414 
17465     void setVideoModeHint (
17466         in unsigned long display,
17467         in boolean enabled,
17468         in boolean changeOrigin,
17469         in long originX,
17470         in long originY,
17471         in unsigned long width,
17472         in unsigned long height,
17473         in unsigned long bitsPerPixel
17474     );
17475 
17487     void setSeamlessMode (
17488         in boolean enabled
17489     );
17490 
17526     void takeScreenShot (
17527         in unsigned long screenId,
17528         in octetPtr address,
17529         in unsigned long width,
17530         in unsigned long height
17531     );
17532 
17576     void takeScreenShotToArray (
17577         in unsigned long screenId,
17578         in unsigned long width,
17579         in unsigned long height,
17580         [retval] out octet[] screenData
17581     );
17582 
17621     void takeScreenShotPNGToArray (
17622         in unsigned long screenId,
17623         in unsigned long width,
17624         in unsigned long height,
17625         [retval] out octet[] screenData
17626     );
17627 
17679     void drawToScreen (
17680         in unsigned long screenId,
17681         in octetPtr address,
17682         in unsigned long x,
17683         in unsigned long y,
17684         in unsigned long width,
17685         in unsigned long height
17686     );
17687 
17702     void invalidateAndUpdate();
17703 
17717     void resizeCompleted (
17718         in unsigned long screenId
17719     );
17720 
17733     void completeVHWACommand (
17734         in octetPtr command
17735     );
17736 
17770     void viewportChanged (
17771         in unsigned long screenId,
17772         in unsigned long x,
17773         in unsigned long y,
17774         in unsigned long width,
17775         in unsigned long height
17776     );
17777 
17778 }; /* interface IDisplay */
17779 
17795 interface INetworkAdapter : $unknown
17796 {
17804     attribute NetworkAdapterType adapterType;
17805 
17813     readonly attribute unsigned long slot;
17814 
17823     attribute boolean enabled;
17824 
17831     attribute wstring MACAddress;
17832 
17838     attribute NetworkAttachmentType attachmentType;
17839 
17845     attribute wstring bridgedInterface;
17846 
17852     attribute wstring hostOnlyInterface;
17853 
17859     attribute wstring internalNetwork;
17860 
17866     attribute wstring NATNetwork;
17867 
17873     attribute wstring genericDriver;
17874 
17881     attribute boolean cableConnected;
17882 
17888     attribute unsigned long lineSpeed;
17889 
17896     attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
17897 
17904     attribute boolean traceEnabled;
17905 
17912     attribute wstring traceFile;
17913 
17921     readonly attribute INATEngine NATEngine;
17922 
17929     attribute unsigned long bootPriority;
17930 
17934     attribute IBandwidthGroup bandwidthGroup;
17935 
17954     void getProperty (
17955         in wstring key,
17956         [retval] out wstring value
17957     );
17958 
17977     void setProperty (
17978         in wstring key,
17979         in wstring value
17980     );
17981 
18009     void getProperties (
18010         in wstring names,
18011         out wstring[] returnNames,
18012         [retval] out wstring[] returnValues
18013     );
18014 
18015 }; /* interface INetworkAdapter */
18016 
18045 interface ISerialPort : $unknown
18046 {
18054     readonly attribute unsigned long slot;
18055 
18062     attribute boolean enabled;
18063 
18067     attribute unsigned long IOBase;
18068 
18072     attribute unsigned long IRQ;
18073 
18084     attribute PortMode hostMode;
18085 
18093     attribute boolean server;
18094 
18104     attribute wstring path;
18105 
18106 }; /* interface ISerialPort */
18107 
18127 interface IParallelPort : $unknown
18128 {
18136     readonly attribute unsigned long slot;
18137 
18144     attribute boolean enabled;
18145 
18149     attribute unsigned long IOBase;
18150 
18154     attribute unsigned long IRQ;
18155 
18163     attribute wstring path;
18164 
18165 }; /* interface IParallelPort */
18166 
18167 interface IMachineDebugger : $unknown
18168 {
18172     attribute boolean singleStep;
18173 
18177     attribute boolean recompileUser;
18178 
18182     attribute boolean recompileSupervisor;
18183 
18187     attribute boolean PATMEnabled;
18188 
18192     attribute boolean CSAMEnabled;
18193 
18197     attribute boolean logEnabled;
18198 
18202     readonly attribute wstring logDbgFlags;
18203 
18207     readonly attribute wstring logDbgGroups;
18208 
18212     readonly attribute wstring logDbgDestinations;
18213 
18217     readonly attribute wstring logRelFlags;
18218 
18222     readonly attribute wstring logRelGroups;
18223 
18227     readonly attribute wstring logRelDestinations;
18228 
18235     readonly attribute boolean HWVirtExEnabled;
18236 
18243     readonly attribute boolean HWVirtExNestedPagingEnabled;
18244 
18251     readonly attribute boolean HWVirtExVPIDEnabled;
18252 
18261     readonly attribute wstring OSName;
18262 
18271     readonly attribute wstring OSVersion;
18272 
18279     readonly attribute boolean PAEEnabled;
18280 
18287     attribute unsigned long virtualTimeRate;
18288 
18295     readonly attribute long long VM;
18296 
18312     void dumpGuestCore (
18313         in wstring filename,
18314         in wstring compression
18315     );
18316 
18333     void dumpHostProcessCore (
18334         in wstring filename,
18335         in wstring compression
18336     );
18337 
18358     void info (
18359         in wstring name,
18360         in wstring args,
18361         [retval] out wstring info
18362     );
18363 
18369     void injectNMI();
18370 
18381     void modifyLogGroups (
18382         in wstring settings
18383     );
18384 
18395     void modifyLogFlags (
18396         in wstring settings
18397     );
18398 
18409     void modifyLogDestinations (
18410         in wstring settings
18411     );
18412 
18427     void readPhysicalMemory (
18428         in long long address,
18429         in unsigned long size,
18430         [retval] out octet[] bytes
18431     );
18432 
18447     void writePhysicalMemory (
18448         in long long address,
18449         in unsigned long size,
18450         in octet[] bytes
18451     );
18452 
18469     void readVirtualMemory (
18470         in unsigned long cpuId,
18471         in long long address,
18472         in unsigned long size,
18473         [retval] out octet[] bytes
18474     );
18475 
18492     void writeVirtualMemory (
18493         in unsigned long cpuId,
18494         in long long address,
18495         in unsigned long size,
18496         in octet[] bytes
18497     );
18498 
18511     void detectOS (
18512         [retval] out wstring os
18513     );
18514 
18532     void getRegister (
18533         in unsigned long cpuId,
18534         in wstring name,
18535         [retval] out wstring value
18536     );
18537 
18555     void getRegisters (
18556         in unsigned long cpuId,
18557         out wstring[] names,
18558         out wstring[] values
18559     );
18560 
18579     void setRegister (
18580         in unsigned long cpuId,
18581         in wstring name,
18582         in wstring value
18583     );
18584 
18603     void setRegisters (
18604         in unsigned long cpuId,
18605         in wstring[] names,
18606         in wstring[] values
18607     );
18608 
18621     void dumpGuestStack (
18622         in unsigned long cpuId,
18623         [retval] out wstring stack
18624     );
18625 
18633     void resetStats (
18634         in wstring pattern
18635     );
18636 
18644     void dumpStats (
18645         in wstring pattern
18646     );
18647 
18659     void getStats (
18660         in wstring pattern,
18661         in boolean withDescriptions,
18662         out wstring stats
18663     );
18664 
18665 }; /* interface IMachineDebugger */
18666 
18667 interface IUSBController : $unknown
18668 {
18677     attribute boolean enabled;
18678 
18687     attribute boolean enabledEHCI;
18688 
18694     readonly attribute boolean proxyAvailable;
18695 
18703     readonly attribute unsigned short USBStandard;
18704 
18730     readonly attribute IUSBDeviceFilter[] deviceFilters;
18731 
18759     void createDeviceFilter (
18760         in wstring name,
18761         [retval] out IUSBDeviceFilter filter
18762     );
18763 
18808     void insertDeviceFilter (
18809         in unsigned long position,
18810         in IUSBDeviceFilter filter
18811     );
18812 
18845     void removeDeviceFilter (
18846         in unsigned long position,
18847         [retval] out IUSBDeviceFilter filter
18848     );
18849 
18850 }; /* interface IUSBController */
18851 
18864 interface IUSBDevice : $unknown
18865 {
18872     readonly attribute wstringUUID id;
18873 
18877     readonly attribute unsigned short vendorId;
18878 
18882     readonly attribute unsigned short productId;
18883 
18891     readonly attribute unsigned short revision;
18892 
18896     readonly attribute wstring manufacturer;
18897 
18901     readonly attribute wstring product;
18902 
18906     readonly attribute wstring serialNumber;
18907 
18911     readonly attribute wstring address;
18912 
18919     readonly attribute unsigned short port;
18920 
18926     readonly attribute unsigned short version;
18927 
18935     readonly attribute unsigned short portVersion;
18936 
18943     readonly attribute boolean remote;
18944 
18945 }; /* interface IUSBDevice */
18946 
19021 interface IUSBDeviceFilter : $unknown
19022 {
19030     attribute wstring name;
19031 
19035     attribute boolean active;
19036 
19044     attribute wstring vendorId;
19045 
19053     attribute wstring productId;
19054 
19068     attribute wstring revision;
19069 
19074     attribute wstring manufacturer;
19075 
19080     attribute wstring product;
19081 
19086     attribute wstring serialNumber;
19087 
19092     attribute wstring port;
19093 
19103     attribute wstring remote;
19104 
19114     attribute unsigned long maskedInterfaces;
19115 
19116 }; /* interface IUSBDeviceFilter */
19117 
19134 interface IHostUSBDevice : IUSBDevice
19135 {
19141     readonly attribute USBDeviceState state;
19142 
19143 }; /* interface IHostUSBDevice */
19144 
19167 interface IHostUSBDeviceFilter : IUSBDeviceFilter
19168 {
19175     attribute USBDeviceFilterAction action;
19176 
19177 }; /* interface IHostUSBDeviceFilter */
19178 
19187 interface IAudioAdapter : $unknown
19188 {
19197     attribute boolean enabled;
19198 
19204     attribute AudioControllerType audioController;
19205 
19212     attribute AudioDriverType audioDriver;
19213 
19214 }; /* interface IAudioAdapter */
19215 
19216 interface IVRDEServer : $unknown
19217 {
19221     attribute boolean enabled;
19222 
19226     attribute AuthType authType;
19227 
19231     attribute unsigned long authTimeout;
19232 
19239     attribute boolean allowMultiConnection;
19240 
19248     attribute boolean reuseSingleConnection;
19249 
19256     attribute wstring VRDEExtPack;
19257 
19264     attribute wstring authLibrary;
19265 
19271     readonly attribute wstring[] VRDEProperties;
19272 
19286     void setVRDEProperty (
19287         in wstring key,
19288         in wstring value
19289     );
19290 
19304     void getVRDEProperty (
19305         in wstring key,
19306         [retval] out wstring value
19307     );
19308 
19309 }; /* interface IVRDEServer */
19310 
19368 interface ISharedFolder : $unknown
19369 {
19373     readonly attribute wstring name;
19374 
19378     readonly attribute wstring hostPath;
19379 
19389     readonly attribute boolean accessible;
19390 
19397     readonly attribute boolean writable;
19398 
19404     readonly attribute boolean autoMount;
19405 
19418     readonly attribute wstring lastAccessError;
19419 
19420 }; /* interface ISharedFolder */
19421 
19422 interface IInternalSessionControl : $unknown
19423 {
19428     void getPID (
19429         [retval] out unsigned long pid
19430     );
19431 
19453     void getRemoteConsole (
19454         [retval] out IConsole console
19455     );
19456 
19480     void assignMachine (
19481         in IMachine machine,
19482         in LockType lockType
19483     );
19484 
19499     void assignRemoteMachine (
19500         in IMachine machine,
19501         in IConsole console
19502     );
19503 
19527     void updateMachineState (
19528         in MachineState aMachineState
19529     );
19530 
19546     void uninitialize();
19547 
19570     void onNetworkAdapterChange (
19571         in INetworkAdapter networkAdapter,
19572         in boolean changeAdapter
19573     );
19574 
19597     void onSerialPortChange (
19598         in ISerialPort serialPort
19599     );
19600 
19623     void onParallelPortChange (
19624         in IParallelPort parallelPort
19625     );
19626 
19649     void onStorageControllerChange();
19650 
19677     void onMediumChange (
19678         in IMediumAttachment mediumAttachment,
19679         in boolean force
19680     );
19681 
19711     void onStorageDeviceChange (
19712         in IMediumAttachment mediumAttachment,
19713         in boolean remove,
19714         in boolean silent
19715     );
19716 
19724     void onClipboardModeChange (
19725         in ClipboardMode clipboardMode
19726     );
19727 
19735     void onDragAndDropModeChange (
19736         in DragAndDropMode dragAndDropMode
19737     );
19738 
19748     void onCPUChange (
19749         in unsigned long cpu,
19750         in boolean add
19751     );
19752 
19760     void onCPUExecutionCapChange (
19761         in unsigned long executionCap
19762     );
19763 
19788     void onVRDEServerChange (
19789         in boolean restart
19790     );
19791 
19814     void onUSBControllerChange();
19815 
19844     void onSharedFolderChange (
19845         in boolean global
19846     );
19847 
19873     void onUSBDeviceAttach (
19874         in IUSBDevice device,
19875         in IVirtualBoxErrorInfo error,
19876         in unsigned long maskedInterfaces
19877     );
19878 
19904     void onUSBDeviceDetach (
19905         in wstringUUID id,
19906         in IVirtualBoxErrorInfo error
19907     );
19908 
19926     void onShowWindow (
19927         in boolean check,
19928         out boolean canShow,
19929         out long long winId
19930     );
19931 
19939     void onBandwidthGroupChange (
19940         in IBandwidthGroup bandwidthGroup
19941     );
19942 
19966     void accessGuestProperty (
19967         in wstring name,
19968         in wstring value,
19969         in wstring flags,
19970         in boolean isSetter,
19971         out wstring retValue,
19972         out long long retTimestamp,
19973         out wstring retFlags
19974     );
19975 
20023     void enumerateGuestProperties (
20024         in wstring patterns,
20025         out wstring[] key,
20026         out wstring[] value,
20027         out long long[] timestamp,
20028         out wstring[] flags
20029     );
20030 
20076     void onlineMergeMedium (
20077         in IMediumAttachment mediumAttachment,
20078         in unsigned long sourceIdx,
20079         in unsigned long targetIdx,
20080         in IMedium source,
20081         in IMedium target,
20082         in boolean mergeForward,
20083         in IMedium parentForTarget,
20084         in IMedium[] childrenToReparent,
20085         in IProgress progress
20086     );
20087 
20111     void enableVMMStatistics (
20112         in boolean enable
20113     );
20114 
20115 }; /* interface IInternalSessionControl */
20116 
20175 interface ISession : $unknown
20176 {
20180     readonly attribute SessionState state;
20181 
20189     readonly attribute SessionType type;
20190 
20194     readonly attribute IMachine machine;
20195 
20199     readonly attribute IConsole console;
20200 
20232     void unlockMachine();
20233 
20234 }; /* interface ISession */
20235 
20258 interface IStorageController : $unknown
20259 {
20268     readonly attribute wstring name;
20269 
20275     readonly attribute unsigned long maxDevicesPerPortCount;
20276 
20282     readonly attribute unsigned long minPortCount;
20283 
20289     readonly attribute unsigned long maxPortCount;
20290 
20296     attribute unsigned long instance;
20297 
20306     attribute unsigned long portCount;
20307 
20313     readonly attribute StorageBus bus;
20314 
20327     attribute StorageControllerType controllerType;
20328 
20343     attribute boolean useHostIOCache;
20344 
20350     readonly attribute boolean bootable;
20351 
20352 }; /* interface IStorageController */
20353 
20377 interface IManagedObjectRef : $unknown
20378 {
20385     void getInterfaceName (
20386         [retval] out wstring return
20387     );
20388 
20396     void release();
20397 
20398 }; /* interface IManagedObjectRef */
20399 
20408 interface IWebsessionManager : $unknown
20409 {
20418     void logon (
20419         in wstring username,
20420         in wstring password,
20421         [retval] out IVirtualBox return
20422     );
20423 
20433     void getSessionObject (
20434         in IVirtualBox refIVirtualBox,
20435         [retval] out ISession return
20436     );
20437 
20445     void logoff (
20446         in IVirtualBox refIVirtualBox
20447     );
20448 
20449 }; /* interface IWebsessionManager */
20450 
20459 interface IPerformanceMetric : $unknown
20460 {
20466     readonly attribute wstring metricName;
20467 
20473     readonly attribute $unknown object;
20474 
20480     readonly attribute wstring description;
20481 
20487     readonly attribute unsigned long period;
20488 
20498     readonly attribute unsigned long count;
20499 
20505     readonly attribute wstring unit;
20506 
20512     readonly attribute long minimumValue;
20513 
20519     readonly attribute long maximumValue;
20520 
20521 }; /* interface IPerformanceMetric */
20522 
20629 interface IPerformanceCollector : $unknown
20630 {
20641     readonly attribute wstring[] metricNames;
20642 
20666     void getMetrics (
20667         in wstring[] metricNames,
20668         in $unknown[] objects,
20669         [retval] out IPerformanceMetric[] metrics
20670     );
20671 
20710     void setupMetrics (
20711         in wstring[] metricNames,
20712         in $unknown[] objects,
20713         in unsigned long period,
20714         in unsigned long count,
20715         [retval] out IPerformanceMetric[] affectedMetrics
20716     );
20717 
20746     void enableMetrics (
20747         in wstring[] metricNames,
20748         in $unknown[] objects,
20749         [retval] out IPerformanceMetric[] affectedMetrics
20750     );
20751 
20780     void disableMetrics (
20781         in wstring[] metricNames,
20782         in $unknown[] objects,
20783         [retval] out IPerformanceMetric[] affectedMetrics
20784     );
20785 
20874     void queryMetricsData (
20875         in wstring[] metricNames,
20876         in $unknown[] objects,
20877         out wstring[] returnMetricNames,
20878         out $unknown[] returnObjects,
20879         out wstring[] returnUnits,
20880         out unsigned long[] returnScales,
20881         out unsigned long[] returnSequenceNumbers,
20882         out unsigned long[] returnDataIndices,
20883         out unsigned long[] returnDataLengths,
20884         [retval] out long[] returnData
20885     );
20886 
20887 }; /* interface IPerformanceCollector */
20888 
20896 interface INATEngine : $unknown
20897 {
20902     attribute wstring network;
20903 
20910     attribute wstring hostIP;
20911 
20916     attribute wstring TFTPPrefix;
20917 
20922     attribute wstring TFTPBootFile;
20923 
20931     attribute wstring TFTPNextServer;
20932 
20936     attribute unsigned long aliasMode;
20937 
20941     attribute boolean DNSPassDomain;
20942 
20947     attribute boolean DNSProxy;
20948 
20953     attribute boolean DNSUseHostResolver;
20954 
20959     readonly attribute wstring[] redirects;
20960 
20976     void setNetworkSettings (
20977         in unsigned long mtu,
20978         in unsigned long sockSnd,
20979         in unsigned long sockRcv,
20980         in unsigned long TcpWndSnd,
20981         in unsigned long TcpWndRcv
20982     );
20983 
20988     void getNetworkSettings (
20989         out unsigned long mtu,
20990         out unsigned long sockSnd,
20991         out unsigned long sockRcv,
20992         out unsigned long TcpWndSnd,
20993         out unsigned long TcpWndRcv
20994     );
20995 
21015     void addRedirect (
21016         in wstring name,
21017         in NATProtocol proto,
21018         in wstring hostIP,
21019         in unsigned short hostPort,
21020         in wstring guestIP,
21021         in unsigned short guestPort
21022     );
21023 
21029     void removeRedirect (
21030         in wstring name
21031     );
21032 
21033 }; /* interface INATEngine */
21034 
21043 interface IExtPackPlugIn : $unknown
21044 {
21048     readonly attribute wstring name;
21049 
21053     readonly attribute wstring description;
21054 
21060     readonly attribute wstring frontend;
21061 
21065     readonly attribute wstring modulePath;
21066 
21067 }; /* interface IExtPackPlugIn */
21068 
21077 interface IExtPackBase : $unknown
21078 {
21082     readonly attribute wstring name;
21083 
21087     readonly attribute wstring description;
21088 
21100     readonly attribute wstring version;
21101 
21105     readonly attribute unsigned long revision;
21106 
21116     readonly attribute wstring edition;
21117 
21121     readonly attribute wstring VRDEModule;
21122 
21126     readonly attribute IExtPackPlugIn[] plugIns;
21127 
21137     readonly attribute boolean usable;
21138 
21145     readonly attribute wstring whyUnusable;
21146 
21150     readonly attribute boolean showLicense;
21151 
21160     readonly attribute wstring license;
21161 
21185     void queryLicense (
21186         in wstring preferredLocale,
21187         in wstring preferredLanguage,
21188         in wstring format,
21189         [retval] out wstring licenseText
21190     );
21191 
21192 }; /* interface IExtPackBase */
21193 
21202 interface IExtPack : IExtPackBase
21203 {
21215     void queryObject (
21216         in wstring objUuid,
21217         [retval] out $unknown returnInterface
21218     );
21219 
21220 }; /* interface IExtPack */
21221 
21231 interface IExtPackFile : IExtPackBase
21232 {
21238     readonly attribute wstring filePath;
21239 
21258     void install (
21259         in boolean replace,
21260         in wstring displayInfo,
21261         [retval] out IProgress progess
21262     );
21263 
21264 }; /* interface IExtPackFile */
21265 
21276 interface IExtPackManager : $unknown
21277 {
21283     readonly attribute IExtPack[] installedExtPacks;
21284 
21302     void find (
21303         in wstring name,
21304         [retval] out IExtPack returnData
21305     );
21306 
21318     void openExtPackFile (
21319         in wstring path,
21320         [retval] out IExtPackFile file
21321     );
21322 
21341     void uninstall (
21342         in wstring name,
21343         in boolean forcedRemoval,
21344         in wstring displayInfo,
21345         [retval] out IProgress progess
21346     );
21347 
21351     void cleanup();
21352 
21365     void queryAllPlugInsForFrontend (
21366         in wstring frontendName,
21367         [retval] out wstring[] plugInModules
21368     );
21369 
21377     void isExtPackUsable (
21378         in wstring name,
21379         [retval] out boolean usable
21380     );
21381 
21382 }; /* interface IExtPackManager */
21383 
21389 interface IBandwidthGroup : $unknown
21390 {
21394     readonly attribute wstring name;
21395 
21399     readonly attribute BandwidthGroupType type;
21400 
21404     readonly attribute unsigned long reference;
21405 
21410     attribute long long maxBytesPerSec;
21411 
21412 }; /* interface IBandwidthGroup */
21413 
21422 interface IBandwidthControl : $unknown
21423 {
21429     readonly attribute unsigned long numGroups;
21430 
21443     void createBandwidthGroup (
21444         in wstring name,
21445         in BandwidthGroupType type,
21446         in long long maxBytesPerSec
21447     );
21448 
21456     void deleteBandwidthGroup (
21457         in wstring name
21458     );
21459 
21469     void getBandwidthGroup (
21470         in wstring name,
21471         [retval] out IBandwidthGroup bandwidthGroup
21472     );
21473 
21481     void getAllBandwidthGroups (
21482         [retval] out IBandwidthGroup[] bandwidthGroups
21483     );
21484 
21485 }; /* interface IBandwidthControl */
21486 
21499 interface IVirtualBoxClient : $unknown
21500 {
21506     readonly attribute IVirtualBox virtualBox;
21507 
21513     readonly attribute ISession session;
21514 
21520     readonly attribute IEventSource eventSource;
21521 
21522 }; /* interface IVirtualBoxClient */
21523 
21537 interface IEventSource : $unknown
21538 {
21544     void createListener (
21545         [retval] out IEventListener listener
21546     );
21547 
21563     void createAggregator (
21564         in IEventSource[] subordinates,
21565         [retval] out IEventSource result
21566     );
21567 
21600     void registerListener (
21601         in IEventListener listener,
21602         in VBoxEventType[] interesting,
21603         in boolean active
21604     );
21605 
21614     void unregisterListener (
21615         in IEventListener listener
21616     );
21617 
21632     void fireEvent (
21633         in IEvent event,
21634         in long timeout,
21635         [retval] out boolean result
21636     );
21637 
21662     void getEvent (
21663         in IEventListener listener,
21664         in long timeout,
21665         [retval] out IEvent event
21666     );
21667 
21679     void eventProcessed (
21680         in IEventListener listener,
21681         in IEvent event
21682     );
21683 
21684 }; /* interface IEventSource */
21685 
21695 interface IEventListener : $unknown
21696 {
21709     void handleEvent (
21710         in IEvent event
21711     );
21712 
21713 }; /* interface IEventListener */
21714 
21791 interface IEvent : $unknown
21792 {
21798     readonly attribute VBoxEventType type;
21799 
21805     readonly attribute IEventSource source;
21806 
21817     readonly attribute boolean waitable;
21818 
21825     void setProcessed();
21826 
21840     void waitProcessed (
21841         in long timeout,
21842         [retval] out boolean result
21843     );
21844 
21845 }; /* interface IEvent */
21846 
21852 interface IReusableEvent : IEvent
21853 {
21857     readonly attribute unsigned long generation;
21858 
21865     void reuse();
21866 
21867 }; /* interface IReusableEvent */
21868 
21874 interface IMachineEvent : IEvent
21875 {
21879     readonly attribute wstringUUID machineId;
21880 
21881 }; /* interface IMachineEvent */
21882 
21888 interface IMachineStateChangedEvent : IMachineEvent
21889 {
21893     readonly attribute MachineState state;
21894 
21895 }; /* interface IMachineStateChangedEvent */
21896 
21904 interface IMachineDataChangedEvent : IMachineEvent
21905 {
21912     readonly attribute boolean temporary;
21913 
21914 }; /* interface IMachineDataChangedEvent */
21915 
21924 interface IMediumRegisteredEvent : IEvent
21925 {
21929     readonly attribute wstringUUID mediumId;
21930 
21934     readonly attribute DeviceType mediumType;
21935 
21942     readonly attribute boolean registered;
21943 
21944 }; /* interface IMediumRegisteredEvent */
21945 
21954 interface IMachineRegisteredEvent : IMachineEvent
21955 {
21962     readonly attribute boolean registered;
21963 
21964 }; /* interface IMachineRegisteredEvent */
21965 
21975 interface ISessionStateChangedEvent : IMachineEvent
21976 {
21982     readonly attribute SessionState state;
21983 
21984 }; /* interface ISessionStateChangedEvent */
21985 
21993 interface IGuestPropertyChangedEvent : IMachineEvent
21994 {
22000     readonly attribute wstring name;
22001 
22007     readonly attribute wstring value;
22008 
22014     readonly attribute wstring flags;
22015 
22016 }; /* interface IGuestPropertyChangedEvent */
22017 
22023 interface ISnapshotEvent : IMachineEvent
22024 {
22028     readonly attribute wstringUUID snapshotId;
22029 
22030 }; /* interface ISnapshotEvent */
22031 
22041 interface ISnapshotTakenEvent : ISnapshotEvent
22042 {
22043 }; /* interface ISnapshotTakenEvent */
22044 
22061 interface ISnapshotDeletedEvent : ISnapshotEvent
22062 {
22063 }; /* interface ISnapshotDeletedEvent */
22064 
22074 interface ISnapshotChangedEvent : ISnapshotEvent
22075 {
22076 }; /* interface ISnapshotChangedEvent */
22077 
22086 interface IMousePointerShapeChangedEvent : IEvent
22087 {
22093     readonly attribute boolean visible;
22094 
22100     readonly attribute boolean alpha;
22101 
22107     readonly attribute unsigned long xhot;
22108 
22114     readonly attribute unsigned long yhot;
22115 
22121     readonly attribute unsigned long width;
22122 
22128     readonly attribute unsigned long height;
22129 
22162     readonly attribute octet[] shape;
22163 
22164 }; /* interface IMousePointerShapeChangedEvent */
22165 
22174 interface IMouseCapabilityChangedEvent : IEvent
22175 {
22181     readonly attribute boolean supportsAbsolute;
22182 
22188     readonly attribute boolean supportsRelative;
22189 
22195     readonly attribute boolean needsHostCursor;
22196 
22197 }; /* interface IMouseCapabilityChangedEvent */
22198 
22207 interface IKeyboardLedsChangedEvent : IEvent
22208 {
22214     readonly attribute boolean numLock;
22215 
22221     readonly attribute boolean capsLock;
22222 
22228     readonly attribute boolean scrollLock;
22229 
22230 }; /* interface IKeyboardLedsChangedEvent */
22231 
22240 interface IStateChangedEvent : IEvent
22241 {
22247     readonly attribute MachineState state;
22248 
22249 }; /* interface IStateChangedEvent */
22250 
22260 interface IAdditionsStateChangedEvent : IEvent
22261 {
22262 }; /* interface IAdditionsStateChangedEvent */
22263 
22274 interface INetworkAdapterChangedEvent : IEvent
22275 {
22281     readonly attribute INetworkAdapter networkAdapter;
22282 
22283 }; /* interface INetworkAdapterChangedEvent */
22284 
22295 interface ISerialPortChangedEvent : IEvent
22296 {
22302     readonly attribute ISerialPort serialPort;
22303 
22304 }; /* interface ISerialPortChangedEvent */
22305 
22316 interface IParallelPortChangedEvent : IEvent
22317 {
22323     readonly attribute IParallelPort parallelPort;
22324 
22325 }; /* interface IParallelPortChangedEvent */
22326 
22336 interface IStorageControllerChangedEvent : IEvent
22337 {
22338 }; /* interface IStorageControllerChangedEvent */
22339 
22349 interface IMediumChangedEvent : IEvent
22350 {
22356     readonly attribute IMediumAttachment mediumAttachment;
22357 
22358 }; /* interface IMediumChangedEvent */
22359 
22367 interface IClipboardModeChangedEvent : IEvent
22368 {
22374     readonly attribute ClipboardMode clipboardMode;
22375 
22376 }; /* interface IClipboardModeChangedEvent */
22377 
22385 interface IDragAndDropModeChangedEvent : IEvent
22386 {
22392     readonly attribute DragAndDropMode dragAndDropMode;
22393 
22394 }; /* interface IDragAndDropModeChangedEvent */
22395 
22403 interface ICPUChangedEvent : IEvent
22404 {
22410     readonly attribute unsigned long CPU;
22411 
22417     readonly attribute boolean add;
22418 
22419 }; /* interface ICPUChangedEvent */
22420 
22428 interface ICPUExecutionCapChangedEvent : IEvent
22429 {
22435     readonly attribute unsigned long executionCap;
22436 
22437 }; /* interface ICPUExecutionCapChangedEvent */
22438 
22446 interface IGuestKeyboardEvent : IEvent
22447 {
22453     readonly attribute long[] scancodes;
22454 
22455 }; /* interface IGuestKeyboardEvent */
22456 
22464 interface IGuestMouseEvent : IReusableEvent
22465 {
22471     readonly attribute boolean absolute;
22472 
22478     readonly attribute long x;
22479 
22485     readonly attribute long y;
22486 
22492     readonly attribute long z;
22493 
22499     readonly attribute long w;
22500 
22506     readonly attribute long buttons;
22507 
22508 }; /* interface IGuestMouseEvent */
22509 
22520 interface IVRDEServerChangedEvent : IEvent
22521 {
22522 }; /* interface IVRDEServerChangedEvent */
22523 
22533 interface IVRDEServerInfoChangedEvent : IEvent
22534 {
22535 }; /* interface IVRDEServerInfoChangedEvent */
22536 
22547 interface IUSBControllerChangedEvent : IEvent
22548 {
22549 }; /* interface IUSBControllerChangedEvent */
22550 
22574 interface IUSBDeviceStateChangedEvent : IEvent
22575 {
22581     readonly attribute IUSBDevice device;
22582 
22588     readonly attribute boolean attached;
22589 
22595     readonly attribute IVirtualBoxErrorInfo error;
22596 
22597 }; /* interface IUSBDeviceStateChangedEvent */
22598 
22614 interface ISharedFolderChangedEvent : IEvent
22615 {
22621     readonly attribute Scope scope;
22622 
22623 }; /* interface ISharedFolderChangedEvent */
22624 
22676 interface IRuntimeErrorEvent : IEvent
22677 {
22683     readonly attribute boolean fatal;
22684 
22690     readonly attribute wstring id;
22691 
22697     readonly attribute wstring message;
22698 
22699 }; /* interface IRuntimeErrorEvent */
22700 
22708 interface IEventSourceChangedEvent : IEvent
22709 {
22715     readonly attribute IEventListener listener;
22716 
22722     readonly attribute boolean add;
22723 
22724 }; /* interface IEventSourceChangedEvent */
22725 
22734 interface IExtraDataChangedEvent : IEvent
22735 {
22742     readonly attribute wstringUUID machineId;
22743 
22749     readonly attribute wstring key;
22750 
22756     readonly attribute wstring value;
22757 
22758 }; /* interface IExtraDataChangedEvent */
22759 
22765 interface IVetoEvent : IEvent
22766 {
22776     void addVeto (
22777         in wstring reason
22778     );
22779 
22789     void isVetoed (
22790         [retval] out boolean result
22791     );
22792 
22802     void getVetos (
22803         [retval] out wstring[] result
22804     );
22805 
22806 }; /* interface IVetoEvent */
22807 
22817 interface IExtraDataCanChangeEvent : IVetoEvent
22818 {
22825     readonly attribute wstringUUID machineId;
22826 
22832     readonly attribute wstring key;
22833 
22839     readonly attribute wstring value;
22840 
22841 }; /* interface IExtraDataCanChangeEvent */
22842 
22858 interface ICanShowWindowEvent : IVetoEvent
22859 {
22860 }; /* interface ICanShowWindowEvent */
22861 
22893 interface IShowWindowEvent : IEvent
22894 {
22903     attribute long long winId;
22904 
22905 }; /* interface IShowWindowEvent */
22906 
22914 interface INATRedirectEvent : IMachineEvent
22915 {
22921     readonly attribute unsigned long slot;
22922 
22928     readonly attribute boolean remove;
22929 
22935     readonly attribute wstring name;
22936 
22942     readonly attribute NATProtocol proto;
22943 
22949     readonly attribute wstring hostIP;
22950 
22956     readonly attribute long hostPort;
22957 
22963     readonly attribute wstring guestIP;
22964 
22970     readonly attribute long guestPort;
22971 
22972 }; /* interface INATRedirectEvent */
22973 
22986 interface IHostPCIDevicePlugEvent : IMachineEvent
22987 {
22993     readonly attribute boolean plugged;
22994 
23001     readonly attribute boolean success;
23002 
23008     readonly attribute IPCIDeviceAttachment attachment;
23009 
23015     readonly attribute wstring message;
23016 
23017 }; /* interface IHostPCIDevicePlugEvent */
23018 
23027 interface IVBoxSVCAvailabilityChangedEvent : IEvent
23028 {
23034     readonly attribute boolean available;
23035 
23036 }; /* interface IVBoxSVCAvailabilityChangedEvent */
23037 
23045 interface IBandwidthGroupChangedEvent : IEvent
23046 {
23052     readonly attribute IBandwidthGroup bandwidthGroup;
23053 
23054 }; /* interface IBandwidthGroupChangedEvent */
23055 
23063 interface IGuestMonitorChangedEvent : IEvent
23064 {
23070     readonly attribute GuestMonitorChangedEventType changeType;
23071 
23077     readonly attribute unsigned long screenId;
23078 
23085     readonly attribute unsigned long originX;
23086 
23093     readonly attribute unsigned long originY;
23094 
23101     readonly attribute unsigned long width;
23102 
23109     readonly attribute unsigned long height;
23110 
23111 }; /* interface IGuestMonitorChangedEvent */
23112 
23122 interface IStorageDeviceChangedEvent : IEvent
23123 {
23129     readonly attribute IMediumAttachment storageDevice;
23130 
23136     readonly attribute boolean removed;
23137 
23138 }; /* interface IStorageDeviceChangedEvent */
23139 
23140 

Generated on Thu Jul 4 2013 16:40:19 for VirtualBox Main API by  doxygen 1.7.1