• 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 
05962     void reportGuestStatistics (
05963         in unsigned long validStats,
05964         in unsigned long cpuUser,
05965         in unsigned long cpuKernel,
05966         in unsigned long cpuIdle,
05967         in unsigned long memTotal,
05968         in unsigned long memFree,
05969         in unsigned long memBalloon,
05970         in unsigned long memShared,
05971         in unsigned long memCache,
05972         in unsigned long pagedTotal,
05973         in unsigned long memAllocTotal,
05974         in unsigned long memFreeTotal,
05975         in unsigned long memBalloonTotal,
05976         in unsigned long memSharedTotal
05977     );
05978 
05979 }; /* interface IInternalMachineControl */
05980 
05989 interface IBIOSSettings : $unknown
05990 {
05994     attribute boolean logoFadeIn;
05995 
05999     attribute boolean logoFadeOut;
06000 
06004     attribute unsigned long logoDisplayTime;
06005 
06012     attribute wstring logoImagePath;
06013 
06017     attribute BIOSBootMenuMode bootMenuMode;
06018 
06022     attribute boolean ACPIEnabled;
06023 
06030     attribute boolean IOAPICEnabled;
06031 
06041     attribute long long timeOffset;
06042 
06049     attribute boolean PXEDebugEnabled;
06050 
06051 }; /* interface IBIOSSettings */
06052 
06060 interface IPCIAddress : $unknown
06061 {
06067     attribute short bus;
06068 
06074     attribute short device;
06075 
06081     attribute short devFunction;
06082 
06088     void asLong (
06089         [retval] out long result
06090     );
06091 
06097     void fromLong (
06098         in long number
06099     );
06100 
06101 }; /* interface IPCIAddress */
06102 
06110 interface IPCIDeviceAttachment : $unknown
06111 {
06117     readonly attribute wstring name;
06118 
06124     readonly attribute boolean isPhysicalDevice;
06125 
06131     readonly attribute long hostAddress;
06132 
06138     readonly attribute long guestAddress;
06139 
06140 }; /* interface IPCIDeviceAttachment */
06141 
06182 interface IMachine : $unknown
06183 {
06187     readonly attribute IVirtualBox parent;
06188 
06238     readonly attribute boolean accessible;
06239 
06251     readonly attribute IVirtualBoxErrorInfo accessError;
06252 
06292     attribute wstring name;
06293 
06304     attribute wstring description;
06305 
06309     readonly attribute wstringUUID id;
06310 
06321     attribute wstring[] groups;
06322 
06337     attribute wstring OSTypeId;
06338 
06342     attribute wstring hardwareVersion;
06343 
06353     attribute wstringUUID hardwareUUID;
06354 
06358     attribute unsigned long CPUCount;
06359 
06365     attribute boolean CPUHotPlugEnabled;
06366 
06374     attribute unsigned long CPUExecutionCap;
06375 
06379     attribute unsigned long memorySize;
06380 
06384     attribute unsigned long memoryBalloonSize;
06385 
06392     attribute boolean pageFusionEnabled;
06393 
06397     attribute unsigned long VRAMSize;
06398 
06404     attribute boolean accelerate3DEnabled;
06405 
06411     attribute boolean accelerate2DVideoEnabled;
06412 
06423     attribute unsigned long monitorCount;
06424 
06430     attribute boolean VideoCaptureEnabled;
06431 
06437     attribute wstring VideoCaptureFile;
06438 
06444     attribute unsigned long VideoCaptureWidth;
06445 
06451     attribute unsigned long VideoCaptureHeight;
06452 
06456     readonly attribute IBIOSSettings BIOSSettings;
06457 
06462     attribute FirmwareType firmwareType;
06463 
06469     attribute PointingHIDType pointingHIDType;
06470 
06476     attribute KeyboardHIDType keyboardHIDType;
06477 
06484     attribute boolean HPETEnabled;
06485 
06489     attribute ChipsetType chipsetType;
06490 
06524     attribute wstring snapshotFolder;
06525 
06529     readonly attribute IVRDEServer VRDEServer;
06530 
06531     attribute boolean emulatedUSBWebcameraEnabled;
06532 
06533     attribute boolean emulatedUSBCardReaderEnabled;
06534 
06538     readonly attribute IMediumAttachment[] mediumAttachments;
06539 
06551     readonly attribute IUSBController USBController;
06552 
06556     readonly attribute IAudioAdapter audioAdapter;
06557 
06561     readonly attribute IStorageController[] storageControllers;
06562 
06568     readonly attribute wstring settingsFilePath;
06569 
06594     readonly attribute boolean settingsModified;
06595 
06599     readonly attribute SessionState sessionState;
06600 
06613     readonly attribute wstring sessionType;
06614 
06624     readonly attribute unsigned long sessionPID;
06625 
06629     readonly attribute MachineState state;
06630 
06637     readonly attribute long long lastStateChange;
06638 
06650     readonly attribute wstring stateFilePath;
06651 
06661     readonly attribute wstring logFolder;
06662 
06673     readonly attribute ISnapshot currentSnapshot;
06674 
06681     readonly attribute unsigned long snapshotCount;
06682 
06714     readonly attribute boolean currentStateModified;
06715 
06727     readonly attribute ISharedFolder[] sharedFolders;
06728 
06735     attribute ClipboardMode clipboardMode;
06736 
06742     attribute DragAndDropMode dragAndDropMode;
06743 
06751     attribute wstring guestPropertyNotificationPatterns;
06752 
06761     attribute boolean teleporterEnabled;
06762 
06773     attribute unsigned long teleporterPort;
06774 
06781     attribute wstring teleporterAddress;
06782 
06793     attribute wstring teleporterPassword;
06794 
06802     attribute FaultToleranceState faultToleranceState;
06803 
06810     attribute unsigned long faultTolerancePort;
06811 
06817     attribute wstring faultToleranceAddress;
06818 
06826     attribute wstring faultTolerancePassword;
06827 
06833     attribute unsigned long faultToleranceSyncInterval;
06834 
06842     attribute boolean RTCUseUTC;
06843 
06850     attribute boolean IOCacheEnabled;
06851 
06857     attribute unsigned long IOCacheSize;
06858 
06868     readonly attribute IPCIDeviceAttachment[] PCIDeviceAssignments;
06869 
06875     readonly attribute IBandwidthControl bandwidthControl;
06876 
06885     attribute boolean tracingEnabled;
06886 
06901     attribute wstring tracingConfig;
06902 
06915     attribute boolean allowTracingToAccessVM;
06916 
06922     attribute boolean autostartEnabled;
06923 
06929     attribute unsigned long autostartDelay;
06930 
06936     attribute AutostopType autostopType;
06937 
07043     void lockMachine (
07044         in ISession session,
07045         in LockType lockType
07046     );
07047 
07177     void launchVMProcess (
07178         in ISession session,
07179         in wstring type,
07180         in wstring environment,
07181         [retval] out IProgress progress
07182     );
07183 
07221     void setBootOrder (
07222         in unsigned long position,
07223         in DeviceType device
07224     );
07225 
07260     void getBootOrder (
07261         in unsigned long position,
07262         [retval] out DeviceType device
07263     );
07264 
07366     void attachDevice (
07367         in wstring name,
07368         in long controllerPort,
07369         in long device,
07370         in DeviceType type,
07371         in IMedium medium
07372     );
07373 
07469     void attachDeviceWithoutMedium (
07470         in wstring name,
07471         in long controllerPort,
07472         in long device,
07473         in DeviceType type
07474     );
07475 
07529     void detachDevice (
07530         in wstring name,
07531         in long controllerPort,
07532         in long device
07533     );
07534 
07577     void passthroughDevice (
07578         in wstring name,
07579         in long controllerPort,
07580         in long device,
07581         in boolean passthrough
07582     );
07583 
07626     void temporaryEjectDevice (
07627         in wstring name,
07628         in long controllerPort,
07629         in long device,
07630         in boolean temporaryEject
07631     );
07632 
07678     void nonRotationalDevice (
07679         in wstring name,
07680         in long controllerPort,
07681         in long device,
07682         in boolean nonRotational
07683     );
07684 
07730     void setAutoDiscardForDevice (
07731         in wstring name,
07732         in long controllerPort,
07733         in long device,
07734         in boolean discard
07735     );
07736 
07777     void setBandwidthGroupForDevice (
07778         in wstring name,
07779         in long controllerPort,
07780         in long device,
07781         in IBandwidthGroup bandwidthGroup
07782     );
07783 
07820     void setNoBandwidthGroupForDevice (
07821         in wstring name,
07822         in long controllerPort,
07823         in long device
07824     );
07825 
07890     void unmountMedium (
07891         in wstring name,
07892         in long controllerPort,
07893         in long device,
07894         in boolean force
07895     );
07896 
07959     void mountMedium (
07960         in wstring name,
07961         in long controllerPort,
07962         in long device,
07963         in IMedium medium,
07964         in boolean force
07965     );
07966 
07995     void getMedium (
07996         in wstring name,
07997         in long controllerPort,
07998         in long device,
07999         [retval] out IMedium medium
08000     );
08001 
08016     void getMediumAttachmentsOfController (
08017         in wstring name,
08018         [retval] out IMediumAttachment[] mediumAttachments
08019     );
08020 
08035     void getMediumAttachment (
08036         in wstring name,
08037         in long controllerPort,
08038         in long device,
08039         [retval] out IMediumAttachment attachment
08040     );
08041 
08082     void attachHostPCIDevice (
08083         in long hostAddress,
08084         in long desiredGuestAddress,
08085         in boolean tryToUnbind
08086     );
08087 
08128     void detachHostPCIDevice (
08129         in long hostAddress
08130     );
08131 
08149     void getNetworkAdapter (
08150         in unsigned long slot,
08151         [retval] out INetworkAdapter adapter
08152     );
08153 
08186     void addStorageController (
08187         in wstring name,
08188         in StorageBus connectionType,
08189         [retval] out IStorageController controller
08190     );
08191 
08205     void getStorageControllerByName (
08206         in wstring name,
08207         [retval] out IStorageController storageController
08208     );
08209 
08223     void getStorageControllerByInstance (
08224         in unsigned long instance,
08225         [retval] out IStorageController storageController
08226     );
08227 
08250     void removeStorageController (
08251         in wstring name
08252     );
08253 
08275     void setStorageControllerBootable (
08276         in wstring name,
08277         in boolean bootable
08278     );
08279 
08297     void getSerialPort (
08298         in unsigned long slot,
08299         [retval] out ISerialPort port
08300     );
08301 
08319     void getParallelPort (
08320         in unsigned long slot,
08321         [retval] out IParallelPort port
08322     );
08323 
08332     void getExtraDataKeys (
08333         [retval] out wstring[] value
08334     );
08335 
08364     void getExtraData (
08365         in wstring key,
08366         [retval] out wstring value
08367     );
08368 
08418     void setExtraData (
08419         in wstring key,
08420         in wstring value
08421     );
08422 
08444     void getCPUProperty (
08445         in CPUPropertyType property,
08446         [retval] out boolean value
08447     );
08448 
08470     void setCPUProperty (
08471         in CPUPropertyType property,
08472         in boolean value
08473     );
08474 
08514     void getCPUIDLeaf (
08515         in unsigned long id,
08516         out unsigned long valEax,
08517         out unsigned long valEbx,
08518         out unsigned long valEcx,
08519         out unsigned long valEdx
08520     );
08521 
08565     void setCPUIDLeaf (
08566         in unsigned long id,
08567         in unsigned long valEax,
08568         in unsigned long valEbx,
08569         in unsigned long valEcx,
08570         in unsigned long valEdx
08571     );
08572 
08590     void removeCPUIDLeaf (
08591         in unsigned long id
08592     );
08593 
08599     void removeAllCPUIDLeaves();
08600 
08622     void getHWVirtExProperty (
08623         in HWVirtExPropertyType property,
08624         [retval] out boolean value
08625     );
08626 
08648     void setHWVirtExProperty (
08649         in HWVirtExPropertyType property,
08650         in boolean value
08651     );
08652 
08698     void saveSettings();
08699 
08723     void discardSettings();
08724 
08808     void unregister (
08809         in CleanupMode cleanupMode,
08810         [retval] out IMedium[] aMedia
08811     );
08812 
08869     void delete (
08870         in IMedium[] aMedia,
08871         [retval] out IProgress aProgress
08872     );
08873 
08885     void export (
08886         in IAppliance aAppliance,
08887         in wstring location,
08888         [retval] out IVirtualSystemDescription aDescription
08889     );
08890 
08914     void findSnapshot (
08915         in wstring nameOrId,
08916         [retval] out ISnapshot snapshot
08917     );
08918 
08952     void createSharedFolder (
08953         in wstring name,
08954         in wstring hostPath,
08955         in boolean writable,
08956         in boolean automount
08957     );
08958 
08984     void removeSharedFolder (
08985         in wstring name
08986     );
08987 
09011     void canShowConsoleWindow (
09012         [retval] out boolean canShow
09013     );
09014 
09049     void showConsoleWindow (
09050         [retval] out long long winId
09051     );
09052 
09085     void getGuestProperty (
09086         in wstring name,
09087         out wstring value,
09088         out long long timestamp,
09089         out wstring flags
09090     );
09091 
09114     void getGuestPropertyValue (
09115         in wstring property,
09116         [retval] out wstring value
09117     );
09118 
09141     void getGuestPropertyTimestamp (
09142         in wstring property,
09143         [retval] out long long value
09144     );
09145 
09196     void setGuestProperty (
09197         in wstring property,
09198         in wstring value,
09199         in wstring flags
09200     );
09201 
09242     void setGuestPropertyValue (
09243         in wstring property,
09244         in wstring value
09245     );
09246 
09264     void deleteGuestProperty (
09265         in wstring name
09266     );
09267 
09298     void enumerateGuestProperties (
09299         in wstring patterns,
09300         out wstring[] name,
09301         out wstring[] value,
09302         out long long[] timestamp,
09303         out wstring[] flags
09304     );
09305 
09335     void querySavedGuestScreenInfo (
09336         in unsigned long screenId,
09337         out unsigned long originX,
09338         out unsigned long originY,
09339         out unsigned long width,
09340         out unsigned long height,
09341         out boolean enabled
09342     );
09343 
09365     void querySavedThumbnailSize (
09366         in unsigned long screenId,
09367         out unsigned long size,
09368         out unsigned long width,
09369         out unsigned long height
09370     );
09371 
09398     void readSavedThumbnailToArray (
09399         in unsigned long screenId,
09400         in boolean BGR,
09401         out unsigned long width,
09402         out unsigned long height,
09403         [retval] out octet[] data
09404     );
09405 
09427     void readSavedThumbnailPNGToArray (
09428         in unsigned long screenId,
09429         out unsigned long width,
09430         out unsigned long height,
09431         [retval] out octet[] data
09432     );
09433 
09455     void querySavedScreenshotPNGSize (
09456         in unsigned long screenId,
09457         out unsigned long size,
09458         out unsigned long width,
09459         out unsigned long height
09460     );
09461 
09483     void readSavedScreenshotPNGToArray (
09484         in unsigned long screenId,
09485         out unsigned long width,
09486         out unsigned long height,
09487         [retval] out octet[] data
09488     );
09489 
09499     void hotPlugCPU (
09500         in unsigned long cpu
09501     );
09502 
09512     void hotUnplugCPU (
09513         in unsigned long cpu
09514     );
09515 
09529     void getCPUStatus (
09530         in unsigned long cpu,
09531         [retval] out boolean attached
09532     );
09533 
09548     void queryLogFilename (
09549         in unsigned long idx,
09550         [retval] out wstring filename
09551     );
09552 
09578     void readLog (
09579         in unsigned long idx,
09580         in long long offset,
09581         in long long size,
09582         [retval] out octet[] data
09583     );
09584 
09617     void cloneTo (
09618         in IMachine target,
09619         in CloneMode mode,
09620         in CloneOptions[] options,
09621         [retval] out IProgress progress
09622     );
09623 
09624 }; /* interface IMachine */
09625 
09634 interface IVRDEServerInfo : $unknown
09635 {
09641     readonly attribute boolean active;
09642 
09651     readonly attribute long port;
09652 
09658     readonly attribute unsigned long numberOfClients;
09659 
09665     readonly attribute long long beginTime;
09666 
09673     readonly attribute long long endTime;
09674 
09680     readonly attribute long long bytesSent;
09681 
09687     readonly attribute long long bytesSentTotal;
09688 
09694     readonly attribute long long bytesReceived;
09695 
09701     readonly attribute long long bytesReceivedTotal;
09702 
09708     readonly attribute wstring user;
09709 
09715     readonly attribute wstring domain;
09716 
09722     readonly attribute wstring clientName;
09723 
09729     readonly attribute wstring clientIP;
09730 
09736     readonly attribute unsigned long clientVersion;
09737 
09745     readonly attribute unsigned long encryptionStyle;
09746 
09747 }; /* interface IVRDEServerInfo */
09748 
09770 interface IConsole : $unknown
09771 {
09783     readonly attribute IMachine machine;
09784 
09798     readonly attribute MachineState state;
09799 
09803     readonly attribute IGuest guest;
09804 
09815     readonly attribute IKeyboard keyboard;
09816 
09827     readonly attribute IMouse mouse;
09828 
09838     readonly attribute IDisplay display;
09839 
09843     readonly attribute IMachineDebugger debugger;
09844 
09855     readonly attribute IUSBDevice[] USBDevices;
09856 
09864     readonly attribute IHostUSBDevice[] remoteUSBDevices;
09865 
09881     readonly attribute ISharedFolder[] sharedFolders;
09882 
09888     readonly attribute IVRDEServerInfo VRDEServerInfo;
09889 
09895     readonly attribute IEventSource eventSource;
09896 
09900     readonly attribute IPCIDeviceAttachment[] attachedPCIDevices;
09901 
09910     attribute boolean useHostClipboard;
09911 
09976     void powerUp (
09977         [retval] out IProgress progress
09978     );
09979 
10013     void powerUpPaused (
10014         [retval] out IProgress progress
10015     );
10016 
10036     void powerDown (
10037         [retval] out IProgress progress
10038     );
10039 
10059     void reset();
10060 
10080     void pause();
10081 
10101     void resume();
10102 
10122     void powerButton();
10123 
10143     void sleepButton();
10144 
10156     void getPowerButtonHandled (
10157         [retval] out boolean handled
10158     );
10159 
10173     void getGuestEnteredACPIMode (
10174         [retval] out boolean entered
10175     );
10176 
10229     void saveState (
10230         [retval] out IProgress progress
10231     );
10232 
10265     void adoptSavedState (
10266         in wstring savedStateFile
10267     );
10268 
10299     void discardSavedState (
10300         in boolean fRemoveFile
10301     );
10302 
10315     void getDeviceActivity (
10316         in DeviceType type,
10317         [retval] out DeviceActivity activity
10318     );
10319 
10357     void attachUSBDevice (
10358         in wstringUUID id
10359     );
10360 
10395     void detachUSBDevice (
10396         in wstringUUID id,
10397         [retval] out IUSBDevice device
10398     );
10399 
10422     void findUSBDeviceByAddress (
10423         in wstring name,
10424         [retval] out IUSBDevice device
10425     );
10426 
10446     void findUSBDeviceById (
10447         in wstringUUID id,
10448         [retval] out IUSBDevice device
10449     );
10450 
10484     void createSharedFolder (
10485         in wstring name,
10486         in wstring hostPath,
10487         in boolean writable,
10488         in boolean automount
10489     );
10490 
10515     void removeSharedFolder (
10516         in wstring name
10517     );
10518 
10556     void takeSnapshot (
10557         in wstring name,
10558         in wstring description,
10559         [retval] out IProgress progress
10560     );
10561 
10634     void deleteSnapshot (
10635         in wstringUUID id,
10636         [retval] out IProgress progress
10637     );
10638 
10678     void deleteSnapshotAndAllChildren (
10679         in wstringUUID id,
10680         [retval] out IProgress progress
10681     );
10682 
10726     void deleteSnapshotRange (
10727         in wstringUUID startId,
10728         in wstringUUID endId,
10729         [retval] out IProgress progress
10730     );
10731 
10772     void restoreSnapshot (
10773         in ISnapshot snapshot,
10774         [retval] out IProgress progress
10775     );
10776 
10815     void teleport (
10816         in wstring hostname,
10817         in unsigned long tcpport,
10818         in wstring password,
10819         in unsigned long maxDowntime,
10820         [retval] out IProgress progress
10821     );
10822 
10823 }; /* interface IConsole */
10824 
10835 interface IHostNetworkInterface : $unknown
10836 {
10840     readonly attribute wstring name;
10841 
10845     readonly attribute wstringUUID id;
10846 
10850     readonly attribute wstring networkName;
10851 
10855     readonly attribute boolean DHCPEnabled;
10856 
10860     readonly attribute wstring IPAddress;
10861 
10865     readonly attribute wstring networkMask;
10866 
10870     readonly attribute boolean IPV6Supported;
10871 
10875     readonly attribute wstring IPV6Address;
10876 
10880     readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
10881 
10885     readonly attribute wstring hardwareAddress;
10886 
10890     readonly attribute HostNetworkInterfaceMediumType mediumType;
10891 
10895     readonly attribute HostNetworkInterfaceStatus status;
10896 
10900     readonly attribute HostNetworkInterfaceType interfaceType;
10901 
10913     void enableStaticIPConfig (
10914         in wstring IPAddress,
10915         in wstring networkMask
10916     );
10917 
10929     void enableStaticIPConfigV6 (
10930         in wstring IPV6Address,
10931         in unsigned long IPV6NetworkMaskPrefixLength
10932     );
10933 
10937     void enableDynamicIPConfig();
10938 
10942     void DHCPRediscover();
10943 
10944 }; /* interface IHostNetworkInterface */
10945 
10962 interface IHost : $unknown
10963 {
10967     readonly attribute IMedium[] DVDDrives;
10968 
10972     readonly attribute IMedium[] floppyDrives;
10973 
10987     readonly attribute IHostUSBDevice[] USBDevices;
10988 
11012     readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
11013 
11017     readonly attribute IHostNetworkInterface[] networkInterfaces;
11018 
11022     readonly attribute unsigned long processorCount;
11023 
11027     readonly attribute unsigned long processorOnlineCount;
11028 
11032     readonly attribute unsigned long processorCoreCount;
11033 
11037     readonly attribute unsigned long memorySize;
11038 
11042     readonly attribute unsigned long memoryAvailable;
11043 
11047     readonly attribute wstring operatingSystem;
11048 
11052     readonly attribute wstring OSVersion;
11053 
11057     readonly attribute long long UTCTime;
11058 
11062     readonly attribute boolean acceleration3DAvailable;
11063 
11078     void getProcessorSpeed (
11079         in unsigned long cpuId,
11080         [retval] out unsigned long speed
11081     );
11082 
11094     void getProcessorFeature (
11095         in ProcessorFeature feature,
11096         [retval] out boolean supported
11097     );
11098 
11117     void getProcessorDescription (
11118         in unsigned long cpuId,
11119         [retval] out wstring description
11120     );
11121 
11162     void getProcessorCPUIDLeaf (
11163         in unsigned long cpuId,
11164         in unsigned long leaf,
11165         in unsigned long subLeaf,
11166         out unsigned long valEax,
11167         out unsigned long valEbx,
11168         out unsigned long valEcx,
11169         out unsigned long valEdx
11170     );
11171 
11192     void createHostOnlyNetworkInterface (
11193         out IHostNetworkInterface hostInterface,
11194         [retval] out IProgress progress
11195     );
11196 
11217     void removeHostOnlyNetworkInterface (
11218         in wstringUUID id,
11219         [retval] out IProgress progress
11220     );
11221 
11241     void createUSBDeviceFilter (
11242         in wstring name,
11243         [retval] out IHostUSBDeviceFilter filter
11244     );
11245 
11288     void insertUSBDeviceFilter (
11289         in unsigned long position,
11290         in IHostUSBDeviceFilter filter
11291     );
11292 
11320     void removeUSBDeviceFilter (
11321         in unsigned long position
11322     );
11323 
11341     void findHostDVDDrive (
11342         in wstring name,
11343         [retval] out IMedium drive
11344     );
11345 
11363     void findHostFloppyDrive (
11364         in wstring name,
11365         [retval] out IMedium drive
11366     );
11367 
11383     void findHostNetworkInterfaceByName (
11384         in wstring name,
11385         [retval] out IHostNetworkInterface networkInterface
11386     );
11387 
11403     void findHostNetworkInterfaceById (
11404         in wstringUUID id,
11405         [retval] out IHostNetworkInterface networkInterface
11406     );
11407 
11417     void findHostNetworkInterfacesOfType (
11418         in HostNetworkInterfaceType type,
11419         [retval] out IHostNetworkInterface[] networkInterfaces
11420     );
11421 
11441     void findUSBDeviceById (
11442         in wstringUUID id,
11443         [retval] out IHostUSBDevice device
11444     );
11445 
11468     void findUSBDeviceByAddress (
11469         in wstring name,
11470         [retval] out IHostUSBDevice device
11471     );
11472 
11480     void generateMACAddress (
11481         [retval] out wstring address
11482     );
11483 
11484 }; /* interface IHost */
11485 
11498 interface ISystemProperties : $unknown
11499 {
11503     readonly attribute unsigned long minGuestRAM;
11504 
11508     readonly attribute unsigned long maxGuestRAM;
11509 
11513     readonly attribute unsigned long minGuestVRAM;
11514 
11518     readonly attribute unsigned long maxGuestVRAM;
11519 
11523     readonly attribute unsigned long minGuestCPUCount;
11524 
11528     readonly attribute unsigned long maxGuestCPUCount;
11529 
11533     readonly attribute unsigned long maxGuestMonitors;
11534 
11539     readonly attribute long long infoVDSize;
11540 
11547     readonly attribute unsigned long serialPortCount;
11548 
11555     readonly attribute unsigned long parallelPortCount;
11556 
11566     readonly attribute unsigned long maxBootPosition;
11567 
11591     attribute wstring defaultMachineFolder;
11592 
11617     readonly attribute IMediumFormat[] mediumFormats;
11618 
11652     attribute wstring defaultHardDiskFormat;
11653 
11659     attribute long long freeDiskSpaceWarning;
11660 
11665     attribute unsigned long freeDiskSpacePercentWarning;
11666 
11672     attribute long long freeDiskSpaceError;
11673 
11678     attribute unsigned long freeDiskSpacePercentError;
11679 
11703     attribute wstring VRDEAuthLibrary;
11704 
11733     attribute wstring webServiceAuthLibrary;
11734 
11748     attribute wstring defaultVRDEExtPack;
11749 
11755     attribute unsigned long logHistoryCount;
11756 
11761     readonly attribute AudioDriverType defaultAudioDriver;
11762 
11769     attribute wstring autostartDatabasePath;
11770 
11777     attribute wstring defaultAdditionsISO;
11778 
11789     void getMaxNetworkAdapters (
11790         in ChipsetType chipset,
11791         [retval] out unsigned long maxNetworkAdapters
11792     );
11793 
11807     void getMaxNetworkAdaptersOfType (
11808         in ChipsetType chipset,
11809         in NetworkAttachmentType type,
11810         [retval] out unsigned long maxNetworkAdapters
11811     );
11812 
11822     void getMaxDevicesPerPortForStorageBus (
11823         in StorageBus bus,
11824         [retval] out unsigned long maxDevicesPerPort
11825     );
11826 
11834     void getMinPortCountForStorageBus (
11835         in StorageBus bus,
11836         [retval] out unsigned long minPortCount
11837     );
11838 
11846     void getMaxPortCountForStorageBus (
11847         in StorageBus bus,
11848         [retval] out unsigned long maxPortCount
11849     );
11850 
11863     void getMaxInstancesOfStorageBus (
11864         in ChipsetType chipset,
11865         in StorageBus bus,
11866         [retval] out unsigned long maxInstances
11867     );
11868 
11878     void getDeviceTypesForStorageBus (
11879         in StorageBus bus,
11880         [retval] out DeviceType[] deviceTypes
11881     );
11882 
11891     void getDefaultIoCacheSettingForStorageController (
11892         in StorageControllerType controllerType,
11893         [retval] out boolean enabled
11894     );
11895 
11896 }; /* interface ISystemProperties */
11897 
11903 interface IGuestOSType : $unknown
11904 {
11908     readonly attribute wstring familyId;
11909 
11913     readonly attribute wstring familyDescription;
11914 
11918     readonly attribute wstring id;
11919 
11923     readonly attribute wstring description;
11924 
11928     readonly attribute boolean is64Bit;
11929 
11933     readonly attribute boolean recommendedIOAPIC;
11934 
11938     readonly attribute boolean recommendedVirtEx;
11939 
11943     readonly attribute unsigned long recommendedRAM;
11944 
11948     readonly attribute unsigned long recommendedVRAM;
11949 
11953     readonly attribute boolean recommended2DVideoAcceleration;
11954 
11958     readonly attribute boolean recommended3DAcceleration;
11959 
11963     readonly attribute long long recommendedHDD;
11964 
11968     readonly attribute NetworkAdapterType adapterType;
11969 
11973     readonly attribute boolean recommendedPAE;
11974 
11978     readonly attribute StorageControllerType recommendedDVDStorageController;
11979 
11983     readonly attribute StorageBus recommendedDVDStorageBus;
11984 
11988     readonly attribute StorageControllerType recommendedHDStorageController;
11989 
11993     readonly attribute StorageBus recommendedHDStorageBus;
11994 
11998     readonly attribute FirmwareType recommendedFirmware;
11999 
12003     readonly attribute boolean recommendedUSBHID;
12004 
12008     readonly attribute boolean recommendedHPET;
12009 
12013     readonly attribute boolean recommendedUSBTablet;
12014 
12018     readonly attribute boolean recommendedRTCUseUTC;
12019 
12023     readonly attribute ChipsetType recommendedChipset;
12024 
12028     readonly attribute AudioControllerType recommendedAudioController;
12029 
12033     readonly attribute boolean recommendedFloppy;
12034 
12038     readonly attribute boolean recommendedUSB;
12039 
12040 }; /* interface IGuestOSType */
12041 
12049 interface IAdditionsFacility : $unknown
12050 {
12054     readonly attribute AdditionsFacilityClass classType;
12055 
12062     readonly attribute long long lastUpdated;
12063 
12067     readonly attribute wstring name;
12068 
12072     readonly attribute AdditionsFacilityStatus status;
12073 
12077     readonly attribute AdditionsFacilityType type;
12078 
12079 }; /* interface IAdditionsFacility */
12080 
12106 interface IGuestSession : $unknown
12107 {
12113     readonly attribute wstring user;
12114 
12120     readonly attribute wstring domain;
12121 
12125     readonly attribute wstring name;
12126 
12130     readonly attribute unsigned long id;
12131 
12144     attribute unsigned long timeout;
12145 
12151     attribute wstring[] environment;
12152 
12158     readonly attribute IGuestProcess[] processes;
12159 
12165     readonly attribute IGuestDirectory[] directories;
12166 
12172     readonly attribute IGuestFile[] files;
12173 
12181     void close();
12182 
12204     void copyFrom (
12205         in wstring source,
12206         in wstring dest,
12207         in CopyFileFlag[] flags,
12208         [retval] out IProgress progress
12209     );
12210 
12232     void copyTo (
12233         in wstring source,
12234         in wstring dest,
12235         in CopyFileFlag[] flags,
12236         [retval] out IProgress progress
12237     );
12238 
12258     void directoryCreate (
12259         in wstring path,
12260         in unsigned long mode,
12261         in DirectoryCreateFlag[] flags
12262     );
12263 
12315     void directoryCreateTemp (
12316         in wstring templateName,
12317         in unsigned long mode,
12318         in wstring path,
12319         in boolean secure,
12320         [retval] out wstring directory
12321     );
12322 
12340     void directoryExists (
12341         in wstring path,
12342         [retval] out boolean exists
12343     );
12344 
12375     void directoryOpen (
12376         in wstring path,
12377         in wstring filter,
12378         in DirectoryOpenFlag[] flags,
12379         [retval] out IGuestDirectory directory
12380     );
12381 
12407     void directoryQueryInfo (
12408         in wstring path,
12409         [retval] out IGuestFsObjInfo info
12410     );
12411 
12427     void directoryRemove (
12428         in wstring path
12429     );
12430 
12450     void directoryRemoveRecursive (
12451         in wstring path,
12452         in DirectoryRemoveRecFlag[] flags,
12453         [retval] out IProgress progress
12454     );
12455 
12475     void directoryRename (
12476         in wstring source,
12477         in wstring dest,
12478         in PathRenameFlag[] flags
12479     );
12480 
12498     void directorySetACL (
12499         in wstring path,
12500         in wstring acl
12501     );
12502 
12516     void environmentClear();
12517 
12538     void environmentGet (
12539         in wstring name,
12540         [retval] out wstring value
12541     );
12542 
12560     void environmentSet (
12561         in wstring name,
12562         in wstring value
12563     );
12564 
12580     void environmentUnset (
12581         in wstring name
12582     );
12583 
12637     void fileCreateTemp (
12638         in wstring templateName,
12639         in unsigned long mode,
12640         in wstring path,
12641         in boolean secure,
12642         [retval] out IGuestFile file
12643     );
12644 
12662     void fileExists (
12663         in wstring path,
12664         [retval] out boolean exists
12665     );
12666 
12690     void fileRemove (
12691         in wstring path
12692     );
12693 
12728     void fileOpen (
12729         in wstring path,
12730         in wstring openMode,
12731         in wstring disposition,
12732         in unsigned long creationMode,
12733         in long long offset,
12734         [retval] out IGuestFile file
12735     );
12736 
12762     void fileQueryInfo (
12763         in wstring path,
12764         [retval] out IGuestFsObjInfo info
12765     );
12766 
12792     void fileQuerySize (
12793         in wstring path,
12794         [retval] out long long size
12795     );
12796 
12816     void fileRename (
12817         in wstring source,
12818         in wstring dest,
12819         in PathRenameFlag[] flags
12820     );
12821 
12839     void fileSetACL (
12840         in wstring file,
12841         in wstring acl
12842     );
12843 
12903     void processCreate (
12904         in wstring command,
12905         in wstring[] arguments,
12906         in wstring[] environment,
12907         in ProcessCreateFlag[] flags,
12908         in unsigned long timeoutMS,
12909         [retval] out IGuestProcess guestProcess
12910     );
12911 
12981     void processCreateEx (
12982         in wstring command,
12983         in wstring[] arguments,
12984         in wstring[] environment,
12985         in ProcessCreateFlag[] flags,
12986         in unsigned long timeoutMS,
12987         in ProcessPriority priority,
12988         in long[] affinity,
12989         [retval] out IGuestProcess guestProcess
12990     );
12991 
13001     void processGet (
13002         in unsigned long pid,
13003         [retval] out IGuestProcess guestProcess
13004     );
13005 
13028     void symlinkCreate (
13029         in wstring source,
13030         in wstring target,
13031         in SymlinkType type
13032     );
13033 
13051     void symlinkExists (
13052         in wstring symlink,
13053         [retval] out boolean exists
13054     );
13055 
13079     void symlinkRead (
13080         in wstring symlink,
13081         in SymlinkReadFlag[] flags,
13082         [retval] out wstring target
13083     );
13084 
13100     void symlinkRemoveDirectory (
13101         in wstring path
13102     );
13103 
13119     void symlinkRemoveFile (
13120         in wstring file
13121     );
13122 
13123 }; /* interface IGuestSession */
13124 
13132 interface IProcess : $unknown
13133 {
13139     readonly attribute unsigned long PID;
13140 
13147     readonly attribute ProcessStatus status;
13148 
13155     readonly attribute long exitCode;
13156 
13162     readonly attribute wstring[] environment;
13163 
13169     readonly attribute wstring[] arguments;
13170 
13174     readonly attribute wstring executablePath;
13175 
13179     readonly attribute wstring name;
13180 
13201     void waitFor (
13202         in unsigned long waitFor,
13203         in unsigned long timeoutMS,
13204         [retval] out ProcessWaitResult reason
13205     );
13206 
13228     void waitForArray (
13229         in ProcessWaitForFlag[] waitFor,
13230         in unsigned long timeoutMS,
13231         [retval] out ProcessWaitResult reason
13232     );
13233 
13250     void read (
13251         in unsigned long handle,
13252         in unsigned long toRead,
13253         in unsigned long timeoutMS,
13254         [retval] out octet[] data
13255     );
13256 
13280     void write (
13281         in unsigned long handle,
13282         in unsigned long flags,
13283         in octet[] data,
13284         in unsigned long timeoutMS,
13285         [retval] out unsigned long written
13286     );
13287 
13312     void writeArray (
13313         in unsigned long handle,
13314         in ProcessInputFlag[] flags,
13315         in octet[] data,
13316         in unsigned long timeoutMS,
13317         [retval] out unsigned long written
13318     );
13319 
13325     void terminate();
13326 
13327 }; /* interface IProcess */
13328 
13337 interface IGuestProcess : IProcess
13338 {
13339 }; /* interface IGuestProcess */
13340 
13348 interface IDirectory : $unknown
13349 {
13355     readonly attribute wstring directoryName;
13356 
13362     readonly attribute wstring filter;
13363 
13370     void close();
13371 
13386     void read (
13387         [retval] out IFsObjInfo objInfo
13388     );
13389 
13390 }; /* interface IDirectory */
13391 
13400 interface IGuestDirectory : IDirectory
13401 {
13402 }; /* interface IGuestDirectory */
13403 
13411 interface IFile : $unknown
13412 {
13418     readonly attribute unsigned long creationMode;
13419 
13425     readonly attribute unsigned long disposition;
13426 
13432     readonly attribute wstring fileName;
13433 
13439     readonly attribute long long initialSize;
13440 
13446     readonly attribute unsigned long openMode;
13447 
13453     readonly attribute long long offset;
13454 
13461     void close();
13462 
13478     void queryInfo (
13479         [retval] out IFsObjInfo objInfo
13480     );
13481 
13504     void read (
13505         in unsigned long toRead,
13506         in unsigned long timeoutMS,
13507         [retval] out octet[] data
13508     );
13509 
13534     void readAt (
13535         in long long offset,
13536         in unsigned long toRead,
13537         in unsigned long timeoutMS,
13538         [retval] out octet[] data
13539     );
13540 
13560     void seek (
13561         in long long offset,
13562         in FileSeekType whence
13563     );
13564 
13580     void setACL (
13581         in wstring acl
13582     );
13583 
13601     void write (
13602         in octet[] data,
13603         in unsigned long timeoutMS,
13604         [retval] out unsigned long written
13605     );
13606 
13634     void writeAt (
13635         in long long offset,
13636         in octet[] data,
13637         in unsigned long timeoutMS,
13638         [retval] out unsigned long written
13639     );
13640 
13641 }; /* interface IFile */
13642 
13651 interface IGuestFile : IFile
13652 {
13653 }; /* interface IGuestFile */
13654 
13663 interface IFsObjInfo : $unknown
13664 {
13670     readonly attribute long long accessTime;
13671 
13677     readonly attribute long long allocatedSize;
13678 
13684     readonly attribute long long birthTime;
13685 
13691     readonly attribute long long changeTime;
13692 
13698     readonly attribute unsigned long deviceNumber;
13699 
13705     readonly attribute wstring fileAttributes;
13706 
13712     readonly attribute unsigned long generationId;
13713 
13719     readonly attribute unsigned long GID;
13720 
13726     readonly attribute wstring groupName;
13727 
13733     readonly attribute unsigned long hardLinks;
13734 
13740     readonly attribute long long modificationTime;
13741 
13747     readonly attribute wstring name;
13748 
13754     readonly attribute long long nodeId;
13755 
13761     readonly attribute unsigned long nodeIdDevice;
13762 
13770     readonly attribute long long objectSize;
13771 
13777     readonly attribute FsObjType type;
13778 
13784     readonly attribute unsigned long UID;
13785 
13791     readonly attribute unsigned long userFlags;
13792 
13798     readonly attribute wstring userName;
13799 
13800 }; /* interface IFsObjInfo */
13801 
13810 interface IGuestFsObjInfo : IFsObjInfo
13811 {
13812 }; /* interface IGuestFsObjInfo */
13813 
13827 interface IGuest : $unknown
13828 {
13843     readonly attribute wstring OSTypeId;
13844 
13850     readonly attribute AdditionsRunLevelType additionsRunLevel;
13851 
13858     readonly attribute wstring additionsVersion;
13859 
13867     readonly attribute unsigned long additionsRevision;
13868 
13875     readonly attribute IAdditionsFacility[] facilities;
13876 
13880     readonly attribute IGuestSession[] sessions;
13881 
13885     attribute unsigned long memoryBalloonSize;
13886 
13890     attribute unsigned long statisticsUpdateInterval;
13891 
13923     void internalGetStatistics (
13924         out unsigned long cpuUser,
13925         out unsigned long cpuKernel,
13926         out unsigned long cpuIdle,
13927         out unsigned long memTotal,
13928         out unsigned long memFree,
13929         out unsigned long memBalloon,
13930         out unsigned long memShared,
13931         out unsigned long memCache,
13932         out unsigned long pagedTotal,
13933         out unsigned long memAllocTotal,
13934         out unsigned long memFreeTotal,
13935         out unsigned long memBalloonTotal,
13936         out unsigned long memSharedTotal
13937     );
13938 
13950     void getFacilityStatus (
13951         in AdditionsFacilityType facility,
13952         out long long timestamp,
13953         [retval] out AdditionsFacilityStatus status
13954     );
13955 
13973     void getAdditionsStatus (
13974         in AdditionsRunLevelType level,
13975         [retval] out boolean active
13976     );
13977 
14007     void setCredentials (
14008         in wstring userName,
14009         in wstring password,
14010         in wstring domain,
14011         in boolean allowInteractiveLogon
14012     );
14013 
14043     void dragHGEnter (
14044         in unsigned long screenId,
14045         in unsigned long y,
14046         in unsigned long x,
14047         in DragAndDropAction defaultAction,
14048         in DragAndDropAction[] allowedActions,
14049         in wstring[] formats,
14050         [retval] out DragAndDropAction resultAction
14051     );
14052 
14082     void dragHGMove (
14083         in unsigned long screenId,
14084         in unsigned long x,
14085         in unsigned long y,
14086         in DragAndDropAction defaultAction,
14087         in DragAndDropAction[] allowedActions,
14088         in wstring[] formats,
14089         [retval] out DragAndDropAction resultAction
14090     );
14091 
14109     void dragHGLeave (
14110         in unsigned long screenId
14111     );
14112 
14144     void dragHGDrop (
14145         in unsigned long screenId,
14146         in unsigned long x,
14147         in unsigned long y,
14148         in DragAndDropAction defaultAction,
14149         in DragAndDropAction[] allowedActions,
14150         in wstring[] formats,
14151         out wstring format,
14152         [retval] out DragAndDropAction resultAction
14153     );
14154 
14178     void dragHGPutData (
14179         in unsigned long screenId,
14180         in wstring format,
14181         in octet[] data,
14182         [retval] out IProgress progress
14183     );
14184 
14210     void dragGHPending (
14211         in unsigned long screenId,
14212         out wstring[] format,
14213         out DragAndDropAction[] allowedActions,
14214         [retval] out DragAndDropAction defaultAction
14215     );
14216 
14238     void dragGHDropped (
14239         in wstring format,
14240         in DragAndDropAction action,
14241         [retval] out IProgress progress
14242     );
14243 
14261     void dragGHGetData (
14262         [retval] out octet[] data
14263     );
14264 
14319     void createSession (
14320         in wstring user,
14321         in wstring password,
14322         in wstring domain,
14323         in wstring sessionName,
14324         [retval] out IGuestSession guestSession
14325     );
14326 
14341     void findSession (
14342         in wstring sessionName,
14343         [retval] out IGuestSession[] sessions
14344     );
14345 
14389     void updateGuestAdditions (
14390         in wstring source,
14391         in AdditionsUpdateFlag[] flags,
14392         [retval] out IProgress progress
14393     );
14394 
14395 }; /* interface IGuest */
14396 
14437 interface IProgress : $unknown
14438 {
14442     readonly attribute wstringUUID id;
14443 
14447     readonly attribute wstring description;
14448 
14452     readonly attribute $unknown initiator;
14453 
14457     readonly attribute boolean cancelable;
14458 
14466     readonly attribute unsigned long percent;
14467 
14481     readonly attribute long timeRemaining;
14482 
14486     readonly attribute boolean completed;
14487 
14491     readonly attribute boolean canceled;
14492 
14499     readonly attribute long resultCode;
14500 
14510     readonly attribute IVirtualBoxErrorInfo errorInfo;
14511 
14518     readonly attribute unsigned long operationCount;
14519 
14523     readonly attribute unsigned long operation;
14524 
14530     readonly attribute wstring operationDescription;
14531 
14535     readonly attribute unsigned long operationPercent;
14536 
14540     readonly attribute unsigned long operationWeight;
14541 
14549     attribute unsigned long timeout;
14550 
14554     void setCurrentOperationProgress (
14555         in unsigned long percent
14556     );
14557 
14561     void setNextOperation (
14562         in wstring nextOperationDescription,
14563         in unsigned long nextOperationsWeight
14564     );
14565 
14592     void waitForCompletion (
14593         in long timeout
14594     );
14595 
14619     void waitForOperationCompletion (
14620         in unsigned long operation,
14621         in long timeout
14622     );
14623 
14649     void waitForAsyncProgressCompletion (
14650         in IProgress pProgressAsync
14651     );
14652 
14669     void cancel();
14670 
14671 }; /* interface IProgress */
14672 
14756 interface ISnapshot : $unknown
14757 {
14761     readonly attribute wstringUUID id;
14762 
14770     attribute wstring name;
14771 
14779     attribute wstring description;
14780 
14786     readonly attribute long long timeStamp;
14787 
14799     readonly attribute boolean online;
14800 
14812     readonly attribute IMachine machine;
14813 
14820     readonly attribute ISnapshot parent;
14821 
14830     readonly attribute ISnapshot[] children;
14831 
14839     void getChildrenCount (
14840         [retval] out unsigned long childrenCount
14841     );
14842 
14843 }; /* interface ISnapshot */
14844 
15031 interface IMediumAttachment : $unknown
15032 {
15037     readonly attribute IMedium medium;
15038 
15044     readonly attribute wstring controller;
15045 
15051     readonly attribute long port;
15052 
15058     readonly attribute long device;
15059 
15063     readonly attribute DeviceType type;
15064 
15068     readonly attribute boolean passthrough;
15069 
15073     readonly attribute boolean temporaryEject;
15074 
15079     readonly attribute boolean isEjected;
15080 
15084     readonly attribute boolean nonRotational;
15085 
15089     readonly attribute boolean discard;
15090 
15094     readonly attribute IBandwidthGroup bandwidthGroup;
15095 
15096 }; /* interface IMediumAttachment */
15097 
15255 interface IMedium : $unknown
15256 {
15270     readonly attribute wstringUUID id;
15271 
15290     attribute wstring description;
15291 
15307     readonly attribute MediumState state;
15308 
15317     readonly attribute unsigned long variant;
15318 
15340     attribute wstring location;
15341 
15361     readonly attribute wstring name;
15362 
15367     readonly attribute DeviceType deviceType;
15368 
15372     readonly attribute boolean hostDrive;
15373 
15386     readonly attribute long long size;
15387 
15402     readonly attribute wstring format;
15403 
15419     readonly attribute IMediumFormat mediumFormat;
15420 
15445     attribute MediumType type;
15446 
15460     readonly attribute MediumType[] allowedTypes;
15461 
15471     readonly attribute IMedium parent;
15472 
15480     readonly attribute IMedium[] children;
15481 
15492     readonly attribute IMedium base;
15493 
15526     readonly attribute boolean readOnly;
15527 
15548     readonly attribute long long logicalSize;
15549 
15577     attribute boolean autoReset;
15578 
15593     readonly attribute wstring lastAccessError;
15594 
15611     readonly attribute wstringUUID[] machineIds;
15612 
15638     void setIds (
15639         in boolean setImageId,
15640         in wstringUUID imageId,
15641         in boolean setParentId,
15642         in wstringUUID parentId
15643     );
15644 
15679     void refreshState (
15680         [retval] out MediumState state
15681     );
15682 
15709     void getSnapshotIds (
15710         in wstringUUID machineId,
15711         [retval] out wstringUUID[] snapshotIds
15712     );
15713 
15773     void lockRead (
15774         [retval] out MediumState state
15775     );
15776 
15799     void unlockRead (
15800         [retval] out MediumState state
15801     );
15802 
15857     void lockWrite (
15858         [retval] out MediumState state
15859     );
15860 
15883     void unlockWrite (
15884         [retval] out MediumState state
15885     );
15886 
15936     void close();
15937 
15967     void getProperty (
15968         in wstring name,
15969         [retval] out wstring value
15970     );
15971 
16003     void setProperty (
16004         in wstring name,
16005         in wstring value
16006     );
16007 
16042     void getProperties (
16043         in wstring names,
16044         out wstring[] returnNames,
16045         [retval] out wstring[] returnValues
16046     );
16047 
16077     void setProperties (
16078         in wstring[] names,
16079         in wstring[] values
16080     );
16081 
16114     void createBaseStorage (
16115         in long long logicalSize,
16116         in unsigned long variant,
16117         [retval] out IProgress progress
16118     );
16119 
16171     void deleteStorage (
16172         [retval] out IProgress progress
16173     );
16174 
16213     void createDiffStorage (
16214         in IMedium target,
16215         in unsigned long variant,
16216         [retval] out IProgress progress
16217     );
16218 
16294     void mergeTo (
16295         in IMedium target,
16296         [retval] out IProgress progress
16297     );
16298 
16348     void cloneTo (
16349         in IMedium target,
16350         in unsigned long variant,
16351         in IMedium parent,
16352         [retval] out IProgress progress
16353     );
16354 
16402     void cloneToBase (
16403         in IMedium target,
16404         in unsigned long variant,
16405         [retval] out IProgress progress
16406     );
16407 
16436     void compact (
16437         [retval] out IProgress progress
16438     );
16439 
16472     void resize (
16473         in long long logicalSize,
16474         [retval] out IProgress progress
16475     );
16476 
16510     void reset (
16511         [retval] out IProgress progress
16512     );
16513 
16514 }; /* interface IMedium */
16515 
16538 interface IMediumFormat : $unknown
16539 {
16558     readonly attribute wstring id;
16559 
16567     readonly attribute wstring name;
16568 
16577     readonly attribute unsigned long capabilities;
16578 
16597     void describeFileExtensions (
16598         out wstring[] extensions,
16599         out DeviceType[] type
16600     );
16601 
16629     void describeProperties (
16630         out wstring[] names,
16631         out wstring[] description,
16632         out DataType[] types,
16633         out unsigned long[] flags,
16634         out wstring[] defaults
16635     );
16636 
16637 }; /* interface IMediumFormat */
16638 
16651 interface IKeyboard : $unknown
16652 {
16658     readonly attribute IEventSource eventSource;
16659 
16672     void putScancode (
16673         in long scancode
16674     );
16675 
16688     void putScancodes (
16689         in long[] scancodes,
16690         [retval] out unsigned long codesStored
16691     );
16692 
16707     void putCAD();
16708 
16709 }; /* interface IKeyboard */
16710 
16722 interface IMouse : $unknown
16723 {
16738     readonly attribute boolean absoluteSupported;
16739 
16754     readonly attribute boolean relativeSupported;
16755 
16770     readonly attribute boolean needsHostCursor;
16771 
16777     readonly attribute IEventSource eventSource;
16778 
16844     void putMouseEvent (
16845         in long dx,
16846         in long dy,
16847         in long dz,
16848         in long dw,
16849         in long buttonState
16850     );
16851 
16924     void putMouseEventAbsolute (
16925         in long x,
16926         in long y,
16927         in long dz,
16928         in long dw,
16929         in long buttonState
16930     );
16931 
16932 }; /* interface IMouse */
16933 
16934 interface IFramebuffer : $unknown
16935 {
16944     readonly attribute octetPtr address;
16945 
16949     readonly attribute unsigned long width;
16950 
16954     readonly attribute unsigned long height;
16955 
16962     readonly attribute unsigned long bitsPerPixel;
16963 
16970     readonly attribute unsigned long bytesPerLine;
16971 
16982     readonly attribute unsigned long pixelFormat;
16983 
16990     readonly attribute boolean usesGuestVRAM;
16991 
17001     readonly attribute unsigned long heightReduction;
17002 
17017     readonly attribute IFramebufferOverlay overlay;
17018 
17025     readonly attribute long long winId;
17026 
17034     void lock();
17035 
17043     void unlock();
17044 
17052     void notifyUpdate (
17053         in unsigned long x,
17054         in unsigned long y,
17055         in unsigned long width,
17056         in unsigned long height
17057     );
17058 
17171     void requestResize (
17172         in unsigned long screenId,
17173         in unsigned long pixelFormat,
17174         in octetPtr VRAM,
17175         in unsigned long bitsPerPixel,
17176         in unsigned long bytesPerLine,
17177         in unsigned long width,
17178         in unsigned long height,
17179         [retval] out boolean finished
17180     );
17181 
17193     void videoModeSupported (
17194         in unsigned long width,
17195         in unsigned long height,
17196         in unsigned long bpp,
17197         [retval] out boolean supported
17198     );
17199 
17236     void getVisibleRegion (
17237         in octetPtr rectangles,
17238         in unsigned long count,
17239         [retval] out unsigned long countCopied
17240     );
17241 
17276     void setVisibleRegion (
17277         in octetPtr rectangles,
17278         in unsigned long count
17279     );
17280 
17301     void processVHWACommand (
17302         in octetPtr command
17303     );
17304 
17305 }; /* interface IFramebuffer */
17306 
17321 interface IFramebufferOverlay : IFramebuffer
17322 {
17326     readonly attribute unsigned long x;
17327 
17331     readonly attribute unsigned long y;
17332 
17338     attribute boolean visible;
17339 
17346     attribute unsigned long alpha;
17347 
17353     void move (
17354         in unsigned long x,
17355         in unsigned long y
17356     );
17357 
17358 }; /* interface IFramebufferOverlay */
17359 
17375 interface IDisplay : $unknown
17376 {
17380     void getScreenResolution (
17381         in unsigned long screenId,
17382         out unsigned long width,
17383         out unsigned long height,
17384         out unsigned long bitsPerPixel
17385     );
17386 
17392     void setFramebuffer (
17393         in unsigned long screenId,
17394         in IFramebuffer framebuffer
17395     );
17396 
17402     void getFramebuffer (
17403         in unsigned long screenId,
17404         out IFramebuffer framebuffer,
17405         out long xOrigin,
17406         out long yOrigin
17407     );
17408 
17459     void setVideoModeHint (
17460         in unsigned long display,
17461         in boolean enabled,
17462         in boolean changeOrigin,
17463         in long originX,
17464         in long originY,
17465         in unsigned long width,
17466         in unsigned long height,
17467         in unsigned long bitsPerPixel
17468     );
17469 
17481     void setSeamlessMode (
17482         in boolean enabled
17483     );
17484 
17520     void takeScreenShot (
17521         in unsigned long screenId,
17522         in octetPtr address,
17523         in unsigned long width,
17524         in unsigned long height
17525     );
17526 
17570     void takeScreenShotToArray (
17571         in unsigned long screenId,
17572         in unsigned long width,
17573         in unsigned long height,
17574         [retval] out octet[] screenData
17575     );
17576 
17615     void takeScreenShotPNGToArray (
17616         in unsigned long screenId,
17617         in unsigned long width,
17618         in unsigned long height,
17619         [retval] out octet[] screenData
17620     );
17621 
17673     void drawToScreen (
17674         in unsigned long screenId,
17675         in octetPtr address,
17676         in unsigned long x,
17677         in unsigned long y,
17678         in unsigned long width,
17679         in unsigned long height
17680     );
17681 
17696     void invalidateAndUpdate();
17697 
17711     void resizeCompleted (
17712         in unsigned long screenId
17713     );
17714 
17727     void completeVHWACommand (
17728         in octetPtr command
17729     );
17730 
17764     void viewportChanged (
17765         in unsigned long screenId,
17766         in unsigned long x,
17767         in unsigned long y,
17768         in unsigned long width,
17769         in unsigned long height
17770     );
17771 
17772 }; /* interface IDisplay */
17773 
17789 interface INetworkAdapter : $unknown
17790 {
17798     attribute NetworkAdapterType adapterType;
17799 
17807     readonly attribute unsigned long slot;
17808 
17817     attribute boolean enabled;
17818 
17825     attribute wstring MACAddress;
17826 
17832     attribute NetworkAttachmentType attachmentType;
17833 
17839     attribute wstring bridgedInterface;
17840 
17846     attribute wstring hostOnlyInterface;
17847 
17853     attribute wstring internalNetwork;
17854 
17860     attribute wstring NATNetwork;
17861 
17867     attribute wstring genericDriver;
17868 
17875     attribute boolean cableConnected;
17876 
17882     attribute unsigned long lineSpeed;
17883 
17890     attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
17891 
17898     attribute boolean traceEnabled;
17899 
17906     attribute wstring traceFile;
17907 
17915     readonly attribute INATEngine NATEngine;
17916 
17923     attribute unsigned long bootPriority;
17924 
17928     attribute IBandwidthGroup bandwidthGroup;
17929 
17948     void getProperty (
17949         in wstring key,
17950         [retval] out wstring value
17951     );
17952 
17971     void setProperty (
17972         in wstring key,
17973         in wstring value
17974     );
17975 
18003     void getProperties (
18004         in wstring names,
18005         out wstring[] returnNames,
18006         [retval] out wstring[] returnValues
18007     );
18008 
18009 }; /* interface INetworkAdapter */
18010 
18039 interface ISerialPort : $unknown
18040 {
18048     readonly attribute unsigned long slot;
18049 
18056     attribute boolean enabled;
18057 
18061     attribute unsigned long IOBase;
18062 
18066     attribute unsigned long IRQ;
18067 
18078     attribute PortMode hostMode;
18079 
18087     attribute boolean server;
18088 
18098     attribute wstring path;
18099 
18100 }; /* interface ISerialPort */
18101 
18121 interface IParallelPort : $unknown
18122 {
18130     readonly attribute unsigned long slot;
18131 
18138     attribute boolean enabled;
18139 
18143     attribute unsigned long IOBase;
18144 
18148     attribute unsigned long IRQ;
18149 
18157     attribute wstring path;
18158 
18159 }; /* interface IParallelPort */
18160 
18161 interface IMachineDebugger : $unknown
18162 {
18166     attribute boolean singleStep;
18167 
18171     attribute boolean recompileUser;
18172 
18176     attribute boolean recompileSupervisor;
18177 
18181     attribute boolean PATMEnabled;
18182 
18186     attribute boolean CSAMEnabled;
18187 
18191     attribute boolean logEnabled;
18192 
18196     readonly attribute wstring logDbgFlags;
18197 
18201     readonly attribute wstring logDbgGroups;
18202 
18206     readonly attribute wstring logDbgDestinations;
18207 
18211     readonly attribute wstring logRelFlags;
18212 
18216     readonly attribute wstring logRelGroups;
18217 
18221     readonly attribute wstring logRelDestinations;
18222 
18229     readonly attribute boolean HWVirtExEnabled;
18230 
18237     readonly attribute boolean HWVirtExNestedPagingEnabled;
18238 
18245     readonly attribute boolean HWVirtExVPIDEnabled;
18246 
18255     readonly attribute wstring OSName;
18256 
18265     readonly attribute wstring OSVersion;
18266 
18273     readonly attribute boolean PAEEnabled;
18274 
18281     attribute unsigned long virtualTimeRate;
18282 
18289     readonly attribute long long VM;
18290 
18306     void dumpGuestCore (
18307         in wstring filename,
18308         in wstring compression
18309     );
18310 
18327     void dumpHostProcessCore (
18328         in wstring filename,
18329         in wstring compression
18330     );
18331 
18352     void info (
18353         in wstring name,
18354         in wstring args,
18355         [retval] out wstring info
18356     );
18357 
18363     void injectNMI();
18364 
18375     void modifyLogGroups (
18376         in wstring settings
18377     );
18378 
18389     void modifyLogFlags (
18390         in wstring settings
18391     );
18392 
18403     void modifyLogDestinations (
18404         in wstring settings
18405     );
18406 
18421     void readPhysicalMemory (
18422         in long long address,
18423         in unsigned long size,
18424         [retval] out octet[] bytes
18425     );
18426 
18441     void writePhysicalMemory (
18442         in long long address,
18443         in unsigned long size,
18444         in octet[] bytes
18445     );
18446 
18463     void readVirtualMemory (
18464         in unsigned long cpuId,
18465         in long long address,
18466         in unsigned long size,
18467         [retval] out octet[] bytes
18468     );
18469 
18486     void writeVirtualMemory (
18487         in unsigned long cpuId,
18488         in long long address,
18489         in unsigned long size,
18490         in octet[] bytes
18491     );
18492 
18505     void detectOS (
18506         [retval] out wstring os
18507     );
18508 
18526     void getRegister (
18527         in unsigned long cpuId,
18528         in wstring name,
18529         [retval] out wstring value
18530     );
18531 
18549     void getRegisters (
18550         in unsigned long cpuId,
18551         out wstring[] names,
18552         out wstring[] values
18553     );
18554 
18573     void setRegister (
18574         in unsigned long cpuId,
18575         in wstring name,
18576         in wstring value
18577     );
18578 
18597     void setRegisters (
18598         in unsigned long cpuId,
18599         in wstring[] names,
18600         in wstring[] values
18601     );
18602 
18615     void dumpGuestStack (
18616         in unsigned long cpuId,
18617         [retval] out wstring stack
18618     );
18619 
18627     void resetStats (
18628         in wstring pattern
18629     );
18630 
18638     void dumpStats (
18639         in wstring pattern
18640     );
18641 
18653     void getStats (
18654         in wstring pattern,
18655         in boolean withDescriptions,
18656         out wstring stats
18657     );
18658 
18659 }; /* interface IMachineDebugger */
18660 
18661 interface IUSBController : $unknown
18662 {
18671     attribute boolean enabled;
18672 
18681     attribute boolean enabledEHCI;
18682 
18688     readonly attribute boolean proxyAvailable;
18689 
18697     readonly attribute unsigned short USBStandard;
18698 
18724     readonly attribute IUSBDeviceFilter[] deviceFilters;
18725 
18753     void createDeviceFilter (
18754         in wstring name,
18755         [retval] out IUSBDeviceFilter filter
18756     );
18757 
18802     void insertDeviceFilter (
18803         in unsigned long position,
18804         in IUSBDeviceFilter filter
18805     );
18806 
18839     void removeDeviceFilter (
18840         in unsigned long position,
18841         [retval] out IUSBDeviceFilter filter
18842     );
18843 
18844 }; /* interface IUSBController */
18845 
18858 interface IUSBDevice : $unknown
18859 {
18866     readonly attribute wstringUUID id;
18867 
18871     readonly attribute unsigned short vendorId;
18872 
18876     readonly attribute unsigned short productId;
18877 
18885     readonly attribute unsigned short revision;
18886 
18890     readonly attribute wstring manufacturer;
18891 
18895     readonly attribute wstring product;
18896 
18900     readonly attribute wstring serialNumber;
18901 
18905     readonly attribute wstring address;
18906 
18913     readonly attribute unsigned short port;
18914 
18920     readonly attribute unsigned short version;
18921 
18929     readonly attribute unsigned short portVersion;
18930 
18937     readonly attribute boolean remote;
18938 
18939 }; /* interface IUSBDevice */
18940 
19015 interface IUSBDeviceFilter : $unknown
19016 {
19024     attribute wstring name;
19025 
19029     attribute boolean active;
19030 
19038     attribute wstring vendorId;
19039 
19047     attribute wstring productId;
19048 
19062     attribute wstring revision;
19063 
19068     attribute wstring manufacturer;
19069 
19074     attribute wstring product;
19075 
19080     attribute wstring serialNumber;
19081 
19086     attribute wstring port;
19087 
19097     attribute wstring remote;
19098 
19108     attribute unsigned long maskedInterfaces;
19109 
19110 }; /* interface IUSBDeviceFilter */
19111 
19128 interface IHostUSBDevice : IUSBDevice
19129 {
19135     readonly attribute USBDeviceState state;
19136 
19137 }; /* interface IHostUSBDevice */
19138 
19161 interface IHostUSBDeviceFilter : IUSBDeviceFilter
19162 {
19169     attribute USBDeviceFilterAction action;
19170 
19171 }; /* interface IHostUSBDeviceFilter */
19172 
19181 interface IAudioAdapter : $unknown
19182 {
19191     attribute boolean enabled;
19192 
19198     attribute AudioControllerType audioController;
19199 
19206     attribute AudioDriverType audioDriver;
19207 
19208 }; /* interface IAudioAdapter */
19209 
19210 interface IVRDEServer : $unknown
19211 {
19215     attribute boolean enabled;
19216 
19220     attribute AuthType authType;
19221 
19225     attribute unsigned long authTimeout;
19226 
19233     attribute boolean allowMultiConnection;
19234 
19242     attribute boolean reuseSingleConnection;
19243 
19250     attribute wstring VRDEExtPack;
19251 
19258     attribute wstring authLibrary;
19259 
19265     readonly attribute wstring[] VRDEProperties;
19266 
19280     void setVRDEProperty (
19281         in wstring key,
19282         in wstring value
19283     );
19284 
19298     void getVRDEProperty (
19299         in wstring key,
19300         [retval] out wstring value
19301     );
19302 
19303 }; /* interface IVRDEServer */
19304 
19362 interface ISharedFolder : $unknown
19363 {
19367     readonly attribute wstring name;
19368 
19372     readonly attribute wstring hostPath;
19373 
19383     readonly attribute boolean accessible;
19384 
19391     readonly attribute boolean writable;
19392 
19398     readonly attribute boolean autoMount;
19399 
19412     readonly attribute wstring lastAccessError;
19413 
19414 }; /* interface ISharedFolder */
19415 
19416 interface IInternalSessionControl : $unknown
19417 {
19422     void getPID (
19423         [retval] out unsigned long pid
19424     );
19425 
19447     void getRemoteConsole (
19448         [retval] out IConsole console
19449     );
19450 
19474     void assignMachine (
19475         in IMachine machine,
19476         in LockType lockType
19477     );
19478 
19493     void assignRemoteMachine (
19494         in IMachine machine,
19495         in IConsole console
19496     );
19497 
19521     void updateMachineState (
19522         in MachineState aMachineState
19523     );
19524 
19540     void uninitialize();
19541 
19564     void onNetworkAdapterChange (
19565         in INetworkAdapter networkAdapter,
19566         in boolean changeAdapter
19567     );
19568 
19591     void onSerialPortChange (
19592         in ISerialPort serialPort
19593     );
19594 
19617     void onParallelPortChange (
19618         in IParallelPort parallelPort
19619     );
19620 
19643     void onStorageControllerChange();
19644 
19671     void onMediumChange (
19672         in IMediumAttachment mediumAttachment,
19673         in boolean force
19674     );
19675 
19702     void onStorageDeviceChange (
19703         in IMediumAttachment mediumAttachment,
19704         in boolean remove
19705     );
19706 
19714     void onClipboardModeChange (
19715         in ClipboardMode clipboardMode
19716     );
19717 
19725     void onDragAndDropModeChange (
19726         in DragAndDropMode dragAndDropMode
19727     );
19728 
19738     void onCPUChange (
19739         in unsigned long cpu,
19740         in boolean add
19741     );
19742 
19750     void onCPUExecutionCapChange (
19751         in unsigned long executionCap
19752     );
19753 
19778     void onVRDEServerChange (
19779         in boolean restart
19780     );
19781 
19804     void onUSBControllerChange();
19805 
19834     void onSharedFolderChange (
19835         in boolean global
19836     );
19837 
19863     void onUSBDeviceAttach (
19864         in IUSBDevice device,
19865         in IVirtualBoxErrorInfo error,
19866         in unsigned long maskedInterfaces
19867     );
19868 
19894     void onUSBDeviceDetach (
19895         in wstringUUID id,
19896         in IVirtualBoxErrorInfo error
19897     );
19898 
19916     void onShowWindow (
19917         in boolean check,
19918         out boolean canShow,
19919         out long long winId
19920     );
19921 
19929     void onBandwidthGroupChange (
19930         in IBandwidthGroup bandwidthGroup
19931     );
19932 
19956     void accessGuestProperty (
19957         in wstring name,
19958         in wstring value,
19959         in wstring flags,
19960         in boolean isSetter,
19961         out wstring retValue,
19962         out long long retTimestamp,
19963         out wstring retFlags
19964     );
19965 
20013     void enumerateGuestProperties (
20014         in wstring patterns,
20015         out wstring[] key,
20016         out wstring[] value,
20017         out long long[] timestamp,
20018         out wstring[] flags
20019     );
20020 
20066     void onlineMergeMedium (
20067         in IMediumAttachment mediumAttachment,
20068         in unsigned long sourceIdx,
20069         in unsigned long targetIdx,
20070         in IMedium source,
20071         in IMedium target,
20072         in boolean mergeForward,
20073         in IMedium parentForTarget,
20074         in IMedium[] childrenToReparent,
20075         in IProgress progress
20076     );
20077 
20101     void enableVMMStatistics (
20102         in boolean enable
20103     );
20104 
20105 }; /* interface IInternalSessionControl */
20106 
20165 interface ISession : $unknown
20166 {
20170     readonly attribute SessionState state;
20171 
20179     readonly attribute SessionType type;
20180 
20184     readonly attribute IMachine machine;
20185 
20189     readonly attribute IConsole console;
20190 
20222     void unlockMachine();
20223 
20224 }; /* interface ISession */
20225 
20248 interface IStorageController : $unknown
20249 {
20258     readonly attribute wstring name;
20259 
20265     readonly attribute unsigned long maxDevicesPerPortCount;
20266 
20272     readonly attribute unsigned long minPortCount;
20273 
20279     readonly attribute unsigned long maxPortCount;
20280 
20286     attribute unsigned long instance;
20287 
20296     attribute unsigned long portCount;
20297 
20303     readonly attribute StorageBus bus;
20304 
20317     attribute StorageControllerType controllerType;
20318 
20333     attribute boolean useHostIOCache;
20334 
20340     readonly attribute boolean bootable;
20341 
20342 }; /* interface IStorageController */
20343 
20367 interface IManagedObjectRef : $unknown
20368 {
20375     void getInterfaceName (
20376         [retval] out wstring return
20377     );
20378 
20386     void release();
20387 
20388 }; /* interface IManagedObjectRef */
20389 
20398 interface IWebsessionManager : $unknown
20399 {
20408     void logon (
20409         in wstring username,
20410         in wstring password,
20411         [retval] out IVirtualBox return
20412     );
20413 
20423     void getSessionObject (
20424         in IVirtualBox refIVirtualBox,
20425         [retval] out ISession return
20426     );
20427 
20435     void logoff (
20436         in IVirtualBox refIVirtualBox
20437     );
20438 
20439 }; /* interface IWebsessionManager */
20440 
20449 interface IPerformanceMetric : $unknown
20450 {
20456     readonly attribute wstring metricName;
20457 
20463     readonly attribute $unknown object;
20464 
20470     readonly attribute wstring description;
20471 
20477     readonly attribute unsigned long period;
20478 
20488     readonly attribute unsigned long count;
20489 
20495     readonly attribute wstring unit;
20496 
20502     readonly attribute long minimumValue;
20503 
20509     readonly attribute long maximumValue;
20510 
20511 }; /* interface IPerformanceMetric */
20512 
20619 interface IPerformanceCollector : $unknown
20620 {
20631     readonly attribute wstring[] metricNames;
20632 
20656     void getMetrics (
20657         in wstring[] metricNames,
20658         in $unknown[] objects,
20659         [retval] out IPerformanceMetric[] metrics
20660     );
20661 
20700     void setupMetrics (
20701         in wstring[] metricNames,
20702         in $unknown[] objects,
20703         in unsigned long period,
20704         in unsigned long count,
20705         [retval] out IPerformanceMetric[] affectedMetrics
20706     );
20707 
20736     void enableMetrics (
20737         in wstring[] metricNames,
20738         in $unknown[] objects,
20739         [retval] out IPerformanceMetric[] affectedMetrics
20740     );
20741 
20770     void disableMetrics (
20771         in wstring[] metricNames,
20772         in $unknown[] objects,
20773         [retval] out IPerformanceMetric[] affectedMetrics
20774     );
20775 
20864     void queryMetricsData (
20865         in wstring[] metricNames,
20866         in $unknown[] objects,
20867         out wstring[] returnMetricNames,
20868         out $unknown[] returnObjects,
20869         out wstring[] returnUnits,
20870         out unsigned long[] returnScales,
20871         out unsigned long[] returnSequenceNumbers,
20872         out unsigned long[] returnDataIndices,
20873         out unsigned long[] returnDataLengths,
20874         [retval] out long[] returnData
20875     );
20876 
20877 }; /* interface IPerformanceCollector */
20878 
20886 interface INATEngine : $unknown
20887 {
20892     attribute wstring network;
20893 
20900     attribute wstring hostIP;
20901 
20906     attribute wstring TFTPPrefix;
20907 
20912     attribute wstring TFTPBootFile;
20913 
20921     attribute wstring TFTPNextServer;
20922 
20926     attribute unsigned long aliasMode;
20927 
20931     attribute boolean DNSPassDomain;
20932 
20937     attribute boolean DNSProxy;
20938 
20943     attribute boolean DNSUseHostResolver;
20944 
20949     readonly attribute wstring[] redirects;
20950 
20966     void setNetworkSettings (
20967         in unsigned long mtu,
20968         in unsigned long sockSnd,
20969         in unsigned long sockRcv,
20970         in unsigned long TcpWndSnd,
20971         in unsigned long TcpWndRcv
20972     );
20973 
20978     void getNetworkSettings (
20979         out unsigned long mtu,
20980         out unsigned long sockSnd,
20981         out unsigned long sockRcv,
20982         out unsigned long TcpWndSnd,
20983         out unsigned long TcpWndRcv
20984     );
20985 
21005     void addRedirect (
21006         in wstring name,
21007         in NATProtocol proto,
21008         in wstring hostIP,
21009         in unsigned short hostPort,
21010         in wstring guestIP,
21011         in unsigned short guestPort
21012     );
21013 
21019     void removeRedirect (
21020         in wstring name
21021     );
21022 
21023 }; /* interface INATEngine */
21024 
21033 interface IExtPackPlugIn : $unknown
21034 {
21038     readonly attribute wstring name;
21039 
21043     readonly attribute wstring description;
21044 
21050     readonly attribute wstring frontend;
21051 
21055     readonly attribute wstring modulePath;
21056 
21057 }; /* interface IExtPackPlugIn */
21058 
21067 interface IExtPackBase : $unknown
21068 {
21072     readonly attribute wstring name;
21073 
21077     readonly attribute wstring description;
21078 
21090     readonly attribute wstring version;
21091 
21095     readonly attribute unsigned long revision;
21096 
21106     readonly attribute wstring edition;
21107 
21111     readonly attribute wstring VRDEModule;
21112 
21116     readonly attribute IExtPackPlugIn[] plugIns;
21117 
21127     readonly attribute boolean usable;
21128 
21135     readonly attribute wstring whyUnusable;
21136 
21140     readonly attribute boolean showLicense;
21141 
21150     readonly attribute wstring license;
21151 
21175     void queryLicense (
21176         in wstring preferredLocale,
21177         in wstring preferredLanguage,
21178         in wstring format,
21179         [retval] out wstring licenseText
21180     );
21181 
21182 }; /* interface IExtPackBase */
21183 
21192 interface IExtPack : IExtPackBase
21193 {
21205     void queryObject (
21206         in wstring objUuid,
21207         [retval] out $unknown returnInterface
21208     );
21209 
21210 }; /* interface IExtPack */
21211 
21221 interface IExtPackFile : IExtPackBase
21222 {
21228     readonly attribute wstring filePath;
21229 
21248     void install (
21249         in boolean replace,
21250         in wstring displayInfo,
21251         [retval] out IProgress progess
21252     );
21253 
21254 }; /* interface IExtPackFile */
21255 
21266 interface IExtPackManager : $unknown
21267 {
21273     readonly attribute IExtPack[] installedExtPacks;
21274 
21292     void find (
21293         in wstring name,
21294         [retval] out IExtPack returnData
21295     );
21296 
21308     void openExtPackFile (
21309         in wstring path,
21310         [retval] out IExtPackFile file
21311     );
21312 
21331     void uninstall (
21332         in wstring name,
21333         in boolean forcedRemoval,
21334         in wstring displayInfo,
21335         [retval] out IProgress progess
21336     );
21337 
21341     void cleanup();
21342 
21355     void queryAllPlugInsForFrontend (
21356         in wstring frontendName,
21357         [retval] out wstring[] plugInModules
21358     );
21359 
21367     void isExtPackUsable (
21368         in wstring name,
21369         [retval] out boolean usable
21370     );
21371 
21372 }; /* interface IExtPackManager */
21373 
21379 interface IBandwidthGroup : $unknown
21380 {
21384     readonly attribute wstring name;
21385 
21389     readonly attribute BandwidthGroupType type;
21390 
21394     readonly attribute unsigned long reference;
21395 
21400     attribute long long maxBytesPerSec;
21401 
21402 }; /* interface IBandwidthGroup */
21403 
21412 interface IBandwidthControl : $unknown
21413 {
21419     readonly attribute unsigned long numGroups;
21420 
21433     void createBandwidthGroup (
21434         in wstring name,
21435         in BandwidthGroupType type,
21436         in long long maxBytesPerSec
21437     );
21438 
21446     void deleteBandwidthGroup (
21447         in wstring name
21448     );
21449 
21459     void getBandwidthGroup (
21460         in wstring name,
21461         [retval] out IBandwidthGroup bandwidthGroup
21462     );
21463 
21471     void getAllBandwidthGroups (
21472         [retval] out IBandwidthGroup[] bandwidthGroups
21473     );
21474 
21475 }; /* interface IBandwidthControl */
21476 
21489 interface IVirtualBoxClient : $unknown
21490 {
21496     readonly attribute IVirtualBox virtualBox;
21497 
21503     readonly attribute ISession session;
21504 
21510     readonly attribute IEventSource eventSource;
21511 
21512 }; /* interface IVirtualBoxClient */
21513 
21527 interface IEventSource : $unknown
21528 {
21534     void createListener (
21535         [retval] out IEventListener listener
21536     );
21537 
21553     void createAggregator (
21554         in IEventSource[] subordinates,
21555         [retval] out IEventSource result
21556     );
21557 
21590     void registerListener (
21591         in IEventListener listener,
21592         in VBoxEventType[] interesting,
21593         in boolean active
21594     );
21595 
21604     void unregisterListener (
21605         in IEventListener listener
21606     );
21607 
21622     void fireEvent (
21623         in IEvent event,
21624         in long timeout,
21625         [retval] out boolean result
21626     );
21627 
21652     void getEvent (
21653         in IEventListener listener,
21654         in long timeout,
21655         [retval] out IEvent event
21656     );
21657 
21669     void eventProcessed (
21670         in IEventListener listener,
21671         in IEvent event
21672     );
21673 
21674 }; /* interface IEventSource */
21675 
21685 interface IEventListener : $unknown
21686 {
21699     void handleEvent (
21700         in IEvent event
21701     );
21702 
21703 }; /* interface IEventListener */
21704 
21781 interface IEvent : $unknown
21782 {
21788     readonly attribute VBoxEventType type;
21789 
21795     readonly attribute IEventSource source;
21796 
21807     readonly attribute boolean waitable;
21808 
21815     void setProcessed();
21816 
21830     void waitProcessed (
21831         in long timeout,
21832         [retval] out boolean result
21833     );
21834 
21835 }; /* interface IEvent */
21836 
21842 interface IReusableEvent : IEvent
21843 {
21847     readonly attribute unsigned long generation;
21848 
21855     void reuse();
21856 
21857 }; /* interface IReusableEvent */
21858 
21864 interface IMachineEvent : IEvent
21865 {
21869     readonly attribute wstringUUID machineId;
21870 
21871 }; /* interface IMachineEvent */
21872 
21878 interface IMachineStateChangedEvent : IMachineEvent
21879 {
21883     readonly attribute MachineState state;
21884 
21885 }; /* interface IMachineStateChangedEvent */
21886 
21894 interface IMachineDataChangedEvent : IMachineEvent
21895 {
21902     readonly attribute boolean temporary;
21903 
21904 }; /* interface IMachineDataChangedEvent */
21905 
21914 interface IMediumRegisteredEvent : IEvent
21915 {
21919     readonly attribute wstringUUID mediumId;
21920 
21924     readonly attribute DeviceType mediumType;
21925 
21932     readonly attribute boolean registered;
21933 
21934 }; /* interface IMediumRegisteredEvent */
21935 
21944 interface IMachineRegisteredEvent : IMachineEvent
21945 {
21952     readonly attribute boolean registered;
21953 
21954 }; /* interface IMachineRegisteredEvent */
21955 
21965 interface ISessionStateChangedEvent : IMachineEvent
21966 {
21972     readonly attribute SessionState state;
21973 
21974 }; /* interface ISessionStateChangedEvent */
21975 
21983 interface IGuestPropertyChangedEvent : IMachineEvent
21984 {
21990     readonly attribute wstring name;
21991 
21997     readonly attribute wstring value;
21998 
22004     readonly attribute wstring flags;
22005 
22006 }; /* interface IGuestPropertyChangedEvent */
22007 
22013 interface ISnapshotEvent : IMachineEvent
22014 {
22018     readonly attribute wstringUUID snapshotId;
22019 
22020 }; /* interface ISnapshotEvent */
22021 
22031 interface ISnapshotTakenEvent : ISnapshotEvent
22032 {
22033 }; /* interface ISnapshotTakenEvent */
22034 
22051 interface ISnapshotDeletedEvent : ISnapshotEvent
22052 {
22053 }; /* interface ISnapshotDeletedEvent */
22054 
22064 interface ISnapshotChangedEvent : ISnapshotEvent
22065 {
22066 }; /* interface ISnapshotChangedEvent */
22067 
22076 interface IMousePointerShapeChangedEvent : IEvent
22077 {
22083     readonly attribute boolean visible;
22084 
22090     readonly attribute boolean alpha;
22091 
22097     readonly attribute unsigned long xhot;
22098 
22104     readonly attribute unsigned long yhot;
22105 
22111     readonly attribute unsigned long width;
22112 
22118     readonly attribute unsigned long height;
22119 
22152     readonly attribute octet[] shape;
22153 
22154 }; /* interface IMousePointerShapeChangedEvent */
22155 
22164 interface IMouseCapabilityChangedEvent : IEvent
22165 {
22171     readonly attribute boolean supportsAbsolute;
22172 
22178     readonly attribute boolean supportsRelative;
22179 
22185     readonly attribute boolean needsHostCursor;
22186 
22187 }; /* interface IMouseCapabilityChangedEvent */
22188 
22197 interface IKeyboardLedsChangedEvent : IEvent
22198 {
22204     readonly attribute boolean numLock;
22205 
22211     readonly attribute boolean capsLock;
22212 
22218     readonly attribute boolean scrollLock;
22219 
22220 }; /* interface IKeyboardLedsChangedEvent */
22221 
22230 interface IStateChangedEvent : IEvent
22231 {
22237     readonly attribute MachineState state;
22238 
22239 }; /* interface IStateChangedEvent */
22240 
22250 interface IAdditionsStateChangedEvent : IEvent
22251 {
22252 }; /* interface IAdditionsStateChangedEvent */
22253 
22264 interface INetworkAdapterChangedEvent : IEvent
22265 {
22271     readonly attribute INetworkAdapter networkAdapter;
22272 
22273 }; /* interface INetworkAdapterChangedEvent */
22274 
22285 interface ISerialPortChangedEvent : IEvent
22286 {
22292     readonly attribute ISerialPort serialPort;
22293 
22294 }; /* interface ISerialPortChangedEvent */
22295 
22306 interface IParallelPortChangedEvent : IEvent
22307 {
22313     readonly attribute IParallelPort parallelPort;
22314 
22315 }; /* interface IParallelPortChangedEvent */
22316 
22326 interface IStorageControllerChangedEvent : IEvent
22327 {
22328 }; /* interface IStorageControllerChangedEvent */
22329 
22339 interface IMediumChangedEvent : IEvent
22340 {
22346     readonly attribute IMediumAttachment mediumAttachment;
22347 
22348 }; /* interface IMediumChangedEvent */
22349 
22357 interface IClipboardModeChangedEvent : IEvent
22358 {
22364     readonly attribute ClipboardMode clipboardMode;
22365 
22366 }; /* interface IClipboardModeChangedEvent */
22367 
22375 interface IDragAndDropModeChangedEvent : IEvent
22376 {
22382     readonly attribute DragAndDropMode dragAndDropMode;
22383 
22384 }; /* interface IDragAndDropModeChangedEvent */
22385 
22393 interface ICPUChangedEvent : IEvent
22394 {
22400     readonly attribute unsigned long CPU;
22401 
22407     readonly attribute boolean add;
22408 
22409 }; /* interface ICPUChangedEvent */
22410 
22418 interface ICPUExecutionCapChangedEvent : IEvent
22419 {
22425     readonly attribute unsigned long executionCap;
22426 
22427 }; /* interface ICPUExecutionCapChangedEvent */
22428 
22436 interface IGuestKeyboardEvent : IEvent
22437 {
22443     readonly attribute long[] scancodes;
22444 
22445 }; /* interface IGuestKeyboardEvent */
22446 
22454 interface IGuestMouseEvent : IReusableEvent
22455 {
22461     readonly attribute boolean absolute;
22462 
22468     readonly attribute long x;
22469 
22475     readonly attribute long y;
22476 
22482     readonly attribute long z;
22483 
22489     readonly attribute long w;
22490 
22496     readonly attribute long buttons;
22497 
22498 }; /* interface IGuestMouseEvent */
22499 
22510 interface IVRDEServerChangedEvent : IEvent
22511 {
22512 }; /* interface IVRDEServerChangedEvent */
22513 
22523 interface IVRDEServerInfoChangedEvent : IEvent
22524 {
22525 }; /* interface IVRDEServerInfoChangedEvent */
22526 
22537 interface IUSBControllerChangedEvent : IEvent
22538 {
22539 }; /* interface IUSBControllerChangedEvent */
22540 
22564 interface IUSBDeviceStateChangedEvent : IEvent
22565 {
22571     readonly attribute IUSBDevice device;
22572 
22578     readonly attribute boolean attached;
22579 
22585     readonly attribute IVirtualBoxErrorInfo error;
22586 
22587 }; /* interface IUSBDeviceStateChangedEvent */
22588 
22604 interface ISharedFolderChangedEvent : IEvent
22605 {
22611     readonly attribute Scope scope;
22612 
22613 }; /* interface ISharedFolderChangedEvent */
22614 
22666 interface IRuntimeErrorEvent : IEvent
22667 {
22673     readonly attribute boolean fatal;
22674 
22680     readonly attribute wstring id;
22681 
22687     readonly attribute wstring message;
22688 
22689 }; /* interface IRuntimeErrorEvent */
22690 
22698 interface IEventSourceChangedEvent : IEvent
22699 {
22705     readonly attribute IEventListener listener;
22706 
22712     readonly attribute boolean add;
22713 
22714 }; /* interface IEventSourceChangedEvent */
22715 
22724 interface IExtraDataChangedEvent : IEvent
22725 {
22732     readonly attribute wstringUUID machineId;
22733 
22739     readonly attribute wstring key;
22740 
22746     readonly attribute wstring value;
22747 
22748 }; /* interface IExtraDataChangedEvent */
22749 
22755 interface IVetoEvent : IEvent
22756 {
22766     void addVeto (
22767         in wstring reason
22768     );
22769 
22779     void isVetoed (
22780         [retval] out boolean result
22781     );
22782 
22792     void getVetos (
22793         [retval] out wstring[] result
22794     );
22795 
22796 }; /* interface IVetoEvent */
22797 
22807 interface IExtraDataCanChangeEvent : IVetoEvent
22808 {
22815     readonly attribute wstringUUID machineId;
22816 
22822     readonly attribute wstring key;
22823 
22829     readonly attribute wstring value;
22830 
22831 }; /* interface IExtraDataCanChangeEvent */
22832 
22848 interface ICanShowWindowEvent : IVetoEvent
22849 {
22850 }; /* interface ICanShowWindowEvent */
22851 
22883 interface IShowWindowEvent : IEvent
22884 {
22893     attribute long long winId;
22894 
22895 }; /* interface IShowWindowEvent */
22896 
22904 interface INATRedirectEvent : IMachineEvent
22905 {
22911     readonly attribute unsigned long slot;
22912 
22918     readonly attribute boolean remove;
22919 
22925     readonly attribute wstring name;
22926 
22932     readonly attribute NATProtocol proto;
22933 
22939     readonly attribute wstring hostIP;
22940 
22946     readonly attribute long hostPort;
22947 
22953     readonly attribute wstring guestIP;
22954 
22960     readonly attribute long guestPort;
22961 
22962 }; /* interface INATRedirectEvent */
22963 
22976 interface IHostPCIDevicePlugEvent : IMachineEvent
22977 {
22983     readonly attribute boolean plugged;
22984 
22991     readonly attribute boolean success;
22992 
22998     readonly attribute IPCIDeviceAttachment attachment;
22999 
23005     readonly attribute wstring message;
23006 
23007 }; /* interface IHostPCIDevicePlugEvent */
23008 
23017 interface IVBoxSVCAvailabilityChangedEvent : IEvent
23018 {
23024     readonly attribute boolean available;
23025 
23026 }; /* interface IVBoxSVCAvailabilityChangedEvent */
23027 
23035 interface IBandwidthGroupChangedEvent : IEvent
23036 {
23042     readonly attribute IBandwidthGroup bandwidthGroup;
23043 
23044 }; /* interface IBandwidthGroupChangedEvent */
23045 
23053 interface IGuestMonitorChangedEvent : IEvent
23054 {
23060     readonly attribute GuestMonitorChangedEventType changeType;
23061 
23067     readonly attribute unsigned long screenId;
23068 
23075     readonly attribute unsigned long originX;
23076 
23083     readonly attribute unsigned long originY;
23084 
23091     readonly attribute unsigned long width;
23092 
23099     readonly attribute unsigned long height;
23100 
23101 }; /* interface IGuestMonitorChangedEvent */
23102 
23112 interface IStorageDeviceChangedEvent : IEvent
23113 {
23119     readonly attribute IMediumAttachment storageDevice;
23120 
23126     readonly attribute boolean removed;
23127 
23128 }; /* interface IStorageDeviceChangedEvent */
23129 
23130 

Generated on Sat Sep 8 2012 12:57:10 for VirtualBox Main API by  doxygen 1.7.1