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
13819 void directoryRemove (
13820 in wstring path
13821 );
13822
13835 void directoryRemoveRecursive (
13836 in wstring path,
13837 in DirectoryRemoveRecFlag[] flags,
13838 [retval] out IProgress progress
13839 );
13840
13852 void directoryRename (
13853 in wstring source,
13854 in wstring dest,
13855 in PathRenameFlag[] flags
13856 );
13857
13875 void directorySetACL (
13876 in wstring path,
13877 in wstring acl
13878 );
13879
13893 void environmentClear();
13894
13915 void environmentGet (
13916 in wstring name,
13917 [retval] out wstring value
13918 );
13919
13937 void environmentSet (
13938 in wstring name,
13939 in wstring value
13940 );
13941
13957 void environmentUnset (
13958 in wstring name
13959 );
13960
14014 void fileCreateTemp (
14015 in wstring templateName,
14016 in unsigned long mode,
14017 in wstring path,
14018 in boolean secure,
14019 [retval] out IGuestFile file
14020 );
14021
14039 void fileExists (
14040 in wstring path,
14041 [retval] out boolean exists
14042 );
14043
14067 void fileRemove (
14068 in wstring path
14069 );
14070
14132 void fileOpen (
14133 in wstring path,
14134 in wstring openMode,
14135 in wstring disposition,
14136 in unsigned long creationMode,
14137 [retval] out IGuestFile file
14138 );
14139
14206 void fileOpenEx (
14207 in wstring path,
14208 in wstring openMode,
14209 in wstring disposition,
14210 in wstring sharingMode,
14211 in unsigned long creationMode,
14212 in long long offset,
14213 [retval] out IGuestFile file
14214 );
14215
14241 void fileQueryInfo (
14242 in wstring path,
14243 [retval] out IGuestFsObjInfo info
14244 );
14245
14271 void fileQuerySize (
14272 in wstring path,
14273 [retval] out long long size
14274 );
14275
14287 void fileRename (
14288 in wstring source,
14289 in wstring dest,
14290 in PathRenameFlag[] flags
14291 );
14292
14310 void fileSetACL (
14311 in wstring file,
14312 in wstring acl
14313 );
14314
14369 void processCreate (
14370 in wstring command,
14371 in wstring[] arguments,
14372 in wstring[] environment,
14373 in ProcessCreateFlag[] flags,
14374 in unsigned long timeoutMS,
14375 [retval] out IGuestProcess guestProcess
14376 );
14377
14419 void processCreateEx (
14420 in wstring command,
14421 in wstring[] arguments,
14422 in wstring[] environment,
14423 in ProcessCreateFlag[] flags,
14424 in unsigned long timeoutMS,
14425 in ProcessPriority priority,
14426 in long[] affinity,
14427 [retval] out IGuestProcess guestProcess
14428 );
14429
14439 void processGet (
14440 in unsigned long pid,
14441 [retval] out IGuestProcess guestProcess
14442 );
14443
14466 void symlinkCreate (
14467 in wstring source,
14468 in wstring target,
14469 in SymlinkType type
14470 );
14471
14489 void symlinkExists (
14490 in wstring symlink,
14491 [retval] out boolean exists
14492 );
14493
14517 void symlinkRead (
14518 in wstring symlink,
14519 in SymlinkReadFlag[] flags,
14520 [retval] out wstring target
14521 );
14522
14538 void symlinkRemoveDirectory (
14539 in wstring path
14540 );
14541
14557 void symlinkRemoveFile (
14558 in wstring file
14559 );
14560
14581 void waitFor (
14582 in unsigned long waitFor,
14583 in unsigned long timeoutMS,
14584 [retval] out GuestSessionWaitResult reason
14585 );
14586
14608 void waitForArray (
14609 in GuestSessionWaitForFlag[] waitFor,
14610 in unsigned long timeoutMS,
14611 [retval] out GuestSessionWaitResult reason
14612 );
14613
14614 };
14615
14623 interface IProcess : $unknown
14624 {
14630 readonly attribute wstring[] arguments;
14631
14637 readonly attribute wstring[] environment;
14638
14644 readonly attribute IEventSource eventSource;
14645
14649 readonly attribute wstring executablePath;
14650
14657 readonly attribute long exitCode;
14658
14664 readonly attribute wstring name;
14665
14671 readonly attribute unsigned long PID;
14672
14679 readonly attribute ProcessStatus status;
14680
14701 void waitFor (
14702 in unsigned long waitFor,
14703 in unsigned long timeoutMS,
14704 [retval] out ProcessWaitResult reason
14705 );
14706
14728 void waitForArray (
14729 in ProcessWaitForFlag[] waitFor,
14730 in unsigned long timeoutMS,
14731 [retval] out ProcessWaitResult reason
14732 );
14733
14750 void read (
14751 in unsigned long handle,
14752 in unsigned long toRead,
14753 in unsigned long timeoutMS,
14754 [retval] out octet[] data
14755 );
14756
14780 void write (
14781 in unsigned long handle,
14782 in unsigned long flags,
14783 in octet[] data,
14784 in unsigned long timeoutMS,
14785 [retval] out unsigned long written
14786 );
14787
14812 void writeArray (
14813 in unsigned long handle,
14814 in ProcessInputFlag[] flags,
14815 in octet[] data,
14816 in unsigned long timeoutMS,
14817 [retval] out unsigned long written
14818 );
14819
14829 void terminate();
14830
14831 };
14832
14841 interface IGuestProcess : IProcess
14842 {
14843 };
14844
14852 interface IDirectory : $unknown
14853 {
14859 readonly attribute wstring directoryName;
14860
14866 readonly attribute wstring filter;
14867
14874 void close();
14875
14891 void read (
14892 [retval] out IFsObjInfo objInfo
14893 );
14894
14895 };
14896
14905 interface IGuestDirectory : IDirectory
14906 {
14907 };
14908
14916 interface IFile : $unknown
14917 {
14923 readonly attribute unsigned long creationMode;
14924
14930 readonly attribute wstring disposition;
14931
14937 readonly attribute IEventSource eventSource;
14938
14944 readonly attribute wstring fileName;
14945
14951 readonly attribute unsigned long id;
14952
14958 readonly attribute long long initialSize;
14959
14965 readonly attribute wstring openMode;
14966
14972 readonly attribute long long offset;
14973
14979 readonly attribute FileStatus status;
14980
14987 void close();
14988
15005 void queryInfo (
15006 [retval] out IFsObjInfo objInfo
15007 );
15008
15031 void read (
15032 in unsigned long toRead,
15033 in unsigned long timeoutMS,
15034 [retval] out octet[] data
15035 );
15036
15061 void readAt (
15062 in long long offset,
15063 in unsigned long toRead,
15064 in unsigned long timeoutMS,
15065 [retval] out octet[] data
15066 );
15067
15087 void seek (
15088 in long long offset,
15089 in FileSeekType whence
15090 );
15091
15107 void setACL (
15108 in wstring acl
15109 );
15110
15128 void write (
15129 in octet[] data,
15130 in unsigned long timeoutMS,
15131 [retval] out unsigned long written
15132 );
15133
15161 void writeAt (
15162 in long long offset,
15163 in octet[] data,
15164 in unsigned long timeoutMS,
15165 [retval] out unsigned long written
15166 );
15167
15168 };
15169
15178 interface IGuestFile : IFile
15179 {
15180 };
15181
15190 interface IFsObjInfo : $unknown
15191 {
15197 readonly attribute long long accessTime;
15198
15204 readonly attribute long long allocatedSize;
15205
15211 readonly attribute long long birthTime;
15212
15218 readonly attribute long long changeTime;
15219
15225 readonly attribute unsigned long deviceNumber;
15226
15232 readonly attribute wstring fileAttributes;
15233
15239 readonly attribute unsigned long generationId;
15240
15246 readonly attribute unsigned long GID;
15247
15253 readonly attribute wstring groupName;
15254
15260 readonly attribute unsigned long hardLinks;
15261
15267 readonly attribute long long modificationTime;
15268
15274 readonly attribute wstring name;
15275
15281 readonly attribute long long nodeId;
15282
15288 readonly attribute unsigned long nodeIdDevice;
15289
15297 readonly attribute long long objectSize;
15298
15304 readonly attribute FsObjType type;
15305
15311 readonly attribute unsigned long UID;
15312
15318 readonly attribute unsigned long userFlags;
15319
15325 readonly attribute wstring userName;
15326
15327 };
15328
15337 interface IGuestFsObjInfo : IFsObjInfo
15338 {
15339 };
15340
15354 interface IGuest : $unknown
15355 {
15370 readonly attribute wstring OSTypeId;
15371
15377 readonly attribute AdditionsRunLevelType additionsRunLevel;
15378
15385 readonly attribute wstring additionsVersion;
15386
15394 readonly attribute unsigned long additionsRevision;
15395
15401 readonly attribute IEventSource eventSource;
15402
15409 readonly attribute IAdditionsFacility[] facilities;
15410
15414 readonly attribute IGuestSession[] sessions;
15415
15419 attribute unsigned long memoryBalloonSize;
15420
15424 attribute unsigned long statisticsUpdateInterval;
15425
15457 void internalGetStatistics (
15458 out unsigned long cpuUser,
15459 out unsigned long cpuKernel,
15460 out unsigned long cpuIdle,
15461 out unsigned long memTotal,
15462 out unsigned long memFree,
15463 out unsigned long memBalloon,
15464 out unsigned long memShared,
15465 out unsigned long memCache,
15466 out unsigned long pagedTotal,
15467 out unsigned long memAllocTotal,
15468 out unsigned long memFreeTotal,
15469 out unsigned long memBalloonTotal,
15470 out unsigned long memSharedTotal
15471 );
15472
15484 void getFacilityStatus (
15485 in AdditionsFacilityType facility,
15486 out long long timestamp,
15487 [retval] out AdditionsFacilityStatus status
15488 );
15489
15507 void getAdditionsStatus (
15508 in AdditionsRunLevelType level,
15509 [retval] out boolean active
15510 );
15511
15541 void setCredentials (
15542 in wstring userName,
15543 in wstring password,
15544 in wstring domain,
15545 in boolean allowInteractiveLogon
15546 );
15547
15577 void dragHGEnter (
15578 in unsigned long screenId,
15579 in unsigned long y,
15580 in unsigned long x,
15581 in DragAndDropAction defaultAction,
15582 in DragAndDropAction[] allowedActions,
15583 in wstring[] formats,
15584 [retval] out DragAndDropAction resultAction
15585 );
15586
15616 void dragHGMove (
15617 in unsigned long screenId,
15618 in unsigned long x,
15619 in unsigned long y,
15620 in DragAndDropAction defaultAction,
15621 in DragAndDropAction[] allowedActions,
15622 in wstring[] formats,
15623 [retval] out DragAndDropAction resultAction
15624 );
15625
15643 void dragHGLeave (
15644 in unsigned long screenId
15645 );
15646
15678 void dragHGDrop (
15679 in unsigned long screenId,
15680 in unsigned long x,
15681 in unsigned long y,
15682 in DragAndDropAction defaultAction,
15683 in DragAndDropAction[] allowedActions,
15684 in wstring[] formats,
15685 out wstring format,
15686 [retval] out DragAndDropAction resultAction
15687 );
15688
15712 void dragHGPutData (
15713 in unsigned long screenId,
15714 in wstring format,
15715 in octet[] data,
15716 [retval] out IProgress progress
15717 );
15718
15744 void dragGHPending (
15745 in unsigned long screenId,
15746 out wstring[] formats,
15747 out DragAndDropAction[] allowedActions,
15748 [retval] out DragAndDropAction defaultAction
15749 );
15750
15772 void dragGHDropped (
15773 in wstring format,
15774 in DragAndDropAction action,
15775 [retval] out IProgress progress
15776 );
15777
15795 void dragGHGetData (
15796 [retval] out octet[] data
15797 );
15798
15861 void createSession (
15862 in wstring user,
15863 in wstring password,
15864 in wstring domain,
15865 in wstring sessionName,
15866 [retval] out IGuestSession guestSession
15867 );
15868
15883 void findSession (
15884 in wstring sessionName,
15885 [retval] out IGuestSession[] sessions
15886 );
15887
15937 void updateGuestAdditions (
15938 in wstring source,
15939 in wstring[] arguments,
15940 in AdditionsUpdateFlag[] flags,
15941 [retval] out IProgress progress
15942 );
15943
15944 };
15945
15986 interface IProgress : $unknown
15987 {
15991 readonly attribute wstringUUID id;
15992
15996 readonly attribute wstring description;
15997
16001 readonly attribute $unknown initiator;
16002
16006 readonly attribute boolean cancelable;
16007
16015 readonly attribute unsigned long percent;
16016
16030 readonly attribute long timeRemaining;
16031
16035 readonly attribute boolean completed;
16036
16040 readonly attribute boolean canceled;
16041
16048 readonly attribute long resultCode;
16049
16059 readonly attribute IVirtualBoxErrorInfo errorInfo;
16060
16067 readonly attribute unsigned long operationCount;
16068
16072 readonly attribute unsigned long operation;
16073
16079 readonly attribute wstring operationDescription;
16080
16084 readonly attribute unsigned long operationPercent;
16085
16089 readonly attribute unsigned long operationWeight;
16090
16098 attribute unsigned long timeout;
16099
16103 void setCurrentOperationProgress (
16104 in unsigned long percent
16105 );
16106
16110 void setNextOperation (
16111 in wstring nextOperationDescription,
16112 in unsigned long nextOperationsWeight
16113 );
16114
16141 void waitForCompletion (
16142 in long timeout
16143 );
16144
16168 void waitForOperationCompletion (
16169 in unsigned long operation,
16170 in long timeout
16171 );
16172
16198 void waitForAsyncProgressCompletion (
16199 in IProgress pProgressAsync
16200 );
16201
16218 void cancel();
16219
16220 };
16221
16305 interface ISnapshot : $unknown
16306 {
16310 readonly attribute wstringUUID id;
16311
16319 attribute wstring name;
16320
16328 attribute wstring description;
16329
16335 readonly attribute long long timeStamp;
16336
16348 readonly attribute boolean online;
16349
16361 readonly attribute IMachine machine;
16362
16369 readonly attribute ISnapshot parent;
16370
16379 readonly attribute ISnapshot[] children;
16380
16388 void getChildrenCount (
16389 [retval] out unsigned long childrenCount
16390 );
16391
16392 };
16393
16580 interface IMediumAttachment : $unknown
16581 {
16586 readonly attribute IMedium medium;
16587
16593 readonly attribute wstring controller;
16594
16600 readonly attribute long port;
16601
16607 readonly attribute long device;
16608
16612 readonly attribute DeviceType type;
16613
16617 readonly attribute boolean passthrough;
16618
16622 readonly attribute boolean temporaryEject;
16623
16628 readonly attribute boolean isEjected;
16629
16633 readonly attribute boolean nonRotational;
16634
16638 readonly attribute boolean discard;
16639
16643 readonly attribute boolean hotPluggable;
16644
16648 readonly attribute IBandwidthGroup bandwidthGroup;
16649
16650 };
16651
16809 interface IMedium : $unknown
16810 {
16824 readonly attribute wstringUUID id;
16825
16844 attribute wstring description;
16845
16861 readonly attribute MediumState state;
16862
16871 readonly attribute MediumVariant[] variant;
16872
16882 readonly attribute wstring location;
16883
16903 readonly attribute wstring name;
16904
16909 readonly attribute DeviceType deviceType;
16910
16914 readonly attribute boolean hostDrive;
16915
16928 readonly attribute long long size;
16929
16944 readonly attribute wstring format;
16945
16961 readonly attribute IMediumFormat mediumFormat;
16962
16987 attribute MediumType type;
16988
17002 readonly attribute MediumType[] allowedTypes;
17003
17013 readonly attribute IMedium parent;
17014
17022 readonly attribute IMedium[] children;
17023
17034 readonly attribute IMedium base;
17035
17068 readonly attribute boolean readOnly;
17069
17085 readonly attribute long long logicalSize;
17086
17114 attribute boolean autoReset;
17115
17130 readonly attribute wstring lastAccessError;
17131
17148 readonly attribute wstringUUID[] machineIds;
17149
17175 void setIds (
17176 in boolean setImageId,
17177 in wstringUUID imageId,
17178 in boolean setParentId,
17179 in wstringUUID parentId
17180 );
17181
17216 void refreshState (
17217 [retval] out MediumState state
17218 );
17219
17246 void getSnapshotIds (
17247 in wstringUUID machineId,
17248 [retval] out wstringUUID[] snapshotIds
17249 );
17250
17313 void lockRead (
17314 [retval] out IToken token
17315 );
17316
17371 void lockWrite (
17372 [retval] out IToken token
17373 );
17374
17424 void close();
17425
17455 void getProperty (
17456 in wstring name,
17457 [retval] out wstring value
17458 );
17459
17491 void setProperty (
17492 in wstring name,
17493 in wstring value
17494 );
17495
17530 void getProperties (
17531 in wstring names,
17532 out wstring[] returnNames,
17533 [retval] out wstring[] returnValues
17534 );
17535
17565 void setProperties (
17566 in wstring[] names,
17567 in wstring[] values
17568 );
17569
17602 void createBaseStorage (
17603 in long long logicalSize,
17604 in MediumVariant[] variant,
17605 [retval] out IProgress progress
17606 );
17607
17659 void deleteStorage (
17660 [retval] out IProgress progress
17661 );
17662
17701 void createDiffStorage (
17702 in IMedium target,
17703 in MediumVariant[] variant,
17704 [retval] out IProgress progress
17705 );
17706
17782 void mergeTo (
17783 in IMedium target,
17784 [retval] out IProgress progress
17785 );
17786
17836 void cloneTo (
17837 in IMedium target,
17838 in MediumVariant[] variant,
17839 in IMedium parent,
17840 [retval] out IProgress progress
17841 );
17842
17889 void cloneToBase (
17890 in IMedium target,
17891 in MediumVariant[] variant,
17892 [retval] out IProgress progress
17893 );
17894
17936 void setLocation (
17937 in wstring location,
17938 [retval] out IProgress progress
17939 );
17940
17969 void compact (
17970 [retval] out IProgress progress
17971 );
17972
18005 void resize (
18006 in long long logicalSize,
18007 [retval] out IProgress progress
18008 );
18009
18043 void reset (
18044 [retval] out IProgress progress
18045 );
18046
18047 };
18048
18071 interface IMediumFormat : $unknown
18072 {
18091 readonly attribute wstring id;
18092
18100 readonly attribute wstring name;
18101
18110 readonly attribute MediumFormatCapabilities[] capabilities;
18111
18130 void describeFileExtensions (
18131 out wstring[] extensions,
18132 out DeviceType[] types
18133 );
18134
18162 void describeProperties (
18163 out wstring[] names,
18164 out wstring[] descriptions,
18165 out DataType[] types,
18166 out unsigned long[] flags,
18167 out wstring[] defaults
18168 );
18169
18170 };
18171
18186 interface IToken : $unknown
18187 {
18196 void abandon();
18197
18204 void dummy();
18205
18206 };
18207
18219 interface IKeyboard : $unknown
18220 {
18226 readonly attribute IEventSource eventSource;
18227
18240 void putScancode (
18241 in long scancode
18242 );
18243
18256 void putScancodes (
18257 in long[] scancodes,
18258 [retval] out unsigned long codesStored
18259 );
18260
18275 void putCAD();
18276
18277 };
18278
18290 interface IMouse : $unknown
18291 {
18306 readonly attribute boolean absoluteSupported;
18307
18322 readonly attribute boolean relativeSupported;
18323
18337 readonly attribute boolean multiTouchSupported;
18338
18353 readonly attribute boolean needsHostCursor;
18354
18360 readonly attribute IEventSource eventSource;
18361
18427 void putMouseEvent (
18428 in long dx,
18429 in long dy,
18430 in long dz,
18431 in long dw,
18432 in long buttonState
18433 );
18434
18507 void putMouseEventAbsolute (
18508 in long x,
18509 in long y,
18510 in long dz,
18511 in long dw,
18512 in long buttonState
18513 );
18514
18562 void putEventMultiTouch (
18563 in long count,
18564 in long long[] contacts,
18565 in unsigned long scanTime
18566 );
18567
18583 void putEventMultiTouchString (
18584 in long count,
18585 in wstring contacts,
18586 in unsigned long scanTime
18587 );
18588
18589 };
18590
18591 interface IFramebuffer : $unknown
18592 {
18601 readonly attribute octetPtr address;
18602
18606 readonly attribute unsigned long width;
18607
18611 readonly attribute unsigned long height;
18612
18619 readonly attribute unsigned long bitsPerPixel;
18620
18627 readonly attribute unsigned long bytesPerLine;
18628
18639 readonly attribute unsigned long pixelFormat;
18640
18647 readonly attribute boolean usesGuestVRAM;
18648
18658 readonly attribute unsigned long heightReduction;
18659
18674 readonly attribute IFramebufferOverlay overlay;
18675
18682 readonly attribute long long winId;
18683
18691 void lock();
18692
18700 void unlock();
18701
18709 void notifyUpdate (
18710 in unsigned long x,
18711 in unsigned long y,
18712 in unsigned long width,
18713 in unsigned long height
18714 );
18715
18828 void requestResize (
18829 in unsigned long screenId,
18830 in unsigned long pixelFormat,
18831 in octetPtr VRAM,
18832 in unsigned long bitsPerPixel,
18833 in unsigned long bytesPerLine,
18834 in unsigned long width,
18835 in unsigned long height,
18836 [retval] out boolean finished
18837 );
18838
18850 void videoModeSupported (
18851 in unsigned long width,
18852 in unsigned long height,
18853 in unsigned long bpp,
18854 [retval] out boolean supported
18855 );
18856
18893 void getVisibleRegion (
18894 in octetPtr rectangles,
18895 in unsigned long count,
18896 [retval] out unsigned long countCopied
18897 );
18898
18933 void setVisibleRegion (
18934 in octetPtr rectangles,
18935 in unsigned long count
18936 );
18937
18958 void processVHWACommand (
18959 in octetPtr command
18960 );
18961
18976 void notify3DEvent (
18977 in unsigned long type,
18978 in octetPtr data
18979 );
18980
18981 };
18982
18997 interface IFramebufferOverlay : IFramebuffer
18998 {
19002 readonly attribute unsigned long x;
19003
19007 readonly attribute unsigned long y;
19008
19014 attribute boolean visible;
19015
19022 attribute unsigned long alpha;
19023
19029 void move (
19030 in unsigned long x,
19031 in unsigned long y
19032 );
19033
19034 };
19035
19051 interface IDisplay : $unknown
19052 {
19056 void getScreenResolution (
19057 in unsigned long screenId,
19058 out unsigned long width,
19059 out unsigned long height,
19060 out unsigned long bitsPerPixel,
19061 out long xOrigin,
19062 out long yOrigin
19063 );
19064
19070 void setFramebuffer (
19071 in unsigned long screenId,
19072 in IFramebuffer framebuffer
19073 );
19074
19080 void getFramebuffer (
19081 in unsigned long screenId,
19082 out IFramebuffer framebuffer,
19083 out long xOrigin,
19084 out long yOrigin
19085 );
19086
19137 void setVideoModeHint (
19138 in unsigned long display,
19139 in boolean enabled,
19140 in boolean changeOrigin,
19141 in long originX,
19142 in long originY,
19143 in unsigned long width,
19144 in unsigned long height,
19145 in unsigned long bitsPerPixel
19146 );
19147
19159 void setSeamlessMode (
19160 in boolean enabled
19161 );
19162
19198 void takeScreenShot (
19199 in unsigned long screenId,
19200 in octetPtr address,
19201 in unsigned long width,
19202 in unsigned long height
19203 );
19204
19248 void takeScreenShotToArray (
19249 in unsigned long screenId,
19250 in unsigned long width,
19251 in unsigned long height,
19252 [retval] out octet[] screenData
19253 );
19254
19293 void takeScreenShotPNGToArray (
19294 in unsigned long screenId,
19295 in unsigned long width,
19296 in unsigned long height,
19297 [retval] out octet[] screenData
19298 );
19299
19351 void drawToScreen (
19352 in unsigned long screenId,
19353 in octetPtr address,
19354 in unsigned long x,
19355 in unsigned long y,
19356 in unsigned long width,
19357 in unsigned long height
19358 );
19359
19374 void invalidateAndUpdate();
19375
19389 void resizeCompleted (
19390 in unsigned long screenId
19391 );
19392
19405 void completeVHWACommand (
19406 in octetPtr command
19407 );
19408
19442 void viewportChanged (
19443 in unsigned long screenId,
19444 in unsigned long x,
19445 in unsigned long y,
19446 in unsigned long width,
19447 in unsigned long height
19448 );
19449
19450 };
19451
19467 interface INetworkAdapter : $unknown
19468 {
19476 attribute NetworkAdapterType adapterType;
19477
19485 readonly attribute unsigned long slot;
19486
19495 attribute boolean enabled;
19496
19503 attribute wstring MACAddress;
19504
19510 attribute NetworkAttachmentType attachmentType;
19511
19517 attribute wstring bridgedInterface;
19518
19524 attribute wstring hostOnlyInterface;
19525
19531 attribute wstring internalNetwork;
19532
19538 attribute wstring NATNetwork;
19539
19545 attribute wstring genericDriver;
19546
19553 attribute boolean cableConnected;
19554
19560 attribute unsigned long lineSpeed;
19561
19568 attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
19569
19576 attribute boolean traceEnabled;
19577
19584 attribute wstring traceFile;
19585
19593 readonly attribute INATEngine NATEngine;
19594
19601 attribute unsigned long bootPriority;
19602
19606 attribute IBandwidthGroup bandwidthGroup;
19607
19626 void getProperty (
19627 in wstring key,
19628 [retval] out wstring value
19629 );
19630
19649 void setProperty (
19650 in wstring key,
19651 in wstring value
19652 );
19653
19681 void getProperties (
19682 in wstring names,
19683 out wstring[] returnNames,
19684 [retval] out wstring[] returnValues
19685 );
19686
19687 };
19688
19717 interface ISerialPort : $unknown
19718 {
19726 readonly attribute unsigned long slot;
19727
19734 attribute boolean enabled;
19735
19739 attribute unsigned long IOBase;
19740
19744 attribute unsigned long IRQ;
19745
19756 attribute PortMode hostMode;
19757
19765 attribute boolean server;
19766
19776 attribute wstring path;
19777
19778 };
19779
19799 interface IParallelPort : $unknown
19800 {
19808 readonly attribute unsigned long slot;
19809
19816 attribute boolean enabled;
19817
19821 attribute unsigned long IOBase;
19822
19826 attribute unsigned long IRQ;
19827
19835 attribute wstring path;
19836
19837 };
19838
19839 interface IMachineDebugger : $unknown
19840 {
19844 attribute boolean singleStep;
19845
19849 attribute boolean recompileUser;
19850
19854 attribute boolean recompileSupervisor;
19855
19863 attribute boolean executeAllInIEM;
19864
19868 attribute boolean PATMEnabled;
19869
19873 attribute boolean CSAMEnabled;
19874
19878 attribute boolean logEnabled;
19879
19883 readonly attribute wstring logDbgFlags;
19884
19888 readonly attribute wstring logDbgGroups;
19889
19893 readonly attribute wstring logDbgDestinations;
19894
19898 readonly attribute wstring logRelFlags;
19899
19903 readonly attribute wstring logRelGroups;
19904
19908 readonly attribute wstring logRelDestinations;
19909
19916 readonly attribute boolean HWVirtExEnabled;
19917
19924 readonly attribute boolean HWVirtExNestedPagingEnabled;
19925
19932 readonly attribute boolean HWVirtExVPIDEnabled;
19933
19940 readonly attribute boolean HWVirtExUXEnabled;
19941
19950 readonly attribute wstring OSName;
19951
19960 readonly attribute wstring OSVersion;
19961
19968 readonly attribute boolean PAEEnabled;
19969
19976 attribute unsigned long virtualTimeRate;
19977
19985 readonly attribute long long VM;
19986
20002 void dumpGuestCore (
20003 in wstring filename,
20004 in wstring compression
20005 );
20006
20023 void dumpHostProcessCore (
20024 in wstring filename,
20025 in wstring compression
20026 );
20027
20048 void info (
20049 in wstring name,
20050 in wstring args,
20051 [retval] out wstring info
20052 );
20053
20059 void injectNMI();
20060
20071 void modifyLogGroups (
20072 in wstring settings
20073 );
20074
20085 void modifyLogFlags (
20086 in wstring settings
20087 );
20088
20099 void modifyLogDestinations (
20100 in wstring settings
20101 );
20102
20117 void readPhysicalMemory (
20118 in long long address,
20119 in unsigned long size,
20120 [retval] out octet[] bytes
20121 );
20122
20137 void writePhysicalMemory (
20138 in long long address,
20139 in unsigned long size,
20140 in octet[] bytes
20141 );
20142
20159 void readVirtualMemory (
20160 in unsigned long cpuId,
20161 in long long address,
20162 in unsigned long size,
20163 [retval] out octet[] bytes
20164 );
20165
20182 void writeVirtualMemory (
20183 in unsigned long cpuId,
20184 in long long address,
20185 in unsigned long size,
20186 in octet[] bytes
20187 );
20188
20201 void detectOS (
20202 [retval] out wstring os
20203 );
20204
20222 void getRegister (
20223 in unsigned long cpuId,
20224 in wstring name,
20225 [retval] out wstring value
20226 );
20227
20245 void getRegisters (
20246 in unsigned long cpuId,
20247 out wstring[] names,
20248 out wstring[] values
20249 );
20250
20269 void setRegister (
20270 in unsigned long cpuId,
20271 in wstring name,
20272 in wstring value
20273 );
20274
20293 void setRegisters (
20294 in unsigned long cpuId,
20295 in wstring[] names,
20296 in wstring[] values
20297 );
20298
20311 void dumpGuestStack (
20312 in unsigned long cpuId,
20313 [retval] out wstring stack
20314 );
20315
20323 void resetStats (
20324 in wstring pattern
20325 );
20326
20334 void dumpStats (
20335 in wstring pattern
20336 );
20337
20349 void getStats (
20350 in wstring pattern,
20351 in boolean withDescriptions,
20352 [retval] out wstring stats
20353 );
20354
20355 };
20356
20357 interface IUSBDeviceFilters : $unknown
20358 {
20384 readonly attribute IUSBDeviceFilter[] deviceFilters;
20385
20413 void createDeviceFilter (
20414 in wstring name,
20415 [retval] out IUSBDeviceFilter filter
20416 );
20417
20462 void insertDeviceFilter (
20463 in unsigned long position,
20464 in IUSBDeviceFilter filter
20465 );
20466
20499 void removeDeviceFilter (
20500 in unsigned long position,
20501 [retval] out IUSBDeviceFilter filter
20502 );
20503
20504 };
20505
20506 interface IUSBController : $unknown
20507 {
20513 readonly attribute wstring name;
20514
20520 readonly attribute USBControllerType type;
20521
20529 readonly attribute unsigned short USBStandard;
20530
20531 };
20532
20545 interface IUSBDevice : $unknown
20546 {
20553 readonly attribute wstringUUID id;
20554
20558 readonly attribute unsigned short vendorId;
20559
20563 readonly attribute unsigned short productId;
20564
20572 readonly attribute unsigned short revision;
20573
20577 readonly attribute wstring manufacturer;
20578
20582 readonly attribute wstring product;
20583
20587 readonly attribute wstring serialNumber;
20588
20592 readonly attribute wstring address;
20593
20600 readonly attribute unsigned short port;
20601
20607 readonly attribute unsigned short version;
20608
20616 readonly attribute unsigned short portVersion;
20617
20624 readonly attribute boolean remote;
20625
20626 };
20627
20702 interface IUSBDeviceFilter : $unknown
20703 {
20711 attribute wstring name;
20712
20716 attribute boolean active;
20717
20725 attribute wstring vendorId;
20726
20734 attribute wstring productId;
20735
20749 attribute wstring revision;
20750
20755 attribute wstring manufacturer;
20756
20761 attribute wstring product;
20762
20767 attribute wstring serialNumber;
20768
20773 attribute wstring port;
20774
20784 attribute wstring remote;
20785
20795 attribute unsigned long maskedInterfaces;
20796
20797 };
20798
20815 interface IHostUSBDevice : IUSBDevice
20816 {
20822 readonly attribute USBDeviceState state;
20823
20824 };
20825
20848 interface IHostUSBDeviceFilter : IUSBDeviceFilter
20849 {
20856 attribute USBDeviceFilterAction action;
20857
20858 };
20859
20868 interface IAudioAdapter : $unknown
20869 {
20878 attribute boolean enabled;
20879
20885 attribute AudioControllerType audioController;
20886
20893 attribute AudioDriverType audioDriver;
20894
20895 };
20896
20897 interface IVRDEServer : $unknown
20898 {
20902 attribute boolean enabled;
20903
20907 attribute AuthType authType;
20908
20912 attribute unsigned long authTimeout;
20913
20920 attribute boolean allowMultiConnection;
20921
20929 attribute boolean reuseSingleConnection;
20930
20937 attribute wstring VRDEExtPack;
20938
20945 attribute wstring authLibrary;
20946
20952 readonly attribute wstring[] VRDEProperties;
20953
20967 void setVRDEProperty (
20968 in wstring key,
20969 in wstring value
20970 );
20971
20985 void getVRDEProperty (
20986 in wstring key,
20987 [retval] out wstring value
20988 );
20989
20990 };
20991
21049 interface ISharedFolder : $unknown
21050 {
21054 readonly attribute wstring name;
21055
21059 readonly attribute wstring hostPath;
21060
21070 readonly attribute boolean accessible;
21071
21078 readonly attribute boolean writable;
21079
21085 readonly attribute boolean autoMount;
21086
21099 readonly attribute wstring lastAccessError;
21100
21101 };
21102
21103 interface IInternalSessionControl : $unknown
21104 {
21109 void getPID (
21110 [retval] out unsigned long pid
21111 );
21112
21134 void getRemoteConsole (
21135 [retval] out IConsole console
21136 );
21137
21152 void assignRemoteMachine (
21153 in IMachine machine,
21154 in IConsole console
21155 );
21156
21180 void updateMachineState (
21181 in MachineState machineState
21182 );
21183
21199 void uninitialize();
21200
21223 void onNetworkAdapterChange (
21224 in INetworkAdapter networkAdapter,
21225 in boolean changeAdapter
21226 );
21227
21250 void onSerialPortChange (
21251 in ISerialPort serialPort
21252 );
21253
21276 void onParallelPortChange (
21277 in IParallelPort parallelPort
21278 );
21279
21302 void onStorageControllerChange();
21303
21330 void onMediumChange (
21331 in IMediumAttachment mediumAttachment,
21332 in boolean force
21333 );
21334
21364 void onStorageDeviceChange (
21365 in IMediumAttachment mediumAttachment,
21366 in boolean remove,
21367 in boolean silent
21368 );
21369
21377 void onClipboardModeChange (
21378 in ClipboardMode clipboardMode
21379 );
21380
21388 void onDragAndDropModeChange (
21389 in DragAndDropMode dragAndDropMode
21390 );
21391
21401 void onCPUChange (
21402 in unsigned long cpu,
21403 in boolean add
21404 );
21405
21413 void onCPUExecutionCapChange (
21414 in unsigned long executionCap
21415 );
21416
21441 void onVRDEServerChange (
21442 in boolean restart
21443 );
21444
21450 void onVideoCaptureChange();
21451
21474 void onUSBControllerChange();
21475
21504 void onSharedFolderChange (
21505 in boolean global
21506 );
21507
21533 void onUSBDeviceAttach (
21534 in IUSBDevice device,
21535 in IVirtualBoxErrorInfo error,
21536 in unsigned long maskedInterfaces
21537 );
21538
21564 void onUSBDeviceDetach (
21565 in wstringUUID id,
21566 in IVirtualBoxErrorInfo error
21567 );
21568
21586 void onShowWindow (
21587 in boolean check,
21588 out boolean canShow,
21589 out long long winId
21590 );
21591
21599 void onBandwidthGroupChange (
21600 in IBandwidthGroup bandwidthGroup
21601 );
21602
21626 void accessGuestProperty (
21627 in wstring name,
21628 in wstring value,
21629 in wstring flags,
21630 in boolean isSetter,
21631 out wstring retValue,
21632 out long long retTimestamp,
21633 out wstring retFlags
21634 );
21635
21683 void enumerateGuestProperties (
21684 in wstring patterns,
21685 out wstring[] keys,
21686 out wstring[] values,
21687 out long long[] timestamps,
21688 out wstring[] flags
21689 );
21690
21725 void onlineMergeMedium (
21726 in IMediumAttachment mediumAttachment,
21727 in unsigned long sourceIdx,
21728 in unsigned long targetIdx,
21729 in IProgress progress
21730 );
21731
21755 void enableVMMStatistics (
21756 in boolean enable
21757 );
21758
21786 void pauseWithReason (
21787 in Reason reason
21788 );
21789
21817 void resumeWithReason (
21818 in Reason reason
21819 );
21820
21850 void saveStateWithReason (
21851 in Reason reason,
21852 [retval] out IProgress progress
21853 );
21854
21878 void assignMachine (
21879 in IMachine machine,
21880 in LockType lockType,
21881 in wstring tokenId
21882 );
21883
21907 void assignMachine (
21908 in IMachine machine,
21909 in LockType lockType,
21910 in IToken token
21911 );
21912
21913 };
21914
21973 interface ISession : $unknown
21974 {
21978 readonly attribute SessionState state;
21979
21987 readonly attribute SessionType type;
21988
21992 readonly attribute IMachine machine;
21993
21997 readonly attribute IConsole console;
21998
22030 void unlockMachine();
22031
22032 };
22033
22056 interface IStorageController : $unknown
22057 {
22066 readonly attribute wstring name;
22067
22073 readonly attribute unsigned long maxDevicesPerPortCount;
22074
22080 readonly attribute unsigned long minPortCount;
22081
22087 readonly attribute unsigned long maxPortCount;
22088
22094 attribute unsigned long instance;
22095
22104 attribute unsigned long portCount;
22105
22111 readonly attribute StorageBus bus;
22112
22125 attribute StorageControllerType controllerType;
22126
22141 attribute boolean useHostIOCache;
22142
22148 readonly attribute boolean bootable;
22149
22150 };
22151
22175 interface IManagedObjectRef : $unknown
22176 {
22183 void getInterfaceName (
22184 [retval] out wstring return
22185 );
22186
22194 void release();
22195
22196 };
22197
22206 interface IWebsessionManager : $unknown
22207 {
22216 void logon (
22217 in wstring username,
22218 in wstring password,
22219 [retval] out IVirtualBox return
22220 );
22221
22231 void getSessionObject (
22232 in IVirtualBox refIVirtualBox,
22233 [retval] out ISession return
22234 );
22235
22243 void logoff (
22244 in IVirtualBox refIVirtualBox
22245 );
22246
22247 };
22248
22257 interface IPerformanceMetric : $unknown
22258 {
22264 readonly attribute wstring metricName;
22265
22271 readonly attribute $unknown object;
22272
22278 readonly attribute wstring description;
22279
22285 readonly attribute unsigned long period;
22286
22296 readonly attribute unsigned long count;
22297
22303 readonly attribute wstring unit;
22304
22310 readonly attribute long minimumValue;
22311
22317 readonly attribute long maximumValue;
22318
22319 };
22320
22427 interface IPerformanceCollector : $unknown
22428 {
22439 readonly attribute wstring[] metricNames;
22440
22464 void getMetrics (
22465 in wstring[] metricNames,
22466 in $unknown[] objects,
22467 [retval] out IPerformanceMetric[] metrics
22468 );
22469
22508 void setupMetrics (
22509 in wstring[] metricNames,
22510 in $unknown[] objects,
22511 in unsigned long period,
22512 in unsigned long count,
22513 [retval] out IPerformanceMetric[] affectedMetrics
22514 );
22515
22544 void enableMetrics (
22545 in wstring[] metricNames,
22546 in $unknown[] objects,
22547 [retval] out IPerformanceMetric[] affectedMetrics
22548 );
22549
22578 void disableMetrics (
22579 in wstring[] metricNames,
22580 in $unknown[] objects,
22581 [retval] out IPerformanceMetric[] affectedMetrics
22582 );
22583
22673 void queryMetricsData (
22674 in wstring[] metricNames,
22675 in $unknown[] objects,
22676 out wstring[] returnMetricNames,
22677 out $unknown[] returnObjects,
22678 out wstring[] returnUnits,
22679 out unsigned long[] returnScales,
22680 out unsigned long[] returnSequenceNumbers,
22681 out unsigned long[] returnDataIndices,
22682 out unsigned long[] returnDataLengths,
22683 [retval] out long[] returnData
22684 );
22685
22686 };
22687
22695 interface INATEngine : $unknown
22696 {
22701 attribute wstring network;
22702
22709 attribute wstring hostIP;
22710
22715 attribute wstring TFTPPrefix;
22716
22721 attribute wstring TFTPBootFile;
22722
22730 attribute wstring TFTPNextServer;
22731
22735 attribute unsigned long aliasMode;
22736
22740 attribute boolean DNSPassDomain;
22741
22746 attribute boolean DNSProxy;
22747
22752 attribute boolean DNSUseHostResolver;
22753
22758 readonly attribute wstring[] redirects;
22759
22775 void setNetworkSettings (
22776 in unsigned long mtu,
22777 in unsigned long sockSnd,
22778 in unsigned long sockRcv,
22779 in unsigned long TcpWndSnd,
22780 in unsigned long TcpWndRcv
22781 );
22782
22787 void getNetworkSettings (
22788 out unsigned long mtu,
22789 out unsigned long sockSnd,
22790 out unsigned long sockRcv,
22791 out unsigned long TcpWndSnd,
22792 out unsigned long TcpWndRcv
22793 );
22794
22814 void addRedirect (
22815 in wstring name,
22816 in NATProtocol proto,
22817 in wstring hostIP,
22818 in unsigned short hostPort,
22819 in wstring guestIP,
22820 in unsigned short guestPort
22821 );
22822
22828 void removeRedirect (
22829 in wstring name
22830 );
22831
22832 };
22833
22842 interface IExtPackPlugIn : $unknown
22843 {
22847 readonly attribute wstring name;
22848
22852 readonly attribute wstring description;
22853
22859 readonly attribute wstring frontend;
22860
22864 readonly attribute wstring modulePath;
22865
22866 };
22867
22876 interface IExtPackBase : $unknown
22877 {
22881 readonly attribute wstring name;
22882
22886 readonly attribute wstring description;
22887
22899 readonly attribute wstring version;
22900
22904 readonly attribute unsigned long revision;
22905
22915 readonly attribute wstring edition;
22916
22920 readonly attribute wstring VRDEModule;
22921
22925 readonly attribute IExtPackPlugIn[] plugIns;
22926
22936 readonly attribute boolean usable;
22937
22944 readonly attribute wstring whyUnusable;
22945
22949 readonly attribute boolean showLicense;
22950
22959 readonly attribute wstring license;
22960
22984 void queryLicense (
22985 in wstring preferredLocale,
22986 in wstring preferredLanguage,
22987 in wstring format,
22988 [retval] out wstring licenseText
22989 );
22990
22991 };
22992
23001 interface IExtPack : IExtPackBase
23002 {
23014 void queryObject (
23015 in wstring objUuid,
23016 [retval] out $unknown returnInterface
23017 );
23018
23019 };
23020
23030 interface IExtPackFile : IExtPackBase
23031 {
23037 readonly attribute wstring filePath;
23038
23057 void install (
23058 in boolean replace,
23059 in wstring displayInfo,
23060 [retval] out IProgress progess
23061 );
23062
23063 };
23064
23075 interface IExtPackManager : $unknown
23076 {
23082 readonly attribute IExtPack[] installedExtPacks;
23083
23101 void find (
23102 in wstring name,
23103 [retval] out IExtPack returnData
23104 );
23105
23117 void openExtPackFile (
23118 in wstring path,
23119 [retval] out IExtPackFile file
23120 );
23121
23140 void uninstall (
23141 in wstring name,
23142 in boolean forcedRemoval,
23143 in wstring displayInfo,
23144 [retval] out IProgress progess
23145 );
23146
23150 void cleanup();
23151
23164 void queryAllPlugInsForFrontend (
23165 in wstring frontendName,
23166 [retval] out wstring[] plugInModules
23167 );
23168
23176 void isExtPackUsable (
23177 in wstring name,
23178 [retval] out boolean usable
23179 );
23180
23181 };
23182
23188 interface IBandwidthGroup : $unknown
23189 {
23193 readonly attribute wstring name;
23194
23198 readonly attribute BandwidthGroupType type;
23199
23203 readonly attribute unsigned long reference;
23204
23209 attribute long long maxBytesPerSec;
23210
23211 };
23212
23221 interface IBandwidthControl : $unknown
23222 {
23228 readonly attribute unsigned long numGroups;
23229
23242 void createBandwidthGroup (
23243 in wstring name,
23244 in BandwidthGroupType type,
23245 in long long maxBytesPerSec
23246 );
23247
23255 void deleteBandwidthGroup (
23256 in wstring name
23257 );
23258
23268 void getBandwidthGroup (
23269 in wstring name,
23270 [retval] out IBandwidthGroup bandwidthGroup
23271 );
23272
23280 void getAllBandwidthGroups (
23281 [retval] out IBandwidthGroup[] bandwidthGroups
23282 );
23283
23284 };
23285
23298 interface IVirtualBoxClient : $unknown
23299 {
23305 readonly attribute IVirtualBox virtualBox;
23306
23312 readonly attribute ISession session;
23313
23319 readonly attribute IEventSource eventSource;
23320
23331 void checkMachineError (
23332 in IMachine machine
23333 );
23334
23335 };
23336
23350 interface IEventSource : $unknown
23351 {
23357 void createListener (
23358 [retval] out IEventListener listener
23359 );
23360
23376 void createAggregator (
23377 in IEventSource[] subordinates,
23378 [retval] out IEventSource result
23379 );
23380
23413 void registerListener (
23414 in IEventListener listener,
23415 in VBoxEventType[] interesting,
23416 in boolean active
23417 );
23418
23427 void unregisterListener (
23428 in IEventListener listener
23429 );
23430
23445 void fireEvent (
23446 in IEvent event,
23447 in long timeout,
23448 [retval] out boolean result
23449 );
23450
23475 void getEvent (
23476 in IEventListener listener,
23477 in long timeout,
23478 [retval] out IEvent event
23479 );
23480
23492 void eventProcessed (
23493 in IEventListener listener,
23494 in IEvent event
23495 );
23496
23497 };
23498
23508 interface IEventListener : $unknown
23509 {
23522 void handleEvent (
23523 in IEvent event
23524 );
23525
23526 };
23527
23604 interface IEvent : $unknown
23605 {
23611 readonly attribute VBoxEventType type;
23612
23618 readonly attribute IEventSource source;
23619
23630 readonly attribute boolean waitable;
23631
23638 void setProcessed();
23639
23653 void waitProcessed (
23654 in long timeout,
23655 [retval] out boolean result
23656 );
23657
23658 };
23659
23665 interface IReusableEvent : IEvent
23666 {
23670 readonly attribute unsigned long generation;
23671
23678 void reuse();
23679
23680 };
23681
23687 interface IMachineEvent : IEvent
23688 {
23692 readonly attribute wstringUUID machineId;
23693
23694 };
23695
23701 interface IMachineStateChangedEvent : IMachineEvent
23702 {
23706 readonly attribute MachineState state;
23707
23708 };
23709
23717 interface IMachineDataChangedEvent : IMachineEvent
23718 {
23725 readonly attribute boolean temporary;
23726
23727 };
23728
23737 interface IMediumRegisteredEvent : IEvent
23738 {
23742 readonly attribute wstringUUID mediumId;
23743
23747 readonly attribute DeviceType mediumType;
23748
23755 readonly attribute boolean registered;
23756
23757 };
23758
23767 interface IMachineRegisteredEvent : IMachineEvent
23768 {
23775 readonly attribute boolean registered;
23776
23777 };
23778
23788 interface ISessionStateChangedEvent : IMachineEvent
23789 {
23795 readonly attribute SessionState state;
23796
23797 };
23798
23806 interface IGuestPropertyChangedEvent : IMachineEvent
23807 {
23813 readonly attribute wstring name;
23814
23820 readonly attribute wstring value;
23821
23827 readonly attribute wstring flags;
23828
23829 };
23830
23836 interface ISnapshotEvent : IMachineEvent
23837 {
23841 readonly attribute wstringUUID snapshotId;
23842
23843 };
23844
23854 interface ISnapshotTakenEvent : ISnapshotEvent
23855 {
23856 };
23857
23874 interface ISnapshotDeletedEvent : ISnapshotEvent
23875 {
23876 };
23877
23887 interface ISnapshotChangedEvent : ISnapshotEvent
23888 {
23889 };
23890
23899 interface IMousePointerShapeChangedEvent : IEvent
23900 {
23906 readonly attribute boolean visible;
23907
23913 readonly attribute boolean alpha;
23914
23920 readonly attribute unsigned long xhot;
23921
23927 readonly attribute unsigned long yhot;
23928
23934 readonly attribute unsigned long width;
23935
23941 readonly attribute unsigned long height;
23942
23975 readonly attribute octet[] shape;
23976
23977 };
23978
23987 interface IMouseCapabilityChangedEvent : IEvent
23988 {
23994 readonly attribute boolean supportsAbsolute;
23995
24001 readonly attribute boolean supportsRelative;
24002
24008 readonly attribute boolean supportsMultiTouch;
24009
24015 readonly attribute boolean needsHostCursor;
24016
24017 };
24018
24027 interface IKeyboardLedsChangedEvent : IEvent
24028 {
24034 readonly attribute boolean numLock;
24035
24041 readonly attribute boolean capsLock;
24042
24048 readonly attribute boolean scrollLock;
24049
24050 };
24051
24060 interface IStateChangedEvent : IEvent
24061 {
24067 readonly attribute MachineState state;
24068
24069 };
24070
24080 interface IAdditionsStateChangedEvent : IEvent
24081 {
24082 };
24083
24094 interface INetworkAdapterChangedEvent : IEvent
24095 {
24101 readonly attribute INetworkAdapter networkAdapter;
24102
24103 };
24104
24115 interface ISerialPortChangedEvent : IEvent
24116 {
24122 readonly attribute ISerialPort serialPort;
24123
24124 };
24125
24136 interface IParallelPortChangedEvent : IEvent
24137 {
24143 readonly attribute IParallelPort parallelPort;
24144
24145 };
24146
24156 interface IStorageControllerChangedEvent : IEvent
24157 {
24158 };
24159
24169 interface IMediumChangedEvent : IEvent
24170 {
24176 readonly attribute IMediumAttachment mediumAttachment;
24177
24178 };
24179
24187 interface IClipboardModeChangedEvent : IEvent
24188 {
24194 readonly attribute ClipboardMode clipboardMode;
24195
24196 };
24197
24205 interface IDragAndDropModeChangedEvent : IEvent
24206 {
24212 readonly attribute DragAndDropMode dragAndDropMode;
24213
24214 };
24215
24223 interface ICPUChangedEvent : IEvent
24224 {
24230 readonly attribute unsigned long CPU;
24231
24237 readonly attribute boolean add;
24238
24239 };
24240
24248 interface ICPUExecutionCapChangedEvent : IEvent
24249 {
24255 readonly attribute unsigned long executionCap;
24256
24257 };
24258
24266 interface IGuestKeyboardEvent : IEvent
24267 {
24273 readonly attribute long[] scancodes;
24274
24275 };
24276
24284 interface IGuestMouseEvent : IReusableEvent
24285 {
24291 readonly attribute GuestMouseEventMode mode;
24292
24298 readonly attribute long x;
24299
24305 readonly attribute long y;
24306
24312 readonly attribute long z;
24313
24319 readonly attribute long w;
24320
24326 readonly attribute long buttons;
24327
24328 };
24329
24337 interface IGuestMultiTouchEvent : IEvent
24338 {
24344 readonly attribute long contactCount;
24345
24351 readonly attribute short[] xPositions;
24352
24358 readonly attribute short[] yPositions;
24359
24365 readonly attribute unsigned short[] contactIds;
24366
24374 readonly attribute unsigned short[] contactFlags;
24375
24381 readonly attribute unsigned long scanTime;
24382
24383 };
24384
24390 interface IGuestSessionEvent : IEvent
24391 {
24395 readonly attribute IGuestSession session;
24396
24397 };
24398
24406 interface IGuestSessionStateChangedEvent : IGuestSessionEvent
24407 {
24413 readonly attribute unsigned long id;
24414
24420 readonly attribute GuestSessionStatus status;
24421
24431 readonly attribute IVirtualBoxErrorInfo error;
24432
24433 };
24434
24442 interface IGuestSessionRegisteredEvent : IGuestSessionEvent
24443 {
24450 readonly attribute boolean registered;
24451
24452 };
24453
24459 interface IGuestProcessEvent : IGuestSessionEvent
24460 {
24466 readonly attribute IGuestProcess process;
24467
24473 readonly attribute unsigned long pid;
24474
24475 };
24476
24484 interface IGuestProcessRegisteredEvent : IGuestProcessEvent
24485 {
24492 readonly attribute boolean registered;
24493
24494 };
24495
24503 interface IGuestProcessStateChangedEvent : IGuestProcessEvent
24504 {
24510 readonly attribute ProcessStatus status;
24511
24521 readonly attribute IVirtualBoxErrorInfo error;
24522
24523 };
24524
24532 interface IGuestProcessIOEvent : IGuestProcessEvent
24533 {
24540 readonly attribute unsigned long handle;
24541
24547 readonly attribute unsigned long processed;
24548
24549 };
24550
24560 interface IGuestProcessInputNotifyEvent : IGuestProcessIOEvent
24561 {
24567 readonly attribute ProcessInputStatus status;
24568
24569 };
24570
24578 interface IGuestProcessOutputEvent : IGuestProcessIOEvent
24579 {
24585 readonly attribute octet[] data;
24586
24587 };
24588
24594 interface IGuestFileEvent : IGuestSessionEvent
24595 {
24601 readonly attribute IGuestFile file;
24602
24603 };
24604
24612 interface IGuestFileRegisteredEvent : IGuestFileEvent
24613 {
24620 readonly attribute boolean registered;
24621
24622 };
24623
24631 interface IGuestFileStateChangedEvent : IGuestFileEvent
24632 {
24638 readonly attribute FileStatus status;
24639
24649 readonly attribute IVirtualBoxErrorInfo error;
24650
24651 };
24652
24660 interface IGuestFileIOEvent : IGuestFileEvent
24661 {
24667 readonly attribute long long offset;
24668
24674 readonly attribute unsigned long processed;
24675
24676 };
24677
24685 interface IGuestFileOffsetChangedEvent : IGuestFileIOEvent
24686 {
24687 };
24688
24696 interface IGuestFileReadEvent : IGuestFileIOEvent
24697 {
24703 readonly attribute octet[] data;
24704
24705 };
24706
24714 interface IGuestFileWriteEvent : IGuestFileIOEvent
24715 {
24716 };
24717
24728 interface IVRDEServerChangedEvent : IEvent
24729 {
24730 };
24731
24741 interface IVRDEServerInfoChangedEvent : IEvent
24742 {
24743 };
24744
24752 interface IVideoCaptureChangedEvent : IEvent
24753 {
24754 };
24755
24766 interface IUSBControllerChangedEvent : IEvent
24767 {
24768 };
24769
24793 interface IUSBDeviceStateChangedEvent : IEvent
24794 {
24800 readonly attribute IUSBDevice device;
24801
24807 readonly attribute boolean attached;
24808
24814 readonly attribute IVirtualBoxErrorInfo error;
24815
24816 };
24817
24833 interface ISharedFolderChangedEvent : IEvent
24834 {
24840 readonly attribute Scope scope;
24841
24842 };
24843
24895 interface IRuntimeErrorEvent : IEvent
24896 {
24902 readonly attribute boolean fatal;
24903
24909 readonly attribute wstring id;
24910
24916 readonly attribute wstring message;
24917
24918 };
24919
24927 interface IEventSourceChangedEvent : IEvent
24928 {
24934 readonly attribute IEventListener listener;
24935
24941 readonly attribute boolean add;
24942
24943 };
24944
24953 interface IExtraDataChangedEvent : IEvent
24954 {
24961 readonly attribute wstringUUID machineId;
24962
24968 readonly attribute wstring key;
24969
24975 readonly attribute wstring value;
24976
24977 };
24978
24984 interface IVetoEvent : IEvent
24985 {
24995 void addVeto (
24996 in wstring reason
24997 );
24998
25008 void isVetoed (
25009 [retval] out boolean result
25010 );
25011
25021 void getVetos (
25022 [retval] out wstring[] result
25023 );
25024
25025 };
25026
25036 interface IExtraDataCanChangeEvent : IVetoEvent
25037 {
25044 readonly attribute wstringUUID machineId;
25045
25051 readonly attribute wstring key;
25052
25058 readonly attribute wstring value;
25059
25060 };
25061
25077 interface ICanShowWindowEvent : IVetoEvent
25078 {
25079 };
25080
25112 interface IShowWindowEvent : IEvent
25113 {
25122 attribute long long winId;
25123
25124 };
25125
25133 interface INATRedirectEvent : IMachineEvent
25134 {
25140 readonly attribute unsigned long slot;
25141
25147 readonly attribute boolean remove;
25148
25154 readonly attribute wstring name;
25155
25161 readonly attribute NATProtocol proto;
25162
25168 readonly attribute wstring hostIP;
25169
25175 readonly attribute long hostPort;
25176
25182 readonly attribute wstring guestIP;
25183
25189 readonly attribute long guestPort;
25190
25191 };
25192
25205 interface IHostPCIDevicePlugEvent : IMachineEvent
25206 {
25212 readonly attribute boolean plugged;
25213
25220 readonly attribute boolean success;
25221
25227 readonly attribute IPCIDeviceAttachment attachment;
25228
25234 readonly attribute wstring message;
25235
25236 };
25237
25246 interface IVBoxSVCAvailabilityChangedEvent : IEvent
25247 {
25253 readonly attribute boolean available;
25254
25255 };
25256
25264 interface IBandwidthGroupChangedEvent : IEvent
25265 {
25271 readonly attribute IBandwidthGroup bandwidthGroup;
25272
25273 };
25274
25282 interface IGuestMonitorChangedEvent : IEvent
25283 {
25289 readonly attribute GuestMonitorChangedEventType changeType;
25290
25296 readonly attribute unsigned long screenId;
25297
25304 readonly attribute unsigned long originX;
25305
25312 readonly attribute unsigned long originY;
25313
25320 readonly attribute unsigned long width;
25321
25328 readonly attribute unsigned long height;
25329
25330 };
25331
25339 interface IGuestUserStateChangedEvent : IEvent
25340 {
25346 readonly attribute wstring name;
25347
25354 readonly attribute wstring domain;
25355
25362 readonly attribute GuestUserState state;
25363
25369 readonly attribute wstring stateDetails;
25370
25371 };
25372
25382 interface IStorageDeviceChangedEvent : IEvent
25383 {
25389 readonly attribute IMediumAttachment storageDevice;
25390
25396 readonly attribute boolean removed;
25397
25403 readonly attribute boolean silent;
25404
25405 };
25406
25407 interface INATNetworkChangedEvent : IEvent
25408 {
25409 readonly attribute wstring networkName;
25410
25411 };
25412
25413 interface INATNetworkStartStopEvent : INATNetworkChangedEvent
25414 {
25420 readonly attribute boolean startEvent;
25421
25422 };
25423
25424 interface INATNetworkAlterEvent : INATNetworkChangedEvent
25425 {
25426 };
25427
25428 interface INATNetworkCreationDeletionEvent : INATNetworkAlterEvent
25429 {
25430 readonly attribute boolean creationEvent;
25431
25432 };
25433
25434 interface INATNetworkSettingEvent : INATNetworkAlterEvent
25435 {
25436 readonly attribute boolean enabled;
25437
25438 readonly attribute wstring network;
25439
25440 readonly attribute wstring gateway;
25441
25442 readonly attribute boolean advertiseDefaultIPv6RouteEnabled;
25443
25444 readonly attribute boolean needDhcpServer;
25445
25446 };
25447
25448 interface INATNetworkPortForwardEvent : INATNetworkAlterEvent
25449 {
25450 readonly attribute boolean create;
25451
25452 readonly attribute boolean ipv6;
25453
25454 readonly attribute wstring name;
25455
25456 readonly attribute NATProtocol proto;
25457
25458 readonly attribute wstring hostIp;
25459
25460 readonly attribute long hostPort;
25461
25462 readonly attribute wstring guestIp;
25463
25464 readonly attribute long guestPort;
25465
25466 };
25467
25468 interface IHostNameResolutionConfigurationChangeEvent : IEvent
25469 {
25470 };
25471
25472