• Main Page
  • Related Pages
  • Modules
  • Classes
  • Files
  • File List
  • File Members

VirtualBox.idl

Go to the documentation of this file.
00001 
00002 /*
00003  *  DO NOT EDIT! This is a generated file.
00004  *
00005  *  Doxygen IDL definition for VirtualBox Main API (COM interfaces)
00006  *  generated from XIDL (XML interface definition).
00007  *
00008  *  Source    : src/VBox/Main/idl/VirtualBox.xidl
00009  *  Generator : src/VBox/Main/idl/doxygen.xsl
00010  *
00011  *  This IDL is generated using some generic OMG IDL-like syntax SOLELY
00012  *  for the purpose of generating the documentation using Doxygen and
00013  *  is not syntactically valid.
00014  *
00015  *  DO NOT USE THIS HEADER IN ANY OTHER WAY!
00016  */
00017 
00137 const HRESULT VBOX_E_OBJECT_NOT_FOUND = 0x80BB0001;
00145 const HRESULT VBOX_E_INVALID_VM_STATE = 0x80BB0002;
00153 const HRESULT VBOX_E_VM_ERROR = 0x80BB0003;
00161 const HRESULT VBOX_E_FILE_ERROR = 0x80BB0004;
00169 const HRESULT VBOX_E_IPRT_ERROR = 0x80BB0005;
00177 const HRESULT VBOX_E_PDM_ERROR = 0x80BB0006;
00185 const HRESULT VBOX_E_INVALID_OBJECT_STATE = 0x80BB0007;
00193 const HRESULT VBOX_E_HOST_ERROR = 0x80BB0008;
00201 const HRESULT VBOX_E_NOT_SUPPORTED = 0x80BB0009;
00209 const HRESULT VBOX_E_XML_ERROR = 0x80BB000A;
00217 const HRESULT VBOX_E_INVALID_SESSION_STATE = 0x80BB000B;
00225 const HRESULT VBOX_E_OBJECT_IN_USE = 0x80BB000C;
00235 enum SettingsVersion
00236 {
00241     SettingsVersion_Null = 0,
00246     SettingsVersion_v1_0 = 1,
00251     SettingsVersion_v1_1 = 2,
00256     SettingsVersion_v1_2 = 3,
00261     SettingsVersion_v1_3pre = 4,
00266     SettingsVersion_v1_3 = 5,
00271     SettingsVersion_v1_4 = 6,
00276     SettingsVersion_v1_5 = 7,
00281     SettingsVersion_v1_6 = 8,
00286     SettingsVersion_v1_7 = 9,
00291     SettingsVersion_v1_8 = 10,
00296     SettingsVersion_v1_9 = 11,
00301     SettingsVersion_v1_10 = 12,
00306     SettingsVersion_v1_11 = 13,
00311     SettingsVersion_v1_12 = 14,
00316     SettingsVersion_v1_13 = 15,
00321     SettingsVersion_Future = 99999,
00322 };
00323 
00331 enum AccessMode
00332 {
00333     AccessMode_ReadOnly = 1,
00334     AccessMode_ReadWrite = 2,
00335 };
00336 
00454 enum MachineState
00455 {
00460     MachineState_Null = 0,
00468     MachineState_PoweredOff = 1,
00477     MachineState_Saved = 2,
00486     MachineState_Teleported = 3,
00495     MachineState_Aborted = 4,
00502     MachineState_Running = 5,
00509     MachineState_Paused = 6,
00517     MachineState_Stuck = 7,
00527     MachineState_Teleporting = 8,
00538     MachineState_LiveSnapshotting = 9,
00546     MachineState_Starting = 10,
00554     MachineState_Stopping = 11,
00562     MachineState_Saving = 12,
00570     MachineState_Restoring = 13,
00579     MachineState_TeleportingPausedVM = 14,
00586     MachineState_TeleportingIn = 15,
00593     MachineState_FaultTolerantSyncing = 16,
00601     MachineState_DeletingSnapshotOnline = 17,
00609     MachineState_DeletingSnapshotPaused = 18,
00616     MachineState_RestoringSnapshot = 19,
00625     MachineState_DeletingSnapshot = 20,
00632     MachineState_SettingUp = 21,
00639     MachineState_FirstOnline = 5,
00646     MachineState_LastOnline = 18,
00653     MachineState_FirstTransient = 8,
00660     MachineState_LastTransient = 21,
00661 };
00662 
00672 enum SessionState
00673 {
00678     SessionState_Null = 0,
00689     SessionState_Unlocked = 1,
00703     SessionState_Locked = 2,
00713     SessionState_Spawning = 3,
00720     SessionState_Unlocking = 4,
00721 };
00722 
00731 enum CPUPropertyType
00732 {
00737     CPUPropertyType_Null = 0,
00746     CPUPropertyType_PAE = 1,
00754     CPUPropertyType_Synthetic = 2,
00755 };
00756 
00766 enum HWVirtExPropertyType
00767 {
00772     HWVirtExPropertyType_Null = 0,
00780     HWVirtExPropertyType_Enabled = 1,
00789     HWVirtExPropertyType_Exclusive = 2,
00796     HWVirtExPropertyType_VPID = 3,
00803     HWVirtExPropertyType_NestedPaging = 4,
00810     HWVirtExPropertyType_LargePages = 5,
00818     HWVirtExPropertyType_Force = 6,
00819 };
00820 
00828 enum FaultToleranceState
00829 {
00834     FaultToleranceState_Inactive = 1,
00839     FaultToleranceState_Master = 2,
00844     FaultToleranceState_Standby = 3,
00845 };
00846 
00854 enum LockType
00855 {
00860     LockType_Write = 2,
00865     LockType_Shared = 1,
00871     LockType_VM = 3,
00872 };
00873 
00882 enum SessionType
00883 {
00888     SessionType_Null = 0,
00896     SessionType_WriteLock = 1,
00903     SessionType_Remote = 2,
00910     SessionType_Shared = 3,
00911 };
00912 
00920 enum DeviceType
00921 {
00929     DeviceType_Null = 0,
00934     DeviceType_Floppy = 1,
00939     DeviceType_DVD = 2,
00944     DeviceType_HardDisk = 3,
00949     DeviceType_Network = 4,
00954     DeviceType_USB = 5,
00959     DeviceType_SharedFolder = 6,
00960 };
00961 
00969 enum DeviceActivity
00970 {
00971     DeviceActivity_Null = 0,
00972     DeviceActivity_Idle = 1,
00973     DeviceActivity_Reading = 2,
00974     DeviceActivity_Writing = 3,
00975 };
00976 
00984 enum ClipboardMode
00985 {
00986     ClipboardMode_Disabled = 0,
00987     ClipboardMode_HostToGuest = 1,
00988     ClipboardMode_GuestToHost = 2,
00989     ClipboardMode_Bidirectional = 3,
00990 };
00991 
00999 enum DragAndDropMode
01000 {
01001     DragAndDropMode_Disabled = 0,
01002     DragAndDropMode_HostToGuest = 1,
01003     DragAndDropMode_GuestToHost = 2,
01004     DragAndDropMode_Bidirectional = 3,
01005 };
01006 
01017 enum Scope
01018 {
01019     Scope_Global = 0,
01020     Scope_Machine = 1,
01021     Scope_Session = 2,
01022 };
01023 
01031 enum BIOSBootMenuMode
01032 {
01033     BIOSBootMenuMode_Disabled = 0,
01034     BIOSBootMenuMode_MenuOnly = 1,
01035     BIOSBootMenuMode_MessageAndMenu = 2,
01036 };
01037 
01045 enum ProcessorFeature
01046 {
01047     ProcessorFeature_HWVirtEx = 0,
01048     ProcessorFeature_PAE = 1,
01049     ProcessorFeature_LongMode = 2,
01050     ProcessorFeature_NestedPaging = 3,
01051 };
01052 
01060 enum FirmwareType
01061 {
01066     FirmwareType_BIOS = 1,
01071     FirmwareType_EFI = 2,
01076     FirmwareType_EFI32 = 3,
01081     FirmwareType_EFI64 = 4,
01086     FirmwareType_EFIDUAL = 5,
01087 };
01088 
01096 enum PointingHIDType
01097 {
01102     PointingHIDType_None = 1,
01107     PointingHIDType_PS2Mouse = 2,
01112     PointingHIDType_USBMouse = 3,
01117     PointingHIDType_USBTablet = 4,
01123     PointingHIDType_ComboMouse = 5,
01124 };
01125 
01133 enum KeyboardHIDType
01134 {
01139     KeyboardHIDType_None = 1,
01144     KeyboardHIDType_PS2Keyboard = 2,
01149     KeyboardHIDType_USBKeyboard = 3,
01155     KeyboardHIDType_ComboKeyboard = 4,
01156 };
01157 
01165 enum VFSType
01166 {
01167     VFSType_File = 1,
01168     VFSType_Cloud = 2,
01169     VFSType_S3 = 3,
01170     VFSType_WebDav = 4,
01171 };
01172 
01180 enum VFSFileType
01181 {
01182     VFSFileType_Unknown = 1,
01183     VFSFileType_Fifo = 2,
01184     VFSFileType_DevChar = 3,
01185     VFSFileType_Directory = 4,
01186     VFSFileType_DevBlock = 5,
01187     VFSFileType_File = 6,
01188     VFSFileType_SymLink = 7,
01189     VFSFileType_Socket = 8,
01190     VFSFileType_WhiteOut = 9,
01191 };
01192 
01200 enum ImportOptions
01201 {
01206     ImportOptions_KeepAllMACs = 1,
01211     ImportOptions_KeepNATMACs = 2,
01212 };
01213 
01220 enum VirtualSystemDescriptionType
01221 {
01222     VirtualSystemDescriptionType_Ignore = 1,
01223     VirtualSystemDescriptionType_OS = 2,
01224     VirtualSystemDescriptionType_Name = 3,
01225     VirtualSystemDescriptionType_Product = 4,
01226     VirtualSystemDescriptionType_Vendor = 5,
01227     VirtualSystemDescriptionType_Version = 6,
01228     VirtualSystemDescriptionType_ProductUrl = 7,
01229     VirtualSystemDescriptionType_VendorUrl = 8,
01230     VirtualSystemDescriptionType_Description = 9,
01231     VirtualSystemDescriptionType_License = 10,
01232     VirtualSystemDescriptionType_Miscellaneous = 11,
01233     VirtualSystemDescriptionType_CPU = 12,
01234     VirtualSystemDescriptionType_Memory = 13,
01235     VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
01236     VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
01237     VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
01238     VirtualSystemDescriptionType_HardDiskControllerSAS = 17,
01239     VirtualSystemDescriptionType_HardDiskImage = 18,
01240     VirtualSystemDescriptionType_Floppy = 19,
01241     VirtualSystemDescriptionType_CDROM = 20,
01242     VirtualSystemDescriptionType_NetworkAdapter = 21,
01243     VirtualSystemDescriptionType_USBController = 22,
01244     VirtualSystemDescriptionType_SoundCard = 23,
01249     VirtualSystemDescriptionType_SettingsFile = 24,
01250 };
01251 
01258 enum VirtualSystemDescriptionValueType
01259 {
01260     VirtualSystemDescriptionValueType_Reference = 1,
01261     VirtualSystemDescriptionValueType_Original = 2,
01262     VirtualSystemDescriptionValueType_Auto = 3,
01263     VirtualSystemDescriptionValueType_ExtraConfig = 4,
01264 };
01265 
01272 enum CleanupMode
01273 {
01278     CleanupMode_UnregisterOnly = 1,
01283     CleanupMode_DetachAllReturnNone = 2,
01288     CleanupMode_DetachAllReturnHardDisksOnly = 3,
01293     CleanupMode_Full = 4,
01294 };
01295 
01303 enum CloneMode
01304 {
01309     CloneMode_MachineState = 1,
01314     CloneMode_MachineAndChildStates = 2,
01319     CloneMode_AllStates = 3,
01320 };
01321 
01329 enum CloneOptions
01330 {
01335     CloneOptions_Link = 1,
01340     CloneOptions_KeepAllMACs = 2,
01345     CloneOptions_KeepNATMACs = 3,
01350     CloneOptions_KeepDiskNames = 4,
01351 };
01352 
01360 enum AutostopType
01361 {
01366     AutostopType_Disabled = 1,
01371     AutostopType_SaveState = 2,
01376     AutostopType_PowerOff = 3,
01381     AutostopType_AcpiShutdown = 4,
01382 };
01383 
01394 enum HostNetworkInterfaceMediumType
01395 {
01402     HostNetworkInterfaceMediumType_Unknown = 0,
01409     HostNetworkInterfaceMediumType_Ethernet = 1,
01416     HostNetworkInterfaceMediumType_PPP = 2,
01423     HostNetworkInterfaceMediumType_SLIP = 3,
01424 };
01425 
01435 enum HostNetworkInterfaceStatus
01436 {
01443     HostNetworkInterfaceStatus_Unknown = 0,
01450     HostNetworkInterfaceStatus_Up = 1,
01457     HostNetworkInterfaceStatus_Down = 2,
01458 };
01459 
01467 enum HostNetworkInterfaceType
01468 {
01469     HostNetworkInterfaceType_Bridged = 1,
01470     HostNetworkInterfaceType_HostOnly = 2,
01471 };
01472 
01480 enum AdditionsFacilityType
01481 {
01486     AdditionsFacilityType_None = 0,
01491     AdditionsFacilityType_VBoxGuestDriver = 20,
01496     AdditionsFacilityType_AutoLogon = 90,
01501     AdditionsFacilityType_VBoxService = 100,
01506     AdditionsFacilityType_VBoxTrayClient = 101,
01511     AdditionsFacilityType_Seamless = 1000,
01519     AdditionsFacilityType_Graphics = 1100,
01524     AdditionsFacilityType_All = 2147483646,
01525 };
01526 
01534 enum AdditionsFacilityClass
01535 {
01540     AdditionsFacilityClass_None = 0,
01545     AdditionsFacilityClass_Driver = 10,
01550     AdditionsFacilityClass_Service = 30,
01555     AdditionsFacilityClass_Program = 50,
01560     AdditionsFacilityClass_Feature = 100,
01565     AdditionsFacilityClass_ThirdParty = 999,
01570     AdditionsFacilityClass_All = 2147483646,
01571 };
01572 
01580 enum AdditionsFacilityStatus
01581 {
01586     AdditionsFacilityStatus_Inactive = 0,
01591     AdditionsFacilityStatus_Paused = 1,
01596     AdditionsFacilityStatus_PreInit = 20,
01601     AdditionsFacilityStatus_Init = 30,
01606     AdditionsFacilityStatus_Active = 50,
01611     AdditionsFacilityStatus_Terminating = 100,
01616     AdditionsFacilityStatus_Terminated = 101,
01621     AdditionsFacilityStatus_Failed = 800,
01626     AdditionsFacilityStatus_Unknown = 999,
01627 };
01628 
01636 enum AdditionsRunLevelType
01637 {
01642     AdditionsRunLevelType_None = 0,
01647     AdditionsRunLevelType_System = 1,
01652     AdditionsRunLevelType_Userland = 2,
01657     AdditionsRunLevelType_Desktop = 3,
01658 };
01659 
01667 enum AdditionsUpdateFlag
01668 {
01673     AdditionsUpdateFlag_None = 0,
01679     AdditionsUpdateFlag_WaitForUpdateStartOnly = 1,
01680 };
01681 
01689 enum FileSeekType
01690 {
01695     FileSeekType_Set = 0,
01700     FileSeekType_Current = 1,
01701 };
01702 
01710 enum ProcessInputFlag
01711 {
01716     ProcessInputFlag_None = 0,
01721     ProcessInputFlag_EndOfFile = 1,
01722 };
01723 
01732 enum ProcessOutputFlag
01733 {
01738     ProcessOutputFlag_None = 0,
01743     ProcessOutputFlag_StdErr = 1,
01744 };
01745 
01753 enum ProcessWaitForFlag
01754 {
01759     ProcessWaitForFlag_None = 0,
01764     ProcessWaitForFlag_Start = 1,
01769     ProcessWaitForFlag_Terminate = 2,
01774     ProcessWaitForFlag_StdIn = 4,
01779     ProcessWaitForFlag_StdOut = 8,
01784     ProcessWaitForFlag_StdErr = 16,
01785 };
01786 
01805 enum ProcessWaitResult
01806 {
01811     ProcessWaitResult_None = 0,
01816     ProcessWaitResult_Start = 1,
01821     ProcessWaitResult_Terminate = 2,
01829     ProcessWaitResult_Status = 3,
01834     ProcessWaitResult_Error = 4,
01843     ProcessWaitResult_Timeout = 5,
01850     ProcessWaitResult_StdIn = 6,
01855     ProcessWaitResult_StdOut = 7,
01860     ProcessWaitResult_StdErr = 8,
01868     ProcessWaitResult_WaitFlagNotSupported = 9,
01869 };
01870 
01878 enum CopyFileFlag
01879 {
01884     CopyFileFlag_None = 0,
01889     CopyFileFlag_Recursive = 1,
01894     CopyFileFlag_Update = 2,
01899     CopyFileFlag_FollowLinks = 4,
01900 };
01901 
01909 enum DirectoryCreateFlag
01910 {
01915     DirectoryCreateFlag_None = 0,
01920     DirectoryCreateFlag_Parents = 1,
01921 };
01922 
01930 enum DirectoryRemoveRecFlag
01931 {
01936     DirectoryRemoveRecFlag_None = 0,
01941     DirectoryRemoveRecFlag_ContentAndDir = 1,
01946     DirectoryRemoveRecFlag_ContentOnly = 2,
01947 };
01948 
01956 enum PathRenameFlag
01957 {
01962     PathRenameFlag_None = 0,
01967     PathRenameFlag_NoReplace = 1,
01972     PathRenameFlag_Replace = 2,
01977     PathRenameFlag_NoSymlinks = 4,
01978 };
01979 
01987 enum ProcessCreateFlag
01988 {
01993     ProcessCreateFlag_None = 0,
01999     ProcessCreateFlag_WaitForProcessStartOnly = 1,
02004     ProcessCreateFlag_IgnoreOrphanedProcesses = 2,
02009     ProcessCreateFlag_Hidden = 4,
02014     ProcessCreateFlag_NoProfile = 8,
02019     ProcessCreateFlag_WaitForStdOut = 16,
02024     ProcessCreateFlag_WaitForStdErr = 32,
02029     ProcessCreateFlag_ExpandArguments = 64,
02030 };
02031 
02039 enum ProcessPriority
02040 {
02045     ProcessPriority_Invalid = 0,
02050     ProcessPriority_Default = 1,
02051 };
02052 
02060 enum SymlinkType
02061 {
02066     SymlinkType_Unknown = 0,
02071     SymlinkType_Directory = 1,
02076     SymlinkType_File = 2,
02077 };
02078 
02086 enum SymlinkReadFlag
02087 {
02092     SymlinkReadFlag_None = 0,
02097     SymlinkReadFlag_NoSymlinks = 1,
02098 };
02099 
02107 enum ProcessStatus
02108 {
02113     ProcessStatus_Undefined = 0,
02118     ProcessStatus_Starting = 10,
02123     ProcessStatus_Started = 100,
02128     ProcessStatus_Paused = 110,
02133     ProcessStatus_Terminating = 480,
02138     ProcessStatus_TerminatedNormally = 500,
02143     ProcessStatus_TerminatedSignal = 510,
02148     ProcessStatus_TerminatedAbnormally = 511,
02153     ProcessStatus_TimedOutKilled = 512,
02158     ProcessStatus_TimedOutAbnormally = 513,
02163     ProcessStatus_Down = 600,
02168     ProcessStatus_Error = 800,
02169 };
02170 
02178 enum FsObjType
02179 {
02184     FsObjType_Undefined = 0,
02189     FsObjType_FIFO = 1,
02194     FsObjType_DevChar = 10,
02199     FsObjType_DevBlock = 11,
02204     FsObjType_Directory = 50,
02209     FsObjType_File = 80,
02214     FsObjType_Symlink = 100,
02219     FsObjType_Socket = 200,
02224     FsObjType_Whiteout = 400,
02225 };
02226 
02234 enum DragAndDropAction
02235 {
02240     DragAndDropAction_Ignore = 0,
02245     DragAndDropAction_Copy = 1,
02250     DragAndDropAction_Move = 2,
02255     DragAndDropAction_Link = 3,
02256 };
02257 
02265 enum DirectoryOpenFlag
02266 {
02271     DirectoryOpenFlag_None = 0,
02276     DirectoryOpenFlag_NoSymlinks = 1,
02277 };
02278 
02288 enum MediumState
02289 {
02297     MediumState_NotCreated = 0,
02306     MediumState_Created = 1,
02314     MediumState_LockedRead = 2,
02322     MediumState_LockedWrite = 3,
02332     MediumState_Inaccessible = 4,
02339     MediumState_Creating = 5,
02346     MediumState_Deleting = 6,
02347 };
02348 
02359 enum MediumType
02360 {
02368     MediumType_Normal = 0,
02376     MediumType_Immutable = 1,
02384     MediumType_Writethrough = 2,
02393     MediumType_Shareable = 3,
02402     MediumType_Readonly = 4,
02414     MediumType_MultiAttach = 5,
02415 };
02416 
02426 enum MediumVariant
02427 {
02434     MediumVariant_Standard = 0,
02441     MediumVariant_VmdkSplit2G = 0x01,
02448     MediumVariant_VmdkRawDisk = 0x02,
02456     MediumVariant_VmdkStreamOptimized = 0x04,
02463     MediumVariant_VmdkESX = 0x08,
02470     MediumVariant_Fixed = 0x10000,
02477     MediumVariant_Diff = 0x20000,
02485     MediumVariant_NoCreateDir = 0x40000000,
02486 };
02487 
02488 enum DataType
02489 {
02490     DataType_Int32 = 0,
02491     DataType_Int8 = 1,
02492     DataType_String = 2,
02493 };
02494 
02495 enum DataFlags
02496 {
02497     DataFlags_None = 0x00,
02498     DataFlags_Mandatory = 0x01,
02499     DataFlags_Expert = 0x02,
02500     DataFlags_Array = 0x04,
02501     DataFlags_FlagMask = 0x07,
02502 };
02503 
02511 enum MediumFormatCapabilities
02512 {
02519     MediumFormatCapabilities_Uuid = 0x01,
02526     MediumFormatCapabilities_CreateFixed = 0x02,
02534     MediumFormatCapabilities_CreateDynamic = 0x04,
02541     MediumFormatCapabilities_CreateSplit2G = 0x08,
02548     MediumFormatCapabilities_Differencing = 0x10,
02555     MediumFormatCapabilities_Asynchronous = 0x20,
02565     MediumFormatCapabilities_File = 0x40,
02574     MediumFormatCapabilities_Properties = 0x80,
02581     MediumFormatCapabilities_TcpNetworking = 0x100,
02588     MediumFormatCapabilities_VFS = 0x200,
02589     MediumFormatCapabilities_CapabilityMask = 0x3FF,
02590 };
02591 
02599 enum MouseButtonState
02600 {
02601     MouseButtonState_LeftButton = 0x01,
02602     MouseButtonState_RightButton = 0x02,
02603     MouseButtonState_MiddleButton = 0x04,
02604     MouseButtonState_WheelUp = 0x08,
02605     MouseButtonState_WheelDown = 0x10,
02606     MouseButtonState_XButton1 = 0x20,
02607     MouseButtonState_XButton2 = 0x40,
02608     MouseButtonState_MouseStateMask = 0x7F,
02609 };
02610 
02621 enum FramebufferPixelFormat
02622 {
02630     FramebufferPixelFormat_Opaque = 0,
02638     FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
02639 };
02640 
02648 enum NetworkAttachmentType
02649 {
02654     NetworkAttachmentType_Null = 0,
02655     NetworkAttachmentType_NAT = 1,
02656     NetworkAttachmentType_Bridged = 2,
02657     NetworkAttachmentType_Internal = 3,
02658     NetworkAttachmentType_HostOnly = 4,
02659     NetworkAttachmentType_Generic = 5,
02660 };
02661 
02669 enum NetworkAdapterType
02670 {
02675     NetworkAdapterType_Null = 0,
02680     NetworkAdapterType_Am79C970A = 1,
02685     NetworkAdapterType_Am79C973 = 2,
02690     NetworkAdapterType_I82540EM = 3,
02695     NetworkAdapterType_I82543GC = 4,
02700     NetworkAdapterType_I82545EM = 5,
02705     NetworkAdapterType_Virtio = 6,
02706 };
02707 
02715 enum NetworkAdapterPromiscModePolicy
02716 {
02721     NetworkAdapterPromiscModePolicy_Deny = 1,
02729     NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
02737     NetworkAdapterPromiscModePolicy_AllowAll = 3,
02738 };
02739 
02748 enum PortMode
02749 {
02754     PortMode_Disconnected = 0,
02759     PortMode_HostPipe = 1,
02764     PortMode_HostDevice = 2,
02769     PortMode_RawFile = 3,
02770 };
02771 
02810 enum USBDeviceState
02811 {
02818     USBDeviceState_NotSupported = 0,
02826     USBDeviceState_Unavailable = 1,
02833     USBDeviceState_Busy = 2,
02841     USBDeviceState_Available = 3,
02849     USBDeviceState_Held = 4,
02857     USBDeviceState_Captured = 5,
02858 };
02859 
02869 enum USBDeviceFilterAction
02870 {
02875     USBDeviceFilterAction_Null = 0,
02880     USBDeviceFilterAction_Ignore = 1,
02885     USBDeviceFilterAction_Hold = 2,
02886 };
02887 
02895 enum AudioDriverType
02896 {
02901     AudioDriverType_Null = 0,
02906     AudioDriverType_WinMM = 1,
02911     AudioDriverType_OSS = 2,
02916     AudioDriverType_ALSA = 3,
02921     AudioDriverType_DirectSound = 4,
02926     AudioDriverType_CoreAudio = 5,
02931     AudioDriverType_MMPM = 6,
02936     AudioDriverType_Pulse = 7,
02941     AudioDriverType_SolAudio = 8,
02942 };
02943 
02951 enum AudioControllerType
02952 {
02953     AudioControllerType_AC97 = 0,
02954     AudioControllerType_SB16 = 1,
02955     AudioControllerType_HDA = 2,
02956 };
02957 
02965 enum AuthType
02966 {
02971     AuthType_Null = 0,
02972     AuthType_External = 1,
02973     AuthType_Guest = 2,
02974 };
02975 
02984 enum StorageBus
02985 {
02990     StorageBus_Null = 0,
02991     StorageBus_IDE = 1,
02992     StorageBus_SATA = 2,
02993     StorageBus_SCSI = 3,
02994     StorageBus_Floppy = 4,
02995     StorageBus_SAS = 5,
02996 };
02997 
03006 enum StorageControllerType
03007 {
03012     StorageControllerType_Null = 0,
03017     StorageControllerType_LsiLogic = 1,
03022     StorageControllerType_BusLogic = 2,
03027     StorageControllerType_IntelAhci = 3,
03032     StorageControllerType_PIIX3 = 4,
03037     StorageControllerType_PIIX4 = 5,
03042     StorageControllerType_ICH6 = 6,
03047     StorageControllerType_I82078 = 7,
03052     StorageControllerType_LsiLogicSas = 8,
03053 };
03054 
03062 enum ChipsetType
03063 {
03068     ChipsetType_Null = 0,
03073     ChipsetType_PIIX3 = 1,
03078     ChipsetType_ICH9 = 2,
03079 };
03080 
03086 enum NATAliasMode
03087 {
03092     NATAliasMode_AliasLog = 0x1,
03097     NATAliasMode_AliasProxyOnly = 0x02,
03102     NATAliasMode_AliasUseSamePorts = 0x04,
03103 };
03104 
03110 enum NATProtocol
03111 {
03116     NATProtocol_UDP = 0,
03121     NATProtocol_TCP = 1,
03122 };
03123 
03131 enum BandwidthGroupType
03132 {
03139     BandwidthGroupType_Null = 0,
03146     BandwidthGroupType_Disk = 1,
03153     BandwidthGroupType_Network = 2,
03154 };
03155 
03164 enum VBoxEventType
03165 {
03172     VBoxEventType_Invalid = 0,
03181     VBoxEventType_Any = 1,
03189     VBoxEventType_Vetoable = 2,
03197     VBoxEventType_MachineEvent = 3,
03205     VBoxEventType_SnapshotEvent = 4,
03214     VBoxEventType_InputEvent = 5,
03221     VBoxEventType_LastWildcard = 31,
03228     VBoxEventType_OnMachineStateChanged = 32,
03235     VBoxEventType_OnMachineDataChanged = 33,
03242     VBoxEventType_OnExtraDataChanged = 34,
03249     VBoxEventType_OnExtraDataCanChange = 35,
03256     VBoxEventType_OnMediumRegistered = 36,
03263     VBoxEventType_OnMachineRegistered = 37,
03270     VBoxEventType_OnSessionStateChanged = 38,
03277     VBoxEventType_OnSnapshotTaken = 39,
03284     VBoxEventType_OnSnapshotDeleted = 40,
03291     VBoxEventType_OnSnapshotChanged = 41,
03298     VBoxEventType_OnGuestPropertyChanged = 42,
03305     VBoxEventType_OnMousePointerShapeChanged = 43,
03312     VBoxEventType_OnMouseCapabilityChanged = 44,
03319     VBoxEventType_OnKeyboardLedsChanged = 45,
03326     VBoxEventType_OnStateChanged = 46,
03333     VBoxEventType_OnAdditionsStateChanged = 47,
03340     VBoxEventType_OnNetworkAdapterChanged = 48,
03347     VBoxEventType_OnSerialPortChanged = 49,
03354     VBoxEventType_OnParallelPortChanged = 50,
03361     VBoxEventType_OnStorageControllerChanged = 51,
03368     VBoxEventType_OnMediumChanged = 52,
03375     VBoxEventType_OnVRDEServerChanged = 53,
03382     VBoxEventType_OnUSBControllerChanged = 54,
03389     VBoxEventType_OnUSBDeviceStateChanged = 55,
03396     VBoxEventType_OnSharedFolderChanged = 56,
03403     VBoxEventType_OnRuntimeError = 57,
03410     VBoxEventType_OnCanShowWindow = 58,
03417     VBoxEventType_OnShowWindow = 59,
03424     VBoxEventType_OnCPUChanged = 60,
03431     VBoxEventType_OnVRDEServerInfoChanged = 61,
03438     VBoxEventType_OnEventSourceChanged = 62,
03445     VBoxEventType_OnCPUExecutionCapChanged = 63,
03452     VBoxEventType_OnGuestKeyboard = 64,
03459     VBoxEventType_OnGuestMouse = 65,
03466     VBoxEventType_OnNATRedirect = 66,
03473     VBoxEventType_OnHostPCIDevicePlug = 67,
03480     VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
03487     VBoxEventType_OnBandwidthGroupChanged = 69,
03494     VBoxEventType_OnGuestMonitorChanged = 70,
03501     VBoxEventType_OnStorageDeviceChanged = 71,
03508     VBoxEventType_OnClipboardModeChanged = 72,
03515     VBoxEventType_OnDragAndDropModeChanged = 73,
03522     VBoxEventType_Last = 74,
03523 };
03524 
03532 enum GuestMonitorChangedEventType
03533 {
03540     GuestMonitorChangedEventType_Enabled = 0,
03547     GuestMonitorChangedEventType_Disabled = 1,
03554     GuestMonitorChangedEventType_NewOrigin = 2,
03555 };
03556 
03590 interface IVirtualBoxErrorInfo : $errorinfo
03591 {
03609     readonly attribute long resultCode;
03610 
03622     readonly attribute wstringUUID interfaceID;
03623 
03634     readonly attribute wstring component;
03635 
03646     readonly attribute wstring text;
03647 
03658     readonly attribute IVirtualBoxErrorInfo next;
03659 
03660 }; /* interface IVirtualBoxErrorInfo */
03661 
03672 interface IDHCPServer : $unknown
03673 {
03679     attribute boolean enabled;
03680 
03686     readonly attribute wstring IPAddress;
03687 
03693     readonly attribute wstring networkMask;
03694 
03700     readonly attribute wstring networkName;
03701 
03707     readonly attribute wstring lowerIP;
03708 
03714     readonly attribute wstring upperIP;
03715 
03744     void setConfiguration (
03745         in wstring IPAddress,
03746         in wstring networkMask,
03747         in wstring FromIPAddress,
03748         in wstring ToIPAddress
03749     );
03750 
03775     void start (
03776         in wstring networkName,
03777         in wstring trunkName,
03778         in wstring trunkType
03779     );
03780 
03793     void stop();
03794 
03795 }; /* interface IDHCPServer */
03796 
03815 interface IVirtualBox : $unknown
03816 {
03829     readonly attribute wstring version;
03830 
03838     readonly attribute wstring versionNormalized;
03839 
03845     readonly attribute unsigned long revision;
03846 
03856     readonly attribute wstring packageType;
03857 
03869     readonly attribute wstring APIVersion;
03870 
03886     readonly attribute wstring homeFolder;
03887 
03895     readonly attribute wstring settingsFilePath;
03896 
03900     readonly attribute IHost host;
03901 
03905     readonly attribute ISystemProperties systemProperties;
03906 
03912     readonly attribute IMachine[] machines;
03913 
03923     readonly attribute wstring[] machineGroups;
03924 
03934     readonly attribute IMedium[] hardDisks;
03935 
03941     readonly attribute IMedium[] DVDImages;
03942 
03948     readonly attribute IMedium[] floppyImages;
03949 
03950     readonly attribute IProgress[] progressOperations;
03951 
03952     readonly attribute IGuestOSType[] guestOSTypes;
03953 
03970     readonly attribute ISharedFolder[] sharedFolders;
03971 
03977     readonly attribute IPerformanceCollector performanceCollector;
03978 
03984     readonly attribute IDHCPServer[] DHCPServers;
03985 
03991     readonly attribute IEventSource eventSource;
03992 
03998     readonly attribute IExtPackManager extensionPackManager;
03999 
04005     readonly attribute wstring[] internalNetworks;
04006 
04012     readonly attribute wstring[] genericNetworkDrivers;
04013 
04062     void composeMachineFilename (
04063         in wstring name,
04064         in wstring group,
04065         in wstring baseFolder,
04066         [retval] out wstring file
04067     );
04068 
04171     void createMachine (
04172         in wstring settingsFile,
04173         in wstring name,
04174         in wstring[] groups,
04175         in wstring osTypeId,
04176         in wstringUUID id,
04177         in boolean forceOverwrite,
04178         [retval] out IMachine machine
04179     );
04180 
04206     void openMachine (
04207         in wstring settingsFile,
04208         [retval] out IMachine machine
04209     );
04210 
04242     void registerMachine (
04243         in IMachine machine
04244     );
04245 
04266     void findMachine (
04267         in wstring nameOrId,
04268         [retval] out IMachine machine
04269     );
04270 
04282     void getMachinesByGroups (
04283         in wstring[] groups,
04284         [retval] out IMachine[] machines
04285     );
04286 
04296     void getMachineStates (
04297         in IMachine[] machines,
04298         [retval] out MachineState[] states
04299     );
04300 
04310     void createAppliance (
04311         [retval] out IAppliance appliance
04312     );
04313 
04376     void createHardDisk (
04377         in wstring format,
04378         in wstring location,
04379         [retval] out IMedium medium
04380     );
04381 
04487     void openMedium (
04488         in wstring location,
04489         in DeviceType deviceType,
04490         in AccessMode accessMode,
04491         in boolean forceNewUuid,
04492         [retval] out IMedium medium
04493     );
04494 
04523     void getGuestOSType (
04524         in wstringUUID id,
04525         [retval] out IGuestOSType type
04526     );
04527 
04550     void createSharedFolder (
04551         in wstring name,
04552         in wstring hostPath,
04553         in boolean writable,
04554         in boolean automount
04555     );
04556 
04571     void removeSharedFolder (
04572         in wstring name
04573     );
04574 
04583     void getExtraDataKeys (
04584         [retval] out wstring[] value
04585     );
04586 
04615     void getExtraData (
04616         in wstring key,
04617         [retval] out wstring value
04618     );
04619 
04669     void setExtraData (
04670         in wstring key,
04671         in wstring value
04672     );
04673 
04692     void setSettingsSecret (
04693         in wstring password
04694     );
04695 
04712     void createDHCPServer (
04713         in wstring name,
04714         [retval] out IDHCPServer server
04715     );
04716 
04733     void findDHCPServerByNetworkName (
04734         in wstring name,
04735         [retval] out IDHCPServer server
04736     );
04737 
04752     void removeDHCPServer (
04753         in IDHCPServer server
04754     );
04755 
04780     void checkFirmwarePresent (
04781         in FirmwareType firmwareType,
04782         in wstring version,
04783         out wstring url,
04784         out wstring file,
04785         [retval] out boolean result
04786     );
04787 
04788 }; /* interface IVirtualBox */
04789 
04800 interface IVFSExplorer : $unknown
04801 {
04805     readonly attribute wstring path;
04806 
04810     readonly attribute VFSType type;
04811 
04819     void update (
04820         [retval] out IProgress aProgress
04821     );
04822 
04830     void cd (
04831         in wstring aDir,
04832         [retval] out IProgress aProgress
04833     );
04834 
04840     void cdUp (
04841         [retval] out IProgress aProgress
04842     );
04843 
04856     void entryList (
04857         out wstring[] aNames,
04858         out unsigned long[] aTypes,
04859         out unsigned long[] aSizes,
04860         out unsigned long[] aModes
04861     );
04862 
04871     void exists (
04872         in wstring[] aNames,
04873         [retval] out wstring[] aExists
04874     );
04875 
04883     void remove (
04884         in wstring[] aNames,
04885         [retval] out IProgress aProgress
04886     );
04887 
04888 }; /* interface IVFSExplorer */
04889 
04955 interface IAppliance : $unknown
04956 {
04964     readonly attribute wstring path;
04965 
04996     readonly attribute wstring[] disks;
04997 
05005     readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
05006 
05014     readonly attribute wstring[] machines;
05015 
05032     void read (
05033         in wstring file,
05034         [retval] out IProgress aProgress
05035     );
05036 
05053     void interpret();
05054 
05077     void importMachines (
05078         in ImportOptions[] options,
05079         [retval] out IProgress aProgress
05080     );
05081 
05089     void createVFSExplorer (
05090         in wstring aUri,
05091         [retval] out IVFSExplorer aExplorer
05092     );
05093 
05123     void write (
05124         in wstring format,
05125         in boolean manifest,
05126         in wstring path,
05127         [retval] out IProgress progress
05128     );
05129 
05135     void getWarnings (
05136         [retval] out wstring[] aWarnings
05137     );
05138 
05139 }; /* interface IAppliance */
05140 
05152 interface IVirtualSystemDescription : $unknown
05153 {
05157     readonly attribute unsigned long count;
05158 
05282     void getDescription (
05283         out VirtualSystemDescriptionType[] aTypes,
05284         out wstring[] aRefs,
05285         out wstring[] aOvfValues,
05286         out wstring[] aVBoxValues,
05287         out wstring[] aExtraConfigValues
05288     );
05289 
05306     void getDescriptionByType (
05307         in VirtualSystemDescriptionType aType,
05308         out VirtualSystemDescriptionType[] aTypes,
05309         out wstring[] aRefs,
05310         out wstring[] aOvfValues,
05311         out wstring[] aVBoxValues,
05312         out wstring[] aExtraConfigValues
05313     );
05314 
05326     void getValuesByType (
05327         in VirtualSystemDescriptionType aType,
05328         in VirtualSystemDescriptionValueType aWhich,
05329         [retval] out wstring[] aValues
05330     );
05331 
05357     void setFinalValues (
05358         in boolean[] aEnabled,
05359         in wstring[] aVBoxValues,
05360         in wstring[] aExtraConfigValues
05361     );
05362 
05377     void addDescription (
05378         in VirtualSystemDescriptionType aType,
05379         in wstring aVBoxValue,
05380         in wstring aExtraConfigValue
05381     );
05382 
05383 }; /* interface IVirtualSystemDescription */
05384 
05385 interface IInternalMachineControl : $unknown
05386 {
05393     void setRemoveSavedStateFile (
05394         in boolean aRemove
05395     );
05396 
05408     void updateState (
05409         in MachineState state
05410     );
05411 
05412     void getIPCId (
05413         [retval] out wstring id
05414     );
05415 
05427     void beginPowerUp (
05428         in IProgress aProgress
05429     );
05430 
05440     void endPowerUp (
05441         in long result
05442     );
05443 
05455     void beginPoweringDown (
05456         out IProgress progress
05457     );
05458 
05488     void endPoweringDown (
05489         in long result,
05490         in wstring errMsg
05491     );
05492 
05506     void runUSBDeviceFilters (
05507         in IUSBDevice device,
05508         out boolean matched,
05509         out unsigned long maskedInterfaces
05510     );
05511 
05520     void captureUSBDevice (
05521         in wstringUUID id
05522     );
05523 
05539     void detachUSBDevice (
05540         in wstringUUID id,
05541         in boolean done
05542     );
05543 
05552     void autoCaptureUSBDevices();
05553 
05569     void detachAllUSBDevices (
05570         in boolean done
05571     );
05572 
05587     void onSessionEnd (
05588         in ISession session,
05589         [retval] out IProgress progress
05590     );
05591 
05607     void beginSavingState (
05608         out IProgress progress,
05609         out wstring stateFilePath
05610     );
05611 
05641     void endSavingState (
05642         in long result,
05643         in wstring errMsg
05644     );
05645 
05660     void adoptSavedState (
05661         in wstring savedStateFile
05662     );
05663 
05712     void beginTakingSnapshot (
05713         in IConsole initiator,
05714         in wstring name,
05715         in wstring description,
05716         in IProgress consoleProgress,
05717         in boolean fTakingSnapshotOnline,
05718         out wstring stateFilePath
05719     );
05720 
05730     void endTakingSnapshot (
05731         in boolean success
05732     );
05733 
05762     void deleteSnapshot (
05763         in IConsole initiator,
05764         in wstringUUID startId,
05765         in wstringUUID endId,
05766         in boolean deleteAllChildren,
05767         out MachineState machineState,
05768         [retval] out IProgress progress
05769     );
05770 
05789     void finishOnlineMergeMedium (
05790         in IMediumAttachment mediumAttachment,
05791         in IMedium source,
05792         in IMedium target,
05793         in boolean mergeForward,
05794         in IMedium parentForTarget,
05795         in IMedium[] childrenToReparent
05796     );
05797 
05811     void restoreSnapshot (
05812         in IConsole initiator,
05813         in ISnapshot snapshot,
05814         out MachineState machineState,
05815         [retval] out IProgress progress
05816     );
05817 
05844     void pullGuestProperties (
05845         out wstring[] name,
05846         out wstring[] value,
05847         out long long[] timestamp,
05848         out wstring[] flags
05849     );
05850 
05872     void pushGuestProperty (
05873         in wstring name,
05874         in wstring value,
05875         in long long timestamp,
05876         in wstring flags
05877     );
05878 
05890     void lockMedia();
05891 
05901     void unlockMedia();
05902 
05918     void ejectMedium (
05919         in IMediumAttachment attachment,
05920         [retval] out IMediumAttachment newAttachment
05921     );
05922 
05959     void reportGuestStatistics (
05960         in unsigned long validStats,
05961         in unsigned long cpuUser,
05962         in unsigned long cpuKernel,
05963         in unsigned long cpuIdle,
05964         in unsigned long memTotal,
05965         in unsigned long memFree,
05966         in unsigned long memBalloon,
05967         in unsigned long memShared,
05968         in unsigned long memCache,
05969         in unsigned long pagedTotal,
05970         in unsigned long memAllocTotal,
05971         in unsigned long memFreeTotal,
05972         in unsigned long memBalloonTotal,
05973         in unsigned long memSharedTotal
05974     );
05975 
05976 }; /* interface IInternalMachineControl */
05977 
05986 interface IBIOSSettings : $unknown
05987 {
05991     attribute boolean logoFadeIn;
05992 
05996     attribute boolean logoFadeOut;
05997 
06001     attribute unsigned long logoDisplayTime;
06002 
06009     attribute wstring logoImagePath;
06010 
06014     attribute BIOSBootMenuMode bootMenuMode;
06015 
06019     attribute boolean ACPIEnabled;
06020 
06027     attribute boolean IOAPICEnabled;
06028 
06038     attribute long long timeOffset;
06039 
06046     attribute boolean PXEDebugEnabled;
06047 
06048 }; /* interface IBIOSSettings */
06049 
06057 interface IPCIAddress : $unknown
06058 {
06064     attribute short bus;
06065 
06071     attribute short device;
06072 
06078     attribute short devFunction;
06079 
06085     void asLong (
06086         [retval] out long result
06087     );
06088 
06094     void fromLong (
06095         in long number
06096     );
06097 
06098 }; /* interface IPCIAddress */
06099 
06107 interface IPCIDeviceAttachment : $unknown
06108 {
06114     readonly attribute wstring name;
06115 
06121     readonly attribute boolean isPhysicalDevice;
06122 
06128     readonly attribute long hostAddress;
06129 
06135     readonly attribute long guestAddress;
06136 
06137 }; /* interface IPCIDeviceAttachment */
06138 
06179 interface IMachine : $unknown
06180 {
06184     readonly attribute IVirtualBox parent;
06185 
06235     readonly attribute boolean accessible;
06236 
06248     readonly attribute IVirtualBoxErrorInfo accessError;
06249 
06289     attribute wstring name;
06290 
06301     attribute wstring description;
06302 
06306     readonly attribute wstringUUID id;
06307 
06318     attribute wstring[] groups;
06319 
06334     attribute wstring OSTypeId;
06335 
06339     attribute wstring hardwareVersion;
06340 
06350     attribute wstringUUID hardwareUUID;
06351 
06355     attribute unsigned long CPUCount;
06356 
06362     attribute boolean CPUHotPlugEnabled;
06363 
06371     attribute unsigned long CPUExecutionCap;
06372 
06376     attribute unsigned long memorySize;
06377 
06381     attribute unsigned long memoryBalloonSize;
06382 
06389     attribute boolean pageFusionEnabled;
06390 
06394     attribute unsigned long VRAMSize;
06395 
06401     attribute boolean accelerate3DEnabled;
06402 
06408     attribute boolean accelerate2DVideoEnabled;
06409 
06420     attribute unsigned long monitorCount;
06421 
06427     attribute boolean VideoCaptureEnabled;
06428 
06434     attribute wstring VideoCaptureFile;
06435 
06441     attribute unsigned long VideoCaptureWidth;
06442 
06448     attribute unsigned long VideoCaptureHeight;
06449 
06453     readonly attribute IBIOSSettings BIOSSettings;
06454 
06459     attribute FirmwareType firmwareType;
06460 
06466     attribute PointingHIDType pointingHIDType;
06467 
06473     attribute KeyboardHIDType keyboardHIDType;
06474 
06481     attribute boolean HPETEnabled;
06482 
06486     attribute ChipsetType chipsetType;
06487 
06521     attribute wstring snapshotFolder;
06522 
06526     readonly attribute IVRDEServer VRDEServer;
06527 
06528     attribute boolean emulatedUSBWebcameraEnabled;
06529 
06530     attribute boolean emulatedUSBCardReaderEnabled;
06531 
06535     readonly attribute IMediumAttachment[] mediumAttachments;
06536 
06548     readonly attribute IUSBController USBController;
06549 
06553     readonly attribute IAudioAdapter audioAdapter;
06554 
06558     readonly attribute IStorageController[] storageControllers;
06559 
06565     readonly attribute wstring settingsFilePath;
06566 
06591     readonly attribute boolean settingsModified;
06592 
06596     readonly attribute SessionState sessionState;
06597 
06610     readonly attribute wstring sessionType;
06611 
06621     readonly attribute unsigned long sessionPID;
06622 
06626     readonly attribute MachineState state;
06627 
06634     readonly attribute long long lastStateChange;
06635 
06647     readonly attribute wstring stateFilePath;
06648 
06658     readonly attribute wstring logFolder;
06659 
06670     readonly attribute ISnapshot currentSnapshot;
06671 
06678     readonly attribute unsigned long snapshotCount;
06679 
06711     readonly attribute boolean currentStateModified;
06712 
06724     readonly attribute ISharedFolder[] sharedFolders;
06725 
06732     attribute ClipboardMode clipboardMode;
06733 
06739     attribute DragAndDropMode dragAndDropMode;
06740 
06748     attribute wstring guestPropertyNotificationPatterns;
06749 
06758     attribute boolean teleporterEnabled;
06759 
06770     attribute unsigned long teleporterPort;
06771 
06778     attribute wstring teleporterAddress;
06779 
06790     attribute wstring teleporterPassword;
06791 
06799     attribute FaultToleranceState faultToleranceState;
06800 
06807     attribute unsigned long faultTolerancePort;
06808 
06814     attribute wstring faultToleranceAddress;
06815 
06823     attribute wstring faultTolerancePassword;
06824 
06830     attribute unsigned long faultToleranceSyncInterval;
06831 
06839     attribute boolean RTCUseUTC;
06840 
06847     attribute boolean IOCacheEnabled;
06848 
06854     attribute unsigned long IOCacheSize;
06855 
06865     readonly attribute IPCIDeviceAttachment[] PCIDeviceAssignments;
06866 
06872     readonly attribute IBandwidthControl bandwidthControl;
06873 
06882     attribute boolean tracingEnabled;
06883 
06898     attribute wstring tracingConfig;
06899 
06912     attribute boolean allowTracingToAccessVM;
06913 
06919     attribute boolean autostartEnabled;
06920 
06926     attribute unsigned long autostartDelay;
06927 
06933     attribute AutostopType autostopType;
06934 
07040     void lockMachine (
07041         in ISession session,
07042         in LockType lockType
07043     );
07044 
07174     void launchVMProcess (
07175         in ISession session,
07176         in wstring type,
07177         in wstring environment,
07178         [retval] out IProgress progress
07179     );
07180 
07218     void setBootOrder (
07219         in unsigned long position,
07220         in DeviceType device
07221     );
07222 
07257     void getBootOrder (
07258         in unsigned long position,
07259         [retval] out DeviceType device
07260     );
07261 
07363     void attachDevice (
07364         in wstring name,
07365         in long controllerPort,
07366         in long device,
07367         in DeviceType type,
07368         in IMedium medium
07369     );
07370 
07466     void attachDeviceWithoutMedium (
07467         in wstring name,
07468         in long controllerPort,
07469         in long device,
07470         in DeviceType type
07471     );
07472 
07526     void detachDevice (
07527         in wstring name,
07528         in long controllerPort,
07529         in long device
07530     );
07531 
07574     void passthroughDevice (
07575         in wstring name,
07576         in long controllerPort,
07577         in long device,
07578         in boolean passthrough
07579     );
07580 
07623     void temporaryEjectDevice (
07624         in wstring name,
07625         in long controllerPort,
07626         in long device,
07627         in boolean temporaryEject
07628     );
07629 
07675     void nonRotationalDevice (
07676         in wstring name,
07677         in long controllerPort,
07678         in long device,
07679         in boolean nonRotational
07680     );
07681 
07727     void setAutoDiscardForDevice (
07728         in wstring name,
07729         in long controllerPort,
07730         in long device,
07731         in boolean discard
07732     );
07733 
07774     void setBandwidthGroupForDevice (
07775         in wstring name,
07776         in long controllerPort,
07777         in long device,
07778         in IBandwidthGroup bandwidthGroup
07779     );
07780 
07817     void setNoBandwidthGroupForDevice (
07818         in wstring name,
07819         in long controllerPort,
07820         in long device
07821     );
07822 
07887     void unmountMedium (
07888         in wstring name,
07889         in long controllerPort,
07890         in long device,
07891         in boolean force
07892     );
07893 
07956     void mountMedium (
07957         in wstring name,
07958         in long controllerPort,
07959         in long device,
07960         in IMedium medium,
07961         in boolean force
07962     );
07963 
07992     void getMedium (
07993         in wstring name,
07994         in long controllerPort,
07995         in long device,
07996         [retval] out IMedium medium
07997     );
07998 
08013     void getMediumAttachmentsOfController (
08014         in wstring name,
08015         [retval] out IMediumAttachment[] mediumAttachments
08016     );
08017 
08032     void getMediumAttachment (
08033         in wstring name,
08034         in long controllerPort,
08035         in long device,
08036         [retval] out IMediumAttachment attachment
08037     );
08038 
08079     void attachHostPCIDevice (
08080         in long hostAddress,
08081         in long desiredGuestAddress,
08082         in boolean tryToUnbind
08083     );
08084 
08125     void detachHostPCIDevice (
08126         in long hostAddress
08127     );
08128 
08146     void getNetworkAdapter (
08147         in unsigned long slot,
08148         [retval] out INetworkAdapter adapter
08149     );
08150 
08183     void addStorageController (
08184         in wstring name,
08185         in StorageBus connectionType,
08186         [retval] out IStorageController controller
08187     );
08188 
08202     void getStorageControllerByName (
08203         in wstring name,
08204         [retval] out IStorageController storageController
08205     );
08206 
08220     void getStorageControllerByInstance (
08221         in unsigned long instance,
08222         [retval] out IStorageController storageController
08223     );
08224 
08247     void removeStorageController (
08248         in wstring name
08249     );
08250 
08272     void setStorageControllerBootable (
08273         in wstring name,
08274         in boolean bootable
08275     );
08276 
08294     void getSerialPort (
08295         in unsigned long slot,
08296         [retval] out ISerialPort port
08297     );
08298 
08316     void getParallelPort (
08317         in unsigned long slot,
08318         [retval] out IParallelPort port
08319     );
08320 
08329     void getExtraDataKeys (
08330         [retval] out wstring[] value
08331     );
08332 
08361     void getExtraData (
08362         in wstring key,
08363         [retval] out wstring value
08364     );
08365 
08415     void setExtraData (
08416         in wstring key,
08417         in wstring value
08418     );
08419 
08441     void getCPUProperty (
08442         in CPUPropertyType property,
08443         [retval] out boolean value
08444     );
08445 
08467     void setCPUProperty (
08468         in CPUPropertyType property,
08469         in boolean value
08470     );
08471 
08511     void getCPUIDLeaf (
08512         in unsigned long id,
08513         out unsigned long valEax,
08514         out unsigned long valEbx,
08515         out unsigned long valEcx,
08516         out unsigned long valEdx
08517     );
08518 
08562     void setCPUIDLeaf (
08563         in unsigned long id,
08564         in unsigned long valEax,
08565         in unsigned long valEbx,
08566         in unsigned long valEcx,
08567         in unsigned long valEdx
08568     );
08569 
08587     void removeCPUIDLeaf (
08588         in unsigned long id
08589     );
08590 
08596     void removeAllCPUIDLeaves();
08597 
08619     void getHWVirtExProperty (
08620         in HWVirtExPropertyType property,
08621         [retval] out boolean value
08622     );
08623 
08645     void setHWVirtExProperty (
08646         in HWVirtExPropertyType property,
08647         in boolean value
08648     );
08649 
08695     void saveSettings();
08696 
08720     void discardSettings();
08721 
08805     void unregister (
08806         in CleanupMode cleanupMode,
08807         [retval] out IMedium[] aMedia
08808     );
08809 
08866     void delete (
08867         in IMedium[] aMedia,
08868         [retval] out IProgress aProgress
08869     );
08870 
08882     void export (
08883         in IAppliance aAppliance,
08884         in wstring location,
08885         [retval] out IVirtualSystemDescription aDescription
08886     );
08887 
08911     void findSnapshot (
08912         in wstring nameOrId,
08913         [retval] out ISnapshot snapshot
08914     );
08915 
08949     void createSharedFolder (
08950         in wstring name,
08951         in wstring hostPath,
08952         in boolean writable,
08953         in boolean automount
08954     );
08955 
08981     void removeSharedFolder (
08982         in wstring name
08983     );
08984 
09008     void canShowConsoleWindow (
09009         [retval] out boolean canShow
09010     );
09011 
09046     void showConsoleWindow (
09047         [retval] out long long winId
09048     );
09049 
09082     void getGuestProperty (
09083         in wstring name,
09084         out wstring value,
09085         out long long timestamp,
09086         out wstring flags
09087     );
09088 
09111     void getGuestPropertyValue (
09112         in wstring property,
09113         [retval] out wstring value
09114     );
09115 
09138     void getGuestPropertyTimestamp (
09139         in wstring property,
09140         [retval] out long long value
09141     );
09142 
09193     void setGuestProperty (
09194         in wstring property,
09195         in wstring value,
09196         in wstring flags
09197     );
09198 
09239     void setGuestPropertyValue (
09240         in wstring property,
09241         in wstring value
09242     );
09243 
09261     void deleteGuestProperty (
09262         in wstring name
09263     );
09264 
09295     void enumerateGuestProperties (
09296         in wstring patterns,
09297         out wstring[] name,
09298         out wstring[] value,
09299         out long long[] timestamp,
09300         out wstring[] flags
09301     );
09302 
09332     void querySavedGuestScreenInfo (
09333         in unsigned long screenId,
09334         out unsigned long originX,
09335         out unsigned long originY,
09336         out unsigned long width,
09337         out unsigned long height,
09338         out boolean enabled
09339     );
09340 
09362     void querySavedThumbnailSize (
09363         in unsigned long screenId,
09364         out unsigned long size,
09365         out unsigned long width,
09366         out unsigned long height
09367     );
09368 
09395     void readSavedThumbnailToArray (
09396         in unsigned long screenId,
09397         in boolean BGR,
09398         out unsigned long width,
09399         out unsigned long height,
09400         [retval] out octet[] data
09401     );
09402 
09424     void readSavedThumbnailPNGToArray (
09425         in unsigned long screenId,
09426         out unsigned long width,
09427         out unsigned long height,
09428         [retval] out octet[] data
09429     );
09430 
09452     void querySavedScreenshotPNGSize (
09453         in unsigned long screenId,
09454         out unsigned long size,
09455         out unsigned long width,
09456         out unsigned long height
09457     );
09458 
09480     void readSavedScreenshotPNGToArray (
09481         in unsigned long screenId,
09482         out unsigned long width,
09483         out unsigned long height,
09484         [retval] out octet[] data
09485     );
09486 
09496     void hotPlugCPU (
09497         in unsigned long cpu
09498     );
09499 
09509     void hotUnplugCPU (
09510         in unsigned long cpu
09511     );
09512 
09526     void getCPUStatus (
09527         in unsigned long cpu,
09528         [retval] out boolean attached
09529     );
09530 
09545     void queryLogFilename (
09546         in unsigned long idx,
09547         [retval] out wstring filename
09548     );
09549 
09575     void readLog (
09576         in unsigned long idx,
09577         in long long offset,
09578         in long long size,
09579         [retval] out octet[] data
09580     );
09581 
09614     void cloneTo (
09615         in IMachine target,
09616         in CloneMode mode,
09617         in CloneOptions[] options,
09618         [retval] out IProgress progress
09619     );
09620 
09621 }; /* interface IMachine */
09622 
09631 interface IVRDEServerInfo : $unknown
09632 {
09638     readonly attribute boolean active;
09639 
09648     readonly attribute long port;
09649 
09655     readonly attribute unsigned long numberOfClients;
09656 
09662     readonly attribute long long beginTime;
09663 
09670     readonly attribute long long endTime;
09671 
09677     readonly attribute long long bytesSent;
09678 
09684     readonly attribute long long bytesSentTotal;
09685 
09691     readonly attribute long long bytesReceived;
09692 
09698     readonly attribute long long bytesReceivedTotal;
09699 
09705     readonly attribute wstring user;
09706 
09712     readonly attribute wstring domain;
09713 
09719     readonly attribute wstring clientName;
09720 
09726     readonly attribute wstring clientIP;
09727 
09733     readonly attribute unsigned long clientVersion;
09734 
09742     readonly attribute unsigned long encryptionStyle;
09743 
09744 }; /* interface IVRDEServerInfo */
09745 
09767 interface IConsole : $unknown
09768 {
09780     readonly attribute IMachine machine;
09781 
09795     readonly attribute MachineState state;
09796 
09800     readonly attribute IGuest guest;
09801 
09812     readonly attribute IKeyboard keyboard;
09813 
09824     readonly attribute IMouse mouse;
09825 
09835     readonly attribute IDisplay display;
09836 
09840     readonly attribute IMachineDebugger debugger;
09841 
09852     readonly attribute IUSBDevice[] USBDevices;
09853 
09861     readonly attribute IHostUSBDevice[] remoteUSBDevices;
09862 
09878     readonly attribute ISharedFolder[] sharedFolders;
09879 
09885     readonly attribute IVRDEServerInfo VRDEServerInfo;
09886 
09892     readonly attribute IEventSource eventSource;
09893 
09897     readonly attribute IPCIDeviceAttachment[] attachedPCIDevices;
09898 
09907     attribute boolean useHostClipboard;
09908 
09973     void powerUp (
09974         [retval] out IProgress progress
09975     );
09976 
10010     void powerUpPaused (
10011         [retval] out IProgress progress
10012     );
10013 
10033     void powerDown (
10034         [retval] out IProgress progress
10035     );
10036 
10056     void reset();
10057 
10077     void pause();
10078 
10098     void resume();
10099 
10119     void powerButton();
10120 
10140     void sleepButton();
10141 
10153     void getPowerButtonHandled (
10154         [retval] out boolean handled
10155     );
10156 
10170     void getGuestEnteredACPIMode (
10171         [retval] out boolean entered
10172     );
10173 
10226     void saveState (
10227         [retval] out IProgress progress
10228     );
10229 
10262     void adoptSavedState (
10263         in wstring savedStateFile
10264     );
10265 
10296     void discardSavedState (
10297         in boolean fRemoveFile
10298     );
10299 
10312     void getDeviceActivity (
10313         in DeviceType type,
10314         [retval] out DeviceActivity activity
10315     );
10316 
10354     void attachUSBDevice (
10355         in wstringUUID id
10356     );
10357 
10392     void detachUSBDevice (
10393         in wstringUUID id,
10394         [retval] out IUSBDevice device
10395     );
10396 
10419     void findUSBDeviceByAddress (
10420         in wstring name,
10421         [retval] out IUSBDevice device
10422     );
10423 
10443     void findUSBDeviceById (
10444         in wstringUUID id,
10445         [retval] out IUSBDevice device
10446     );
10447 
10481     void createSharedFolder (
10482         in wstring name,
10483         in wstring hostPath,
10484         in boolean writable,
10485         in boolean automount
10486     );
10487 
10512     void removeSharedFolder (
10513         in wstring name
10514     );
10515 
10553     void takeSnapshot (
10554         in wstring name,
10555         in wstring description,
10556         [retval] out IProgress progress
10557     );
10558 
10631     void deleteSnapshot (
10632         in wstringUUID id,
10633         [retval] out IProgress progress
10634     );
10635 
10675     void deleteSnapshotAndAllChildren (
10676         in wstringUUID id,
10677         [retval] out IProgress progress
10678     );
10679 
10723     void deleteSnapshotRange (
10724         in wstringUUID startId,
10725         in wstringUUID endId,
10726         [retval] out IProgress progress
10727     );
10728 
10769     void restoreSnapshot (
10770         in ISnapshot snapshot,
10771         [retval] out IProgress progress
10772     );
10773 
10812     void teleport (
10813         in wstring hostname,
10814         in unsigned long tcpport,
10815         in wstring password,
10816         in unsigned long maxDowntime,
10817         [retval] out IProgress progress
10818     );
10819 
10820 }; /* interface IConsole */
10821 
10832 interface IHostNetworkInterface : $unknown
10833 {
10837     readonly attribute wstring name;
10838 
10842     readonly attribute wstringUUID id;
10843 
10847     readonly attribute wstring networkName;
10848 
10852     readonly attribute boolean DHCPEnabled;
10853 
10857     readonly attribute wstring IPAddress;
10858 
10862     readonly attribute wstring networkMask;
10863 
10867     readonly attribute boolean IPV6Supported;
10868 
10872     readonly attribute wstring IPV6Address;
10873 
10877     readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
10878 
10882     readonly attribute wstring hardwareAddress;
10883 
10887     readonly attribute HostNetworkInterfaceMediumType mediumType;
10888 
10892     readonly attribute HostNetworkInterfaceStatus status;
10893 
10897     readonly attribute HostNetworkInterfaceType interfaceType;
10898 
10910     void enableStaticIPConfig (
10911         in wstring IPAddress,
10912         in wstring networkMask
10913     );
10914 
10926     void enableStaticIPConfigV6 (
10927         in wstring IPV6Address,
10928         in unsigned long IPV6NetworkMaskPrefixLength
10929     );
10930 
10934     void enableDynamicIPConfig();
10935 
10939     void DHCPRediscover();
10940 
10941 }; /* interface IHostNetworkInterface */
10942 
10959 interface IHost : $unknown
10960 {
10964     readonly attribute IMedium[] DVDDrives;
10965 
10969     readonly attribute IMedium[] floppyDrives;
10970 
10984     readonly attribute IHostUSBDevice[] USBDevices;
10985 
11009     readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
11010 
11014     readonly attribute IHostNetworkInterface[] networkInterfaces;
11015 
11019     readonly attribute unsigned long processorCount;
11020 
11024     readonly attribute unsigned long processorOnlineCount;
11025 
11029     readonly attribute unsigned long processorCoreCount;
11030 
11034     readonly attribute unsigned long memorySize;
11035 
11039     readonly attribute unsigned long memoryAvailable;
11040 
11044     readonly attribute wstring operatingSystem;
11045 
11049     readonly attribute wstring OSVersion;
11050 
11054     readonly attribute long long UTCTime;
11055 
11059     readonly attribute boolean acceleration3DAvailable;
11060 
11075     void getProcessorSpeed (
11076         in unsigned long cpuId,
11077         [retval] out unsigned long speed
11078     );
11079 
11091     void getProcessorFeature (
11092         in ProcessorFeature feature,
11093         [retval] out boolean supported
11094     );
11095 
11114     void getProcessorDescription (
11115         in unsigned long cpuId,
11116         [retval] out wstring description
11117     );
11118 
11159     void getProcessorCPUIDLeaf (
11160         in unsigned long cpuId,
11161         in unsigned long leaf,
11162         in unsigned long subLeaf,
11163         out unsigned long valEax,
11164         out unsigned long valEbx,
11165         out unsigned long valEcx,
11166         out unsigned long valEdx
11167     );
11168 
11189     void createHostOnlyNetworkInterface (
11190         out IHostNetworkInterface hostInterface,
11191         [retval] out IProgress progress
11192     );
11193 
11214     void removeHostOnlyNetworkInterface (
11215         in wstringUUID id,
11216         [retval] out IProgress progress
11217     );
11218 
11238     void createUSBDeviceFilter (
11239         in wstring name,
11240         [retval] out IHostUSBDeviceFilter filter
11241     );
11242 
11285     void insertUSBDeviceFilter (
11286         in unsigned long position,
11287         in IHostUSBDeviceFilter filter
11288     );
11289 
11317     void removeUSBDeviceFilter (
11318         in unsigned long position
11319     );
11320 
11338     void findHostDVDDrive (
11339         in wstring name,
11340         [retval] out IMedium drive
11341     );
11342 
11360     void findHostFloppyDrive (
11361         in wstring name,
11362         [retval] out IMedium drive
11363     );
11364 
11380     void findHostNetworkInterfaceByName (
11381         in wstring name,
11382         [retval] out IHostNetworkInterface networkInterface
11383     );
11384 
11400     void findHostNetworkInterfaceById (
11401         in wstringUUID id,
11402         [retval] out IHostNetworkInterface networkInterface
11403     );
11404 
11414     void findHostNetworkInterfacesOfType (
11415         in HostNetworkInterfaceType type,
11416         [retval] out IHostNetworkInterface[] networkInterfaces
11417     );
11418 
11438     void findUSBDeviceById (
11439         in wstringUUID id,
11440         [retval] out IHostUSBDevice device
11441     );
11442 
11465     void findUSBDeviceByAddress (
11466         in wstring name,
11467         [retval] out IHostUSBDevice device
11468     );
11469 
11477     void generateMACAddress (
11478         [retval] out wstring address
11479     );
11480 
11481 }; /* interface IHost */
11482 
11495 interface ISystemProperties : $unknown
11496 {
11500     readonly attribute unsigned long minGuestRAM;
11501 
11505     readonly attribute unsigned long maxGuestRAM;
11506 
11510     readonly attribute unsigned long minGuestVRAM;
11511 
11515     readonly attribute unsigned long maxGuestVRAM;
11516 
11520     readonly attribute unsigned long minGuestCPUCount;
11521 
11525     readonly attribute unsigned long maxGuestCPUCount;
11526 
11530     readonly attribute unsigned long maxGuestMonitors;
11531 
11536     readonly attribute long long infoVDSize;
11537 
11544     readonly attribute unsigned long serialPortCount;
11545 
11552     readonly attribute unsigned long parallelPortCount;
11553 
11563     readonly attribute unsigned long maxBootPosition;
11564 
11588     attribute wstring defaultMachineFolder;
11589 
11614     readonly attribute IMediumFormat[] mediumFormats;
11615 
11649     attribute wstring defaultHardDiskFormat;
11650 
11656     attribute long long freeDiskSpaceWarning;
11657 
11662     attribute unsigned long freeDiskSpacePercentWarning;
11663 
11669     attribute long long freeDiskSpaceError;
11670 
11675     attribute unsigned long freeDiskSpacePercentError;
11676 
11700     attribute wstring VRDEAuthLibrary;
11701 
11730     attribute wstring webServiceAuthLibrary;
11731 
11745     attribute wstring defaultVRDEExtPack;
11746 
11752     attribute unsigned long logHistoryCount;
11753 
11758     readonly attribute AudioDriverType defaultAudioDriver;
11759 
11766     attribute wstring autostartDatabasePath;
11767 
11774     attribute wstring defaultAdditionsISO;
11775 
11786     void getMaxNetworkAdapters (
11787         in ChipsetType chipset,
11788         [retval] out unsigned long maxNetworkAdapters
11789     );
11790 
11804     void getMaxNetworkAdaptersOfType (
11805         in ChipsetType chipset,
11806         in NetworkAttachmentType type,
11807         [retval] out unsigned long maxNetworkAdapters
11808     );
11809 
11819     void getMaxDevicesPerPortForStorageBus (
11820         in StorageBus bus,
11821         [retval] out unsigned long maxDevicesPerPort
11822     );
11823 
11831     void getMinPortCountForStorageBus (
11832         in StorageBus bus,
11833         [retval] out unsigned long minPortCount
11834     );
11835 
11843     void getMaxPortCountForStorageBus (
11844         in StorageBus bus,
11845         [retval] out unsigned long maxPortCount
11846     );
11847 
11860     void getMaxInstancesOfStorageBus (
11861         in ChipsetType chipset,
11862         in StorageBus bus,
11863         [retval] out unsigned long maxInstances
11864     );
11865 
11875     void getDeviceTypesForStorageBus (
11876         in StorageBus bus,
11877         [retval] out DeviceType[] deviceTypes
11878     );
11879 
11888     void getDefaultIoCacheSettingForStorageController (
11889         in StorageControllerType controllerType,
11890         [retval] out boolean enabled
11891     );
11892 
11893 }; /* interface ISystemProperties */
11894 
11900 interface IGuestOSType : $unknown
11901 {
11905     readonly attribute wstring familyId;
11906 
11910     readonly attribute wstring familyDescription;
11911 
11915     readonly attribute wstring id;
11916 
11920     readonly attribute wstring description;
11921 
11925     readonly attribute boolean is64Bit;
11926 
11930     readonly attribute boolean recommendedIOAPIC;
11931 
11935     readonly attribute boolean recommendedVirtEx;
11936 
11940     readonly attribute unsigned long recommendedRAM;
11941 
11945     readonly attribute unsigned long recommendedVRAM;
11946 
11950     readonly attribute boolean recommended2DVideoAcceleration;
11951 
11955     readonly attribute boolean recommended3DAcceleration;
11956 
11960     readonly attribute long long recommendedHDD;
11961 
11965     readonly attribute NetworkAdapterType adapterType;
11966 
11970     readonly attribute boolean recommendedPAE;
11971 
11975     readonly attribute StorageControllerType recommendedDVDStorageController;
11976 
11980     readonly attribute StorageBus recommendedDVDStorageBus;
11981 
11985     readonly attribute StorageControllerType recommendedHDStorageController;
11986 
11990     readonly attribute StorageBus recommendedHDStorageBus;
11991 
11995     readonly attribute FirmwareType recommendedFirmware;
11996 
12000     readonly attribute boolean recommendedUSBHID;
12001 
12005     readonly attribute boolean recommendedHPET;
12006 
12010     readonly attribute boolean recommendedUSBTablet;
12011 
12015     readonly attribute boolean recommendedRTCUseUTC;
12016 
12020     readonly attribute ChipsetType recommendedChipset;
12021 
12025     readonly attribute AudioControllerType recommendedAudioController;
12026 
12030     readonly attribute boolean recommendedFloppy;
12031 
12035     readonly attribute boolean recommendedUSB;
12036 
12037 }; /* interface IGuestOSType */
12038 
12046 interface IAdditionsFacility : $unknown
12047 {
12051     readonly attribute AdditionsFacilityClass classType;
12052 
12059     readonly attribute long long lastUpdated;
12060 
12064     readonly attribute wstring name;
12065 
12069     readonly attribute AdditionsFacilityStatus status;
12070 
12074     readonly attribute AdditionsFacilityType type;
12075 
12076 }; /* interface IAdditionsFacility */
12077 
12103 interface IGuestSession : $unknown
12104 {
12110     readonly attribute wstring user;
12111 
12117     readonly attribute wstring domain;
12118 
12122     readonly attribute wstring name;
12123 
12127     readonly attribute unsigned long id;
12128 
12141     attribute unsigned long timeout;
12142 
12148     attribute wstring[] environment;
12149 
12155     readonly attribute IGuestProcess[] processes;
12156 
12162     readonly attribute IGuestDirectory[] directories;
12163 
12169     readonly attribute IGuestFile[] files;
12170 
12178     void close();
12179 
12201     void copyFrom (
12202         in wstring source,
12203         in wstring dest,
12204         in CopyFileFlag[] flags,
12205         [retval] out IProgress progress
12206     );
12207 
12229     void copyTo (
12230         in wstring source,
12231         in wstring dest,
12232         in CopyFileFlag[] flags,
12233         [retval] out IProgress progress
12234     );
12235 
12255     void directoryCreate (
12256         in wstring path,
12257         in unsigned long mode,
12258         in DirectoryCreateFlag[] flags
12259     );
12260 
12312     void directoryCreateTemp (
12313         in wstring templateName,
12314         in unsigned long mode,
12315         in wstring path,
12316         in boolean secure,
12317         [retval] out wstring directory
12318     );
12319 
12337     void directoryExists (
12338         in wstring path,
12339         [retval] out boolean exists
12340     );
12341 
12372     void directoryOpen (
12373         in wstring path,
12374         in wstring filter,
12375         in DirectoryOpenFlag[] flags,
12376         [retval] out IGuestDirectory directory
12377     );
12378 
12404     void directoryQueryInfo (
12405         in wstring path,
12406         [retval] out IGuestFsObjInfo info
12407     );
12408 
12424     void directoryRemove (
12425         in wstring path
12426     );
12427 
12447     void directoryRemoveRecursive (
12448         in wstring path,
12449         in DirectoryRemoveRecFlag[] flags,
12450         [retval] out IProgress progress
12451     );
12452 
12472     void directoryRename (
12473         in wstring source,
12474         in wstring dest,
12475         in PathRenameFlag[] flags
12476     );
12477 
12495     void directorySetACL (
12496         in wstring path,
12497         in wstring acl
12498     );
12499 
12513     void environmentClear();
12514 
12535     void environmentGet (
12536         in wstring name,
12537         [retval] out wstring value
12538     );
12539 
12557     void environmentSet (
12558         in wstring name,
12559         in wstring value
12560     );
12561 
12577     void environmentUnset (
12578         in wstring name
12579     );
12580 
12634     void fileCreateTemp (
12635         in wstring templateName,
12636         in unsigned long mode,
12637         in wstring path,
12638         in boolean secure,
12639         [retval] out IGuestFile file
12640     );
12641 
12659     void fileExists (
12660         in wstring path,
12661         [retval] out boolean exists
12662     );
12663 
12687     void fileRemove (
12688         in wstring path
12689     );
12690 
12725     void fileOpen (
12726         in wstring path,
12727         in wstring openMode,
12728         in wstring disposition,
12729         in unsigned long creationMode,
12730         in long long offset,
12731         [retval] out IGuestFile file
12732     );
12733 
12759     void fileQueryInfo (
12760         in wstring path,
12761         [retval] out IGuestFsObjInfo info
12762     );
12763 
12789     void fileQuerySize (
12790         in wstring path,
12791         [retval] out long long size
12792     );
12793 
12813     void fileRename (
12814         in wstring source,
12815         in wstring dest,
12816         in PathRenameFlag[] flags
12817     );
12818 
12836     void fileSetACL (
12837         in wstring file,
12838         in wstring acl
12839     );
12840 
12900     void processCreate (
12901         in wstring command,
12902         in wstring[] arguments,
12903         in wstring[] environment,
12904         in ProcessCreateFlag[] flags,
12905         in unsigned long timeoutMS,
12906         [retval] out IGuestProcess guestProcess
12907     );
12908 
12978     void processCreateEx (
12979         in wstring command,
12980         in wstring[] arguments,
12981         in wstring[] environment,
12982         in ProcessCreateFlag[] flags,
12983         in unsigned long timeoutMS,
12984         in ProcessPriority priority,
12985         in long[] affinity,
12986         [retval] out IGuestProcess guestProcess
12987     );
12988 
12998     void processGet (
12999         in unsigned long pid,
13000         [retval] out IGuestProcess guestProcess
13001     );
13002 
13025     void symlinkCreate (
13026         in wstring source,
13027         in wstring target,
13028         in SymlinkType type
13029     );
13030 
13048     void symlinkExists (
13049         in wstring symlink,
13050         [retval] out boolean exists
13051     );
13052 
13076     void symlinkRead (
13077         in wstring symlink,
13078         in SymlinkReadFlag[] flags,
13079         [retval] out wstring target
13080     );
13081 
13097     void symlinkRemoveDirectory (
13098         in wstring path
13099     );
13100 
13116     void symlinkRemoveFile (
13117         in wstring file
13118     );
13119 
13120 }; /* interface IGuestSession */
13121 
13129 interface IProcess : $unknown
13130 {
13136     readonly attribute unsigned long PID;
13137 
13144     readonly attribute ProcessStatus status;
13145 
13152     readonly attribute long exitCode;
13153 
13159     readonly attribute wstring[] environment;
13160 
13166     readonly attribute wstring[] arguments;
13167 
13171     readonly attribute wstring executablePath;
13172 
13176     readonly attribute wstring name;
13177 
13198     void waitFor (
13199         in unsigned long waitFor,
13200         in unsigned long timeoutMS,
13201         [retval] out ProcessWaitResult reason
13202     );
13203 
13225     void waitForArray (
13226         in ProcessWaitForFlag[] waitFor,
13227         in unsigned long timeoutMS,
13228         [retval] out ProcessWaitResult reason
13229     );
13230 
13247     void read (
13248         in unsigned long handle,
13249         in unsigned long toRead,
13250         in unsigned long timeoutMS,
13251         [retval] out octet[] data
13252     );
13253 
13277     void write (
13278         in unsigned long handle,
13279         in unsigned long flags,
13280         in octet[] data,
13281         in unsigned long timeoutMS,
13282         [retval] out unsigned long written
13283     );
13284 
13309     void writeArray (
13310         in unsigned long handle,
13311         in ProcessInputFlag[] flags,
13312         in octet[] data,
13313         in unsigned long timeoutMS,
13314         [retval] out unsigned long written
13315     );
13316 
13322     void terminate();
13323 
13324 }; /* interface IProcess */
13325 
13334 interface IGuestProcess : IProcess
13335 {
13336 }; /* interface IGuestProcess */
13337 
13345 interface IDirectory : $unknown
13346 {
13352     readonly attribute wstring directoryName;
13353 
13359     readonly attribute wstring filter;
13360 
13367     void close();
13368 
13383     void read (
13384         [retval] out IFsObjInfo objInfo
13385     );
13386 
13387 }; /* interface IDirectory */
13388 
13397 interface IGuestDirectory : IDirectory
13398 {
13399 }; /* interface IGuestDirectory */
13400 
13408 interface IFile : $unknown
13409 {
13415     readonly attribute unsigned long creationMode;
13416 
13422     readonly attribute unsigned long disposition;
13423 
13429     readonly attribute wstring fileName;
13430 
13436     readonly attribute long long initialSize;
13437 
13443     readonly attribute unsigned long openMode;
13444 
13450     readonly attribute long long offset;
13451 
13458     void close();
13459 
13475     void queryInfo (
13476         [retval] out IFsObjInfo objInfo
13477     );
13478 
13501     void read (
13502         in unsigned long toRead,
13503         in unsigned long timeoutMS,
13504         [retval] out octet[] data
13505     );
13506 
13531     void readAt (
13532         in long long offset,
13533         in unsigned long toRead,
13534         in unsigned long timeoutMS,
13535         [retval] out octet[] data
13536     );
13537 
13557     void seek (
13558         in long long offset,
13559         in FileSeekType whence
13560     );
13561 
13577     void setACL (
13578         in wstring acl
13579     );
13580 
13598     void write (
13599         in octet[] data,
13600         in unsigned long timeoutMS,
13601         [retval] out unsigned long written
13602     );
13603 
13631     void writeAt (
13632         in long long offset,
13633         in octet[] data,
13634         in unsigned long timeoutMS,
13635         [retval] out unsigned long written
13636     );
13637 
13638 }; /* interface IFile */
13639 
13648 interface IGuestFile : IFile
13649 {
13650 }; /* interface IGuestFile */
13651 
13660 interface IFsObjInfo : $unknown
13661 {
13667     readonly attribute long long accessTime;
13668 
13674     readonly attribute long long allocatedSize;
13675 
13681     readonly attribute long long birthTime;
13682 
13688     readonly attribute long long changeTime;
13689 
13695     readonly attribute unsigned long deviceNumber;
13696 
13702     readonly attribute wstring fileAttributes;
13703 
13709     readonly attribute unsigned long generationId;
13710 
13716     readonly attribute unsigned long GID;
13717 
13723     readonly attribute wstring groupName;
13724 
13730     readonly attribute unsigned long hardLinks;
13731 
13737     readonly attribute long long modificationTime;
13738 
13744     readonly attribute wstring name;
13745 
13751     readonly attribute long long nodeId;
13752 
13758     readonly attribute unsigned long nodeIdDevice;
13759 
13767     readonly attribute long long objectSize;
13768 
13774     readonly attribute FsObjType type;
13775 
13781     readonly attribute unsigned long UID;
13782 
13788     readonly attribute unsigned long userFlags;
13789 
13795     readonly attribute wstring userName;
13796 
13797 }; /* interface IFsObjInfo */
13798 
13807 interface IGuestFsObjInfo : IFsObjInfo
13808 {
13809 }; /* interface IGuestFsObjInfo */
13810 
13824 interface IGuest : $unknown
13825 {
13840     readonly attribute wstring OSTypeId;
13841 
13847     readonly attribute AdditionsRunLevelType additionsRunLevel;
13848 
13855     readonly attribute wstring additionsVersion;
13856 
13864     readonly attribute unsigned long additionsRevision;
13865 
13872     readonly attribute IAdditionsFacility[] facilities;
13873 
13877     readonly attribute IGuestSession[] sessions;
13878 
13882     attribute unsigned long memoryBalloonSize;
13883 
13887     attribute unsigned long statisticsUpdateInterval;
13888 
13920     void internalGetStatistics (
13921         out unsigned long cpuUser,
13922         out unsigned long cpuKernel,
13923         out unsigned long cpuIdle,
13924         out unsigned long memTotal,
13925         out unsigned long memFree,
13926         out unsigned long memBalloon,
13927         out unsigned long memShared,
13928         out unsigned long memCache,
13929         out unsigned long pagedTotal,
13930         out unsigned long memAllocTotal,
13931         out unsigned long memFreeTotal,
13932         out unsigned long memBalloonTotal,
13933         out unsigned long memSharedTotal
13934     );
13935 
13947     void getFacilityStatus (
13948         in AdditionsFacilityType facility,
13949         out long long timestamp,
13950         [retval] out AdditionsFacilityStatus status
13951     );
13952 
13970     void getAdditionsStatus (
13971         in AdditionsRunLevelType level,
13972         [retval] out boolean active
13973     );
13974 
14004     void setCredentials (
14005         in wstring userName,
14006         in wstring password,
14007         in wstring domain,
14008         in boolean allowInteractiveLogon
14009     );
14010 
14040     void dragHGEnter (
14041         in unsigned long screenId,
14042         in unsigned long y,
14043         in unsigned long x,
14044         in DragAndDropAction defaultAction,
14045         in DragAndDropAction[] allowedActions,
14046         in wstring[] formats,
14047         [retval] out DragAndDropAction resultAction
14048     );
14049 
14079     void dragHGMove (
14080         in unsigned long screenId,
14081         in unsigned long x,
14082         in unsigned long y,
14083         in DragAndDropAction defaultAction,
14084         in DragAndDropAction[] allowedActions,
14085         in wstring[] formats,
14086         [retval] out DragAndDropAction resultAction
14087     );
14088 
14106     void dragHGLeave (
14107         in unsigned long screenId
14108     );
14109 
14141     void dragHGDrop (
14142         in unsigned long screenId,
14143         in unsigned long x,
14144         in unsigned long y,
14145         in DragAndDropAction defaultAction,
14146         in DragAndDropAction[] allowedActions,
14147         in wstring[] formats,
14148         out wstring format,
14149         [retval] out DragAndDropAction resultAction
14150     );
14151 
14175     void dragHGPutData (
14176         in unsigned long screenId,
14177         in wstring format,
14178         in octet[] data,
14179         [retval] out IProgress progress
14180     );
14181 
14207     void dragGHPending (
14208         in unsigned long screenId,
14209         out wstring[] format,
14210         out DragAndDropAction[] allowedActions,
14211         [retval] out DragAndDropAction defaultAction
14212     );
14213 
14235     void dragGHDropped (
14236         in wstring format,
14237         in DragAndDropAction action,
14238         [retval] out IProgress progress
14239     );
14240 
14258     void dragGHGetData (
14259         [retval] out octet[] data
14260     );
14261 
14316     void createSession (
14317         in wstring user,
14318         in wstring password,
14319         in wstring domain,
14320         in wstring sessionName,
14321         [retval] out IGuestSession guestSession
14322     );
14323 
14338     void findSession (
14339         in wstring sessionName,
14340         [retval] out IGuestSession[] sessions
14341     );
14342 
14366     void updateGuestAdditions (
14367         in wstring source,
14368         in AdditionsUpdateFlag[] flags,
14369         [retval] out IProgress progress
14370     );
14371 
14372 }; /* interface IGuest */
14373 
14414 interface IProgress : $unknown
14415 {
14419     readonly attribute wstringUUID id;
14420 
14424     readonly attribute wstring description;
14425 
14429     readonly attribute $unknown initiator;
14430 
14434     readonly attribute boolean cancelable;
14435 
14443     readonly attribute unsigned long percent;
14444 
14458     readonly attribute long timeRemaining;
14459 
14463     readonly attribute boolean completed;
14464 
14468     readonly attribute boolean canceled;
14469 
14476     readonly attribute long resultCode;
14477 
14487     readonly attribute IVirtualBoxErrorInfo errorInfo;
14488 
14495     readonly attribute unsigned long operationCount;
14496 
14500     readonly attribute unsigned long operation;
14501 
14507     readonly attribute wstring operationDescription;
14508 
14512     readonly attribute unsigned long operationPercent;
14513 
14517     readonly attribute unsigned long operationWeight;
14518 
14526     attribute unsigned long timeout;
14527 
14531     void setCurrentOperationProgress (
14532         in unsigned long percent
14533     );
14534 
14538     void setNextOperation (
14539         in wstring nextOperationDescription,
14540         in unsigned long nextOperationsWeight
14541     );
14542 
14569     void waitForCompletion (
14570         in long timeout
14571     );
14572 
14596     void waitForOperationCompletion (
14597         in unsigned long operation,
14598         in long timeout
14599     );
14600 
14626     void waitForAsyncProgressCompletion (
14627         in IProgress pProgressAsync
14628     );
14629 
14646     void cancel();
14647 
14648 }; /* interface IProgress */
14649 
14733 interface ISnapshot : $unknown
14734 {
14738     readonly attribute wstringUUID id;
14739 
14747     attribute wstring name;
14748 
14756     attribute wstring description;
14757 
14763     readonly attribute long long timeStamp;
14764 
14776     readonly attribute boolean online;
14777 
14789     readonly attribute IMachine machine;
14790 
14797     readonly attribute ISnapshot parent;
14798 
14807     readonly attribute ISnapshot[] children;
14808 
14816     void getChildrenCount (
14817         [retval] out unsigned long childrenCount
14818     );
14819 
14820 }; /* interface ISnapshot */
14821 
15008 interface IMediumAttachment : $unknown
15009 {
15014     readonly attribute IMedium medium;
15015 
15021     readonly attribute wstring controller;
15022 
15028     readonly attribute long port;
15029 
15035     readonly attribute long device;
15036 
15040     readonly attribute DeviceType type;
15041 
15045     readonly attribute boolean passthrough;
15046 
15050     readonly attribute boolean temporaryEject;
15051 
15056     readonly attribute boolean isEjected;
15057 
15061     readonly attribute boolean nonRotational;
15062 
15066     readonly attribute boolean discard;
15067 
15071     readonly attribute IBandwidthGroup bandwidthGroup;
15072 
15073 }; /* interface IMediumAttachment */
15074 
15232 interface IMedium : $unknown
15233 {
15247     readonly attribute wstringUUID id;
15248 
15267     attribute wstring description;
15268 
15284     readonly attribute MediumState state;
15285 
15294     readonly attribute unsigned long variant;
15295 
15317     attribute wstring location;
15318 
15338     readonly attribute wstring name;
15339 
15344     readonly attribute DeviceType deviceType;
15345 
15349     readonly attribute boolean hostDrive;
15350 
15363     readonly attribute long long size;
15364 
15379     readonly attribute wstring format;
15380 
15396     readonly attribute IMediumFormat mediumFormat;
15397 
15422     attribute MediumType type;
15423 
15437     readonly attribute MediumType[] allowedTypes;
15438 
15448     readonly attribute IMedium parent;
15449 
15457     readonly attribute IMedium[] children;
15458 
15469     readonly attribute IMedium base;
15470 
15503     readonly attribute boolean readOnly;
15504 
15525     readonly attribute long long logicalSize;
15526 
15554     attribute boolean autoReset;
15555 
15570     readonly attribute wstring lastAccessError;
15571 
15588     readonly attribute wstringUUID[] machineIds;
15589 
15615     void setIds (
15616         in boolean setImageId,
15617         in wstringUUID imageId,
15618         in boolean setParentId,
15619         in wstringUUID parentId
15620     );
15621 
15656     void refreshState (
15657         [retval] out MediumState state
15658     );
15659 
15686     void getSnapshotIds (
15687         in wstringUUID machineId,
15688         [retval] out wstringUUID[] snapshotIds
15689     );
15690 
15750     void lockRead (
15751         [retval] out MediumState state
15752     );
15753 
15776     void unlockRead (
15777         [retval] out MediumState state
15778     );
15779 
15834     void lockWrite (
15835         [retval] out MediumState state
15836     );
15837 
15860     void unlockWrite (
15861         [retval] out MediumState state
15862     );
15863 
15913     void close();
15914 
15944     void getProperty (
15945         in wstring name,
15946         [retval] out wstring value
15947     );
15948 
15980     void setProperty (
15981         in wstring name,
15982         in wstring value
15983     );
15984 
16019     void getProperties (
16020         in wstring names,
16021         out wstring[] returnNames,
16022         [retval] out wstring[] returnValues
16023     );
16024 
16054     void setProperties (
16055         in wstring[] names,
16056         in wstring[] values
16057     );
16058 
16091     void createBaseStorage (
16092         in long long logicalSize,
16093         in unsigned long variant,
16094         [retval] out IProgress progress
16095     );
16096 
16148     void deleteStorage (
16149         [retval] out IProgress progress
16150     );
16151 
16190     void createDiffStorage (
16191         in IMedium target,
16192         in unsigned long variant,
16193         [retval] out IProgress progress
16194     );
16195 
16271     void mergeTo (
16272         in IMedium target,
16273         [retval] out IProgress progress
16274     );
16275 
16325     void cloneTo (
16326         in IMedium target,
16327         in unsigned long variant,
16328         in IMedium parent,
16329         [retval] out IProgress progress
16330     );
16331 
16379     void cloneToBase (
16380         in IMedium target,
16381         in unsigned long variant,
16382         [retval] out IProgress progress
16383     );
16384 
16413     void compact (
16414         [retval] out IProgress progress
16415     );
16416 
16449     void resize (
16450         in long long logicalSize,
16451         [retval] out IProgress progress
16452     );
16453 
16487     void reset (
16488         [retval] out IProgress progress
16489     );
16490 
16491 }; /* interface IMedium */
16492 
16515 interface IMediumFormat : $unknown
16516 {
16535     readonly attribute wstring id;
16536 
16544     readonly attribute wstring name;
16545 
16554     readonly attribute unsigned long capabilities;
16555 
16574     void describeFileExtensions (
16575         out wstring[] extensions,
16576         out DeviceType[] type
16577     );
16578 
16606     void describeProperties (
16607         out wstring[] names,
16608         out wstring[] description,
16609         out DataType[] types,
16610         out unsigned long[] flags,
16611         out wstring[] defaults
16612     );
16613 
16614 }; /* interface IMediumFormat */
16615 
16628 interface IKeyboard : $unknown
16629 {
16635     readonly attribute IEventSource eventSource;
16636 
16649     void putScancode (
16650         in long scancode
16651     );
16652 
16665     void putScancodes (
16666         in long[] scancodes,
16667         [retval] out unsigned long codesStored
16668     );
16669 
16684     void putCAD();
16685 
16686 }; /* interface IKeyboard */
16687 
16699 interface IMouse : $unknown
16700 {
16715     readonly attribute boolean absoluteSupported;
16716 
16731     readonly attribute boolean relativeSupported;
16732 
16747     readonly attribute boolean needsHostCursor;
16748 
16754     readonly attribute IEventSource eventSource;
16755 
16821     void putMouseEvent (
16822         in long dx,
16823         in long dy,
16824         in long dz,
16825         in long dw,
16826         in long buttonState
16827     );
16828 
16901     void putMouseEventAbsolute (
16902         in long x,
16903         in long y,
16904         in long dz,
16905         in long dw,
16906         in long buttonState
16907     );
16908 
16909 }; /* interface IMouse */
16910 
16911 interface IFramebuffer : $unknown
16912 {
16921     readonly attribute octetPtr address;
16922 
16926     readonly attribute unsigned long width;
16927 
16931     readonly attribute unsigned long height;
16932 
16939     readonly attribute unsigned long bitsPerPixel;
16940 
16947     readonly attribute unsigned long bytesPerLine;
16948 
16959     readonly attribute unsigned long pixelFormat;
16960 
16967     readonly attribute boolean usesGuestVRAM;
16968 
16978     readonly attribute unsigned long heightReduction;
16979 
16994     readonly attribute IFramebufferOverlay overlay;
16995 
17002     readonly attribute long long winId;
17003 
17011     void lock();
17012 
17020     void unlock();
17021 
17029     void notifyUpdate (
17030         in unsigned long x,
17031         in unsigned long y,
17032         in unsigned long width,
17033         in unsigned long height
17034     );
17035 
17148     void requestResize (
17149         in unsigned long screenId,
17150         in unsigned long pixelFormat,
17151         in octetPtr VRAM,
17152         in unsigned long bitsPerPixel,
17153         in unsigned long bytesPerLine,
17154         in unsigned long width,
17155         in unsigned long height,
17156         [retval] out boolean finished
17157     );
17158 
17170     void videoModeSupported (
17171         in unsigned long width,
17172         in unsigned long height,
17173         in unsigned long bpp,
17174         [retval] out boolean supported
17175     );
17176 
17213     void getVisibleRegion (
17214         in octetPtr rectangles,
17215         in unsigned long count,
17216         [retval] out unsigned long countCopied
17217     );
17218 
17253     void setVisibleRegion (
17254         in octetPtr rectangles,
17255         in unsigned long count
17256     );
17257 
17278     void processVHWACommand (
17279         in octetPtr command
17280     );
17281 
17282 }; /* interface IFramebuffer */
17283 
17298 interface IFramebufferOverlay : IFramebuffer
17299 {
17303     readonly attribute unsigned long x;
17304 
17308     readonly attribute unsigned long y;
17309 
17315     attribute boolean visible;
17316 
17323     attribute unsigned long alpha;
17324 
17330     void move (
17331         in unsigned long x,
17332         in unsigned long y
17333     );
17334 
17335 }; /* interface IFramebufferOverlay */
17336 
17352 interface IDisplay : $unknown
17353 {
17357     void getScreenResolution (
17358         in unsigned long screenId,
17359         out unsigned long width,
17360         out unsigned long height,
17361         out unsigned long bitsPerPixel
17362     );
17363 
17369     void setFramebuffer (
17370         in unsigned long screenId,
17371         in IFramebuffer framebuffer
17372     );
17373 
17379     void getFramebuffer (
17380         in unsigned long screenId,
17381         out IFramebuffer framebuffer,
17382         out long xOrigin,
17383         out long yOrigin
17384     );
17385 
17436     void setVideoModeHint (
17437         in unsigned long display,
17438         in boolean enabled,
17439         in boolean changeOrigin,
17440         in long originX,
17441         in long originY,
17442         in unsigned long width,
17443         in unsigned long height,
17444         in unsigned long bitsPerPixel
17445     );
17446 
17458     void setSeamlessMode (
17459         in boolean enabled
17460     );
17461 
17497     void takeScreenShot (
17498         in unsigned long screenId,
17499         in octetPtr address,
17500         in unsigned long width,
17501         in unsigned long height
17502     );
17503 
17547     void takeScreenShotToArray (
17548         in unsigned long screenId,
17549         in unsigned long width,
17550         in unsigned long height,
17551         [retval] out octet[] screenData
17552     );
17553 
17592     void takeScreenShotPNGToArray (
17593         in unsigned long screenId,
17594         in unsigned long width,
17595         in unsigned long height,
17596         [retval] out octet[] screenData
17597     );
17598 
17650     void drawToScreen (
17651         in unsigned long screenId,
17652         in octetPtr address,
17653         in unsigned long x,
17654         in unsigned long y,
17655         in unsigned long width,
17656         in unsigned long height
17657     );
17658 
17673     void invalidateAndUpdate();
17674 
17688     void resizeCompleted (
17689         in unsigned long screenId
17690     );
17691 
17704     void completeVHWACommand (
17705         in octetPtr command
17706     );
17707 
17741     void viewportChanged (
17742         in unsigned long screenId,
17743         in unsigned long x,
17744         in unsigned long y,
17745         in unsigned long width,
17746         in unsigned long height
17747     );
17748 
17749 }; /* interface IDisplay */
17750 
17766 interface INetworkAdapter : $unknown
17767 {
17775     attribute NetworkAdapterType adapterType;
17776 
17784     readonly attribute unsigned long slot;
17785 
17794     attribute boolean enabled;
17795 
17802     attribute wstring MACAddress;
17803 
17809     attribute NetworkAttachmentType attachmentType;
17810 
17816     attribute wstring bridgedInterface;
17817 
17823     attribute wstring hostOnlyInterface;
17824 
17830     attribute wstring internalNetwork;
17831 
17837     attribute wstring NATNetwork;
17838 
17844     attribute wstring genericDriver;
17845 
17852     attribute boolean cableConnected;
17853 
17859     attribute unsigned long lineSpeed;
17860 
17867     attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
17868 
17875     attribute boolean traceEnabled;
17876 
17883     attribute wstring traceFile;
17884 
17892     readonly attribute INATEngine NATEngine;
17893 
17900     attribute unsigned long bootPriority;
17901 
17905     attribute IBandwidthGroup bandwidthGroup;
17906 
17925     void getProperty (
17926         in wstring key,
17927         [retval] out wstring value
17928     );
17929 
17948     void setProperty (
17949         in wstring key,
17950         in wstring value
17951     );
17952 
17980     void getProperties (
17981         in wstring names,
17982         out wstring[] returnNames,
17983         [retval] out wstring[] returnValues
17984     );
17985 
17986 }; /* interface INetworkAdapter */
17987 
18016 interface ISerialPort : $unknown
18017 {
18025     readonly attribute unsigned long slot;
18026 
18033     attribute boolean enabled;
18034 
18038     attribute unsigned long IOBase;
18039 
18043     attribute unsigned long IRQ;
18044 
18055     attribute PortMode hostMode;
18056 
18064     attribute boolean server;
18065 
18075     attribute wstring path;
18076 
18077 }; /* interface ISerialPort */
18078 
18098 interface IParallelPort : $unknown
18099 {
18107     readonly attribute unsigned long slot;
18108 
18115     attribute boolean enabled;
18116 
18120     attribute unsigned long IOBase;
18121 
18125     attribute unsigned long IRQ;
18126 
18134     attribute wstring path;
18135 
18136 }; /* interface IParallelPort */
18137 
18138 interface IMachineDebugger : $unknown
18139 {
18143     attribute boolean singleStep;
18144 
18148     attribute boolean recompileUser;
18149 
18153     attribute boolean recompileSupervisor;
18154 
18158     attribute boolean PATMEnabled;
18159 
18163     attribute boolean CSAMEnabled;
18164 
18168     attribute boolean logEnabled;
18169 
18173     readonly attribute wstring logDbgFlags;
18174 
18178     readonly attribute wstring logDbgGroups;
18179 
18183     readonly attribute wstring logDbgDestinations;
18184 
18188     readonly attribute wstring logRelFlags;
18189 
18193     readonly attribute wstring logRelGroups;
18194 
18198     readonly attribute wstring logRelDestinations;
18199 
18206     readonly attribute boolean HWVirtExEnabled;
18207 
18214     readonly attribute boolean HWVirtExNestedPagingEnabled;
18215 
18222     readonly attribute boolean HWVirtExVPIDEnabled;
18223 
18232     readonly attribute wstring OSName;
18233 
18242     readonly attribute wstring OSVersion;
18243 
18250     readonly attribute boolean PAEEnabled;
18251 
18258     attribute unsigned long virtualTimeRate;
18259 
18266     readonly attribute long long VM;
18267 
18283     void dumpGuestCore (
18284         in wstring filename,
18285         in wstring compression
18286     );
18287 
18304     void dumpHostProcessCore (
18305         in wstring filename,
18306         in wstring compression
18307     );
18308 
18329     void info (
18330         in wstring name,
18331         in wstring args,
18332         [retval] out wstring info
18333     );
18334 
18340     void injectNMI();
18341 
18352     void modifyLogGroups (
18353         in wstring settings
18354     );
18355 
18366     void modifyLogFlags (
18367         in wstring settings
18368     );
18369 
18380     void modifyLogDestinations (
18381         in wstring settings
18382     );
18383 
18398     void readPhysicalMemory (
18399         in long long address,
18400         in unsigned long size,
18401         [retval] out octet[] bytes
18402     );
18403 
18418     void writePhysicalMemory (
18419         in long long address,
18420         in unsigned long size,
18421         in octet[] bytes
18422     );
18423 
18440     void readVirtualMemory (
18441         in unsigned long cpuId,
18442         in long long address,
18443         in unsigned long size,
18444         [retval] out octet[] bytes
18445     );
18446 
18463     void writeVirtualMemory (
18464         in unsigned long cpuId,
18465         in long long address,
18466         in unsigned long size,
18467         in octet[] bytes
18468     );
18469 
18482     void detectOS (
18483         [retval] out wstring os
18484     );
18485 
18503     void getRegister (
18504         in unsigned long cpuId,
18505         in wstring name,
18506         [retval] out wstring value
18507     );
18508 
18526     void getRegisters (
18527         in unsigned long cpuId,
18528         out wstring[] names,
18529         out wstring[] values
18530     );
18531 
18550     void setRegister (
18551         in unsigned long cpuId,
18552         in wstring name,
18553         in wstring value
18554     );
18555 
18574     void setRegisters (
18575         in unsigned long cpuId,
18576         in wstring[] names,
18577         in wstring[] values
18578     );
18579 
18592     void dumpGuestStack (
18593         in unsigned long cpuId,
18594         [retval] out wstring stack
18595     );
18596 
18604     void resetStats (
18605         in wstring pattern
18606     );
18607 
18615     void dumpStats (
18616         in wstring pattern
18617     );
18618 
18630     void getStats (
18631         in wstring pattern,
18632         in boolean withDescriptions,
18633         out wstring stats
18634     );
18635 
18636 }; /* interface IMachineDebugger */
18637 
18638 interface IUSBController : $unknown
18639 {
18648     attribute boolean enabled;
18649 
18658     attribute boolean enabledEHCI;
18659 
18665     readonly attribute boolean proxyAvailable;
18666 
18674     readonly attribute unsigned short USBStandard;
18675 
18701     readonly attribute IUSBDeviceFilter[] deviceFilters;
18702 
18730     void createDeviceFilter (
18731         in wstring name,
18732         [retval] out IUSBDeviceFilter filter
18733     );
18734 
18779     void insertDeviceFilter (
18780         in unsigned long position,
18781         in IUSBDeviceFilter filter
18782     );
18783 
18816     void removeDeviceFilter (
18817         in unsigned long position,
18818         [retval] out IUSBDeviceFilter filter
18819     );
18820 
18821 }; /* interface IUSBController */
18822 
18835 interface IUSBDevice : $unknown
18836 {
18843     readonly attribute wstringUUID id;
18844 
18848     readonly attribute unsigned short vendorId;
18849 
18853     readonly attribute unsigned short productId;
18854 
18862     readonly attribute unsigned short revision;
18863 
18867     readonly attribute wstring manufacturer;
18868 
18872     readonly attribute wstring product;
18873 
18877     readonly attribute wstring serialNumber;
18878 
18882     readonly attribute wstring address;
18883 
18890     readonly attribute unsigned short port;
18891 
18897     readonly attribute unsigned short version;
18898 
18906     readonly attribute unsigned short portVersion;
18907 
18914     readonly attribute boolean remote;
18915 
18916 }; /* interface IUSBDevice */
18917 
18992 interface IUSBDeviceFilter : $unknown
18993 {
19001     attribute wstring name;
19002 
19006     attribute boolean active;
19007 
19015     attribute wstring vendorId;
19016 
19024     attribute wstring productId;
19025 
19039     attribute wstring revision;
19040 
19045     attribute wstring manufacturer;
19046 
19051     attribute wstring product;
19052 
19057     attribute wstring serialNumber;
19058 
19063     attribute wstring port;
19064 
19074     attribute wstring remote;
19075 
19085     attribute unsigned long maskedInterfaces;
19086 
19087 }; /* interface IUSBDeviceFilter */
19088 
19105 interface IHostUSBDevice : IUSBDevice
19106 {
19112     readonly attribute USBDeviceState state;
19113 
19114 }; /* interface IHostUSBDevice */
19115 
19138 interface IHostUSBDeviceFilter : IUSBDeviceFilter
19139 {
19146     attribute USBDeviceFilterAction action;
19147 
19148 }; /* interface IHostUSBDeviceFilter */
19149 
19158 interface IAudioAdapter : $unknown
19159 {
19168     attribute boolean enabled;
19169 
19175     attribute AudioControllerType audioController;
19176 
19183     attribute AudioDriverType audioDriver;
19184 
19185 }; /* interface IAudioAdapter */
19186 
19187 interface IVRDEServer : $unknown
19188 {
19192     attribute boolean enabled;
19193 
19197     attribute AuthType authType;
19198 
19202     attribute unsigned long authTimeout;
19203 
19210     attribute boolean allowMultiConnection;
19211 
19219     attribute boolean reuseSingleConnection;
19220 
19227     attribute wstring VRDEExtPack;
19228 
19235     attribute wstring authLibrary;
19236 
19242     readonly attribute wstring[] VRDEProperties;
19243 
19257     void setVRDEProperty (
19258         in wstring key,
19259         in wstring value
19260     );
19261 
19275     void getVRDEProperty (
19276         in wstring key,
19277         [retval] out wstring value
19278     );
19279 
19280 }; /* interface IVRDEServer */
19281 
19339 interface ISharedFolder : $unknown
19340 {
19344     readonly attribute wstring name;
19345 
19349     readonly attribute wstring hostPath;
19350 
19360     readonly attribute boolean accessible;
19361 
19368     readonly attribute boolean writable;
19369 
19375     readonly attribute boolean autoMount;
19376 
19389     readonly attribute wstring lastAccessError;
19390 
19391 }; /* interface ISharedFolder */
19392 
19393 interface IInternalSessionControl : $unknown
19394 {
19399     void getPID (
19400         [retval] out unsigned long pid
19401     );
19402 
19424     void getRemoteConsole (
19425         [retval] out IConsole console
19426     );
19427 
19451     void assignMachine (
19452         in IMachine machine,
19453         in LockType lockType
19454     );
19455 
19470     void assignRemoteMachine (
19471         in IMachine machine,
19472         in IConsole console
19473     );
19474 
19498     void updateMachineState (
19499         in MachineState aMachineState
19500     );
19501 
19517     void uninitialize();
19518 
19541     void onNetworkAdapterChange (
19542         in INetworkAdapter networkAdapter,
19543         in boolean changeAdapter
19544     );
19545 
19568     void onSerialPortChange (
19569         in ISerialPort serialPort
19570     );
19571 
19594     void onParallelPortChange (
19595         in IParallelPort parallelPort
19596     );
19597 
19620     void onStorageControllerChange();
19621 
19648     void onMediumChange (
19649         in IMediumAttachment mediumAttachment,
19650         in boolean force
19651     );
19652 
19679     void onStorageDeviceChange (
19680         in IMediumAttachment mediumAttachment,
19681         in boolean remove
19682     );
19683 
19691     void onClipboardModeChange (
19692         in ClipboardMode clipboardMode
19693     );
19694 
19702     void onDragAndDropModeChange (
19703         in DragAndDropMode dragAndDropMode
19704     );
19705 
19715     void onCPUChange (
19716         in unsigned long cpu,
19717         in boolean add
19718     );
19719 
19727     void onCPUExecutionCapChange (
19728         in unsigned long executionCap
19729     );
19730 
19755     void onVRDEServerChange (
19756         in boolean restart
19757     );
19758 
19781     void onUSBControllerChange();
19782 
19811     void onSharedFolderChange (
19812         in boolean global
19813     );
19814 
19840     void onUSBDeviceAttach (
19841         in IUSBDevice device,
19842         in IVirtualBoxErrorInfo error,
19843         in unsigned long maskedInterfaces
19844     );
19845 
19871     void onUSBDeviceDetach (
19872         in wstringUUID id,
19873         in IVirtualBoxErrorInfo error
19874     );
19875 
19893     void onShowWindow (
19894         in boolean check,
19895         out boolean canShow,
19896         out long long winId
19897     );
19898 
19906     void onBandwidthGroupChange (
19907         in IBandwidthGroup bandwidthGroup
19908     );
19909 
19933     void accessGuestProperty (
19934         in wstring name,
19935         in wstring value,
19936         in wstring flags,
19937         in boolean isSetter,
19938         out wstring retValue,
19939         out long long retTimestamp,
19940         out wstring retFlags
19941     );
19942 
19990     void enumerateGuestProperties (
19991         in wstring patterns,
19992         out wstring[] key,
19993         out wstring[] value,
19994         out long long[] timestamp,
19995         out wstring[] flags
19996     );
19997 
20043     void onlineMergeMedium (
20044         in IMediumAttachment mediumAttachment,
20045         in unsigned long sourceIdx,
20046         in unsigned long targetIdx,
20047         in IMedium source,
20048         in IMedium target,
20049         in boolean mergeForward,
20050         in IMedium parentForTarget,
20051         in IMedium[] childrenToReparent,
20052         in IProgress progress
20053     );
20054 
20078     void enableVMMStatistics (
20079         in boolean enable
20080     );
20081 
20082 }; /* interface IInternalSessionControl */
20083 
20142 interface ISession : $unknown
20143 {
20147     readonly attribute SessionState state;
20148 
20156     readonly attribute SessionType type;
20157 
20161     readonly attribute IMachine machine;
20162 
20166     readonly attribute IConsole console;
20167 
20199     void unlockMachine();
20200 
20201 }; /* interface ISession */
20202 
20225 interface IStorageController : $unknown
20226 {
20235     readonly attribute wstring name;
20236 
20242     readonly attribute unsigned long maxDevicesPerPortCount;
20243 
20249     readonly attribute unsigned long minPortCount;
20250 
20256     readonly attribute unsigned long maxPortCount;
20257 
20263     attribute unsigned long instance;
20264 
20273     attribute unsigned long portCount;
20274 
20280     readonly attribute StorageBus bus;
20281 
20294     attribute StorageControllerType controllerType;
20295 
20310     attribute boolean useHostIOCache;
20311 
20317     readonly attribute boolean bootable;
20318 
20341     void getIDEEmulationPort (
20342         in long devicePosition,
20343         [retval] out long portNumber
20344     );
20345 
20369     void setIDEEmulationPort (
20370         in long devicePosition,
20371         in long portNumber
20372     );
20373 
20374 }; /* interface IStorageController */
20375 
20399 interface IManagedObjectRef : $unknown
20400 {
20407     void getInterfaceName (
20408         [retval] out wstring return
20409     );
20410 
20418     void release();
20419 
20420 }; /* interface IManagedObjectRef */
20421 
20430 interface IWebsessionManager : $unknown
20431 {
20440     void logon (
20441         in wstring username,
20442         in wstring password,
20443         [retval] out IVirtualBox return
20444     );
20445 
20455     void getSessionObject (
20456         in IVirtualBox refIVirtualBox,
20457         [retval] out ISession return
20458     );
20459 
20467     void logoff (
20468         in IVirtualBox refIVirtualBox
20469     );
20470 
20471 }; /* interface IWebsessionManager */
20472 
20481 interface IPerformanceMetric : $unknown
20482 {
20488     readonly attribute wstring metricName;
20489 
20495     readonly attribute $unknown object;
20496 
20502     readonly attribute wstring description;
20503 
20509     readonly attribute unsigned long period;
20510 
20520     readonly attribute unsigned long count;
20521 
20527     readonly attribute wstring unit;
20528 
20534     readonly attribute long minimumValue;
20535 
20541     readonly attribute long maximumValue;
20542 
20543 }; /* interface IPerformanceMetric */
20544 
20651 interface IPerformanceCollector : $unknown
20652 {
20663     readonly attribute wstring[] metricNames;
20664 
20688     void getMetrics (
20689         in wstring[] metricNames,
20690         in $unknown[] objects,
20691         [retval] out IPerformanceMetric[] metrics
20692     );
20693 
20732     void setupMetrics (
20733         in wstring[] metricNames,
20734         in $unknown[] objects,
20735         in unsigned long period,
20736         in unsigned long count,
20737         [retval] out IPerformanceMetric[] affectedMetrics
20738     );
20739 
20768     void enableMetrics (
20769         in wstring[] metricNames,
20770         in $unknown[] objects,
20771         [retval] out IPerformanceMetric[] affectedMetrics
20772     );
20773 
20802     void disableMetrics (
20803         in wstring[] metricNames,
20804         in $unknown[] objects,
20805         [retval] out IPerformanceMetric[] affectedMetrics
20806     );
20807 
20896     void queryMetricsData (
20897         in wstring[] metricNames,
20898         in $unknown[] objects,
20899         out wstring[] returnMetricNames,
20900         out $unknown[] returnObjects,
20901         out wstring[] returnUnits,
20902         out unsigned long[] returnScales,
20903         out unsigned long[] returnSequenceNumbers,
20904         out unsigned long[] returnDataIndices,
20905         out unsigned long[] returnDataLengths,
20906         [retval] out long[] returnData
20907     );
20908 
20909 }; /* interface IPerformanceCollector */
20910 
20918 interface INATEngine : $unknown
20919 {
20924     attribute wstring network;
20925 
20932     attribute wstring hostIP;
20933 
20938     attribute wstring TFTPPrefix;
20939 
20944     attribute wstring TFTPBootFile;
20945 
20953     attribute wstring TFTPNextServer;
20954 
20958     attribute unsigned long aliasMode;
20959 
20963     attribute boolean DNSPassDomain;
20964 
20969     attribute boolean DNSProxy;
20970 
20975     attribute boolean DNSUseHostResolver;
20976 
20981     readonly attribute wstring[] redirects;
20982 
20998     void setNetworkSettings (
20999         in unsigned long mtu,
21000         in unsigned long sockSnd,
21001         in unsigned long sockRcv,
21002         in unsigned long TcpWndSnd,
21003         in unsigned long TcpWndRcv
21004     );
21005 
21010     void getNetworkSettings (
21011         out unsigned long mtu,
21012         out unsigned long sockSnd,
21013         out unsigned long sockRcv,
21014         out unsigned long TcpWndSnd,
21015         out unsigned long TcpWndRcv
21016     );
21017 
21037     void addRedirect (
21038         in wstring name,
21039         in NATProtocol proto,
21040         in wstring hostIP,
21041         in unsigned short hostPort,
21042         in wstring guestIP,
21043         in unsigned short guestPort
21044     );
21045 
21051     void removeRedirect (
21052         in wstring name
21053     );
21054 
21055 }; /* interface INATEngine */
21056 
21065 interface IExtPackPlugIn : $unknown
21066 {
21070     readonly attribute wstring name;
21071 
21075     readonly attribute wstring description;
21076 
21082     readonly attribute wstring frontend;
21083 
21087     readonly attribute wstring modulePath;
21088 
21089 }; /* interface IExtPackPlugIn */
21090 
21099 interface IExtPackBase : $unknown
21100 {
21104     readonly attribute wstring name;
21105 
21109     readonly attribute wstring description;
21110 
21122     readonly attribute wstring version;
21123 
21127     readonly attribute unsigned long revision;
21128 
21138     readonly attribute wstring edition;
21139 
21143     readonly attribute wstring VRDEModule;
21144 
21148     readonly attribute IExtPackPlugIn[] plugIns;
21149 
21159     readonly attribute boolean usable;
21160 
21167     readonly attribute wstring whyUnusable;
21168 
21172     readonly attribute boolean showLicense;
21173 
21182     readonly attribute wstring license;
21183 
21207     void queryLicense (
21208         in wstring preferredLocale,
21209         in wstring preferredLanguage,
21210         in wstring format,
21211         [retval] out wstring licenseText
21212     );
21213 
21214 }; /* interface IExtPackBase */
21215 
21224 interface IExtPack : IExtPackBase
21225 {
21237     void queryObject (
21238         in wstring objUuid,
21239         [retval] out $unknown returnInterface
21240     );
21241 
21242 }; /* interface IExtPack */
21243 
21253 interface IExtPackFile : IExtPackBase
21254 {
21260     readonly attribute wstring filePath;
21261 
21280     void install (
21281         in boolean replace,
21282         in wstring displayInfo,
21283         [retval] out IProgress progess
21284     );
21285 
21286 }; /* interface IExtPackFile */
21287 
21298 interface IExtPackManager : $unknown
21299 {
21305     readonly attribute IExtPack[] installedExtPacks;
21306 
21324     void find (
21325         in wstring name,
21326         [retval] out IExtPack returnData
21327     );
21328 
21340     void openExtPackFile (
21341         in wstring path,
21342         [retval] out IExtPackFile file
21343     );
21344 
21363     void uninstall (
21364         in wstring name,
21365         in boolean forcedRemoval,
21366         in wstring displayInfo,
21367         [retval] out IProgress progess
21368     );
21369 
21373     void cleanup();
21374 
21387     void queryAllPlugInsForFrontend (
21388         in wstring frontendName,
21389         [retval] out wstring[] plugInModules
21390     );
21391 
21399     void isExtPackUsable (
21400         in wstring name,
21401         [retval] out boolean usable
21402     );
21403 
21404 }; /* interface IExtPackManager */
21405 
21411 interface IBandwidthGroup : $unknown
21412 {
21416     readonly attribute wstring name;
21417 
21421     readonly attribute BandwidthGroupType type;
21422 
21426     readonly attribute unsigned long reference;
21427 
21432     attribute long long maxBytesPerSec;
21433 
21434 }; /* interface IBandwidthGroup */
21435 
21444 interface IBandwidthControl : $unknown
21445 {
21451     readonly attribute unsigned long numGroups;
21452 
21465     void createBandwidthGroup (
21466         in wstring name,
21467         in BandwidthGroupType type,
21468         in long long maxBytesPerSec
21469     );
21470 
21478     void deleteBandwidthGroup (
21479         in wstring name
21480     );
21481 
21491     void getBandwidthGroup (
21492         in wstring name,
21493         [retval] out IBandwidthGroup bandwidthGroup
21494     );
21495 
21503     void getAllBandwidthGroups (
21504         [retval] out IBandwidthGroup[] bandwidthGroups
21505     );
21506 
21507 }; /* interface IBandwidthControl */
21508 
21521 interface IVirtualBoxClient : $unknown
21522 {
21528     readonly attribute IVirtualBox virtualBox;
21529 
21535     readonly attribute ISession session;
21536 
21542     readonly attribute IEventSource eventSource;
21543 
21544 }; /* interface IVirtualBoxClient */
21545 
21559 interface IEventSource : $unknown
21560 {
21566     void createListener (
21567         [retval] out IEventListener listener
21568     );
21569 
21585     void createAggregator (
21586         in IEventSource[] subordinates,
21587         [retval] out IEventSource result
21588     );
21589 
21622     void registerListener (
21623         in IEventListener listener,
21624         in VBoxEventType[] interesting,
21625         in boolean active
21626     );
21627 
21636     void unregisterListener (
21637         in IEventListener listener
21638     );
21639 
21654     void fireEvent (
21655         in IEvent event,
21656         in long timeout,
21657         [retval] out boolean result
21658     );
21659 
21684     void getEvent (
21685         in IEventListener listener,
21686         in long timeout,
21687         [retval] out IEvent event
21688     );
21689 
21701     void eventProcessed (
21702         in IEventListener listener,
21703         in IEvent event
21704     );
21705 
21706 }; /* interface IEventSource */
21707 
21717 interface IEventListener : $unknown
21718 {
21731     void handleEvent (
21732         in IEvent event
21733     );
21734 
21735 }; /* interface IEventListener */
21736 
21813 interface IEvent : $unknown
21814 {
21820     readonly attribute VBoxEventType type;
21821 
21827     readonly attribute IEventSource source;
21828 
21839     readonly attribute boolean waitable;
21840 
21847     void setProcessed();
21848 
21862     void waitProcessed (
21863         in long timeout,
21864         [retval] out boolean result
21865     );
21866 
21867 }; /* interface IEvent */
21868 
21874 interface IReusableEvent : IEvent
21875 {
21879     readonly attribute unsigned long generation;
21880 
21887     void reuse();
21888 
21889 }; /* interface IReusableEvent */
21890 
21896 interface IMachineEvent : IEvent
21897 {
21901     readonly attribute wstringUUID machineId;
21902 
21903 }; /* interface IMachineEvent */
21904 
21910 interface IMachineStateChangedEvent : IMachineEvent
21911 {
21915     readonly attribute MachineState state;
21916 
21917 }; /* interface IMachineStateChangedEvent */
21918 
21926 interface IMachineDataChangedEvent : IMachineEvent
21927 {
21934     readonly attribute boolean temporary;
21935 
21936 }; /* interface IMachineDataChangedEvent */
21937 
21946 interface IMediumRegisteredEvent : IEvent
21947 {
21951     readonly attribute wstringUUID mediumId;
21952 
21956     readonly attribute DeviceType mediumType;
21957 
21964     readonly attribute boolean registered;
21965 
21966 }; /* interface IMediumRegisteredEvent */
21967 
21976 interface IMachineRegisteredEvent : IMachineEvent
21977 {
21984     readonly attribute boolean registered;
21985 
21986 }; /* interface IMachineRegisteredEvent */
21987 
21997 interface ISessionStateChangedEvent : IMachineEvent
21998 {
22004     readonly attribute SessionState state;
22005 
22006 }; /* interface ISessionStateChangedEvent */
22007 
22015 interface IGuestPropertyChangedEvent : IMachineEvent
22016 {
22022     readonly attribute wstring name;
22023 
22029     readonly attribute wstring value;
22030 
22036     readonly attribute wstring flags;
22037 
22038 }; /* interface IGuestPropertyChangedEvent */
22039 
22045 interface ISnapshotEvent : IMachineEvent
22046 {
22050     readonly attribute wstringUUID snapshotId;
22051 
22052 }; /* interface ISnapshotEvent */
22053 
22063 interface ISnapshotTakenEvent : ISnapshotEvent
22064 {
22065 }; /* interface ISnapshotTakenEvent */
22066 
22083 interface ISnapshotDeletedEvent : ISnapshotEvent
22084 {
22085 }; /* interface ISnapshotDeletedEvent */
22086 
22096 interface ISnapshotChangedEvent : ISnapshotEvent
22097 {
22098 }; /* interface ISnapshotChangedEvent */
22099 
22108 interface IMousePointerShapeChangedEvent : IEvent
22109 {
22115     readonly attribute boolean visible;
22116 
22122     readonly attribute boolean alpha;
22123 
22129     readonly attribute unsigned long xhot;
22130 
22136     readonly attribute unsigned long yhot;
22137 
22143     readonly attribute unsigned long width;
22144 
22150     readonly attribute unsigned long height;
22151 
22184     readonly attribute octet[] shape;
22185 
22186 }; /* interface IMousePointerShapeChangedEvent */
22187 
22196 interface IMouseCapabilityChangedEvent : IEvent
22197 {
22203     readonly attribute boolean supportsAbsolute;
22204 
22210     readonly attribute boolean supportsRelative;
22211 
22217     readonly attribute boolean needsHostCursor;
22218 
22219 }; /* interface IMouseCapabilityChangedEvent */
22220 
22229 interface IKeyboardLedsChangedEvent : IEvent
22230 {
22236     readonly attribute boolean numLock;
22237 
22243     readonly attribute boolean capsLock;
22244 
22250     readonly attribute boolean scrollLock;
22251 
22252 }; /* interface IKeyboardLedsChangedEvent */
22253 
22262 interface IStateChangedEvent : IEvent
22263 {
22269     readonly attribute MachineState state;
22270 
22271 }; /* interface IStateChangedEvent */
22272 
22282 interface IAdditionsStateChangedEvent : IEvent
22283 {
22284 }; /* interface IAdditionsStateChangedEvent */
22285 
22296 interface INetworkAdapterChangedEvent : IEvent
22297 {
22303     readonly attribute INetworkAdapter networkAdapter;
22304 
22305 }; /* interface INetworkAdapterChangedEvent */
22306 
22317 interface ISerialPortChangedEvent : IEvent
22318 {
22324     readonly attribute ISerialPort serialPort;
22325 
22326 }; /* interface ISerialPortChangedEvent */
22327 
22338 interface IParallelPortChangedEvent : IEvent
22339 {
22345     readonly attribute IParallelPort parallelPort;
22346 
22347 }; /* interface IParallelPortChangedEvent */
22348 
22358 interface IStorageControllerChangedEvent : IEvent
22359 {
22360 }; /* interface IStorageControllerChangedEvent */
22361 
22371 interface IMediumChangedEvent : IEvent
22372 {
22378     readonly attribute IMediumAttachment mediumAttachment;
22379 
22380 }; /* interface IMediumChangedEvent */
22381 
22389 interface IClipboardModeChangedEvent : IEvent
22390 {
22396     readonly attribute ClipboardMode clipboardMode;
22397 
22398 }; /* interface IClipboardModeChangedEvent */
22399 
22407 interface IDragAndDropModeChangedEvent : IEvent
22408 {
22414     readonly attribute DragAndDropMode dragAndDropMode;
22415 
22416 }; /* interface IDragAndDropModeChangedEvent */
22417 
22425 interface ICPUChangedEvent : IEvent
22426 {
22432     readonly attribute unsigned long CPU;
22433 
22439     readonly attribute boolean add;
22440 
22441 }; /* interface ICPUChangedEvent */
22442 
22450 interface ICPUExecutionCapChangedEvent : IEvent
22451 {
22457     readonly attribute unsigned long executionCap;
22458 
22459 }; /* interface ICPUExecutionCapChangedEvent */
22460 
22468 interface IGuestKeyboardEvent : IEvent
22469 {
22475     readonly attribute long[] scancodes;
22476 
22477 }; /* interface IGuestKeyboardEvent */
22478 
22486 interface IGuestMouseEvent : IReusableEvent
22487 {
22493     readonly attribute boolean absolute;
22494 
22500     readonly attribute long x;
22501 
22507     readonly attribute long y;
22508 
22514     readonly attribute long z;
22515 
22521     readonly attribute long w;
22522 
22528     readonly attribute long buttons;
22529 
22530 }; /* interface IGuestMouseEvent */
22531 
22542 interface IVRDEServerChangedEvent : IEvent
22543 {
22544 }; /* interface IVRDEServerChangedEvent */
22545 
22555 interface IVRDEServerInfoChangedEvent : IEvent
22556 {
22557 }; /* interface IVRDEServerInfoChangedEvent */
22558 
22569 interface IUSBControllerChangedEvent : IEvent
22570 {
22571 }; /* interface IUSBControllerChangedEvent */
22572 
22596 interface IUSBDeviceStateChangedEvent : IEvent
22597 {
22603     readonly attribute IUSBDevice device;
22604 
22610     readonly attribute boolean attached;
22611 
22617     readonly attribute IVirtualBoxErrorInfo error;
22618 
22619 }; /* interface IUSBDeviceStateChangedEvent */
22620 
22636 interface ISharedFolderChangedEvent : IEvent
22637 {
22643     readonly attribute Scope scope;
22644 
22645 }; /* interface ISharedFolderChangedEvent */
22646 
22698 interface IRuntimeErrorEvent : IEvent
22699 {
22705     readonly attribute boolean fatal;
22706 
22712     readonly attribute wstring id;
22713 
22719     readonly attribute wstring message;
22720 
22721 }; /* interface IRuntimeErrorEvent */
22722 
22730 interface IEventSourceChangedEvent : IEvent
22731 {
22737     readonly attribute IEventListener listener;
22738 
22744     readonly attribute boolean add;
22745 
22746 }; /* interface IEventSourceChangedEvent */
22747 
22756 interface IExtraDataChangedEvent : IEvent
22757 {
22764     readonly attribute wstringUUID machineId;
22765 
22771     readonly attribute wstring key;
22772 
22778     readonly attribute wstring value;
22779 
22780 }; /* interface IExtraDataChangedEvent */
22781 
22787 interface IVetoEvent : IEvent
22788 {
22798     void addVeto (
22799         in wstring reason
22800     );
22801 
22811     void isVetoed (
22812         [retval] out boolean result
22813     );
22814 
22824     void getVetos (
22825         [retval] out wstring[] result
22826     );
22827 
22828 }; /* interface IVetoEvent */
22829 
22839 interface IExtraDataCanChangeEvent : IVetoEvent
22840 {
22847     readonly attribute wstringUUID machineId;
22848 
22854     readonly attribute wstring key;
22855 
22861     readonly attribute wstring value;
22862 
22863 }; /* interface IExtraDataCanChangeEvent */
22864 
22880 interface ICanShowWindowEvent : IVetoEvent
22881 {
22882 }; /* interface ICanShowWindowEvent */
22883 
22915 interface IShowWindowEvent : IEvent
22916 {
22925     attribute long long winId;
22926 
22927 }; /* interface IShowWindowEvent */
22928 
22936 interface INATRedirectEvent : IMachineEvent
22937 {
22943     readonly attribute unsigned long slot;
22944 
22950     readonly attribute boolean remove;
22951 
22957     readonly attribute wstring name;
22958 
22964     readonly attribute NATProtocol proto;
22965 
22971     readonly attribute wstring hostIP;
22972 
22978     readonly attribute long hostPort;
22979 
22985     readonly attribute wstring guestIP;
22986 
22992     readonly attribute long guestPort;
22993 
22994 }; /* interface INATRedirectEvent */
22995 
23008 interface IHostPCIDevicePlugEvent : IMachineEvent
23009 {
23015     readonly attribute boolean plugged;
23016 
23023     readonly attribute boolean success;
23024 
23030     readonly attribute IPCIDeviceAttachment attachment;
23031 
23037     readonly attribute wstring message;
23038 
23039 }; /* interface IHostPCIDevicePlugEvent */
23040 
23049 interface IVBoxSVCAvailabilityChangedEvent : IEvent
23050 {
23056     readonly attribute boolean available;
23057 
23058 }; /* interface IVBoxSVCAvailabilityChangedEvent */
23059 
23067 interface IBandwidthGroupChangedEvent : IEvent
23068 {
23074     readonly attribute IBandwidthGroup bandwidthGroup;
23075 
23076 }; /* interface IBandwidthGroupChangedEvent */
23077 
23085 interface IGuestMonitorChangedEvent : IEvent
23086 {
23092     readonly attribute GuestMonitorChangedEventType changeType;
23093 
23099     readonly attribute unsigned long screenId;
23100 
23107     readonly attribute unsigned long originX;
23108 
23115     readonly attribute unsigned long originY;
23116 
23123     readonly attribute unsigned long width;
23124 
23131     readonly attribute unsigned long height;
23132 
23133 }; /* interface IGuestMonitorChangedEvent */
23134 
23144 interface IStorageDeviceChangedEvent : IEvent
23145 {
23151     readonly attribute IMediumAttachment storageDevice;
23152 
23158     readonly attribute boolean removed;
23159 
23160 }; /* interface IStorageDeviceChangedEvent */
23161 
23162 

Generated on Wed Aug 22 2012 12:59:20 for VirtualBox Main API by  doxygen 1.7.1