00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
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_v1_14 = 16,
00326 SettingsVersion_Future = 99999,
00327 };
00328
00336 enum AccessMode
00337 {
00338 AccessMode_ReadOnly = 1,
00339 AccessMode_ReadWrite = 2,
00340 };
00341
00459 enum MachineState
00460 {
00465 MachineState_Null = 0,
00473 MachineState_PoweredOff = 1,
00482 MachineState_Saved = 2,
00491 MachineState_Teleported = 3,
00500 MachineState_Aborted = 4,
00507 MachineState_Running = 5,
00514 MachineState_Paused = 6,
00522 MachineState_Stuck = 7,
00532 MachineState_Teleporting = 8,
00543 MachineState_LiveSnapshotting = 9,
00551 MachineState_Starting = 10,
00559 MachineState_Stopping = 11,
00567 MachineState_Saving = 12,
00575 MachineState_Restoring = 13,
00584 MachineState_TeleportingPausedVM = 14,
00591 MachineState_TeleportingIn = 15,
00598 MachineState_FaultTolerantSyncing = 16,
00606 MachineState_DeletingSnapshotOnline = 17,
00614 MachineState_DeletingSnapshotPaused = 18,
00621 MachineState_RestoringSnapshot = 19,
00630 MachineState_DeletingSnapshot = 20,
00637 MachineState_SettingUp = 21,
00644 MachineState_FirstOnline = 5,
00651 MachineState_LastOnline = 18,
00658 MachineState_FirstTransient = 8,
00665 MachineState_LastTransient = 21,
00666 };
00667
00677 enum SessionState
00678 {
00683 SessionState_Null = 0,
00694 SessionState_Unlocked = 1,
00708 SessionState_Locked = 2,
00718 SessionState_Spawning = 3,
00725 SessionState_Unlocking = 4,
00726 };
00727
00736 enum CPUPropertyType
00737 {
00742 CPUPropertyType_Null = 0,
00751 CPUPropertyType_PAE = 1,
00759 CPUPropertyType_Synthetic = 2,
00767 CPUPropertyType_LongMode = 3,
00768 };
00769
00779 enum HWVirtExPropertyType
00780 {
00785 HWVirtExPropertyType_Null = 0,
00793 HWVirtExPropertyType_Enabled = 1,
00800 HWVirtExPropertyType_VPID = 2,
00807 HWVirtExPropertyType_NestedPaging = 3,
00814 HWVirtExPropertyType_UnrestrictedExecution = 4,
00821 HWVirtExPropertyType_LargePages = 5,
00829 HWVirtExPropertyType_Force = 6,
00830 };
00831
00839 enum FaultToleranceState
00840 {
00845 FaultToleranceState_Inactive = 1,
00850 FaultToleranceState_Master = 2,
00855 FaultToleranceState_Standby = 3,
00856 };
00857
00865 enum LockType
00866 {
00875 LockType_Write = 2,
00882 LockType_Shared = 1,
00888 LockType_VM = 3,
00889 };
00890
00899 enum SessionType
00900 {
00905 SessionType_Null = 0,
00913 SessionType_WriteLock = 1,
00920 SessionType_Remote = 2,
00927 SessionType_Shared = 3,
00928 };
00929
00937 enum DeviceType
00938 {
00946 DeviceType_Null = 0,
00951 DeviceType_Floppy = 1,
00956 DeviceType_DVD = 2,
00961 DeviceType_HardDisk = 3,
00966 DeviceType_Network = 4,
00971 DeviceType_USB = 5,
00976 DeviceType_SharedFolder = 6,
00977 };
00978
00986 enum DeviceActivity
00987 {
00988 DeviceActivity_Null = 0,
00989 DeviceActivity_Idle = 1,
00990 DeviceActivity_Reading = 2,
00991 DeviceActivity_Writing = 3,
00992 };
00993
01001 enum ClipboardMode
01002 {
01003 ClipboardMode_Disabled = 0,
01004 ClipboardMode_HostToGuest = 1,
01005 ClipboardMode_GuestToHost = 2,
01006 ClipboardMode_Bidirectional = 3,
01007 };
01008
01016 enum DragAndDropMode
01017 {
01018 DragAndDropMode_Disabled = 0,
01019 DragAndDropMode_HostToGuest = 1,
01020 DragAndDropMode_GuestToHost = 2,
01021 DragAndDropMode_Bidirectional = 3,
01022 };
01023
01034 enum Scope
01035 {
01036 Scope_Global = 0,
01037 Scope_Machine = 1,
01038 Scope_Session = 2,
01039 };
01040
01048 enum BIOSBootMenuMode
01049 {
01050 BIOSBootMenuMode_Disabled = 0,
01051 BIOSBootMenuMode_MenuOnly = 1,
01052 BIOSBootMenuMode_MessageAndMenu = 2,
01053 };
01054
01062 enum ProcessorFeature
01063 {
01064 ProcessorFeature_HWVirtEx = 0,
01065 ProcessorFeature_PAE = 1,
01066 ProcessorFeature_LongMode = 2,
01067 ProcessorFeature_NestedPaging = 3,
01068 };
01069
01077 enum FirmwareType
01078 {
01083 FirmwareType_BIOS = 1,
01088 FirmwareType_EFI = 2,
01093 FirmwareType_EFI32 = 3,
01098 FirmwareType_EFI64 = 4,
01103 FirmwareType_EFIDUAL = 5,
01104 };
01105
01113 enum PointingHIDType
01114 {
01119 PointingHIDType_None = 1,
01124 PointingHIDType_PS2Mouse = 2,
01129 PointingHIDType_USBMouse = 3,
01137 PointingHIDType_USBTablet = 4,
01145 PointingHIDType_ComboMouse = 5,
01152 PointingHIDType_USBMultiTouch = 6,
01153 };
01154
01162 enum KeyboardHIDType
01163 {
01168 KeyboardHIDType_None = 1,
01173 KeyboardHIDType_PS2Keyboard = 2,
01178 KeyboardHIDType_USBKeyboard = 3,
01184 KeyboardHIDType_ComboKeyboard = 4,
01185 };
01186
01187 enum DhcpOpt
01188 {
01189 DhcpOpt_SubnetMask = 1,
01190 DhcpOpt_TimeOffset = 2,
01191 DhcpOpt_Router = 3,
01192 DhcpOpt_TimeServer = 4,
01193 DhcpOpt_NameServer = 5,
01194 DhcpOpt_DomainNameServer = 6,
01195 DhcpOpt_LogServer = 7,
01196 DhcpOpt_Cookie = 8,
01197 DhcpOpt_LPRServer = 9,
01198 DhcpOpt_ImpressServer = 10,
01199 DhcpOpt_ResourseLocationServer = 11,
01200 DhcpOpt_HostName = 12,
01201 DhcpOpt_BootFileSize = 13,
01202 DhcpOpt_MeritDumpFile = 14,
01203 DhcpOpt_DomainName = 15,
01204 DhcpOpt_SwapServer = 16,
01205 DhcpOpt_RootPath = 17,
01206 DhcpOpt_ExtensionPath = 18,
01207 DhcpOpt_IPForwardingEnableDisable = 19,
01208 DhcpOpt_NonLocalSourceRoutingEnableDisable = 20,
01209 DhcpOpt_PolicyFilter = 21,
01210 DhcpOpt_MaximumDatagramReassemblySize = 22,
01211 DhcpOpt_DefaultIPTime2Live = 23,
01212 DhcpOpt_PathMTUAgingTimeout = 24,
01213 DhcpOpt_IPLayerParametersPerInterface = 25,
01214 DhcpOpt_InterfaceMTU = 26,
01215 DhcpOpt_AllSubnetsAreLocal = 27,
01216 DhcpOpt_BroadcastAddress = 28,
01217 DhcpOpt_PerformMaskDiscovery = 29,
01218 DhcpOpt_MaskSupplier = 30,
01219 DhcpOpt_PerformRouteDiscovery = 31,
01220 DhcpOpt_RouterSolicitationAddress = 32,
01221 DhcpOpt_StaticRoute = 33,
01222 DhcpOpt_TrailerEncapsulation = 34,
01223 DhcpOpt_ARPCacheTimeout = 35,
01224 DhcpOpt_EthernetEncapsulation = 36,
01225 DhcpOpt_TCPDefaultTTL = 37,
01226 DhcpOpt_TCPKeepAliveInterval = 38,
01227 DhcpOpt_TCPKeepAliveGarbage = 39,
01228 DhcpOpt_NetworkInformationServiceDomain = 40,
01229 DhcpOpt_NetworkInformationServiceServers = 41,
01230 DhcpOpt_NetworkTimeProtocolServers = 42,
01231 DhcpOpt_VendorSpecificInformation = 43,
01232 DhcpOpt_Option_44 = 44,
01233 DhcpOpt_Option_45 = 45,
01234 DhcpOpt_Option_46 = 46,
01235 DhcpOpt_Option_47 = 47,
01236 DhcpOpt_Option_48 = 48,
01237 DhcpOpt_Option_49 = 49,
01238 DhcpOpt_IPAddressLeaseTime = 51,
01239 DhcpOpt_Option_64 = 64,
01240 DhcpOpt_Option_65 = 65,
01241 DhcpOpt_TFTPServerName = 66,
01242 DhcpOpt_BootfileName = 67,
01243 DhcpOpt_Option_68 = 68,
01244 DhcpOpt_Option_69 = 69,
01245 DhcpOpt_Option_70 = 70,
01246 DhcpOpt_Option_71 = 71,
01247 DhcpOpt_Option_72 = 72,
01248 DhcpOpt_Option_73 = 73,
01249 DhcpOpt_Option_74 = 74,
01250 DhcpOpt_Option_75 = 75,
01251 DhcpOpt_Option_119 = 119,
01252 };
01253
01261 enum VFSType
01262 {
01263 VFSType_File = 1,
01264 VFSType_Cloud = 2,
01265 VFSType_S3 = 3,
01266 VFSType_WebDav = 4,
01267 };
01268
01276 enum VFSFileType
01277 {
01278 VFSFileType_Unknown = 1,
01279 VFSFileType_Fifo = 2,
01280 VFSFileType_DevChar = 3,
01281 VFSFileType_Directory = 4,
01282 VFSFileType_DevBlock = 5,
01283 VFSFileType_File = 6,
01284 VFSFileType_SymLink = 7,
01285 VFSFileType_Socket = 8,
01286 VFSFileType_WhiteOut = 9,
01287 };
01288
01296 enum ImportOptions
01297 {
01302 ImportOptions_KeepAllMACs = 1,
01307 ImportOptions_KeepNATMACs = 2,
01308 };
01309
01316 enum VirtualSystemDescriptionType
01317 {
01318 VirtualSystemDescriptionType_Ignore = 1,
01319 VirtualSystemDescriptionType_OS = 2,
01320 VirtualSystemDescriptionType_Name = 3,
01321 VirtualSystemDescriptionType_Product = 4,
01322 VirtualSystemDescriptionType_Vendor = 5,
01323 VirtualSystemDescriptionType_Version = 6,
01324 VirtualSystemDescriptionType_ProductUrl = 7,
01325 VirtualSystemDescriptionType_VendorUrl = 8,
01326 VirtualSystemDescriptionType_Description = 9,
01327 VirtualSystemDescriptionType_License = 10,
01328 VirtualSystemDescriptionType_Miscellaneous = 11,
01329 VirtualSystemDescriptionType_CPU = 12,
01330 VirtualSystemDescriptionType_Memory = 13,
01331 VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
01332 VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
01333 VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
01334 VirtualSystemDescriptionType_HardDiskControllerSAS = 17,
01335 VirtualSystemDescriptionType_HardDiskImage = 18,
01336 VirtualSystemDescriptionType_Floppy = 19,
01337 VirtualSystemDescriptionType_CDROM = 20,
01338 VirtualSystemDescriptionType_NetworkAdapter = 21,
01339 VirtualSystemDescriptionType_USBController = 22,
01340 VirtualSystemDescriptionType_SoundCard = 23,
01345 VirtualSystemDescriptionType_SettingsFile = 24,
01346 };
01347
01354 enum VirtualSystemDescriptionValueType
01355 {
01356 VirtualSystemDescriptionValueType_Reference = 1,
01357 VirtualSystemDescriptionValueType_Original = 2,
01358 VirtualSystemDescriptionValueType_Auto = 3,
01359 VirtualSystemDescriptionValueType_ExtraConfig = 4,
01360 };
01361
01368 enum GraphicsControllerType
01369 {
01374 GraphicsControllerType_Null = 0,
01379 GraphicsControllerType_VBoxVGA = 1,
01380 };
01381
01388 enum CleanupMode
01389 {
01394 CleanupMode_UnregisterOnly = 1,
01399 CleanupMode_DetachAllReturnNone = 2,
01404 CleanupMode_DetachAllReturnHardDisksOnly = 3,
01409 CleanupMode_Full = 4,
01410 };
01411
01419 enum CloneMode
01420 {
01425 CloneMode_MachineState = 1,
01430 CloneMode_MachineAndChildStates = 2,
01435 CloneMode_AllStates = 3,
01436 };
01437
01445 enum CloneOptions
01446 {
01451 CloneOptions_Link = 1,
01456 CloneOptions_KeepAllMACs = 2,
01461 CloneOptions_KeepNATMACs = 3,
01466 CloneOptions_KeepDiskNames = 4,
01467 };
01468
01476 enum AutostopType
01477 {
01482 AutostopType_Disabled = 1,
01487 AutostopType_SaveState = 2,
01492 AutostopType_PowerOff = 3,
01497 AutostopType_AcpiShutdown = 4,
01498 };
01499
01510 enum HostNetworkInterfaceMediumType
01511 {
01518 HostNetworkInterfaceMediumType_Unknown = 0,
01525 HostNetworkInterfaceMediumType_Ethernet = 1,
01532 HostNetworkInterfaceMediumType_PPP = 2,
01539 HostNetworkInterfaceMediumType_SLIP = 3,
01540 };
01541
01551 enum HostNetworkInterfaceStatus
01552 {
01559 HostNetworkInterfaceStatus_Unknown = 0,
01566 HostNetworkInterfaceStatus_Up = 1,
01573 HostNetworkInterfaceStatus_Down = 2,
01574 };
01575
01583 enum HostNetworkInterfaceType
01584 {
01585 HostNetworkInterfaceType_Bridged = 1,
01586 HostNetworkInterfaceType_HostOnly = 2,
01587 };
01588
01596 enum AdditionsFacilityType
01597 {
01602 AdditionsFacilityType_None = 0,
01607 AdditionsFacilityType_VBoxGuestDriver = 20,
01612 AdditionsFacilityType_AutoLogon = 90,
01617 AdditionsFacilityType_VBoxService = 100,
01622 AdditionsFacilityType_VBoxTrayClient = 101,
01627 AdditionsFacilityType_Seamless = 1000,
01635 AdditionsFacilityType_Graphics = 1100,
01640 AdditionsFacilityType_All = 2147483646,
01641 };
01642
01650 enum AdditionsFacilityClass
01651 {
01656 AdditionsFacilityClass_None = 0,
01661 AdditionsFacilityClass_Driver = 10,
01666 AdditionsFacilityClass_Service = 30,
01671 AdditionsFacilityClass_Program = 50,
01676 AdditionsFacilityClass_Feature = 100,
01681 AdditionsFacilityClass_ThirdParty = 999,
01686 AdditionsFacilityClass_All = 2147483646,
01687 };
01688
01696 enum AdditionsFacilityStatus
01697 {
01702 AdditionsFacilityStatus_Inactive = 0,
01707 AdditionsFacilityStatus_Paused = 1,
01712 AdditionsFacilityStatus_PreInit = 20,
01717 AdditionsFacilityStatus_Init = 30,
01722 AdditionsFacilityStatus_Active = 50,
01727 AdditionsFacilityStatus_Terminating = 100,
01732 AdditionsFacilityStatus_Terminated = 101,
01737 AdditionsFacilityStatus_Failed = 800,
01742 AdditionsFacilityStatus_Unknown = 999,
01743 };
01744
01752 enum AdditionsRunLevelType
01753 {
01758 AdditionsRunLevelType_None = 0,
01763 AdditionsRunLevelType_System = 1,
01768 AdditionsRunLevelType_Userland = 2,
01773 AdditionsRunLevelType_Desktop = 3,
01774 };
01775
01783 enum AdditionsUpdateFlag
01784 {
01789 AdditionsUpdateFlag_None = 0,
01797 AdditionsUpdateFlag_WaitForUpdateStartOnly = 1,
01798 };
01799
01808 enum GuestSessionStatus
01809 {
01814 GuestSessionStatus_Undefined = 0,
01819 GuestSessionStatus_Starting = 10,
01824 GuestSessionStatus_Started = 100,
01829 GuestSessionStatus_Terminating = 480,
01834 GuestSessionStatus_Terminated = 500,
01839 GuestSessionStatus_TimedOutKilled = 512,
01844 GuestSessionStatus_TimedOutAbnormally = 513,
01849 GuestSessionStatus_Down = 600,
01854 GuestSessionStatus_Error = 800,
01855 };
01856
01864 enum GuestSessionWaitForFlag
01865 {
01870 GuestSessionWaitForFlag_None = 0,
01875 GuestSessionWaitForFlag_Start = 1,
01880 GuestSessionWaitForFlag_Terminate = 2,
01885 GuestSessionWaitForFlag_Status = 4,
01886 };
01887
01901 enum GuestSessionWaitResult
01902 {
01907 GuestSessionWaitResult_None = 0,
01912 GuestSessionWaitResult_Start = 1,
01917 GuestSessionWaitResult_Terminate = 2,
01925 GuestSessionWaitResult_Status = 3,
01930 GuestSessionWaitResult_Error = 4,
01939 GuestSessionWaitResult_Timeout = 5,
01947 GuestSessionWaitResult_WaitFlagNotSupported = 6,
01948 };
01949
01957 enum GuestUserState
01958 {
01963 GuestUserState_Unknown = 0,
01972 GuestUserState_LoggedIn = 1,
01981 GuestUserState_LoggedOut = 2,
01991 GuestUserState_Locked = 3,
01999 GuestUserState_Unlocked = 4,
02007 GuestUserState_Disabled = 5,
02029 GuestUserState_Idle = 6,
02035 GuestUserState_InUse = 7,
02043 GuestUserState_Created = 8,
02051 GuestUserState_Deleted = 9,
02059 GuestUserState_SessionChanged = 10,
02069 GuestUserState_CredentialsChanged = 11,
02078 GuestUserState_RoleChanged = 12,
02087 GuestUserState_GroupAdded = 13,
02096 GuestUserState_GroupRemoved = 14,
02105 GuestUserState_Elevated = 15,
02106 };
02107
02115 enum FileSeekType
02116 {
02121 FileSeekType_Set = 0,
02126 FileSeekType_Current = 1,
02127 };
02128
02136 enum ProcessInputFlag
02137 {
02142 ProcessInputFlag_None = 0,
02147 ProcessInputFlag_EndOfFile = 1,
02148 };
02149
02158 enum ProcessOutputFlag
02159 {
02164 ProcessOutputFlag_None = 0,
02169 ProcessOutputFlag_StdErr = 1,
02170 };
02171
02179 enum ProcessWaitForFlag
02180 {
02185 ProcessWaitForFlag_None = 0,
02190 ProcessWaitForFlag_Start = 1,
02195 ProcessWaitForFlag_Terminate = 2,
02200 ProcessWaitForFlag_StdIn = 4,
02205 ProcessWaitForFlag_StdOut = 8,
02210 ProcessWaitForFlag_StdErr = 16,
02211 };
02212
02231 enum ProcessWaitResult
02232 {
02237 ProcessWaitResult_None = 0,
02242 ProcessWaitResult_Start = 1,
02247 ProcessWaitResult_Terminate = 2,
02255 ProcessWaitResult_Status = 3,
02260 ProcessWaitResult_Error = 4,
02269 ProcessWaitResult_Timeout = 5,
02276 ProcessWaitResult_StdIn = 6,
02281 ProcessWaitResult_StdOut = 7,
02286 ProcessWaitResult_StdErr = 8,
02294 ProcessWaitResult_WaitFlagNotSupported = 9,
02295 };
02296
02304 enum CopyFileFlag
02305 {
02310 CopyFileFlag_None = 0,
02315 CopyFileFlag_Recursive = 1,
02320 CopyFileFlag_Update = 2,
02325 CopyFileFlag_FollowLinks = 4,
02326 };
02327
02335 enum DirectoryCreateFlag
02336 {
02341 DirectoryCreateFlag_None = 0,
02346 DirectoryCreateFlag_Parents = 1,
02347 };
02348
02356 enum DirectoryRemoveRecFlag
02357 {
02362 DirectoryRemoveRecFlag_None = 0,
02367 DirectoryRemoveRecFlag_ContentAndDir = 1,
02372 DirectoryRemoveRecFlag_ContentOnly = 2,
02373 };
02374
02382 enum PathRenameFlag
02383 {
02388 PathRenameFlag_None = 0,
02393 PathRenameFlag_NoReplace = 1,
02398 PathRenameFlag_Replace = 2,
02403 PathRenameFlag_NoSymlinks = 4,
02404 };
02405
02413 enum ProcessCreateFlag
02414 {
02419 ProcessCreateFlag_None = 0,
02425 ProcessCreateFlag_WaitForProcessStartOnly = 1,
02430 ProcessCreateFlag_IgnoreOrphanedProcesses = 2,
02435 ProcessCreateFlag_Hidden = 4,
02440 ProcessCreateFlag_NoProfile = 8,
02445 ProcessCreateFlag_WaitForStdOut = 16,
02450 ProcessCreateFlag_WaitForStdErr = 32,
02455 ProcessCreateFlag_ExpandArguments = 64,
02456 };
02457
02465 enum ProcessPriority
02466 {
02471 ProcessPriority_Invalid = 0,
02476 ProcessPriority_Default = 1,
02477 };
02478
02486 enum SymlinkType
02487 {
02492 SymlinkType_Unknown = 0,
02497 SymlinkType_Directory = 1,
02502 SymlinkType_File = 2,
02503 };
02504
02512 enum SymlinkReadFlag
02513 {
02518 SymlinkReadFlag_None = 0,
02523 SymlinkReadFlag_NoSymlinks = 1,
02524 };
02525
02533 enum ProcessStatus
02534 {
02539 ProcessStatus_Undefined = 0,
02544 ProcessStatus_Starting = 10,
02549 ProcessStatus_Started = 100,
02554 ProcessStatus_Paused = 110,
02559 ProcessStatus_Terminating = 480,
02564 ProcessStatus_TerminatedNormally = 500,
02569 ProcessStatus_TerminatedSignal = 510,
02574 ProcessStatus_TerminatedAbnormally = 511,
02579 ProcessStatus_TimedOutKilled = 512,
02584 ProcessStatus_TimedOutAbnormally = 513,
02589 ProcessStatus_Down = 600,
02594 ProcessStatus_Error = 800,
02595 };
02596
02604 enum ProcessInputStatus
02605 {
02610 ProcessInputStatus_Undefined = 0,
02615 ProcessInputStatus_Broken = 1,
02620 ProcessInputStatus_Available = 10,
02625 ProcessInputStatus_Written = 50,
02630 ProcessInputStatus_Overflow = 100,
02631 };
02632
02640 enum FileStatus
02641 {
02646 FileStatus_Undefined = 0,
02651 FileStatus_Opening = 10,
02656 FileStatus_Open = 100,
02661 FileStatus_Closing = 150,
02666 FileStatus_Closed = 200,
02671 FileStatus_Down = 600,
02676 FileStatus_Error = 800,
02677 };
02678
02686 enum FsObjType
02687 {
02692 FsObjType_Undefined = 0,
02697 FsObjType_FIFO = 1,
02702 FsObjType_DevChar = 10,
02707 FsObjType_DevBlock = 11,
02712 FsObjType_Directory = 50,
02717 FsObjType_File = 80,
02722 FsObjType_Symlink = 100,
02727 FsObjType_Socket = 200,
02732 FsObjType_Whiteout = 400,
02733 };
02734
02742 enum DragAndDropAction
02743 {
02748 DragAndDropAction_Ignore = 0,
02753 DragAndDropAction_Copy = 1,
02758 DragAndDropAction_Move = 2,
02763 DragAndDropAction_Link = 3,
02764 };
02765
02773 enum DirectoryOpenFlag
02774 {
02779 DirectoryOpenFlag_None = 0,
02784 DirectoryOpenFlag_NoSymlinks = 1,
02785 };
02786
02796 enum MediumState
02797 {
02805 MediumState_NotCreated = 0,
02814 MediumState_Created = 1,
02822 MediumState_LockedRead = 2,
02830 MediumState_LockedWrite = 3,
02840 MediumState_Inaccessible = 4,
02847 MediumState_Creating = 5,
02854 MediumState_Deleting = 6,
02855 };
02856
02867 enum MediumType
02868 {
02876 MediumType_Normal = 0,
02884 MediumType_Immutable = 1,
02892 MediumType_Writethrough = 2,
02901 MediumType_Shareable = 3,
02910 MediumType_Readonly = 4,
02922 MediumType_MultiAttach = 5,
02923 };
02924
02934 enum MediumVariant
02935 {
02942 MediumVariant_Standard = 0,
02949 MediumVariant_VmdkSplit2G = 0x01,
02956 MediumVariant_VmdkRawDisk = 0x02,
02964 MediumVariant_VmdkStreamOptimized = 0x04,
02971 MediumVariant_VmdkESX = 0x08,
02978 MediumVariant_Fixed = 0x10000,
02985 MediumVariant_Diff = 0x20000,
02993 MediumVariant_NoCreateDir = 0x40000000,
02994 };
02995
02996 enum DataType
02997 {
02998 DataType_Int32 = 0,
02999 DataType_Int8 = 1,
03000 DataType_String = 2,
03001 };
03002
03003 enum DataFlags
03004 {
03005 DataFlags_None = 0x00,
03006 DataFlags_Mandatory = 0x01,
03007 DataFlags_Expert = 0x02,
03008 DataFlags_Array = 0x04,
03009 DataFlags_FlagMask = 0x07,
03010 };
03011
03019 enum MediumFormatCapabilities
03020 {
03027 MediumFormatCapabilities_Uuid = 0x01,
03034 MediumFormatCapabilities_CreateFixed = 0x02,
03042 MediumFormatCapabilities_CreateDynamic = 0x04,
03049 MediumFormatCapabilities_CreateSplit2G = 0x08,
03056 MediumFormatCapabilities_Differencing = 0x10,
03063 MediumFormatCapabilities_Asynchronous = 0x20,
03073 MediumFormatCapabilities_File = 0x40,
03082 MediumFormatCapabilities_Properties = 0x80,
03089 MediumFormatCapabilities_TcpNetworking = 0x100,
03096 MediumFormatCapabilities_VFS = 0x200,
03097 MediumFormatCapabilities_CapabilityMask = 0x3FF,
03098 };
03099
03107 enum MouseButtonState
03108 {
03109 MouseButtonState_LeftButton = 0x01,
03110 MouseButtonState_RightButton = 0x02,
03111 MouseButtonState_MiddleButton = 0x04,
03112 MouseButtonState_WheelUp = 0x08,
03113 MouseButtonState_WheelDown = 0x10,
03114 MouseButtonState_XButton1 = 0x20,
03115 MouseButtonState_XButton2 = 0x40,
03116 MouseButtonState_MouseStateMask = 0x7F,
03117 };
03118
03126 enum TouchContactState
03127 {
03132 TouchContactState_None = 0x00,
03137 TouchContactState_InContact = 0x01,
03144 TouchContactState_InRange = 0x02,
03145 TouchContactState_ContactStateMask = 0x03,
03146 };
03147
03158 enum FramebufferPixelFormat
03159 {
03167 FramebufferPixelFormat_Opaque = 0,
03175 FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
03176 };
03177
03185 enum NetworkAttachmentType
03186 {
03191 NetworkAttachmentType_Null = 0,
03192 NetworkAttachmentType_NAT = 1,
03193 NetworkAttachmentType_Bridged = 2,
03194 NetworkAttachmentType_Internal = 3,
03195 NetworkAttachmentType_HostOnly = 4,
03196 NetworkAttachmentType_Generic = 5,
03197 NetworkAttachmentType_NATNetwork = 6,
03198 };
03199
03207 enum NetworkAdapterType
03208 {
03213 NetworkAdapterType_Null = 0,
03218 NetworkAdapterType_Am79C970A = 1,
03223 NetworkAdapterType_Am79C973 = 2,
03228 NetworkAdapterType_I82540EM = 3,
03233 NetworkAdapterType_I82543GC = 4,
03238 NetworkAdapterType_I82545EM = 5,
03243 NetworkAdapterType_Virtio = 6,
03244 };
03245
03253 enum NetworkAdapterPromiscModePolicy
03254 {
03259 NetworkAdapterPromiscModePolicy_Deny = 1,
03267 NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
03275 NetworkAdapterPromiscModePolicy_AllowAll = 3,
03276 };
03277
03286 enum PortMode
03287 {
03292 PortMode_Disconnected = 0,
03297 PortMode_HostPipe = 1,
03302 PortMode_HostDevice = 2,
03307 PortMode_RawFile = 3,
03308 };
03309
03317 enum USBControllerType
03318 {
03323 USBControllerType_Null = 0,
03324 USBControllerType_OHCI = 1,
03325 USBControllerType_EHCI = 2,
03330 USBControllerType_Last = 3,
03331 };
03332
03371 enum USBDeviceState
03372 {
03379 USBDeviceState_NotSupported = 0,
03387 USBDeviceState_Unavailable = 1,
03394 USBDeviceState_Busy = 2,
03402 USBDeviceState_Available = 3,
03410 USBDeviceState_Held = 4,
03418 USBDeviceState_Captured = 5,
03419 };
03420
03430 enum USBDeviceFilterAction
03431 {
03436 USBDeviceFilterAction_Null = 0,
03441 USBDeviceFilterAction_Ignore = 1,
03446 USBDeviceFilterAction_Hold = 2,
03447 };
03448
03456 enum AudioDriverType
03457 {
03462 AudioDriverType_Null = 0,
03467 AudioDriverType_WinMM = 1,
03472 AudioDriverType_OSS = 2,
03477 AudioDriverType_ALSA = 3,
03482 AudioDriverType_DirectSound = 4,
03487 AudioDriverType_CoreAudio = 5,
03492 AudioDriverType_MMPM = 6,
03497 AudioDriverType_Pulse = 7,
03502 AudioDriverType_SolAudio = 8,
03503 };
03504
03512 enum AudioControllerType
03513 {
03514 AudioControllerType_AC97 = 0,
03515 AudioControllerType_SB16 = 1,
03516 AudioControllerType_HDA = 2,
03517 };
03518
03526 enum AuthType
03527 {
03532 AuthType_Null = 0,
03533 AuthType_External = 1,
03534 AuthType_Guest = 2,
03535 };
03536
03544 enum Reason
03545 {
03550 Reason_Unspecified = 0,
03555 Reason_HostSuspend = 1,
03560 Reason_HostResume = 2,
03565 Reason_HostBatteryLow = 3,
03566 };
03567
03576 enum StorageBus
03577 {
03582 StorageBus_Null = 0,
03583 StorageBus_IDE = 1,
03584 StorageBus_SATA = 2,
03585 StorageBus_SCSI = 3,
03586 StorageBus_Floppy = 4,
03587 StorageBus_SAS = 5,
03588 };
03589
03598 enum StorageControllerType
03599 {
03604 StorageControllerType_Null = 0,
03609 StorageControllerType_LsiLogic = 1,
03614 StorageControllerType_BusLogic = 2,
03619 StorageControllerType_IntelAhci = 3,
03624 StorageControllerType_PIIX3 = 4,
03629 StorageControllerType_PIIX4 = 5,
03634 StorageControllerType_ICH6 = 6,
03639 StorageControllerType_I82078 = 7,
03644 StorageControllerType_LsiLogicSas = 8,
03645 };
03646
03654 enum ChipsetType
03655 {
03660 ChipsetType_Null = 0,
03665 ChipsetType_PIIX3 = 1,
03670 ChipsetType_ICH9 = 2,
03671 };
03672
03678 enum NATAliasMode
03679 {
03684 NATAliasMode_AliasLog = 0x1,
03689 NATAliasMode_AliasProxyOnly = 0x02,
03694 NATAliasMode_AliasUseSamePorts = 0x04,
03695 };
03696
03702 enum NATProtocol
03703 {
03708 NATProtocol_UDP = 0,
03713 NATProtocol_TCP = 1,
03714 };
03715
03723 enum BandwidthGroupType
03724 {
03731 BandwidthGroupType_Null = 0,
03738 BandwidthGroupType_Disk = 1,
03745 BandwidthGroupType_Network = 2,
03746 };
03747
03756 enum VBoxEventType
03757 {
03764 VBoxEventType_Invalid = 0,
03773 VBoxEventType_Any = 1,
03781 VBoxEventType_Vetoable = 2,
03789 VBoxEventType_MachineEvent = 3,
03797 VBoxEventType_SnapshotEvent = 4,
03806 VBoxEventType_InputEvent = 5,
03813 VBoxEventType_LastWildcard = 31,
03820 VBoxEventType_OnMachineStateChanged = 32,
03827 VBoxEventType_OnMachineDataChanged = 33,
03834 VBoxEventType_OnExtraDataChanged = 34,
03841 VBoxEventType_OnExtraDataCanChange = 35,
03848 VBoxEventType_OnMediumRegistered = 36,
03855 VBoxEventType_OnMachineRegistered = 37,
03862 VBoxEventType_OnSessionStateChanged = 38,
03869 VBoxEventType_OnSnapshotTaken = 39,
03876 VBoxEventType_OnSnapshotDeleted = 40,
03883 VBoxEventType_OnSnapshotChanged = 41,
03890 VBoxEventType_OnGuestPropertyChanged = 42,
03897 VBoxEventType_OnMousePointerShapeChanged = 43,
03904 VBoxEventType_OnMouseCapabilityChanged = 44,
03911 VBoxEventType_OnKeyboardLedsChanged = 45,
03918 VBoxEventType_OnStateChanged = 46,
03925 VBoxEventType_OnAdditionsStateChanged = 47,
03932 VBoxEventType_OnNetworkAdapterChanged = 48,
03939 VBoxEventType_OnSerialPortChanged = 49,
03946 VBoxEventType_OnParallelPortChanged = 50,
03953 VBoxEventType_OnStorageControllerChanged = 51,
03960 VBoxEventType_OnMediumChanged = 52,
03967 VBoxEventType_OnVRDEServerChanged = 53,
03974 VBoxEventType_OnUSBControllerChanged = 54,
03981 VBoxEventType_OnUSBDeviceStateChanged = 55,
03988 VBoxEventType_OnSharedFolderChanged = 56,
03995 VBoxEventType_OnRuntimeError = 57,
04002 VBoxEventType_OnCanShowWindow = 58,
04009 VBoxEventType_OnShowWindow = 59,
04016 VBoxEventType_OnCPUChanged = 60,
04023 VBoxEventType_OnVRDEServerInfoChanged = 61,
04030 VBoxEventType_OnEventSourceChanged = 62,
04037 VBoxEventType_OnCPUExecutionCapChanged = 63,
04044 VBoxEventType_OnGuestKeyboard = 64,
04051 VBoxEventType_OnGuestMouse = 65,
04058 VBoxEventType_OnNATRedirect = 66,
04065 VBoxEventType_OnHostPCIDevicePlug = 67,
04072 VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
04079 VBoxEventType_OnBandwidthGroupChanged = 69,
04086 VBoxEventType_OnGuestMonitorChanged = 70,
04093 VBoxEventType_OnStorageDeviceChanged = 71,
04100 VBoxEventType_OnClipboardModeChanged = 72,
04107 VBoxEventType_OnDragAndDropModeChanged = 73,
04114 VBoxEventType_OnNATNetworkChanged = 74,
04121 VBoxEventType_OnNATNetworkStartStop = 75,
04128 VBoxEventType_OnNATNetworkAlter = 76,
04135 VBoxEventType_OnNATNetworkCreationDeletion = 77,
04142 VBoxEventType_OnNATNetworkSetting = 78,
04149 VBoxEventType_OnNATNetworkPortForward = 79,
04156 VBoxEventType_OnGuestSessionStateChanged = 80,
04163 VBoxEventType_OnGuestSessionRegistered = 81,
04170 VBoxEventType_OnGuestProcessRegistered = 82,
04177 VBoxEventType_OnGuestProcessStateChanged = 83,
04184 VBoxEventType_OnGuestProcessInputNotify = 84,
04191 VBoxEventType_OnGuestProcessOutput = 85,
04198 VBoxEventType_OnGuestFileRegistered = 86,
04205 VBoxEventType_OnGuestFileStateChanged = 87,
04212 VBoxEventType_OnGuestFileOffsetChanged = 88,
04220 VBoxEventType_OnGuestFileRead = 89,
04228 VBoxEventType_OnGuestFileWrite = 90,
04235 VBoxEventType_OnVideoCaptureChanged = 91,
04242 VBoxEventType_OnGuestUserStateChanged = 92,
04249 VBoxEventType_OnGuestMultiTouch = 93,
04256 VBoxEventType_OnHostNameResolutionConfigurationChange = 94,
04263 VBoxEventType_Last = 95,
04264 };
04265
04277 enum GuestMouseEventMode
04278 {
04285 GuestMouseEventMode_Relative = 0,
04292 GuestMouseEventMode_Absolute = 1,
04293 };
04294
04302 enum GuestMonitorChangedEventType
04303 {
04310 GuestMonitorChangedEventType_Enabled = 0,
04317 GuestMonitorChangedEventType_Disabled = 1,
04324 GuestMonitorChangedEventType_NewOrigin = 2,
04325 };
04326
04360 interface IVirtualBoxErrorInfo : $errorinfo
04361 {
04379 readonly attribute long resultCode;
04380
04387 readonly attribute long resultDetail;
04388
04400 readonly attribute wstringUUID interfaceID;
04401
04412 readonly attribute wstring component;
04413
04424 readonly attribute wstring text;
04425
04436 readonly attribute IVirtualBoxErrorInfo next;
04437
04438 };
04439
04440 interface INATNetwork : $unknown
04441 {
04450 attribute wstring networkName;
04451
04452 attribute boolean enabled;
04453
04462 attribute wstring network;
04463
04470 readonly attribute wstring gateway;
04471
04477 attribute boolean IPv6Enabled;
04478
04486 attribute wstring IPv6Prefix;
04487
04488 attribute boolean advertiseDefaultIPv6RouteEnabled;
04489
04490 attribute boolean needDhcpServer;
04491
04492 readonly attribute IEventSource eventSource;
04493
04500 readonly attribute wstring[] portForwardRules4;
04501
04506 readonly attribute wstring[] localMappings;
04507
04512 attribute long loopbackIp6;
04513
04519 readonly attribute wstring[] portForwardRules6;
04520
04524 void addLocalMapping (
04525 in wstring hostid,
04526 in long offset
04527 );
04528
04529 void addPortForwardRule (
04530 in boolean isIpv6,
04531 in wstring ruleName,
04532 in NATProtocol proto,
04533 in wstring hostIP,
04534 in unsigned short hostPort,
04535 in wstring guestIP,
04536 in unsigned short guestPort
04537 );
04538
04539 void removePortForwardRule (
04540 in boolean iSipv6,
04541 in wstring ruleName
04542 );
04543
04544 void start (
04545 in wstring trunkType
04546 );
04547
04548 void stop();
04549
04550 };
04551
04562 interface IDHCPServer : $unknown
04563 {
04564 readonly attribute IEventSource eventSource;
04565
04571 attribute boolean enabled;
04572
04578 readonly attribute wstring IPAddress;
04579
04585 readonly attribute wstring networkMask;
04586
04592 readonly attribute wstring networkName;
04593
04599 readonly attribute wstring lowerIP;
04600
04606 readonly attribute wstring upperIP;
04607
04608 readonly attribute wstring[] globalOptions;
04609
04610 readonly attribute wstring[] vmConfigs;
04611
04612 void addGlobalOption (
04613 in DhcpOpt option,
04614 in wstring value
04615 );
04616
04617 void addVmSlotOption (
04618 in wstring vmname,
04619 in long slot,
04620 in DhcpOpt option,
04621 in wstring value
04622 );
04623
04624 void removeVmSlotOptions (
04625 in wstring vmname,
04626 in long slot
04627 );
04628
04629 void getVmSlotOptions (
04630 in wstring vmname,
04631 in long slot,
04632 [retval] out wstring[] option
04633 );
04634
04635 void getMacOptions (
04636 in wstring mac,
04637 [retval] out wstring[] option
04638 );
04639
04668 void setConfiguration (
04669 in wstring IPAddress,
04670 in wstring networkMask,
04671 in wstring FromIPAddress,
04672 in wstring ToIPAddress
04673 );
04674
04699 void start (
04700 in wstring networkName,
04701 in wstring trunkName,
04702 in wstring trunkType
04703 );
04704
04717 void stop();
04718
04719 };
04720
04739 interface IVirtualBox : $unknown
04740 {
04753 readonly attribute wstring version;
04754
04762 readonly attribute wstring versionNormalized;
04763
04769 readonly attribute unsigned long revision;
04770
04780 readonly attribute wstring packageType;
04781
04793 readonly attribute wstring APIVersion;
04794
04810 readonly attribute wstring homeFolder;
04811
04819 readonly attribute wstring settingsFilePath;
04820
04824 readonly attribute IHost host;
04825
04829 readonly attribute ISystemProperties systemProperties;
04830
04836 readonly attribute IMachine[] machines;
04837
04847 readonly attribute wstring[] machineGroups;
04848
04858 readonly attribute IMedium[] hardDisks;
04859
04865 readonly attribute IMedium[] DVDImages;
04866
04872 readonly attribute IMedium[] floppyImages;
04873
04874 readonly attribute IProgress[] progressOperations;
04875
04876 readonly attribute IGuestOSType[] guestOSTypes;
04877
04894 readonly attribute ISharedFolder[] sharedFolders;
04895
04901 readonly attribute IPerformanceCollector performanceCollector;
04902
04908 readonly attribute IDHCPServer[] DHCPServers;
04909
04910 readonly attribute INATNetwork[] NATNetworks;
04911
04917 readonly attribute IEventSource eventSource;
04918
04924 readonly attribute IExtPackManager extensionPackManager;
04925
04931 readonly attribute wstring[] internalNetworks;
04932
04938 readonly attribute wstring[] genericNetworkDrivers;
04939
04990 void composeMachineFilename (
04991 in wstring name,
04992 in wstring group,
04993 in wstring createFlags,
04994 in wstring baseFolder,
04995 [retval] out wstring file
04996 );
04997
05104 void createMachine (
05105 in wstring settingsFile,
05106 in wstring name,
05107 in wstring[] groups,
05108 in wstring osTypeId,
05109 in wstring flags,
05110 [retval] out IMachine machine
05111 );
05112
05143 void openMachine (
05144 in wstring settingsFile,
05145 [retval] out IMachine machine
05146 );
05147
05179 void registerMachine (
05180 in IMachine machine
05181 );
05182
05203 void findMachine (
05204 in wstring nameOrId,
05205 [retval] out IMachine machine
05206 );
05207
05219 void getMachinesByGroups (
05220 in wstring[] groups,
05221 [retval] out IMachine[] machines
05222 );
05223
05233 void getMachineStates (
05234 in IMachine[] machines,
05235 [retval] out MachineState[] states
05236 );
05237
05247 void createAppliance (
05248 [retval] out IAppliance appliance
05249 );
05250
05313 void createHardDisk (
05314 in wstring format,
05315 in wstring location,
05316 [retval] out IMedium medium
05317 );
05318
05424 void openMedium (
05425 in wstring location,
05426 in DeviceType deviceType,
05427 in AccessMode accessMode,
05428 in boolean forceNewUuid,
05429 [retval] out IMedium medium
05430 );
05431
05460 void getGuestOSType (
05461 in wstringUUID id,
05462 [retval] out IGuestOSType type
05463 );
05464
05487 void createSharedFolder (
05488 in wstring name,
05489 in wstring hostPath,
05490 in boolean writable,
05491 in boolean automount
05492 );
05493
05508 void removeSharedFolder (
05509 in wstring name
05510 );
05511
05520 void getExtraDataKeys (
05521 [retval] out wstring[] keys
05522 );
05523
05552 void getExtraData (
05553 in wstring key,
05554 [retval] out wstring value
05555 );
05556
05606 void setExtraData (
05607 in wstring key,
05608 in wstring value
05609 );
05610
05629 void setSettingsSecret (
05630 in wstring password
05631 );
05632
05649 void createDHCPServer (
05650 in wstring name,
05651 [retval] out IDHCPServer server
05652 );
05653
05670 void findDHCPServerByNetworkName (
05671 in wstring name,
05672 [retval] out IDHCPServer server
05673 );
05674
05689 void removeDHCPServer (
05690 in IDHCPServer server
05691 );
05692
05693 void createNATNetwork (
05694 in wstring networkName,
05695 [retval] out INATNetwork network
05696 );
05697
05698 void findNATNetworkByName (
05699 in wstring networkName,
05700 [retval] out INATNetwork network
05701 );
05702
05703 void removeNATNetwork (
05704 in INATNetwork network
05705 );
05706
05731 void checkFirmwarePresent (
05732 in FirmwareType firmwareType,
05733 in wstring version,
05734 out wstring url,
05735 out wstring file,
05736 [retval] out boolean result
05737 );
05738
05739 };
05740
05751 interface IVFSExplorer : $unknown
05752 {
05756 readonly attribute wstring path;
05757
05761 readonly attribute VFSType type;
05762
05770 void update (
05771 [retval] out IProgress progress
05772 );
05773
05781 void cd (
05782 in wstring dir,
05783 [retval] out IProgress progress
05784 );
05785
05791 void cdUp (
05792 [retval] out IProgress progress
05793 );
05794
05807 void entryList (
05808 out wstring[] names,
05809 out unsigned long[] types,
05810 out long long[] sizes,
05811 out unsigned long[] modes
05812 );
05813
05822 void exists (
05823 in wstring[] names,
05824 [retval] out wstring[] exists
05825 );
05826
05834 void remove (
05835 in wstring[] names,
05836 [retval] out IProgress progress
05837 );
05838
05839 };
05840
05906 interface IAppliance : $unknown
05907 {
05915 readonly attribute wstring path;
05916
05947 readonly attribute wstring[] disks;
05948
05956 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
05957
05965 readonly attribute wstring[] machines;
05966
05983 void read (
05984 in wstring file,
05985 [retval] out IProgress progress
05986 );
05987
06004 void interpret();
06005
06028 void importMachines (
06029 in ImportOptions[] options,
06030 [retval] out IProgress progress
06031 );
06032
06040 void createVFSExplorer (
06041 in wstring URI,
06042 [retval] out IVFSExplorer explorer
06043 );
06044
06074 void write (
06075 in wstring format,
06076 in boolean manifest,
06077 in wstring path,
06078 [retval] out IProgress progress
06079 );
06080
06086 void getWarnings (
06087 [retval] out wstring[] warnings
06088 );
06089
06090 };
06091
06103 interface IVirtualSystemDescription : $unknown
06104 {
06108 readonly attribute unsigned long count;
06109
06233 void getDescription (
06234 out VirtualSystemDescriptionType[] types,
06235 out wstring[] refs,
06236 out wstring[] OVFValues,
06237 out wstring[] VBoxValues,
06238 out wstring[] extraConfigValues
06239 );
06240
06257 void getDescriptionByType (
06258 in VirtualSystemDescriptionType type,
06259 out VirtualSystemDescriptionType[] types,
06260 out wstring[] refs,
06261 out wstring[] OVFValues,
06262 out wstring[] VBoxValues,
06263 out wstring[] extraConfigValues
06264 );
06265
06277 void getValuesByType (
06278 in VirtualSystemDescriptionType type,
06279 in VirtualSystemDescriptionValueType which,
06280 [retval] out wstring[] values
06281 );
06282
06308 void setFinalValues (
06309 in boolean[] enabled,
06310 in wstring[] VBoxValues,
06311 in wstring[] extraConfigValues
06312 );
06313
06328 void addDescription (
06329 in VirtualSystemDescriptionType type,
06330 in wstring VBoxValue,
06331 in wstring extraConfigValue
06332 );
06333
06334 };
06335
06336 interface IInternalMachineControl : $unknown
06337 {
06344 void setRemoveSavedStateFile (
06345 in boolean remove
06346 );
06347
06359 void updateState (
06360 in MachineState state
06361 );
06362
06374 void beginPowerUp (
06375 in IProgress progress
06376 );
06377
06387 void endPowerUp (
06388 in long result
06389 );
06390
06402 void beginPoweringDown (
06403 out IProgress progress
06404 );
06405
06435 void endPoweringDown (
06436 in long result,
06437 in wstring errMsg
06438 );
06439
06453 void runUSBDeviceFilters (
06454 in IUSBDevice device,
06455 out boolean matched,
06456 out unsigned long maskedInterfaces
06457 );
06458
06467 void captureUSBDevice (
06468 in wstringUUID id
06469 );
06470
06486 void detachUSBDevice (
06487 in wstringUUID id,
06488 in boolean done
06489 );
06490
06499 void autoCaptureUSBDevices();
06500
06516 void detachAllUSBDevices (
06517 in boolean done
06518 );
06519
06534 void onSessionEnd (
06535 in ISession session,
06536 [retval] out IProgress progress
06537 );
06538
06554 void beginSavingState (
06555 out IProgress progress,
06556 out wstring stateFilePath
06557 );
06558
06588 void endSavingState (
06589 in long result,
06590 in wstring errMsg
06591 );
06592
06607 void adoptSavedState (
06608 in wstring savedStateFile
06609 );
06610
06659 void beginTakingSnapshot (
06660 in IConsole initiator,
06661 in wstring name,
06662 in wstring description,
06663 in IProgress consoleProgress,
06664 in boolean fTakingSnapshotOnline,
06665 out wstring stateFilePath
06666 );
06667
06677 void endTakingSnapshot (
06678 in boolean success
06679 );
06680
06709 void deleteSnapshot (
06710 in IConsole initiator,
06711 in wstringUUID startId,
06712 in wstringUUID endId,
06713 in boolean deleteAllChildren,
06714 out MachineState machineState,
06715 [retval] out IProgress progress
06716 );
06717
06724 void finishOnlineMergeMedium();
06725
06739 void restoreSnapshot (
06740 in IConsole initiator,
06741 in ISnapshot snapshot,
06742 out MachineState machineState,
06743 [retval] out IProgress progress
06744 );
06745
06772 void pullGuestProperties (
06773 out wstring[] names,
06774 out wstring[] values,
06775 out long long[] timestamps,
06776 out wstring[] flags
06777 );
06778
06800 void pushGuestProperty (
06801 in wstring name,
06802 in wstring value,
06803 in long long timestamp,
06804 in wstring flags
06805 );
06806
06818 void lockMedia();
06819
06829 void unlockMedia();
06830
06846 void ejectMedium (
06847 in IMediumAttachment attachment,
06848 [retval] out IMediumAttachment newAttachment
06849 );
06850
06891 void reportVmStatistics (
06892 in unsigned long validStats,
06893 in unsigned long cpuUser,
06894 in unsigned long cpuKernel,
06895 in unsigned long cpuIdle,
06896 in unsigned long memTotal,
06897 in unsigned long memFree,
06898 in unsigned long memBalloon,
06899 in unsigned long memShared,
06900 in unsigned long memCache,
06901 in unsigned long pagedTotal,
06902 in unsigned long memAllocTotal,
06903 in unsigned long memFreeTotal,
06904 in unsigned long memBalloonTotal,
06905 in unsigned long memSharedTotal,
06906 in unsigned long vmNetRx,
06907 in unsigned long vmNetTx
06908 );
06909
06910 };
06911
06920 interface IBIOSSettings : $unknown
06921 {
06925 attribute boolean logoFadeIn;
06926
06930 attribute boolean logoFadeOut;
06931
06935 attribute unsigned long logoDisplayTime;
06936
06943 attribute wstring logoImagePath;
06944
06948 attribute BIOSBootMenuMode bootMenuMode;
06949
06953 attribute boolean ACPIEnabled;
06954
06961 attribute boolean IOAPICEnabled;
06962
06972 attribute long long timeOffset;
06973
06980 attribute boolean PXEDebugEnabled;
06981
06990 readonly attribute wstring nonVolatileStorageFile;
06991
06992 };
06993
07001 interface IPCIAddress : $unknown
07002 {
07008 attribute short bus;
07009
07015 attribute short device;
07016
07022 attribute short devFunction;
07023
07029 void asLong (
07030 [retval] out long result
07031 );
07032
07038 void fromLong (
07039 in long number
07040 );
07041
07042 };
07043
07051 interface IPCIDeviceAttachment : $unknown
07052 {
07058 readonly attribute wstring name;
07059
07065 readonly attribute boolean isPhysicalDevice;
07066
07072 readonly attribute long hostAddress;
07073
07079 readonly attribute long guestAddress;
07080
07081 };
07082
07123 interface IMachine : $unknown
07124 {
07128 readonly attribute IVirtualBox parent;
07129
07133 attribute octet[] icon;
07134
07184 readonly attribute boolean accessible;
07185
07197 readonly attribute IVirtualBoxErrorInfo accessError;
07198
07238 attribute wstring name;
07239
07250 attribute wstring description;
07251
07255 readonly attribute wstringUUID id;
07256
07267 attribute wstring[] groups;
07268
07283 attribute wstring OSTypeId;
07284
07288 attribute wstring hardwareVersion;
07289
07299 attribute wstringUUID hardwareUUID;
07300
07304 attribute unsigned long CPUCount;
07305
07311 attribute boolean CPUHotPlugEnabled;
07312
07320 attribute unsigned long CPUExecutionCap;
07321
07325 attribute unsigned long memorySize;
07326
07330 attribute unsigned long memoryBalloonSize;
07331
07338 attribute boolean pageFusionEnabled;
07339
07343 attribute GraphicsControllerType graphicsControllerType;
07344
07348 attribute unsigned long VRAMSize;
07349
07355 attribute boolean accelerate3DEnabled;
07356
07362 attribute boolean accelerate2DVideoEnabled;
07363
07374 attribute unsigned long monitorCount;
07375
07381 attribute boolean videoCaptureEnabled;
07382
07388 attribute boolean[] videoCaptureScreens;
07389
07403 attribute wstring videoCaptureFile;
07404
07412 attribute unsigned long videoCaptureWidth;
07413
07421 attribute unsigned long videoCaptureHeight;
07422
07431 attribute unsigned long videoCaptureRate;
07432
07442 attribute unsigned long videoCaptureFPS;
07443
07447 readonly attribute IBIOSSettings BIOSSettings;
07448
07453 attribute FirmwareType firmwareType;
07454
07460 attribute PointingHIDType pointingHIDType;
07461
07467 attribute KeyboardHIDType keyboardHIDType;
07468
07475 attribute boolean HPETEnabled;
07476
07480 attribute ChipsetType chipsetType;
07481
07515 attribute wstring snapshotFolder;
07516
07520 readonly attribute IVRDEServer VRDEServer;
07521
07522 attribute boolean emulatedUSBCardReaderEnabled;
07523
07527 readonly attribute IMediumAttachment[] mediumAttachments;
07528
07540 readonly attribute IUSBController[] USBControllers;
07541
07553 readonly attribute IUSBDeviceFilters USBDeviceFilters;
07554
07558 readonly attribute IAudioAdapter audioAdapter;
07559
07563 readonly attribute IStorageController[] storageControllers;
07564
07570 readonly attribute wstring settingsFilePath;
07571
07596 readonly attribute boolean settingsModified;
07597
07601 readonly attribute SessionState sessionState;
07602
07615 readonly attribute wstring sessionType;
07616
07626 readonly attribute unsigned long sessionPID;
07627
07631 readonly attribute MachineState state;
07632
07639 readonly attribute long long lastStateChange;
07640
07652 readonly attribute wstring stateFilePath;
07653
07663 readonly attribute wstring logFolder;
07664
07675 readonly attribute ISnapshot currentSnapshot;
07676
07683 readonly attribute unsigned long snapshotCount;
07684
07716 readonly attribute boolean currentStateModified;
07717
07729 readonly attribute ISharedFolder[] sharedFolders;
07730
07737 attribute ClipboardMode clipboardMode;
07738
07744 attribute DragAndDropMode dragAndDropMode;
07745
07753 attribute wstring guestPropertyNotificationPatterns;
07754
07763 attribute boolean teleporterEnabled;
07764
07775 attribute unsigned long teleporterPort;
07776
07783 attribute wstring teleporterAddress;
07784
07795 attribute wstring teleporterPassword;
07796
07804 attribute FaultToleranceState faultToleranceState;
07805
07812 attribute unsigned long faultTolerancePort;
07813
07819 attribute wstring faultToleranceAddress;
07820
07828 attribute wstring faultTolerancePassword;
07829
07835 attribute unsigned long faultToleranceSyncInterval;
07836
07844 attribute boolean RTCUseUTC;
07845
07852 attribute boolean IOCacheEnabled;
07853
07859 attribute unsigned long IOCacheSize;
07860
07870 readonly attribute IPCIDeviceAttachment[] PCIDeviceAssignments;
07871
07877 readonly attribute IBandwidthControl bandwidthControl;
07878
07887 attribute boolean tracingEnabled;
07888
07903 attribute wstring tracingConfig;
07904
07917 attribute boolean allowTracingToAccessVM;
07918
07924 attribute boolean autostartEnabled;
07925
07931 attribute unsigned long autostartDelay;
07932
07938 attribute AutostopType autostopType;
07939
07955 attribute wstring defaultFrontend;
07956
07962 readonly attribute boolean USBProxyAvailable;
07963
08069 void lockMachine (
08070 in ISession session,
08071 in LockType lockType
08072 );
08073
08210 void launchVMProcess (
08211 in ISession session,
08212 in wstring type,
08213 in wstring environment,
08214 [retval] out IProgress progress
08215 );
08216
08254 void setBootOrder (
08255 in unsigned long position,
08256 in DeviceType device
08257 );
08258
08293 void getBootOrder (
08294 in unsigned long position,
08295 [retval] out DeviceType device
08296 );
08297
08399 void attachDevice (
08400 in wstring name,
08401 in long controllerPort,
08402 in long device,
08403 in DeviceType type,
08404 in IMedium medium
08405 );
08406
08502 void attachDeviceWithoutMedium (
08503 in wstring name,
08504 in long controllerPort,
08505 in long device,
08506 in DeviceType type
08507 );
08508
08562 void detachDevice (
08563 in wstring name,
08564 in long controllerPort,
08565 in long device
08566 );
08567
08610 void passthroughDevice (
08611 in wstring name,
08612 in long controllerPort,
08613 in long device,
08614 in boolean passthrough
08615 );
08616
08659 void temporaryEjectDevice (
08660 in wstring name,
08661 in long controllerPort,
08662 in long device,
08663 in boolean temporaryEject
08664 );
08665
08711 void nonRotationalDevice (
08712 in wstring name,
08713 in long controllerPort,
08714 in long device,
08715 in boolean nonRotational
08716 );
08717
08763 void setAutoDiscardForDevice (
08764 in wstring name,
08765 in long controllerPort,
08766 in long device,
08767 in boolean discard
08768 );
08769
08819 void setHotPluggableForDevice (
08820 in wstring name,
08821 in long controllerPort,
08822 in long device,
08823 in boolean hotPluggable
08824 );
08825
08866 void setBandwidthGroupForDevice (
08867 in wstring name,
08868 in long controllerPort,
08869 in long device,
08870 in IBandwidthGroup bandwidthGroup
08871 );
08872
08909 void setNoBandwidthGroupForDevice (
08910 in wstring name,
08911 in long controllerPort,
08912 in long device
08913 );
08914
08979 void unmountMedium (
08980 in wstring name,
08981 in long controllerPort,
08982 in long device,
08983 in boolean force
08984 );
08985
09048 void mountMedium (
09049 in wstring name,
09050 in long controllerPort,
09051 in long device,
09052 in IMedium medium,
09053 in boolean force
09054 );
09055
09084 void getMedium (
09085 in wstring name,
09086 in long controllerPort,
09087 in long device,
09088 [retval] out IMedium medium
09089 );
09090
09105 void getMediumAttachmentsOfController (
09106 in wstring name,
09107 [retval] out IMediumAttachment[] mediumAttachments
09108 );
09109
09124 void getMediumAttachment (
09125 in wstring name,
09126 in long controllerPort,
09127 in long device,
09128 [retval] out IMediumAttachment attachment
09129 );
09130
09171 void attachHostPCIDevice (
09172 in long hostAddress,
09173 in long desiredGuestAddress,
09174 in boolean tryToUnbind
09175 );
09176
09217 void detachHostPCIDevice (
09218 in long hostAddress
09219 );
09220
09238 void getNetworkAdapter (
09239 in unsigned long slot,
09240 [retval] out INetworkAdapter adapter
09241 );
09242
09275 void addStorageController (
09276 in wstring name,
09277 in StorageBus connectionType,
09278 [retval] out IStorageController controller
09279 );
09280
09294 void getStorageControllerByName (
09295 in wstring name,
09296 [retval] out IStorageController storageController
09297 );
09298
09312 void getStorageControllerByInstance (
09313 in unsigned long instance,
09314 [retval] out IStorageController storageController
09315 );
09316
09339 void removeStorageController (
09340 in wstring name
09341 );
09342
09364 void setStorageControllerBootable (
09365 in wstring name,
09366 in boolean bootable
09367 );
09368
09391 void addUSBController (
09392 in wstring name,
09393 in USBControllerType type,
09394 [retval] out IUSBController controller
09395 );
09396
09410 void removeUSBController (
09411 in wstring name
09412 );
09413
09427 void getUSBControllerByName (
09428 in wstring name,
09429 [retval] out IUSBController controller
09430 );
09431
09437 void getUSBControllerCountByType (
09438 in USBControllerType type,
09439 [retval] out unsigned long controllers
09440 );
09441
09459 void getSerialPort (
09460 in unsigned long slot,
09461 [retval] out ISerialPort port
09462 );
09463
09481 void getParallelPort (
09482 in unsigned long slot,
09483 [retval] out IParallelPort port
09484 );
09485
09494 void getExtraDataKeys (
09495 [retval] out wstring[] keys
09496 );
09497
09526 void getExtraData (
09527 in wstring key,
09528 [retval] out wstring value
09529 );
09530
09580 void setExtraData (
09581 in wstring key,
09582 in wstring value
09583 );
09584
09606 void getCPUProperty (
09607 in CPUPropertyType property,
09608 [retval] out boolean value
09609 );
09610
09632 void setCPUProperty (
09633 in CPUPropertyType property,
09634 in boolean value
09635 );
09636
09676 void getCPUIDLeaf (
09677 in unsigned long id,
09678 out unsigned long valEax,
09679 out unsigned long valEbx,
09680 out unsigned long valEcx,
09681 out unsigned long valEdx
09682 );
09683
09727 void setCPUIDLeaf (
09728 in unsigned long id,
09729 in unsigned long valEax,
09730 in unsigned long valEbx,
09731 in unsigned long valEcx,
09732 in unsigned long valEdx
09733 );
09734
09752 void removeCPUIDLeaf (
09753 in unsigned long id
09754 );
09755
09761 void removeAllCPUIDLeaves();
09762
09784 void getHWVirtExProperty (
09785 in HWVirtExPropertyType property,
09786 [retval] out boolean value
09787 );
09788
09810 void setHWVirtExProperty (
09811 in HWVirtExPropertyType property,
09812 in boolean value
09813 );
09814
09844 void setSettingsFilePath (
09845 in wstring settingsFilePath,
09846 [retval] out IProgress progress
09847 );
09848
09894 void saveSettings();
09895
09919 void discardSettings();
09920
10004 void unregister (
10005 in CleanupMode cleanupMode,
10006 [retval] out IMedium[] media
10007 );
10008
10065 void deleteConfig (
10066 in IMedium[] media,
10067 [retval] out IProgress progress
10068 );
10069
10081 void exportTo (
10082 in IAppliance appliance,
10083 in wstring location,
10084 [retval] out IVirtualSystemDescription description
10085 );
10086
10110 void findSnapshot (
10111 in wstring nameOrId,
10112 [retval] out ISnapshot snapshot
10113 );
10114
10148 void createSharedFolder (
10149 in wstring name,
10150 in wstring hostPath,
10151 in boolean writable,
10152 in boolean automount
10153 );
10154
10180 void removeSharedFolder (
10181 in wstring name
10182 );
10183
10207 void canShowConsoleWindow (
10208 [retval] out boolean canShow
10209 );
10210
10245 void showConsoleWindow (
10246 [retval] out long long winId
10247 );
10248
10281 void getGuestProperty (
10282 in wstring name,
10283 out wstring value,
10284 out long long timestamp,
10285 out wstring flags
10286 );
10287
10310 void getGuestPropertyValue (
10311 in wstring property,
10312 [retval] out wstring value
10313 );
10314
10337 void getGuestPropertyTimestamp (
10338 in wstring property,
10339 [retval] out long long value
10340 );
10341
10392 void setGuestProperty (
10393 in wstring property,
10394 in wstring value,
10395 in wstring flags
10396 );
10397
10437 void setGuestPropertyValue (
10438 in wstring property,
10439 in wstring value
10440 );
10441
10459 void deleteGuestProperty (
10460 in wstring name
10461 );
10462
10493 void enumerateGuestProperties (
10494 in wstring patterns,
10495 out wstring[] names,
10496 out wstring[] values,
10497 out long long[] timestamps,
10498 out wstring[] flags
10499 );
10500
10530 void querySavedGuestScreenInfo (
10531 in unsigned long screenId,
10532 out unsigned long originX,
10533 out unsigned long originY,
10534 out unsigned long width,
10535 out unsigned long height,
10536 out boolean enabled
10537 );
10538
10560 void querySavedThumbnailSize (
10561 in unsigned long screenId,
10562 out unsigned long size,
10563 out unsigned long width,
10564 out unsigned long height
10565 );
10566
10593 void readSavedThumbnailToArray (
10594 in unsigned long screenId,
10595 in boolean BGR,
10596 out unsigned long width,
10597 out unsigned long height,
10598 [retval] out octet[] data
10599 );
10600
10622 void readSavedThumbnailPNGToArray (
10623 in unsigned long screenId,
10624 out unsigned long width,
10625 out unsigned long height,
10626 [retval] out octet[] data
10627 );
10628
10650 void querySavedScreenshotPNGSize (
10651 in unsigned long screenId,
10652 out unsigned long size,
10653 out unsigned long width,
10654 out unsigned long height
10655 );
10656
10678 void readSavedScreenshotPNGToArray (
10679 in unsigned long screenId,
10680 out unsigned long width,
10681 out unsigned long height,
10682 [retval] out octet[] data
10683 );
10684
10694 void hotPlugCPU (
10695 in unsigned long cpu
10696 );
10697
10707 void hotUnplugCPU (
10708 in unsigned long cpu
10709 );
10710
10724 void getCPUStatus (
10725 in unsigned long cpu,
10726 [retval] out boolean attached
10727 );
10728
10743 void queryLogFilename (
10744 in unsigned long idx,
10745 [retval] out wstring filename
10746 );
10747
10773 void readLog (
10774 in unsigned long idx,
10775 in long long offset,
10776 in long long size,
10777 [retval] out octet[] data
10778 );
10779
10812 void cloneTo (
10813 in IMachine target,
10814 in CloneMode mode,
10815 in CloneOptions[] options,
10816 [retval] out IProgress progress
10817 );
10818
10819 };
10820
10828 interface IEmulatedUSB : $unknown
10829 {
10833 readonly attribute wstring[] webcams;
10834
10844 void webcamAttach (
10845 in wstring path,
10846 in wstring settings
10847 );
10848
10856 void webcamDetach (
10857 in wstring path
10858 );
10859
10860 };
10861
10870 interface IVRDEServerInfo : $unknown
10871 {
10877 readonly attribute boolean active;
10878
10887 readonly attribute long port;
10888
10894 readonly attribute unsigned long numberOfClients;
10895
10901 readonly attribute long long beginTime;
10902
10909 readonly attribute long long endTime;
10910
10916 readonly attribute long long bytesSent;
10917
10923 readonly attribute long long bytesSentTotal;
10924
10930 readonly attribute long long bytesReceived;
10931
10937 readonly attribute long long bytesReceivedTotal;
10938
10944 readonly attribute wstring user;
10945
10951 readonly attribute wstring domain;
10952
10958 readonly attribute wstring clientName;
10959
10965 readonly attribute wstring clientIP;
10966
10972 readonly attribute unsigned long clientVersion;
10973
10981 readonly attribute unsigned long encryptionStyle;
10982
10983 };
10984
11006 interface IConsole : $unknown
11007 {
11019 readonly attribute IMachine machine;
11020
11034 readonly attribute MachineState state;
11035
11039 readonly attribute IGuest guest;
11040
11051 readonly attribute IKeyboard keyboard;
11052
11063 readonly attribute IMouse mouse;
11064
11074 readonly attribute IDisplay display;
11075
11079 readonly attribute IMachineDebugger debugger;
11080
11091 readonly attribute IUSBDevice[] USBDevices;
11092
11100 readonly attribute IHostUSBDevice[] remoteUSBDevices;
11101
11117 readonly attribute ISharedFolder[] sharedFolders;
11118
11124 readonly attribute IVRDEServerInfo VRDEServerInfo;
11125
11131 readonly attribute IEventSource eventSource;
11132
11136 readonly attribute IPCIDeviceAttachment[] attachedPCIDevices;
11137
11146 attribute boolean useHostClipboard;
11147
11153 readonly attribute IEmulatedUSB emulatedUSB;
11154
11219 void powerUp (
11220 [retval] out IProgress progress
11221 );
11222
11256 void powerUpPaused (
11257 [retval] out IProgress progress
11258 );
11259
11279 void powerDown (
11280 [retval] out IProgress progress
11281 );
11282
11302 void reset();
11303
11323 void pause();
11324
11344 void resume();
11345
11365 void powerButton();
11366
11386 void sleepButton();
11387
11399 void getPowerButtonHandled (
11400 [retval] out boolean handled
11401 );
11402
11416 void getGuestEnteredACPIMode (
11417 [retval] out boolean entered
11418 );
11419
11472 void saveState (
11473 [retval] out IProgress progress
11474 );
11475
11508 void adoptSavedState (
11509 in wstring savedStateFile
11510 );
11511
11542 void discardSavedState (
11543 in boolean fRemoveFile
11544 );
11545
11558 void getDeviceActivity (
11559 in DeviceType type,
11560 [retval] out DeviceActivity activity
11561 );
11562
11600 void attachUSBDevice (
11601 in wstringUUID id
11602 );
11603
11638 void detachUSBDevice (
11639 in wstringUUID id,
11640 [retval] out IUSBDevice device
11641 );
11642
11665 void findUSBDeviceByAddress (
11666 in wstring name,
11667 [retval] out IUSBDevice device
11668 );
11669
11689 void findUSBDeviceById (
11690 in wstringUUID id,
11691 [retval] out IUSBDevice device
11692 );
11693
11727 void createSharedFolder (
11728 in wstring name,
11729 in wstring hostPath,
11730 in boolean writable,
11731 in boolean automount
11732 );
11733
11758 void removeSharedFolder (
11759 in wstring name
11760 );
11761
11799 void takeSnapshot (
11800 in wstring name,
11801 in wstring description,
11802 [retval] out IProgress progress
11803 );
11804
11877 void deleteSnapshot (
11878 in wstringUUID id,
11879 [retval] out IProgress progress
11880 );
11881
11921 void deleteSnapshotAndAllChildren (
11922 in wstringUUID id,
11923 [retval] out IProgress progress
11924 );
11925
11969 void deleteSnapshotRange (
11970 in wstringUUID startId,
11971 in wstringUUID endId,
11972 [retval] out IProgress progress
11973 );
11974
12015 void restoreSnapshot (
12016 in ISnapshot snapshot,
12017 [retval] out IProgress progress
12018 );
12019
12058 void teleport (
12059 in wstring hostname,
12060 in unsigned long tcpport,
12061 in wstring password,
12062 in unsigned long maxDowntime,
12063 [retval] out IProgress progress
12064 );
12065
12066 };
12067
12078 interface IHostNetworkInterface : $unknown
12079 {
12083 readonly attribute wstring name;
12084
12088 readonly attribute wstring shortName;
12089
12093 readonly attribute wstringUUID id;
12094
12098 readonly attribute wstring networkName;
12099
12103 readonly attribute boolean DHCPEnabled;
12104
12108 readonly attribute wstring IPAddress;
12109
12113 readonly attribute wstring networkMask;
12114
12118 readonly attribute boolean IPV6Supported;
12119
12123 readonly attribute wstring IPV6Address;
12124
12128 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
12129
12133 readonly attribute wstring hardwareAddress;
12134
12138 readonly attribute HostNetworkInterfaceMediumType mediumType;
12139
12143 readonly attribute HostNetworkInterfaceStatus status;
12144
12148 readonly attribute HostNetworkInterfaceType interfaceType;
12149
12161 void enableStaticIPConfig (
12162 in wstring IPAddress,
12163 in wstring networkMask
12164 );
12165
12177 void enableStaticIPConfigV6 (
12178 in wstring IPV6Address,
12179 in unsigned long IPV6NetworkMaskPrefixLength
12180 );
12181
12185 void enableDynamicIPConfig();
12186
12190 void DHCPRediscover();
12191
12192 };
12193
12201 interface IHostVideoInputDevice : $unknown
12202 {
12206 readonly attribute wstring name;
12207
12211 readonly attribute wstring path;
12212
12216 readonly attribute wstring alias;
12217
12218 };
12219
12236 interface IHost : $unknown
12237 {
12241 readonly attribute IMedium[] DVDDrives;
12242
12246 readonly attribute IMedium[] floppyDrives;
12247
12261 readonly attribute IHostUSBDevice[] USBDevices;
12262
12286 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
12287
12291 readonly attribute IHostNetworkInterface[] networkInterfaces;
12292
12296 readonly attribute wstring[] nameServers;
12297
12301 readonly attribute wstring domainName;
12302
12306 readonly attribute wstring[] searchStrings;
12307
12311 readonly attribute unsigned long processorCount;
12312
12316 readonly attribute unsigned long processorOnlineCount;
12317
12321 readonly attribute unsigned long processorCoreCount;
12322
12326 readonly attribute unsigned long processorOnlineCoreCount;
12327
12331 readonly attribute unsigned long memorySize;
12332
12336 readonly attribute unsigned long memoryAvailable;
12337
12341 readonly attribute wstring operatingSystem;
12342
12346 readonly attribute wstring OSVersion;
12347
12351 readonly attribute long long UTCTime;
12352
12356 readonly attribute boolean acceleration3DAvailable;
12357
12361 readonly attribute IHostVideoInputDevice[] videoInputDevices;
12362
12377 void getProcessorSpeed (
12378 in unsigned long cpuId,
12379 [retval] out unsigned long speed
12380 );
12381
12393 void getProcessorFeature (
12394 in ProcessorFeature feature,
12395 [retval] out boolean supported
12396 );
12397
12416 void getProcessorDescription (
12417 in unsigned long cpuId,
12418 [retval] out wstring description
12419 );
12420
12461 void getProcessorCPUIDLeaf (
12462 in unsigned long cpuId,
12463 in unsigned long leaf,
12464 in unsigned long subLeaf,
12465 out unsigned long valEax,
12466 out unsigned long valEbx,
12467 out unsigned long valEcx,
12468 out unsigned long valEdx
12469 );
12470
12491 void createHostOnlyNetworkInterface (
12492 out IHostNetworkInterface hostInterface,
12493 [retval] out IProgress progress
12494 );
12495
12516 void removeHostOnlyNetworkInterface (
12517 in wstringUUID id,
12518 [retval] out IProgress progress
12519 );
12520
12540 void createUSBDeviceFilter (
12541 in wstring name,
12542 [retval] out IHostUSBDeviceFilter filter
12543 );
12544
12587 void insertUSBDeviceFilter (
12588 in unsigned long position,
12589 in IHostUSBDeviceFilter filter
12590 );
12591
12619 void removeUSBDeviceFilter (
12620 in unsigned long position
12621 );
12622
12640 void findHostDVDDrive (
12641 in wstring name,
12642 [retval] out IMedium drive
12643 );
12644
12662 void findHostFloppyDrive (
12663 in wstring name,
12664 [retval] out IMedium drive
12665 );
12666
12682 void findHostNetworkInterfaceByName (
12683 in wstring name,
12684 [retval] out IHostNetworkInterface networkInterface
12685 );
12686
12702 void findHostNetworkInterfaceById (
12703 in wstringUUID id,
12704 [retval] out IHostNetworkInterface networkInterface
12705 );
12706
12716 void findHostNetworkInterfacesOfType (
12717 in HostNetworkInterfaceType type,
12718 [retval] out IHostNetworkInterface[] networkInterfaces
12719 );
12720
12740 void findUSBDeviceById (
12741 in wstringUUID id,
12742 [retval] out IHostUSBDevice device
12743 );
12744
12767 void findUSBDeviceByAddress (
12768 in wstring name,
12769 [retval] out IHostUSBDevice device
12770 );
12771
12779 void generateMACAddress (
12780 [retval] out wstring address
12781 );
12782
12783 };
12784
12797 interface ISystemProperties : $unknown
12798 {
12802 readonly attribute unsigned long minGuestRAM;
12803
12807 readonly attribute unsigned long maxGuestRAM;
12808
12812 readonly attribute unsigned long minGuestVRAM;
12813
12817 readonly attribute unsigned long maxGuestVRAM;
12818
12822 readonly attribute unsigned long minGuestCPUCount;
12823
12827 readonly attribute unsigned long maxGuestCPUCount;
12828
12832 readonly attribute unsigned long maxGuestMonitors;
12833
12838 readonly attribute long long infoVDSize;
12839
12846 readonly attribute unsigned long serialPortCount;
12847
12854 readonly attribute unsigned long parallelPortCount;
12855
12865 readonly attribute unsigned long maxBootPosition;
12866
12875 attribute boolean exclusiveHwVirt;
12876
12900 attribute wstring defaultMachineFolder;
12901
12907 attribute wstring loggingLevel;
12908
12933 readonly attribute IMediumFormat[] mediumFormats;
12934
12968 attribute wstring defaultHardDiskFormat;
12969
12975 attribute long long freeDiskSpaceWarning;
12976
12981 attribute unsigned long freeDiskSpacePercentWarning;
12982
12988 attribute long long freeDiskSpaceError;
12989
12994 attribute unsigned long freeDiskSpacePercentError;
12995
13019 attribute wstring VRDEAuthLibrary;
13020
13049 attribute wstring webServiceAuthLibrary;
13050
13064 attribute wstring defaultVRDEExtPack;
13065
13071 attribute unsigned long logHistoryCount;
13072
13077 readonly attribute AudioDriverType defaultAudioDriver;
13078
13085 attribute wstring autostartDatabasePath;
13086
13093 attribute wstring defaultAdditionsISO;
13094
13109 attribute wstring defaultFrontend;
13110
13121 void getMaxNetworkAdapters (
13122 in ChipsetType chipset,
13123 [retval] out unsigned long maxNetworkAdapters
13124 );
13125
13139 void getMaxNetworkAdaptersOfType (
13140 in ChipsetType chipset,
13141 in NetworkAttachmentType type,
13142 [retval] out unsigned long maxNetworkAdapters
13143 );
13144
13154 void getMaxDevicesPerPortForStorageBus (
13155 in StorageBus bus,
13156 [retval] out unsigned long maxDevicesPerPort
13157 );
13158
13166 void getMinPortCountForStorageBus (
13167 in StorageBus bus,
13168 [retval] out unsigned long minPortCount
13169 );
13170
13178 void getMaxPortCountForStorageBus (
13179 in StorageBus bus,
13180 [retval] out unsigned long maxPortCount
13181 );
13182
13195 void getMaxInstancesOfStorageBus (
13196 in ChipsetType chipset,
13197 in StorageBus bus,
13198 [retval] out unsigned long maxInstances
13199 );
13200
13210 void getDeviceTypesForStorageBus (
13211 in StorageBus bus,
13212 [retval] out DeviceType[] deviceTypes
13213 );
13214
13223 void getDefaultIoCacheSettingForStorageController (
13224 in StorageControllerType controllerType,
13225 [retval] out boolean enabled
13226 );
13227
13240 void getMaxInstancesOfUSBControllerType (
13241 in ChipsetType chipset,
13242 in USBControllerType type,
13243 [retval] out unsigned long maxInstances
13244 );
13245
13246 };
13247
13253 interface IGuestOSType : $unknown
13254 {
13258 readonly attribute wstring familyId;
13259
13263 readonly attribute wstring familyDescription;
13264
13268 readonly attribute wstring id;
13269
13273 readonly attribute wstring description;
13274
13278 readonly attribute boolean is64Bit;
13279
13283 readonly attribute boolean recommendedIOAPIC;
13284
13288 readonly attribute boolean recommendedVirtEx;
13289
13293 readonly attribute unsigned long recommendedRAM;
13294
13298 readonly attribute unsigned long recommendedVRAM;
13299
13303 readonly attribute boolean recommended2DVideoAcceleration;
13304
13308 readonly attribute boolean recommended3DAcceleration;
13309
13313 readonly attribute long long recommendedHDD;
13314
13318 readonly attribute NetworkAdapterType adapterType;
13319
13323 readonly attribute boolean recommendedPAE;
13324
13328 readonly attribute StorageControllerType recommendedDVDStorageController;
13329
13333 readonly attribute StorageBus recommendedDVDStorageBus;
13334
13338 readonly attribute StorageControllerType recommendedHDStorageController;
13339
13343 readonly attribute StorageBus recommendedHDStorageBus;
13344
13348 readonly attribute FirmwareType recommendedFirmware;
13349
13353 readonly attribute boolean recommendedUSBHID;
13354
13358 readonly attribute boolean recommendedHPET;
13359
13363 readonly attribute boolean recommendedUSBTablet;
13364
13368 readonly attribute boolean recommendedRTCUseUTC;
13369
13373 readonly attribute ChipsetType recommendedChipset;
13374
13378 readonly attribute AudioControllerType recommendedAudioController;
13379
13383 readonly attribute boolean recommendedFloppy;
13384
13388 readonly attribute boolean recommendedUSB;
13389
13390 };
13391
13399 interface IAdditionsFacility : $unknown
13400 {
13404 readonly attribute AdditionsFacilityClass classType;
13405
13412 readonly attribute long long lastUpdated;
13413
13417 readonly attribute wstring name;
13418
13422 readonly attribute AdditionsFacilityStatus status;
13423
13427 readonly attribute AdditionsFacilityType type;
13428
13429 };
13430
13459 interface IGuestSession : $unknown
13460 {
13466 readonly attribute wstring user;
13467
13473 readonly attribute wstring domain;
13474
13478 readonly attribute wstring name;
13479
13483 readonly attribute unsigned long id;
13484
13497 attribute unsigned long timeout;
13498
13503 readonly attribute unsigned long protocolVersion;
13504
13508 readonly attribute GuestSessionStatus status;
13509
13515 attribute wstring[] environment;
13516
13522 readonly attribute IGuestProcess[] processes;
13523
13529 readonly attribute IGuestDirectory[] directories;
13530
13536 readonly attribute IGuestFile[] files;
13537
13543 readonly attribute IEventSource eventSource;
13544
13553 void close();
13554
13576 void copyFrom (
13577 in wstring source,
13578 in wstring dest,
13579 in CopyFileFlag[] flags,
13580 [retval] out IProgress progress
13581 );
13582
13604 void copyTo (
13605 in wstring source,
13606 in wstring dest,
13607 in CopyFileFlag[] flags,
13608 [retval] out IProgress progress
13609 );
13610
13630 void directoryCreate (
13631 in wstring path,
13632 in unsigned long mode,
13633 in DirectoryCreateFlag[] flags
13634 );
13635
13687 void directoryCreateTemp (
13688 in wstring templateName,
13689 in unsigned long mode,
13690 in wstring path,
13691 in boolean secure,
13692 [retval] out wstring directory
13693 );
13694
13712 void directoryExists (
13713 in wstring path,
13714 [retval] out boolean exists
13715 );
13716
13747 void directoryOpen (
13748 in wstring path,
13749 in wstring filter,
13750 in DirectoryOpenFlag[] flags,
13751 [retval] out IGuestDirectory directory
13752 );
13753
13779 void directoryQueryInfo (
13780 in wstring path,
13781 [retval] out IGuestFsObjInfo info
13782 );
13783
13799 void directoryRemove (
13800 in wstring path
13801 );
13802
13822 void directoryRemoveRecursive (
13823 in wstring path,
13824 in DirectoryRemoveRecFlag[] flags,
13825 [retval] out IProgress progress
13826 );
13827
13847 void directoryRename (
13848 in wstring source,
13849 in wstring dest,
13850 in PathRenameFlag[] flags
13851 );
13852
13870 void directorySetACL (
13871 in wstring path,
13872 in wstring acl
13873 );
13874
13888 void environmentClear();
13889
13910 void environmentGet (
13911 in wstring name,
13912 [retval] out wstring value
13913 );
13914
13932 void environmentSet (
13933 in wstring name,
13934 in wstring value
13935 );
13936
13952 void environmentUnset (
13953 in wstring name
13954 );
13955
14009 void fileCreateTemp (
14010 in wstring templateName,
14011 in unsigned long mode,
14012 in wstring path,
14013 in boolean secure,
14014 [retval] out IGuestFile file
14015 );
14016
14034 void fileExists (
14035 in wstring path,
14036 [retval] out boolean exists
14037 );
14038
14062 void fileRemove (
14063 in wstring path
14064 );
14065
14127 void fileOpen (
14128 in wstring path,
14129 in wstring openMode,
14130 in wstring disposition,
14131 in unsigned long creationMode,
14132 [retval] out IGuestFile file
14133 );
14134
14201 void fileOpenEx (
14202 in wstring path,
14203 in wstring openMode,
14204 in wstring disposition,
14205 in wstring sharingMode,
14206 in unsigned long creationMode,
14207 in long long offset,
14208 [retval] out IGuestFile file
14209 );
14210
14236 void fileQueryInfo (
14237 in wstring path,
14238 [retval] out IGuestFsObjInfo info
14239 );
14240
14266 void fileQuerySize (
14267 in wstring path,
14268 [retval] out long long size
14269 );
14270
14290 void fileRename (
14291 in wstring source,
14292 in wstring dest,
14293 in PathRenameFlag[] flags
14294 );
14295
14313 void fileSetACL (
14314 in wstring file,
14315 in wstring acl
14316 );
14317
14372 void processCreate (
14373 in wstring command,
14374 in wstring[] arguments,
14375 in wstring[] environment,
14376 in ProcessCreateFlag[] flags,
14377 in unsigned long timeoutMS,
14378 [retval] out IGuestProcess guestProcess
14379 );
14380
14422 void processCreateEx (
14423 in wstring command,
14424 in wstring[] arguments,
14425 in wstring[] environment,
14426 in ProcessCreateFlag[] flags,
14427 in unsigned long timeoutMS,
14428 in ProcessPriority priority,
14429 in long[] affinity,
14430 [retval] out IGuestProcess guestProcess
14431 );
14432
14442 void processGet (
14443 in unsigned long pid,
14444 [retval] out IGuestProcess guestProcess
14445 );
14446
14469 void symlinkCreate (
14470 in wstring source,
14471 in wstring target,
14472 in SymlinkType type
14473 );
14474
14492 void symlinkExists (
14493 in wstring symlink,
14494 [retval] out boolean exists
14495 );
14496
14520 void symlinkRead (
14521 in wstring symlink,
14522 in SymlinkReadFlag[] flags,
14523 [retval] out wstring target
14524 );
14525
14541 void symlinkRemoveDirectory (
14542 in wstring path
14543 );
14544
14560 void symlinkRemoveFile (
14561 in wstring file
14562 );
14563
14584 void waitFor (
14585 in unsigned long waitFor,
14586 in unsigned long timeoutMS,
14587 [retval] out GuestSessionWaitResult reason
14588 );
14589
14611 void waitForArray (
14612 in GuestSessionWaitForFlag[] waitFor,
14613 in unsigned long timeoutMS,
14614 [retval] out GuestSessionWaitResult reason
14615 );
14616
14617 };
14618
14626 interface IProcess : $unknown
14627 {
14633 readonly attribute wstring[] arguments;
14634
14640 readonly attribute wstring[] environment;
14641
14647 readonly attribute IEventSource eventSource;
14648
14652 readonly attribute wstring executablePath;
14653
14660 readonly attribute long exitCode;
14661
14667 readonly attribute wstring name;
14668
14674 readonly attribute unsigned long PID;
14675
14682 readonly attribute ProcessStatus status;
14683
14704 void waitFor (
14705 in unsigned long waitFor,
14706 in unsigned long timeoutMS,
14707 [retval] out ProcessWaitResult reason
14708 );
14709
14731 void waitForArray (
14732 in ProcessWaitForFlag[] waitFor,
14733 in unsigned long timeoutMS,
14734 [retval] out ProcessWaitResult reason
14735 );
14736
14753 void read (
14754 in unsigned long handle,
14755 in unsigned long toRead,
14756 in unsigned long timeoutMS,
14757 [retval] out octet[] data
14758 );
14759
14783 void write (
14784 in unsigned long handle,
14785 in unsigned long flags,
14786 in octet[] data,
14787 in unsigned long timeoutMS,
14788 [retval] out unsigned long written
14789 );
14790
14815 void writeArray (
14816 in unsigned long handle,
14817 in ProcessInputFlag[] flags,
14818 in octet[] data,
14819 in unsigned long timeoutMS,
14820 [retval] out unsigned long written
14821 );
14822
14832 void terminate();
14833
14834 };
14835
14844 interface IGuestProcess : IProcess
14845 {
14846 };
14847
14855 interface IDirectory : $unknown
14856 {
14862 readonly attribute wstring directoryName;
14863
14869 readonly attribute wstring filter;
14870
14877 void close();
14878
14894 void read (
14895 [retval] out IFsObjInfo objInfo
14896 );
14897
14898 };
14899
14908 interface IGuestDirectory : IDirectory
14909 {
14910 };
14911
14919 interface IFile : $unknown
14920 {
14926 readonly attribute unsigned long creationMode;
14927
14933 readonly attribute wstring disposition;
14934
14940 readonly attribute IEventSource eventSource;
14941
14947 readonly attribute wstring fileName;
14948
14954 readonly attribute unsigned long id;
14955
14961 readonly attribute long long initialSize;
14962
14968 readonly attribute wstring openMode;
14969
14975 readonly attribute long long offset;
14976
14982 readonly attribute FileStatus status;
14983
14990 void close();
14991
15008 void queryInfo (
15009 [retval] out IFsObjInfo objInfo
15010 );
15011
15034 void read (
15035 in unsigned long toRead,
15036 in unsigned long timeoutMS,
15037 [retval] out octet[] data
15038 );
15039
15064 void readAt (
15065 in long long offset,
15066 in unsigned long toRead,
15067 in unsigned long timeoutMS,
15068 [retval] out octet[] data
15069 );
15070
15090 void seek (
15091 in long long offset,
15092 in FileSeekType whence
15093 );
15094
15110 void setACL (
15111 in wstring acl
15112 );
15113
15131 void write (
15132 in octet[] data,
15133 in unsigned long timeoutMS,
15134 [retval] out unsigned long written
15135 );
15136
15164 void writeAt (
15165 in long long offset,
15166 in octet[] data,
15167 in unsigned long timeoutMS,
15168 [retval] out unsigned long written
15169 );
15170
15171 };
15172
15181 interface IGuestFile : IFile
15182 {
15183 };
15184
15193 interface IFsObjInfo : $unknown
15194 {
15200 readonly attribute long long accessTime;
15201
15207 readonly attribute long long allocatedSize;
15208
15214 readonly attribute long long birthTime;
15215
15221 readonly attribute long long changeTime;
15222
15228 readonly attribute unsigned long deviceNumber;
15229
15235 readonly attribute wstring fileAttributes;
15236
15242 readonly attribute unsigned long generationId;
15243
15249 readonly attribute unsigned long GID;
15250
15256 readonly attribute wstring groupName;
15257
15263 readonly attribute unsigned long hardLinks;
15264
15270 readonly attribute long long modificationTime;
15271
15277 readonly attribute wstring name;
15278
15284 readonly attribute long long nodeId;
15285
15291 readonly attribute unsigned long nodeIdDevice;
15292
15300 readonly attribute long long objectSize;
15301
15307 readonly attribute FsObjType type;
15308
15314 readonly attribute unsigned long UID;
15315
15321 readonly attribute unsigned long userFlags;
15322
15328 readonly attribute wstring userName;
15329
15330 };
15331
15340 interface IGuestFsObjInfo : IFsObjInfo
15341 {
15342 };
15343
15357 interface IGuest : $unknown
15358 {
15373 readonly attribute wstring OSTypeId;
15374
15380 readonly attribute AdditionsRunLevelType additionsRunLevel;
15381
15388 readonly attribute wstring additionsVersion;
15389
15397 readonly attribute unsigned long additionsRevision;
15398
15404 readonly attribute IEventSource eventSource;
15405
15412 readonly attribute IAdditionsFacility[] facilities;
15413
15417 readonly attribute IGuestSession[] sessions;
15418
15422 attribute unsigned long memoryBalloonSize;
15423
15427 attribute unsigned long statisticsUpdateInterval;
15428
15460 void internalGetStatistics (
15461 out unsigned long cpuUser,
15462 out unsigned long cpuKernel,
15463 out unsigned long cpuIdle,
15464 out unsigned long memTotal,
15465 out unsigned long memFree,
15466 out unsigned long memBalloon,
15467 out unsigned long memShared,
15468 out unsigned long memCache,
15469 out unsigned long pagedTotal,
15470 out unsigned long memAllocTotal,
15471 out unsigned long memFreeTotal,
15472 out unsigned long memBalloonTotal,
15473 out unsigned long memSharedTotal
15474 );
15475
15487 void getFacilityStatus (
15488 in AdditionsFacilityType facility,
15489 out long long timestamp,
15490 [retval] out AdditionsFacilityStatus status
15491 );
15492
15510 void getAdditionsStatus (
15511 in AdditionsRunLevelType level,
15512 [retval] out boolean active
15513 );
15514
15544 void setCredentials (
15545 in wstring userName,
15546 in wstring password,
15547 in wstring domain,
15548 in boolean allowInteractiveLogon
15549 );
15550
15580 void dragHGEnter (
15581 in unsigned long screenId,
15582 in unsigned long y,
15583 in unsigned long x,
15584 in DragAndDropAction defaultAction,
15585 in DragAndDropAction[] allowedActions,
15586 in wstring[] formats,
15587 [retval] out DragAndDropAction resultAction
15588 );
15589
15619 void dragHGMove (
15620 in unsigned long screenId,
15621 in unsigned long x,
15622 in unsigned long y,
15623 in DragAndDropAction defaultAction,
15624 in DragAndDropAction[] allowedActions,
15625 in wstring[] formats,
15626 [retval] out DragAndDropAction resultAction
15627 );
15628
15646 void dragHGLeave (
15647 in unsigned long screenId
15648 );
15649
15681 void dragHGDrop (
15682 in unsigned long screenId,
15683 in unsigned long x,
15684 in unsigned long y,
15685 in DragAndDropAction defaultAction,
15686 in DragAndDropAction[] allowedActions,
15687 in wstring[] formats,
15688 out wstring format,
15689 [retval] out DragAndDropAction resultAction
15690 );
15691
15715 void dragHGPutData (
15716 in unsigned long screenId,
15717 in wstring format,
15718 in octet[] data,
15719 [retval] out IProgress progress
15720 );
15721
15747 void dragGHPending (
15748 in unsigned long screenId,
15749 out wstring[] formats,
15750 out DragAndDropAction[] allowedActions,
15751 [retval] out DragAndDropAction defaultAction
15752 );
15753
15775 void dragGHDropped (
15776 in wstring format,
15777 in DragAndDropAction action,
15778 [retval] out IProgress progress
15779 );
15780
15798 void dragGHGetData (
15799 [retval] out octet[] data
15800 );
15801
15860 void createSession (
15861 in wstring user,
15862 in wstring password,
15863 in wstring domain,
15864 in wstring sessionName,
15865 [retval] out IGuestSession guestSession
15866 );
15867
15882 void findSession (
15883 in wstring sessionName,
15884 [retval] out IGuestSession[] sessions
15885 );
15886
15936 void updateGuestAdditions (
15937 in wstring source,
15938 in wstring[] arguments,
15939 in AdditionsUpdateFlag[] flags,
15940 [retval] out IProgress progress
15941 );
15942
15943 };
15944
15985 interface IProgress : $unknown
15986 {
15990 readonly attribute wstringUUID id;
15991
15995 readonly attribute wstring description;
15996
16000 readonly attribute $unknown initiator;
16001
16005 readonly attribute boolean cancelable;
16006
16014 readonly attribute unsigned long percent;
16015
16029 readonly attribute long timeRemaining;
16030
16034 readonly attribute boolean completed;
16035
16039 readonly attribute boolean canceled;
16040
16047 readonly attribute long resultCode;
16048
16058 readonly attribute IVirtualBoxErrorInfo errorInfo;
16059
16066 readonly attribute unsigned long operationCount;
16067
16071 readonly attribute unsigned long operation;
16072
16078 readonly attribute wstring operationDescription;
16079
16083 readonly attribute unsigned long operationPercent;
16084
16088 readonly attribute unsigned long operationWeight;
16089
16097 attribute unsigned long timeout;
16098
16102 void setCurrentOperationProgress (
16103 in unsigned long percent
16104 );
16105
16109 void setNextOperation (
16110 in wstring nextOperationDescription,
16111 in unsigned long nextOperationsWeight
16112 );
16113
16140 void waitForCompletion (
16141 in long timeout
16142 );
16143
16167 void waitForOperationCompletion (
16168 in unsigned long operation,
16169 in long timeout
16170 );
16171
16197 void waitForAsyncProgressCompletion (
16198 in IProgress pProgressAsync
16199 );
16200
16217 void cancel();
16218
16219 };
16220
16304 interface ISnapshot : $unknown
16305 {
16309 readonly attribute wstringUUID id;
16310
16318 attribute wstring name;
16319
16327 attribute wstring description;
16328
16334 readonly attribute long long timeStamp;
16335
16347 readonly attribute boolean online;
16348
16360 readonly attribute IMachine machine;
16361
16368 readonly attribute ISnapshot parent;
16369
16378 readonly attribute ISnapshot[] children;
16379
16387 void getChildrenCount (
16388 [retval] out unsigned long childrenCount
16389 );
16390
16391 };
16392
16579 interface IMediumAttachment : $unknown
16580 {
16585 readonly attribute IMedium medium;
16586
16592 readonly attribute wstring controller;
16593
16599 readonly attribute long port;
16600
16606 readonly attribute long device;
16607
16611 readonly attribute DeviceType type;
16612
16616 readonly attribute boolean passthrough;
16617
16621 readonly attribute boolean temporaryEject;
16622
16627 readonly attribute boolean isEjected;
16628
16632 readonly attribute boolean nonRotational;
16633
16637 readonly attribute boolean discard;
16638
16642 readonly attribute boolean hotPluggable;
16643
16647 readonly attribute IBandwidthGroup bandwidthGroup;
16648
16649 };
16650
16808 interface IMedium : $unknown
16809 {
16823 readonly attribute wstringUUID id;
16824
16843 attribute wstring description;
16844
16860 readonly attribute MediumState state;
16861
16870 readonly attribute MediumVariant[] variant;
16871
16881 readonly attribute wstring location;
16882
16902 readonly attribute wstring name;
16903
16908 readonly attribute DeviceType deviceType;
16909
16913 readonly attribute boolean hostDrive;
16914
16927 readonly attribute long long size;
16928
16943 readonly attribute wstring format;
16944
16960 readonly attribute IMediumFormat mediumFormat;
16961
16986 attribute MediumType type;
16987
17001 readonly attribute MediumType[] allowedTypes;
17002
17012 readonly attribute IMedium parent;
17013
17021 readonly attribute IMedium[] children;
17022
17033 readonly attribute IMedium base;
17034
17067 readonly attribute boolean readOnly;
17068
17084 readonly attribute long long logicalSize;
17085
17113 attribute boolean autoReset;
17114
17129 readonly attribute wstring lastAccessError;
17130
17147 readonly attribute wstringUUID[] machineIds;
17148
17174 void setIds (
17175 in boolean setImageId,
17176 in wstringUUID imageId,
17177 in boolean setParentId,
17178 in wstringUUID parentId
17179 );
17180
17215 void refreshState (
17216 [retval] out MediumState state
17217 );
17218
17245 void getSnapshotIds (
17246 in wstringUUID machineId,
17247 [retval] out wstringUUID[] snapshotIds
17248 );
17249
17312 void lockRead (
17313 [retval] out IToken token
17314 );
17315
17370 void lockWrite (
17371 [retval] out IToken token
17372 );
17373
17423 void close();
17424
17454 void getProperty (
17455 in wstring name,
17456 [retval] out wstring value
17457 );
17458
17490 void setProperty (
17491 in wstring name,
17492 in wstring value
17493 );
17494
17529 void getProperties (
17530 in wstring names,
17531 out wstring[] returnNames,
17532 [retval] out wstring[] returnValues
17533 );
17534
17564 void setProperties (
17565 in wstring[] names,
17566 in wstring[] values
17567 );
17568
17601 void createBaseStorage (
17602 in long long logicalSize,
17603 in MediumVariant[] variant,
17604 [retval] out IProgress progress
17605 );
17606
17658 void deleteStorage (
17659 [retval] out IProgress progress
17660 );
17661
17700 void createDiffStorage (
17701 in IMedium target,
17702 in MediumVariant[] variant,
17703 [retval] out IProgress progress
17704 );
17705
17781 void mergeTo (
17782 in IMedium target,
17783 [retval] out IProgress progress
17784 );
17785
17835 void cloneTo (
17836 in IMedium target,
17837 in MediumVariant[] variant,
17838 in IMedium parent,
17839 [retval] out IProgress progress
17840 );
17841
17888 void cloneToBase (
17889 in IMedium target,
17890 in MediumVariant[] variant,
17891 [retval] out IProgress progress
17892 );
17893
17935 void setLocation (
17936 in wstring location,
17937 [retval] out IProgress progress
17938 );
17939
17968 void compact (
17969 [retval] out IProgress progress
17970 );
17971
18004 void resize (
18005 in long long logicalSize,
18006 [retval] out IProgress progress
18007 );
18008
18042 void reset (
18043 [retval] out IProgress progress
18044 );
18045
18046 };
18047
18070 interface IMediumFormat : $unknown
18071 {
18090 readonly attribute wstring id;
18091
18099 readonly attribute wstring name;
18100
18109 readonly attribute MediumFormatCapabilities[] capabilities;
18110
18129 void describeFileExtensions (
18130 out wstring[] extensions,
18131 out DeviceType[] types
18132 );
18133
18161 void describeProperties (
18162 out wstring[] names,
18163 out wstring[] descriptions,
18164 out DataType[] types,
18165 out unsigned long[] flags,
18166 out wstring[] defaults
18167 );
18168
18169 };
18170
18185 interface IToken : $unknown
18186 {
18195 void abandon();
18196
18203 void dummy();
18204
18205 };
18206
18218 interface IKeyboard : $unknown
18219 {
18225 readonly attribute IEventSource eventSource;
18226
18239 void putScancode (
18240 in long scancode
18241 );
18242
18255 void putScancodes (
18256 in long[] scancodes,
18257 [retval] out unsigned long codesStored
18258 );
18259
18274 void putCAD();
18275
18276 };
18277
18289 interface IMouse : $unknown
18290 {
18305 readonly attribute boolean absoluteSupported;
18306
18321 readonly attribute boolean relativeSupported;
18322
18336 readonly attribute boolean multiTouchSupported;
18337
18352 readonly attribute boolean needsHostCursor;
18353
18359 readonly attribute IEventSource eventSource;
18360
18426 void putMouseEvent (
18427 in long dx,
18428 in long dy,
18429 in long dz,
18430 in long dw,
18431 in long buttonState
18432 );
18433
18506 void putMouseEventAbsolute (
18507 in long x,
18508 in long y,
18509 in long dz,
18510 in long dw,
18511 in long buttonState
18512 );
18513
18561 void putEventMultiTouch (
18562 in long count,
18563 in long long[] contacts,
18564 in unsigned long scanTime
18565 );
18566
18582 void putEventMultiTouchString (
18583 in long count,
18584 in wstring contacts,
18585 in unsigned long scanTime
18586 );
18587
18588 };
18589
18590 interface IFramebuffer : $unknown
18591 {
18600 readonly attribute octetPtr address;
18601
18605 readonly attribute unsigned long width;
18606
18610 readonly attribute unsigned long height;
18611
18618 readonly attribute unsigned long bitsPerPixel;
18619
18626 readonly attribute unsigned long bytesPerLine;
18627
18638 readonly attribute unsigned long pixelFormat;
18639
18646 readonly attribute boolean usesGuestVRAM;
18647
18657 readonly attribute unsigned long heightReduction;
18658
18673 readonly attribute IFramebufferOverlay overlay;
18674
18681 readonly attribute long long winId;
18682
18690 void lock();
18691
18699 void unlock();
18700
18708 void notifyUpdate (
18709 in unsigned long x,
18710 in unsigned long y,
18711 in unsigned long width,
18712 in unsigned long height
18713 );
18714
18827 void requestResize (
18828 in unsigned long screenId,
18829 in unsigned long pixelFormat,
18830 in octetPtr VRAM,
18831 in unsigned long bitsPerPixel,
18832 in unsigned long bytesPerLine,
18833 in unsigned long width,
18834 in unsigned long height,
18835 [retval] out boolean finished
18836 );
18837
18849 void videoModeSupported (
18850 in unsigned long width,
18851 in unsigned long height,
18852 in unsigned long bpp,
18853 [retval] out boolean supported
18854 );
18855
18892 void getVisibleRegion (
18893 in octetPtr rectangles,
18894 in unsigned long count,
18895 [retval] out unsigned long countCopied
18896 );
18897
18932 void setVisibleRegion (
18933 in octetPtr rectangles,
18934 in unsigned long count
18935 );
18936
18957 void processVHWACommand (
18958 in octetPtr command
18959 );
18960
18975 void notify3DEvent (
18976 in unsigned long type,
18977 in octetPtr data
18978 );
18979
18980 };
18981
18996 interface IFramebufferOverlay : IFramebuffer
18997 {
19001 readonly attribute unsigned long x;
19002
19006 readonly attribute unsigned long y;
19007
19013 attribute boolean visible;
19014
19021 attribute unsigned long alpha;
19022
19028 void move (
19029 in unsigned long x,
19030 in unsigned long y
19031 );
19032
19033 };
19034
19050 interface IDisplay : $unknown
19051 {
19055 void getScreenResolution (
19056 in unsigned long screenId,
19057 out unsigned long width,
19058 out unsigned long height,
19059 out unsigned long bitsPerPixel,
19060 out long xOrigin,
19061 out long yOrigin
19062 );
19063
19069 void setFramebuffer (
19070 in unsigned long screenId,
19071 in IFramebuffer framebuffer
19072 );
19073
19079 void getFramebuffer (
19080 in unsigned long screenId,
19081 out IFramebuffer framebuffer,
19082 out long xOrigin,
19083 out long yOrigin
19084 );
19085
19136 void setVideoModeHint (
19137 in unsigned long display,
19138 in boolean enabled,
19139 in boolean changeOrigin,
19140 in long originX,
19141 in long originY,
19142 in unsigned long width,
19143 in unsigned long height,
19144 in unsigned long bitsPerPixel
19145 );
19146
19158 void setSeamlessMode (
19159 in boolean enabled
19160 );
19161
19197 void takeScreenShot (
19198 in unsigned long screenId,
19199 in octetPtr address,
19200 in unsigned long width,
19201 in unsigned long height
19202 );
19203
19247 void takeScreenShotToArray (
19248 in unsigned long screenId,
19249 in unsigned long width,
19250 in unsigned long height,
19251 [retval] out octet[] screenData
19252 );
19253
19292 void takeScreenShotPNGToArray (
19293 in unsigned long screenId,
19294 in unsigned long width,
19295 in unsigned long height,
19296 [retval] out octet[] screenData
19297 );
19298
19350 void drawToScreen (
19351 in unsigned long screenId,
19352 in octetPtr address,
19353 in unsigned long x,
19354 in unsigned long y,
19355 in unsigned long width,
19356 in unsigned long height
19357 );
19358
19373 void invalidateAndUpdate();
19374
19388 void resizeCompleted (
19389 in unsigned long screenId
19390 );
19391
19404 void completeVHWACommand (
19405 in octetPtr command
19406 );
19407
19441 void viewportChanged (
19442 in unsigned long screenId,
19443 in unsigned long x,
19444 in unsigned long y,
19445 in unsigned long width,
19446 in unsigned long height
19447 );
19448
19449 };
19450
19466 interface INetworkAdapter : $unknown
19467 {
19475 attribute NetworkAdapterType adapterType;
19476
19484 readonly attribute unsigned long slot;
19485
19494 attribute boolean enabled;
19495
19502 attribute wstring MACAddress;
19503
19509 attribute NetworkAttachmentType attachmentType;
19510
19516 attribute wstring bridgedInterface;
19517
19523 attribute wstring hostOnlyInterface;
19524
19530 attribute wstring internalNetwork;
19531
19537 attribute wstring NATNetwork;
19538
19544 attribute wstring genericDriver;
19545
19552 attribute boolean cableConnected;
19553
19559 attribute unsigned long lineSpeed;
19560
19567 attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
19568
19575 attribute boolean traceEnabled;
19576
19583 attribute wstring traceFile;
19584
19592 readonly attribute INATEngine NATEngine;
19593
19600 attribute unsigned long bootPriority;
19601
19605 attribute IBandwidthGroup bandwidthGroup;
19606
19625 void getProperty (
19626 in wstring key,
19627 [retval] out wstring value
19628 );
19629
19648 void setProperty (
19649 in wstring key,
19650 in wstring value
19651 );
19652
19680 void getProperties (
19681 in wstring names,
19682 out wstring[] returnNames,
19683 [retval] out wstring[] returnValues
19684 );
19685
19686 };
19687
19716 interface ISerialPort : $unknown
19717 {
19725 readonly attribute unsigned long slot;
19726
19733 attribute boolean enabled;
19734
19738 attribute unsigned long IOBase;
19739
19743 attribute unsigned long IRQ;
19744
19755 attribute PortMode hostMode;
19756
19764 attribute boolean server;
19765
19775 attribute wstring path;
19776
19777 };
19778
19798 interface IParallelPort : $unknown
19799 {
19807 readonly attribute unsigned long slot;
19808
19815 attribute boolean enabled;
19816
19820 attribute unsigned long IOBase;
19821
19825 attribute unsigned long IRQ;
19826
19834 attribute wstring path;
19835
19836 };
19837
19838 interface IMachineDebugger : $unknown
19839 {
19843 attribute boolean singleStep;
19844
19848 attribute boolean recompileUser;
19849
19853 attribute boolean recompileSupervisor;
19854
19862 attribute boolean executeAllInIEM;
19863
19867 attribute boolean PATMEnabled;
19868
19872 attribute boolean CSAMEnabled;
19873
19877 attribute boolean logEnabled;
19878
19882 readonly attribute wstring logDbgFlags;
19883
19887 readonly attribute wstring logDbgGroups;
19888
19892 readonly attribute wstring logDbgDestinations;
19893
19897 readonly attribute wstring logRelFlags;
19898
19902 readonly attribute wstring logRelGroups;
19903
19907 readonly attribute wstring logRelDestinations;
19908
19915 readonly attribute boolean HWVirtExEnabled;
19916
19923 readonly attribute boolean HWVirtExNestedPagingEnabled;
19924
19931 readonly attribute boolean HWVirtExVPIDEnabled;
19932
19939 readonly attribute boolean HWVirtExUXEnabled;
19940
19949 readonly attribute wstring OSName;
19950
19959 readonly attribute wstring OSVersion;
19960
19967 readonly attribute boolean PAEEnabled;
19968
19975 attribute unsigned long virtualTimeRate;
19976
19984 readonly attribute long long VM;
19985
20001 void dumpGuestCore (
20002 in wstring filename,
20003 in wstring compression
20004 );
20005
20022 void dumpHostProcessCore (
20023 in wstring filename,
20024 in wstring compression
20025 );
20026
20047 void info (
20048 in wstring name,
20049 in wstring args,
20050 [retval] out wstring info
20051 );
20052
20058 void injectNMI();
20059
20070 void modifyLogGroups (
20071 in wstring settings
20072 );
20073
20084 void modifyLogFlags (
20085 in wstring settings
20086 );
20087
20098 void modifyLogDestinations (
20099 in wstring settings
20100 );
20101
20116 void readPhysicalMemory (
20117 in long long address,
20118 in unsigned long size,
20119 [retval] out octet[] bytes
20120 );
20121
20136 void writePhysicalMemory (
20137 in long long address,
20138 in unsigned long size,
20139 in octet[] bytes
20140 );
20141
20158 void readVirtualMemory (
20159 in unsigned long cpuId,
20160 in long long address,
20161 in unsigned long size,
20162 [retval] out octet[] bytes
20163 );
20164
20181 void writeVirtualMemory (
20182 in unsigned long cpuId,
20183 in long long address,
20184 in unsigned long size,
20185 in octet[] bytes
20186 );
20187
20200 void detectOS (
20201 [retval] out wstring os
20202 );
20203
20221 void getRegister (
20222 in unsigned long cpuId,
20223 in wstring name,
20224 [retval] out wstring value
20225 );
20226
20244 void getRegisters (
20245 in unsigned long cpuId,
20246 out wstring[] names,
20247 out wstring[] values
20248 );
20249
20268 void setRegister (
20269 in unsigned long cpuId,
20270 in wstring name,
20271 in wstring value
20272 );
20273
20292 void setRegisters (
20293 in unsigned long cpuId,
20294 in wstring[] names,
20295 in wstring[] values
20296 );
20297
20310 void dumpGuestStack (
20311 in unsigned long cpuId,
20312 [retval] out wstring stack
20313 );
20314
20322 void resetStats (
20323 in wstring pattern
20324 );
20325
20333 void dumpStats (
20334 in wstring pattern
20335 );
20336
20348 void getStats (
20349 in wstring pattern,
20350 in boolean withDescriptions,
20351 [retval] out wstring stats
20352 );
20353
20354 };
20355
20356 interface IUSBDeviceFilters : $unknown
20357 {
20383 readonly attribute IUSBDeviceFilter[] deviceFilters;
20384
20412 void createDeviceFilter (
20413 in wstring name,
20414 [retval] out IUSBDeviceFilter filter
20415 );
20416
20461 void insertDeviceFilter (
20462 in unsigned long position,
20463 in IUSBDeviceFilter filter
20464 );
20465
20498 void removeDeviceFilter (
20499 in unsigned long position,
20500 [retval] out IUSBDeviceFilter filter
20501 );
20502
20503 };
20504
20505 interface IUSBController : $unknown
20506 {
20512 readonly attribute wstring name;
20513
20519 readonly attribute USBControllerType type;
20520
20528 readonly attribute unsigned short USBStandard;
20529
20530 };
20531
20544 interface IUSBDevice : $unknown
20545 {
20552 readonly attribute wstringUUID id;
20553
20557 readonly attribute unsigned short vendorId;
20558
20562 readonly attribute unsigned short productId;
20563
20571 readonly attribute unsigned short revision;
20572
20576 readonly attribute wstring manufacturer;
20577
20581 readonly attribute wstring product;
20582
20586 readonly attribute wstring serialNumber;
20587
20591 readonly attribute wstring address;
20592
20599 readonly attribute unsigned short port;
20600
20606 readonly attribute unsigned short version;
20607
20615 readonly attribute unsigned short portVersion;
20616
20623 readonly attribute boolean remote;
20624
20625 };
20626
20701 interface IUSBDeviceFilter : $unknown
20702 {
20710 attribute wstring name;
20711
20715 attribute boolean active;
20716
20724 attribute wstring vendorId;
20725
20733 attribute wstring productId;
20734
20748 attribute wstring revision;
20749
20754 attribute wstring manufacturer;
20755
20760 attribute wstring product;
20761
20766 attribute wstring serialNumber;
20767
20772 attribute wstring port;
20773
20783 attribute wstring remote;
20784
20794 attribute unsigned long maskedInterfaces;
20795
20796 };
20797
20814 interface IHostUSBDevice : IUSBDevice
20815 {
20821 readonly attribute USBDeviceState state;
20822
20823 };
20824
20847 interface IHostUSBDeviceFilter : IUSBDeviceFilter
20848 {
20855 attribute USBDeviceFilterAction action;
20856
20857 };
20858
20867 interface IAudioAdapter : $unknown
20868 {
20877 attribute boolean enabled;
20878
20884 attribute AudioControllerType audioController;
20885
20892 attribute AudioDriverType audioDriver;
20893
20894 };
20895
20896 interface IVRDEServer : $unknown
20897 {
20901 attribute boolean enabled;
20902
20906 attribute AuthType authType;
20907
20911 attribute unsigned long authTimeout;
20912
20919 attribute boolean allowMultiConnection;
20920
20928 attribute boolean reuseSingleConnection;
20929
20936 attribute wstring VRDEExtPack;
20937
20944 attribute wstring authLibrary;
20945
20951 readonly attribute wstring[] VRDEProperties;
20952
20966 void setVRDEProperty (
20967 in wstring key,
20968 in wstring value
20969 );
20970
20984 void getVRDEProperty (
20985 in wstring key,
20986 [retval] out wstring value
20987 );
20988
20989 };
20990
21048 interface ISharedFolder : $unknown
21049 {
21053 readonly attribute wstring name;
21054
21058 readonly attribute wstring hostPath;
21059
21069 readonly attribute boolean accessible;
21070
21077 readonly attribute boolean writable;
21078
21084 readonly attribute boolean autoMount;
21085
21098 readonly attribute wstring lastAccessError;
21099
21100 };
21101
21102 interface IInternalSessionControl : $unknown
21103 {
21108 void getPID (
21109 [retval] out unsigned long pid
21110 );
21111
21133 void getRemoteConsole (
21134 [retval] out IConsole console
21135 );
21136
21151 void assignRemoteMachine (
21152 in IMachine machine,
21153 in IConsole console
21154 );
21155
21179 void updateMachineState (
21180 in MachineState machineState
21181 );
21182
21198 void uninitialize();
21199
21222 void onNetworkAdapterChange (
21223 in INetworkAdapter networkAdapter,
21224 in boolean changeAdapter
21225 );
21226
21249 void onSerialPortChange (
21250 in ISerialPort serialPort
21251 );
21252
21275 void onParallelPortChange (
21276 in IParallelPort parallelPort
21277 );
21278
21301 void onStorageControllerChange();
21302
21329 void onMediumChange (
21330 in IMediumAttachment mediumAttachment,
21331 in boolean force
21332 );
21333
21363 void onStorageDeviceChange (
21364 in IMediumAttachment mediumAttachment,
21365 in boolean remove,
21366 in boolean silent
21367 );
21368
21376 void onClipboardModeChange (
21377 in ClipboardMode clipboardMode
21378 );
21379
21387 void onDragAndDropModeChange (
21388 in DragAndDropMode dragAndDropMode
21389 );
21390
21400 void onCPUChange (
21401 in unsigned long cpu,
21402 in boolean add
21403 );
21404
21412 void onCPUExecutionCapChange (
21413 in unsigned long executionCap
21414 );
21415
21440 void onVRDEServerChange (
21441 in boolean restart
21442 );
21443
21449 void onVideoCaptureChange();
21450
21473 void onUSBControllerChange();
21474
21503 void onSharedFolderChange (
21504 in boolean global
21505 );
21506
21532 void onUSBDeviceAttach (
21533 in IUSBDevice device,
21534 in IVirtualBoxErrorInfo error,
21535 in unsigned long maskedInterfaces
21536 );
21537
21563 void onUSBDeviceDetach (
21564 in wstringUUID id,
21565 in IVirtualBoxErrorInfo error
21566 );
21567
21585 void onShowWindow (
21586 in boolean check,
21587 out boolean canShow,
21588 out long long winId
21589 );
21590
21598 void onBandwidthGroupChange (
21599 in IBandwidthGroup bandwidthGroup
21600 );
21601
21625 void accessGuestProperty (
21626 in wstring name,
21627 in wstring value,
21628 in wstring flags,
21629 in boolean isSetter,
21630 out wstring retValue,
21631 out long long retTimestamp,
21632 out wstring retFlags
21633 );
21634
21682 void enumerateGuestProperties (
21683 in wstring patterns,
21684 out wstring[] keys,
21685 out wstring[] values,
21686 out long long[] timestamps,
21687 out wstring[] flags
21688 );
21689
21724 void onlineMergeMedium (
21725 in IMediumAttachment mediumAttachment,
21726 in unsigned long sourceIdx,
21727 in unsigned long targetIdx,
21728 in IProgress progress
21729 );
21730
21754 void enableVMMStatistics (
21755 in boolean enable
21756 );
21757
21785 void pauseWithReason (
21786 in Reason reason
21787 );
21788
21816 void resumeWithReason (
21817 in Reason reason
21818 );
21819
21849 void saveStateWithReason (
21850 in Reason reason,
21851 [retval] out IProgress progress
21852 );
21853
21877 void assignMachine (
21878 in IMachine machine,
21879 in LockType lockType,
21880 in wstring tokenId
21881 );
21882
21906 void assignMachine (
21907 in IMachine machine,
21908 in LockType lockType,
21909 in IToken token
21910 );
21911
21912 };
21913
21972 interface ISession : $unknown
21973 {
21977 readonly attribute SessionState state;
21978
21986 readonly attribute SessionType type;
21987
21991 readonly attribute IMachine machine;
21992
21996 readonly attribute IConsole console;
21997
22029 void unlockMachine();
22030
22031 };
22032
22055 interface IStorageController : $unknown
22056 {
22065 readonly attribute wstring name;
22066
22072 readonly attribute unsigned long maxDevicesPerPortCount;
22073
22079 readonly attribute unsigned long minPortCount;
22080
22086 readonly attribute unsigned long maxPortCount;
22087
22093 attribute unsigned long instance;
22094
22103 attribute unsigned long portCount;
22104
22110 readonly attribute StorageBus bus;
22111
22124 attribute StorageControllerType controllerType;
22125
22140 attribute boolean useHostIOCache;
22141
22147 readonly attribute boolean bootable;
22148
22149 };
22150
22174 interface IManagedObjectRef : $unknown
22175 {
22182 void getInterfaceName (
22183 [retval] out wstring return
22184 );
22185
22193 void release();
22194
22195 };
22196
22205 interface IWebsessionManager : $unknown
22206 {
22215 void logon (
22216 in wstring username,
22217 in wstring password,
22218 [retval] out IVirtualBox return
22219 );
22220
22230 void getSessionObject (
22231 in IVirtualBox refIVirtualBox,
22232 [retval] out ISession return
22233 );
22234
22242 void logoff (
22243 in IVirtualBox refIVirtualBox
22244 );
22245
22246 };
22247
22256 interface IPerformanceMetric : $unknown
22257 {
22263 readonly attribute wstring metricName;
22264
22270 readonly attribute $unknown object;
22271
22277 readonly attribute wstring description;
22278
22284 readonly attribute unsigned long period;
22285
22295 readonly attribute unsigned long count;
22296
22302 readonly attribute wstring unit;
22303
22309 readonly attribute long minimumValue;
22310
22316 readonly attribute long maximumValue;
22317
22318 };
22319
22426 interface IPerformanceCollector : $unknown
22427 {
22438 readonly attribute wstring[] metricNames;
22439
22463 void getMetrics (
22464 in wstring[] metricNames,
22465 in $unknown[] objects,
22466 [retval] out IPerformanceMetric[] metrics
22467 );
22468
22507 void setupMetrics (
22508 in wstring[] metricNames,
22509 in $unknown[] objects,
22510 in unsigned long period,
22511 in unsigned long count,
22512 [retval] out IPerformanceMetric[] affectedMetrics
22513 );
22514
22543 void enableMetrics (
22544 in wstring[] metricNames,
22545 in $unknown[] objects,
22546 [retval] out IPerformanceMetric[] affectedMetrics
22547 );
22548
22577 void disableMetrics (
22578 in wstring[] metricNames,
22579 in $unknown[] objects,
22580 [retval] out IPerformanceMetric[] affectedMetrics
22581 );
22582
22672 void queryMetricsData (
22673 in wstring[] metricNames,
22674 in $unknown[] objects,
22675 out wstring[] returnMetricNames,
22676 out $unknown[] returnObjects,
22677 out wstring[] returnUnits,
22678 out unsigned long[] returnScales,
22679 out unsigned long[] returnSequenceNumbers,
22680 out unsigned long[] returnDataIndices,
22681 out unsigned long[] returnDataLengths,
22682 [retval] out long[] returnData
22683 );
22684
22685 };
22686
22694 interface INATEngine : $unknown
22695 {
22700 attribute wstring network;
22701
22708 attribute wstring hostIP;
22709
22714 attribute wstring TFTPPrefix;
22715
22720 attribute wstring TFTPBootFile;
22721
22729 attribute wstring TFTPNextServer;
22730
22734 attribute unsigned long aliasMode;
22735
22739 attribute boolean DNSPassDomain;
22740
22745 attribute boolean DNSProxy;
22746
22751 attribute boolean DNSUseHostResolver;
22752
22757 readonly attribute wstring[] redirects;
22758
22774 void setNetworkSettings (
22775 in unsigned long mtu,
22776 in unsigned long sockSnd,
22777 in unsigned long sockRcv,
22778 in unsigned long TcpWndSnd,
22779 in unsigned long TcpWndRcv
22780 );
22781
22786 void getNetworkSettings (
22787 out unsigned long mtu,
22788 out unsigned long sockSnd,
22789 out unsigned long sockRcv,
22790 out unsigned long TcpWndSnd,
22791 out unsigned long TcpWndRcv
22792 );
22793
22813 void addRedirect (
22814 in wstring name,
22815 in NATProtocol proto,
22816 in wstring hostIP,
22817 in unsigned short hostPort,
22818 in wstring guestIP,
22819 in unsigned short guestPort
22820 );
22821
22827 void removeRedirect (
22828 in wstring name
22829 );
22830
22831 };
22832
22841 interface IExtPackPlugIn : $unknown
22842 {
22846 readonly attribute wstring name;
22847
22851 readonly attribute wstring description;
22852
22858 readonly attribute wstring frontend;
22859
22863 readonly attribute wstring modulePath;
22864
22865 };
22866
22875 interface IExtPackBase : $unknown
22876 {
22880 readonly attribute wstring name;
22881
22885 readonly attribute wstring description;
22886
22898 readonly attribute wstring version;
22899
22903 readonly attribute unsigned long revision;
22904
22914 readonly attribute wstring edition;
22915
22919 readonly attribute wstring VRDEModule;
22920
22924 readonly attribute IExtPackPlugIn[] plugIns;
22925
22935 readonly attribute boolean usable;
22936
22943 readonly attribute wstring whyUnusable;
22944
22948 readonly attribute boolean showLicense;
22949
22958 readonly attribute wstring license;
22959
22983 void queryLicense (
22984 in wstring preferredLocale,
22985 in wstring preferredLanguage,
22986 in wstring format,
22987 [retval] out wstring licenseText
22988 );
22989
22990 };
22991
23000 interface IExtPack : IExtPackBase
23001 {
23013 void queryObject (
23014 in wstring objUuid,
23015 [retval] out $unknown returnInterface
23016 );
23017
23018 };
23019
23029 interface IExtPackFile : IExtPackBase
23030 {
23036 readonly attribute wstring filePath;
23037
23056 void install (
23057 in boolean replace,
23058 in wstring displayInfo,
23059 [retval] out IProgress progess
23060 );
23061
23062 };
23063
23074 interface IExtPackManager : $unknown
23075 {
23081 readonly attribute IExtPack[] installedExtPacks;
23082
23100 void find (
23101 in wstring name,
23102 [retval] out IExtPack returnData
23103 );
23104
23116 void openExtPackFile (
23117 in wstring path,
23118 [retval] out IExtPackFile file
23119 );
23120
23139 void uninstall (
23140 in wstring name,
23141 in boolean forcedRemoval,
23142 in wstring displayInfo,
23143 [retval] out IProgress progess
23144 );
23145
23149 void cleanup();
23150
23163 void queryAllPlugInsForFrontend (
23164 in wstring frontendName,
23165 [retval] out wstring[] plugInModules
23166 );
23167
23175 void isExtPackUsable (
23176 in wstring name,
23177 [retval] out boolean usable
23178 );
23179
23180 };
23181
23187 interface IBandwidthGroup : $unknown
23188 {
23192 readonly attribute wstring name;
23193
23197 readonly attribute BandwidthGroupType type;
23198
23202 readonly attribute unsigned long reference;
23203
23208 attribute long long maxBytesPerSec;
23209
23210 };
23211
23220 interface IBandwidthControl : $unknown
23221 {
23227 readonly attribute unsigned long numGroups;
23228
23241 void createBandwidthGroup (
23242 in wstring name,
23243 in BandwidthGroupType type,
23244 in long long maxBytesPerSec
23245 );
23246
23254 void deleteBandwidthGroup (
23255 in wstring name
23256 );
23257
23267 void getBandwidthGroup (
23268 in wstring name,
23269 [retval] out IBandwidthGroup bandwidthGroup
23270 );
23271
23279 void getAllBandwidthGroups (
23280 [retval] out IBandwidthGroup[] bandwidthGroups
23281 );
23282
23283 };
23284
23297 interface IVirtualBoxClient : $unknown
23298 {
23304 readonly attribute IVirtualBox virtualBox;
23305
23311 readonly attribute ISession session;
23312
23318 readonly attribute IEventSource eventSource;
23319
23330 void checkMachineError (
23331 in IMachine machine
23332 );
23333
23334 };
23335
23349 interface IEventSource : $unknown
23350 {
23356 void createListener (
23357 [retval] out IEventListener listener
23358 );
23359
23375 void createAggregator (
23376 in IEventSource[] subordinates,
23377 [retval] out IEventSource result
23378 );
23379
23412 void registerListener (
23413 in IEventListener listener,
23414 in VBoxEventType[] interesting,
23415 in boolean active
23416 );
23417
23426 void unregisterListener (
23427 in IEventListener listener
23428 );
23429
23444 void fireEvent (
23445 in IEvent event,
23446 in long timeout,
23447 [retval] out boolean result
23448 );
23449
23474 void getEvent (
23475 in IEventListener listener,
23476 in long timeout,
23477 [retval] out IEvent event
23478 );
23479
23491 void eventProcessed (
23492 in IEventListener listener,
23493 in IEvent event
23494 );
23495
23496 };
23497
23507 interface IEventListener : $unknown
23508 {
23521 void handleEvent (
23522 in IEvent event
23523 );
23524
23525 };
23526
23603 interface IEvent : $unknown
23604 {
23610 readonly attribute VBoxEventType type;
23611
23617 readonly attribute IEventSource source;
23618
23629 readonly attribute boolean waitable;
23630
23637 void setProcessed();
23638
23652 void waitProcessed (
23653 in long timeout,
23654 [retval] out boolean result
23655 );
23656
23657 };
23658
23664 interface IReusableEvent : IEvent
23665 {
23669 readonly attribute unsigned long generation;
23670
23677 void reuse();
23678
23679 };
23680
23686 interface IMachineEvent : IEvent
23687 {
23691 readonly attribute wstringUUID machineId;
23692
23693 };
23694
23700 interface IMachineStateChangedEvent : IMachineEvent
23701 {
23705 readonly attribute MachineState state;
23706
23707 };
23708
23716 interface IMachineDataChangedEvent : IMachineEvent
23717 {
23724 readonly attribute boolean temporary;
23725
23726 };
23727
23736 interface IMediumRegisteredEvent : IEvent
23737 {
23741 readonly attribute wstringUUID mediumId;
23742
23746 readonly attribute DeviceType mediumType;
23747
23754 readonly attribute boolean registered;
23755
23756 };
23757
23766 interface IMachineRegisteredEvent : IMachineEvent
23767 {
23774 readonly attribute boolean registered;
23775
23776 };
23777
23787 interface ISessionStateChangedEvent : IMachineEvent
23788 {
23794 readonly attribute SessionState state;
23795
23796 };
23797
23805 interface IGuestPropertyChangedEvent : IMachineEvent
23806 {
23812 readonly attribute wstring name;
23813
23819 readonly attribute wstring value;
23820
23826 readonly attribute wstring flags;
23827
23828 };
23829
23835 interface ISnapshotEvent : IMachineEvent
23836 {
23840 readonly attribute wstringUUID snapshotId;
23841
23842 };
23843
23853 interface ISnapshotTakenEvent : ISnapshotEvent
23854 {
23855 };
23856
23873 interface ISnapshotDeletedEvent : ISnapshotEvent
23874 {
23875 };
23876
23886 interface ISnapshotChangedEvent : ISnapshotEvent
23887 {
23888 };
23889
23898 interface IMousePointerShapeChangedEvent : IEvent
23899 {
23905 readonly attribute boolean visible;
23906
23912 readonly attribute boolean alpha;
23913
23919 readonly attribute unsigned long xhot;
23920
23926 readonly attribute unsigned long yhot;
23927
23933 readonly attribute unsigned long width;
23934
23940 readonly attribute unsigned long height;
23941
23974 readonly attribute octet[] shape;
23975
23976 };
23977
23986 interface IMouseCapabilityChangedEvent : IEvent
23987 {
23993 readonly attribute boolean supportsAbsolute;
23994
24000 readonly attribute boolean supportsRelative;
24001
24007 readonly attribute boolean supportsMultiTouch;
24008
24014 readonly attribute boolean needsHostCursor;
24015
24016 };
24017
24026 interface IKeyboardLedsChangedEvent : IEvent
24027 {
24033 readonly attribute boolean numLock;
24034
24040 readonly attribute boolean capsLock;
24041
24047 readonly attribute boolean scrollLock;
24048
24049 };
24050
24059 interface IStateChangedEvent : IEvent
24060 {
24066 readonly attribute MachineState state;
24067
24068 };
24069
24079 interface IAdditionsStateChangedEvent : IEvent
24080 {
24081 };
24082
24093 interface INetworkAdapterChangedEvent : IEvent
24094 {
24100 readonly attribute INetworkAdapter networkAdapter;
24101
24102 };
24103
24114 interface ISerialPortChangedEvent : IEvent
24115 {
24121 readonly attribute ISerialPort serialPort;
24122
24123 };
24124
24135 interface IParallelPortChangedEvent : IEvent
24136 {
24142 readonly attribute IParallelPort parallelPort;
24143
24144 };
24145
24155 interface IStorageControllerChangedEvent : IEvent
24156 {
24157 };
24158
24168 interface IMediumChangedEvent : IEvent
24169 {
24175 readonly attribute IMediumAttachment mediumAttachment;
24176
24177 };
24178
24186 interface IClipboardModeChangedEvent : IEvent
24187 {
24193 readonly attribute ClipboardMode clipboardMode;
24194
24195 };
24196
24204 interface IDragAndDropModeChangedEvent : IEvent
24205 {
24211 readonly attribute DragAndDropMode dragAndDropMode;
24212
24213 };
24214
24222 interface ICPUChangedEvent : IEvent
24223 {
24229 readonly attribute unsigned long CPU;
24230
24236 readonly attribute boolean add;
24237
24238 };
24239
24247 interface ICPUExecutionCapChangedEvent : IEvent
24248 {
24254 readonly attribute unsigned long executionCap;
24255
24256 };
24257
24265 interface IGuestKeyboardEvent : IEvent
24266 {
24272 readonly attribute long[] scancodes;
24273
24274 };
24275
24283 interface IGuestMouseEvent : IReusableEvent
24284 {
24290 readonly attribute GuestMouseEventMode mode;
24291
24297 readonly attribute long x;
24298
24304 readonly attribute long y;
24305
24311 readonly attribute long z;
24312
24318 readonly attribute long w;
24319
24325 readonly attribute long buttons;
24326
24327 };
24328
24336 interface IGuestMultiTouchEvent : IEvent
24337 {
24343 readonly attribute long contactCount;
24344
24350 readonly attribute short[] xPositions;
24351
24357 readonly attribute short[] yPositions;
24358
24364 readonly attribute unsigned short[] contactIds;
24365
24373 readonly attribute unsigned short[] contactFlags;
24374
24380 readonly attribute unsigned long scanTime;
24381
24382 };
24383
24389 interface IGuestSessionEvent : IEvent
24390 {
24394 readonly attribute IGuestSession session;
24395
24396 };
24397
24405 interface IGuestSessionStateChangedEvent : IGuestSessionEvent
24406 {
24412 readonly attribute unsigned long id;
24413
24419 readonly attribute GuestSessionStatus status;
24420
24430 readonly attribute IVirtualBoxErrorInfo error;
24431
24432 };
24433
24441 interface IGuestSessionRegisteredEvent : IGuestSessionEvent
24442 {
24449 readonly attribute boolean registered;
24450
24451 };
24452
24458 interface IGuestProcessEvent : IGuestSessionEvent
24459 {
24465 readonly attribute IGuestProcess process;
24466
24472 readonly attribute unsigned long pid;
24473
24474 };
24475
24483 interface IGuestProcessRegisteredEvent : IGuestProcessEvent
24484 {
24491 readonly attribute boolean registered;
24492
24493 };
24494
24502 interface IGuestProcessStateChangedEvent : IGuestProcessEvent
24503 {
24509 readonly attribute ProcessStatus status;
24510
24520 readonly attribute IVirtualBoxErrorInfo error;
24521
24522 };
24523
24531 interface IGuestProcessIOEvent : IGuestProcessEvent
24532 {
24539 readonly attribute unsigned long handle;
24540
24546 readonly attribute unsigned long processed;
24547
24548 };
24549
24559 interface IGuestProcessInputNotifyEvent : IGuestProcessIOEvent
24560 {
24566 readonly attribute ProcessInputStatus status;
24567
24568 };
24569
24577 interface IGuestProcessOutputEvent : IGuestProcessIOEvent
24578 {
24584 readonly attribute octet[] data;
24585
24586 };
24587
24593 interface IGuestFileEvent : IGuestSessionEvent
24594 {
24600 readonly attribute IGuestFile file;
24601
24602 };
24603
24611 interface IGuestFileRegisteredEvent : IGuestFileEvent
24612 {
24619 readonly attribute boolean registered;
24620
24621 };
24622
24630 interface IGuestFileStateChangedEvent : IGuestFileEvent
24631 {
24637 readonly attribute FileStatus status;
24638
24648 readonly attribute IVirtualBoxErrorInfo error;
24649
24650 };
24651
24659 interface IGuestFileIOEvent : IGuestFileEvent
24660 {
24666 readonly attribute long long offset;
24667
24673 readonly attribute unsigned long processed;
24674
24675 };
24676
24684 interface IGuestFileOffsetChangedEvent : IGuestFileIOEvent
24685 {
24686 };
24687
24695 interface IGuestFileReadEvent : IGuestFileIOEvent
24696 {
24702 readonly attribute octet[] data;
24703
24704 };
24705
24713 interface IGuestFileWriteEvent : IGuestFileIOEvent
24714 {
24715 };
24716
24727 interface IVRDEServerChangedEvent : IEvent
24728 {
24729 };
24730
24740 interface IVRDEServerInfoChangedEvent : IEvent
24741 {
24742 };
24743
24751 interface IVideoCaptureChangedEvent : IEvent
24752 {
24753 };
24754
24765 interface IUSBControllerChangedEvent : IEvent
24766 {
24767 };
24768
24792 interface IUSBDeviceStateChangedEvent : IEvent
24793 {
24799 readonly attribute IUSBDevice device;
24800
24806 readonly attribute boolean attached;
24807
24813 readonly attribute IVirtualBoxErrorInfo error;
24814
24815 };
24816
24832 interface ISharedFolderChangedEvent : IEvent
24833 {
24839 readonly attribute Scope scope;
24840
24841 };
24842
24894 interface IRuntimeErrorEvent : IEvent
24895 {
24901 readonly attribute boolean fatal;
24902
24908 readonly attribute wstring id;
24909
24915 readonly attribute wstring message;
24916
24917 };
24918
24926 interface IEventSourceChangedEvent : IEvent
24927 {
24933 readonly attribute IEventListener listener;
24934
24940 readonly attribute boolean add;
24941
24942 };
24943
24952 interface IExtraDataChangedEvent : IEvent
24953 {
24960 readonly attribute wstringUUID machineId;
24961
24967 readonly attribute wstring key;
24968
24974 readonly attribute wstring value;
24975
24976 };
24977
24983 interface IVetoEvent : IEvent
24984 {
24994 void addVeto (
24995 in wstring reason
24996 );
24997
25007 void isVetoed (
25008 [retval] out boolean result
25009 );
25010
25020 void getVetos (
25021 [retval] out wstring[] result
25022 );
25023
25024 };
25025
25035 interface IExtraDataCanChangeEvent : IVetoEvent
25036 {
25043 readonly attribute wstringUUID machineId;
25044
25050 readonly attribute wstring key;
25051
25057 readonly attribute wstring value;
25058
25059 };
25060
25076 interface ICanShowWindowEvent : IVetoEvent
25077 {
25078 };
25079
25111 interface IShowWindowEvent : IEvent
25112 {
25121 attribute long long winId;
25122
25123 };
25124
25132 interface INATRedirectEvent : IMachineEvent
25133 {
25139 readonly attribute unsigned long slot;
25140
25146 readonly attribute boolean remove;
25147
25153 readonly attribute wstring name;
25154
25160 readonly attribute NATProtocol proto;
25161
25167 readonly attribute wstring hostIP;
25168
25174 readonly attribute long hostPort;
25175
25181 readonly attribute wstring guestIP;
25182
25188 readonly attribute long guestPort;
25189
25190 };
25191
25204 interface IHostPCIDevicePlugEvent : IMachineEvent
25205 {
25211 readonly attribute boolean plugged;
25212
25219 readonly attribute boolean success;
25220
25226 readonly attribute IPCIDeviceAttachment attachment;
25227
25233 readonly attribute wstring message;
25234
25235 };
25236
25245 interface IVBoxSVCAvailabilityChangedEvent : IEvent
25246 {
25252 readonly attribute boolean available;
25253
25254 };
25255
25263 interface IBandwidthGroupChangedEvent : IEvent
25264 {
25270 readonly attribute IBandwidthGroup bandwidthGroup;
25271
25272 };
25273
25281 interface IGuestMonitorChangedEvent : IEvent
25282 {
25288 readonly attribute GuestMonitorChangedEventType changeType;
25289
25295 readonly attribute unsigned long screenId;
25296
25303 readonly attribute unsigned long originX;
25304
25311 readonly attribute unsigned long originY;
25312
25319 readonly attribute unsigned long width;
25320
25327 readonly attribute unsigned long height;
25328
25329 };
25330
25338 interface IGuestUserStateChangedEvent : IEvent
25339 {
25345 readonly attribute wstring name;
25346
25353 readonly attribute wstring domain;
25354
25361 readonly attribute GuestUserState state;
25362
25368 readonly attribute wstring stateDetails;
25369
25370 };
25371
25381 interface IStorageDeviceChangedEvent : IEvent
25382 {
25388 readonly attribute IMediumAttachment storageDevice;
25389
25395 readonly attribute boolean removed;
25396
25402 readonly attribute boolean silent;
25403
25404 };
25405
25406 interface INATNetworkChangedEvent : IEvent
25407 {
25408 readonly attribute wstring networkName;
25409
25410 };
25411
25412 interface INATNetworkStartStopEvent : INATNetworkChangedEvent
25413 {
25419 readonly attribute boolean startEvent;
25420
25421 };
25422
25423 interface INATNetworkAlterEvent : INATNetworkChangedEvent
25424 {
25425 };
25426
25427 interface INATNetworkCreationDeletionEvent : INATNetworkAlterEvent
25428 {
25429 readonly attribute boolean creationEvent;
25430
25431 };
25432
25433 interface INATNetworkSettingEvent : INATNetworkAlterEvent
25434 {
25435 readonly attribute boolean enabled;
25436
25437 readonly attribute wstring network;
25438
25439 readonly attribute wstring gateway;
25440
25441 readonly attribute boolean advertiseDefaultIPv6RouteEnabled;
25442
25443 readonly attribute boolean needDhcpServer;
25444
25445 };
25446
25447 interface INATNetworkPortForwardEvent : INATNetworkAlterEvent
25448 {
25449 readonly attribute boolean create;
25450
25451 readonly attribute boolean ipv6;
25452
25453 readonly attribute wstring name;
25454
25455 readonly attribute NATProtocol proto;
25456
25457 readonly attribute wstring hostIp;
25458
25459 readonly attribute long hostPort;
25460
25461 readonly attribute wstring guestIp;
25462
25463 readonly attribute long guestPort;
25464
25465 };
25466
25467 interface IHostNameResolutionConfigurationChangeEvent : IEvent
25468 {
25469 };
25470
25471