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,
02347 CopyFileFlag_Recursive = 1,
02354 CopyFileFlag_Update = 2,
02359 CopyFileFlag_FollowLinks = 4,
02360 };
02361
02369 enum DirectoryCreateFlag
02370 {
02375 DirectoryCreateFlag_None = 0,
02380 DirectoryCreateFlag_Parents = 1,
02381 };
02382
02390 enum DirectoryRemoveRecFlag
02391 {
02396 DirectoryRemoveRecFlag_None = 0,
02401 DirectoryRemoveRecFlag_ContentAndDir = 1,
02406 DirectoryRemoveRecFlag_ContentOnly = 2,
02407 };
02408
02416 enum PathRenameFlag
02417 {
02422 PathRenameFlag_None = 0,
02427 PathRenameFlag_NoReplace = 1,
02432 PathRenameFlag_Replace = 2,
02437 PathRenameFlag_NoSymlinks = 4,
02438 };
02439
02447 enum ProcessCreateFlag
02448 {
02453 ProcessCreateFlag_None = 0,
02459 ProcessCreateFlag_WaitForProcessStartOnly = 1,
02464 ProcessCreateFlag_IgnoreOrphanedProcesses = 2,
02469 ProcessCreateFlag_Hidden = 4,
02474 ProcessCreateFlag_NoProfile = 8,
02479 ProcessCreateFlag_WaitForStdOut = 16,
02484 ProcessCreateFlag_WaitForStdErr = 32,
02489 ProcessCreateFlag_ExpandArguments = 64,
02490 };
02491
02499 enum ProcessPriority
02500 {
02505 ProcessPriority_Invalid = 0,
02510 ProcessPriority_Default = 1,
02511 };
02512
02520 enum SymlinkType
02521 {
02526 SymlinkType_Unknown = 0,
02531 SymlinkType_Directory = 1,
02536 SymlinkType_File = 2,
02537 };
02538
02546 enum SymlinkReadFlag
02547 {
02552 SymlinkReadFlag_None = 0,
02557 SymlinkReadFlag_NoSymlinks = 1,
02558 };
02559
02567 enum ProcessStatus
02568 {
02573 ProcessStatus_Undefined = 0,
02578 ProcessStatus_Starting = 10,
02583 ProcessStatus_Started = 100,
02588 ProcessStatus_Paused = 110,
02593 ProcessStatus_Terminating = 480,
02598 ProcessStatus_TerminatedNormally = 500,
02603 ProcessStatus_TerminatedSignal = 510,
02608 ProcessStatus_TerminatedAbnormally = 511,
02613 ProcessStatus_TimedOutKilled = 512,
02618 ProcessStatus_TimedOutAbnormally = 513,
02623 ProcessStatus_Down = 600,
02628 ProcessStatus_Error = 800,
02629 };
02630
02638 enum ProcessInputStatus
02639 {
02644 ProcessInputStatus_Undefined = 0,
02649 ProcessInputStatus_Broken = 1,
02654 ProcessInputStatus_Available = 10,
02659 ProcessInputStatus_Written = 50,
02664 ProcessInputStatus_Overflow = 100,
02665 };
02666
02674 enum FileStatus
02675 {
02680 FileStatus_Undefined = 0,
02685 FileStatus_Opening = 10,
02690 FileStatus_Open = 100,
02695 FileStatus_Closing = 150,
02700 FileStatus_Closed = 200,
02705 FileStatus_Down = 600,
02710 FileStatus_Error = 800,
02711 };
02712
02720 enum FsObjType
02721 {
02726 FsObjType_Undefined = 0,
02731 FsObjType_FIFO = 1,
02736 FsObjType_DevChar = 10,
02741 FsObjType_DevBlock = 11,
02746 FsObjType_Directory = 50,
02751 FsObjType_File = 80,
02756 FsObjType_Symlink = 100,
02761 FsObjType_Socket = 200,
02766 FsObjType_Whiteout = 400,
02767 };
02768
02776 enum DragAndDropAction
02777 {
02782 DragAndDropAction_Ignore = 0,
02787 DragAndDropAction_Copy = 1,
02792 DragAndDropAction_Move = 2,
02797 DragAndDropAction_Link = 3,
02798 };
02799
02807 enum DirectoryOpenFlag
02808 {
02813 DirectoryOpenFlag_None = 0,
02818 DirectoryOpenFlag_NoSymlinks = 1,
02819 };
02820
02830 enum MediumState
02831 {
02839 MediumState_NotCreated = 0,
02848 MediumState_Created = 1,
02856 MediumState_LockedRead = 2,
02864 MediumState_LockedWrite = 3,
02874 MediumState_Inaccessible = 4,
02881 MediumState_Creating = 5,
02888 MediumState_Deleting = 6,
02889 };
02890
02901 enum MediumType
02902 {
02910 MediumType_Normal = 0,
02918 MediumType_Immutable = 1,
02926 MediumType_Writethrough = 2,
02935 MediumType_Shareable = 3,
02944 MediumType_Readonly = 4,
02956 MediumType_MultiAttach = 5,
02957 };
02958
02968 enum MediumVariant
02969 {
02976 MediumVariant_Standard = 0,
02983 MediumVariant_VmdkSplit2G = 0x01,
02990 MediumVariant_VmdkRawDisk = 0x02,
02998 MediumVariant_VmdkStreamOptimized = 0x04,
03005 MediumVariant_VmdkESX = 0x08,
03012 MediumVariant_Fixed = 0x10000,
03019 MediumVariant_Diff = 0x20000,
03027 MediumVariant_NoCreateDir = 0x40000000,
03028 };
03029
03030 enum DataType
03031 {
03032 DataType_Int32 = 0,
03033 DataType_Int8 = 1,
03034 DataType_String = 2,
03035 };
03036
03037 enum DataFlags
03038 {
03039 DataFlags_None = 0x00,
03040 DataFlags_Mandatory = 0x01,
03041 DataFlags_Expert = 0x02,
03042 DataFlags_Array = 0x04,
03043 DataFlags_FlagMask = 0x07,
03044 };
03045
03053 enum MediumFormatCapabilities
03054 {
03061 MediumFormatCapabilities_Uuid = 0x01,
03068 MediumFormatCapabilities_CreateFixed = 0x02,
03076 MediumFormatCapabilities_CreateDynamic = 0x04,
03083 MediumFormatCapabilities_CreateSplit2G = 0x08,
03090 MediumFormatCapabilities_Differencing = 0x10,
03097 MediumFormatCapabilities_Asynchronous = 0x20,
03107 MediumFormatCapabilities_File = 0x40,
03116 MediumFormatCapabilities_Properties = 0x80,
03123 MediumFormatCapabilities_TcpNetworking = 0x100,
03130 MediumFormatCapabilities_VFS = 0x200,
03131 MediumFormatCapabilities_CapabilityMask = 0x3FF,
03132 };
03133
03141 enum MouseButtonState
03142 {
03143 MouseButtonState_LeftButton = 0x01,
03144 MouseButtonState_RightButton = 0x02,
03145 MouseButtonState_MiddleButton = 0x04,
03146 MouseButtonState_WheelUp = 0x08,
03147 MouseButtonState_WheelDown = 0x10,
03148 MouseButtonState_XButton1 = 0x20,
03149 MouseButtonState_XButton2 = 0x40,
03150 MouseButtonState_MouseStateMask = 0x7F,
03151 };
03152
03160 enum TouchContactState
03161 {
03166 TouchContactState_None = 0x00,
03171 TouchContactState_InContact = 0x01,
03178 TouchContactState_InRange = 0x02,
03179 TouchContactState_ContactStateMask = 0x03,
03180 };
03181
03192 enum FramebufferPixelFormat
03193 {
03201 FramebufferPixelFormat_Opaque = 0,
03209 FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
03210 };
03211
03219 enum NetworkAttachmentType
03220 {
03225 NetworkAttachmentType_Null = 0,
03226 NetworkAttachmentType_NAT = 1,
03227 NetworkAttachmentType_Bridged = 2,
03228 NetworkAttachmentType_Internal = 3,
03229 NetworkAttachmentType_HostOnly = 4,
03230 NetworkAttachmentType_Generic = 5,
03231 NetworkAttachmentType_NATNetwork = 6,
03232 };
03233
03241 enum NetworkAdapterType
03242 {
03247 NetworkAdapterType_Null = 0,
03252 NetworkAdapterType_Am79C970A = 1,
03257 NetworkAdapterType_Am79C973 = 2,
03262 NetworkAdapterType_I82540EM = 3,
03267 NetworkAdapterType_I82543GC = 4,
03272 NetworkAdapterType_I82545EM = 5,
03277 NetworkAdapterType_Virtio = 6,
03278 };
03279
03287 enum NetworkAdapterPromiscModePolicy
03288 {
03293 NetworkAdapterPromiscModePolicy_Deny = 1,
03301 NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
03309 NetworkAdapterPromiscModePolicy_AllowAll = 3,
03310 };
03311
03320 enum PortMode
03321 {
03326 PortMode_Disconnected = 0,
03331 PortMode_HostPipe = 1,
03336 PortMode_HostDevice = 2,
03341 PortMode_RawFile = 3,
03342 };
03343
03351 enum USBControllerType
03352 {
03357 USBControllerType_Null = 0,
03358 USBControllerType_OHCI = 1,
03359 USBControllerType_EHCI = 2,
03364 USBControllerType_Last = 3,
03365 };
03366
03405 enum USBDeviceState
03406 {
03413 USBDeviceState_NotSupported = 0,
03421 USBDeviceState_Unavailable = 1,
03428 USBDeviceState_Busy = 2,
03436 USBDeviceState_Available = 3,
03444 USBDeviceState_Held = 4,
03452 USBDeviceState_Captured = 5,
03453 };
03454
03464 enum USBDeviceFilterAction
03465 {
03470 USBDeviceFilterAction_Null = 0,
03475 USBDeviceFilterAction_Ignore = 1,
03480 USBDeviceFilterAction_Hold = 2,
03481 };
03482
03490 enum AudioDriverType
03491 {
03496 AudioDriverType_Null = 0,
03501 AudioDriverType_WinMM = 1,
03506 AudioDriverType_OSS = 2,
03511 AudioDriverType_ALSA = 3,
03516 AudioDriverType_DirectSound = 4,
03521 AudioDriverType_CoreAudio = 5,
03526 AudioDriverType_MMPM = 6,
03531 AudioDriverType_Pulse = 7,
03536 AudioDriverType_SolAudio = 8,
03537 };
03538
03546 enum AudioControllerType
03547 {
03548 AudioControllerType_AC97 = 0,
03549 AudioControllerType_SB16 = 1,
03550 AudioControllerType_HDA = 2,
03551 };
03552
03560 enum AuthType
03561 {
03566 AuthType_Null = 0,
03567 AuthType_External = 1,
03568 AuthType_Guest = 2,
03569 };
03570
03578 enum Reason
03579 {
03584 Reason_Unspecified = 0,
03589 Reason_HostSuspend = 1,
03594 Reason_HostResume = 2,
03599 Reason_HostBatteryLow = 3,
03600 };
03601
03610 enum StorageBus
03611 {
03616 StorageBus_Null = 0,
03617 StorageBus_IDE = 1,
03618 StorageBus_SATA = 2,
03619 StorageBus_SCSI = 3,
03620 StorageBus_Floppy = 4,
03621 StorageBus_SAS = 5,
03622 };
03623
03632 enum StorageControllerType
03633 {
03638 StorageControllerType_Null = 0,
03643 StorageControllerType_LsiLogic = 1,
03648 StorageControllerType_BusLogic = 2,
03653 StorageControllerType_IntelAhci = 3,
03658 StorageControllerType_PIIX3 = 4,
03663 StorageControllerType_PIIX4 = 5,
03668 StorageControllerType_ICH6 = 6,
03673 StorageControllerType_I82078 = 7,
03678 StorageControllerType_LsiLogicSas = 8,
03679 };
03680
03688 enum ChipsetType
03689 {
03694 ChipsetType_Null = 0,
03699 ChipsetType_PIIX3 = 1,
03704 ChipsetType_ICH9 = 2,
03705 };
03706
03712 enum NATAliasMode
03713 {
03718 NATAliasMode_AliasLog = 0x1,
03723 NATAliasMode_AliasProxyOnly = 0x02,
03728 NATAliasMode_AliasUseSamePorts = 0x04,
03729 };
03730
03736 enum NATProtocol
03737 {
03742 NATProtocol_UDP = 0,
03747 NATProtocol_TCP = 1,
03748 };
03749
03757 enum BandwidthGroupType
03758 {
03765 BandwidthGroupType_Null = 0,
03772 BandwidthGroupType_Disk = 1,
03779 BandwidthGroupType_Network = 2,
03780 };
03781
03790 enum VBoxEventType
03791 {
03798 VBoxEventType_Invalid = 0,
03807 VBoxEventType_Any = 1,
03815 VBoxEventType_Vetoable = 2,
03823 VBoxEventType_MachineEvent = 3,
03831 VBoxEventType_SnapshotEvent = 4,
03840 VBoxEventType_InputEvent = 5,
03847 VBoxEventType_LastWildcard = 31,
03854 VBoxEventType_OnMachineStateChanged = 32,
03861 VBoxEventType_OnMachineDataChanged = 33,
03868 VBoxEventType_OnExtraDataChanged = 34,
03875 VBoxEventType_OnExtraDataCanChange = 35,
03882 VBoxEventType_OnMediumRegistered = 36,
03889 VBoxEventType_OnMachineRegistered = 37,
03896 VBoxEventType_OnSessionStateChanged = 38,
03903 VBoxEventType_OnSnapshotTaken = 39,
03910 VBoxEventType_OnSnapshotDeleted = 40,
03917 VBoxEventType_OnSnapshotChanged = 41,
03924 VBoxEventType_OnGuestPropertyChanged = 42,
03931 VBoxEventType_OnMousePointerShapeChanged = 43,
03938 VBoxEventType_OnMouseCapabilityChanged = 44,
03945 VBoxEventType_OnKeyboardLedsChanged = 45,
03952 VBoxEventType_OnStateChanged = 46,
03959 VBoxEventType_OnAdditionsStateChanged = 47,
03966 VBoxEventType_OnNetworkAdapterChanged = 48,
03973 VBoxEventType_OnSerialPortChanged = 49,
03980 VBoxEventType_OnParallelPortChanged = 50,
03987 VBoxEventType_OnStorageControllerChanged = 51,
03994 VBoxEventType_OnMediumChanged = 52,
04001 VBoxEventType_OnVRDEServerChanged = 53,
04008 VBoxEventType_OnUSBControllerChanged = 54,
04015 VBoxEventType_OnUSBDeviceStateChanged = 55,
04022 VBoxEventType_OnSharedFolderChanged = 56,
04029 VBoxEventType_OnRuntimeError = 57,
04036 VBoxEventType_OnCanShowWindow = 58,
04043 VBoxEventType_OnShowWindow = 59,
04050 VBoxEventType_OnCPUChanged = 60,
04057 VBoxEventType_OnVRDEServerInfoChanged = 61,
04064 VBoxEventType_OnEventSourceChanged = 62,
04071 VBoxEventType_OnCPUExecutionCapChanged = 63,
04078 VBoxEventType_OnGuestKeyboard = 64,
04085 VBoxEventType_OnGuestMouse = 65,
04092 VBoxEventType_OnNATRedirect = 66,
04099 VBoxEventType_OnHostPCIDevicePlug = 67,
04106 VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
04113 VBoxEventType_OnBandwidthGroupChanged = 69,
04120 VBoxEventType_OnGuestMonitorChanged = 70,
04127 VBoxEventType_OnStorageDeviceChanged = 71,
04134 VBoxEventType_OnClipboardModeChanged = 72,
04141 VBoxEventType_OnDragAndDropModeChanged = 73,
04148 VBoxEventType_OnNATNetworkChanged = 74,
04155 VBoxEventType_OnNATNetworkStartStop = 75,
04162 VBoxEventType_OnNATNetworkAlter = 76,
04169 VBoxEventType_OnNATNetworkCreationDeletion = 77,
04176 VBoxEventType_OnNATNetworkSetting = 78,
04183 VBoxEventType_OnNATNetworkPortForward = 79,
04190 VBoxEventType_OnGuestSessionStateChanged = 80,
04197 VBoxEventType_OnGuestSessionRegistered = 81,
04204 VBoxEventType_OnGuestProcessRegistered = 82,
04211 VBoxEventType_OnGuestProcessStateChanged = 83,
04218 VBoxEventType_OnGuestProcessInputNotify = 84,
04225 VBoxEventType_OnGuestProcessOutput = 85,
04232 VBoxEventType_OnGuestFileRegistered = 86,
04239 VBoxEventType_OnGuestFileStateChanged = 87,
04246 VBoxEventType_OnGuestFileOffsetChanged = 88,
04254 VBoxEventType_OnGuestFileRead = 89,
04262 VBoxEventType_OnGuestFileWrite = 90,
04269 VBoxEventType_OnVideoCaptureChanged = 91,
04276 VBoxEventType_OnGuestUserStateChanged = 92,
04283 VBoxEventType_OnGuestMultiTouch = 93,
04290 VBoxEventType_OnHostNameResolutionConfigurationChange = 94,
04297 VBoxEventType_Last = 95,
04298 };
04299
04311 enum GuestMouseEventMode
04312 {
04319 GuestMouseEventMode_Relative = 0,
04326 GuestMouseEventMode_Absolute = 1,
04327 };
04328
04336 enum GuestMonitorChangedEventType
04337 {
04344 GuestMonitorChangedEventType_Enabled = 0,
04351 GuestMonitorChangedEventType_Disabled = 1,
04358 GuestMonitorChangedEventType_NewOrigin = 2,
04359 };
04360
04394 interface IVirtualBoxErrorInfo : $errorinfo
04395 {
04413 readonly attribute long resultCode;
04414
04421 readonly attribute long resultDetail;
04422
04434 readonly attribute wstringUUID interfaceID;
04435
04446 readonly attribute wstring component;
04447
04458 readonly attribute wstring text;
04459
04470 readonly attribute IVirtualBoxErrorInfo next;
04471
04472 };
04473
04474 interface INATNetwork : $unknown
04475 {
04484 attribute wstring networkName;
04485
04486 attribute boolean enabled;
04487
04496 attribute wstring network;
04497
04504 readonly attribute wstring gateway;
04505
04511 attribute boolean IPv6Enabled;
04512
04520 attribute wstring IPv6Prefix;
04521
04522 attribute boolean advertiseDefaultIPv6RouteEnabled;
04523
04524 attribute boolean needDhcpServer;
04525
04526 readonly attribute IEventSource eventSource;
04527
04534 readonly attribute wstring[] portForwardRules4;
04535
04540 readonly attribute wstring[] localMappings;
04541
04546 attribute long loopbackIp6;
04547
04553 readonly attribute wstring[] portForwardRules6;
04554
04558 void addLocalMapping (
04559 in wstring hostid,
04560 in long offset
04561 );
04562
04563 void addPortForwardRule (
04564 in boolean isIpv6,
04565 in wstring ruleName,
04566 in NATProtocol proto,
04567 in wstring hostIP,
04568 in unsigned short hostPort,
04569 in wstring guestIP,
04570 in unsigned short guestPort
04571 );
04572
04573 void removePortForwardRule (
04574 in boolean iSipv6,
04575 in wstring ruleName
04576 );
04577
04578 void start (
04579 in wstring trunkType
04580 );
04581
04582 void stop();
04583
04584 };
04585
04596 interface IDHCPServer : $unknown
04597 {
04598 readonly attribute IEventSource eventSource;
04599
04605 attribute boolean enabled;
04606
04612 readonly attribute wstring IPAddress;
04613
04619 readonly attribute wstring networkMask;
04620
04626 readonly attribute wstring networkName;
04627
04633 readonly attribute wstring lowerIP;
04634
04640 readonly attribute wstring upperIP;
04641
04642 readonly attribute wstring[] globalOptions;
04643
04644 readonly attribute wstring[] vmConfigs;
04645
04646 void addGlobalOption (
04647 in DhcpOpt option,
04648 in wstring value
04649 );
04650
04651 void addVmSlotOption (
04652 in wstring vmname,
04653 in long slot,
04654 in DhcpOpt option,
04655 in wstring value
04656 );
04657
04658 void removeVmSlotOptions (
04659 in wstring vmname,
04660 in long slot
04661 );
04662
04663 void getVmSlotOptions (
04664 in wstring vmname,
04665 in long slot,
04666 [retval] out wstring[] option
04667 );
04668
04669 void getMacOptions (
04670 in wstring mac,
04671 [retval] out wstring[] option
04672 );
04673
04702 void setConfiguration (
04703 in wstring IPAddress,
04704 in wstring networkMask,
04705 in wstring FromIPAddress,
04706 in wstring ToIPAddress
04707 );
04708
04733 void start (
04734 in wstring networkName,
04735 in wstring trunkName,
04736 in wstring trunkType
04737 );
04738
04751 void stop();
04752
04753 };
04754
04773 interface IVirtualBox : $unknown
04774 {
04787 readonly attribute wstring version;
04788
04796 readonly attribute wstring versionNormalized;
04797
04803 readonly attribute unsigned long revision;
04804
04814 readonly attribute wstring packageType;
04815
04827 readonly attribute wstring APIVersion;
04828
04844 readonly attribute wstring homeFolder;
04845
04853 readonly attribute wstring settingsFilePath;
04854
04858 readonly attribute IHost host;
04859
04863 readonly attribute ISystemProperties systemProperties;
04864
04870 readonly attribute IMachine[] machines;
04871
04881 readonly attribute wstring[] machineGroups;
04882
04892 readonly attribute IMedium[] hardDisks;
04893
04899 readonly attribute IMedium[] DVDImages;
04900
04906 readonly attribute IMedium[] floppyImages;
04907
04908 readonly attribute IProgress[] progressOperations;
04909
04910 readonly attribute IGuestOSType[] guestOSTypes;
04911
04928 readonly attribute ISharedFolder[] sharedFolders;
04929
04935 readonly attribute IPerformanceCollector performanceCollector;
04936
04942 readonly attribute IDHCPServer[] DHCPServers;
04943
04944 readonly attribute INATNetwork[] NATNetworks;
04945
04951 readonly attribute IEventSource eventSource;
04952
04958 readonly attribute IExtPackManager extensionPackManager;
04959
04965 readonly attribute wstring[] internalNetworks;
04966
04972 readonly attribute wstring[] genericNetworkDrivers;
04973
05024 void composeMachineFilename (
05025 in wstring name,
05026 in wstring group,
05027 in wstring createFlags,
05028 in wstring baseFolder,
05029 [retval] out wstring file
05030 );
05031
05138 void createMachine (
05139 in wstring settingsFile,
05140 in wstring name,
05141 in wstring[] groups,
05142 in wstring osTypeId,
05143 in wstring flags,
05144 [retval] out IMachine machine
05145 );
05146
05177 void openMachine (
05178 in wstring settingsFile,
05179 [retval] out IMachine machine
05180 );
05181
05213 void registerMachine (
05214 in IMachine machine
05215 );
05216
05237 void findMachine (
05238 in wstring nameOrId,
05239 [retval] out IMachine machine
05240 );
05241
05253 void getMachinesByGroups (
05254 in wstring[] groups,
05255 [retval] out IMachine[] machines
05256 );
05257
05267 void getMachineStates (
05268 in IMachine[] machines,
05269 [retval] out MachineState[] states
05270 );
05271
05281 void createAppliance (
05282 [retval] out IAppliance appliance
05283 );
05284
05347 void createHardDisk (
05348 in wstring format,
05349 in wstring location,
05350 [retval] out IMedium medium
05351 );
05352
05458 void openMedium (
05459 in wstring location,
05460 in DeviceType deviceType,
05461 in AccessMode accessMode,
05462 in boolean forceNewUuid,
05463 [retval] out IMedium medium
05464 );
05465
05494 void getGuestOSType (
05495 in wstringUUID id,
05496 [retval] out IGuestOSType type
05497 );
05498
05521 void createSharedFolder (
05522 in wstring name,
05523 in wstring hostPath,
05524 in boolean writable,
05525 in boolean automount
05526 );
05527
05542 void removeSharedFolder (
05543 in wstring name
05544 );
05545
05554 void getExtraDataKeys (
05555 [retval] out wstring[] keys
05556 );
05557
05586 void getExtraData (
05587 in wstring key,
05588 [retval] out wstring value
05589 );
05590
05640 void setExtraData (
05641 in wstring key,
05642 in wstring value
05643 );
05644
05663 void setSettingsSecret (
05664 in wstring password
05665 );
05666
05683 void createDHCPServer (
05684 in wstring name,
05685 [retval] out IDHCPServer server
05686 );
05687
05704 void findDHCPServerByNetworkName (
05705 in wstring name,
05706 [retval] out IDHCPServer server
05707 );
05708
05723 void removeDHCPServer (
05724 in IDHCPServer server
05725 );
05726
05727 void createNATNetwork (
05728 in wstring networkName,
05729 [retval] out INATNetwork network
05730 );
05731
05732 void findNATNetworkByName (
05733 in wstring networkName,
05734 [retval] out INATNetwork network
05735 );
05736
05737 void removeNATNetwork (
05738 in INATNetwork network
05739 );
05740
05765 void checkFirmwarePresent (
05766 in FirmwareType firmwareType,
05767 in wstring version,
05768 out wstring url,
05769 out wstring file,
05770 [retval] out boolean result
05771 );
05772
05773 };
05774
05785 interface IVFSExplorer : $unknown
05786 {
05790 readonly attribute wstring path;
05791
05795 readonly attribute VFSType type;
05796
05804 void update (
05805 [retval] out IProgress progress
05806 );
05807
05815 void cd (
05816 in wstring dir,
05817 [retval] out IProgress progress
05818 );
05819
05825 void cdUp (
05826 [retval] out IProgress progress
05827 );
05828
05841 void entryList (
05842 out wstring[] names,
05843 out unsigned long[] types,
05844 out long long[] sizes,
05845 out unsigned long[] modes
05846 );
05847
05856 void exists (
05857 in wstring[] names,
05858 [retval] out wstring[] exists
05859 );
05860
05868 void remove (
05869 in wstring[] names,
05870 [retval] out IProgress progress
05871 );
05872
05873 };
05874
05940 interface IAppliance : $unknown
05941 {
05949 readonly attribute wstring path;
05950
05981 readonly attribute wstring[] disks;
05982
05990 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
05991
05999 readonly attribute wstring[] machines;
06000
06017 void read (
06018 in wstring file,
06019 [retval] out IProgress progress
06020 );
06021
06038 void interpret();
06039
06062 void importMachines (
06063 in ImportOptions[] options,
06064 [retval] out IProgress progress
06065 );
06066
06074 void createVFSExplorer (
06075 in wstring URI,
06076 [retval] out IVFSExplorer explorer
06077 );
06078
06105 void write (
06106 in wstring format,
06107 in ExportOptions[] options,
06108 in wstring path,
06109 [retval] out IProgress progress
06110 );
06111
06117 void getWarnings (
06118 [retval] out wstring[] warnings
06119 );
06120
06121 };
06122
06134 interface IVirtualSystemDescription : $unknown
06135 {
06139 readonly attribute unsigned long count;
06140
06264 void getDescription (
06265 out VirtualSystemDescriptionType[] types,
06266 out wstring[] refs,
06267 out wstring[] OVFValues,
06268 out wstring[] VBoxValues,
06269 out wstring[] extraConfigValues
06270 );
06271
06288 void getDescriptionByType (
06289 in VirtualSystemDescriptionType type,
06290 out VirtualSystemDescriptionType[] types,
06291 out wstring[] refs,
06292 out wstring[] OVFValues,
06293 out wstring[] VBoxValues,
06294 out wstring[] extraConfigValues
06295 );
06296
06308 void getValuesByType (
06309 in VirtualSystemDescriptionType type,
06310 in VirtualSystemDescriptionValueType which,
06311 [retval] out wstring[] values
06312 );
06313
06339 void setFinalValues (
06340 in boolean[] enabled,
06341 in wstring[] VBoxValues,
06342 in wstring[] extraConfigValues
06343 );
06344
06359 void addDescription (
06360 in VirtualSystemDescriptionType type,
06361 in wstring VBoxValue,
06362 in wstring extraConfigValue
06363 );
06364
06365 };
06366
06367 interface IInternalMachineControl : $unknown
06368 {
06375 void setRemoveSavedStateFile (
06376 in boolean remove
06377 );
06378
06390 void updateState (
06391 in MachineState state
06392 );
06393
06405 void beginPowerUp (
06406 in IProgress progress
06407 );
06408
06418 void endPowerUp (
06419 in long result
06420 );
06421
06433 void beginPoweringDown (
06434 out IProgress progress
06435 );
06436
06466 void endPoweringDown (
06467 in long result,
06468 in wstring errMsg
06469 );
06470
06484 void runUSBDeviceFilters (
06485 in IUSBDevice device,
06486 out boolean matched,
06487 out unsigned long maskedInterfaces
06488 );
06489
06498 void captureUSBDevice (
06499 in wstringUUID id
06500 );
06501
06517 void detachUSBDevice (
06518 in wstringUUID id,
06519 in boolean done
06520 );
06521
06530 void autoCaptureUSBDevices();
06531
06547 void detachAllUSBDevices (
06548 in boolean done
06549 );
06550
06565 void onSessionEnd (
06566 in ISession session,
06567 [retval] out IProgress progress
06568 );
06569
06585 void beginSavingState (
06586 out IProgress progress,
06587 out wstring stateFilePath
06588 );
06589
06619 void endSavingState (
06620 in long result,
06621 in wstring errMsg
06622 );
06623
06638 void adoptSavedState (
06639 in wstring savedStateFile
06640 );
06641
06690 void beginTakingSnapshot (
06691 in IConsole initiator,
06692 in wstring name,
06693 in wstring description,
06694 in IProgress consoleProgress,
06695 in boolean fTakingSnapshotOnline,
06696 out wstring stateFilePath
06697 );
06698
06708 void endTakingSnapshot (
06709 in boolean success
06710 );
06711
06740 void deleteSnapshot (
06741 in IConsole initiator,
06742 in wstringUUID startId,
06743 in wstringUUID endId,
06744 in boolean deleteAllChildren,
06745 out MachineState machineState,
06746 [retval] out IProgress progress
06747 );
06748
06755 void finishOnlineMergeMedium();
06756
06770 void restoreSnapshot (
06771 in IConsole initiator,
06772 in ISnapshot snapshot,
06773 out MachineState machineState,
06774 [retval] out IProgress progress
06775 );
06776
06803 void pullGuestProperties (
06804 out wstring[] names,
06805 out wstring[] values,
06806 out long long[] timestamps,
06807 out wstring[] flags
06808 );
06809
06831 void pushGuestProperty (
06832 in wstring name,
06833 in wstring value,
06834 in long long timestamp,
06835 in wstring flags
06836 );
06837
06849 void lockMedia();
06850
06860 void unlockMedia();
06861
06877 void ejectMedium (
06878 in IMediumAttachment attachment,
06879 [retval] out IMediumAttachment newAttachment
06880 );
06881
06922 void reportVmStatistics (
06923 in unsigned long validStats,
06924 in unsigned long cpuUser,
06925 in unsigned long cpuKernel,
06926 in unsigned long cpuIdle,
06927 in unsigned long memTotal,
06928 in unsigned long memFree,
06929 in unsigned long memBalloon,
06930 in unsigned long memShared,
06931 in unsigned long memCache,
06932 in unsigned long pagedTotal,
06933 in unsigned long memAllocTotal,
06934 in unsigned long memFreeTotal,
06935 in unsigned long memBalloonTotal,
06936 in unsigned long memSharedTotal,
06937 in unsigned long vmNetRx,
06938 in unsigned long vmNetTx
06939 );
06940
06941 };
06942
06951 interface IBIOSSettings : $unknown
06952 {
06956 attribute boolean logoFadeIn;
06957
06961 attribute boolean logoFadeOut;
06962
06966 attribute unsigned long logoDisplayTime;
06967
06974 attribute wstring logoImagePath;
06975
06979 attribute BIOSBootMenuMode bootMenuMode;
06980
06984 attribute boolean ACPIEnabled;
06985
06992 attribute boolean IOAPICEnabled;
06993
07003 attribute long long timeOffset;
07004
07011 attribute boolean PXEDebugEnabled;
07012
07021 readonly attribute wstring nonVolatileStorageFile;
07022
07023 };
07024
07032 interface IPCIAddress : $unknown
07033 {
07039 attribute short bus;
07040
07046 attribute short device;
07047
07053 attribute short devFunction;
07054
07060 void asLong (
07061 [retval] out long result
07062 );
07063
07069 void fromLong (
07070 in long number
07071 );
07072
07073 };
07074
07082 interface IPCIDeviceAttachment : $unknown
07083 {
07089 readonly attribute wstring name;
07090
07096 readonly attribute boolean isPhysicalDevice;
07097
07103 readonly attribute long hostAddress;
07104
07110 readonly attribute long guestAddress;
07111
07112 };
07113
07154 interface IMachine : $unknown
07155 {
07159 readonly attribute IVirtualBox parent;
07160
07164 attribute octet[] icon;
07165
07215 readonly attribute boolean accessible;
07216
07228 readonly attribute IVirtualBoxErrorInfo accessError;
07229
07269 attribute wstring name;
07270
07281 attribute wstring description;
07282
07286 readonly attribute wstringUUID id;
07287
07298 attribute wstring[] groups;
07299
07314 attribute wstring OSTypeId;
07315
07319 attribute wstring hardwareVersion;
07320
07330 attribute wstringUUID hardwareUUID;
07331
07335 attribute unsigned long CPUCount;
07336
07342 attribute boolean CPUHotPlugEnabled;
07343
07351 attribute unsigned long CPUExecutionCap;
07352
07356 attribute unsigned long memorySize;
07357
07361 attribute unsigned long memoryBalloonSize;
07362
07369 attribute boolean pageFusionEnabled;
07370
07374 attribute GraphicsControllerType graphicsControllerType;
07375
07379 attribute unsigned long VRAMSize;
07380
07386 attribute boolean accelerate3DEnabled;
07387
07393 attribute boolean accelerate2DVideoEnabled;
07394
07405 attribute unsigned long monitorCount;
07406
07412 attribute boolean videoCaptureEnabled;
07413
07419 attribute boolean[] videoCaptureScreens;
07420
07434 attribute wstring videoCaptureFile;
07435
07443 attribute unsigned long videoCaptureWidth;
07444
07452 attribute unsigned long videoCaptureHeight;
07453
07462 attribute unsigned long videoCaptureRate;
07463
07473 attribute unsigned long videoCaptureFPS;
07474
07478 readonly attribute IBIOSSettings BIOSSettings;
07479
07484 attribute FirmwareType firmwareType;
07485
07491 attribute PointingHIDType pointingHIDType;
07492
07498 attribute KeyboardHIDType keyboardHIDType;
07499
07506 attribute boolean HPETEnabled;
07507
07511 attribute ChipsetType chipsetType;
07512
07546 attribute wstring snapshotFolder;
07547
07551 readonly attribute IVRDEServer VRDEServer;
07552
07553 attribute boolean emulatedUSBCardReaderEnabled;
07554
07558 readonly attribute IMediumAttachment[] mediumAttachments;
07559
07571 readonly attribute IUSBController[] USBControllers;
07572
07584 readonly attribute IUSBDeviceFilters USBDeviceFilters;
07585
07589 readonly attribute IAudioAdapter audioAdapter;
07590
07594 readonly attribute IStorageController[] storageControllers;
07595
07601 readonly attribute wstring settingsFilePath;
07602
07627 readonly attribute boolean settingsModified;
07628
07632 readonly attribute SessionState sessionState;
07633
07646 readonly attribute wstring sessionType;
07647
07657 readonly attribute unsigned long sessionPID;
07658
07662 readonly attribute MachineState state;
07663
07670 readonly attribute long long lastStateChange;
07671
07683 readonly attribute wstring stateFilePath;
07684
07694 readonly attribute wstring logFolder;
07695
07706 readonly attribute ISnapshot currentSnapshot;
07707
07714 readonly attribute unsigned long snapshotCount;
07715
07747 readonly attribute boolean currentStateModified;
07748
07760 readonly attribute ISharedFolder[] sharedFolders;
07761
07768 attribute ClipboardMode clipboardMode;
07769
07775 attribute DragAndDropMode dragAndDropMode;
07776
07784 attribute wstring guestPropertyNotificationPatterns;
07785
07794 attribute boolean teleporterEnabled;
07795
07806 attribute unsigned long teleporterPort;
07807
07814 attribute wstring teleporterAddress;
07815
07826 attribute wstring teleporterPassword;
07827
07835 attribute FaultToleranceState faultToleranceState;
07836
07843 attribute unsigned long faultTolerancePort;
07844
07850 attribute wstring faultToleranceAddress;
07851
07859 attribute wstring faultTolerancePassword;
07860
07866 attribute unsigned long faultToleranceSyncInterval;
07867
07875 attribute boolean RTCUseUTC;
07876
07883 attribute boolean IOCacheEnabled;
07884
07890 attribute unsigned long IOCacheSize;
07891
07901 readonly attribute IPCIDeviceAttachment[] PCIDeviceAssignments;
07902
07908 readonly attribute IBandwidthControl bandwidthControl;
07909
07918 attribute boolean tracingEnabled;
07919
07934 attribute wstring tracingConfig;
07935
07948 attribute boolean allowTracingToAccessVM;
07949
07955 attribute boolean autostartEnabled;
07956
07962 attribute unsigned long autostartDelay;
07963
07969 attribute AutostopType autostopType;
07970
07986 attribute wstring defaultFrontend;
07987
07993 readonly attribute boolean USBProxyAvailable;
07994
08100 void lockMachine (
08101 in ISession session,
08102 in LockType lockType
08103 );
08104
08241 void launchVMProcess (
08242 in ISession session,
08243 in wstring type,
08244 in wstring environment,
08245 [retval] out IProgress progress
08246 );
08247
08285 void setBootOrder (
08286 in unsigned long position,
08287 in DeviceType device
08288 );
08289
08324 void getBootOrder (
08325 in unsigned long position,
08326 [retval] out DeviceType device
08327 );
08328
08430 void attachDevice (
08431 in wstring name,
08432 in long controllerPort,
08433 in long device,
08434 in DeviceType type,
08435 in IMedium medium
08436 );
08437
08533 void attachDeviceWithoutMedium (
08534 in wstring name,
08535 in long controllerPort,
08536 in long device,
08537 in DeviceType type
08538 );
08539
08593 void detachDevice (
08594 in wstring name,
08595 in long controllerPort,
08596 in long device
08597 );
08598
08641 void passthroughDevice (
08642 in wstring name,
08643 in long controllerPort,
08644 in long device,
08645 in boolean passthrough
08646 );
08647
08690 void temporaryEjectDevice (
08691 in wstring name,
08692 in long controllerPort,
08693 in long device,
08694 in boolean temporaryEject
08695 );
08696
08742 void nonRotationalDevice (
08743 in wstring name,
08744 in long controllerPort,
08745 in long device,
08746 in boolean nonRotational
08747 );
08748
08794 void setAutoDiscardForDevice (
08795 in wstring name,
08796 in long controllerPort,
08797 in long device,
08798 in boolean discard
08799 );
08800
08850 void setHotPluggableForDevice (
08851 in wstring name,
08852 in long controllerPort,
08853 in long device,
08854 in boolean hotPluggable
08855 );
08856
08897 void setBandwidthGroupForDevice (
08898 in wstring name,
08899 in long controllerPort,
08900 in long device,
08901 in IBandwidthGroup bandwidthGroup
08902 );
08903
08940 void setNoBandwidthGroupForDevice (
08941 in wstring name,
08942 in long controllerPort,
08943 in long device
08944 );
08945
09010 void unmountMedium (
09011 in wstring name,
09012 in long controllerPort,
09013 in long device,
09014 in boolean force
09015 );
09016
09079 void mountMedium (
09080 in wstring name,
09081 in long controllerPort,
09082 in long device,
09083 in IMedium medium,
09084 in boolean force
09085 );
09086
09115 void getMedium (
09116 in wstring name,
09117 in long controllerPort,
09118 in long device,
09119 [retval] out IMedium medium
09120 );
09121
09136 void getMediumAttachmentsOfController (
09137 in wstring name,
09138 [retval] out IMediumAttachment[] mediumAttachments
09139 );
09140
09155 void getMediumAttachment (
09156 in wstring name,
09157 in long controllerPort,
09158 in long device,
09159 [retval] out IMediumAttachment attachment
09160 );
09161
09202 void attachHostPCIDevice (
09203 in long hostAddress,
09204 in long desiredGuestAddress,
09205 in boolean tryToUnbind
09206 );
09207
09248 void detachHostPCIDevice (
09249 in long hostAddress
09250 );
09251
09269 void getNetworkAdapter (
09270 in unsigned long slot,
09271 [retval] out INetworkAdapter adapter
09272 );
09273
09306 void addStorageController (
09307 in wstring name,
09308 in StorageBus connectionType,
09309 [retval] out IStorageController controller
09310 );
09311
09325 void getStorageControllerByName (
09326 in wstring name,
09327 [retval] out IStorageController storageController
09328 );
09329
09343 void getStorageControllerByInstance (
09344 in unsigned long instance,
09345 [retval] out IStorageController storageController
09346 );
09347
09370 void removeStorageController (
09371 in wstring name
09372 );
09373
09395 void setStorageControllerBootable (
09396 in wstring name,
09397 in boolean bootable
09398 );
09399
09422 void addUSBController (
09423 in wstring name,
09424 in USBControllerType type,
09425 [retval] out IUSBController controller
09426 );
09427
09441 void removeUSBController (
09442 in wstring name
09443 );
09444
09458 void getUSBControllerByName (
09459 in wstring name,
09460 [retval] out IUSBController controller
09461 );
09462
09468 void getUSBControllerCountByType (
09469 in USBControllerType type,
09470 [retval] out unsigned long controllers
09471 );
09472
09490 void getSerialPort (
09491 in unsigned long slot,
09492 [retval] out ISerialPort port
09493 );
09494
09512 void getParallelPort (
09513 in unsigned long slot,
09514 [retval] out IParallelPort port
09515 );
09516
09525 void getExtraDataKeys (
09526 [retval] out wstring[] keys
09527 );
09528
09557 void getExtraData (
09558 in wstring key,
09559 [retval] out wstring value
09560 );
09561
09611 void setExtraData (
09612 in wstring key,
09613 in wstring value
09614 );
09615
09637 void getCPUProperty (
09638 in CPUPropertyType property,
09639 [retval] out boolean value
09640 );
09641
09663 void setCPUProperty (
09664 in CPUPropertyType property,
09665 in boolean value
09666 );
09667
09707 void getCPUIDLeaf (
09708 in unsigned long id,
09709 out unsigned long valEax,
09710 out unsigned long valEbx,
09711 out unsigned long valEcx,
09712 out unsigned long valEdx
09713 );
09714
09758 void setCPUIDLeaf (
09759 in unsigned long id,
09760 in unsigned long valEax,
09761 in unsigned long valEbx,
09762 in unsigned long valEcx,
09763 in unsigned long valEdx
09764 );
09765
09783 void removeCPUIDLeaf (
09784 in unsigned long id
09785 );
09786
09792 void removeAllCPUIDLeaves();
09793
09815 void getHWVirtExProperty (
09816 in HWVirtExPropertyType property,
09817 [retval] out boolean value
09818 );
09819
09841 void setHWVirtExProperty (
09842 in HWVirtExPropertyType property,
09843 in boolean value
09844 );
09845
09875 void setSettingsFilePath (
09876 in wstring settingsFilePath,
09877 [retval] out IProgress progress
09878 );
09879
09925 void saveSettings();
09926
09950 void discardSettings();
09951
10035 void unregister (
10036 in CleanupMode cleanupMode,
10037 [retval] out IMedium[] media
10038 );
10039
10096 void deleteConfig (
10097 in IMedium[] media,
10098 [retval] out IProgress progress
10099 );
10100
10112 void exportTo (
10113 in IAppliance appliance,
10114 in wstring location,
10115 [retval] out IVirtualSystemDescription description
10116 );
10117
10141 void findSnapshot (
10142 in wstring nameOrId,
10143 [retval] out ISnapshot snapshot
10144 );
10145
10179 void createSharedFolder (
10180 in wstring name,
10181 in wstring hostPath,
10182 in boolean writable,
10183 in boolean automount
10184 );
10185
10211 void removeSharedFolder (
10212 in wstring name
10213 );
10214
10238 void canShowConsoleWindow (
10239 [retval] out boolean canShow
10240 );
10241
10276 void showConsoleWindow (
10277 [retval] out long long winId
10278 );
10279
10312 void getGuestProperty (
10313 in wstring name,
10314 out wstring value,
10315 out long long timestamp,
10316 out wstring flags
10317 );
10318
10341 void getGuestPropertyValue (
10342 in wstring property,
10343 [retval] out wstring value
10344 );
10345
10368 void getGuestPropertyTimestamp (
10369 in wstring property,
10370 [retval] out long long value
10371 );
10372
10423 void setGuestProperty (
10424 in wstring property,
10425 in wstring value,
10426 in wstring flags
10427 );
10428
10468 void setGuestPropertyValue (
10469 in wstring property,
10470 in wstring value
10471 );
10472
10490 void deleteGuestProperty (
10491 in wstring name
10492 );
10493
10524 void enumerateGuestProperties (
10525 in wstring patterns,
10526 out wstring[] names,
10527 out wstring[] values,
10528 out long long[] timestamps,
10529 out wstring[] flags
10530 );
10531
10561 void querySavedGuestScreenInfo (
10562 in unsigned long screenId,
10563 out unsigned long originX,
10564 out unsigned long originY,
10565 out unsigned long width,
10566 out unsigned long height,
10567 out boolean enabled
10568 );
10569
10591 void querySavedThumbnailSize (
10592 in unsigned long screenId,
10593 out unsigned long size,
10594 out unsigned long width,
10595 out unsigned long height
10596 );
10597
10624 void readSavedThumbnailToArray (
10625 in unsigned long screenId,
10626 in boolean BGR,
10627 out unsigned long width,
10628 out unsigned long height,
10629 [retval] out octet[] data
10630 );
10631
10653 void readSavedThumbnailPNGToArray (
10654 in unsigned long screenId,
10655 out unsigned long width,
10656 out unsigned long height,
10657 [retval] out octet[] data
10658 );
10659
10681 void querySavedScreenshotPNGSize (
10682 in unsigned long screenId,
10683 out unsigned long size,
10684 out unsigned long width,
10685 out unsigned long height
10686 );
10687
10709 void readSavedScreenshotPNGToArray (
10710 in unsigned long screenId,
10711 out unsigned long width,
10712 out unsigned long height,
10713 [retval] out octet[] data
10714 );
10715
10725 void hotPlugCPU (
10726 in unsigned long cpu
10727 );
10728
10738 void hotUnplugCPU (
10739 in unsigned long cpu
10740 );
10741
10755 void getCPUStatus (
10756 in unsigned long cpu,
10757 [retval] out boolean attached
10758 );
10759
10774 void queryLogFilename (
10775 in unsigned long idx,
10776 [retval] out wstring filename
10777 );
10778
10804 void readLog (
10805 in unsigned long idx,
10806 in long long offset,
10807 in long long size,
10808 [retval] out octet[] data
10809 );
10810
10843 void cloneTo (
10844 in IMachine target,
10845 in CloneMode mode,
10846 in CloneOptions[] options,
10847 [retval] out IProgress progress
10848 );
10849
10850 };
10851
10859 interface IEmulatedUSB : $unknown
10860 {
10864 readonly attribute wstring[] webcams;
10865
10875 void webcamAttach (
10876 in wstring path,
10877 in wstring settings
10878 );
10879
10887 void webcamDetach (
10888 in wstring path
10889 );
10890
10891 };
10892
10901 interface IVRDEServerInfo : $unknown
10902 {
10908 readonly attribute boolean active;
10909
10918 readonly attribute long port;
10919
10925 readonly attribute unsigned long numberOfClients;
10926
10932 readonly attribute long long beginTime;
10933
10940 readonly attribute long long endTime;
10941
10947 readonly attribute long long bytesSent;
10948
10954 readonly attribute long long bytesSentTotal;
10955
10961 readonly attribute long long bytesReceived;
10962
10968 readonly attribute long long bytesReceivedTotal;
10969
10975 readonly attribute wstring user;
10976
10982 readonly attribute wstring domain;
10983
10989 readonly attribute wstring clientName;
10990
10996 readonly attribute wstring clientIP;
10997
11003 readonly attribute unsigned long clientVersion;
11004
11012 readonly attribute unsigned long encryptionStyle;
11013
11014 };
11015
11037 interface IConsole : $unknown
11038 {
11050 readonly attribute IMachine machine;
11051
11065 readonly attribute MachineState state;
11066
11070 readonly attribute IGuest guest;
11071
11082 readonly attribute IKeyboard keyboard;
11083
11094 readonly attribute IMouse mouse;
11095
11105 readonly attribute IDisplay display;
11106
11110 readonly attribute IMachineDebugger debugger;
11111
11122 readonly attribute IUSBDevice[] USBDevices;
11123
11131 readonly attribute IHostUSBDevice[] remoteUSBDevices;
11132
11148 readonly attribute ISharedFolder[] sharedFolders;
11149
11155 readonly attribute IVRDEServerInfo VRDEServerInfo;
11156
11162 readonly attribute IEventSource eventSource;
11163
11167 readonly attribute IPCIDeviceAttachment[] attachedPCIDevices;
11168
11177 attribute boolean useHostClipboard;
11178
11184 readonly attribute IEmulatedUSB emulatedUSB;
11185
11250 void powerUp (
11251 [retval] out IProgress progress
11252 );
11253
11287 void powerUpPaused (
11288 [retval] out IProgress progress
11289 );
11290
11310 void powerDown (
11311 [retval] out IProgress progress
11312 );
11313
11333 void reset();
11334
11354 void pause();
11355
11375 void resume();
11376
11396 void powerButton();
11397
11417 void sleepButton();
11418
11430 void getPowerButtonHandled (
11431 [retval] out boolean handled
11432 );
11433
11447 void getGuestEnteredACPIMode (
11448 [retval] out boolean entered
11449 );
11450
11503 void saveState (
11504 [retval] out IProgress progress
11505 );
11506
11539 void adoptSavedState (
11540 in wstring savedStateFile
11541 );
11542
11573 void discardSavedState (
11574 in boolean fRemoveFile
11575 );
11576
11589 void getDeviceActivity (
11590 in DeviceType type,
11591 [retval] out DeviceActivity activity
11592 );
11593
11631 void attachUSBDevice (
11632 in wstringUUID id
11633 );
11634
11669 void detachUSBDevice (
11670 in wstringUUID id,
11671 [retval] out IUSBDevice device
11672 );
11673
11696 void findUSBDeviceByAddress (
11697 in wstring name,
11698 [retval] out IUSBDevice device
11699 );
11700
11720 void findUSBDeviceById (
11721 in wstringUUID id,
11722 [retval] out IUSBDevice device
11723 );
11724
11758 void createSharedFolder (
11759 in wstring name,
11760 in wstring hostPath,
11761 in boolean writable,
11762 in boolean automount
11763 );
11764
11789 void removeSharedFolder (
11790 in wstring name
11791 );
11792
11830 void takeSnapshot (
11831 in wstring name,
11832 in wstring description,
11833 [retval] out IProgress progress
11834 );
11835
11908 void deleteSnapshot (
11909 in wstringUUID id,
11910 [retval] out IProgress progress
11911 );
11912
11952 void deleteSnapshotAndAllChildren (
11953 in wstringUUID id,
11954 [retval] out IProgress progress
11955 );
11956
12000 void deleteSnapshotRange (
12001 in wstringUUID startId,
12002 in wstringUUID endId,
12003 [retval] out IProgress progress
12004 );
12005
12046 void restoreSnapshot (
12047 in ISnapshot snapshot,
12048 [retval] out IProgress progress
12049 );
12050
12089 void teleport (
12090 in wstring hostname,
12091 in unsigned long tcpport,
12092 in wstring password,
12093 in unsigned long maxDowntime,
12094 [retval] out IProgress progress
12095 );
12096
12097 };
12098
12109 interface IHostNetworkInterface : $unknown
12110 {
12114 readonly attribute wstring name;
12115
12119 readonly attribute wstring shortName;
12120
12124 readonly attribute wstringUUID id;
12125
12129 readonly attribute wstring networkName;
12130
12134 readonly attribute boolean DHCPEnabled;
12135
12139 readonly attribute wstring IPAddress;
12140
12144 readonly attribute wstring networkMask;
12145
12149 readonly attribute boolean IPV6Supported;
12150
12154 readonly attribute wstring IPV6Address;
12155
12159 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
12160
12164 readonly attribute wstring hardwareAddress;
12165
12169 readonly attribute HostNetworkInterfaceMediumType mediumType;
12170
12174 readonly attribute HostNetworkInterfaceStatus status;
12175
12179 readonly attribute HostNetworkInterfaceType interfaceType;
12180
12192 void enableStaticIPConfig (
12193 in wstring IPAddress,
12194 in wstring networkMask
12195 );
12196
12208 void enableStaticIPConfigV6 (
12209 in wstring IPV6Address,
12210 in unsigned long IPV6NetworkMaskPrefixLength
12211 );
12212
12216 void enableDynamicIPConfig();
12217
12221 void DHCPRediscover();
12222
12223 };
12224
12232 interface IHostVideoInputDevice : $unknown
12233 {
12237 readonly attribute wstring name;
12238
12242 readonly attribute wstring path;
12243
12247 readonly attribute wstring alias;
12248
12249 };
12250
12267 interface IHost : $unknown
12268 {
12272 readonly attribute IMedium[] DVDDrives;
12273
12277 readonly attribute IMedium[] floppyDrives;
12278
12292 readonly attribute IHostUSBDevice[] USBDevices;
12293
12317 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
12318
12322 readonly attribute IHostNetworkInterface[] networkInterfaces;
12323
12327 readonly attribute wstring[] nameServers;
12328
12332 readonly attribute wstring domainName;
12333
12337 readonly attribute wstring[] searchStrings;
12338
12342 readonly attribute unsigned long processorCount;
12343
12347 readonly attribute unsigned long processorOnlineCount;
12348
12352 readonly attribute unsigned long processorCoreCount;
12353
12357 readonly attribute unsigned long processorOnlineCoreCount;
12358
12362 readonly attribute unsigned long memorySize;
12363
12367 readonly attribute unsigned long memoryAvailable;
12368
12372 readonly attribute wstring operatingSystem;
12373
12377 readonly attribute wstring OSVersion;
12378
12382 readonly attribute long long UTCTime;
12383
12387 readonly attribute boolean acceleration3DAvailable;
12388
12392 readonly attribute IHostVideoInputDevice[] videoInputDevices;
12393
12408 void getProcessorSpeed (
12409 in unsigned long cpuId,
12410 [retval] out unsigned long speed
12411 );
12412
12424 void getProcessorFeature (
12425 in ProcessorFeature feature,
12426 [retval] out boolean supported
12427 );
12428
12447 void getProcessorDescription (
12448 in unsigned long cpuId,
12449 [retval] out wstring description
12450 );
12451
12492 void getProcessorCPUIDLeaf (
12493 in unsigned long cpuId,
12494 in unsigned long leaf,
12495 in unsigned long subLeaf,
12496 out unsigned long valEax,
12497 out unsigned long valEbx,
12498 out unsigned long valEcx,
12499 out unsigned long valEdx
12500 );
12501
12522 void createHostOnlyNetworkInterface (
12523 out IHostNetworkInterface hostInterface,
12524 [retval] out IProgress progress
12525 );
12526
12547 void removeHostOnlyNetworkInterface (
12548 in wstringUUID id,
12549 [retval] out IProgress progress
12550 );
12551
12571 void createUSBDeviceFilter (
12572 in wstring name,
12573 [retval] out IHostUSBDeviceFilter filter
12574 );
12575
12618 void insertUSBDeviceFilter (
12619 in unsigned long position,
12620 in IHostUSBDeviceFilter filter
12621 );
12622
12650 void removeUSBDeviceFilter (
12651 in unsigned long position
12652 );
12653
12671 void findHostDVDDrive (
12672 in wstring name,
12673 [retval] out IMedium drive
12674 );
12675
12693 void findHostFloppyDrive (
12694 in wstring name,
12695 [retval] out IMedium drive
12696 );
12697
12713 void findHostNetworkInterfaceByName (
12714 in wstring name,
12715 [retval] out IHostNetworkInterface networkInterface
12716 );
12717
12733 void findHostNetworkInterfaceById (
12734 in wstringUUID id,
12735 [retval] out IHostNetworkInterface networkInterface
12736 );
12737
12747 void findHostNetworkInterfacesOfType (
12748 in HostNetworkInterfaceType type,
12749 [retval] out IHostNetworkInterface[] networkInterfaces
12750 );
12751
12771 void findUSBDeviceById (
12772 in wstringUUID id,
12773 [retval] out IHostUSBDevice device
12774 );
12775
12798 void findUSBDeviceByAddress (
12799 in wstring name,
12800 [retval] out IHostUSBDevice device
12801 );
12802
12810 void generateMACAddress (
12811 [retval] out wstring address
12812 );
12813
12814 };
12815
12828 interface ISystemProperties : $unknown
12829 {
12833 readonly attribute unsigned long minGuestRAM;
12834
12838 readonly attribute unsigned long maxGuestRAM;
12839
12843 readonly attribute unsigned long minGuestVRAM;
12844
12848 readonly attribute unsigned long maxGuestVRAM;
12849
12853 readonly attribute unsigned long minGuestCPUCount;
12854
12858 readonly attribute unsigned long maxGuestCPUCount;
12859
12863 readonly attribute unsigned long maxGuestMonitors;
12864
12869 readonly attribute long long infoVDSize;
12870
12877 readonly attribute unsigned long serialPortCount;
12878
12885 readonly attribute unsigned long parallelPortCount;
12886
12896 readonly attribute unsigned long maxBootPosition;
12897
12906 attribute boolean exclusiveHwVirt;
12907
12931 attribute wstring defaultMachineFolder;
12932
12938 attribute wstring loggingLevel;
12939
12964 readonly attribute IMediumFormat[] mediumFormats;
12965
12999 attribute wstring defaultHardDiskFormat;
13000
13006 attribute long long freeDiskSpaceWarning;
13007
13012 attribute unsigned long freeDiskSpacePercentWarning;
13013
13019 attribute long long freeDiskSpaceError;
13020
13025 attribute unsigned long freeDiskSpacePercentError;
13026
13050 attribute wstring VRDEAuthLibrary;
13051
13080 attribute wstring webServiceAuthLibrary;
13081
13095 attribute wstring defaultVRDEExtPack;
13096
13102 attribute unsigned long logHistoryCount;
13103
13108 readonly attribute AudioDriverType defaultAudioDriver;
13109
13116 attribute wstring autostartDatabasePath;
13117
13124 attribute wstring defaultAdditionsISO;
13125
13140 attribute wstring defaultFrontend;
13141
13152 void getMaxNetworkAdapters (
13153 in ChipsetType chipset,
13154 [retval] out unsigned long maxNetworkAdapters
13155 );
13156
13170 void getMaxNetworkAdaptersOfType (
13171 in ChipsetType chipset,
13172 in NetworkAttachmentType type,
13173 [retval] out unsigned long maxNetworkAdapters
13174 );
13175
13185 void getMaxDevicesPerPortForStorageBus (
13186 in StorageBus bus,
13187 [retval] out unsigned long maxDevicesPerPort
13188 );
13189
13197 void getMinPortCountForStorageBus (
13198 in StorageBus bus,
13199 [retval] out unsigned long minPortCount
13200 );
13201
13209 void getMaxPortCountForStorageBus (
13210 in StorageBus bus,
13211 [retval] out unsigned long maxPortCount
13212 );
13213
13226 void getMaxInstancesOfStorageBus (
13227 in ChipsetType chipset,
13228 in StorageBus bus,
13229 [retval] out unsigned long maxInstances
13230 );
13231
13241 void getDeviceTypesForStorageBus (
13242 in StorageBus bus,
13243 [retval] out DeviceType[] deviceTypes
13244 );
13245
13254 void getDefaultIoCacheSettingForStorageController (
13255 in StorageControllerType controllerType,
13256 [retval] out boolean enabled
13257 );
13258
13271 void getMaxInstancesOfUSBControllerType (
13272 in ChipsetType chipset,
13273 in USBControllerType type,
13274 [retval] out unsigned long maxInstances
13275 );
13276
13277 };
13278
13284 interface IGuestOSType : $unknown
13285 {
13289 readonly attribute wstring familyId;
13290
13294 readonly attribute wstring familyDescription;
13295
13299 readonly attribute wstring id;
13300
13304 readonly attribute wstring description;
13305
13309 readonly attribute boolean is64Bit;
13310
13314 readonly attribute boolean recommendedIOAPIC;
13315
13319 readonly attribute boolean recommendedVirtEx;
13320
13324 readonly attribute unsigned long recommendedRAM;
13325
13329 readonly attribute unsigned long recommendedVRAM;
13330
13334 readonly attribute boolean recommended2DVideoAcceleration;
13335
13339 readonly attribute boolean recommended3DAcceleration;
13340
13344 readonly attribute long long recommendedHDD;
13345
13349 readonly attribute NetworkAdapterType adapterType;
13350
13354 readonly attribute boolean recommendedPAE;
13355
13359 readonly attribute StorageControllerType recommendedDVDStorageController;
13360
13364 readonly attribute StorageBus recommendedDVDStorageBus;
13365
13369 readonly attribute StorageControllerType recommendedHDStorageController;
13370
13374 readonly attribute StorageBus recommendedHDStorageBus;
13375
13379 readonly attribute FirmwareType recommendedFirmware;
13380
13384 readonly attribute boolean recommendedUSBHID;
13385
13389 readonly attribute boolean recommendedHPET;
13390
13394 readonly attribute boolean recommendedUSBTablet;
13395
13399 readonly attribute boolean recommendedRTCUseUTC;
13400
13404 readonly attribute ChipsetType recommendedChipset;
13405
13409 readonly attribute AudioControllerType recommendedAudioController;
13410
13414 readonly attribute boolean recommendedFloppy;
13415
13419 readonly attribute boolean recommendedUSB;
13420
13421 };
13422
13430 interface IAdditionsFacility : $unknown
13431 {
13435 readonly attribute AdditionsFacilityClass classType;
13436
13443 readonly attribute long long lastUpdated;
13444
13448 readonly attribute wstring name;
13449
13453 readonly attribute AdditionsFacilityStatus status;
13454
13458 readonly attribute AdditionsFacilityType type;
13459
13460 };
13461
13490 interface IGuestSession : $unknown
13491 {
13497 readonly attribute wstring user;
13498
13504 readonly attribute wstring domain;
13505
13509 readonly attribute wstring name;
13510
13514 readonly attribute unsigned long id;
13515
13528 attribute unsigned long timeout;
13529
13534 readonly attribute unsigned long protocolVersion;
13535
13539 readonly attribute GuestSessionStatus status;
13540
13546 attribute wstring[] environment;
13547
13553 readonly attribute IGuestProcess[] processes;
13554
13560 readonly attribute IGuestDirectory[] directories;
13561
13567 readonly attribute IGuestFile[] files;
13568
13574 readonly attribute IEventSource eventSource;
13575
13584 void close();
13585
13607 void copyFrom (
13608 in wstring source,
13609 in wstring dest,
13610 in CopyFileFlag[] flags,
13611 [retval] out IProgress progress
13612 );
13613
13635 void copyTo (
13636 in wstring source,
13637 in wstring dest,
13638 in CopyFileFlag[] flags,
13639 [retval] out IProgress progress
13640 );
13641
13661 void directoryCreate (
13662 in wstring path,
13663 in unsigned long mode,
13664 in DirectoryCreateFlag[] flags
13665 );
13666
13718 void directoryCreateTemp (
13719 in wstring templateName,
13720 in unsigned long mode,
13721 in wstring path,
13722 in boolean secure,
13723 [retval] out wstring directory
13724 );
13725
13743 void directoryExists (
13744 in wstring path,
13745 [retval] out boolean exists
13746 );
13747
13778 void directoryOpen (
13779 in wstring path,
13780 in wstring filter,
13781 in DirectoryOpenFlag[] flags,
13782 [retval] out IGuestDirectory directory
13783 );
13784
13810 void directoryQueryInfo (
13811 in wstring path,
13812 [retval] out IGuestFsObjInfo info
13813 );
13814
13822 void directoryRemove (
13823 in wstring path
13824 );
13825
13838 void directoryRemoveRecursive (
13839 in wstring path,
13840 in DirectoryRemoveRecFlag[] flags,
13841 [retval] out IProgress progress
13842 );
13843
13855 void directoryRename (
13856 in wstring source,
13857 in wstring dest,
13858 in PathRenameFlag[] flags
13859 );
13860
13878 void directorySetACL (
13879 in wstring path,
13880 in wstring acl
13881 );
13882
13896 void environmentClear();
13897
13918 void environmentGet (
13919 in wstring name,
13920 [retval] out wstring value
13921 );
13922
13940 void environmentSet (
13941 in wstring name,
13942 in wstring value
13943 );
13944
13960 void environmentUnset (
13961 in wstring name
13962 );
13963
14017 void fileCreateTemp (
14018 in wstring templateName,
14019 in unsigned long mode,
14020 in wstring path,
14021 in boolean secure,
14022 [retval] out IGuestFile file
14023 );
14024
14042 void fileExists (
14043 in wstring path,
14044 [retval] out boolean exists
14045 );
14046
14070 void fileRemove (
14071 in wstring path
14072 );
14073
14135 void fileOpen (
14136 in wstring path,
14137 in wstring openMode,
14138 in wstring disposition,
14139 in unsigned long creationMode,
14140 [retval] out IGuestFile file
14141 );
14142
14209 void fileOpenEx (
14210 in wstring path,
14211 in wstring openMode,
14212 in wstring disposition,
14213 in wstring sharingMode,
14214 in unsigned long creationMode,
14215 in long long offset,
14216 [retval] out IGuestFile file
14217 );
14218
14244 void fileQueryInfo (
14245 in wstring path,
14246 [retval] out IGuestFsObjInfo info
14247 );
14248
14274 void fileQuerySize (
14275 in wstring path,
14276 [retval] out long long size
14277 );
14278
14290 void fileRename (
14291 in wstring source,
14292 in wstring dest,
14293 in PathRenameFlag[] flags
14294 );
14295
14313 void fileSetACL (
14314 in wstring file,
14315 in wstring acl
14316 );
14317
14372 void processCreate (
14373 in wstring command,
14374 in wstring[] arguments,
14375 in wstring[] environment,
14376 in ProcessCreateFlag[] flags,
14377 in unsigned long timeoutMS,
14378 [retval] out IGuestProcess guestProcess
14379 );
14380
14422 void processCreateEx (
14423 in wstring command,
14424 in wstring[] arguments,
14425 in wstring[] environment,
14426 in ProcessCreateFlag[] flags,
14427 in unsigned long timeoutMS,
14428 in ProcessPriority priority,
14429 in long[] affinity,
14430 [retval] out IGuestProcess guestProcess
14431 );
14432
14442 void processGet (
14443 in unsigned long pid,
14444 [retval] out IGuestProcess guestProcess
14445 );
14446
14469 void symlinkCreate (
14470 in wstring source,
14471 in wstring target,
14472 in SymlinkType type
14473 );
14474
14492 void symlinkExists (
14493 in wstring symlink,
14494 [retval] out boolean exists
14495 );
14496
14520 void symlinkRead (
14521 in wstring symlink,
14522 in SymlinkReadFlag[] flags,
14523 [retval] out wstring target
14524 );
14525
14541 void symlinkRemoveDirectory (
14542 in wstring path
14543 );
14544
14560 void symlinkRemoveFile (
14561 in wstring file
14562 );
14563
14584 void waitFor (
14585 in unsigned long waitFor,
14586 in unsigned long timeoutMS,
14587 [retval] out GuestSessionWaitResult reason
14588 );
14589
14611 void waitForArray (
14612 in GuestSessionWaitForFlag[] waitFor,
14613 in unsigned long timeoutMS,
14614 [retval] out GuestSessionWaitResult reason
14615 );
14616
14617 };
14618
14626 interface IProcess : $unknown
14627 {
14633 readonly attribute wstring[] arguments;
14634
14640 readonly attribute wstring[] environment;
14641
14647 readonly attribute IEventSource eventSource;
14648
14652 readonly attribute wstring executablePath;
14653
14660 readonly attribute long exitCode;
14661
14667 readonly attribute wstring name;
14668
14674 readonly attribute unsigned long PID;
14675
14682 readonly attribute ProcessStatus status;
14683
14704 void waitFor (
14705 in unsigned long waitFor,
14706 in unsigned long timeoutMS,
14707 [retval] out ProcessWaitResult reason
14708 );
14709
14731 void waitForArray (
14732 in ProcessWaitForFlag[] waitFor,
14733 in unsigned long timeoutMS,
14734 [retval] out ProcessWaitResult reason
14735 );
14736
14753 void read (
14754 in unsigned long handle,
14755 in unsigned long toRead,
14756 in unsigned long timeoutMS,
14757 [retval] out octet[] data
14758 );
14759
14783 void write (
14784 in unsigned long handle,
14785 in unsigned long flags,
14786 in octet[] data,
14787 in unsigned long timeoutMS,
14788 [retval] out unsigned long written
14789 );
14790
14815 void writeArray (
14816 in unsigned long handle,
14817 in ProcessInputFlag[] flags,
14818 in octet[] data,
14819 in unsigned long timeoutMS,
14820 [retval] out unsigned long written
14821 );
14822
14832 void terminate();
14833
14834 };
14835
14844 interface IGuestProcess : IProcess
14845 {
14846 };
14847
14855 interface IDirectory : $unknown
14856 {
14862 readonly attribute wstring directoryName;
14863
14869 readonly attribute wstring filter;
14870
14877 void close();
14878
14894 void read (
14895 [retval] out IFsObjInfo objInfo
14896 );
14897
14898 };
14899
14908 interface IGuestDirectory : IDirectory
14909 {
14910 };
14911
14919 interface IFile : $unknown
14920 {
14926 readonly attribute unsigned long creationMode;
14927
14933 readonly attribute wstring disposition;
14934
14940 readonly attribute IEventSource eventSource;
14941
14947 readonly attribute wstring fileName;
14948
14954 readonly attribute unsigned long id;
14955
14961 readonly attribute long long initialSize;
14962
14968 readonly attribute wstring openMode;
14969
14975 readonly attribute long long offset;
14976
14982 readonly attribute FileStatus status;
14983
14990 void close();
14991
15008 void queryInfo (
15009 [retval] out IFsObjInfo objInfo
15010 );
15011
15034 void read (
15035 in unsigned long toRead,
15036 in unsigned long timeoutMS,
15037 [retval] out octet[] data
15038 );
15039
15064 void readAt (
15065 in long long offset,
15066 in unsigned long toRead,
15067 in unsigned long timeoutMS,
15068 [retval] out octet[] data
15069 );
15070
15090 void seek (
15091 in long long offset,
15092 in FileSeekType whence
15093 );
15094
15110 void setACL (
15111 in wstring acl
15112 );
15113
15131 void write (
15132 in octet[] data,
15133 in unsigned long timeoutMS,
15134 [retval] out unsigned long written
15135 );
15136
15164 void writeAt (
15165 in long long offset,
15166 in octet[] data,
15167 in unsigned long timeoutMS,
15168 [retval] out unsigned long written
15169 );
15170
15171 };
15172
15181 interface IGuestFile : IFile
15182 {
15183 };
15184
15193 interface IFsObjInfo : $unknown
15194 {
15200 readonly attribute long long accessTime;
15201
15207 readonly attribute long long allocatedSize;
15208
15214 readonly attribute long long birthTime;
15215
15221 readonly attribute long long changeTime;
15222
15228 readonly attribute unsigned long deviceNumber;
15229
15235 readonly attribute wstring fileAttributes;
15236
15242 readonly attribute unsigned long generationId;
15243
15249 readonly attribute unsigned long GID;
15250
15256 readonly attribute wstring groupName;
15257
15263 readonly attribute unsigned long hardLinks;
15264
15270 readonly attribute long long modificationTime;
15271
15277 readonly attribute wstring name;
15278
15284 readonly attribute long long nodeId;
15285
15291 readonly attribute unsigned long nodeIdDevice;
15292
15300 readonly attribute long long objectSize;
15301
15307 readonly attribute FsObjType type;
15308
15314 readonly attribute unsigned long UID;
15315
15321 readonly attribute unsigned long userFlags;
15322
15328 readonly attribute wstring userName;
15329
15330 };
15331
15340 interface IGuestFsObjInfo : IFsObjInfo
15341 {
15342 };
15343
15357 interface IGuest : $unknown
15358 {
15373 readonly attribute wstring OSTypeId;
15374
15380 readonly attribute AdditionsRunLevelType additionsRunLevel;
15381
15388 readonly attribute wstring additionsVersion;
15389
15397 readonly attribute unsigned long additionsRevision;
15398
15404 readonly attribute IEventSource eventSource;
15405
15412 readonly attribute IAdditionsFacility[] facilities;
15413
15417 readonly attribute IGuestSession[] sessions;
15418
15422 attribute unsigned long memoryBalloonSize;
15423
15427 attribute unsigned long statisticsUpdateInterval;
15428
15460 void internalGetStatistics (
15461 out unsigned long cpuUser,
15462 out unsigned long cpuKernel,
15463 out unsigned long cpuIdle,
15464 out unsigned long memTotal,
15465 out unsigned long memFree,
15466 out unsigned long memBalloon,
15467 out unsigned long memShared,
15468 out unsigned long memCache,
15469 out unsigned long pagedTotal,
15470 out unsigned long memAllocTotal,
15471 out unsigned long memFreeTotal,
15472 out unsigned long memBalloonTotal,
15473 out unsigned long memSharedTotal
15474 );
15475
15487 void getFacilityStatus (
15488 in AdditionsFacilityType facility,
15489 out long long timestamp,
15490 [retval] out AdditionsFacilityStatus status
15491 );
15492
15510 void getAdditionsStatus (
15511 in AdditionsRunLevelType level,
15512 [retval] out boolean active
15513 );
15514
15544 void setCredentials (
15545 in wstring userName,
15546 in wstring password,
15547 in wstring domain,
15548 in boolean allowInteractiveLogon
15549 );
15550
15580 void dragHGEnter (
15581 in unsigned long screenId,
15582 in unsigned long y,
15583 in unsigned long x,
15584 in DragAndDropAction defaultAction,
15585 in DragAndDropAction[] allowedActions,
15586 in wstring[] formats,
15587 [retval] out DragAndDropAction resultAction
15588 );
15589
15619 void dragHGMove (
15620 in unsigned long screenId,
15621 in unsigned long x,
15622 in unsigned long y,
15623 in DragAndDropAction defaultAction,
15624 in DragAndDropAction[] allowedActions,
15625 in wstring[] formats,
15626 [retval] out DragAndDropAction resultAction
15627 );
15628
15646 void dragHGLeave (
15647 in unsigned long screenId
15648 );
15649
15681 void dragHGDrop (
15682 in unsigned long screenId,
15683 in unsigned long x,
15684 in unsigned long y,
15685 in DragAndDropAction defaultAction,
15686 in DragAndDropAction[] allowedActions,
15687 in wstring[] formats,
15688 out wstring format,
15689 [retval] out DragAndDropAction resultAction
15690 );
15691
15715 void dragHGPutData (
15716 in unsigned long screenId,
15717 in wstring format,
15718 in octet[] data,
15719 [retval] out IProgress progress
15720 );
15721
15747 void dragGHPending (
15748 in unsigned long screenId,
15749 out wstring[] formats,
15750 out DragAndDropAction[] allowedActions,
15751 [retval] out DragAndDropAction defaultAction
15752 );
15753
15775 void dragGHDropped (
15776 in wstring format,
15777 in DragAndDropAction action,
15778 [retval] out IProgress progress
15779 );
15780
15798 void dragGHGetData (
15799 [retval] out octet[] data
15800 );
15801
15864 void createSession (
15865 in wstring user,
15866 in wstring password,
15867 in wstring domain,
15868 in wstring sessionName,
15869 [retval] out IGuestSession guestSession
15870 );
15871
15886 void findSession (
15887 in wstring sessionName,
15888 [retval] out IGuestSession[] sessions
15889 );
15890
15940 void updateGuestAdditions (
15941 in wstring source,
15942 in wstring[] arguments,
15943 in AdditionsUpdateFlag[] flags,
15944 [retval] out IProgress progress
15945 );
15946
15947 };
15948
15989 interface IProgress : $unknown
15990 {
15994 readonly attribute wstringUUID id;
15995
15999 readonly attribute wstring description;
16000
16004 readonly attribute $unknown initiator;
16005
16009 readonly attribute boolean cancelable;
16010
16018 readonly attribute unsigned long percent;
16019
16033 readonly attribute long timeRemaining;
16034
16038 readonly attribute boolean completed;
16039
16043 readonly attribute boolean canceled;
16044
16051 readonly attribute long resultCode;
16052
16062 readonly attribute IVirtualBoxErrorInfo errorInfo;
16063
16070 readonly attribute unsigned long operationCount;
16071
16075 readonly attribute unsigned long operation;
16076
16082 readonly attribute wstring operationDescription;
16083
16087 readonly attribute unsigned long operationPercent;
16088
16092 readonly attribute unsigned long operationWeight;
16093
16101 attribute unsigned long timeout;
16102
16106 void setCurrentOperationProgress (
16107 in unsigned long percent
16108 );
16109
16113 void setNextOperation (
16114 in wstring nextOperationDescription,
16115 in unsigned long nextOperationsWeight
16116 );
16117
16144 void waitForCompletion (
16145 in long timeout
16146 );
16147
16171 void waitForOperationCompletion (
16172 in unsigned long operation,
16173 in long timeout
16174 );
16175
16201 void waitForAsyncProgressCompletion (
16202 in IProgress pProgressAsync
16203 );
16204
16221 void cancel();
16222
16223 };
16224
16308 interface ISnapshot : $unknown
16309 {
16313 readonly attribute wstringUUID id;
16314
16322 attribute wstring name;
16323
16331 attribute wstring description;
16332
16338 readonly attribute long long timeStamp;
16339
16351 readonly attribute boolean online;
16352
16364 readonly attribute IMachine machine;
16365
16372 readonly attribute ISnapshot parent;
16373
16382 readonly attribute ISnapshot[] children;
16383
16391 void getChildrenCount (
16392 [retval] out unsigned long childrenCount
16393 );
16394
16395 };
16396
16583 interface IMediumAttachment : $unknown
16584 {
16589 readonly attribute IMedium medium;
16590
16596 readonly attribute wstring controller;
16597
16603 readonly attribute long port;
16604
16610 readonly attribute long device;
16611
16615 readonly attribute DeviceType type;
16616
16620 readonly attribute boolean passthrough;
16621
16625 readonly attribute boolean temporaryEject;
16626
16631 readonly attribute boolean isEjected;
16632
16636 readonly attribute boolean nonRotational;
16637
16641 readonly attribute boolean discard;
16642
16646 readonly attribute boolean hotPluggable;
16647
16651 readonly attribute IBandwidthGroup bandwidthGroup;
16652
16653 };
16654
16812 interface IMedium : $unknown
16813 {
16827 readonly attribute wstringUUID id;
16828
16847 attribute wstring description;
16848
16864 readonly attribute MediumState state;
16865
16874 readonly attribute MediumVariant[] variant;
16875
16885 readonly attribute wstring location;
16886
16906 readonly attribute wstring name;
16907
16912 readonly attribute DeviceType deviceType;
16913
16917 readonly attribute boolean hostDrive;
16918
16931 readonly attribute long long size;
16932
16947 readonly attribute wstring format;
16948
16964 readonly attribute IMediumFormat mediumFormat;
16965
16990 attribute MediumType type;
16991
17005 readonly attribute MediumType[] allowedTypes;
17006
17016 readonly attribute IMedium parent;
17017
17025 readonly attribute IMedium[] children;
17026
17037 readonly attribute IMedium base;
17038
17071 readonly attribute boolean readOnly;
17072
17088 readonly attribute long long logicalSize;
17089
17117 attribute boolean autoReset;
17118
17133 readonly attribute wstring lastAccessError;
17134
17151 readonly attribute wstringUUID[] machineIds;
17152
17178 void setIds (
17179 in boolean setImageId,
17180 in wstringUUID imageId,
17181 in boolean setParentId,
17182 in wstringUUID parentId
17183 );
17184
17219 void refreshState (
17220 [retval] out MediumState state
17221 );
17222
17249 void getSnapshotIds (
17250 in wstringUUID machineId,
17251 [retval] out wstringUUID[] snapshotIds
17252 );
17253
17316 void lockRead (
17317 [retval] out IToken token
17318 );
17319
17374 void lockWrite (
17375 [retval] out IToken token
17376 );
17377
17427 void close();
17428
17458 void getProperty (
17459 in wstring name,
17460 [retval] out wstring value
17461 );
17462
17494 void setProperty (
17495 in wstring name,
17496 in wstring value
17497 );
17498
17533 void getProperties (
17534 in wstring names,
17535 out wstring[] returnNames,
17536 [retval] out wstring[] returnValues
17537 );
17538
17568 void setProperties (
17569 in wstring[] names,
17570 in wstring[] values
17571 );
17572
17605 void createBaseStorage (
17606 in long long logicalSize,
17607 in MediumVariant[] variant,
17608 [retval] out IProgress progress
17609 );
17610
17662 void deleteStorage (
17663 [retval] out IProgress progress
17664 );
17665
17704 void createDiffStorage (
17705 in IMedium target,
17706 in MediumVariant[] variant,
17707 [retval] out IProgress progress
17708 );
17709
17785 void mergeTo (
17786 in IMedium target,
17787 [retval] out IProgress progress
17788 );
17789
17839 void cloneTo (
17840 in IMedium target,
17841 in MediumVariant[] variant,
17842 in IMedium parent,
17843 [retval] out IProgress progress
17844 );
17845
17892 void cloneToBase (
17893 in IMedium target,
17894 in MediumVariant[] variant,
17895 [retval] out IProgress progress
17896 );
17897
17939 void setLocation (
17940 in wstring location,
17941 [retval] out IProgress progress
17942 );
17943
17972 void compact (
17973 [retval] out IProgress progress
17974 );
17975
18008 void resize (
18009 in long long logicalSize,
18010 [retval] out IProgress progress
18011 );
18012
18046 void reset (
18047 [retval] out IProgress progress
18048 );
18049
18050 };
18051
18074 interface IMediumFormat : $unknown
18075 {
18094 readonly attribute wstring id;
18095
18103 readonly attribute wstring name;
18104
18113 readonly attribute MediumFormatCapabilities[] capabilities;
18114
18133 void describeFileExtensions (
18134 out wstring[] extensions,
18135 out DeviceType[] types
18136 );
18137
18165 void describeProperties (
18166 out wstring[] names,
18167 out wstring[] descriptions,
18168 out DataType[] types,
18169 out unsigned long[] flags,
18170 out wstring[] defaults
18171 );
18172
18173 };
18174
18189 interface IToken : $unknown
18190 {
18199 void abandon();
18200
18207 void dummy();
18208
18209 };
18210
18222 interface IKeyboard : $unknown
18223 {
18229 readonly attribute IEventSource eventSource;
18230
18243 void putScancode (
18244 in long scancode
18245 );
18246
18259 void putScancodes (
18260 in long[] scancodes,
18261 [retval] out unsigned long codesStored
18262 );
18263
18278 void putCAD();
18279
18280 };
18281
18293 interface IMouse : $unknown
18294 {
18309 readonly attribute boolean absoluteSupported;
18310
18325 readonly attribute boolean relativeSupported;
18326
18340 readonly attribute boolean multiTouchSupported;
18341
18356 readonly attribute boolean needsHostCursor;
18357
18363 readonly attribute IEventSource eventSource;
18364
18430 void putMouseEvent (
18431 in long dx,
18432 in long dy,
18433 in long dz,
18434 in long dw,
18435 in long buttonState
18436 );
18437
18510 void putMouseEventAbsolute (
18511 in long x,
18512 in long y,
18513 in long dz,
18514 in long dw,
18515 in long buttonState
18516 );
18517
18565 void putEventMultiTouch (
18566 in long count,
18567 in long long[] contacts,
18568 in unsigned long scanTime
18569 );
18570
18586 void putEventMultiTouchString (
18587 in long count,
18588 in wstring contacts,
18589 in unsigned long scanTime
18590 );
18591
18592 };
18593
18594 interface IFramebuffer : $unknown
18595 {
18604 readonly attribute octetPtr address;
18605
18609 readonly attribute unsigned long width;
18610
18614 readonly attribute unsigned long height;
18615
18622 readonly attribute unsigned long bitsPerPixel;
18623
18630 readonly attribute unsigned long bytesPerLine;
18631
18642 readonly attribute unsigned long pixelFormat;
18643
18650 readonly attribute boolean usesGuestVRAM;
18651
18661 readonly attribute unsigned long heightReduction;
18662
18677 readonly attribute IFramebufferOverlay overlay;
18678
18685 readonly attribute long long winId;
18686
18694 void lock();
18695
18703 void unlock();
18704
18712 void notifyUpdate (
18713 in unsigned long x,
18714 in unsigned long y,
18715 in unsigned long width,
18716 in unsigned long height
18717 );
18718
18831 void requestResize (
18832 in unsigned long screenId,
18833 in unsigned long pixelFormat,
18834 in octetPtr VRAM,
18835 in unsigned long bitsPerPixel,
18836 in unsigned long bytesPerLine,
18837 in unsigned long width,
18838 in unsigned long height,
18839 [retval] out boolean finished
18840 );
18841
18853 void videoModeSupported (
18854 in unsigned long width,
18855 in unsigned long height,
18856 in unsigned long bpp,
18857 [retval] out boolean supported
18858 );
18859
18896 void getVisibleRegion (
18897 in octetPtr rectangles,
18898 in unsigned long count,
18899 [retval] out unsigned long countCopied
18900 );
18901
18936 void setVisibleRegion (
18937 in octetPtr rectangles,
18938 in unsigned long count
18939 );
18940
18961 void processVHWACommand (
18962 in octetPtr command
18963 );
18964
18979 void notify3DEvent (
18980 in unsigned long type,
18981 in octetPtr data
18982 );
18983
18984 };
18985
19000 interface IFramebufferOverlay : IFramebuffer
19001 {
19005 readonly attribute unsigned long x;
19006
19010 readonly attribute unsigned long y;
19011
19017 attribute boolean visible;
19018
19025 attribute unsigned long alpha;
19026
19032 void move (
19033 in unsigned long x,
19034 in unsigned long y
19035 );
19036
19037 };
19038
19054 interface IDisplay : $unknown
19055 {
19059 void getScreenResolution (
19060 in unsigned long screenId,
19061 out unsigned long width,
19062 out unsigned long height,
19063 out unsigned long bitsPerPixel,
19064 out long xOrigin,
19065 out long yOrigin
19066 );
19067
19073 void setFramebuffer (
19074 in unsigned long screenId,
19075 in IFramebuffer framebuffer
19076 );
19077
19083 void getFramebuffer (
19084 in unsigned long screenId,
19085 out IFramebuffer framebuffer,
19086 out long xOrigin,
19087 out long yOrigin
19088 );
19089
19140 void setVideoModeHint (
19141 in unsigned long display,
19142 in boolean enabled,
19143 in boolean changeOrigin,
19144 in long originX,
19145 in long originY,
19146 in unsigned long width,
19147 in unsigned long height,
19148 in unsigned long bitsPerPixel
19149 );
19150
19162 void setSeamlessMode (
19163 in boolean enabled
19164 );
19165
19201 void takeScreenShot (
19202 in unsigned long screenId,
19203 in octetPtr address,
19204 in unsigned long width,
19205 in unsigned long height
19206 );
19207
19251 void takeScreenShotToArray (
19252 in unsigned long screenId,
19253 in unsigned long width,
19254 in unsigned long height,
19255 [retval] out octet[] screenData
19256 );
19257
19296 void takeScreenShotPNGToArray (
19297 in unsigned long screenId,
19298 in unsigned long width,
19299 in unsigned long height,
19300 [retval] out octet[] screenData
19301 );
19302
19354 void drawToScreen (
19355 in unsigned long screenId,
19356 in octetPtr address,
19357 in unsigned long x,
19358 in unsigned long y,
19359 in unsigned long width,
19360 in unsigned long height
19361 );
19362
19377 void invalidateAndUpdate();
19378
19392 void resizeCompleted (
19393 in unsigned long screenId
19394 );
19395
19408 void completeVHWACommand (
19409 in octetPtr command
19410 );
19411
19445 void viewportChanged (
19446 in unsigned long screenId,
19447 in unsigned long x,
19448 in unsigned long y,
19449 in unsigned long width,
19450 in unsigned long height
19451 );
19452
19453 };
19454
19470 interface INetworkAdapter : $unknown
19471 {
19479 attribute NetworkAdapterType adapterType;
19480
19488 readonly attribute unsigned long slot;
19489
19498 attribute boolean enabled;
19499
19506 attribute wstring MACAddress;
19507
19513 attribute NetworkAttachmentType attachmentType;
19514
19520 attribute wstring bridgedInterface;
19521
19527 attribute wstring hostOnlyInterface;
19528
19534 attribute wstring internalNetwork;
19535
19541 attribute wstring NATNetwork;
19542
19548 attribute wstring genericDriver;
19549
19556 attribute boolean cableConnected;
19557
19563 attribute unsigned long lineSpeed;
19564
19571 attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
19572
19579 attribute boolean traceEnabled;
19580
19587 attribute wstring traceFile;
19588
19596 readonly attribute INATEngine NATEngine;
19597
19604 attribute unsigned long bootPriority;
19605
19609 attribute IBandwidthGroup bandwidthGroup;
19610
19629 void getProperty (
19630 in wstring key,
19631 [retval] out wstring value
19632 );
19633
19652 void setProperty (
19653 in wstring key,
19654 in wstring value
19655 );
19656
19684 void getProperties (
19685 in wstring names,
19686 out wstring[] returnNames,
19687 [retval] out wstring[] returnValues
19688 );
19689
19690 };
19691
19720 interface ISerialPort : $unknown
19721 {
19729 readonly attribute unsigned long slot;
19730
19737 attribute boolean enabled;
19738
19742 attribute unsigned long IOBase;
19743
19747 attribute unsigned long IRQ;
19748
19759 attribute PortMode hostMode;
19760
19768 attribute boolean server;
19769
19779 attribute wstring path;
19780
19781 };
19782
19802 interface IParallelPort : $unknown
19803 {
19811 readonly attribute unsigned long slot;
19812
19819 attribute boolean enabled;
19820
19824 attribute unsigned long IOBase;
19825
19829 attribute unsigned long IRQ;
19830
19838 attribute wstring path;
19839
19840 };
19841
19842 interface IMachineDebugger : $unknown
19843 {
19847 attribute boolean singleStep;
19848
19852 attribute boolean recompileUser;
19853
19857 attribute boolean recompileSupervisor;
19858
19866 attribute boolean executeAllInIEM;
19867
19871 attribute boolean PATMEnabled;
19872
19876 attribute boolean CSAMEnabled;
19877
19881 attribute boolean logEnabled;
19882
19886 readonly attribute wstring logDbgFlags;
19887
19891 readonly attribute wstring logDbgGroups;
19892
19896 readonly attribute wstring logDbgDestinations;
19897
19901 readonly attribute wstring logRelFlags;
19902
19906 readonly attribute wstring logRelGroups;
19907
19911 readonly attribute wstring logRelDestinations;
19912
19919 readonly attribute boolean HWVirtExEnabled;
19920
19927 readonly attribute boolean HWVirtExNestedPagingEnabled;
19928
19935 readonly attribute boolean HWVirtExVPIDEnabled;
19936
19943 readonly attribute boolean HWVirtExUXEnabled;
19944
19953 readonly attribute wstring OSName;
19954
19963 readonly attribute wstring OSVersion;
19964
19971 readonly attribute boolean PAEEnabled;
19972
19979 attribute unsigned long virtualTimeRate;
19980
19988 readonly attribute long long VM;
19989
20005 void dumpGuestCore (
20006 in wstring filename,
20007 in wstring compression
20008 );
20009
20026 void dumpHostProcessCore (
20027 in wstring filename,
20028 in wstring compression
20029 );
20030
20051 void info (
20052 in wstring name,
20053 in wstring args,
20054 [retval] out wstring info
20055 );
20056
20062 void injectNMI();
20063
20074 void modifyLogGroups (
20075 in wstring settings
20076 );
20077
20088 void modifyLogFlags (
20089 in wstring settings
20090 );
20091
20102 void modifyLogDestinations (
20103 in wstring settings
20104 );
20105
20120 void readPhysicalMemory (
20121 in long long address,
20122 in unsigned long size,
20123 [retval] out octet[] bytes
20124 );
20125
20140 void writePhysicalMemory (
20141 in long long address,
20142 in unsigned long size,
20143 in octet[] bytes
20144 );
20145
20162 void readVirtualMemory (
20163 in unsigned long cpuId,
20164 in long long address,
20165 in unsigned long size,
20166 [retval] out octet[] bytes
20167 );
20168
20185 void writeVirtualMemory (
20186 in unsigned long cpuId,
20187 in long long address,
20188 in unsigned long size,
20189 in octet[] bytes
20190 );
20191
20204 void detectOS (
20205 [retval] out wstring os
20206 );
20207
20225 void getRegister (
20226 in unsigned long cpuId,
20227 in wstring name,
20228 [retval] out wstring value
20229 );
20230
20248 void getRegisters (
20249 in unsigned long cpuId,
20250 out wstring[] names,
20251 out wstring[] values
20252 );
20253
20272 void setRegister (
20273 in unsigned long cpuId,
20274 in wstring name,
20275 in wstring value
20276 );
20277
20296 void setRegisters (
20297 in unsigned long cpuId,
20298 in wstring[] names,
20299 in wstring[] values
20300 );
20301
20314 void dumpGuestStack (
20315 in unsigned long cpuId,
20316 [retval] out wstring stack
20317 );
20318
20326 void resetStats (
20327 in wstring pattern
20328 );
20329
20337 void dumpStats (
20338 in wstring pattern
20339 );
20340
20352 void getStats (
20353 in wstring pattern,
20354 in boolean withDescriptions,
20355 [retval] out wstring stats
20356 );
20357
20358 };
20359
20360 interface IUSBDeviceFilters : $unknown
20361 {
20387 readonly attribute IUSBDeviceFilter[] deviceFilters;
20388
20416 void createDeviceFilter (
20417 in wstring name,
20418 [retval] out IUSBDeviceFilter filter
20419 );
20420
20465 void insertDeviceFilter (
20466 in unsigned long position,
20467 in IUSBDeviceFilter filter
20468 );
20469
20502 void removeDeviceFilter (
20503 in unsigned long position,
20504 [retval] out IUSBDeviceFilter filter
20505 );
20506
20507 };
20508
20509 interface IUSBController : $unknown
20510 {
20516 readonly attribute wstring name;
20517
20523 readonly attribute USBControllerType type;
20524
20532 readonly attribute unsigned short USBStandard;
20533
20534 };
20535
20548 interface IUSBDevice : $unknown
20549 {
20556 readonly attribute wstringUUID id;
20557
20561 readonly attribute unsigned short vendorId;
20562
20566 readonly attribute unsigned short productId;
20567
20575 readonly attribute unsigned short revision;
20576
20580 readonly attribute wstring manufacturer;
20581
20585 readonly attribute wstring product;
20586
20590 readonly attribute wstring serialNumber;
20591
20595 readonly attribute wstring address;
20596
20603 readonly attribute unsigned short port;
20604
20610 readonly attribute unsigned short version;
20611
20619 readonly attribute unsigned short portVersion;
20620
20627 readonly attribute boolean remote;
20628
20629 };
20630
20705 interface IUSBDeviceFilter : $unknown
20706 {
20714 attribute wstring name;
20715
20719 attribute boolean active;
20720
20728 attribute wstring vendorId;
20729
20737 attribute wstring productId;
20738
20752 attribute wstring revision;
20753
20758 attribute wstring manufacturer;
20759
20764 attribute wstring product;
20765
20770 attribute wstring serialNumber;
20771
20776 attribute wstring port;
20777
20787 attribute wstring remote;
20788
20798 attribute unsigned long maskedInterfaces;
20799
20800 };
20801
20818 interface IHostUSBDevice : IUSBDevice
20819 {
20825 readonly attribute USBDeviceState state;
20826
20827 };
20828
20851 interface IHostUSBDeviceFilter : IUSBDeviceFilter
20852 {
20859 attribute USBDeviceFilterAction action;
20860
20861 };
20862
20871 interface IAudioAdapter : $unknown
20872 {
20881 attribute boolean enabled;
20882
20888 attribute AudioControllerType audioController;
20889
20896 attribute AudioDriverType audioDriver;
20897
20898 };
20899
20900 interface IVRDEServer : $unknown
20901 {
20905 attribute boolean enabled;
20906
20910 attribute AuthType authType;
20911
20915 attribute unsigned long authTimeout;
20916
20923 attribute boolean allowMultiConnection;
20924
20932 attribute boolean reuseSingleConnection;
20933
20940 attribute wstring VRDEExtPack;
20941
20948 attribute wstring authLibrary;
20949
20955 readonly attribute wstring[] VRDEProperties;
20956
20970 void setVRDEProperty (
20971 in wstring key,
20972 in wstring value
20973 );
20974
20988 void getVRDEProperty (
20989 in wstring key,
20990 [retval] out wstring value
20991 );
20992
20993 };
20994
21052 interface ISharedFolder : $unknown
21053 {
21057 readonly attribute wstring name;
21058
21062 readonly attribute wstring hostPath;
21063
21073 readonly attribute boolean accessible;
21074
21081 readonly attribute boolean writable;
21082
21088 readonly attribute boolean autoMount;
21089
21102 readonly attribute wstring lastAccessError;
21103
21104 };
21105
21106 interface IInternalSessionControl : $unknown
21107 {
21112 void getPID (
21113 [retval] out unsigned long pid
21114 );
21115
21137 void getRemoteConsole (
21138 [retval] out IConsole console
21139 );
21140
21155 void assignRemoteMachine (
21156 in IMachine machine,
21157 in IConsole console
21158 );
21159
21183 void updateMachineState (
21184 in MachineState machineState
21185 );
21186
21202 void uninitialize();
21203
21226 void onNetworkAdapterChange (
21227 in INetworkAdapter networkAdapter,
21228 in boolean changeAdapter
21229 );
21230
21253 void onSerialPortChange (
21254 in ISerialPort serialPort
21255 );
21256
21279 void onParallelPortChange (
21280 in IParallelPort parallelPort
21281 );
21282
21305 void onStorageControllerChange();
21306
21333 void onMediumChange (
21334 in IMediumAttachment mediumAttachment,
21335 in boolean force
21336 );
21337
21367 void onStorageDeviceChange (
21368 in IMediumAttachment mediumAttachment,
21369 in boolean remove,
21370 in boolean silent
21371 );
21372
21380 void onClipboardModeChange (
21381 in ClipboardMode clipboardMode
21382 );
21383
21391 void onDragAndDropModeChange (
21392 in DragAndDropMode dragAndDropMode
21393 );
21394
21404 void onCPUChange (
21405 in unsigned long cpu,
21406 in boolean add
21407 );
21408
21416 void onCPUExecutionCapChange (
21417 in unsigned long executionCap
21418 );
21419
21444 void onVRDEServerChange (
21445 in boolean restart
21446 );
21447
21453 void onVideoCaptureChange();
21454
21477 void onUSBControllerChange();
21478
21507 void onSharedFolderChange (
21508 in boolean global
21509 );
21510
21536 void onUSBDeviceAttach (
21537 in IUSBDevice device,
21538 in IVirtualBoxErrorInfo error,
21539 in unsigned long maskedInterfaces
21540 );
21541
21567 void onUSBDeviceDetach (
21568 in wstringUUID id,
21569 in IVirtualBoxErrorInfo error
21570 );
21571
21589 void onShowWindow (
21590 in boolean check,
21591 out boolean canShow,
21592 out long long winId
21593 );
21594
21602 void onBandwidthGroupChange (
21603 in IBandwidthGroup bandwidthGroup
21604 );
21605
21629 void accessGuestProperty (
21630 in wstring name,
21631 in wstring value,
21632 in wstring flags,
21633 in boolean isSetter,
21634 out wstring retValue,
21635 out long long retTimestamp,
21636 out wstring retFlags
21637 );
21638
21686 void enumerateGuestProperties (
21687 in wstring patterns,
21688 out wstring[] keys,
21689 out wstring[] values,
21690 out long long[] timestamps,
21691 out wstring[] flags
21692 );
21693
21728 void onlineMergeMedium (
21729 in IMediumAttachment mediumAttachment,
21730 in unsigned long sourceIdx,
21731 in unsigned long targetIdx,
21732 in IProgress progress
21733 );
21734
21758 void enableVMMStatistics (
21759 in boolean enable
21760 );
21761
21789 void pauseWithReason (
21790 in Reason reason
21791 );
21792
21820 void resumeWithReason (
21821 in Reason reason
21822 );
21823
21853 void saveStateWithReason (
21854 in Reason reason,
21855 [retval] out IProgress progress
21856 );
21857
21881 void assignMachine (
21882 in IMachine machine,
21883 in LockType lockType,
21884 in wstring tokenId
21885 );
21886
21910 void assignMachine (
21911 in IMachine machine,
21912 in LockType lockType,
21913 in IToken token
21914 );
21915
21916 };
21917
21976 interface ISession : $unknown
21977 {
21981 readonly attribute SessionState state;
21982
21990 readonly attribute SessionType type;
21991
21995 readonly attribute IMachine machine;
21996
22000 readonly attribute IConsole console;
22001
22033 void unlockMachine();
22034
22035 };
22036
22059 interface IStorageController : $unknown
22060 {
22069 readonly attribute wstring name;
22070
22076 readonly attribute unsigned long maxDevicesPerPortCount;
22077
22083 readonly attribute unsigned long minPortCount;
22084
22090 readonly attribute unsigned long maxPortCount;
22091
22097 attribute unsigned long instance;
22098
22107 attribute unsigned long portCount;
22108
22114 readonly attribute StorageBus bus;
22115
22128 attribute StorageControllerType controllerType;
22129
22144 attribute boolean useHostIOCache;
22145
22151 readonly attribute boolean bootable;
22152
22153 };
22154
22178 interface IManagedObjectRef : $unknown
22179 {
22186 void getInterfaceName (
22187 [retval] out wstring return
22188 );
22189
22197 void release();
22198
22199 };
22200
22209 interface IWebsessionManager : $unknown
22210 {
22219 void logon (
22220 in wstring username,
22221 in wstring password,
22222 [retval] out IVirtualBox return
22223 );
22224
22234 void getSessionObject (
22235 in IVirtualBox refIVirtualBox,
22236 [retval] out ISession return
22237 );
22238
22246 void logoff (
22247 in IVirtualBox refIVirtualBox
22248 );
22249
22250 };
22251
22260 interface IPerformanceMetric : $unknown
22261 {
22267 readonly attribute wstring metricName;
22268
22274 readonly attribute $unknown object;
22275
22281 readonly attribute wstring description;
22282
22288 readonly attribute unsigned long period;
22289
22299 readonly attribute unsigned long count;
22300
22306 readonly attribute wstring unit;
22307
22313 readonly attribute long minimumValue;
22314
22320 readonly attribute long maximumValue;
22321
22322 };
22323
22430 interface IPerformanceCollector : $unknown
22431 {
22442 readonly attribute wstring[] metricNames;
22443
22467 void getMetrics (
22468 in wstring[] metricNames,
22469 in $unknown[] objects,
22470 [retval] out IPerformanceMetric[] metrics
22471 );
22472
22511 void setupMetrics (
22512 in wstring[] metricNames,
22513 in $unknown[] objects,
22514 in unsigned long period,
22515 in unsigned long count,
22516 [retval] out IPerformanceMetric[] affectedMetrics
22517 );
22518
22547 void enableMetrics (
22548 in wstring[] metricNames,
22549 in $unknown[] objects,
22550 [retval] out IPerformanceMetric[] affectedMetrics
22551 );
22552
22581 void disableMetrics (
22582 in wstring[] metricNames,
22583 in $unknown[] objects,
22584 [retval] out IPerformanceMetric[] affectedMetrics
22585 );
22586
22676 void queryMetricsData (
22677 in wstring[] metricNames,
22678 in $unknown[] objects,
22679 out wstring[] returnMetricNames,
22680 out $unknown[] returnObjects,
22681 out wstring[] returnUnits,
22682 out unsigned long[] returnScales,
22683 out unsigned long[] returnSequenceNumbers,
22684 out unsigned long[] returnDataIndices,
22685 out unsigned long[] returnDataLengths,
22686 [retval] out long[] returnData
22687 );
22688
22689 };
22690
22698 interface INATEngine : $unknown
22699 {
22704 attribute wstring network;
22705
22712 attribute wstring hostIP;
22713
22718 attribute wstring TFTPPrefix;
22719
22724 attribute wstring TFTPBootFile;
22725
22733 attribute wstring TFTPNextServer;
22734
22738 attribute unsigned long aliasMode;
22739
22743 attribute boolean DNSPassDomain;
22744
22749 attribute boolean DNSProxy;
22750
22755 attribute boolean DNSUseHostResolver;
22756
22761 readonly attribute wstring[] redirects;
22762
22778 void setNetworkSettings (
22779 in unsigned long mtu,
22780 in unsigned long sockSnd,
22781 in unsigned long sockRcv,
22782 in unsigned long TcpWndSnd,
22783 in unsigned long TcpWndRcv
22784 );
22785
22790 void getNetworkSettings (
22791 out unsigned long mtu,
22792 out unsigned long sockSnd,
22793 out unsigned long sockRcv,
22794 out unsigned long TcpWndSnd,
22795 out unsigned long TcpWndRcv
22796 );
22797
22817 void addRedirect (
22818 in wstring name,
22819 in NATProtocol proto,
22820 in wstring hostIP,
22821 in unsigned short hostPort,
22822 in wstring guestIP,
22823 in unsigned short guestPort
22824 );
22825
22831 void removeRedirect (
22832 in wstring name
22833 );
22834
22835 };
22836
22845 interface IExtPackPlugIn : $unknown
22846 {
22850 readonly attribute wstring name;
22851
22855 readonly attribute wstring description;
22856
22862 readonly attribute wstring frontend;
22863
22867 readonly attribute wstring modulePath;
22868
22869 };
22870
22879 interface IExtPackBase : $unknown
22880 {
22884 readonly attribute wstring name;
22885
22889 readonly attribute wstring description;
22890
22902 readonly attribute wstring version;
22903
22907 readonly attribute unsigned long revision;
22908
22918 readonly attribute wstring edition;
22919
22923 readonly attribute wstring VRDEModule;
22924
22928 readonly attribute IExtPackPlugIn[] plugIns;
22929
22939 readonly attribute boolean usable;
22940
22947 readonly attribute wstring whyUnusable;
22948
22952 readonly attribute boolean showLicense;
22953
22962 readonly attribute wstring license;
22963
22987 void queryLicense (
22988 in wstring preferredLocale,
22989 in wstring preferredLanguage,
22990 in wstring format,
22991 [retval] out wstring licenseText
22992 );
22993
22994 };
22995
23004 interface IExtPack : IExtPackBase
23005 {
23017 void queryObject (
23018 in wstring objUuid,
23019 [retval] out $unknown returnInterface
23020 );
23021
23022 };
23023
23033 interface IExtPackFile : IExtPackBase
23034 {
23040 readonly attribute wstring filePath;
23041
23060 void install (
23061 in boolean replace,
23062 in wstring displayInfo,
23063 [retval] out IProgress progess
23064 );
23065
23066 };
23067
23078 interface IExtPackManager : $unknown
23079 {
23085 readonly attribute IExtPack[] installedExtPacks;
23086
23104 void find (
23105 in wstring name,
23106 [retval] out IExtPack returnData
23107 );
23108
23120 void openExtPackFile (
23121 in wstring path,
23122 [retval] out IExtPackFile file
23123 );
23124
23143 void uninstall (
23144 in wstring name,
23145 in boolean forcedRemoval,
23146 in wstring displayInfo,
23147 [retval] out IProgress progess
23148 );
23149
23153 void cleanup();
23154
23167 void queryAllPlugInsForFrontend (
23168 in wstring frontendName,
23169 [retval] out wstring[] plugInModules
23170 );
23171
23179 void isExtPackUsable (
23180 in wstring name,
23181 [retval] out boolean usable
23182 );
23183
23184 };
23185
23191 interface IBandwidthGroup : $unknown
23192 {
23196 readonly attribute wstring name;
23197
23201 readonly attribute BandwidthGroupType type;
23202
23206 readonly attribute unsigned long reference;
23207
23212 attribute long long maxBytesPerSec;
23213
23214 };
23215
23224 interface IBandwidthControl : $unknown
23225 {
23231 readonly attribute unsigned long numGroups;
23232
23245 void createBandwidthGroup (
23246 in wstring name,
23247 in BandwidthGroupType type,
23248 in long long maxBytesPerSec
23249 );
23250
23258 void deleteBandwidthGroup (
23259 in wstring name
23260 );
23261
23271 void getBandwidthGroup (
23272 in wstring name,
23273 [retval] out IBandwidthGroup bandwidthGroup
23274 );
23275
23283 void getAllBandwidthGroups (
23284 [retval] out IBandwidthGroup[] bandwidthGroups
23285 );
23286
23287 };
23288
23301 interface IVirtualBoxClient : $unknown
23302 {
23308 readonly attribute IVirtualBox virtualBox;
23309
23315 readonly attribute ISession session;
23316
23322 readonly attribute IEventSource eventSource;
23323
23334 void checkMachineError (
23335 in IMachine machine
23336 );
23337
23338 };
23339
23353 interface IEventSource : $unknown
23354 {
23360 void createListener (
23361 [retval] out IEventListener listener
23362 );
23363
23379 void createAggregator (
23380 in IEventSource[] subordinates,
23381 [retval] out IEventSource result
23382 );
23383
23416 void registerListener (
23417 in IEventListener listener,
23418 in VBoxEventType[] interesting,
23419 in boolean active
23420 );
23421
23430 void unregisterListener (
23431 in IEventListener listener
23432 );
23433
23448 void fireEvent (
23449 in IEvent event,
23450 in long timeout,
23451 [retval] out boolean result
23452 );
23453
23478 void getEvent (
23479 in IEventListener listener,
23480 in long timeout,
23481 [retval] out IEvent event
23482 );
23483
23495 void eventProcessed (
23496 in IEventListener listener,
23497 in IEvent event
23498 );
23499
23500 };
23501
23511 interface IEventListener : $unknown
23512 {
23525 void handleEvent (
23526 in IEvent event
23527 );
23528
23529 };
23530
23607 interface IEvent : $unknown
23608 {
23614 readonly attribute VBoxEventType type;
23615
23621 readonly attribute IEventSource source;
23622
23633 readonly attribute boolean waitable;
23634
23641 void setProcessed();
23642
23656 void waitProcessed (
23657 in long timeout,
23658 [retval] out boolean result
23659 );
23660
23661 };
23662
23668 interface IReusableEvent : IEvent
23669 {
23673 readonly attribute unsigned long generation;
23674
23681 void reuse();
23682
23683 };
23684
23690 interface IMachineEvent : IEvent
23691 {
23695 readonly attribute wstringUUID machineId;
23696
23697 };
23698
23704 interface IMachineStateChangedEvent : IMachineEvent
23705 {
23709 readonly attribute MachineState state;
23710
23711 };
23712
23720 interface IMachineDataChangedEvent : IMachineEvent
23721 {
23728 readonly attribute boolean temporary;
23729
23730 };
23731
23740 interface IMediumRegisteredEvent : IEvent
23741 {
23745 readonly attribute wstringUUID mediumId;
23746
23750 readonly attribute DeviceType mediumType;
23751
23758 readonly attribute boolean registered;
23759
23760 };
23761
23770 interface IMachineRegisteredEvent : IMachineEvent
23771 {
23778 readonly attribute boolean registered;
23779
23780 };
23781
23791 interface ISessionStateChangedEvent : IMachineEvent
23792 {
23798 readonly attribute SessionState state;
23799
23800 };
23801
23809 interface IGuestPropertyChangedEvent : IMachineEvent
23810 {
23816 readonly attribute wstring name;
23817
23823 readonly attribute wstring value;
23824
23830 readonly attribute wstring flags;
23831
23832 };
23833
23839 interface ISnapshotEvent : IMachineEvent
23840 {
23844 readonly attribute wstringUUID snapshotId;
23845
23846 };
23847
23857 interface ISnapshotTakenEvent : ISnapshotEvent
23858 {
23859 };
23860
23877 interface ISnapshotDeletedEvent : ISnapshotEvent
23878 {
23879 };
23880
23890 interface ISnapshotChangedEvent : ISnapshotEvent
23891 {
23892 };
23893
23902 interface IMousePointerShapeChangedEvent : IEvent
23903 {
23909 readonly attribute boolean visible;
23910
23916 readonly attribute boolean alpha;
23917
23923 readonly attribute unsigned long xhot;
23924
23930 readonly attribute unsigned long yhot;
23931
23937 readonly attribute unsigned long width;
23938
23944 readonly attribute unsigned long height;
23945
23978 readonly attribute octet[] shape;
23979
23980 };
23981
23990 interface IMouseCapabilityChangedEvent : IEvent
23991 {
23997 readonly attribute boolean supportsAbsolute;
23998
24004 readonly attribute boolean supportsRelative;
24005
24011 readonly attribute boolean supportsMultiTouch;
24012
24018 readonly attribute boolean needsHostCursor;
24019
24020 };
24021
24030 interface IKeyboardLedsChangedEvent : IEvent
24031 {
24037 readonly attribute boolean numLock;
24038
24044 readonly attribute boolean capsLock;
24045
24051 readonly attribute boolean scrollLock;
24052
24053 };
24054
24063 interface IStateChangedEvent : IEvent
24064 {
24070 readonly attribute MachineState state;
24071
24072 };
24073
24083 interface IAdditionsStateChangedEvent : IEvent
24084 {
24085 };
24086
24097 interface INetworkAdapterChangedEvent : IEvent
24098 {
24104 readonly attribute INetworkAdapter networkAdapter;
24105
24106 };
24107
24118 interface ISerialPortChangedEvent : IEvent
24119 {
24125 readonly attribute ISerialPort serialPort;
24126
24127 };
24128
24139 interface IParallelPortChangedEvent : IEvent
24140 {
24146 readonly attribute IParallelPort parallelPort;
24147
24148 };
24149
24159 interface IStorageControllerChangedEvent : IEvent
24160 {
24161 };
24162
24172 interface IMediumChangedEvent : IEvent
24173 {
24179 readonly attribute IMediumAttachment mediumAttachment;
24180
24181 };
24182
24190 interface IClipboardModeChangedEvent : IEvent
24191 {
24197 readonly attribute ClipboardMode clipboardMode;
24198
24199 };
24200
24208 interface IDragAndDropModeChangedEvent : IEvent
24209 {
24215 readonly attribute DragAndDropMode dragAndDropMode;
24216
24217 };
24218
24226 interface ICPUChangedEvent : IEvent
24227 {
24233 readonly attribute unsigned long CPU;
24234
24240 readonly attribute boolean add;
24241
24242 };
24243
24251 interface ICPUExecutionCapChangedEvent : IEvent
24252 {
24258 readonly attribute unsigned long executionCap;
24259
24260 };
24261
24269 interface IGuestKeyboardEvent : IEvent
24270 {
24276 readonly attribute long[] scancodes;
24277
24278 };
24279
24287 interface IGuestMouseEvent : IReusableEvent
24288 {
24294 readonly attribute GuestMouseEventMode mode;
24295
24301 readonly attribute long x;
24302
24308 readonly attribute long y;
24309
24315 readonly attribute long z;
24316
24322 readonly attribute long w;
24323
24329 readonly attribute long buttons;
24330
24331 };
24332
24340 interface IGuestMultiTouchEvent : IEvent
24341 {
24347 readonly attribute long contactCount;
24348
24354 readonly attribute short[] xPositions;
24355
24361 readonly attribute short[] yPositions;
24362
24368 readonly attribute unsigned short[] contactIds;
24369
24377 readonly attribute unsigned short[] contactFlags;
24378
24384 readonly attribute unsigned long scanTime;
24385
24386 };
24387
24393 interface IGuestSessionEvent : IEvent
24394 {
24398 readonly attribute IGuestSession session;
24399
24400 };
24401
24409 interface IGuestSessionStateChangedEvent : IGuestSessionEvent
24410 {
24416 readonly attribute unsigned long id;
24417
24423 readonly attribute GuestSessionStatus status;
24424
24434 readonly attribute IVirtualBoxErrorInfo error;
24435
24436 };
24437
24445 interface IGuestSessionRegisteredEvent : IGuestSessionEvent
24446 {
24453 readonly attribute boolean registered;
24454
24455 };
24456
24462 interface IGuestProcessEvent : IGuestSessionEvent
24463 {
24469 readonly attribute IGuestProcess process;
24470
24476 readonly attribute unsigned long pid;
24477
24478 };
24479
24487 interface IGuestProcessRegisteredEvent : IGuestProcessEvent
24488 {
24495 readonly attribute boolean registered;
24496
24497 };
24498
24506 interface IGuestProcessStateChangedEvent : IGuestProcessEvent
24507 {
24513 readonly attribute ProcessStatus status;
24514
24524 readonly attribute IVirtualBoxErrorInfo error;
24525
24526 };
24527
24535 interface IGuestProcessIOEvent : IGuestProcessEvent
24536 {
24543 readonly attribute unsigned long handle;
24544
24550 readonly attribute unsigned long processed;
24551
24552 };
24553
24563 interface IGuestProcessInputNotifyEvent : IGuestProcessIOEvent
24564 {
24570 readonly attribute ProcessInputStatus status;
24571
24572 };
24573
24581 interface IGuestProcessOutputEvent : IGuestProcessIOEvent
24582 {
24588 readonly attribute octet[] data;
24589
24590 };
24591
24597 interface IGuestFileEvent : IGuestSessionEvent
24598 {
24604 readonly attribute IGuestFile file;
24605
24606 };
24607
24615 interface IGuestFileRegisteredEvent : IGuestFileEvent
24616 {
24623 readonly attribute boolean registered;
24624
24625 };
24626
24634 interface IGuestFileStateChangedEvent : IGuestFileEvent
24635 {
24641 readonly attribute FileStatus status;
24642
24652 readonly attribute IVirtualBoxErrorInfo error;
24653
24654 };
24655
24663 interface IGuestFileIOEvent : IGuestFileEvent
24664 {
24670 readonly attribute long long offset;
24671
24677 readonly attribute unsigned long processed;
24678
24679 };
24680
24688 interface IGuestFileOffsetChangedEvent : IGuestFileIOEvent
24689 {
24690 };
24691
24699 interface IGuestFileReadEvent : IGuestFileIOEvent
24700 {
24706 readonly attribute octet[] data;
24707
24708 };
24709
24717 interface IGuestFileWriteEvent : IGuestFileIOEvent
24718 {
24719 };
24720
24731 interface IVRDEServerChangedEvent : IEvent
24732 {
24733 };
24734
24744 interface IVRDEServerInfoChangedEvent : IEvent
24745 {
24746 };
24747
24755 interface IVideoCaptureChangedEvent : IEvent
24756 {
24757 };
24758
24769 interface IUSBControllerChangedEvent : IEvent
24770 {
24771 };
24772
24796 interface IUSBDeviceStateChangedEvent : IEvent
24797 {
24803 readonly attribute IUSBDevice device;
24804
24810 readonly attribute boolean attached;
24811
24817 readonly attribute IVirtualBoxErrorInfo error;
24818
24819 };
24820
24836 interface ISharedFolderChangedEvent : IEvent
24837 {
24843 readonly attribute Scope scope;
24844
24845 };
24846
24898 interface IRuntimeErrorEvent : IEvent
24899 {
24905 readonly attribute boolean fatal;
24906
24912 readonly attribute wstring id;
24913
24919 readonly attribute wstring message;
24920
24921 };
24922
24930 interface IEventSourceChangedEvent : IEvent
24931 {
24937 readonly attribute IEventListener listener;
24938
24944 readonly attribute boolean add;
24945
24946 };
24947
24956 interface IExtraDataChangedEvent : IEvent
24957 {
24964 readonly attribute wstringUUID machineId;
24965
24971 readonly attribute wstring key;
24972
24978 readonly attribute wstring value;
24979
24980 };
24981
24987 interface IVetoEvent : IEvent
24988 {
24998 void addVeto (
24999 in wstring reason
25000 );
25001
25011 void isVetoed (
25012 [retval] out boolean result
25013 );
25014
25024 void getVetos (
25025 [retval] out wstring[] result
25026 );
25027
25028 };
25029
25039 interface IExtraDataCanChangeEvent : IVetoEvent
25040 {
25047 readonly attribute wstringUUID machineId;
25048
25054 readonly attribute wstring key;
25055
25061 readonly attribute wstring value;
25062
25063 };
25064
25080 interface ICanShowWindowEvent : IVetoEvent
25081 {
25082 };
25083
25115 interface IShowWindowEvent : IEvent
25116 {
25125 attribute long long winId;
25126
25127 };
25128
25136 interface INATRedirectEvent : IMachineEvent
25137 {
25143 readonly attribute unsigned long slot;
25144
25150 readonly attribute boolean remove;
25151
25157 readonly attribute wstring name;
25158
25164 readonly attribute NATProtocol proto;
25165
25171 readonly attribute wstring hostIP;
25172
25178 readonly attribute long hostPort;
25179
25185 readonly attribute wstring guestIP;
25186
25192 readonly attribute long guestPort;
25193
25194 };
25195
25208 interface IHostPCIDevicePlugEvent : IMachineEvent
25209 {
25215 readonly attribute boolean plugged;
25216
25223 readonly attribute boolean success;
25224
25230 readonly attribute IPCIDeviceAttachment attachment;
25231
25237 readonly attribute wstring message;
25238
25239 };
25240
25249 interface IVBoxSVCAvailabilityChangedEvent : IEvent
25250 {
25256 readonly attribute boolean available;
25257
25258 };
25259
25267 interface IBandwidthGroupChangedEvent : IEvent
25268 {
25274 readonly attribute IBandwidthGroup bandwidthGroup;
25275
25276 };
25277
25285 interface IGuestMonitorChangedEvent : IEvent
25286 {
25292 readonly attribute GuestMonitorChangedEventType changeType;
25293
25299 readonly attribute unsigned long screenId;
25300
25307 readonly attribute unsigned long originX;
25308
25315 readonly attribute unsigned long originY;
25316
25323 readonly attribute unsigned long width;
25324
25331 readonly attribute unsigned long height;
25332
25333 };
25334
25342 interface IGuestUserStateChangedEvent : IEvent
25343 {
25349 readonly attribute wstring name;
25350
25357 readonly attribute wstring domain;
25358
25365 readonly attribute GuestUserState state;
25366
25372 readonly attribute wstring stateDetails;
25373
25374 };
25375
25385 interface IStorageDeviceChangedEvent : IEvent
25386 {
25392 readonly attribute IMediumAttachment storageDevice;
25393
25399 readonly attribute boolean removed;
25400
25406 readonly attribute boolean silent;
25407
25408 };
25409
25410 interface INATNetworkChangedEvent : IEvent
25411 {
25412 readonly attribute wstring networkName;
25413
25414 };
25415
25416 interface INATNetworkStartStopEvent : INATNetworkChangedEvent
25417 {
25423 readonly attribute boolean startEvent;
25424
25425 };
25426
25427 interface INATNetworkAlterEvent : INATNetworkChangedEvent
25428 {
25429 };
25430
25431 interface INATNetworkCreationDeletionEvent : INATNetworkAlterEvent
25432 {
25433 readonly attribute boolean creationEvent;
25434
25435 };
25436
25437 interface INATNetworkSettingEvent : INATNetworkAlterEvent
25438 {
25439 readonly attribute boolean enabled;
25440
25441 readonly attribute wstring network;
25442
25443 readonly attribute wstring gateway;
25444
25445 readonly attribute boolean advertiseDefaultIPv6RouteEnabled;
25446
25447 readonly attribute boolean needDhcpServer;
25448
25449 };
25450
25451 interface INATNetworkPortForwardEvent : INATNetworkAlterEvent
25452 {
25453 readonly attribute boolean create;
25454
25455 readonly attribute boolean ipv6;
25456
25457 readonly attribute wstring name;
25458
25459 readonly attribute NATProtocol proto;
25460
25461 readonly attribute wstring hostIp;
25462
25463 readonly attribute long hostPort;
25464
25465 readonly attribute wstring guestIp;
25466
25467 readonly attribute long guestPort;
25468
25469 };
25470
25471 interface IHostNameResolutionConfigurationChangeEvent : IEvent
25472 {
25473 };
25474
25475