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,
00775 CPUPropertyType_TripleFaultReset = 4,
00776 };
00777
00787 enum HWVirtExPropertyType
00788 {
00793 HWVirtExPropertyType_Null = 0,
00801 HWVirtExPropertyType_Enabled = 1,
00808 HWVirtExPropertyType_VPID = 2,
00815 HWVirtExPropertyType_NestedPaging = 3,
00822 HWVirtExPropertyType_UnrestrictedExecution = 4,
00829 HWVirtExPropertyType_LargePages = 5,
00837 HWVirtExPropertyType_Force = 6,
00838 };
00839
00847 enum FaultToleranceState
00848 {
00853 FaultToleranceState_Inactive = 1,
00858 FaultToleranceState_Master = 2,
00863 FaultToleranceState_Standby = 3,
00864 };
00865
00873 enum LockType
00874 {
00883 LockType_Write = 2,
00890 LockType_Shared = 1,
00896 LockType_VM = 3,
00897 };
00898
00907 enum SessionType
00908 {
00913 SessionType_Null = 0,
00921 SessionType_WriteLock = 1,
00928 SessionType_Remote = 2,
00935 SessionType_Shared = 3,
00936 };
00937
00945 enum DeviceType
00946 {
00954 DeviceType_Null = 0,
00959 DeviceType_Floppy = 1,
00964 DeviceType_DVD = 2,
00969 DeviceType_HardDisk = 3,
00974 DeviceType_Network = 4,
00979 DeviceType_USB = 5,
00984 DeviceType_SharedFolder = 6,
00985 };
00986
00994 enum DeviceActivity
00995 {
00996 DeviceActivity_Null = 0,
00997 DeviceActivity_Idle = 1,
00998 DeviceActivity_Reading = 2,
00999 DeviceActivity_Writing = 3,
01000 };
01001
01009 enum ClipboardMode
01010 {
01011 ClipboardMode_Disabled = 0,
01012 ClipboardMode_HostToGuest = 1,
01013 ClipboardMode_GuestToHost = 2,
01014 ClipboardMode_Bidirectional = 3,
01015 };
01016
01024 enum DragAndDropMode
01025 {
01026 DragAndDropMode_Disabled = 0,
01027 DragAndDropMode_HostToGuest = 1,
01028 DragAndDropMode_GuestToHost = 2,
01029 DragAndDropMode_Bidirectional = 3,
01030 };
01031
01042 enum Scope
01043 {
01044 Scope_Global = 0,
01045 Scope_Machine = 1,
01046 Scope_Session = 2,
01047 };
01048
01056 enum BIOSBootMenuMode
01057 {
01058 BIOSBootMenuMode_Disabled = 0,
01059 BIOSBootMenuMode_MenuOnly = 1,
01060 BIOSBootMenuMode_MessageAndMenu = 2,
01061 };
01062
01070 enum ProcessorFeature
01071 {
01072 ProcessorFeature_HWVirtEx = 0,
01073 ProcessorFeature_PAE = 1,
01074 ProcessorFeature_LongMode = 2,
01075 ProcessorFeature_NestedPaging = 3,
01076 };
01077
01085 enum FirmwareType
01086 {
01091 FirmwareType_BIOS = 1,
01096 FirmwareType_EFI = 2,
01101 FirmwareType_EFI32 = 3,
01106 FirmwareType_EFI64 = 4,
01111 FirmwareType_EFIDUAL = 5,
01112 };
01113
01121 enum PointingHIDType
01122 {
01127 PointingHIDType_None = 1,
01132 PointingHIDType_PS2Mouse = 2,
01137 PointingHIDType_USBMouse = 3,
01145 PointingHIDType_USBTablet = 4,
01153 PointingHIDType_ComboMouse = 5,
01160 PointingHIDType_USBMultiTouch = 6,
01161 };
01162
01170 enum KeyboardHIDType
01171 {
01176 KeyboardHIDType_None = 1,
01181 KeyboardHIDType_PS2Keyboard = 2,
01186 KeyboardHIDType_USBKeyboard = 3,
01192 KeyboardHIDType_ComboKeyboard = 4,
01193 };
01194
01195 enum DhcpOpt
01196 {
01197 DhcpOpt_SubnetMask = 1,
01198 DhcpOpt_TimeOffset = 2,
01199 DhcpOpt_Router = 3,
01200 DhcpOpt_TimeServer = 4,
01201 DhcpOpt_NameServer = 5,
01202 DhcpOpt_DomainNameServer = 6,
01203 DhcpOpt_LogServer = 7,
01204 DhcpOpt_Cookie = 8,
01205 DhcpOpt_LPRServer = 9,
01206 DhcpOpt_ImpressServer = 10,
01207 DhcpOpt_ResourseLocationServer = 11,
01208 DhcpOpt_HostName = 12,
01209 DhcpOpt_BootFileSize = 13,
01210 DhcpOpt_MeritDumpFile = 14,
01211 DhcpOpt_DomainName = 15,
01212 DhcpOpt_SwapServer = 16,
01213 DhcpOpt_RootPath = 17,
01214 DhcpOpt_ExtensionPath = 18,
01215 DhcpOpt_IPForwardingEnableDisable = 19,
01216 DhcpOpt_NonLocalSourceRoutingEnableDisable = 20,
01217 DhcpOpt_PolicyFilter = 21,
01218 DhcpOpt_MaximumDatagramReassemblySize = 22,
01219 DhcpOpt_DefaultIPTime2Live = 23,
01220 DhcpOpt_PathMTUAgingTimeout = 24,
01221 DhcpOpt_IPLayerParametersPerInterface = 25,
01222 DhcpOpt_InterfaceMTU = 26,
01223 DhcpOpt_AllSubnetsAreLocal = 27,
01224 DhcpOpt_BroadcastAddress = 28,
01225 DhcpOpt_PerformMaskDiscovery = 29,
01226 DhcpOpt_MaskSupplier = 30,
01227 DhcpOpt_PerformRouteDiscovery = 31,
01228 DhcpOpt_RouterSolicitationAddress = 32,
01229 DhcpOpt_StaticRoute = 33,
01230 DhcpOpt_TrailerEncapsulation = 34,
01231 DhcpOpt_ARPCacheTimeout = 35,
01232 DhcpOpt_EthernetEncapsulation = 36,
01233 DhcpOpt_TCPDefaultTTL = 37,
01234 DhcpOpt_TCPKeepAliveInterval = 38,
01235 DhcpOpt_TCPKeepAliveGarbage = 39,
01236 DhcpOpt_NetworkInformationServiceDomain = 40,
01237 DhcpOpt_NetworkInformationServiceServers = 41,
01238 DhcpOpt_NetworkTimeProtocolServers = 42,
01239 DhcpOpt_VendorSpecificInformation = 43,
01240 DhcpOpt_Option_44 = 44,
01241 DhcpOpt_Option_45 = 45,
01242 DhcpOpt_Option_46 = 46,
01243 DhcpOpt_Option_47 = 47,
01244 DhcpOpt_Option_48 = 48,
01245 DhcpOpt_Option_49 = 49,
01246 DhcpOpt_IPAddressLeaseTime = 51,
01247 DhcpOpt_Option_64 = 64,
01248 DhcpOpt_Option_65 = 65,
01249 DhcpOpt_TFTPServerName = 66,
01250 DhcpOpt_BootfileName = 67,
01251 DhcpOpt_Option_68 = 68,
01252 DhcpOpt_Option_69 = 69,
01253 DhcpOpt_Option_70 = 70,
01254 DhcpOpt_Option_71 = 71,
01255 DhcpOpt_Option_72 = 72,
01256 DhcpOpt_Option_73 = 73,
01257 DhcpOpt_Option_74 = 74,
01258 DhcpOpt_Option_75 = 75,
01259 DhcpOpt_Option_119 = 119,
01260 };
01261
01269 enum VFSType
01270 {
01271 VFSType_File = 1,
01272 VFSType_Cloud = 2,
01273 VFSType_S3 = 3,
01274 VFSType_WebDav = 4,
01275 };
01276
01284 enum VFSFileType
01285 {
01286 VFSFileType_Unknown = 1,
01287 VFSFileType_Fifo = 2,
01288 VFSFileType_DevChar = 3,
01289 VFSFileType_Directory = 4,
01290 VFSFileType_DevBlock = 5,
01291 VFSFileType_File = 6,
01292 VFSFileType_SymLink = 7,
01293 VFSFileType_Socket = 8,
01294 VFSFileType_WhiteOut = 9,
01295 };
01296
01304 enum ImportOptions
01305 {
01310 ImportOptions_KeepAllMACs = 1,
01315 ImportOptions_KeepNATMACs = 2,
01316 };
01317
01325 enum ExportOptions
01326 {
01332 ExportOptions_CreateManifest = 1,
01338 ExportOptions_ExportDVDImages = 2,
01339 };
01340
01347 enum VirtualSystemDescriptionType
01348 {
01349 VirtualSystemDescriptionType_Ignore = 1,
01350 VirtualSystemDescriptionType_OS = 2,
01351 VirtualSystemDescriptionType_Name = 3,
01352 VirtualSystemDescriptionType_Product = 4,
01353 VirtualSystemDescriptionType_Vendor = 5,
01354 VirtualSystemDescriptionType_Version = 6,
01355 VirtualSystemDescriptionType_ProductUrl = 7,
01356 VirtualSystemDescriptionType_VendorUrl = 8,
01357 VirtualSystemDescriptionType_Description = 9,
01358 VirtualSystemDescriptionType_License = 10,
01359 VirtualSystemDescriptionType_Miscellaneous = 11,
01360 VirtualSystemDescriptionType_CPU = 12,
01361 VirtualSystemDescriptionType_Memory = 13,
01362 VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
01363 VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
01364 VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
01365 VirtualSystemDescriptionType_HardDiskControllerSAS = 17,
01366 VirtualSystemDescriptionType_HardDiskImage = 18,
01367 VirtualSystemDescriptionType_Floppy = 19,
01368 VirtualSystemDescriptionType_CDROM = 20,
01369 VirtualSystemDescriptionType_NetworkAdapter = 21,
01370 VirtualSystemDescriptionType_USBController = 22,
01371 VirtualSystemDescriptionType_SoundCard = 23,
01376 VirtualSystemDescriptionType_SettingsFile = 24,
01377 };
01378
01385 enum VirtualSystemDescriptionValueType
01386 {
01387 VirtualSystemDescriptionValueType_Reference = 1,
01388 VirtualSystemDescriptionValueType_Original = 2,
01389 VirtualSystemDescriptionValueType_Auto = 3,
01390 VirtualSystemDescriptionValueType_ExtraConfig = 4,
01391 };
01392
01399 enum GraphicsControllerType
01400 {
01405 GraphicsControllerType_Null = 0,
01410 GraphicsControllerType_VBoxVGA = 1,
01411 };
01412
01419 enum CleanupMode
01420 {
01425 CleanupMode_UnregisterOnly = 1,
01430 CleanupMode_DetachAllReturnNone = 2,
01435 CleanupMode_DetachAllReturnHardDisksOnly = 3,
01440 CleanupMode_Full = 4,
01441 };
01442
01450 enum CloneMode
01451 {
01456 CloneMode_MachineState = 1,
01461 CloneMode_MachineAndChildStates = 2,
01466 CloneMode_AllStates = 3,
01467 };
01468
01476 enum CloneOptions
01477 {
01482 CloneOptions_Link = 1,
01487 CloneOptions_KeepAllMACs = 2,
01492 CloneOptions_KeepNATMACs = 3,
01497 CloneOptions_KeepDiskNames = 4,
01498 };
01499
01507 enum AutostopType
01508 {
01513 AutostopType_Disabled = 1,
01518 AutostopType_SaveState = 2,
01523 AutostopType_PowerOff = 3,
01528 AutostopType_AcpiShutdown = 4,
01529 };
01530
01541 enum HostNetworkInterfaceMediumType
01542 {
01549 HostNetworkInterfaceMediumType_Unknown = 0,
01556 HostNetworkInterfaceMediumType_Ethernet = 1,
01563 HostNetworkInterfaceMediumType_PPP = 2,
01570 HostNetworkInterfaceMediumType_SLIP = 3,
01571 };
01572
01582 enum HostNetworkInterfaceStatus
01583 {
01590 HostNetworkInterfaceStatus_Unknown = 0,
01597 HostNetworkInterfaceStatus_Up = 1,
01604 HostNetworkInterfaceStatus_Down = 2,
01605 };
01606
01614 enum HostNetworkInterfaceType
01615 {
01616 HostNetworkInterfaceType_Bridged = 1,
01617 HostNetworkInterfaceType_HostOnly = 2,
01618 };
01619
01627 enum AdditionsFacilityType
01628 {
01633 AdditionsFacilityType_None = 0,
01638 AdditionsFacilityType_VBoxGuestDriver = 20,
01643 AdditionsFacilityType_AutoLogon = 90,
01648 AdditionsFacilityType_VBoxService = 100,
01653 AdditionsFacilityType_VBoxTrayClient = 101,
01658 AdditionsFacilityType_Seamless = 1000,
01666 AdditionsFacilityType_Graphics = 1100,
01671 AdditionsFacilityType_All = 2147483646,
01672 };
01673
01681 enum AdditionsFacilityClass
01682 {
01687 AdditionsFacilityClass_None = 0,
01692 AdditionsFacilityClass_Driver = 10,
01697 AdditionsFacilityClass_Service = 30,
01702 AdditionsFacilityClass_Program = 50,
01707 AdditionsFacilityClass_Feature = 100,
01712 AdditionsFacilityClass_ThirdParty = 999,
01717 AdditionsFacilityClass_All = 2147483646,
01718 };
01719
01727 enum AdditionsFacilityStatus
01728 {
01733 AdditionsFacilityStatus_Inactive = 0,
01738 AdditionsFacilityStatus_Paused = 1,
01743 AdditionsFacilityStatus_PreInit = 20,
01748 AdditionsFacilityStatus_Init = 30,
01753 AdditionsFacilityStatus_Active = 50,
01758 AdditionsFacilityStatus_Terminating = 100,
01763 AdditionsFacilityStatus_Terminated = 101,
01768 AdditionsFacilityStatus_Failed = 800,
01773 AdditionsFacilityStatus_Unknown = 999,
01774 };
01775
01783 enum AdditionsRunLevelType
01784 {
01789 AdditionsRunLevelType_None = 0,
01794 AdditionsRunLevelType_System = 1,
01799 AdditionsRunLevelType_Userland = 2,
01804 AdditionsRunLevelType_Desktop = 3,
01805 };
01806
01814 enum AdditionsUpdateFlag
01815 {
01820 AdditionsUpdateFlag_None = 0,
01828 AdditionsUpdateFlag_WaitForUpdateStartOnly = 1,
01829 };
01830
01839 enum GuestSessionStatus
01840 {
01845 GuestSessionStatus_Undefined = 0,
01850 GuestSessionStatus_Starting = 10,
01855 GuestSessionStatus_Started = 100,
01860 GuestSessionStatus_Terminating = 480,
01865 GuestSessionStatus_Terminated = 500,
01870 GuestSessionStatus_TimedOutKilled = 512,
01875 GuestSessionStatus_TimedOutAbnormally = 513,
01880 GuestSessionStatus_Down = 600,
01885 GuestSessionStatus_Error = 800,
01886 };
01887
01895 enum GuestSessionWaitForFlag
01896 {
01901 GuestSessionWaitForFlag_None = 0,
01906 GuestSessionWaitForFlag_Start = 1,
01911 GuestSessionWaitForFlag_Terminate = 2,
01916 GuestSessionWaitForFlag_Status = 4,
01917 };
01918
01932 enum GuestSessionWaitResult
01933 {
01938 GuestSessionWaitResult_None = 0,
01943 GuestSessionWaitResult_Start = 1,
01948 GuestSessionWaitResult_Terminate = 2,
01956 GuestSessionWaitResult_Status = 3,
01961 GuestSessionWaitResult_Error = 4,
01970 GuestSessionWaitResult_Timeout = 5,
01978 GuestSessionWaitResult_WaitFlagNotSupported = 6,
01979 };
01980
01988 enum GuestUserState
01989 {
01994 GuestUserState_Unknown = 0,
02003 GuestUserState_LoggedIn = 1,
02012 GuestUserState_LoggedOut = 2,
02022 GuestUserState_Locked = 3,
02030 GuestUserState_Unlocked = 4,
02038 GuestUserState_Disabled = 5,
02060 GuestUserState_Idle = 6,
02066 GuestUserState_InUse = 7,
02074 GuestUserState_Created = 8,
02082 GuestUserState_Deleted = 9,
02090 GuestUserState_SessionChanged = 10,
02100 GuestUserState_CredentialsChanged = 11,
02109 GuestUserState_RoleChanged = 12,
02118 GuestUserState_GroupAdded = 13,
02127 GuestUserState_GroupRemoved = 14,
02136 GuestUserState_Elevated = 15,
02137 };
02138
02146 enum FileSeekType
02147 {
02152 FileSeekType_Set = 0,
02157 FileSeekType_Current = 1,
02158 };
02159
02167 enum ProcessInputFlag
02168 {
02173 ProcessInputFlag_None = 0,
02178 ProcessInputFlag_EndOfFile = 1,
02179 };
02180
02189 enum ProcessOutputFlag
02190 {
02195 ProcessOutputFlag_None = 0,
02200 ProcessOutputFlag_StdErr = 1,
02201 };
02202
02210 enum ProcessWaitForFlag
02211 {
02216 ProcessWaitForFlag_None = 0,
02221 ProcessWaitForFlag_Start = 1,
02226 ProcessWaitForFlag_Terminate = 2,
02231 ProcessWaitForFlag_StdIn = 4,
02236 ProcessWaitForFlag_StdOut = 8,
02241 ProcessWaitForFlag_StdErr = 16,
02242 };
02243
02262 enum ProcessWaitResult
02263 {
02268 ProcessWaitResult_None = 0,
02273 ProcessWaitResult_Start = 1,
02278 ProcessWaitResult_Terminate = 2,
02286 ProcessWaitResult_Status = 3,
02291 ProcessWaitResult_Error = 4,
02300 ProcessWaitResult_Timeout = 5,
02307 ProcessWaitResult_StdIn = 6,
02312 ProcessWaitResult_StdOut = 7,
02317 ProcessWaitResult_StdErr = 8,
02325 ProcessWaitResult_WaitFlagNotSupported = 9,
02326 };
02327
02335 enum CopyFileFlag
02336 {
02341 CopyFileFlag_None = 0,
02346 CopyFileFlag_Recursive = 1,
02351 CopyFileFlag_Update = 2,
02356 CopyFileFlag_FollowLinks = 4,
02357 };
02358
02366 enum DirectoryCreateFlag
02367 {
02372 DirectoryCreateFlag_None = 0,
02377 DirectoryCreateFlag_Parents = 1,
02378 };
02379
02387 enum DirectoryRemoveRecFlag
02388 {
02393 DirectoryRemoveRecFlag_None = 0,
02398 DirectoryRemoveRecFlag_ContentAndDir = 1,
02403 DirectoryRemoveRecFlag_ContentOnly = 2,
02404 };
02405
02413 enum PathRenameFlag
02414 {
02419 PathRenameFlag_None = 0,
02424 PathRenameFlag_NoReplace = 1,
02429 PathRenameFlag_Replace = 2,
02434 PathRenameFlag_NoSymlinks = 4,
02435 };
02436
02444 enum ProcessCreateFlag
02445 {
02450 ProcessCreateFlag_None = 0,
02456 ProcessCreateFlag_WaitForProcessStartOnly = 1,
02461 ProcessCreateFlag_IgnoreOrphanedProcesses = 2,
02466 ProcessCreateFlag_Hidden = 4,
02471 ProcessCreateFlag_NoProfile = 8,
02476 ProcessCreateFlag_WaitForStdOut = 16,
02481 ProcessCreateFlag_WaitForStdErr = 32,
02486 ProcessCreateFlag_ExpandArguments = 64,
02487 };
02488
02496 enum ProcessPriority
02497 {
02502 ProcessPriority_Invalid = 0,
02507 ProcessPriority_Default = 1,
02508 };
02509
02517 enum SymlinkType
02518 {
02523 SymlinkType_Unknown = 0,
02528 SymlinkType_Directory = 1,
02533 SymlinkType_File = 2,
02534 };
02535
02543 enum SymlinkReadFlag
02544 {
02549 SymlinkReadFlag_None = 0,
02554 SymlinkReadFlag_NoSymlinks = 1,
02555 };
02556
02564 enum ProcessStatus
02565 {
02570 ProcessStatus_Undefined = 0,
02575 ProcessStatus_Starting = 10,
02580 ProcessStatus_Started = 100,
02585 ProcessStatus_Paused = 110,
02590 ProcessStatus_Terminating = 480,
02595 ProcessStatus_TerminatedNormally = 500,
02600 ProcessStatus_TerminatedSignal = 510,
02605 ProcessStatus_TerminatedAbnormally = 511,
02610 ProcessStatus_TimedOutKilled = 512,
02615 ProcessStatus_TimedOutAbnormally = 513,
02620 ProcessStatus_Down = 600,
02625 ProcessStatus_Error = 800,
02626 };
02627
02635 enum ProcessInputStatus
02636 {
02641 ProcessInputStatus_Undefined = 0,
02646 ProcessInputStatus_Broken = 1,
02651 ProcessInputStatus_Available = 10,
02656 ProcessInputStatus_Written = 50,
02661 ProcessInputStatus_Overflow = 100,
02662 };
02663
02671 enum FileStatus
02672 {
02677 FileStatus_Undefined = 0,
02682 FileStatus_Opening = 10,
02687 FileStatus_Open = 100,
02692 FileStatus_Closing = 150,
02697 FileStatus_Closed = 200,
02702 FileStatus_Down = 600,
02707 FileStatus_Error = 800,
02708 };
02709
02717 enum FsObjType
02718 {
02723 FsObjType_Undefined = 0,
02728 FsObjType_FIFO = 1,
02733 FsObjType_DevChar = 10,
02738 FsObjType_DevBlock = 11,
02743 FsObjType_Directory = 50,
02748 FsObjType_File = 80,
02753 FsObjType_Symlink = 100,
02758 FsObjType_Socket = 200,
02763 FsObjType_Whiteout = 400,
02764 };
02765
02773 enum DragAndDropAction
02774 {
02779 DragAndDropAction_Ignore = 0,
02784 DragAndDropAction_Copy = 1,
02789 DragAndDropAction_Move = 2,
02794 DragAndDropAction_Link = 3,
02795 };
02796
02804 enum DirectoryOpenFlag
02805 {
02810 DirectoryOpenFlag_None = 0,
02815 DirectoryOpenFlag_NoSymlinks = 1,
02816 };
02817
02827 enum MediumState
02828 {
02836 MediumState_NotCreated = 0,
02845 MediumState_Created = 1,
02853 MediumState_LockedRead = 2,
02861 MediumState_LockedWrite = 3,
02871 MediumState_Inaccessible = 4,
02878 MediumState_Creating = 5,
02885 MediumState_Deleting = 6,
02886 };
02887
02898 enum MediumType
02899 {
02907 MediumType_Normal = 0,
02915 MediumType_Immutable = 1,
02923 MediumType_Writethrough = 2,
02932 MediumType_Shareable = 3,
02941 MediumType_Readonly = 4,
02953 MediumType_MultiAttach = 5,
02954 };
02955
02965 enum MediumVariant
02966 {
02973 MediumVariant_Standard = 0,
02980 MediumVariant_VmdkSplit2G = 0x01,
02987 MediumVariant_VmdkRawDisk = 0x02,
02995 MediumVariant_VmdkStreamOptimized = 0x04,
03002 MediumVariant_VmdkESX = 0x08,
03009 MediumVariant_Fixed = 0x10000,
03016 MediumVariant_Diff = 0x20000,
03024 MediumVariant_NoCreateDir = 0x40000000,
03025 };
03026
03027 enum DataType
03028 {
03029 DataType_Int32 = 0,
03030 DataType_Int8 = 1,
03031 DataType_String = 2,
03032 };
03033
03034 enum DataFlags
03035 {
03036 DataFlags_None = 0x00,
03037 DataFlags_Mandatory = 0x01,
03038 DataFlags_Expert = 0x02,
03039 DataFlags_Array = 0x04,
03040 DataFlags_FlagMask = 0x07,
03041 };
03042
03050 enum MediumFormatCapabilities
03051 {
03058 MediumFormatCapabilities_Uuid = 0x01,
03065 MediumFormatCapabilities_CreateFixed = 0x02,
03073 MediumFormatCapabilities_CreateDynamic = 0x04,
03080 MediumFormatCapabilities_CreateSplit2G = 0x08,
03087 MediumFormatCapabilities_Differencing = 0x10,
03094 MediumFormatCapabilities_Asynchronous = 0x20,
03104 MediumFormatCapabilities_File = 0x40,
03113 MediumFormatCapabilities_Properties = 0x80,
03120 MediumFormatCapabilities_TcpNetworking = 0x100,
03127 MediumFormatCapabilities_VFS = 0x200,
03128 MediumFormatCapabilities_CapabilityMask = 0x3FF,
03129 };
03130
03138 enum MouseButtonState
03139 {
03140 MouseButtonState_LeftButton = 0x01,
03141 MouseButtonState_RightButton = 0x02,
03142 MouseButtonState_MiddleButton = 0x04,
03143 MouseButtonState_WheelUp = 0x08,
03144 MouseButtonState_WheelDown = 0x10,
03145 MouseButtonState_XButton1 = 0x20,
03146 MouseButtonState_XButton2 = 0x40,
03147 MouseButtonState_MouseStateMask = 0x7F,
03148 };
03149
03157 enum TouchContactState
03158 {
03163 TouchContactState_None = 0x00,
03168 TouchContactState_InContact = 0x01,
03175 TouchContactState_InRange = 0x02,
03176 TouchContactState_ContactStateMask = 0x03,
03177 };
03178
03189 enum FramebufferPixelFormat
03190 {
03198 FramebufferPixelFormat_Opaque = 0,
03206 FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
03207 };
03208
03216 enum NetworkAttachmentType
03217 {
03222 NetworkAttachmentType_Null = 0,
03223 NetworkAttachmentType_NAT = 1,
03224 NetworkAttachmentType_Bridged = 2,
03225 NetworkAttachmentType_Internal = 3,
03226 NetworkAttachmentType_HostOnly = 4,
03227 NetworkAttachmentType_Generic = 5,
03228 NetworkAttachmentType_NATNetwork = 6,
03229 };
03230
03238 enum NetworkAdapterType
03239 {
03244 NetworkAdapterType_Null = 0,
03249 NetworkAdapterType_Am79C970A = 1,
03254 NetworkAdapterType_Am79C973 = 2,
03259 NetworkAdapterType_I82540EM = 3,
03264 NetworkAdapterType_I82543GC = 4,
03269 NetworkAdapterType_I82545EM = 5,
03274 NetworkAdapterType_Virtio = 6,
03275 };
03276
03284 enum NetworkAdapterPromiscModePolicy
03285 {
03290 NetworkAdapterPromiscModePolicy_Deny = 1,
03298 NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
03306 NetworkAdapterPromiscModePolicy_AllowAll = 3,
03307 };
03308
03317 enum PortMode
03318 {
03323 PortMode_Disconnected = 0,
03328 PortMode_HostPipe = 1,
03333 PortMode_HostDevice = 2,
03338 PortMode_RawFile = 3,
03339 };
03340
03348 enum USBControllerType
03349 {
03354 USBControllerType_Null = 0,
03355 USBControllerType_OHCI = 1,
03356 USBControllerType_EHCI = 2,
03361 USBControllerType_Last = 3,
03362 };
03363
03402 enum USBDeviceState
03403 {
03410 USBDeviceState_NotSupported = 0,
03418 USBDeviceState_Unavailable = 1,
03425 USBDeviceState_Busy = 2,
03433 USBDeviceState_Available = 3,
03441 USBDeviceState_Held = 4,
03449 USBDeviceState_Captured = 5,
03450 };
03451
03461 enum USBDeviceFilterAction
03462 {
03467 USBDeviceFilterAction_Null = 0,
03472 USBDeviceFilterAction_Ignore = 1,
03477 USBDeviceFilterAction_Hold = 2,
03478 };
03479
03487 enum AudioDriverType
03488 {
03493 AudioDriverType_Null = 0,
03498 AudioDriverType_WinMM = 1,
03503 AudioDriverType_OSS = 2,
03508 AudioDriverType_ALSA = 3,
03513 AudioDriverType_DirectSound = 4,
03518 AudioDriverType_CoreAudio = 5,
03523 AudioDriverType_MMPM = 6,
03528 AudioDriverType_Pulse = 7,
03533 AudioDriverType_SolAudio = 8,
03534 };
03535
03543 enum AudioControllerType
03544 {
03545 AudioControllerType_AC97 = 0,
03546 AudioControllerType_SB16 = 1,
03547 AudioControllerType_HDA = 2,
03548 };
03549
03557 enum AuthType
03558 {
03563 AuthType_Null = 0,
03564 AuthType_External = 1,
03565 AuthType_Guest = 2,
03566 };
03567
03575 enum Reason
03576 {
03581 Reason_Unspecified = 0,
03586 Reason_HostSuspend = 1,
03591 Reason_HostResume = 2,
03596 Reason_HostBatteryLow = 3,
03597 };
03598
03607 enum StorageBus
03608 {
03613 StorageBus_Null = 0,
03614 StorageBus_IDE = 1,
03615 StorageBus_SATA = 2,
03616 StorageBus_SCSI = 3,
03617 StorageBus_Floppy = 4,
03618 StorageBus_SAS = 5,
03619 };
03620
03629 enum StorageControllerType
03630 {
03635 StorageControllerType_Null = 0,
03640 StorageControllerType_LsiLogic = 1,
03645 StorageControllerType_BusLogic = 2,
03650 StorageControllerType_IntelAhci = 3,
03655 StorageControllerType_PIIX3 = 4,
03660 StorageControllerType_PIIX4 = 5,
03665 StorageControllerType_ICH6 = 6,
03670 StorageControllerType_I82078 = 7,
03675 StorageControllerType_LsiLogicSas = 8,
03676 };
03677
03685 enum ChipsetType
03686 {
03691 ChipsetType_Null = 0,
03696 ChipsetType_PIIX3 = 1,
03701 ChipsetType_ICH9 = 2,
03702 };
03703
03709 enum NATAliasMode
03710 {
03715 NATAliasMode_AliasLog = 0x1,
03720 NATAliasMode_AliasProxyOnly = 0x02,
03725 NATAliasMode_AliasUseSamePorts = 0x04,
03726 };
03727
03733 enum NATProtocol
03734 {
03739 NATProtocol_UDP = 0,
03744 NATProtocol_TCP = 1,
03745 };
03746
03754 enum BandwidthGroupType
03755 {
03762 BandwidthGroupType_Null = 0,
03769 BandwidthGroupType_Disk = 1,
03776 BandwidthGroupType_Network = 2,
03777 };
03778
03787 enum VBoxEventType
03788 {
03795 VBoxEventType_Invalid = 0,
03804 VBoxEventType_Any = 1,
03812 VBoxEventType_Vetoable = 2,
03820 VBoxEventType_MachineEvent = 3,
03828 VBoxEventType_SnapshotEvent = 4,
03837 VBoxEventType_InputEvent = 5,
03844 VBoxEventType_LastWildcard = 31,
03851 VBoxEventType_OnMachineStateChanged = 32,
03858 VBoxEventType_OnMachineDataChanged = 33,
03865 VBoxEventType_OnExtraDataChanged = 34,
03872 VBoxEventType_OnExtraDataCanChange = 35,
03879 VBoxEventType_OnMediumRegistered = 36,
03886 VBoxEventType_OnMachineRegistered = 37,
03893 VBoxEventType_OnSessionStateChanged = 38,
03900 VBoxEventType_OnSnapshotTaken = 39,
03907 VBoxEventType_OnSnapshotDeleted = 40,
03914 VBoxEventType_OnSnapshotChanged = 41,
03921 VBoxEventType_OnGuestPropertyChanged = 42,
03928 VBoxEventType_OnMousePointerShapeChanged = 43,
03935 VBoxEventType_OnMouseCapabilityChanged = 44,
03942 VBoxEventType_OnKeyboardLedsChanged = 45,
03949 VBoxEventType_OnStateChanged = 46,
03956 VBoxEventType_OnAdditionsStateChanged = 47,
03963 VBoxEventType_OnNetworkAdapterChanged = 48,
03970 VBoxEventType_OnSerialPortChanged = 49,
03977 VBoxEventType_OnParallelPortChanged = 50,
03984 VBoxEventType_OnStorageControllerChanged = 51,
03991 VBoxEventType_OnMediumChanged = 52,
03998 VBoxEventType_OnVRDEServerChanged = 53,
04005 VBoxEventType_OnUSBControllerChanged = 54,
04012 VBoxEventType_OnUSBDeviceStateChanged = 55,
04019 VBoxEventType_OnSharedFolderChanged = 56,
04026 VBoxEventType_OnRuntimeError = 57,
04033 VBoxEventType_OnCanShowWindow = 58,
04040 VBoxEventType_OnShowWindow = 59,
04047 VBoxEventType_OnCPUChanged = 60,
04054 VBoxEventType_OnVRDEServerInfoChanged = 61,
04061 VBoxEventType_OnEventSourceChanged = 62,
04068 VBoxEventType_OnCPUExecutionCapChanged = 63,
04075 VBoxEventType_OnGuestKeyboard = 64,
04082 VBoxEventType_OnGuestMouse = 65,
04089 VBoxEventType_OnNATRedirect = 66,
04096 VBoxEventType_OnHostPCIDevicePlug = 67,
04103 VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
04110 VBoxEventType_OnBandwidthGroupChanged = 69,
04117 VBoxEventType_OnGuestMonitorChanged = 70,
04124 VBoxEventType_OnStorageDeviceChanged = 71,
04131 VBoxEventType_OnClipboardModeChanged = 72,
04138 VBoxEventType_OnDragAndDropModeChanged = 73,
04145 VBoxEventType_OnNATNetworkChanged = 74,
04152 VBoxEventType_OnNATNetworkStartStop = 75,
04159 VBoxEventType_OnNATNetworkAlter = 76,
04166 VBoxEventType_OnNATNetworkCreationDeletion = 77,
04173 VBoxEventType_OnNATNetworkSetting = 78,
04180 VBoxEventType_OnNATNetworkPortForward = 79,
04187 VBoxEventType_OnGuestSessionStateChanged = 80,
04194 VBoxEventType_OnGuestSessionRegistered = 81,
04201 VBoxEventType_OnGuestProcessRegistered = 82,
04208 VBoxEventType_OnGuestProcessStateChanged = 83,
04215 VBoxEventType_OnGuestProcessInputNotify = 84,
04222 VBoxEventType_OnGuestProcessOutput = 85,
04229 VBoxEventType_OnGuestFileRegistered = 86,
04236 VBoxEventType_OnGuestFileStateChanged = 87,
04243 VBoxEventType_OnGuestFileOffsetChanged = 88,
04251 VBoxEventType_OnGuestFileRead = 89,
04259 VBoxEventType_OnGuestFileWrite = 90,
04266 VBoxEventType_OnVideoCaptureChanged = 91,
04273 VBoxEventType_OnGuestUserStateChanged = 92,
04280 VBoxEventType_OnGuestMultiTouch = 93,
04287 VBoxEventType_OnHostNameResolutionConfigurationChange = 94,
04294 VBoxEventType_Last = 95,
04295 };
04296
04308 enum GuestMouseEventMode
04309 {
04316 GuestMouseEventMode_Relative = 0,
04323 GuestMouseEventMode_Absolute = 1,
04324 };
04325
04333 enum GuestMonitorChangedEventType
04334 {
04341 GuestMonitorChangedEventType_Enabled = 0,
04348 GuestMonitorChangedEventType_Disabled = 1,
04355 GuestMonitorChangedEventType_NewOrigin = 2,
04356 };
04357
04391 interface IVirtualBoxErrorInfo : $errorinfo
04392 {
04410 readonly attribute long resultCode;
04411
04418 readonly attribute long resultDetail;
04419
04431 readonly attribute wstringUUID interfaceID;
04432
04443 readonly attribute wstring component;
04444
04455 readonly attribute wstring text;
04456
04467 readonly attribute IVirtualBoxErrorInfo next;
04468
04469 };
04470
04471 interface INATNetwork : $unknown
04472 {
04481 attribute wstring networkName;
04482
04483 attribute boolean enabled;
04484
04493 attribute wstring network;
04494
04501 readonly attribute wstring gateway;
04502
04508 attribute boolean IPv6Enabled;
04509
04517 attribute wstring IPv6Prefix;
04518
04519 attribute boolean advertiseDefaultIPv6RouteEnabled;
04520
04521 attribute boolean needDhcpServer;
04522
04523 readonly attribute IEventSource eventSource;
04524
04531 readonly attribute wstring[] portForwardRules4;
04532
04537 readonly attribute wstring[] localMappings;
04538
04543 attribute long loopbackIp6;
04544
04550 readonly attribute wstring[] portForwardRules6;
04551
04555 void addLocalMapping (
04556 in wstring hostid,
04557 in long offset
04558 );
04559
04560 void addPortForwardRule (
04561 in boolean isIpv6,
04562 in wstring ruleName,
04563 in NATProtocol proto,
04564 in wstring hostIP,
04565 in unsigned short hostPort,
04566 in wstring guestIP,
04567 in unsigned short guestPort
04568 );
04569
04570 void removePortForwardRule (
04571 in boolean iSipv6,
04572 in wstring ruleName
04573 );
04574
04575 void start (
04576 in wstring trunkType
04577 );
04578
04579 void stop();
04580
04581 };
04582
04593 interface IDHCPServer : $unknown
04594 {
04595 readonly attribute IEventSource eventSource;
04596
04602 attribute boolean enabled;
04603
04609 readonly attribute wstring IPAddress;
04610
04616 readonly attribute wstring networkMask;
04617
04623 readonly attribute wstring networkName;
04624
04630 readonly attribute wstring lowerIP;
04631
04637 readonly attribute wstring upperIP;
04638
04639 readonly attribute wstring[] globalOptions;
04640
04641 readonly attribute wstring[] vmConfigs;
04642
04643 void addGlobalOption (
04644 in DhcpOpt option,
04645 in wstring value
04646 );
04647
04648 void addVmSlotOption (
04649 in wstring vmname,
04650 in long slot,
04651 in DhcpOpt option,
04652 in wstring value
04653 );
04654
04655 void removeVmSlotOptions (
04656 in wstring vmname,
04657 in long slot
04658 );
04659
04660 void getVmSlotOptions (
04661 in wstring vmname,
04662 in long slot,
04663 [retval] out wstring[] option
04664 );
04665
04666 void getMacOptions (
04667 in wstring mac,
04668 [retval] out wstring[] option
04669 );
04670
04699 void setConfiguration (
04700 in wstring IPAddress,
04701 in wstring networkMask,
04702 in wstring FromIPAddress,
04703 in wstring ToIPAddress
04704 );
04705
04730 void start (
04731 in wstring networkName,
04732 in wstring trunkName,
04733 in wstring trunkType
04734 );
04735
04748 void stop();
04749
04750 };
04751
04770 interface IVirtualBox : $unknown
04771 {
04784 readonly attribute wstring version;
04785
04793 readonly attribute wstring versionNormalized;
04794
04800 readonly attribute unsigned long revision;
04801
04811 readonly attribute wstring packageType;
04812
04824 readonly attribute wstring APIVersion;
04825
04841 readonly attribute wstring homeFolder;
04842
04850 readonly attribute wstring settingsFilePath;
04851
04855 readonly attribute IHost host;
04856
04860 readonly attribute ISystemProperties systemProperties;
04861
04867 readonly attribute IMachine[] machines;
04868
04878 readonly attribute wstring[] machineGroups;
04879
04889 readonly attribute IMedium[] hardDisks;
04890
04896 readonly attribute IMedium[] DVDImages;
04897
04903 readonly attribute IMedium[] floppyImages;
04904
04905 readonly attribute IProgress[] progressOperations;
04906
04907 readonly attribute IGuestOSType[] guestOSTypes;
04908
04925 readonly attribute ISharedFolder[] sharedFolders;
04926
04932 readonly attribute IPerformanceCollector performanceCollector;
04933
04939 readonly attribute IDHCPServer[] DHCPServers;
04940
04941 readonly attribute INATNetwork[] NATNetworks;
04942
04948 readonly attribute IEventSource eventSource;
04949
04955 readonly attribute IExtPackManager extensionPackManager;
04956
04962 readonly attribute wstring[] internalNetworks;
04963
04969 readonly attribute wstring[] genericNetworkDrivers;
04970
05021 void composeMachineFilename (
05022 in wstring name,
05023 in wstring group,
05024 in wstring createFlags,
05025 in wstring baseFolder,
05026 [retval] out wstring file
05027 );
05028
05135 void createMachine (
05136 in wstring settingsFile,
05137 in wstring name,
05138 in wstring[] groups,
05139 in wstring osTypeId,
05140 in wstring flags,
05141 [retval] out IMachine machine
05142 );
05143
05174 void openMachine (
05175 in wstring settingsFile,
05176 [retval] out IMachine machine
05177 );
05178
05210 void registerMachine (
05211 in IMachine machine
05212 );
05213
05234 void findMachine (
05235 in wstring nameOrId,
05236 [retval] out IMachine machine
05237 );
05238
05250 void getMachinesByGroups (
05251 in wstring[] groups,
05252 [retval] out IMachine[] machines
05253 );
05254
05264 void getMachineStates (
05265 in IMachine[] machines,
05266 [retval] out MachineState[] states
05267 );
05268
05278 void createAppliance (
05279 [retval] out IAppliance appliance
05280 );
05281
05344 void createHardDisk (
05345 in wstring format,
05346 in wstring location,
05347 [retval] out IMedium medium
05348 );
05349
05455 void openMedium (
05456 in wstring location,
05457 in DeviceType deviceType,
05458 in AccessMode accessMode,
05459 in boolean forceNewUuid,
05460 [retval] out IMedium medium
05461 );
05462
05491 void getGuestOSType (
05492 in wstringUUID id,
05493 [retval] out IGuestOSType type
05494 );
05495
05518 void createSharedFolder (
05519 in wstring name,
05520 in wstring hostPath,
05521 in boolean writable,
05522 in boolean automount
05523 );
05524
05539 void removeSharedFolder (
05540 in wstring name
05541 );
05542
05551 void getExtraDataKeys (
05552 [retval] out wstring[] keys
05553 );
05554
05583 void getExtraData (
05584 in wstring key,
05585 [retval] out wstring value
05586 );
05587
05637 void setExtraData (
05638 in wstring key,
05639 in wstring value
05640 );
05641
05660 void setSettingsSecret (
05661 in wstring password
05662 );
05663
05680 void createDHCPServer (
05681 in wstring name,
05682 [retval] out IDHCPServer server
05683 );
05684
05701 void findDHCPServerByNetworkName (
05702 in wstring name,
05703 [retval] out IDHCPServer server
05704 );
05705
05720 void removeDHCPServer (
05721 in IDHCPServer server
05722 );
05723
05724 void createNATNetwork (
05725 in wstring networkName,
05726 [retval] out INATNetwork network
05727 );
05728
05729 void findNATNetworkByName (
05730 in wstring networkName,
05731 [retval] out INATNetwork network
05732 );
05733
05734 void removeNATNetwork (
05735 in INATNetwork network
05736 );
05737
05762 void checkFirmwarePresent (
05763 in FirmwareType firmwareType,
05764 in wstring version,
05765 out wstring url,
05766 out wstring file,
05767 [retval] out boolean result
05768 );
05769
05770 };
05771
05782 interface IVFSExplorer : $unknown
05783 {
05787 readonly attribute wstring path;
05788
05792 readonly attribute VFSType type;
05793
05801 void update (
05802 [retval] out IProgress progress
05803 );
05804
05812 void cd (
05813 in wstring dir,
05814 [retval] out IProgress progress
05815 );
05816
05822 void cdUp (
05823 [retval] out IProgress progress
05824 );
05825
05838 void entryList (
05839 out wstring[] names,
05840 out unsigned long[] types,
05841 out long long[] sizes,
05842 out unsigned long[] modes
05843 );
05844
05853 void exists (
05854 in wstring[] names,
05855 [retval] out wstring[] exists
05856 );
05857
05865 void remove (
05866 in wstring[] names,
05867 [retval] out IProgress progress
05868 );
05869
05870 };
05871
05937 interface IAppliance : $unknown
05938 {
05946 readonly attribute wstring path;
05947
05978 readonly attribute wstring[] disks;
05979
05987 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
05988
05996 readonly attribute wstring[] machines;
05997
06014 void read (
06015 in wstring file,
06016 [retval] out IProgress progress
06017 );
06018
06035 void interpret();
06036
06059 void importMachines (
06060 in ImportOptions[] options,
06061 [retval] out IProgress progress
06062 );
06063
06071 void createVFSExplorer (
06072 in wstring URI,
06073 [retval] out IVFSExplorer explorer
06074 );
06075
06102 void write (
06103 in wstring format,
06104 in ExportOptions[] options,
06105 in wstring path,
06106 [retval] out IProgress progress
06107 );
06108
06114 void getWarnings (
06115 [retval] out wstring[] warnings
06116 );
06117
06118 };
06119
06131 interface IVirtualSystemDescription : $unknown
06132 {
06136 readonly attribute unsigned long count;
06137
06261 void getDescription (
06262 out VirtualSystemDescriptionType[] types,
06263 out wstring[] refs,
06264 out wstring[] OVFValues,
06265 out wstring[] VBoxValues,
06266 out wstring[] extraConfigValues
06267 );
06268
06285 void getDescriptionByType (
06286 in VirtualSystemDescriptionType type,
06287 out VirtualSystemDescriptionType[] types,
06288 out wstring[] refs,
06289 out wstring[] OVFValues,
06290 out wstring[] VBoxValues,
06291 out wstring[] extraConfigValues
06292 );
06293
06305 void getValuesByType (
06306 in VirtualSystemDescriptionType type,
06307 in VirtualSystemDescriptionValueType which,
06308 [retval] out wstring[] values
06309 );
06310
06336 void setFinalValues (
06337 in boolean[] enabled,
06338 in wstring[] VBoxValues,
06339 in wstring[] extraConfigValues
06340 );
06341
06356 void addDescription (
06357 in VirtualSystemDescriptionType type,
06358 in wstring VBoxValue,
06359 in wstring extraConfigValue
06360 );
06361
06362 };
06363
06364 interface IInternalMachineControl : $unknown
06365 {
06372 void setRemoveSavedStateFile (
06373 in boolean remove
06374 );
06375
06387 void updateState (
06388 in MachineState state
06389 );
06390
06402 void beginPowerUp (
06403 in IProgress progress
06404 );
06405
06415 void endPowerUp (
06416 in long result
06417 );
06418
06430 void beginPoweringDown (
06431 out IProgress progress
06432 );
06433
06463 void endPoweringDown (
06464 in long result,
06465 in wstring errMsg
06466 );
06467
06481 void runUSBDeviceFilters (
06482 in IUSBDevice device,
06483 out boolean matched,
06484 out unsigned long maskedInterfaces
06485 );
06486
06495 void captureUSBDevice (
06496 in wstringUUID id
06497 );
06498
06514 void detachUSBDevice (
06515 in wstringUUID id,
06516 in boolean done
06517 );
06518
06527 void autoCaptureUSBDevices();
06528
06544 void detachAllUSBDevices (
06545 in boolean done
06546 );
06547
06562 void onSessionEnd (
06563 in ISession session,
06564 [retval] out IProgress progress
06565 );
06566
06582 void beginSavingState (
06583 out IProgress progress,
06584 out wstring stateFilePath
06585 );
06586
06616 void endSavingState (
06617 in long result,
06618 in wstring errMsg
06619 );
06620
06635 void adoptSavedState (
06636 in wstring savedStateFile
06637 );
06638
06687 void beginTakingSnapshot (
06688 in IConsole initiator,
06689 in wstring name,
06690 in wstring description,
06691 in IProgress consoleProgress,
06692 in boolean fTakingSnapshotOnline,
06693 out wstring stateFilePath
06694 );
06695
06705 void endTakingSnapshot (
06706 in boolean success
06707 );
06708
06737 void deleteSnapshot (
06738 in IConsole initiator,
06739 in wstringUUID startId,
06740 in wstringUUID endId,
06741 in boolean deleteAllChildren,
06742 out MachineState machineState,
06743 [retval] out IProgress progress
06744 );
06745
06752 void finishOnlineMergeMedium();
06753
06767 void restoreSnapshot (
06768 in IConsole initiator,
06769 in ISnapshot snapshot,
06770 out MachineState machineState,
06771 [retval] out IProgress progress
06772 );
06773
06800 void pullGuestProperties (
06801 out wstring[] names,
06802 out wstring[] values,
06803 out long long[] timestamps,
06804 out wstring[] flags
06805 );
06806
06828 void pushGuestProperty (
06829 in wstring name,
06830 in wstring value,
06831 in long long timestamp,
06832 in wstring flags
06833 );
06834
06846 void lockMedia();
06847
06857 void unlockMedia();
06858
06874 void ejectMedium (
06875 in IMediumAttachment attachment,
06876 [retval] out IMediumAttachment newAttachment
06877 );
06878
06919 void reportVmStatistics (
06920 in unsigned long validStats,
06921 in unsigned long cpuUser,
06922 in unsigned long cpuKernel,
06923 in unsigned long cpuIdle,
06924 in unsigned long memTotal,
06925 in unsigned long memFree,
06926 in unsigned long memBalloon,
06927 in unsigned long memShared,
06928 in unsigned long memCache,
06929 in unsigned long pagedTotal,
06930 in unsigned long memAllocTotal,
06931 in unsigned long memFreeTotal,
06932 in unsigned long memBalloonTotal,
06933 in unsigned long memSharedTotal,
06934 in unsigned long vmNetRx,
06935 in unsigned long vmNetTx
06936 );
06937
06938 };
06939
06948 interface IBIOSSettings : $unknown
06949 {
06953 attribute boolean logoFadeIn;
06954
06958 attribute boolean logoFadeOut;
06959
06963 attribute unsigned long logoDisplayTime;
06964
06971 attribute wstring logoImagePath;
06972
06976 attribute BIOSBootMenuMode bootMenuMode;
06977
06981 attribute boolean ACPIEnabled;
06982
06989 attribute boolean IOAPICEnabled;
06990
07000 attribute long long timeOffset;
07001
07008 attribute boolean PXEDebugEnabled;
07009
07018 readonly attribute wstring nonVolatileStorageFile;
07019
07020 };
07021
07029 interface IPCIAddress : $unknown
07030 {
07036 attribute short bus;
07037
07043 attribute short device;
07044
07050 attribute short devFunction;
07051
07057 void asLong (
07058 [retval] out long result
07059 );
07060
07066 void fromLong (
07067 in long number
07068 );
07069
07070 };
07071
07079 interface IPCIDeviceAttachment : $unknown
07080 {
07086 readonly attribute wstring name;
07087
07093 readonly attribute boolean isPhysicalDevice;
07094
07100 readonly attribute long hostAddress;
07101
07107 readonly attribute long guestAddress;
07108
07109 };
07110
07151 interface IMachine : $unknown
07152 {
07156 readonly attribute IVirtualBox parent;
07157
07161 attribute octet[] icon;
07162
07212 readonly attribute boolean accessible;
07213
07225 readonly attribute IVirtualBoxErrorInfo accessError;
07226
07266 attribute wstring name;
07267
07278 attribute wstring description;
07279
07283 readonly attribute wstringUUID id;
07284
07295 attribute wstring[] groups;
07296
07311 attribute wstring OSTypeId;
07312
07316 attribute wstring hardwareVersion;
07317
07327 attribute wstringUUID hardwareUUID;
07328
07332 attribute unsigned long CPUCount;
07333
07339 attribute boolean CPUHotPlugEnabled;
07340
07348 attribute unsigned long CPUExecutionCap;
07349
07353 attribute unsigned long memorySize;
07354
07358 attribute unsigned long memoryBalloonSize;
07359
07366 attribute boolean pageFusionEnabled;
07367
07371 attribute GraphicsControllerType graphicsControllerType;
07372
07376 attribute unsigned long VRAMSize;
07377
07383 attribute boolean accelerate3DEnabled;
07384
07390 attribute boolean accelerate2DVideoEnabled;
07391
07402 attribute unsigned long monitorCount;
07403
07409 attribute boolean videoCaptureEnabled;
07410
07416 attribute boolean[] videoCaptureScreens;
07417
07431 attribute wstring videoCaptureFile;
07432
07440 attribute unsigned long videoCaptureWidth;
07441
07449 attribute unsigned long videoCaptureHeight;
07450
07459 attribute unsigned long videoCaptureRate;
07460
07470 attribute unsigned long videoCaptureFPS;
07471
07475 readonly attribute IBIOSSettings BIOSSettings;
07476
07481 attribute FirmwareType firmwareType;
07482
07488 attribute PointingHIDType pointingHIDType;
07489
07495 attribute KeyboardHIDType keyboardHIDType;
07496
07503 attribute boolean HPETEnabled;
07504
07508 attribute ChipsetType chipsetType;
07509
07543 attribute wstring snapshotFolder;
07544
07548 readonly attribute IVRDEServer VRDEServer;
07549
07550 attribute boolean emulatedUSBCardReaderEnabled;
07551
07555 readonly attribute IMediumAttachment[] mediumAttachments;
07556
07568 readonly attribute IUSBController[] USBControllers;
07569
07581 readonly attribute IUSBDeviceFilters USBDeviceFilters;
07582
07586 readonly attribute IAudioAdapter audioAdapter;
07587
07591 readonly attribute IStorageController[] storageControllers;
07592
07598 readonly attribute wstring settingsFilePath;
07599
07624 readonly attribute boolean settingsModified;
07625
07629 readonly attribute SessionState sessionState;
07630
07643 readonly attribute wstring sessionType;
07644
07654 readonly attribute unsigned long sessionPID;
07655
07659 readonly attribute MachineState state;
07660
07667 readonly attribute long long lastStateChange;
07668
07680 readonly attribute wstring stateFilePath;
07681
07691 readonly attribute wstring logFolder;
07692
07703 readonly attribute ISnapshot currentSnapshot;
07704
07711 readonly attribute unsigned long snapshotCount;
07712
07744 readonly attribute boolean currentStateModified;
07745
07757 readonly attribute ISharedFolder[] sharedFolders;
07758
07765 attribute ClipboardMode clipboardMode;
07766
07772 attribute DragAndDropMode dragAndDropMode;
07773
07781 attribute wstring guestPropertyNotificationPatterns;
07782
07791 attribute boolean teleporterEnabled;
07792
07803 attribute unsigned long teleporterPort;
07804
07811 attribute wstring teleporterAddress;
07812
07823 attribute wstring teleporterPassword;
07824
07832 attribute FaultToleranceState faultToleranceState;
07833
07840 attribute unsigned long faultTolerancePort;
07841
07847 attribute wstring faultToleranceAddress;
07848
07856 attribute wstring faultTolerancePassword;
07857
07863 attribute unsigned long faultToleranceSyncInterval;
07864
07872 attribute boolean RTCUseUTC;
07873
07880 attribute boolean IOCacheEnabled;
07881
07887 attribute unsigned long IOCacheSize;
07888
07898 readonly attribute IPCIDeviceAttachment[] PCIDeviceAssignments;
07899
07905 readonly attribute IBandwidthControl bandwidthControl;
07906
07915 attribute boolean tracingEnabled;
07916
07931 attribute wstring tracingConfig;
07932
07945 attribute boolean allowTracingToAccessVM;
07946
07952 attribute boolean autostartEnabled;
07953
07959 attribute unsigned long autostartDelay;
07960
07966 attribute AutostopType autostopType;
07967
07983 attribute wstring defaultFrontend;
07984
07990 readonly attribute boolean USBProxyAvailable;
07991
08097 void lockMachine (
08098 in ISession session,
08099 in LockType lockType
08100 );
08101
08238 void launchVMProcess (
08239 in ISession session,
08240 in wstring type,
08241 in wstring environment,
08242 [retval] out IProgress progress
08243 );
08244
08282 void setBootOrder (
08283 in unsigned long position,
08284 in DeviceType device
08285 );
08286
08321 void getBootOrder (
08322 in unsigned long position,
08323 [retval] out DeviceType device
08324 );
08325
08427 void attachDevice (
08428 in wstring name,
08429 in long controllerPort,
08430 in long device,
08431 in DeviceType type,
08432 in IMedium medium
08433 );
08434
08530 void attachDeviceWithoutMedium (
08531 in wstring name,
08532 in long controllerPort,
08533 in long device,
08534 in DeviceType type
08535 );
08536
08590 void detachDevice (
08591 in wstring name,
08592 in long controllerPort,
08593 in long device
08594 );
08595
08638 void passthroughDevice (
08639 in wstring name,
08640 in long controllerPort,
08641 in long device,
08642 in boolean passthrough
08643 );
08644
08687 void temporaryEjectDevice (
08688 in wstring name,
08689 in long controllerPort,
08690 in long device,
08691 in boolean temporaryEject
08692 );
08693
08739 void nonRotationalDevice (
08740 in wstring name,
08741 in long controllerPort,
08742 in long device,
08743 in boolean nonRotational
08744 );
08745
08791 void setAutoDiscardForDevice (
08792 in wstring name,
08793 in long controllerPort,
08794 in long device,
08795 in boolean discard
08796 );
08797
08847 void setHotPluggableForDevice (
08848 in wstring name,
08849 in long controllerPort,
08850 in long device,
08851 in boolean hotPluggable
08852 );
08853
08894 void setBandwidthGroupForDevice (
08895 in wstring name,
08896 in long controllerPort,
08897 in long device,
08898 in IBandwidthGroup bandwidthGroup
08899 );
08900
08937 void setNoBandwidthGroupForDevice (
08938 in wstring name,
08939 in long controllerPort,
08940 in long device
08941 );
08942
09007 void unmountMedium (
09008 in wstring name,
09009 in long controllerPort,
09010 in long device,
09011 in boolean force
09012 );
09013
09076 void mountMedium (
09077 in wstring name,
09078 in long controllerPort,
09079 in long device,
09080 in IMedium medium,
09081 in boolean force
09082 );
09083
09112 void getMedium (
09113 in wstring name,
09114 in long controllerPort,
09115 in long device,
09116 [retval] out IMedium medium
09117 );
09118
09133 void getMediumAttachmentsOfController (
09134 in wstring name,
09135 [retval] out IMediumAttachment[] mediumAttachments
09136 );
09137
09152 void getMediumAttachment (
09153 in wstring name,
09154 in long controllerPort,
09155 in long device,
09156 [retval] out IMediumAttachment attachment
09157 );
09158
09199 void attachHostPCIDevice (
09200 in long hostAddress,
09201 in long desiredGuestAddress,
09202 in boolean tryToUnbind
09203 );
09204
09245 void detachHostPCIDevice (
09246 in long hostAddress
09247 );
09248
09266 void getNetworkAdapter (
09267 in unsigned long slot,
09268 [retval] out INetworkAdapter adapter
09269 );
09270
09303 void addStorageController (
09304 in wstring name,
09305 in StorageBus connectionType,
09306 [retval] out IStorageController controller
09307 );
09308
09322 void getStorageControllerByName (
09323 in wstring name,
09324 [retval] out IStorageController storageController
09325 );
09326
09340 void getStorageControllerByInstance (
09341 in unsigned long instance,
09342 [retval] out IStorageController storageController
09343 );
09344
09367 void removeStorageController (
09368 in wstring name
09369 );
09370
09392 void setStorageControllerBootable (
09393 in wstring name,
09394 in boolean bootable
09395 );
09396
09419 void addUSBController (
09420 in wstring name,
09421 in USBControllerType type,
09422 [retval] out IUSBController controller
09423 );
09424
09438 void removeUSBController (
09439 in wstring name
09440 );
09441
09455 void getUSBControllerByName (
09456 in wstring name,
09457 [retval] out IUSBController controller
09458 );
09459
09465 void getUSBControllerCountByType (
09466 in USBControllerType type,
09467 [retval] out unsigned long controllers
09468 );
09469
09487 void getSerialPort (
09488 in unsigned long slot,
09489 [retval] out ISerialPort port
09490 );
09491
09509 void getParallelPort (
09510 in unsigned long slot,
09511 [retval] out IParallelPort port
09512 );
09513
09522 void getExtraDataKeys (
09523 [retval] out wstring[] keys
09524 );
09525
09554 void getExtraData (
09555 in wstring key,
09556 [retval] out wstring value
09557 );
09558
09608 void setExtraData (
09609 in wstring key,
09610 in wstring value
09611 );
09612
09634 void getCPUProperty (
09635 in CPUPropertyType property,
09636 [retval] out boolean value
09637 );
09638
09660 void setCPUProperty (
09661 in CPUPropertyType property,
09662 in boolean value
09663 );
09664
09704 void getCPUIDLeaf (
09705 in unsigned long id,
09706 out unsigned long valEax,
09707 out unsigned long valEbx,
09708 out unsigned long valEcx,
09709 out unsigned long valEdx
09710 );
09711
09755 void setCPUIDLeaf (
09756 in unsigned long id,
09757 in unsigned long valEax,
09758 in unsigned long valEbx,
09759 in unsigned long valEcx,
09760 in unsigned long valEdx
09761 );
09762
09780 void removeCPUIDLeaf (
09781 in unsigned long id
09782 );
09783
09789 void removeAllCPUIDLeaves();
09790
09812 void getHWVirtExProperty (
09813 in HWVirtExPropertyType property,
09814 [retval] out boolean value
09815 );
09816
09838 void setHWVirtExProperty (
09839 in HWVirtExPropertyType property,
09840 in boolean value
09841 );
09842
09872 void setSettingsFilePath (
09873 in wstring settingsFilePath,
09874 [retval] out IProgress progress
09875 );
09876
09922 void saveSettings();
09923
09947 void discardSettings();
09948
10032 void unregister (
10033 in CleanupMode cleanupMode,
10034 [retval] out IMedium[] media
10035 );
10036
10093 void deleteConfig (
10094 in IMedium[] media,
10095 [retval] out IProgress progress
10096 );
10097
10109 void exportTo (
10110 in IAppliance appliance,
10111 in wstring location,
10112 [retval] out IVirtualSystemDescription description
10113 );
10114
10138 void findSnapshot (
10139 in wstring nameOrId,
10140 [retval] out ISnapshot snapshot
10141 );
10142
10176 void createSharedFolder (
10177 in wstring name,
10178 in wstring hostPath,
10179 in boolean writable,
10180 in boolean automount
10181 );
10182
10208 void removeSharedFolder (
10209 in wstring name
10210 );
10211
10235 void canShowConsoleWindow (
10236 [retval] out boolean canShow
10237 );
10238
10273 void showConsoleWindow (
10274 [retval] out long long winId
10275 );
10276
10309 void getGuestProperty (
10310 in wstring name,
10311 out wstring value,
10312 out long long timestamp,
10313 out wstring flags
10314 );
10315
10338 void getGuestPropertyValue (
10339 in wstring property,
10340 [retval] out wstring value
10341 );
10342
10365 void getGuestPropertyTimestamp (
10366 in wstring property,
10367 [retval] out long long value
10368 );
10369
10420 void setGuestProperty (
10421 in wstring property,
10422 in wstring value,
10423 in wstring flags
10424 );
10425
10465 void setGuestPropertyValue (
10466 in wstring property,
10467 in wstring value
10468 );
10469
10487 void deleteGuestProperty (
10488 in wstring name
10489 );
10490
10521 void enumerateGuestProperties (
10522 in wstring patterns,
10523 out wstring[] names,
10524 out wstring[] values,
10525 out long long[] timestamps,
10526 out wstring[] flags
10527 );
10528
10558 void querySavedGuestScreenInfo (
10559 in unsigned long screenId,
10560 out unsigned long originX,
10561 out unsigned long originY,
10562 out unsigned long width,
10563 out unsigned long height,
10564 out boolean enabled
10565 );
10566
10588 void querySavedThumbnailSize (
10589 in unsigned long screenId,
10590 out unsigned long size,
10591 out unsigned long width,
10592 out unsigned long height
10593 );
10594
10621 void readSavedThumbnailToArray (
10622 in unsigned long screenId,
10623 in boolean BGR,
10624 out unsigned long width,
10625 out unsigned long height,
10626 [retval] out octet[] data
10627 );
10628
10650 void readSavedThumbnailPNGToArray (
10651 in unsigned long screenId,
10652 out unsigned long width,
10653 out unsigned long height,
10654 [retval] out octet[] data
10655 );
10656
10678 void querySavedScreenshotPNGSize (
10679 in unsigned long screenId,
10680 out unsigned long size,
10681 out unsigned long width,
10682 out unsigned long height
10683 );
10684
10706 void readSavedScreenshotPNGToArray (
10707 in unsigned long screenId,
10708 out unsigned long width,
10709 out unsigned long height,
10710 [retval] out octet[] data
10711 );
10712
10722 void hotPlugCPU (
10723 in unsigned long cpu
10724 );
10725
10735 void hotUnplugCPU (
10736 in unsigned long cpu
10737 );
10738
10752 void getCPUStatus (
10753 in unsigned long cpu,
10754 [retval] out boolean attached
10755 );
10756
10771 void queryLogFilename (
10772 in unsigned long idx,
10773 [retval] out wstring filename
10774 );
10775
10801 void readLog (
10802 in unsigned long idx,
10803 in long long offset,
10804 in long long size,
10805 [retval] out octet[] data
10806 );
10807
10840 void cloneTo (
10841 in IMachine target,
10842 in CloneMode mode,
10843 in CloneOptions[] options,
10844 [retval] out IProgress progress
10845 );
10846
10847 };
10848
10856 interface IEmulatedUSB : $unknown
10857 {
10861 readonly attribute wstring[] webcams;
10862
10872 void webcamAttach (
10873 in wstring path,
10874 in wstring settings
10875 );
10876
10884 void webcamDetach (
10885 in wstring path
10886 );
10887
10888 };
10889
10898 interface IVRDEServerInfo : $unknown
10899 {
10905 readonly attribute boolean active;
10906
10915 readonly attribute long port;
10916
10922 readonly attribute unsigned long numberOfClients;
10923
10929 readonly attribute long long beginTime;
10930
10937 readonly attribute long long endTime;
10938
10944 readonly attribute long long bytesSent;
10945
10951 readonly attribute long long bytesSentTotal;
10952
10958 readonly attribute long long bytesReceived;
10959
10965 readonly attribute long long bytesReceivedTotal;
10966
10972 readonly attribute wstring user;
10973
10979 readonly attribute wstring domain;
10980
10986 readonly attribute wstring clientName;
10987
10993 readonly attribute wstring clientIP;
10994
11000 readonly attribute unsigned long clientVersion;
11001
11009 readonly attribute unsigned long encryptionStyle;
11010
11011 };
11012
11034 interface IConsole : $unknown
11035 {
11047 readonly attribute IMachine machine;
11048
11062 readonly attribute MachineState state;
11063
11067 readonly attribute IGuest guest;
11068
11079 readonly attribute IKeyboard keyboard;
11080
11091 readonly attribute IMouse mouse;
11092
11102 readonly attribute IDisplay display;
11103
11107 readonly attribute IMachineDebugger debugger;
11108
11119 readonly attribute IUSBDevice[] USBDevices;
11120
11128 readonly attribute IHostUSBDevice[] remoteUSBDevices;
11129
11145 readonly attribute ISharedFolder[] sharedFolders;
11146
11152 readonly attribute IVRDEServerInfo VRDEServerInfo;
11153
11159 readonly attribute IEventSource eventSource;
11160
11164 readonly attribute IPCIDeviceAttachment[] attachedPCIDevices;
11165
11174 attribute boolean useHostClipboard;
11175
11181 readonly attribute IEmulatedUSB emulatedUSB;
11182
11247 void powerUp (
11248 [retval] out IProgress progress
11249 );
11250
11284 void powerUpPaused (
11285 [retval] out IProgress progress
11286 );
11287
11307 void powerDown (
11308 [retval] out IProgress progress
11309 );
11310
11330 void reset();
11331
11351 void pause();
11352
11372 void resume();
11373
11393 void powerButton();
11394
11414 void sleepButton();
11415
11427 void getPowerButtonHandled (
11428 [retval] out boolean handled
11429 );
11430
11444 void getGuestEnteredACPIMode (
11445 [retval] out boolean entered
11446 );
11447
11500 void saveState (
11501 [retval] out IProgress progress
11502 );
11503
11536 void adoptSavedState (
11537 in wstring savedStateFile
11538 );
11539
11570 void discardSavedState (
11571 in boolean fRemoveFile
11572 );
11573
11586 void getDeviceActivity (
11587 in DeviceType type,
11588 [retval] out DeviceActivity activity
11589 );
11590
11628 void attachUSBDevice (
11629 in wstringUUID id
11630 );
11631
11666 void detachUSBDevice (
11667 in wstringUUID id,
11668 [retval] out IUSBDevice device
11669 );
11670
11693 void findUSBDeviceByAddress (
11694 in wstring name,
11695 [retval] out IUSBDevice device
11696 );
11697
11717 void findUSBDeviceById (
11718 in wstringUUID id,
11719 [retval] out IUSBDevice device
11720 );
11721
11755 void createSharedFolder (
11756 in wstring name,
11757 in wstring hostPath,
11758 in boolean writable,
11759 in boolean automount
11760 );
11761
11786 void removeSharedFolder (
11787 in wstring name
11788 );
11789
11827 void takeSnapshot (
11828 in wstring name,
11829 in wstring description,
11830 [retval] out IProgress progress
11831 );
11832
11905 void deleteSnapshot (
11906 in wstringUUID id,
11907 [retval] out IProgress progress
11908 );
11909
11949 void deleteSnapshotAndAllChildren (
11950 in wstringUUID id,
11951 [retval] out IProgress progress
11952 );
11953
11997 void deleteSnapshotRange (
11998 in wstringUUID startId,
11999 in wstringUUID endId,
12000 [retval] out IProgress progress
12001 );
12002
12043 void restoreSnapshot (
12044 in ISnapshot snapshot,
12045 [retval] out IProgress progress
12046 );
12047
12086 void teleport (
12087 in wstring hostname,
12088 in unsigned long tcpport,
12089 in wstring password,
12090 in unsigned long maxDowntime,
12091 [retval] out IProgress progress
12092 );
12093
12094 };
12095
12106 interface IHostNetworkInterface : $unknown
12107 {
12111 readonly attribute wstring name;
12112
12116 readonly attribute wstring shortName;
12117
12121 readonly attribute wstringUUID id;
12122
12126 readonly attribute wstring networkName;
12127
12131 readonly attribute boolean DHCPEnabled;
12132
12136 readonly attribute wstring IPAddress;
12137
12141 readonly attribute wstring networkMask;
12142
12146 readonly attribute boolean IPV6Supported;
12147
12151 readonly attribute wstring IPV6Address;
12152
12156 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
12157
12161 readonly attribute wstring hardwareAddress;
12162
12166 readonly attribute HostNetworkInterfaceMediumType mediumType;
12167
12171 readonly attribute HostNetworkInterfaceStatus status;
12172
12176 readonly attribute HostNetworkInterfaceType interfaceType;
12177
12189 void enableStaticIPConfig (
12190 in wstring IPAddress,
12191 in wstring networkMask
12192 );
12193
12205 void enableStaticIPConfigV6 (
12206 in wstring IPV6Address,
12207 in unsigned long IPV6NetworkMaskPrefixLength
12208 );
12209
12213 void enableDynamicIPConfig();
12214
12218 void DHCPRediscover();
12219
12220 };
12221
12229 interface IHostVideoInputDevice : $unknown
12230 {
12234 readonly attribute wstring name;
12235
12239 readonly attribute wstring path;
12240
12244 readonly attribute wstring alias;
12245
12246 };
12247
12264 interface IHost : $unknown
12265 {
12269 readonly attribute IMedium[] DVDDrives;
12270
12274 readonly attribute IMedium[] floppyDrives;
12275
12289 readonly attribute IHostUSBDevice[] USBDevices;
12290
12314 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
12315
12319 readonly attribute IHostNetworkInterface[] networkInterfaces;
12320
12324 readonly attribute wstring[] nameServers;
12325
12329 readonly attribute wstring domainName;
12330
12334 readonly attribute wstring[] searchStrings;
12335
12339 readonly attribute unsigned long processorCount;
12340
12344 readonly attribute unsigned long processorOnlineCount;
12345
12349 readonly attribute unsigned long processorCoreCount;
12350
12354 readonly attribute unsigned long processorOnlineCoreCount;
12355
12359 readonly attribute unsigned long memorySize;
12360
12364 readonly attribute unsigned long memoryAvailable;
12365
12369 readonly attribute wstring operatingSystem;
12370
12374 readonly attribute wstring OSVersion;
12375
12379 readonly attribute long long UTCTime;
12380
12384 readonly attribute boolean acceleration3DAvailable;
12385
12389 readonly attribute IHostVideoInputDevice[] videoInputDevices;
12390
12405 void getProcessorSpeed (
12406 in unsigned long cpuId,
12407 [retval] out unsigned long speed
12408 );
12409
12421 void getProcessorFeature (
12422 in ProcessorFeature feature,
12423 [retval] out boolean supported
12424 );
12425
12444 void getProcessorDescription (
12445 in unsigned long cpuId,
12446 [retval] out wstring description
12447 );
12448
12489 void getProcessorCPUIDLeaf (
12490 in unsigned long cpuId,
12491 in unsigned long leaf,
12492 in unsigned long subLeaf,
12493 out unsigned long valEax,
12494 out unsigned long valEbx,
12495 out unsigned long valEcx,
12496 out unsigned long valEdx
12497 );
12498
12519 void createHostOnlyNetworkInterface (
12520 out IHostNetworkInterface hostInterface,
12521 [retval] out IProgress progress
12522 );
12523
12544 void removeHostOnlyNetworkInterface (
12545 in wstringUUID id,
12546 [retval] out IProgress progress
12547 );
12548
12568 void createUSBDeviceFilter (
12569 in wstring name,
12570 [retval] out IHostUSBDeviceFilter filter
12571 );
12572
12615 void insertUSBDeviceFilter (
12616 in unsigned long position,
12617 in IHostUSBDeviceFilter filter
12618 );
12619
12647 void removeUSBDeviceFilter (
12648 in unsigned long position
12649 );
12650
12668 void findHostDVDDrive (
12669 in wstring name,
12670 [retval] out IMedium drive
12671 );
12672
12690 void findHostFloppyDrive (
12691 in wstring name,
12692 [retval] out IMedium drive
12693 );
12694
12710 void findHostNetworkInterfaceByName (
12711 in wstring name,
12712 [retval] out IHostNetworkInterface networkInterface
12713 );
12714
12730 void findHostNetworkInterfaceById (
12731 in wstringUUID id,
12732 [retval] out IHostNetworkInterface networkInterface
12733 );
12734
12744 void findHostNetworkInterfacesOfType (
12745 in HostNetworkInterfaceType type,
12746 [retval] out IHostNetworkInterface[] networkInterfaces
12747 );
12748
12768 void findUSBDeviceById (
12769 in wstringUUID id,
12770 [retval] out IHostUSBDevice device
12771 );
12772
12795 void findUSBDeviceByAddress (
12796 in wstring name,
12797 [retval] out IHostUSBDevice device
12798 );
12799
12807 void generateMACAddress (
12808 [retval] out wstring address
12809 );
12810
12811 };
12812
12825 interface ISystemProperties : $unknown
12826 {
12830 readonly attribute unsigned long minGuestRAM;
12831
12835 readonly attribute unsigned long maxGuestRAM;
12836
12840 readonly attribute unsigned long minGuestVRAM;
12841
12845 readonly attribute unsigned long maxGuestVRAM;
12846
12850 readonly attribute unsigned long minGuestCPUCount;
12851
12855 readonly attribute unsigned long maxGuestCPUCount;
12856
12860 readonly attribute unsigned long maxGuestMonitors;
12861
12866 readonly attribute long long infoVDSize;
12867
12874 readonly attribute unsigned long serialPortCount;
12875
12882 readonly attribute unsigned long parallelPortCount;
12883
12893 readonly attribute unsigned long maxBootPosition;
12894
12903 attribute boolean exclusiveHwVirt;
12904
12928 attribute wstring defaultMachineFolder;
12929
12935 attribute wstring loggingLevel;
12936
12961 readonly attribute IMediumFormat[] mediumFormats;
12962
12996 attribute wstring defaultHardDiskFormat;
12997
13003 attribute long long freeDiskSpaceWarning;
13004
13009 attribute unsigned long freeDiskSpacePercentWarning;
13010
13016 attribute long long freeDiskSpaceError;
13017
13022 attribute unsigned long freeDiskSpacePercentError;
13023
13047 attribute wstring VRDEAuthLibrary;
13048
13077 attribute wstring webServiceAuthLibrary;
13078
13092 attribute wstring defaultVRDEExtPack;
13093
13099 attribute unsigned long logHistoryCount;
13100
13105 readonly attribute AudioDriverType defaultAudioDriver;
13106
13113 attribute wstring autostartDatabasePath;
13114
13121 attribute wstring defaultAdditionsISO;
13122
13137 attribute wstring defaultFrontend;
13138
13149 void getMaxNetworkAdapters (
13150 in ChipsetType chipset,
13151 [retval] out unsigned long maxNetworkAdapters
13152 );
13153
13167 void getMaxNetworkAdaptersOfType (
13168 in ChipsetType chipset,
13169 in NetworkAttachmentType type,
13170 [retval] out unsigned long maxNetworkAdapters
13171 );
13172
13182 void getMaxDevicesPerPortForStorageBus (
13183 in StorageBus bus,
13184 [retval] out unsigned long maxDevicesPerPort
13185 );
13186
13194 void getMinPortCountForStorageBus (
13195 in StorageBus bus,
13196 [retval] out unsigned long minPortCount
13197 );
13198
13206 void getMaxPortCountForStorageBus (
13207 in StorageBus bus,
13208 [retval] out unsigned long maxPortCount
13209 );
13210
13223 void getMaxInstancesOfStorageBus (
13224 in ChipsetType chipset,
13225 in StorageBus bus,
13226 [retval] out unsigned long maxInstances
13227 );
13228
13238 void getDeviceTypesForStorageBus (
13239 in StorageBus bus,
13240 [retval] out DeviceType[] deviceTypes
13241 );
13242
13251 void getDefaultIoCacheSettingForStorageController (
13252 in StorageControllerType controllerType,
13253 [retval] out boolean enabled
13254 );
13255
13268 void getMaxInstancesOfUSBControllerType (
13269 in ChipsetType chipset,
13270 in USBControllerType type,
13271 [retval] out unsigned long maxInstances
13272 );
13273
13274 };
13275
13281 interface IGuestOSType : $unknown
13282 {
13286 readonly attribute wstring familyId;
13287
13291 readonly attribute wstring familyDescription;
13292
13296 readonly attribute wstring id;
13297
13301 readonly attribute wstring description;
13302
13306 readonly attribute boolean is64Bit;
13307
13311 readonly attribute boolean recommendedIOAPIC;
13312
13316 readonly attribute boolean recommendedVirtEx;
13317
13321 readonly attribute unsigned long recommendedRAM;
13322
13326 readonly attribute unsigned long recommendedVRAM;
13327
13331 readonly attribute boolean recommended2DVideoAcceleration;
13332
13336 readonly attribute boolean recommended3DAcceleration;
13337
13341 readonly attribute long long recommendedHDD;
13342
13346 readonly attribute NetworkAdapterType adapterType;
13347
13351 readonly attribute boolean recommendedPAE;
13352
13356 readonly attribute StorageControllerType recommendedDVDStorageController;
13357
13361 readonly attribute StorageBus recommendedDVDStorageBus;
13362
13366 readonly attribute StorageControllerType recommendedHDStorageController;
13367
13371 readonly attribute StorageBus recommendedHDStorageBus;
13372
13376 readonly attribute FirmwareType recommendedFirmware;
13377
13381 readonly attribute boolean recommendedUSBHID;
13382
13386 readonly attribute boolean recommendedHPET;
13387
13391 readonly attribute boolean recommendedUSBTablet;
13392
13396 readonly attribute boolean recommendedRTCUseUTC;
13397
13401 readonly attribute ChipsetType recommendedChipset;
13402
13406 readonly attribute AudioControllerType recommendedAudioController;
13407
13411 readonly attribute boolean recommendedFloppy;
13412
13416 readonly attribute boolean recommendedUSB;
13417
13418 };
13419
13427 interface IAdditionsFacility : $unknown
13428 {
13432 readonly attribute AdditionsFacilityClass classType;
13433
13440 readonly attribute long long lastUpdated;
13441
13445 readonly attribute wstring name;
13446
13450 readonly attribute AdditionsFacilityStatus status;
13451
13455 readonly attribute AdditionsFacilityType type;
13456
13457 };
13458
13487 interface IGuestSession : $unknown
13488 {
13494 readonly attribute wstring user;
13495
13501 readonly attribute wstring domain;
13502
13506 readonly attribute wstring name;
13507
13511 readonly attribute unsigned long id;
13512
13525 attribute unsigned long timeout;
13526
13531 readonly attribute unsigned long protocolVersion;
13532
13536 readonly attribute GuestSessionStatus status;
13537
13543 attribute wstring[] environment;
13544
13550 readonly attribute IGuestProcess[] processes;
13551
13557 readonly attribute IGuestDirectory[] directories;
13558
13564 readonly attribute IGuestFile[] files;
13565
13571 readonly attribute IEventSource eventSource;
13572
13581 void close();
13582
13604 void copyFrom (
13605 in wstring source,
13606 in wstring dest,
13607 in CopyFileFlag[] flags,
13608 [retval] out IProgress progress
13609 );
13610
13632 void copyTo (
13633 in wstring source,
13634 in wstring dest,
13635 in CopyFileFlag[] flags,
13636 [retval] out IProgress progress
13637 );
13638
13658 void directoryCreate (
13659 in wstring path,
13660 in unsigned long mode,
13661 in DirectoryCreateFlag[] flags
13662 );
13663
13715 void directoryCreateTemp (
13716 in wstring templateName,
13717 in unsigned long mode,
13718 in wstring path,
13719 in boolean secure,
13720 [retval] out wstring directory
13721 );
13722
13740 void directoryExists (
13741 in wstring path,
13742 [retval] out boolean exists
13743 );
13744
13775 void directoryOpen (
13776 in wstring path,
13777 in wstring filter,
13778 in DirectoryOpenFlag[] flags,
13779 [retval] out IGuestDirectory directory
13780 );
13781
13807 void directoryQueryInfo (
13808 in wstring path,
13809 [retval] out IGuestFsObjInfo info
13810 );
13811
13827 void directoryRemove (
13828 in wstring path
13829 );
13830
13850 void directoryRemoveRecursive (
13851 in wstring path,
13852 in DirectoryRemoveRecFlag[] flags,
13853 [retval] out IProgress progress
13854 );
13855
13875 void directoryRename (
13876 in wstring source,
13877 in wstring dest,
13878 in PathRenameFlag[] flags
13879 );
13880
13898 void directorySetACL (
13899 in wstring path,
13900 in wstring acl
13901 );
13902
13916 void environmentClear();
13917
13938 void environmentGet (
13939 in wstring name,
13940 [retval] out wstring value
13941 );
13942
13960 void environmentSet (
13961 in wstring name,
13962 in wstring value
13963 );
13964
13980 void environmentUnset (
13981 in wstring name
13982 );
13983
14037 void fileCreateTemp (
14038 in wstring templateName,
14039 in unsigned long mode,
14040 in wstring path,
14041 in boolean secure,
14042 [retval] out IGuestFile file
14043 );
14044
14062 void fileExists (
14063 in wstring path,
14064 [retval] out boolean exists
14065 );
14066
14090 void fileRemove (
14091 in wstring path
14092 );
14093
14155 void fileOpen (
14156 in wstring path,
14157 in wstring openMode,
14158 in wstring disposition,
14159 in unsigned long creationMode,
14160 [retval] out IGuestFile file
14161 );
14162
14229 void fileOpenEx (
14230 in wstring path,
14231 in wstring openMode,
14232 in wstring disposition,
14233 in wstring sharingMode,
14234 in unsigned long creationMode,
14235 in long long offset,
14236 [retval] out IGuestFile file
14237 );
14238
14264 void fileQueryInfo (
14265 in wstring path,
14266 [retval] out IGuestFsObjInfo info
14267 );
14268
14294 void fileQuerySize (
14295 in wstring path,
14296 [retval] out long long size
14297 );
14298
14318 void fileRename (
14319 in wstring source,
14320 in wstring dest,
14321 in PathRenameFlag[] flags
14322 );
14323
14341 void fileSetACL (
14342 in wstring file,
14343 in wstring acl
14344 );
14345
14400 void processCreate (
14401 in wstring command,
14402 in wstring[] arguments,
14403 in wstring[] environment,
14404 in ProcessCreateFlag[] flags,
14405 in unsigned long timeoutMS,
14406 [retval] out IGuestProcess guestProcess
14407 );
14408
14450 void processCreateEx (
14451 in wstring command,
14452 in wstring[] arguments,
14453 in wstring[] environment,
14454 in ProcessCreateFlag[] flags,
14455 in unsigned long timeoutMS,
14456 in ProcessPriority priority,
14457 in long[] affinity,
14458 [retval] out IGuestProcess guestProcess
14459 );
14460
14470 void processGet (
14471 in unsigned long pid,
14472 [retval] out IGuestProcess guestProcess
14473 );
14474
14497 void symlinkCreate (
14498 in wstring source,
14499 in wstring target,
14500 in SymlinkType type
14501 );
14502
14520 void symlinkExists (
14521 in wstring symlink,
14522 [retval] out boolean exists
14523 );
14524
14548 void symlinkRead (
14549 in wstring symlink,
14550 in SymlinkReadFlag[] flags,
14551 [retval] out wstring target
14552 );
14553
14569 void symlinkRemoveDirectory (
14570 in wstring path
14571 );
14572
14588 void symlinkRemoveFile (
14589 in wstring file
14590 );
14591
14612 void waitFor (
14613 in unsigned long waitFor,
14614 in unsigned long timeoutMS,
14615 [retval] out GuestSessionWaitResult reason
14616 );
14617
14639 void waitForArray (
14640 in GuestSessionWaitForFlag[] waitFor,
14641 in unsigned long timeoutMS,
14642 [retval] out GuestSessionWaitResult reason
14643 );
14644
14645 };
14646
14654 interface IProcess : $unknown
14655 {
14661 readonly attribute wstring[] arguments;
14662
14668 readonly attribute wstring[] environment;
14669
14675 readonly attribute IEventSource eventSource;
14676
14680 readonly attribute wstring executablePath;
14681
14688 readonly attribute long exitCode;
14689
14695 readonly attribute wstring name;
14696
14702 readonly attribute unsigned long PID;
14703
14710 readonly attribute ProcessStatus status;
14711
14732 void waitFor (
14733 in unsigned long waitFor,
14734 in unsigned long timeoutMS,
14735 [retval] out ProcessWaitResult reason
14736 );
14737
14759 void waitForArray (
14760 in ProcessWaitForFlag[] waitFor,
14761 in unsigned long timeoutMS,
14762 [retval] out ProcessWaitResult reason
14763 );
14764
14781 void read (
14782 in unsigned long handle,
14783 in unsigned long toRead,
14784 in unsigned long timeoutMS,
14785 [retval] out octet[] data
14786 );
14787
14811 void write (
14812 in unsigned long handle,
14813 in unsigned long flags,
14814 in octet[] data,
14815 in unsigned long timeoutMS,
14816 [retval] out unsigned long written
14817 );
14818
14843 void writeArray (
14844 in unsigned long handle,
14845 in ProcessInputFlag[] flags,
14846 in octet[] data,
14847 in unsigned long timeoutMS,
14848 [retval] out unsigned long written
14849 );
14850
14860 void terminate();
14861
14862 };
14863
14872 interface IGuestProcess : IProcess
14873 {
14874 };
14875
14883 interface IDirectory : $unknown
14884 {
14890 readonly attribute wstring directoryName;
14891
14897 readonly attribute wstring filter;
14898
14905 void close();
14906
14922 void read (
14923 [retval] out IFsObjInfo objInfo
14924 );
14925
14926 };
14927
14936 interface IGuestDirectory : IDirectory
14937 {
14938 };
14939
14947 interface IFile : $unknown
14948 {
14954 readonly attribute unsigned long creationMode;
14955
14961 readonly attribute wstring disposition;
14962
14968 readonly attribute IEventSource eventSource;
14969
14975 readonly attribute wstring fileName;
14976
14982 readonly attribute unsigned long id;
14983
14989 readonly attribute long long initialSize;
14990
14996 readonly attribute wstring openMode;
14997
15003 readonly attribute long long offset;
15004
15010 readonly attribute FileStatus status;
15011
15018 void close();
15019
15036 void queryInfo (
15037 [retval] out IFsObjInfo objInfo
15038 );
15039
15062 void read (
15063 in unsigned long toRead,
15064 in unsigned long timeoutMS,
15065 [retval] out octet[] data
15066 );
15067
15092 void readAt (
15093 in long long offset,
15094 in unsigned long toRead,
15095 in unsigned long timeoutMS,
15096 [retval] out octet[] data
15097 );
15098
15118 void seek (
15119 in long long offset,
15120 in FileSeekType whence
15121 );
15122
15138 void setACL (
15139 in wstring acl
15140 );
15141
15159 void write (
15160 in octet[] data,
15161 in unsigned long timeoutMS,
15162 [retval] out unsigned long written
15163 );
15164
15192 void writeAt (
15193 in long long offset,
15194 in octet[] data,
15195 in unsigned long timeoutMS,
15196 [retval] out unsigned long written
15197 );
15198
15199 };
15200
15209 interface IGuestFile : IFile
15210 {
15211 };
15212
15221 interface IFsObjInfo : $unknown
15222 {
15228 readonly attribute long long accessTime;
15229
15235 readonly attribute long long allocatedSize;
15236
15242 readonly attribute long long birthTime;
15243
15249 readonly attribute long long changeTime;
15250
15256 readonly attribute unsigned long deviceNumber;
15257
15263 readonly attribute wstring fileAttributes;
15264
15270 readonly attribute unsigned long generationId;
15271
15277 readonly attribute unsigned long GID;
15278
15284 readonly attribute wstring groupName;
15285
15291 readonly attribute unsigned long hardLinks;
15292
15298 readonly attribute long long modificationTime;
15299
15305 readonly attribute wstring name;
15306
15312 readonly attribute long long nodeId;
15313
15319 readonly attribute unsigned long nodeIdDevice;
15320
15328 readonly attribute long long objectSize;
15329
15335 readonly attribute FsObjType type;
15336
15342 readonly attribute unsigned long UID;
15343
15349 readonly attribute unsigned long userFlags;
15350
15356 readonly attribute wstring userName;
15357
15358 };
15359
15368 interface IGuestFsObjInfo : IFsObjInfo
15369 {
15370 };
15371
15385 interface IGuest : $unknown
15386 {
15401 readonly attribute wstring OSTypeId;
15402
15408 readonly attribute AdditionsRunLevelType additionsRunLevel;
15409
15416 readonly attribute wstring additionsVersion;
15417
15425 readonly attribute unsigned long additionsRevision;
15426
15432 readonly attribute IEventSource eventSource;
15433
15440 readonly attribute IAdditionsFacility[] facilities;
15441
15445 readonly attribute IGuestSession[] sessions;
15446
15450 attribute unsigned long memoryBalloonSize;
15451
15455 attribute unsigned long statisticsUpdateInterval;
15456
15488 void internalGetStatistics (
15489 out unsigned long cpuUser,
15490 out unsigned long cpuKernel,
15491 out unsigned long cpuIdle,
15492 out unsigned long memTotal,
15493 out unsigned long memFree,
15494 out unsigned long memBalloon,
15495 out unsigned long memShared,
15496 out unsigned long memCache,
15497 out unsigned long pagedTotal,
15498 out unsigned long memAllocTotal,
15499 out unsigned long memFreeTotal,
15500 out unsigned long memBalloonTotal,
15501 out unsigned long memSharedTotal
15502 );
15503
15515 void getFacilityStatus (
15516 in AdditionsFacilityType facility,
15517 out long long timestamp,
15518 [retval] out AdditionsFacilityStatus status
15519 );
15520
15538 void getAdditionsStatus (
15539 in AdditionsRunLevelType level,
15540 [retval] out boolean active
15541 );
15542
15572 void setCredentials (
15573 in wstring userName,
15574 in wstring password,
15575 in wstring domain,
15576 in boolean allowInteractiveLogon
15577 );
15578
15608 void dragHGEnter (
15609 in unsigned long screenId,
15610 in unsigned long y,
15611 in unsigned long x,
15612 in DragAndDropAction defaultAction,
15613 in DragAndDropAction[] allowedActions,
15614 in wstring[] formats,
15615 [retval] out DragAndDropAction resultAction
15616 );
15617
15647 void dragHGMove (
15648 in unsigned long screenId,
15649 in unsigned long x,
15650 in unsigned long y,
15651 in DragAndDropAction defaultAction,
15652 in DragAndDropAction[] allowedActions,
15653 in wstring[] formats,
15654 [retval] out DragAndDropAction resultAction
15655 );
15656
15674 void dragHGLeave (
15675 in unsigned long screenId
15676 );
15677
15709 void dragHGDrop (
15710 in unsigned long screenId,
15711 in unsigned long x,
15712 in unsigned long y,
15713 in DragAndDropAction defaultAction,
15714 in DragAndDropAction[] allowedActions,
15715 in wstring[] formats,
15716 out wstring format,
15717 [retval] out DragAndDropAction resultAction
15718 );
15719
15743 void dragHGPutData (
15744 in unsigned long screenId,
15745 in wstring format,
15746 in octet[] data,
15747 [retval] out IProgress progress
15748 );
15749
15775 void dragGHPending (
15776 in unsigned long screenId,
15777 out wstring[] formats,
15778 out DragAndDropAction[] allowedActions,
15779 [retval] out DragAndDropAction defaultAction
15780 );
15781
15803 void dragGHDropped (
15804 in wstring format,
15805 in DragAndDropAction action,
15806 [retval] out IProgress progress
15807 );
15808
15826 void dragGHGetData (
15827 [retval] out octet[] data
15828 );
15829
15888 void createSession (
15889 in wstring user,
15890 in wstring password,
15891 in wstring domain,
15892 in wstring sessionName,
15893 [retval] out IGuestSession guestSession
15894 );
15895
15910 void findSession (
15911 in wstring sessionName,
15912 [retval] out IGuestSession[] sessions
15913 );
15914
15964 void updateGuestAdditions (
15965 in wstring source,
15966 in wstring[] arguments,
15967 in AdditionsUpdateFlag[] flags,
15968 [retval] out IProgress progress
15969 );
15970
15971 };
15972
16013 interface IProgress : $unknown
16014 {
16018 readonly attribute wstringUUID id;
16019
16023 readonly attribute wstring description;
16024
16028 readonly attribute $unknown initiator;
16029
16033 readonly attribute boolean cancelable;
16034
16042 readonly attribute unsigned long percent;
16043
16057 readonly attribute long timeRemaining;
16058
16062 readonly attribute boolean completed;
16063
16067 readonly attribute boolean canceled;
16068
16075 readonly attribute long resultCode;
16076
16086 readonly attribute IVirtualBoxErrorInfo errorInfo;
16087
16094 readonly attribute unsigned long operationCount;
16095
16099 readonly attribute unsigned long operation;
16100
16106 readonly attribute wstring operationDescription;
16107
16111 readonly attribute unsigned long operationPercent;
16112
16116 readonly attribute unsigned long operationWeight;
16117
16125 attribute unsigned long timeout;
16126
16130 void setCurrentOperationProgress (
16131 in unsigned long percent
16132 );
16133
16137 void setNextOperation (
16138 in wstring nextOperationDescription,
16139 in unsigned long nextOperationsWeight
16140 );
16141
16168 void waitForCompletion (
16169 in long timeout
16170 );
16171
16195 void waitForOperationCompletion (
16196 in unsigned long operation,
16197 in long timeout
16198 );
16199
16225 void waitForAsyncProgressCompletion (
16226 in IProgress pProgressAsync
16227 );
16228
16245 void cancel();
16246
16247 };
16248
16332 interface ISnapshot : $unknown
16333 {
16337 readonly attribute wstringUUID id;
16338
16346 attribute wstring name;
16347
16355 attribute wstring description;
16356
16362 readonly attribute long long timeStamp;
16363
16375 readonly attribute boolean online;
16376
16388 readonly attribute IMachine machine;
16389
16396 readonly attribute ISnapshot parent;
16397
16406 readonly attribute ISnapshot[] children;
16407
16415 void getChildrenCount (
16416 [retval] out unsigned long childrenCount
16417 );
16418
16419 };
16420
16607 interface IMediumAttachment : $unknown
16608 {
16613 readonly attribute IMedium medium;
16614
16620 readonly attribute wstring controller;
16621
16627 readonly attribute long port;
16628
16634 readonly attribute long device;
16635
16639 readonly attribute DeviceType type;
16640
16644 readonly attribute boolean passthrough;
16645
16649 readonly attribute boolean temporaryEject;
16650
16655 readonly attribute boolean isEjected;
16656
16660 readonly attribute boolean nonRotational;
16661
16665 readonly attribute boolean discard;
16666
16670 readonly attribute boolean hotPluggable;
16671
16675 readonly attribute IBandwidthGroup bandwidthGroup;
16676
16677 };
16678
16836 interface IMedium : $unknown
16837 {
16851 readonly attribute wstringUUID id;
16852
16871 attribute wstring description;
16872
16888 readonly attribute MediumState state;
16889
16898 readonly attribute MediumVariant[] variant;
16899
16909 readonly attribute wstring location;
16910
16930 readonly attribute wstring name;
16931
16936 readonly attribute DeviceType deviceType;
16937
16941 readonly attribute boolean hostDrive;
16942
16955 readonly attribute long long size;
16956
16971 readonly attribute wstring format;
16972
16988 readonly attribute IMediumFormat mediumFormat;
16989
17014 attribute MediumType type;
17015
17029 readonly attribute MediumType[] allowedTypes;
17030
17040 readonly attribute IMedium parent;
17041
17049 readonly attribute IMedium[] children;
17050
17061 readonly attribute IMedium base;
17062
17095 readonly attribute boolean readOnly;
17096
17112 readonly attribute long long logicalSize;
17113
17141 attribute boolean autoReset;
17142
17157 readonly attribute wstring lastAccessError;
17158
17175 readonly attribute wstringUUID[] machineIds;
17176
17202 void setIds (
17203 in boolean setImageId,
17204 in wstringUUID imageId,
17205 in boolean setParentId,
17206 in wstringUUID parentId
17207 );
17208
17243 void refreshState (
17244 [retval] out MediumState state
17245 );
17246
17273 void getSnapshotIds (
17274 in wstringUUID machineId,
17275 [retval] out wstringUUID[] snapshotIds
17276 );
17277
17340 void lockRead (
17341 [retval] out IToken token
17342 );
17343
17398 void lockWrite (
17399 [retval] out IToken token
17400 );
17401
17451 void close();
17452
17482 void getProperty (
17483 in wstring name,
17484 [retval] out wstring value
17485 );
17486
17518 void setProperty (
17519 in wstring name,
17520 in wstring value
17521 );
17522
17557 void getProperties (
17558 in wstring names,
17559 out wstring[] returnNames,
17560 [retval] out wstring[] returnValues
17561 );
17562
17592 void setProperties (
17593 in wstring[] names,
17594 in wstring[] values
17595 );
17596
17629 void createBaseStorage (
17630 in long long logicalSize,
17631 in MediumVariant[] variant,
17632 [retval] out IProgress progress
17633 );
17634
17686 void deleteStorage (
17687 [retval] out IProgress progress
17688 );
17689
17728 void createDiffStorage (
17729 in IMedium target,
17730 in MediumVariant[] variant,
17731 [retval] out IProgress progress
17732 );
17733
17809 void mergeTo (
17810 in IMedium target,
17811 [retval] out IProgress progress
17812 );
17813
17863 void cloneTo (
17864 in IMedium target,
17865 in MediumVariant[] variant,
17866 in IMedium parent,
17867 [retval] out IProgress progress
17868 );
17869
17916 void cloneToBase (
17917 in IMedium target,
17918 in MediumVariant[] variant,
17919 [retval] out IProgress progress
17920 );
17921
17963 void setLocation (
17964 in wstring location,
17965 [retval] out IProgress progress
17966 );
17967
17996 void compact (
17997 [retval] out IProgress progress
17998 );
17999
18032 void resize (
18033 in long long logicalSize,
18034 [retval] out IProgress progress
18035 );
18036
18070 void reset (
18071 [retval] out IProgress progress
18072 );
18073
18074 };
18075
18098 interface IMediumFormat : $unknown
18099 {
18118 readonly attribute wstring id;
18119
18127 readonly attribute wstring name;
18128
18137 readonly attribute MediumFormatCapabilities[] capabilities;
18138
18157 void describeFileExtensions (
18158 out wstring[] extensions,
18159 out DeviceType[] types
18160 );
18161
18189 void describeProperties (
18190 out wstring[] names,
18191 out wstring[] descriptions,
18192 out DataType[] types,
18193 out unsigned long[] flags,
18194 out wstring[] defaults
18195 );
18196
18197 };
18198
18213 interface IToken : $unknown
18214 {
18223 void abandon();
18224
18231 void dummy();
18232
18233 };
18234
18246 interface IKeyboard : $unknown
18247 {
18253 readonly attribute IEventSource eventSource;
18254
18267 void putScancode (
18268 in long scancode
18269 );
18270
18283 void putScancodes (
18284 in long[] scancodes,
18285 [retval] out unsigned long codesStored
18286 );
18287
18302 void putCAD();
18303
18304 };
18305
18317 interface IMouse : $unknown
18318 {
18333 readonly attribute boolean absoluteSupported;
18334
18349 readonly attribute boolean relativeSupported;
18350
18364 readonly attribute boolean multiTouchSupported;
18365
18380 readonly attribute boolean needsHostCursor;
18381
18387 readonly attribute IEventSource eventSource;
18388
18454 void putMouseEvent (
18455 in long dx,
18456 in long dy,
18457 in long dz,
18458 in long dw,
18459 in long buttonState
18460 );
18461
18534 void putMouseEventAbsolute (
18535 in long x,
18536 in long y,
18537 in long dz,
18538 in long dw,
18539 in long buttonState
18540 );
18541
18589 void putEventMultiTouch (
18590 in long count,
18591 in long long[] contacts,
18592 in unsigned long scanTime
18593 );
18594
18610 void putEventMultiTouchString (
18611 in long count,
18612 in wstring contacts,
18613 in unsigned long scanTime
18614 );
18615
18616 };
18617
18618 interface IFramebuffer : $unknown
18619 {
18628 readonly attribute octetPtr address;
18629
18633 readonly attribute unsigned long width;
18634
18638 readonly attribute unsigned long height;
18639
18646 readonly attribute unsigned long bitsPerPixel;
18647
18654 readonly attribute unsigned long bytesPerLine;
18655
18666 readonly attribute unsigned long pixelFormat;
18667
18674 readonly attribute boolean usesGuestVRAM;
18675
18685 readonly attribute unsigned long heightReduction;
18686
18701 readonly attribute IFramebufferOverlay overlay;
18702
18709 readonly attribute long long winId;
18710
18718 void lock();
18719
18727 void unlock();
18728
18736 void notifyUpdate (
18737 in unsigned long x,
18738 in unsigned long y,
18739 in unsigned long width,
18740 in unsigned long height
18741 );
18742
18855 void requestResize (
18856 in unsigned long screenId,
18857 in unsigned long pixelFormat,
18858 in octetPtr VRAM,
18859 in unsigned long bitsPerPixel,
18860 in unsigned long bytesPerLine,
18861 in unsigned long width,
18862 in unsigned long height,
18863 [retval] out boolean finished
18864 );
18865
18877 void videoModeSupported (
18878 in unsigned long width,
18879 in unsigned long height,
18880 in unsigned long bpp,
18881 [retval] out boolean supported
18882 );
18883
18920 void getVisibleRegion (
18921 in octetPtr rectangles,
18922 in unsigned long count,
18923 [retval] out unsigned long countCopied
18924 );
18925
18960 void setVisibleRegion (
18961 in octetPtr rectangles,
18962 in unsigned long count
18963 );
18964
18985 void processVHWACommand (
18986 in octetPtr command
18987 );
18988
19003 void notify3DEvent (
19004 in unsigned long type,
19005 in octetPtr data
19006 );
19007
19008 };
19009
19024 interface IFramebufferOverlay : IFramebuffer
19025 {
19029 readonly attribute unsigned long x;
19030
19034 readonly attribute unsigned long y;
19035
19041 attribute boolean visible;
19042
19049 attribute unsigned long alpha;
19050
19056 void move (
19057 in unsigned long x,
19058 in unsigned long y
19059 );
19060
19061 };
19062
19078 interface IDisplay : $unknown
19079 {
19083 void getScreenResolution (
19084 in unsigned long screenId,
19085 out unsigned long width,
19086 out unsigned long height,
19087 out unsigned long bitsPerPixel,
19088 out long xOrigin,
19089 out long yOrigin
19090 );
19091
19097 void setFramebuffer (
19098 in unsigned long screenId,
19099 in IFramebuffer framebuffer
19100 );
19101
19107 void getFramebuffer (
19108 in unsigned long screenId,
19109 out IFramebuffer framebuffer,
19110 out long xOrigin,
19111 out long yOrigin
19112 );
19113
19164 void setVideoModeHint (
19165 in unsigned long display,
19166 in boolean enabled,
19167 in boolean changeOrigin,
19168 in long originX,
19169 in long originY,
19170 in unsigned long width,
19171 in unsigned long height,
19172 in unsigned long bitsPerPixel
19173 );
19174
19186 void setSeamlessMode (
19187 in boolean enabled
19188 );
19189
19225 void takeScreenShot (
19226 in unsigned long screenId,
19227 in octetPtr address,
19228 in unsigned long width,
19229 in unsigned long height
19230 );
19231
19275 void takeScreenShotToArray (
19276 in unsigned long screenId,
19277 in unsigned long width,
19278 in unsigned long height,
19279 [retval] out octet[] screenData
19280 );
19281
19320 void takeScreenShotPNGToArray (
19321 in unsigned long screenId,
19322 in unsigned long width,
19323 in unsigned long height,
19324 [retval] out octet[] screenData
19325 );
19326
19378 void drawToScreen (
19379 in unsigned long screenId,
19380 in octetPtr address,
19381 in unsigned long x,
19382 in unsigned long y,
19383 in unsigned long width,
19384 in unsigned long height
19385 );
19386
19401 void invalidateAndUpdate();
19402
19416 void resizeCompleted (
19417 in unsigned long screenId
19418 );
19419
19432 void completeVHWACommand (
19433 in octetPtr command
19434 );
19435
19469 void viewportChanged (
19470 in unsigned long screenId,
19471 in unsigned long x,
19472 in unsigned long y,
19473 in unsigned long width,
19474 in unsigned long height
19475 );
19476
19477 };
19478
19494 interface INetworkAdapter : $unknown
19495 {
19503 attribute NetworkAdapterType adapterType;
19504
19512 readonly attribute unsigned long slot;
19513
19522 attribute boolean enabled;
19523
19530 attribute wstring MACAddress;
19531
19537 attribute NetworkAttachmentType attachmentType;
19538
19544 attribute wstring bridgedInterface;
19545
19551 attribute wstring hostOnlyInterface;
19552
19558 attribute wstring internalNetwork;
19559
19565 attribute wstring NATNetwork;
19566
19572 attribute wstring genericDriver;
19573
19580 attribute boolean cableConnected;
19581
19587 attribute unsigned long lineSpeed;
19588
19595 attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
19596
19603 attribute boolean traceEnabled;
19604
19611 attribute wstring traceFile;
19612
19620 readonly attribute INATEngine NATEngine;
19621
19628 attribute unsigned long bootPriority;
19629
19633 attribute IBandwidthGroup bandwidthGroup;
19634
19653 void getProperty (
19654 in wstring key,
19655 [retval] out wstring value
19656 );
19657
19676 void setProperty (
19677 in wstring key,
19678 in wstring value
19679 );
19680
19708 void getProperties (
19709 in wstring names,
19710 out wstring[] returnNames,
19711 [retval] out wstring[] returnValues
19712 );
19713
19714 };
19715
19744 interface ISerialPort : $unknown
19745 {
19753 readonly attribute unsigned long slot;
19754
19761 attribute boolean enabled;
19762
19766 attribute unsigned long IOBase;
19767
19771 attribute unsigned long IRQ;
19772
19783 attribute PortMode hostMode;
19784
19792 attribute boolean server;
19793
19803 attribute wstring path;
19804
19805 };
19806
19826 interface IParallelPort : $unknown
19827 {
19835 readonly attribute unsigned long slot;
19836
19843 attribute boolean enabled;
19844
19848 attribute unsigned long IOBase;
19849
19853 attribute unsigned long IRQ;
19854
19862 attribute wstring path;
19863
19864 };
19865
19866 interface IMachineDebugger : $unknown
19867 {
19871 attribute boolean singleStep;
19872
19876 attribute boolean recompileUser;
19877
19881 attribute boolean recompileSupervisor;
19882
19890 attribute boolean executeAllInIEM;
19891
19895 attribute boolean PATMEnabled;
19896
19900 attribute boolean CSAMEnabled;
19901
19905 attribute boolean logEnabled;
19906
19910 readonly attribute wstring logDbgFlags;
19911
19915 readonly attribute wstring logDbgGroups;
19916
19920 readonly attribute wstring logDbgDestinations;
19921
19925 readonly attribute wstring logRelFlags;
19926
19930 readonly attribute wstring logRelGroups;
19931
19935 readonly attribute wstring logRelDestinations;
19936
19943 readonly attribute boolean HWVirtExEnabled;
19944
19951 readonly attribute boolean HWVirtExNestedPagingEnabled;
19952
19959 readonly attribute boolean HWVirtExVPIDEnabled;
19960
19967 readonly attribute boolean HWVirtExUXEnabled;
19968
19977 readonly attribute wstring OSName;
19978
19987 readonly attribute wstring OSVersion;
19988
19995 readonly attribute boolean PAEEnabled;
19996
20003 attribute unsigned long virtualTimeRate;
20004
20012 readonly attribute long long VM;
20013
20029 void dumpGuestCore (
20030 in wstring filename,
20031 in wstring compression
20032 );
20033
20050 void dumpHostProcessCore (
20051 in wstring filename,
20052 in wstring compression
20053 );
20054
20075 void info (
20076 in wstring name,
20077 in wstring args,
20078 [retval] out wstring info
20079 );
20080
20086 void injectNMI();
20087
20098 void modifyLogGroups (
20099 in wstring settings
20100 );
20101
20112 void modifyLogFlags (
20113 in wstring settings
20114 );
20115
20126 void modifyLogDestinations (
20127 in wstring settings
20128 );
20129
20144 void readPhysicalMemory (
20145 in long long address,
20146 in unsigned long size,
20147 [retval] out octet[] bytes
20148 );
20149
20164 void writePhysicalMemory (
20165 in long long address,
20166 in unsigned long size,
20167 in octet[] bytes
20168 );
20169
20186 void readVirtualMemory (
20187 in unsigned long cpuId,
20188 in long long address,
20189 in unsigned long size,
20190 [retval] out octet[] bytes
20191 );
20192
20209 void writeVirtualMemory (
20210 in unsigned long cpuId,
20211 in long long address,
20212 in unsigned long size,
20213 in octet[] bytes
20214 );
20215
20228 void detectOS (
20229 [retval] out wstring os
20230 );
20231
20249 void getRegister (
20250 in unsigned long cpuId,
20251 in wstring name,
20252 [retval] out wstring value
20253 );
20254
20272 void getRegisters (
20273 in unsigned long cpuId,
20274 out wstring[] names,
20275 out wstring[] values
20276 );
20277
20296 void setRegister (
20297 in unsigned long cpuId,
20298 in wstring name,
20299 in wstring value
20300 );
20301
20320 void setRegisters (
20321 in unsigned long cpuId,
20322 in wstring[] names,
20323 in wstring[] values
20324 );
20325
20338 void dumpGuestStack (
20339 in unsigned long cpuId,
20340 [retval] out wstring stack
20341 );
20342
20350 void resetStats (
20351 in wstring pattern
20352 );
20353
20361 void dumpStats (
20362 in wstring pattern
20363 );
20364
20376 void getStats (
20377 in wstring pattern,
20378 in boolean withDescriptions,
20379 [retval] out wstring stats
20380 );
20381
20382 };
20383
20384 interface IUSBDeviceFilters : $unknown
20385 {
20411 readonly attribute IUSBDeviceFilter[] deviceFilters;
20412
20440 void createDeviceFilter (
20441 in wstring name,
20442 [retval] out IUSBDeviceFilter filter
20443 );
20444
20489 void insertDeviceFilter (
20490 in unsigned long position,
20491 in IUSBDeviceFilter filter
20492 );
20493
20526 void removeDeviceFilter (
20527 in unsigned long position,
20528 [retval] out IUSBDeviceFilter filter
20529 );
20530
20531 };
20532
20533 interface IUSBController : $unknown
20534 {
20540 readonly attribute wstring name;
20541
20547 readonly attribute USBControllerType type;
20548
20556 readonly attribute unsigned short USBStandard;
20557
20558 };
20559
20572 interface IUSBDevice : $unknown
20573 {
20580 readonly attribute wstringUUID id;
20581
20585 readonly attribute unsigned short vendorId;
20586
20590 readonly attribute unsigned short productId;
20591
20599 readonly attribute unsigned short revision;
20600
20604 readonly attribute wstring manufacturer;
20605
20609 readonly attribute wstring product;
20610
20614 readonly attribute wstring serialNumber;
20615
20619 readonly attribute wstring address;
20620
20627 readonly attribute unsigned short port;
20628
20634 readonly attribute unsigned short version;
20635
20643 readonly attribute unsigned short portVersion;
20644
20651 readonly attribute boolean remote;
20652
20653 };
20654
20729 interface IUSBDeviceFilter : $unknown
20730 {
20738 attribute wstring name;
20739
20743 attribute boolean active;
20744
20752 attribute wstring vendorId;
20753
20761 attribute wstring productId;
20762
20776 attribute wstring revision;
20777
20782 attribute wstring manufacturer;
20783
20788 attribute wstring product;
20789
20794 attribute wstring serialNumber;
20795
20800 attribute wstring port;
20801
20811 attribute wstring remote;
20812
20822 attribute unsigned long maskedInterfaces;
20823
20824 };
20825
20842 interface IHostUSBDevice : IUSBDevice
20843 {
20849 readonly attribute USBDeviceState state;
20850
20851 };
20852
20875 interface IHostUSBDeviceFilter : IUSBDeviceFilter
20876 {
20883 attribute USBDeviceFilterAction action;
20884
20885 };
20886
20895 interface IAudioAdapter : $unknown
20896 {
20905 attribute boolean enabled;
20906
20912 attribute AudioControllerType audioController;
20913
20920 attribute AudioDriverType audioDriver;
20921
20922 };
20923
20924 interface IVRDEServer : $unknown
20925 {
20929 attribute boolean enabled;
20930
20934 attribute AuthType authType;
20935
20939 attribute unsigned long authTimeout;
20940
20947 attribute boolean allowMultiConnection;
20948
20956 attribute boolean reuseSingleConnection;
20957
20964 attribute wstring VRDEExtPack;
20965
20972 attribute wstring authLibrary;
20973
20979 readonly attribute wstring[] VRDEProperties;
20980
20994 void setVRDEProperty (
20995 in wstring key,
20996 in wstring value
20997 );
20998
21012 void getVRDEProperty (
21013 in wstring key,
21014 [retval] out wstring value
21015 );
21016
21017 };
21018
21076 interface ISharedFolder : $unknown
21077 {
21081 readonly attribute wstring name;
21082
21086 readonly attribute wstring hostPath;
21087
21097 readonly attribute boolean accessible;
21098
21105 readonly attribute boolean writable;
21106
21112 readonly attribute boolean autoMount;
21113
21126 readonly attribute wstring lastAccessError;
21127
21128 };
21129
21130 interface IInternalSessionControl : $unknown
21131 {
21136 void getPID (
21137 [retval] out unsigned long pid
21138 );
21139
21161 void getRemoteConsole (
21162 [retval] out IConsole console
21163 );
21164
21179 void assignRemoteMachine (
21180 in IMachine machine,
21181 in IConsole console
21182 );
21183
21207 void updateMachineState (
21208 in MachineState machineState
21209 );
21210
21226 void uninitialize();
21227
21250 void onNetworkAdapterChange (
21251 in INetworkAdapter networkAdapter,
21252 in boolean changeAdapter
21253 );
21254
21277 void onSerialPortChange (
21278 in ISerialPort serialPort
21279 );
21280
21303 void onParallelPortChange (
21304 in IParallelPort parallelPort
21305 );
21306
21329 void onStorageControllerChange();
21330
21357 void onMediumChange (
21358 in IMediumAttachment mediumAttachment,
21359 in boolean force
21360 );
21361
21391 void onStorageDeviceChange (
21392 in IMediumAttachment mediumAttachment,
21393 in boolean remove,
21394 in boolean silent
21395 );
21396
21404 void onClipboardModeChange (
21405 in ClipboardMode clipboardMode
21406 );
21407
21415 void onDragAndDropModeChange (
21416 in DragAndDropMode dragAndDropMode
21417 );
21418
21428 void onCPUChange (
21429 in unsigned long cpu,
21430 in boolean add
21431 );
21432
21440 void onCPUExecutionCapChange (
21441 in unsigned long executionCap
21442 );
21443
21468 void onVRDEServerChange (
21469 in boolean restart
21470 );
21471
21477 void onVideoCaptureChange();
21478
21501 void onUSBControllerChange();
21502
21531 void onSharedFolderChange (
21532 in boolean global
21533 );
21534
21560 void onUSBDeviceAttach (
21561 in IUSBDevice device,
21562 in IVirtualBoxErrorInfo error,
21563 in unsigned long maskedInterfaces
21564 );
21565
21591 void onUSBDeviceDetach (
21592 in wstringUUID id,
21593 in IVirtualBoxErrorInfo error
21594 );
21595
21613 void onShowWindow (
21614 in boolean check,
21615 out boolean canShow,
21616 out long long winId
21617 );
21618
21626 void onBandwidthGroupChange (
21627 in IBandwidthGroup bandwidthGroup
21628 );
21629
21653 void accessGuestProperty (
21654 in wstring name,
21655 in wstring value,
21656 in wstring flags,
21657 in boolean isSetter,
21658 out wstring retValue,
21659 out long long retTimestamp,
21660 out wstring retFlags
21661 );
21662
21710 void enumerateGuestProperties (
21711 in wstring patterns,
21712 out wstring[] keys,
21713 out wstring[] values,
21714 out long long[] timestamps,
21715 out wstring[] flags
21716 );
21717
21752 void onlineMergeMedium (
21753 in IMediumAttachment mediumAttachment,
21754 in unsigned long sourceIdx,
21755 in unsigned long targetIdx,
21756 in IProgress progress
21757 );
21758
21782 void enableVMMStatistics (
21783 in boolean enable
21784 );
21785
21813 void pauseWithReason (
21814 in Reason reason
21815 );
21816
21844 void resumeWithReason (
21845 in Reason reason
21846 );
21847
21877 void saveStateWithReason (
21878 in Reason reason,
21879 [retval] out IProgress progress
21880 );
21881
21905 void assignMachine (
21906 in IMachine machine,
21907 in LockType lockType,
21908 in wstring tokenId
21909 );
21910
21934 void assignMachine (
21935 in IMachine machine,
21936 in LockType lockType,
21937 in IToken token
21938 );
21939
21940 };
21941
22000 interface ISession : $unknown
22001 {
22005 readonly attribute SessionState state;
22006
22014 readonly attribute SessionType type;
22015
22019 readonly attribute IMachine machine;
22020
22024 readonly attribute IConsole console;
22025
22057 void unlockMachine();
22058
22059 };
22060
22083 interface IStorageController : $unknown
22084 {
22093 readonly attribute wstring name;
22094
22100 readonly attribute unsigned long maxDevicesPerPortCount;
22101
22107 readonly attribute unsigned long minPortCount;
22108
22114 readonly attribute unsigned long maxPortCount;
22115
22121 attribute unsigned long instance;
22122
22131 attribute unsigned long portCount;
22132
22138 readonly attribute StorageBus bus;
22139
22152 attribute StorageControllerType controllerType;
22153
22168 attribute boolean useHostIOCache;
22169
22175 readonly attribute boolean bootable;
22176
22177 };
22178
22202 interface IManagedObjectRef : $unknown
22203 {
22210 void getInterfaceName (
22211 [retval] out wstring return
22212 );
22213
22221 void release();
22222
22223 };
22224
22233 interface IWebsessionManager : $unknown
22234 {
22243 void logon (
22244 in wstring username,
22245 in wstring password,
22246 [retval] out IVirtualBox return
22247 );
22248
22258 void getSessionObject (
22259 in IVirtualBox refIVirtualBox,
22260 [retval] out ISession return
22261 );
22262
22270 void logoff (
22271 in IVirtualBox refIVirtualBox
22272 );
22273
22274 };
22275
22284 interface IPerformanceMetric : $unknown
22285 {
22291 readonly attribute wstring metricName;
22292
22298 readonly attribute $unknown object;
22299
22305 readonly attribute wstring description;
22306
22312 readonly attribute unsigned long period;
22313
22323 readonly attribute unsigned long count;
22324
22330 readonly attribute wstring unit;
22331
22337 readonly attribute long minimumValue;
22338
22344 readonly attribute long maximumValue;
22345
22346 };
22347
22454 interface IPerformanceCollector : $unknown
22455 {
22466 readonly attribute wstring[] metricNames;
22467
22491 void getMetrics (
22492 in wstring[] metricNames,
22493 in $unknown[] objects,
22494 [retval] out IPerformanceMetric[] metrics
22495 );
22496
22535 void setupMetrics (
22536 in wstring[] metricNames,
22537 in $unknown[] objects,
22538 in unsigned long period,
22539 in unsigned long count,
22540 [retval] out IPerformanceMetric[] affectedMetrics
22541 );
22542
22571 void enableMetrics (
22572 in wstring[] metricNames,
22573 in $unknown[] objects,
22574 [retval] out IPerformanceMetric[] affectedMetrics
22575 );
22576
22605 void disableMetrics (
22606 in wstring[] metricNames,
22607 in $unknown[] objects,
22608 [retval] out IPerformanceMetric[] affectedMetrics
22609 );
22610
22700 void queryMetricsData (
22701 in wstring[] metricNames,
22702 in $unknown[] objects,
22703 out wstring[] returnMetricNames,
22704 out $unknown[] returnObjects,
22705 out wstring[] returnUnits,
22706 out unsigned long[] returnScales,
22707 out unsigned long[] returnSequenceNumbers,
22708 out unsigned long[] returnDataIndices,
22709 out unsigned long[] returnDataLengths,
22710 [retval] out long[] returnData
22711 );
22712
22713 };
22714
22722 interface INATEngine : $unknown
22723 {
22728 attribute wstring network;
22729
22736 attribute wstring hostIP;
22737
22742 attribute wstring TFTPPrefix;
22743
22748 attribute wstring TFTPBootFile;
22749
22757 attribute wstring TFTPNextServer;
22758
22762 attribute unsigned long aliasMode;
22763
22767 attribute boolean DNSPassDomain;
22768
22773 attribute boolean DNSProxy;
22774
22779 attribute boolean DNSUseHostResolver;
22780
22785 readonly attribute wstring[] redirects;
22786
22802 void setNetworkSettings (
22803 in unsigned long mtu,
22804 in unsigned long sockSnd,
22805 in unsigned long sockRcv,
22806 in unsigned long TcpWndSnd,
22807 in unsigned long TcpWndRcv
22808 );
22809
22814 void getNetworkSettings (
22815 out unsigned long mtu,
22816 out unsigned long sockSnd,
22817 out unsigned long sockRcv,
22818 out unsigned long TcpWndSnd,
22819 out unsigned long TcpWndRcv
22820 );
22821
22841 void addRedirect (
22842 in wstring name,
22843 in NATProtocol proto,
22844 in wstring hostIP,
22845 in unsigned short hostPort,
22846 in wstring guestIP,
22847 in unsigned short guestPort
22848 );
22849
22855 void removeRedirect (
22856 in wstring name
22857 );
22858
22859 };
22860
22869 interface IExtPackPlugIn : $unknown
22870 {
22874 readonly attribute wstring name;
22875
22879 readonly attribute wstring description;
22880
22886 readonly attribute wstring frontend;
22887
22891 readonly attribute wstring modulePath;
22892
22893 };
22894
22903 interface IExtPackBase : $unknown
22904 {
22908 readonly attribute wstring name;
22909
22913 readonly attribute wstring description;
22914
22926 readonly attribute wstring version;
22927
22931 readonly attribute unsigned long revision;
22932
22942 readonly attribute wstring edition;
22943
22947 readonly attribute wstring VRDEModule;
22948
22952 readonly attribute IExtPackPlugIn[] plugIns;
22953
22963 readonly attribute boolean usable;
22964
22971 readonly attribute wstring whyUnusable;
22972
22976 readonly attribute boolean showLicense;
22977
22986 readonly attribute wstring license;
22987
23011 void queryLicense (
23012 in wstring preferredLocale,
23013 in wstring preferredLanguage,
23014 in wstring format,
23015 [retval] out wstring licenseText
23016 );
23017
23018 };
23019
23028 interface IExtPack : IExtPackBase
23029 {
23041 void queryObject (
23042 in wstring objUuid,
23043 [retval] out $unknown returnInterface
23044 );
23045
23046 };
23047
23057 interface IExtPackFile : IExtPackBase
23058 {
23064 readonly attribute wstring filePath;
23065
23084 void install (
23085 in boolean replace,
23086 in wstring displayInfo,
23087 [retval] out IProgress progess
23088 );
23089
23090 };
23091
23102 interface IExtPackManager : $unknown
23103 {
23109 readonly attribute IExtPack[] installedExtPacks;
23110
23128 void find (
23129 in wstring name,
23130 [retval] out IExtPack returnData
23131 );
23132
23144 void openExtPackFile (
23145 in wstring path,
23146 [retval] out IExtPackFile file
23147 );
23148
23167 void uninstall (
23168 in wstring name,
23169 in boolean forcedRemoval,
23170 in wstring displayInfo,
23171 [retval] out IProgress progess
23172 );
23173
23177 void cleanup();
23178
23191 void queryAllPlugInsForFrontend (
23192 in wstring frontendName,
23193 [retval] out wstring[] plugInModules
23194 );
23195
23203 void isExtPackUsable (
23204 in wstring name,
23205 [retval] out boolean usable
23206 );
23207
23208 };
23209
23215 interface IBandwidthGroup : $unknown
23216 {
23220 readonly attribute wstring name;
23221
23225 readonly attribute BandwidthGroupType type;
23226
23230 readonly attribute unsigned long reference;
23231
23236 attribute long long maxBytesPerSec;
23237
23238 };
23239
23248 interface IBandwidthControl : $unknown
23249 {
23255 readonly attribute unsigned long numGroups;
23256
23269 void createBandwidthGroup (
23270 in wstring name,
23271 in BandwidthGroupType type,
23272 in long long maxBytesPerSec
23273 );
23274
23282 void deleteBandwidthGroup (
23283 in wstring name
23284 );
23285
23295 void getBandwidthGroup (
23296 in wstring name,
23297 [retval] out IBandwidthGroup bandwidthGroup
23298 );
23299
23307 void getAllBandwidthGroups (
23308 [retval] out IBandwidthGroup[] bandwidthGroups
23309 );
23310
23311 };
23312
23325 interface IVirtualBoxClient : $unknown
23326 {
23332 readonly attribute IVirtualBox virtualBox;
23333
23339 readonly attribute ISession session;
23340
23346 readonly attribute IEventSource eventSource;
23347
23358 void checkMachineError (
23359 in IMachine machine
23360 );
23361
23362 };
23363
23377 interface IEventSource : $unknown
23378 {
23384 void createListener (
23385 [retval] out IEventListener listener
23386 );
23387
23403 void createAggregator (
23404 in IEventSource[] subordinates,
23405 [retval] out IEventSource result
23406 );
23407
23440 void registerListener (
23441 in IEventListener listener,
23442 in VBoxEventType[] interesting,
23443 in boolean active
23444 );
23445
23454 void unregisterListener (
23455 in IEventListener listener
23456 );
23457
23472 void fireEvent (
23473 in IEvent event,
23474 in long timeout,
23475 [retval] out boolean result
23476 );
23477
23502 void getEvent (
23503 in IEventListener listener,
23504 in long timeout,
23505 [retval] out IEvent event
23506 );
23507
23519 void eventProcessed (
23520 in IEventListener listener,
23521 in IEvent event
23522 );
23523
23524 };
23525
23535 interface IEventListener : $unknown
23536 {
23549 void handleEvent (
23550 in IEvent event
23551 );
23552
23553 };
23554
23631 interface IEvent : $unknown
23632 {
23638 readonly attribute VBoxEventType type;
23639
23645 readonly attribute IEventSource source;
23646
23657 readonly attribute boolean waitable;
23658
23665 void setProcessed();
23666
23680 void waitProcessed (
23681 in long timeout,
23682 [retval] out boolean result
23683 );
23684
23685 };
23686
23692 interface IReusableEvent : IEvent
23693 {
23697 readonly attribute unsigned long generation;
23698
23705 void reuse();
23706
23707 };
23708
23714 interface IMachineEvent : IEvent
23715 {
23719 readonly attribute wstringUUID machineId;
23720
23721 };
23722
23728 interface IMachineStateChangedEvent : IMachineEvent
23729 {
23733 readonly attribute MachineState state;
23734
23735 };
23736
23744 interface IMachineDataChangedEvent : IMachineEvent
23745 {
23752 readonly attribute boolean temporary;
23753
23754 };
23755
23764 interface IMediumRegisteredEvent : IEvent
23765 {
23769 readonly attribute wstringUUID mediumId;
23770
23774 readonly attribute DeviceType mediumType;
23775
23782 readonly attribute boolean registered;
23783
23784 };
23785
23794 interface IMachineRegisteredEvent : IMachineEvent
23795 {
23802 readonly attribute boolean registered;
23803
23804 };
23805
23815 interface ISessionStateChangedEvent : IMachineEvent
23816 {
23822 readonly attribute SessionState state;
23823
23824 };
23825
23833 interface IGuestPropertyChangedEvent : IMachineEvent
23834 {
23840 readonly attribute wstring name;
23841
23847 readonly attribute wstring value;
23848
23854 readonly attribute wstring flags;
23855
23856 };
23857
23863 interface ISnapshotEvent : IMachineEvent
23864 {
23868 readonly attribute wstringUUID snapshotId;
23869
23870 };
23871
23881 interface ISnapshotTakenEvent : ISnapshotEvent
23882 {
23883 };
23884
23901 interface ISnapshotDeletedEvent : ISnapshotEvent
23902 {
23903 };
23904
23914 interface ISnapshotChangedEvent : ISnapshotEvent
23915 {
23916 };
23917
23926 interface IMousePointerShapeChangedEvent : IEvent
23927 {
23933 readonly attribute boolean visible;
23934
23940 readonly attribute boolean alpha;
23941
23947 readonly attribute unsigned long xhot;
23948
23954 readonly attribute unsigned long yhot;
23955
23961 readonly attribute unsigned long width;
23962
23968 readonly attribute unsigned long height;
23969
24002 readonly attribute octet[] shape;
24003
24004 };
24005
24014 interface IMouseCapabilityChangedEvent : IEvent
24015 {
24021 readonly attribute boolean supportsAbsolute;
24022
24028 readonly attribute boolean supportsRelative;
24029
24035 readonly attribute boolean supportsMultiTouch;
24036
24042 readonly attribute boolean needsHostCursor;
24043
24044 };
24045
24054 interface IKeyboardLedsChangedEvent : IEvent
24055 {
24061 readonly attribute boolean numLock;
24062
24068 readonly attribute boolean capsLock;
24069
24075 readonly attribute boolean scrollLock;
24076
24077 };
24078
24087 interface IStateChangedEvent : IEvent
24088 {
24094 readonly attribute MachineState state;
24095
24096 };
24097
24107 interface IAdditionsStateChangedEvent : IEvent
24108 {
24109 };
24110
24121 interface INetworkAdapterChangedEvent : IEvent
24122 {
24128 readonly attribute INetworkAdapter networkAdapter;
24129
24130 };
24131
24142 interface ISerialPortChangedEvent : IEvent
24143 {
24149 readonly attribute ISerialPort serialPort;
24150
24151 };
24152
24163 interface IParallelPortChangedEvent : IEvent
24164 {
24170 readonly attribute IParallelPort parallelPort;
24171
24172 };
24173
24183 interface IStorageControllerChangedEvent : IEvent
24184 {
24185 };
24186
24196 interface IMediumChangedEvent : IEvent
24197 {
24203 readonly attribute IMediumAttachment mediumAttachment;
24204
24205 };
24206
24214 interface IClipboardModeChangedEvent : IEvent
24215 {
24221 readonly attribute ClipboardMode clipboardMode;
24222
24223 };
24224
24232 interface IDragAndDropModeChangedEvent : IEvent
24233 {
24239 readonly attribute DragAndDropMode dragAndDropMode;
24240
24241 };
24242
24250 interface ICPUChangedEvent : IEvent
24251 {
24257 readonly attribute unsigned long CPU;
24258
24264 readonly attribute boolean add;
24265
24266 };
24267
24275 interface ICPUExecutionCapChangedEvent : IEvent
24276 {
24282 readonly attribute unsigned long executionCap;
24283
24284 };
24285
24293 interface IGuestKeyboardEvent : IEvent
24294 {
24300 readonly attribute long[] scancodes;
24301
24302 };
24303
24311 interface IGuestMouseEvent : IReusableEvent
24312 {
24318 readonly attribute GuestMouseEventMode mode;
24319
24325 readonly attribute long x;
24326
24332 readonly attribute long y;
24333
24339 readonly attribute long z;
24340
24346 readonly attribute long w;
24347
24353 readonly attribute long buttons;
24354
24355 };
24356
24364 interface IGuestMultiTouchEvent : IEvent
24365 {
24371 readonly attribute long contactCount;
24372
24378 readonly attribute short[] xPositions;
24379
24385 readonly attribute short[] yPositions;
24386
24392 readonly attribute unsigned short[] contactIds;
24393
24401 readonly attribute unsigned short[] contactFlags;
24402
24408 readonly attribute unsigned long scanTime;
24409
24410 };
24411
24417 interface IGuestSessionEvent : IEvent
24418 {
24422 readonly attribute IGuestSession session;
24423
24424 };
24425
24433 interface IGuestSessionStateChangedEvent : IGuestSessionEvent
24434 {
24440 readonly attribute unsigned long id;
24441
24447 readonly attribute GuestSessionStatus status;
24448
24458 readonly attribute IVirtualBoxErrorInfo error;
24459
24460 };
24461
24469 interface IGuestSessionRegisteredEvent : IGuestSessionEvent
24470 {
24477 readonly attribute boolean registered;
24478
24479 };
24480
24486 interface IGuestProcessEvent : IGuestSessionEvent
24487 {
24493 readonly attribute IGuestProcess process;
24494
24500 readonly attribute unsigned long pid;
24501
24502 };
24503
24511 interface IGuestProcessRegisteredEvent : IGuestProcessEvent
24512 {
24519 readonly attribute boolean registered;
24520
24521 };
24522
24530 interface IGuestProcessStateChangedEvent : IGuestProcessEvent
24531 {
24537 readonly attribute ProcessStatus status;
24538
24548 readonly attribute IVirtualBoxErrorInfo error;
24549
24550 };
24551
24559 interface IGuestProcessIOEvent : IGuestProcessEvent
24560 {
24567 readonly attribute unsigned long handle;
24568
24574 readonly attribute unsigned long processed;
24575
24576 };
24577
24587 interface IGuestProcessInputNotifyEvent : IGuestProcessIOEvent
24588 {
24594 readonly attribute ProcessInputStatus status;
24595
24596 };
24597
24605 interface IGuestProcessOutputEvent : IGuestProcessIOEvent
24606 {
24612 readonly attribute octet[] data;
24613
24614 };
24615
24621 interface IGuestFileEvent : IGuestSessionEvent
24622 {
24628 readonly attribute IGuestFile file;
24629
24630 };
24631
24639 interface IGuestFileRegisteredEvent : IGuestFileEvent
24640 {
24647 readonly attribute boolean registered;
24648
24649 };
24650
24658 interface IGuestFileStateChangedEvent : IGuestFileEvent
24659 {
24665 readonly attribute FileStatus status;
24666
24676 readonly attribute IVirtualBoxErrorInfo error;
24677
24678 };
24679
24687 interface IGuestFileIOEvent : IGuestFileEvent
24688 {
24694 readonly attribute long long offset;
24695
24701 readonly attribute unsigned long processed;
24702
24703 };
24704
24712 interface IGuestFileOffsetChangedEvent : IGuestFileIOEvent
24713 {
24714 };
24715
24723 interface IGuestFileReadEvent : IGuestFileIOEvent
24724 {
24730 readonly attribute octet[] data;
24731
24732 };
24733
24741 interface IGuestFileWriteEvent : IGuestFileIOEvent
24742 {
24743 };
24744
24755 interface IVRDEServerChangedEvent : IEvent
24756 {
24757 };
24758
24768 interface IVRDEServerInfoChangedEvent : IEvent
24769 {
24770 };
24771
24779 interface IVideoCaptureChangedEvent : IEvent
24780 {
24781 };
24782
24793 interface IUSBControllerChangedEvent : IEvent
24794 {
24795 };
24796
24820 interface IUSBDeviceStateChangedEvent : IEvent
24821 {
24827 readonly attribute IUSBDevice device;
24828
24834 readonly attribute boolean attached;
24835
24841 readonly attribute IVirtualBoxErrorInfo error;
24842
24843 };
24844
24860 interface ISharedFolderChangedEvent : IEvent
24861 {
24867 readonly attribute Scope scope;
24868
24869 };
24870
24922 interface IRuntimeErrorEvent : IEvent
24923 {
24929 readonly attribute boolean fatal;
24930
24936 readonly attribute wstring id;
24937
24943 readonly attribute wstring message;
24944
24945 };
24946
24954 interface IEventSourceChangedEvent : IEvent
24955 {
24961 readonly attribute IEventListener listener;
24962
24968 readonly attribute boolean add;
24969
24970 };
24971
24980 interface IExtraDataChangedEvent : IEvent
24981 {
24988 readonly attribute wstringUUID machineId;
24989
24995 readonly attribute wstring key;
24996
25002 readonly attribute wstring value;
25003
25004 };
25005
25011 interface IVetoEvent : IEvent
25012 {
25022 void addVeto (
25023 in wstring reason
25024 );
25025
25035 void isVetoed (
25036 [retval] out boolean result
25037 );
25038
25048 void getVetos (
25049 [retval] out wstring[] result
25050 );
25051
25052 };
25053
25063 interface IExtraDataCanChangeEvent : IVetoEvent
25064 {
25071 readonly attribute wstringUUID machineId;
25072
25078 readonly attribute wstring key;
25079
25085 readonly attribute wstring value;
25086
25087 };
25088
25104 interface ICanShowWindowEvent : IVetoEvent
25105 {
25106 };
25107
25139 interface IShowWindowEvent : IEvent
25140 {
25149 attribute long long winId;
25150
25151 };
25152
25160 interface INATRedirectEvent : IMachineEvent
25161 {
25167 readonly attribute unsigned long slot;
25168
25174 readonly attribute boolean remove;
25175
25181 readonly attribute wstring name;
25182
25188 readonly attribute NATProtocol proto;
25189
25195 readonly attribute wstring hostIP;
25196
25202 readonly attribute long hostPort;
25203
25209 readonly attribute wstring guestIP;
25210
25216 readonly attribute long guestPort;
25217
25218 };
25219
25232 interface IHostPCIDevicePlugEvent : IMachineEvent
25233 {
25239 readonly attribute boolean plugged;
25240
25247 readonly attribute boolean success;
25248
25254 readonly attribute IPCIDeviceAttachment attachment;
25255
25261 readonly attribute wstring message;
25262
25263 };
25264
25273 interface IVBoxSVCAvailabilityChangedEvent : IEvent
25274 {
25280 readonly attribute boolean available;
25281
25282 };
25283
25291 interface IBandwidthGroupChangedEvent : IEvent
25292 {
25298 readonly attribute IBandwidthGroup bandwidthGroup;
25299
25300 };
25301
25309 interface IGuestMonitorChangedEvent : IEvent
25310 {
25316 readonly attribute GuestMonitorChangedEventType changeType;
25317
25323 readonly attribute unsigned long screenId;
25324
25331 readonly attribute unsigned long originX;
25332
25339 readonly attribute unsigned long originY;
25340
25347 readonly attribute unsigned long width;
25348
25355 readonly attribute unsigned long height;
25356
25357 };
25358
25366 interface IGuestUserStateChangedEvent : IEvent
25367 {
25373 readonly attribute wstring name;
25374
25381 readonly attribute wstring domain;
25382
25389 readonly attribute GuestUserState state;
25390
25396 readonly attribute wstring stateDetails;
25397
25398 };
25399
25409 interface IStorageDeviceChangedEvent : IEvent
25410 {
25416 readonly attribute IMediumAttachment storageDevice;
25417
25423 readonly attribute boolean removed;
25424
25430 readonly attribute boolean silent;
25431
25432 };
25433
25434 interface INATNetworkChangedEvent : IEvent
25435 {
25436 readonly attribute wstring networkName;
25437
25438 };
25439
25440 interface INATNetworkStartStopEvent : INATNetworkChangedEvent
25441 {
25447 readonly attribute boolean startEvent;
25448
25449 };
25450
25451 interface INATNetworkAlterEvent : INATNetworkChangedEvent
25452 {
25453 };
25454
25455 interface INATNetworkCreationDeletionEvent : INATNetworkAlterEvent
25456 {
25457 readonly attribute boolean creationEvent;
25458
25459 };
25460
25461 interface INATNetworkSettingEvent : INATNetworkAlterEvent
25462 {
25463 readonly attribute boolean enabled;
25464
25465 readonly attribute wstring network;
25466
25467 readonly attribute wstring gateway;
25468
25469 readonly attribute boolean advertiseDefaultIPv6RouteEnabled;
25470
25471 readonly attribute boolean needDhcpServer;
25472
25473 };
25474
25475 interface INATNetworkPortForwardEvent : INATNetworkAlterEvent
25476 {
25477 readonly attribute boolean create;
25478
25479 readonly attribute boolean ipv6;
25480
25481 readonly attribute wstring name;
25482
25483 readonly attribute NATProtocol proto;
25484
25485 readonly attribute wstring hostIp;
25486
25487 readonly attribute long hostPort;
25488
25489 readonly attribute wstring guestIp;
25490
25491 readonly attribute long guestPort;
25492
25493 };
25494
25495 interface IHostNameResolutionConfigurationChangeEvent : IEvent
25496 {
25497 };
25498
25499