00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00137 const HRESULT VBOX_E_OBJECT_NOT_FOUND = 0x80BB0001;
00145 const HRESULT VBOX_E_INVALID_VM_STATE = 0x80BB0002;
00153 const HRESULT VBOX_E_VM_ERROR = 0x80BB0003;
00161 const HRESULT VBOX_E_FILE_ERROR = 0x80BB0004;
00169 const HRESULT VBOX_E_IPRT_ERROR = 0x80BB0005;
00177 const HRESULT VBOX_E_PDM_ERROR = 0x80BB0006;
00185 const HRESULT VBOX_E_INVALID_OBJECT_STATE = 0x80BB0007;
00193 const HRESULT VBOX_E_HOST_ERROR = 0x80BB0008;
00201 const HRESULT VBOX_E_NOT_SUPPORTED = 0x80BB0009;
00209 const HRESULT VBOX_E_XML_ERROR = 0x80BB000A;
00217 const HRESULT VBOX_E_INVALID_SESSION_STATE = 0x80BB000B;
00225 const HRESULT VBOX_E_OBJECT_IN_USE = 0x80BB000C;
00235 enum SettingsVersion
00236 {
00241 SettingsVersion_Null = 0,
00246 SettingsVersion_v1_0 = 1,
00251 SettingsVersion_v1_1 = 2,
00256 SettingsVersion_v1_2 = 3,
00261 SettingsVersion_v1_3pre = 4,
00266 SettingsVersion_v1_3 = 5,
00271 SettingsVersion_v1_4 = 6,
00276 SettingsVersion_v1_5 = 7,
00281 SettingsVersion_v1_6 = 8,
00286 SettingsVersion_v1_7 = 9,
00291 SettingsVersion_v1_8 = 10,
00296 SettingsVersion_v1_9 = 11,
00301 SettingsVersion_v1_10 = 12,
00306 SettingsVersion_v1_11 = 13,
00311 SettingsVersion_v1_12 = 14,
00316 SettingsVersion_v1_13 = 15,
00321 SettingsVersion_v1_14 = 16,
00326 SettingsVersion_Future = 99999,
00327 };
00328
00336 enum AccessMode
00337 {
00338 AccessMode_ReadOnly = 1,
00339 AccessMode_ReadWrite = 2,
00340 };
00341
00459 enum MachineState
00460 {
00465 MachineState_Null = 0,
00473 MachineState_PoweredOff = 1,
00482 MachineState_Saved = 2,
00491 MachineState_Teleported = 3,
00500 MachineState_Aborted = 4,
00507 MachineState_Running = 5,
00514 MachineState_Paused = 6,
00522 MachineState_Stuck = 7,
00532 MachineState_Teleporting = 8,
00543 MachineState_LiveSnapshotting = 9,
00551 MachineState_Starting = 10,
00559 MachineState_Stopping = 11,
00567 MachineState_Saving = 12,
00575 MachineState_Restoring = 13,
00584 MachineState_TeleportingPausedVM = 14,
00591 MachineState_TeleportingIn = 15,
00598 MachineState_FaultTolerantSyncing = 16,
00606 MachineState_DeletingSnapshotOnline = 17,
00614 MachineState_DeletingSnapshotPaused = 18,
00621 MachineState_RestoringSnapshot = 19,
00630 MachineState_DeletingSnapshot = 20,
00637 MachineState_SettingUp = 21,
00644 MachineState_FirstOnline = 5,
00651 MachineState_LastOnline = 18,
00658 MachineState_FirstTransient = 8,
00665 MachineState_LastTransient = 21,
00666 };
00667
00677 enum SessionState
00678 {
00683 SessionState_Null = 0,
00694 SessionState_Unlocked = 1,
00708 SessionState_Locked = 2,
00718 SessionState_Spawning = 3,
00725 SessionState_Unlocking = 4,
00726 };
00727
00736 enum CPUPropertyType
00737 {
00742 CPUPropertyType_Null = 0,
00751 CPUPropertyType_PAE = 1,
00759 CPUPropertyType_Synthetic = 2,
00767 CPUPropertyType_LongMode = 3,
00768 };
00769
00779 enum HWVirtExPropertyType
00780 {
00785 HWVirtExPropertyType_Null = 0,
00793 HWVirtExPropertyType_Enabled = 1,
00802 HWVirtExPropertyType_Exclusive = 2,
00809 HWVirtExPropertyType_VPID = 3,
00816 HWVirtExPropertyType_NestedPaging = 4,
00823 HWVirtExPropertyType_UnrestrictedExecution = 5,
00830 HWVirtExPropertyType_LargePages = 6,
00838 HWVirtExPropertyType_Force = 7,
00839 };
00840
00848 enum FaultToleranceState
00849 {
00854 FaultToleranceState_Inactive = 1,
00859 FaultToleranceState_Master = 2,
00864 FaultToleranceState_Standby = 3,
00865 };
00866
00874 enum LockType
00875 {
00884 LockType_Write = 2,
00891 LockType_Shared = 1,
00897 LockType_VM = 3,
00898 };
00899
00908 enum SessionType
00909 {
00914 SessionType_Null = 0,
00922 SessionType_WriteLock = 1,
00929 SessionType_Remote = 2,
00936 SessionType_Shared = 3,
00937 };
00938
00946 enum DeviceType
00947 {
00955 DeviceType_Null = 0,
00960 DeviceType_Floppy = 1,
00965 DeviceType_DVD = 2,
00970 DeviceType_HardDisk = 3,
00975 DeviceType_Network = 4,
00980 DeviceType_USB = 5,
00985 DeviceType_SharedFolder = 6,
00986 };
00987
00995 enum DeviceActivity
00996 {
00997 DeviceActivity_Null = 0,
00998 DeviceActivity_Idle = 1,
00999 DeviceActivity_Reading = 2,
01000 DeviceActivity_Writing = 3,
01001 };
01002
01010 enum ClipboardMode
01011 {
01012 ClipboardMode_Disabled = 0,
01013 ClipboardMode_HostToGuest = 1,
01014 ClipboardMode_GuestToHost = 2,
01015 ClipboardMode_Bidirectional = 3,
01016 };
01017
01025 enum DragAndDropMode
01026 {
01027 DragAndDropMode_Disabled = 0,
01028 DragAndDropMode_HostToGuest = 1,
01029 DragAndDropMode_GuestToHost = 2,
01030 DragAndDropMode_Bidirectional = 3,
01031 };
01032
01043 enum Scope
01044 {
01045 Scope_Global = 0,
01046 Scope_Machine = 1,
01047 Scope_Session = 2,
01048 };
01049
01057 enum BIOSBootMenuMode
01058 {
01059 BIOSBootMenuMode_Disabled = 0,
01060 BIOSBootMenuMode_MenuOnly = 1,
01061 BIOSBootMenuMode_MessageAndMenu = 2,
01062 };
01063
01071 enum ProcessorFeature
01072 {
01073 ProcessorFeature_HWVirtEx = 0,
01074 ProcessorFeature_PAE = 1,
01075 ProcessorFeature_LongMode = 2,
01076 ProcessorFeature_NestedPaging = 3,
01077 };
01078
01086 enum FirmwareType
01087 {
01092 FirmwareType_BIOS = 1,
01097 FirmwareType_EFI = 2,
01102 FirmwareType_EFI32 = 3,
01107 FirmwareType_EFI64 = 4,
01112 FirmwareType_EFIDUAL = 5,
01113 };
01114
01122 enum PointingHIDType
01123 {
01128 PointingHIDType_None = 1,
01133 PointingHIDType_PS2Mouse = 2,
01138 PointingHIDType_USBMouse = 3,
01146 PointingHIDType_USBTablet = 4,
01154 PointingHIDType_ComboMouse = 5,
01161 PointingHIDType_USBMultiTouch = 6,
01162 };
01163
01171 enum KeyboardHIDType
01172 {
01177 KeyboardHIDType_None = 1,
01182 KeyboardHIDType_PS2Keyboard = 2,
01187 KeyboardHIDType_USBKeyboard = 3,
01193 KeyboardHIDType_ComboKeyboard = 4,
01194 };
01195
01196 enum DhcpOpt
01197 {
01198 DhcpOpt_SubnetMask = 1,
01199 DhcpOpt_TimeOffset = 2,
01200 DhcpOpt_Router = 3,
01201 DhcpOpt_TimeServer = 4,
01202 DhcpOpt_NameServer = 5,
01203 DhcpOpt_DomainNameServer = 6,
01204 DhcpOpt_LogServer = 7,
01205 DhcpOpt_Cookie = 8,
01206 DhcpOpt_LPRServer = 9,
01207 DhcpOpt_ImpressServer = 10,
01208 DhcpOpt_ResourseLocationServer = 11,
01209 DhcpOpt_HostName = 12,
01210 DhcpOpt_BootFileSize = 13,
01211 DhcpOpt_MeritDumpFile = 14,
01212 DhcpOpt_DomainName = 15,
01213 DhcpOpt_SwapServer = 16,
01214 DhcpOpt_RootPath = 17,
01215 DhcpOpt_ExtensionPath = 18,
01216 DhcpOpt_IPForwardingEnableDisable = 19,
01217 DhcpOpt_NonLocalSourceRoutingEnableDisable = 20,
01218 DhcpOpt_PolicyFilter = 21,
01219 DhcpOpt_MaximumDatagramReassemblySize = 22,
01220 DhcpOpt_DefaultIPTime2Live = 23,
01221 DhcpOpt_PathMTUAgingTimeout = 24,
01222 DhcpOpt_IPLayerParametersPerInterface = 25,
01223 DhcpOpt_InterfaceMTU = 26,
01224 DhcpOpt_AllSubnetsAreLocal = 27,
01225 DhcpOpt_BroadcastAddress = 28,
01226 DhcpOpt_PerformMaskDiscovery = 29,
01227 DhcpOpt_MaskSupplier = 30,
01228 DhcpOpt_PerformRouteDiscovery = 31,
01229 DhcpOpt_RouterSolicitationAddress = 32,
01230 DhcpOpt_StaticRoute = 33,
01231 DhcpOpt_TrailerEncapsulation = 34,
01232 DhcpOpt_ARPCacheTimeout = 35,
01233 DhcpOpt_EthernetEncapsulation = 36,
01234 DhcpOpt_TCPDefaultTTL = 37,
01235 DhcpOpt_TCPKeepAliveInterval = 38,
01236 DhcpOpt_TCPKeepAliveGarbage = 39,
01237 DhcpOpt_NetworkInformationServiceDomain = 40,
01238 DhcpOpt_NetworkInformationServiceServers = 41,
01239 DhcpOpt_NetworkTimeProtocolServers = 42,
01240 DhcpOpt_VendorSpecificInformation = 43,
01241 DhcpOpt_Option_44 = 44,
01242 DhcpOpt_Option_45 = 45,
01243 DhcpOpt_Option_46 = 46,
01244 DhcpOpt_Option_47 = 47,
01245 DhcpOpt_Option_48 = 48,
01246 DhcpOpt_Option_49 = 49,
01247 DhcpOpt_IPAddressLeaseTime = 51,
01248 DhcpOpt_Option_64 = 64,
01249 DhcpOpt_Option_65 = 65,
01250 DhcpOpt_TFTPServerName = 66,
01251 DhcpOpt_BootfileName = 67,
01252 DhcpOpt_Option_68 = 68,
01253 DhcpOpt_Option_69 = 69,
01254 DhcpOpt_Option_70 = 70,
01255 DhcpOpt_Option_71 = 71,
01256 DhcpOpt_Option_72 = 72,
01257 DhcpOpt_Option_73 = 73,
01258 DhcpOpt_Option_74 = 74,
01259 DhcpOpt_Option_75 = 75,
01260 DhcpOpt_Option_119 = 119,
01261 };
01262
01270 enum VFSType
01271 {
01272 VFSType_File = 1,
01273 VFSType_Cloud = 2,
01274 VFSType_S3 = 3,
01275 VFSType_WebDav = 4,
01276 };
01277
01285 enum VFSFileType
01286 {
01287 VFSFileType_Unknown = 1,
01288 VFSFileType_Fifo = 2,
01289 VFSFileType_DevChar = 3,
01290 VFSFileType_Directory = 4,
01291 VFSFileType_DevBlock = 5,
01292 VFSFileType_File = 6,
01293 VFSFileType_SymLink = 7,
01294 VFSFileType_Socket = 8,
01295 VFSFileType_WhiteOut = 9,
01296 };
01297
01305 enum ImportOptions
01306 {
01311 ImportOptions_KeepAllMACs = 1,
01316 ImportOptions_KeepNATMACs = 2,
01317 };
01318
01325 enum VirtualSystemDescriptionType
01326 {
01327 VirtualSystemDescriptionType_Ignore = 1,
01328 VirtualSystemDescriptionType_OS = 2,
01329 VirtualSystemDescriptionType_Name = 3,
01330 VirtualSystemDescriptionType_Product = 4,
01331 VirtualSystemDescriptionType_Vendor = 5,
01332 VirtualSystemDescriptionType_Version = 6,
01333 VirtualSystemDescriptionType_ProductUrl = 7,
01334 VirtualSystemDescriptionType_VendorUrl = 8,
01335 VirtualSystemDescriptionType_Description = 9,
01336 VirtualSystemDescriptionType_License = 10,
01337 VirtualSystemDescriptionType_Miscellaneous = 11,
01338 VirtualSystemDescriptionType_CPU = 12,
01339 VirtualSystemDescriptionType_Memory = 13,
01340 VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
01341 VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
01342 VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
01343 VirtualSystemDescriptionType_HardDiskControllerSAS = 17,
01344 VirtualSystemDescriptionType_HardDiskImage = 18,
01345 VirtualSystemDescriptionType_Floppy = 19,
01346 VirtualSystemDescriptionType_CDROM = 20,
01347 VirtualSystemDescriptionType_NetworkAdapter = 21,
01348 VirtualSystemDescriptionType_USBController = 22,
01349 VirtualSystemDescriptionType_SoundCard = 23,
01354 VirtualSystemDescriptionType_SettingsFile = 24,
01355 };
01356
01363 enum VirtualSystemDescriptionValueType
01364 {
01365 VirtualSystemDescriptionValueType_Reference = 1,
01366 VirtualSystemDescriptionValueType_Original = 2,
01367 VirtualSystemDescriptionValueType_Auto = 3,
01368 VirtualSystemDescriptionValueType_ExtraConfig = 4,
01369 };
01370
01377 enum GraphicsControllerType
01378 {
01383 GraphicsControllerType_Null = 0,
01388 GraphicsControllerType_VBoxVGA = 1,
01389 };
01390
01397 enum CleanupMode
01398 {
01403 CleanupMode_UnregisterOnly = 1,
01408 CleanupMode_DetachAllReturnNone = 2,
01413 CleanupMode_DetachAllReturnHardDisksOnly = 3,
01418 CleanupMode_Full = 4,
01419 };
01420
01428 enum CloneMode
01429 {
01434 CloneMode_MachineState = 1,
01439 CloneMode_MachineAndChildStates = 2,
01444 CloneMode_AllStates = 3,
01445 };
01446
01454 enum CloneOptions
01455 {
01460 CloneOptions_Link = 1,
01465 CloneOptions_KeepAllMACs = 2,
01470 CloneOptions_KeepNATMACs = 3,
01475 CloneOptions_KeepDiskNames = 4,
01476 };
01477
01485 enum AutostopType
01486 {
01491 AutostopType_Disabled = 1,
01496 AutostopType_SaveState = 2,
01501 AutostopType_PowerOff = 3,
01506 AutostopType_AcpiShutdown = 4,
01507 };
01508
01519 enum HostNetworkInterfaceMediumType
01520 {
01527 HostNetworkInterfaceMediumType_Unknown = 0,
01534 HostNetworkInterfaceMediumType_Ethernet = 1,
01541 HostNetworkInterfaceMediumType_PPP = 2,
01548 HostNetworkInterfaceMediumType_SLIP = 3,
01549 };
01550
01560 enum HostNetworkInterfaceStatus
01561 {
01568 HostNetworkInterfaceStatus_Unknown = 0,
01575 HostNetworkInterfaceStatus_Up = 1,
01582 HostNetworkInterfaceStatus_Down = 2,
01583 };
01584
01592 enum HostNetworkInterfaceType
01593 {
01594 HostNetworkInterfaceType_Bridged = 1,
01595 HostNetworkInterfaceType_HostOnly = 2,
01596 };
01597
01605 enum AdditionsFacilityType
01606 {
01611 AdditionsFacilityType_None = 0,
01616 AdditionsFacilityType_VBoxGuestDriver = 20,
01621 AdditionsFacilityType_AutoLogon = 90,
01626 AdditionsFacilityType_VBoxService = 100,
01631 AdditionsFacilityType_VBoxTrayClient = 101,
01636 AdditionsFacilityType_Seamless = 1000,
01644 AdditionsFacilityType_Graphics = 1100,
01649 AdditionsFacilityType_All = 2147483646,
01650 };
01651
01659 enum AdditionsFacilityClass
01660 {
01665 AdditionsFacilityClass_None = 0,
01670 AdditionsFacilityClass_Driver = 10,
01675 AdditionsFacilityClass_Service = 30,
01680 AdditionsFacilityClass_Program = 50,
01685 AdditionsFacilityClass_Feature = 100,
01690 AdditionsFacilityClass_ThirdParty = 999,
01695 AdditionsFacilityClass_All = 2147483646,
01696 };
01697
01705 enum AdditionsFacilityStatus
01706 {
01711 AdditionsFacilityStatus_Inactive = 0,
01716 AdditionsFacilityStatus_Paused = 1,
01721 AdditionsFacilityStatus_PreInit = 20,
01726 AdditionsFacilityStatus_Init = 30,
01731 AdditionsFacilityStatus_Active = 50,
01736 AdditionsFacilityStatus_Terminating = 100,
01741 AdditionsFacilityStatus_Terminated = 101,
01746 AdditionsFacilityStatus_Failed = 800,
01751 AdditionsFacilityStatus_Unknown = 999,
01752 };
01753
01761 enum AdditionsRunLevelType
01762 {
01767 AdditionsRunLevelType_None = 0,
01772 AdditionsRunLevelType_System = 1,
01777 AdditionsRunLevelType_Userland = 2,
01782 AdditionsRunLevelType_Desktop = 3,
01783 };
01784
01792 enum AdditionsUpdateFlag
01793 {
01798 AdditionsUpdateFlag_None = 0,
01806 AdditionsUpdateFlag_WaitForUpdateStartOnly = 1,
01807 };
01808
01817 enum GuestSessionStatus
01818 {
01823 GuestSessionStatus_Undefined = 0,
01828 GuestSessionStatus_Starting = 10,
01833 GuestSessionStatus_Started = 100,
01838 GuestSessionStatus_Terminating = 480,
01843 GuestSessionStatus_Terminated = 500,
01848 GuestSessionStatus_TimedOutKilled = 512,
01853 GuestSessionStatus_TimedOutAbnormally = 513,
01858 GuestSessionStatus_Down = 600,
01863 GuestSessionStatus_Error = 800,
01864 };
01865
01873 enum GuestSessionWaitForFlag
01874 {
01879 GuestSessionWaitForFlag_None = 0,
01884 GuestSessionWaitForFlag_Start = 1,
01889 GuestSessionWaitForFlag_Terminate = 2,
01894 GuestSessionWaitForFlag_Status = 4,
01895 };
01896
01910 enum GuestSessionWaitResult
01911 {
01916 GuestSessionWaitResult_None = 0,
01921 GuestSessionWaitResult_Start = 1,
01926 GuestSessionWaitResult_Terminate = 2,
01934 GuestSessionWaitResult_Status = 3,
01939 GuestSessionWaitResult_Error = 4,
01948 GuestSessionWaitResult_Timeout = 5,
01956 GuestSessionWaitResult_WaitFlagNotSupported = 6,
01957 };
01958
01966 enum GuestUserState
01967 {
01972 GuestUserState_Unknown = 0,
01981 GuestUserState_LoggedIn = 1,
01990 GuestUserState_LoggedOut = 2,
02000 GuestUserState_Locked = 3,
02008 GuestUserState_Unlocked = 4,
02016 GuestUserState_Disabled = 5,
02038 GuestUserState_Idle = 6,
02044 GuestUserState_InUse = 7,
02052 GuestUserState_Created = 8,
02060 GuestUserState_Deleted = 9,
02068 GuestUserState_SessionChanged = 10,
02078 GuestUserState_CredentialsChanged = 11,
02087 GuestUserState_RoleChanged = 12,
02096 GuestUserState_GroupAdded = 13,
02105 GuestUserState_GroupRemoved = 14,
02114 GuestUserState_Elevated = 15,
02115 };
02116
02124 enum FileSeekType
02125 {
02130 FileSeekType_Set = 0,
02135 FileSeekType_Current = 1,
02136 };
02137
02145 enum ProcessInputFlag
02146 {
02151 ProcessInputFlag_None = 0,
02156 ProcessInputFlag_EndOfFile = 1,
02157 };
02158
02167 enum ProcessOutputFlag
02168 {
02173 ProcessOutputFlag_None = 0,
02178 ProcessOutputFlag_StdErr = 1,
02179 };
02180
02188 enum ProcessWaitForFlag
02189 {
02194 ProcessWaitForFlag_None = 0,
02199 ProcessWaitForFlag_Start = 1,
02204 ProcessWaitForFlag_Terminate = 2,
02209 ProcessWaitForFlag_StdIn = 4,
02214 ProcessWaitForFlag_StdOut = 8,
02219 ProcessWaitForFlag_StdErr = 16,
02220 };
02221
02240 enum ProcessWaitResult
02241 {
02246 ProcessWaitResult_None = 0,
02251 ProcessWaitResult_Start = 1,
02256 ProcessWaitResult_Terminate = 2,
02264 ProcessWaitResult_Status = 3,
02269 ProcessWaitResult_Error = 4,
02278 ProcessWaitResult_Timeout = 5,
02285 ProcessWaitResult_StdIn = 6,
02290 ProcessWaitResult_StdOut = 7,
02295 ProcessWaitResult_StdErr = 8,
02303 ProcessWaitResult_WaitFlagNotSupported = 9,
02304 };
02305
02313 enum CopyFileFlag
02314 {
02319 CopyFileFlag_None = 0,
02324 CopyFileFlag_Recursive = 1,
02329 CopyFileFlag_Update = 2,
02334 CopyFileFlag_FollowLinks = 4,
02335 };
02336
02344 enum DirectoryCreateFlag
02345 {
02350 DirectoryCreateFlag_None = 0,
02355 DirectoryCreateFlag_Parents = 1,
02356 };
02357
02365 enum DirectoryRemoveRecFlag
02366 {
02371 DirectoryRemoveRecFlag_None = 0,
02376 DirectoryRemoveRecFlag_ContentAndDir = 1,
02381 DirectoryRemoveRecFlag_ContentOnly = 2,
02382 };
02383
02391 enum PathRenameFlag
02392 {
02397 PathRenameFlag_None = 0,
02402 PathRenameFlag_NoReplace = 1,
02407 PathRenameFlag_Replace = 2,
02412 PathRenameFlag_NoSymlinks = 4,
02413 };
02414
02422 enum ProcessCreateFlag
02423 {
02428 ProcessCreateFlag_None = 0,
02434 ProcessCreateFlag_WaitForProcessStartOnly = 1,
02439 ProcessCreateFlag_IgnoreOrphanedProcesses = 2,
02444 ProcessCreateFlag_Hidden = 4,
02449 ProcessCreateFlag_NoProfile = 8,
02454 ProcessCreateFlag_WaitForStdOut = 16,
02459 ProcessCreateFlag_WaitForStdErr = 32,
02464 ProcessCreateFlag_ExpandArguments = 64,
02465 };
02466
02474 enum ProcessPriority
02475 {
02480 ProcessPriority_Invalid = 0,
02485 ProcessPriority_Default = 1,
02486 };
02487
02495 enum SymlinkType
02496 {
02501 SymlinkType_Unknown = 0,
02506 SymlinkType_Directory = 1,
02511 SymlinkType_File = 2,
02512 };
02513
02521 enum SymlinkReadFlag
02522 {
02527 SymlinkReadFlag_None = 0,
02532 SymlinkReadFlag_NoSymlinks = 1,
02533 };
02534
02542 enum ProcessStatus
02543 {
02548 ProcessStatus_Undefined = 0,
02553 ProcessStatus_Starting = 10,
02558 ProcessStatus_Started = 100,
02563 ProcessStatus_Paused = 110,
02568 ProcessStatus_Terminating = 480,
02573 ProcessStatus_TerminatedNormally = 500,
02578 ProcessStatus_TerminatedSignal = 510,
02583 ProcessStatus_TerminatedAbnormally = 511,
02588 ProcessStatus_TimedOutKilled = 512,
02593 ProcessStatus_TimedOutAbnormally = 513,
02598 ProcessStatus_Down = 600,
02603 ProcessStatus_Error = 800,
02604 };
02605
02613 enum ProcessInputStatus
02614 {
02619 ProcessInputStatus_Undefined = 0,
02624 ProcessInputStatus_Broken = 1,
02629 ProcessInputStatus_Available = 10,
02634 ProcessInputStatus_Written = 50,
02639 ProcessInputStatus_Overflow = 100,
02640 };
02641
02649 enum FileStatus
02650 {
02655 FileStatus_Undefined = 0,
02660 FileStatus_Opening = 10,
02665 FileStatus_Open = 100,
02670 FileStatus_Closing = 150,
02675 FileStatus_Closed = 200,
02680 FileStatus_Down = 600,
02685 FileStatus_Error = 800,
02686 };
02687
02695 enum FsObjType
02696 {
02701 FsObjType_Undefined = 0,
02706 FsObjType_FIFO = 1,
02711 FsObjType_DevChar = 10,
02716 FsObjType_DevBlock = 11,
02721 FsObjType_Directory = 50,
02726 FsObjType_File = 80,
02731 FsObjType_Symlink = 100,
02736 FsObjType_Socket = 200,
02741 FsObjType_Whiteout = 400,
02742 };
02743
02751 enum DragAndDropAction
02752 {
02757 DragAndDropAction_Ignore = 0,
02762 DragAndDropAction_Copy = 1,
02767 DragAndDropAction_Move = 2,
02772 DragAndDropAction_Link = 3,
02773 };
02774
02782 enum DirectoryOpenFlag
02783 {
02788 DirectoryOpenFlag_None = 0,
02793 DirectoryOpenFlag_NoSymlinks = 1,
02794 };
02795
02805 enum MediumState
02806 {
02814 MediumState_NotCreated = 0,
02823 MediumState_Created = 1,
02831 MediumState_LockedRead = 2,
02839 MediumState_LockedWrite = 3,
02849 MediumState_Inaccessible = 4,
02856 MediumState_Creating = 5,
02863 MediumState_Deleting = 6,
02864 };
02865
02876 enum MediumType
02877 {
02885 MediumType_Normal = 0,
02893 MediumType_Immutable = 1,
02901 MediumType_Writethrough = 2,
02910 MediumType_Shareable = 3,
02919 MediumType_Readonly = 4,
02931 MediumType_MultiAttach = 5,
02932 };
02933
02943 enum MediumVariant
02944 {
02951 MediumVariant_Standard = 0,
02958 MediumVariant_VmdkSplit2G = 0x01,
02965 MediumVariant_VmdkRawDisk = 0x02,
02973 MediumVariant_VmdkStreamOptimized = 0x04,
02980 MediumVariant_VmdkESX = 0x08,
02987 MediumVariant_Fixed = 0x10000,
02994 MediumVariant_Diff = 0x20000,
03002 MediumVariant_NoCreateDir = 0x40000000,
03003 };
03004
03005 enum DataType
03006 {
03007 DataType_Int32 = 0,
03008 DataType_Int8 = 1,
03009 DataType_String = 2,
03010 };
03011
03012 enum DataFlags
03013 {
03014 DataFlags_None = 0x00,
03015 DataFlags_Mandatory = 0x01,
03016 DataFlags_Expert = 0x02,
03017 DataFlags_Array = 0x04,
03018 DataFlags_FlagMask = 0x07,
03019 };
03020
03028 enum MediumFormatCapabilities
03029 {
03036 MediumFormatCapabilities_Uuid = 0x01,
03043 MediumFormatCapabilities_CreateFixed = 0x02,
03051 MediumFormatCapabilities_CreateDynamic = 0x04,
03058 MediumFormatCapabilities_CreateSplit2G = 0x08,
03065 MediumFormatCapabilities_Differencing = 0x10,
03072 MediumFormatCapabilities_Asynchronous = 0x20,
03082 MediumFormatCapabilities_File = 0x40,
03091 MediumFormatCapabilities_Properties = 0x80,
03098 MediumFormatCapabilities_TcpNetworking = 0x100,
03105 MediumFormatCapabilities_VFS = 0x200,
03106 MediumFormatCapabilities_CapabilityMask = 0x3FF,
03107 };
03108
03116 enum MouseButtonState
03117 {
03118 MouseButtonState_LeftButton = 0x01,
03119 MouseButtonState_RightButton = 0x02,
03120 MouseButtonState_MiddleButton = 0x04,
03121 MouseButtonState_WheelUp = 0x08,
03122 MouseButtonState_WheelDown = 0x10,
03123 MouseButtonState_XButton1 = 0x20,
03124 MouseButtonState_XButton2 = 0x40,
03125 MouseButtonState_MouseStateMask = 0x7F,
03126 };
03127
03135 enum TouchContactState
03136 {
03141 TouchContactState_None = 0x00,
03146 TouchContactState_InContact = 0x01,
03153 TouchContactState_InRange = 0x02,
03154 TouchContactState_ContactStateMask = 0x03,
03155 };
03156
03167 enum FramebufferPixelFormat
03168 {
03176 FramebufferPixelFormat_Opaque = 0,
03184 FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
03185 };
03186
03194 enum NetworkAttachmentType
03195 {
03200 NetworkAttachmentType_Null = 0,
03201 NetworkAttachmentType_NAT = 1,
03202 NetworkAttachmentType_Bridged = 2,
03203 NetworkAttachmentType_Internal = 3,
03204 NetworkAttachmentType_HostOnly = 4,
03205 NetworkAttachmentType_Generic = 5,
03206 };
03207
03215 enum NetworkAdapterType
03216 {
03221 NetworkAdapterType_Null = 0,
03226 NetworkAdapterType_Am79C970A = 1,
03231 NetworkAdapterType_Am79C973 = 2,
03236 NetworkAdapterType_I82540EM = 3,
03241 NetworkAdapterType_I82543GC = 4,
03246 NetworkAdapterType_I82545EM = 5,
03251 NetworkAdapterType_Virtio = 6,
03252 };
03253
03261 enum NetworkAdapterPromiscModePolicy
03262 {
03267 NetworkAdapterPromiscModePolicy_Deny = 1,
03275 NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
03283 NetworkAdapterPromiscModePolicy_AllowAll = 3,
03284 };
03285
03294 enum PortMode
03295 {
03300 PortMode_Disconnected = 0,
03305 PortMode_HostPipe = 1,
03310 PortMode_HostDevice = 2,
03315 PortMode_RawFile = 3,
03316 };
03317
03325 enum USBControllerType
03326 {
03331 USBControllerType_Null = 0,
03332 USBControllerType_OHCI = 1,
03333 USBControllerType_EHCI = 2,
03338 USBControllerType_Last = 3,
03339 };
03340
03379 enum USBDeviceState
03380 {
03387 USBDeviceState_NotSupported = 0,
03395 USBDeviceState_Unavailable = 1,
03402 USBDeviceState_Busy = 2,
03410 USBDeviceState_Available = 3,
03418 USBDeviceState_Held = 4,
03426 USBDeviceState_Captured = 5,
03427 };
03428
03438 enum USBDeviceFilterAction
03439 {
03444 USBDeviceFilterAction_Null = 0,
03449 USBDeviceFilterAction_Ignore = 1,
03454 USBDeviceFilterAction_Hold = 2,
03455 };
03456
03464 enum AudioDriverType
03465 {
03470 AudioDriverType_Null = 0,
03475 AudioDriverType_WinMM = 1,
03480 AudioDriverType_OSS = 2,
03485 AudioDriverType_ALSA = 3,
03490 AudioDriverType_DirectSound = 4,
03495 AudioDriverType_CoreAudio = 5,
03500 AudioDriverType_MMPM = 6,
03505 AudioDriverType_Pulse = 7,
03510 AudioDriverType_SolAudio = 8,
03511 };
03512
03520 enum AudioControllerType
03521 {
03522 AudioControllerType_AC97 = 0,
03523 AudioControllerType_SB16 = 1,
03524 AudioControllerType_HDA = 2,
03525 };
03526
03534 enum AuthType
03535 {
03540 AuthType_Null = 0,
03541 AuthType_External = 1,
03542 AuthType_Guest = 2,
03543 };
03544
03552 enum Reason
03553 {
03558 Reason_Unspecified = 0,
03563 Reason_HostSuspend = 1,
03568 Reason_HostResume = 2,
03573 Reason_HostBatteryLow = 3,
03574 };
03575
03584 enum StorageBus
03585 {
03590 StorageBus_Null = 0,
03591 StorageBus_IDE = 1,
03592 StorageBus_SATA = 2,
03593 StorageBus_SCSI = 3,
03594 StorageBus_Floppy = 4,
03595 StorageBus_SAS = 5,
03596 };
03597
03606 enum StorageControllerType
03607 {
03612 StorageControllerType_Null = 0,
03617 StorageControllerType_LsiLogic = 1,
03622 StorageControllerType_BusLogic = 2,
03627 StorageControllerType_IntelAhci = 3,
03632 StorageControllerType_PIIX3 = 4,
03637 StorageControllerType_PIIX4 = 5,
03642 StorageControllerType_ICH6 = 6,
03647 StorageControllerType_I82078 = 7,
03652 StorageControllerType_LsiLogicSas = 8,
03653 };
03654
03662 enum ChipsetType
03663 {
03668 ChipsetType_Null = 0,
03673 ChipsetType_PIIX3 = 1,
03678 ChipsetType_ICH9 = 2,
03679 };
03680
03686 enum NATAliasMode
03687 {
03692 NATAliasMode_AliasLog = 0x1,
03697 NATAliasMode_AliasProxyOnly = 0x02,
03702 NATAliasMode_AliasUseSamePorts = 0x04,
03703 };
03704
03710 enum NATProtocol
03711 {
03716 NATProtocol_UDP = 0,
03721 NATProtocol_TCP = 1,
03722 };
03723
03731 enum BandwidthGroupType
03732 {
03739 BandwidthGroupType_Null = 0,
03746 BandwidthGroupType_Disk = 1,
03753 BandwidthGroupType_Network = 2,
03754 };
03755
03764 enum VBoxEventType
03765 {
03772 VBoxEventType_Invalid = 0,
03781 VBoxEventType_Any = 1,
03789 VBoxEventType_Vetoable = 2,
03797 VBoxEventType_MachineEvent = 3,
03805 VBoxEventType_SnapshotEvent = 4,
03814 VBoxEventType_InputEvent = 5,
03821 VBoxEventType_LastWildcard = 31,
03828 VBoxEventType_OnMachineStateChanged = 32,
03835 VBoxEventType_OnMachineDataChanged = 33,
03842 VBoxEventType_OnExtraDataChanged = 34,
03849 VBoxEventType_OnExtraDataCanChange = 35,
03856 VBoxEventType_OnMediumRegistered = 36,
03863 VBoxEventType_OnMachineRegistered = 37,
03870 VBoxEventType_OnSessionStateChanged = 38,
03877 VBoxEventType_OnSnapshotTaken = 39,
03884 VBoxEventType_OnSnapshotDeleted = 40,
03891 VBoxEventType_OnSnapshotChanged = 41,
03898 VBoxEventType_OnGuestPropertyChanged = 42,
03905 VBoxEventType_OnMousePointerShapeChanged = 43,
03912 VBoxEventType_OnMouseCapabilityChanged = 44,
03919 VBoxEventType_OnKeyboardLedsChanged = 45,
03926 VBoxEventType_OnStateChanged = 46,
03933 VBoxEventType_OnAdditionsStateChanged = 47,
03940 VBoxEventType_OnNetworkAdapterChanged = 48,
03947 VBoxEventType_OnSerialPortChanged = 49,
03954 VBoxEventType_OnParallelPortChanged = 50,
03961 VBoxEventType_OnStorageControllerChanged = 51,
03968 VBoxEventType_OnMediumChanged = 52,
03975 VBoxEventType_OnVRDEServerChanged = 53,
03982 VBoxEventType_OnUSBControllerChanged = 54,
03989 VBoxEventType_OnUSBDeviceStateChanged = 55,
03996 VBoxEventType_OnSharedFolderChanged = 56,
04003 VBoxEventType_OnRuntimeError = 57,
04010 VBoxEventType_OnCanShowWindow = 58,
04017 VBoxEventType_OnShowWindow = 59,
04024 VBoxEventType_OnCPUChanged = 60,
04031 VBoxEventType_OnVRDEServerInfoChanged = 61,
04038 VBoxEventType_OnEventSourceChanged = 62,
04045 VBoxEventType_OnCPUExecutionCapChanged = 63,
04052 VBoxEventType_OnGuestKeyboard = 64,
04059 VBoxEventType_OnGuestMouse = 65,
04066 VBoxEventType_OnNATRedirect = 66,
04073 VBoxEventType_OnHostPCIDevicePlug = 67,
04080 VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
04087 VBoxEventType_OnBandwidthGroupChanged = 69,
04094 VBoxEventType_OnGuestMonitorChanged = 70,
04101 VBoxEventType_OnStorageDeviceChanged = 71,
04108 VBoxEventType_OnClipboardModeChanged = 72,
04115 VBoxEventType_OnDragAndDropModeChanged = 73,
04122 VBoxEventType_OnNATNetworkChanged = 74,
04129 VBoxEventType_OnNATNetworkStartStop = 75,
04136 VBoxEventType_OnNATNetworkAlter = 76,
04143 VBoxEventType_OnNATNetworkCreationDeletion = 77,
04150 VBoxEventType_OnNATNetworkSetting = 78,
04157 VBoxEventType_OnNATNetworkPortForward = 79,
04164 VBoxEventType_OnGuestSessionStateChanged = 80,
04171 VBoxEventType_OnGuestSessionRegistered = 81,
04178 VBoxEventType_OnGuestProcessRegistered = 82,
04185 VBoxEventType_OnGuestProcessStateChanged = 83,
04192 VBoxEventType_OnGuestProcessInputNotify = 84,
04199 VBoxEventType_OnGuestProcessOutput = 85,
04206 VBoxEventType_OnGuestFileRegistered = 86,
04213 VBoxEventType_OnGuestFileStateChanged = 87,
04220 VBoxEventType_OnGuestFileOffsetChanged = 88,
04228 VBoxEventType_OnGuestFileRead = 89,
04236 VBoxEventType_OnGuestFileWrite = 90,
04243 VBoxEventType_OnVideoCaptureChanged = 91,
04250 VBoxEventType_OnGuestUserStateChanged = 92,
04257 VBoxEventType_OnGuestMultiTouch = 93,
04264 VBoxEventType_Last = 94,
04265 };
04266
04278 enum GuestMouseEventMode
04279 {
04286 GuestMouseEventMode_Relative = 0,
04293 GuestMouseEventMode_Absolute = 1,
04294 };
04295
04303 enum GuestMonitorChangedEventType
04304 {
04311 GuestMonitorChangedEventType_Enabled = 0,
04318 GuestMonitorChangedEventType_Disabled = 1,
04325 GuestMonitorChangedEventType_NewOrigin = 2,
04326 };
04327
04361 interface IVirtualBoxErrorInfo : $errorinfo
04362 {
04380 readonly attribute long resultCode;
04381
04388 readonly attribute long resultDetail;
04389
04401 readonly attribute wstringUUID interfaceID;
04402
04413 readonly attribute wstring component;
04414
04425 readonly attribute wstring text;
04426
04437 readonly attribute IVirtualBoxErrorInfo next;
04438
04439 };
04440
04441 interface INATNetwork : $unknown
04442 {
04451 attribute wstring networkName;
04452
04453 attribute boolean enabled;
04454
04463 attribute wstring network;
04464
04471 readonly attribute wstring gateway;
04472
04478 attribute boolean IPv6Enabled;
04479
04487 attribute wstring IPv6Prefix;
04488
04489 attribute boolean advertiseDefaultIPv6RouteEnabled;
04490
04491 attribute boolean needDhcpServer;
04492
04493 readonly attribute IEventSource eventSource;
04494
04501 readonly attribute wstring[] portForwardRules4;
04502
04507 readonly attribute wstring[] localMappings;
04508
04513 attribute long loopbackIp6;
04514
04520 readonly attribute wstring[] portForwardRules6;
04521
04525 void addLocalMapping (
04526 in wstring hostid,
04527 in long offset
04528 );
04529
04530 void addPortForwardRule (
04531 in boolean isIpv6,
04532 in wstring ruleName,
04533 in NATProtocol proto,
04534 in wstring hostIP,
04535 in unsigned short hostPort,
04536 in wstring guestIP,
04537 in unsigned short guestPort
04538 );
04539
04540 void removePortForwardRule (
04541 in boolean iSipv6,
04542 in wstring ruleName
04543 );
04544
04545 void start (
04546 in wstring trunkType
04547 );
04548
04549 void stop();
04550
04551 };
04552
04563 interface IDHCPServer : $unknown
04564 {
04565 readonly attribute IEventSource eventSource;
04566
04572 attribute boolean enabled;
04573
04579 readonly attribute wstring IPAddress;
04580
04586 readonly attribute wstring networkMask;
04587
04593 readonly attribute wstring networkName;
04594
04600 readonly attribute wstring lowerIP;
04601
04607 readonly attribute wstring upperIP;
04608
04609 readonly attribute wstring[] globalOptions;
04610
04611 readonly attribute wstring[] vmConfigs;
04612
04613 void addGlobalOption (
04614 in DhcpOpt option,
04615 in wstring value
04616 );
04617
04618 void addVmSlotOption (
04619 in wstring vmname,
04620 in long slot,
04621 in DhcpOpt option,
04622 in wstring value
04623 );
04624
04625 void removeVmSlotOptions (
04626 in wstring vmname,
04627 in long slot
04628 );
04629
04630 void getVmSlotOptions (
04631 in wstring vmname,
04632 in long slot,
04633 [retval] out wstring[] option
04634 );
04635
04636 void getMacOptions (
04637 in wstring mac,
04638 [retval] out wstring[] option
04639 );
04640
04669 void setConfiguration (
04670 in wstring IPAddress,
04671 in wstring networkMask,
04672 in wstring FromIPAddress,
04673 in wstring ToIPAddress
04674 );
04675
04700 void start (
04701 in wstring networkName,
04702 in wstring trunkName,
04703 in wstring trunkType
04704 );
04705
04718 void stop();
04719
04720 };
04721
04740 interface IVirtualBox : $unknown
04741 {
04754 readonly attribute wstring version;
04755
04763 readonly attribute wstring versionNormalized;
04764
04770 readonly attribute unsigned long revision;
04771
04781 readonly attribute wstring packageType;
04782
04794 readonly attribute wstring APIVersion;
04795
04811 readonly attribute wstring homeFolder;
04812
04820 readonly attribute wstring settingsFilePath;
04821
04825 readonly attribute IHost host;
04826
04830 readonly attribute ISystemProperties systemProperties;
04831
04837 readonly attribute IMachine[] machines;
04838
04848 readonly attribute wstring[] machineGroups;
04849
04859 readonly attribute IMedium[] hardDisks;
04860
04866 readonly attribute IMedium[] DVDImages;
04867
04873 readonly attribute IMedium[] floppyImages;
04874
04875 readonly attribute IProgress[] progressOperations;
04876
04877 readonly attribute IGuestOSType[] guestOSTypes;
04878
04895 readonly attribute ISharedFolder[] sharedFolders;
04896
04902 readonly attribute IPerformanceCollector performanceCollector;
04903
04909 readonly attribute IDHCPServer[] DHCPServers;
04910
04911 readonly attribute INATNetwork[] NATNetworks;
04912
04918 readonly attribute IEventSource eventSource;
04919
04925 readonly attribute IExtPackManager extensionPackManager;
04926
04932 readonly attribute wstring[] internalNetworks;
04933
04939 readonly attribute wstring[] genericNetworkDrivers;
04940
04991 void composeMachineFilename (
04992 in wstring name,
04993 in wstring group,
04994 in wstring createFlags,
04995 in wstring baseFolder,
04996 [retval] out wstring file
04997 );
04998
05105 void createMachine (
05106 in wstring settingsFile,
05107 in wstring name,
05108 in wstring[] groups,
05109 in wstring osTypeId,
05110 in wstring flags,
05111 [retval] out IMachine machine
05112 );
05113
05144 void openMachine (
05145 in wstring settingsFile,
05146 [retval] out IMachine machine
05147 );
05148
05180 void registerMachine (
05181 in IMachine machine
05182 );
05183
05204 void findMachine (
05205 in wstring nameOrId,
05206 [retval] out IMachine machine
05207 );
05208
05220 void getMachinesByGroups (
05221 in wstring[] groups,
05222 [retval] out IMachine[] machines
05223 );
05224
05234 void getMachineStates (
05235 in IMachine[] machines,
05236 [retval] out MachineState[] states
05237 );
05238
05248 void createAppliance (
05249 [retval] out IAppliance appliance
05250 );
05251
05314 void createHardDisk (
05315 in wstring format,
05316 in wstring location,
05317 [retval] out IMedium medium
05318 );
05319
05425 void openMedium (
05426 in wstring location,
05427 in DeviceType deviceType,
05428 in AccessMode accessMode,
05429 in boolean forceNewUuid,
05430 [retval] out IMedium medium
05431 );
05432
05461 void getGuestOSType (
05462 in wstringUUID id,
05463 [retval] out IGuestOSType type
05464 );
05465
05488 void createSharedFolder (
05489 in wstring name,
05490 in wstring hostPath,
05491 in boolean writable,
05492 in boolean automount
05493 );
05494
05509 void removeSharedFolder (
05510 in wstring name
05511 );
05512
05521 void getExtraDataKeys (
05522 [retval] out wstring[] keys
05523 );
05524
05553 void getExtraData (
05554 in wstring key,
05555 [retval] out wstring value
05556 );
05557
05607 void setExtraData (
05608 in wstring key,
05609 in wstring value
05610 );
05611
05630 void setSettingsSecret (
05631 in wstring password
05632 );
05633
05650 void createDHCPServer (
05651 in wstring name,
05652 [retval] out IDHCPServer server
05653 );
05654
05671 void findDHCPServerByNetworkName (
05672 in wstring name,
05673 [retval] out IDHCPServer server
05674 );
05675
05690 void removeDHCPServer (
05691 in IDHCPServer server
05692 );
05693
05694 void createNATNetwork (
05695 in wstring networkName,
05696 [retval] out INATNetwork network
05697 );
05698
05699 void findNATNetworkByName (
05700 in wstring networkName,
05701 [retval] out INATNetwork network
05702 );
05703
05704 void removeNATNetwork (
05705 in INATNetwork network
05706 );
05707
05732 void checkFirmwarePresent (
05733 in FirmwareType firmwareType,
05734 in wstring version,
05735 out wstring url,
05736 out wstring file,
05737 [retval] out boolean result
05738 );
05739
05740 };
05741
05752 interface IVFSExplorer : $unknown
05753 {
05757 readonly attribute wstring path;
05758
05762 readonly attribute VFSType type;
05763
05771 void update (
05772 [retval] out IProgress progress
05773 );
05774
05782 void cd (
05783 in wstring dir,
05784 [retval] out IProgress progress
05785 );
05786
05792 void cdUp (
05793 [retval] out IProgress progress
05794 );
05795
05808 void entryList (
05809 out wstring[] names,
05810 out unsigned long[] types,
05811 out long long[] sizes,
05812 out unsigned long[] modes
05813 );
05814
05823 void exists (
05824 in wstring[] names,
05825 [retval] out wstring[] exists
05826 );
05827
05835 void remove (
05836 in wstring[] names,
05837 [retval] out IProgress progress
05838 );
05839
05840 };
05841
05907 interface IAppliance : $unknown
05908 {
05916 readonly attribute wstring path;
05917
05948 readonly attribute wstring[] disks;
05949
05957 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
05958
05966 readonly attribute wstring[] machines;
05967
05984 void read (
05985 in wstring file,
05986 [retval] out IProgress progress
05987 );
05988
06005 void interpret();
06006
06029 void importMachines (
06030 in ImportOptions[] options,
06031 [retval] out IProgress progress
06032 );
06033
06041 void createVFSExplorer (
06042 in wstring URI,
06043 [retval] out IVFSExplorer explorer
06044 );
06045
06075 void write (
06076 in wstring format,
06077 in boolean manifest,
06078 in wstring path,
06079 [retval] out IProgress progress
06080 );
06081
06087 void getWarnings (
06088 [retval] out wstring[] warnings
06089 );
06090
06091 };
06092
06104 interface IVirtualSystemDescription : $unknown
06105 {
06109 readonly attribute unsigned long count;
06110
06234 void getDescription (
06235 out VirtualSystemDescriptionType[] types,
06236 out wstring[] refs,
06237 out wstring[] OVFValues,
06238 out wstring[] VBoxValues,
06239 out wstring[] extraConfigValues
06240 );
06241
06258 void getDescriptionByType (
06259 in VirtualSystemDescriptionType type,
06260 out VirtualSystemDescriptionType[] types,
06261 out wstring[] refs,
06262 out wstring[] OVFValues,
06263 out wstring[] VBoxValues,
06264 out wstring[] extraConfigValues
06265 );
06266
06278 void getValuesByType (
06279 in VirtualSystemDescriptionType type,
06280 in VirtualSystemDescriptionValueType which,
06281 [retval] out wstring[] values
06282 );
06283
06309 void setFinalValues (
06310 in boolean[] enabled,
06311 in wstring[] VBoxValues,
06312 in wstring[] extraConfigValues
06313 );
06314
06329 void addDescription (
06330 in VirtualSystemDescriptionType type,
06331 in wstring VBoxValue,
06332 in wstring extraConfigValue
06333 );
06334
06335 };
06336
06337 interface IInternalMachineControl : $unknown
06338 {
06345 void setRemoveSavedStateFile (
06346 in boolean remove
06347 );
06348
06360 void updateState (
06361 in MachineState state
06362 );
06363
06375 void beginPowerUp (
06376 in IProgress progress
06377 );
06378
06388 void endPowerUp (
06389 in long result
06390 );
06391
06403 void beginPoweringDown (
06404 out IProgress progress
06405 );
06406
06436 void endPoweringDown (
06437 in long result,
06438 in wstring errMsg
06439 );
06440
06454 void runUSBDeviceFilters (
06455 in IUSBDevice device,
06456 out boolean matched,
06457 out unsigned long maskedInterfaces
06458 );
06459
06468 void captureUSBDevice (
06469 in wstringUUID id
06470 );
06471
06487 void detachUSBDevice (
06488 in wstringUUID id,
06489 in boolean done
06490 );
06491
06500 void autoCaptureUSBDevices();
06501
06517 void detachAllUSBDevices (
06518 in boolean done
06519 );
06520
06535 void onSessionEnd (
06536 in ISession session,
06537 [retval] out IProgress progress
06538 );
06539
06555 void beginSavingState (
06556 out IProgress progress,
06557 out wstring stateFilePath
06558 );
06559
06589 void endSavingState (
06590 in long result,
06591 in wstring errMsg
06592 );
06593
06608 void adoptSavedState (
06609 in wstring savedStateFile
06610 );
06611
06660 void beginTakingSnapshot (
06661 in IConsole initiator,
06662 in wstring name,
06663 in wstring description,
06664 in IProgress consoleProgress,
06665 in boolean fTakingSnapshotOnline,
06666 out wstring stateFilePath
06667 );
06668
06678 void endTakingSnapshot (
06679 in boolean success
06680 );
06681
06710 void deleteSnapshot (
06711 in IConsole initiator,
06712 in wstringUUID startId,
06713 in wstringUUID endId,
06714 in boolean deleteAllChildren,
06715 out MachineState machineState,
06716 [retval] out IProgress progress
06717 );
06718
06737 void finishOnlineMergeMedium (
06738 in IMediumAttachment mediumAttachment,
06739 in IMedium source,
06740 in IMedium target,
06741 in boolean mergeForward,
06742 in IMedium parentForTarget,
06743 in IMedium[] childrenToReparent
06744 );
06745
06759 void restoreSnapshot (
06760 in IConsole initiator,
06761 in ISnapshot snapshot,
06762 out MachineState machineState,
06763 [retval] out IProgress progress
06764 );
06765
06792 void pullGuestProperties (
06793 out wstring[] names,
06794 out wstring[] values,
06795 out long long[] timestamps,
06796 out wstring[] flags
06797 );
06798
06820 void pushGuestProperty (
06821 in wstring name,
06822 in wstring value,
06823 in long long timestamp,
06824 in wstring flags
06825 );
06826
06838 void lockMedia();
06839
06849 void unlockMedia();
06850
06866 void ejectMedium (
06867 in IMediumAttachment attachment,
06868 [retval] out IMediumAttachment newAttachment
06869 );
06870
06911 void reportVmStatistics (
06912 in unsigned long validStats,
06913 in unsigned long cpuUser,
06914 in unsigned long cpuKernel,
06915 in unsigned long cpuIdle,
06916 in unsigned long memTotal,
06917 in unsigned long memFree,
06918 in unsigned long memBalloon,
06919 in unsigned long memShared,
06920 in unsigned long memCache,
06921 in unsigned long pagedTotal,
06922 in unsigned long memAllocTotal,
06923 in unsigned long memFreeTotal,
06924 in unsigned long memBalloonTotal,
06925 in unsigned long memSharedTotal,
06926 in unsigned long vmNetRx,
06927 in unsigned long vmNetTx
06928 );
06929
06930 };
06931
06940 interface IBIOSSettings : $unknown
06941 {
06945 attribute boolean logoFadeIn;
06946
06950 attribute boolean logoFadeOut;
06951
06955 attribute unsigned long logoDisplayTime;
06956
06963 attribute wstring logoImagePath;
06964
06968 attribute BIOSBootMenuMode bootMenuMode;
06969
06973 attribute boolean ACPIEnabled;
06974
06981 attribute boolean IOAPICEnabled;
06982
06992 attribute long long timeOffset;
06993
07000 attribute boolean PXEDebugEnabled;
07001
07002 };
07003
07011 interface IPCIAddress : $unknown
07012 {
07018 attribute short bus;
07019
07025 attribute short device;
07026
07032 attribute short devFunction;
07033
07039 void asLong (
07040 [retval] out long result
07041 );
07042
07048 void fromLong (
07049 in long number
07050 );
07051
07052 };
07053
07061 interface IPCIDeviceAttachment : $unknown
07062 {
07068 readonly attribute wstring name;
07069
07075 readonly attribute boolean isPhysicalDevice;
07076
07082 readonly attribute long hostAddress;
07083
07089 readonly attribute long guestAddress;
07090
07091 };
07092
07133 interface IMachine : $unknown
07134 {
07138 readonly attribute IVirtualBox parent;
07139
07143 attribute octet[] icon;
07144
07194 readonly attribute boolean accessible;
07195
07207 readonly attribute IVirtualBoxErrorInfo accessError;
07208
07248 attribute wstring name;
07249
07260 attribute wstring description;
07261
07265 readonly attribute wstringUUID id;
07266
07277 attribute wstring[] groups;
07278
07293 attribute wstring OSTypeId;
07294
07298 attribute wstring hardwareVersion;
07299
07309 attribute wstringUUID hardwareUUID;
07310
07314 attribute unsigned long CPUCount;
07315
07321 attribute boolean CPUHotPlugEnabled;
07322
07330 attribute unsigned long CPUExecutionCap;
07331
07335 attribute unsigned long memorySize;
07336
07340 attribute unsigned long memoryBalloonSize;
07341
07348 attribute boolean pageFusionEnabled;
07349
07353 attribute GraphicsControllerType graphicsControllerType;
07354
07358 attribute unsigned long VRAMSize;
07359
07365 attribute boolean accelerate3DEnabled;
07366
07372 attribute boolean accelerate2DVideoEnabled;
07373
07384 attribute unsigned long monitorCount;
07385
07391 attribute boolean videoCaptureEnabled;
07392
07398 attribute boolean[] videoCaptureScreens;
07399
07413 attribute wstring videoCaptureFile;
07414
07422 attribute unsigned long videoCaptureWidth;
07423
07431 attribute unsigned long videoCaptureHeight;
07432
07441 attribute unsigned long videoCaptureRate;
07442
07452 attribute unsigned long videoCaptureFPS;
07453
07457 readonly attribute IBIOSSettings BIOSSettings;
07458
07463 attribute FirmwareType firmwareType;
07464
07470 attribute PointingHIDType pointingHIDType;
07471
07477 attribute KeyboardHIDType keyboardHIDType;
07478
07485 attribute boolean HPETEnabled;
07486
07490 attribute ChipsetType chipsetType;
07491
07525 attribute wstring snapshotFolder;
07526
07530 readonly attribute IVRDEServer VRDEServer;
07531
07532 attribute boolean emulatedUSBWebcameraEnabled;
07533
07534 attribute boolean emulatedUSBCardReaderEnabled;
07535
07539 readonly attribute IMediumAttachment[] mediumAttachments;
07540
07552 readonly attribute IUSBController[] USBControllers;
07553
07565 readonly attribute IUSBDeviceFilters USBDeviceFilters;
07566
07570 readonly attribute IAudioAdapter audioAdapter;
07571
07575 readonly attribute IStorageController[] storageControllers;
07576
07582 readonly attribute wstring settingsFilePath;
07583
07608 readonly attribute boolean settingsModified;
07609
07613 readonly attribute SessionState sessionState;
07614
07627 readonly attribute wstring sessionType;
07628
07638 readonly attribute unsigned long sessionPID;
07639
07643 readonly attribute MachineState state;
07644
07651 readonly attribute long long lastStateChange;
07652
07664 readonly attribute wstring stateFilePath;
07665
07675 readonly attribute wstring logFolder;
07676
07687 readonly attribute ISnapshot currentSnapshot;
07688
07695 readonly attribute unsigned long snapshotCount;
07696
07728 readonly attribute boolean currentStateModified;
07729
07741 readonly attribute ISharedFolder[] sharedFolders;
07742
07749 attribute ClipboardMode clipboardMode;
07750
07756 attribute DragAndDropMode dragAndDropMode;
07757
07765 attribute wstring guestPropertyNotificationPatterns;
07766
07775 attribute boolean teleporterEnabled;
07776
07787 attribute unsigned long teleporterPort;
07788
07795 attribute wstring teleporterAddress;
07796
07807 attribute wstring teleporterPassword;
07808
07816 attribute FaultToleranceState faultToleranceState;
07817
07824 attribute unsigned long faultTolerancePort;
07825
07831 attribute wstring faultToleranceAddress;
07832
07840 attribute wstring faultTolerancePassword;
07841
07847 attribute unsigned long faultToleranceSyncInterval;
07848
07856 attribute boolean RTCUseUTC;
07857
07864 attribute boolean IOCacheEnabled;
07865
07871 attribute unsigned long IOCacheSize;
07872
07882 readonly attribute IPCIDeviceAttachment[] PCIDeviceAssignments;
07883
07889 readonly attribute IBandwidthControl bandwidthControl;
07890
07899 attribute boolean tracingEnabled;
07900
07915 attribute wstring tracingConfig;
07916
07929 attribute boolean allowTracingToAccessVM;
07930
07936 attribute boolean autostartEnabled;
07937
07943 attribute unsigned long autostartDelay;
07944
07950 attribute AutostopType autostopType;
07951
07967 attribute wstring defaultFrontend;
07968
07974 readonly attribute boolean USBProxyAvailable;
07975
08081 void lockMachine (
08082 in ISession session,
08083 in LockType lockType
08084 );
08085
08222 void launchVMProcess (
08223 in ISession session,
08224 in wstring type,
08225 in wstring environment,
08226 [retval] out IProgress progress
08227 );
08228
08266 void setBootOrder (
08267 in unsigned long position,
08268 in DeviceType device
08269 );
08270
08305 void getBootOrder (
08306 in unsigned long position,
08307 [retval] out DeviceType device
08308 );
08309
08411 void attachDevice (
08412 in wstring name,
08413 in long controllerPort,
08414 in long device,
08415 in DeviceType type,
08416 in IMedium medium
08417 );
08418
08514 void attachDeviceWithoutMedium (
08515 in wstring name,
08516 in long controllerPort,
08517 in long device,
08518 in DeviceType type
08519 );
08520
08574 void detachDevice (
08575 in wstring name,
08576 in long controllerPort,
08577 in long device
08578 );
08579
08622 void passthroughDevice (
08623 in wstring name,
08624 in long controllerPort,
08625 in long device,
08626 in boolean passthrough
08627 );
08628
08671 void temporaryEjectDevice (
08672 in wstring name,
08673 in long controllerPort,
08674 in long device,
08675 in boolean temporaryEject
08676 );
08677
08723 void nonRotationalDevice (
08724 in wstring name,
08725 in long controllerPort,
08726 in long device,
08727 in boolean nonRotational
08728 );
08729
08775 void setAutoDiscardForDevice (
08776 in wstring name,
08777 in long controllerPort,
08778 in long device,
08779 in boolean discard
08780 );
08781
08822 void setBandwidthGroupForDevice (
08823 in wstring name,
08824 in long controllerPort,
08825 in long device,
08826 in IBandwidthGroup bandwidthGroup
08827 );
08828
08865 void setNoBandwidthGroupForDevice (
08866 in wstring name,
08867 in long controllerPort,
08868 in long device
08869 );
08870
08935 void unmountMedium (
08936 in wstring name,
08937 in long controllerPort,
08938 in long device,
08939 in boolean force
08940 );
08941
09004 void mountMedium (
09005 in wstring name,
09006 in long controllerPort,
09007 in long device,
09008 in IMedium medium,
09009 in boolean force
09010 );
09011
09040 void getMedium (
09041 in wstring name,
09042 in long controllerPort,
09043 in long device,
09044 [retval] out IMedium medium
09045 );
09046
09061 void getMediumAttachmentsOfController (
09062 in wstring name,
09063 [retval] out IMediumAttachment[] mediumAttachments
09064 );
09065
09080 void getMediumAttachment (
09081 in wstring name,
09082 in long controllerPort,
09083 in long device,
09084 [retval] out IMediumAttachment attachment
09085 );
09086
09127 void attachHostPCIDevice (
09128 in long hostAddress,
09129 in long desiredGuestAddress,
09130 in boolean tryToUnbind
09131 );
09132
09173 void detachHostPCIDevice (
09174 in long hostAddress
09175 );
09176
09194 void getNetworkAdapter (
09195 in unsigned long slot,
09196 [retval] out INetworkAdapter adapter
09197 );
09198
09231 void addStorageController (
09232 in wstring name,
09233 in StorageBus connectionType,
09234 [retval] out IStorageController controller
09235 );
09236
09250 void getStorageControllerByName (
09251 in wstring name,
09252 [retval] out IStorageController storageController
09253 );
09254
09268 void getStorageControllerByInstance (
09269 in unsigned long instance,
09270 [retval] out IStorageController storageController
09271 );
09272
09295 void removeStorageController (
09296 in wstring name
09297 );
09298
09320 void setStorageControllerBootable (
09321 in wstring name,
09322 in boolean bootable
09323 );
09324
09347 void addUSBController (
09348 in wstring name,
09349 in USBControllerType type,
09350 [retval] out IUSBController controller
09351 );
09352
09366 void removeUSBController (
09367 in wstring name
09368 );
09369
09383 void getUSBControllerByName (
09384 in wstring name,
09385 [retval] out IUSBController controller
09386 );
09387
09393 void getUSBControllerCountByType (
09394 in USBControllerType type,
09395 [retval] out unsigned long controllers
09396 );
09397
09415 void getSerialPort (
09416 in unsigned long slot,
09417 [retval] out ISerialPort port
09418 );
09419
09437 void getParallelPort (
09438 in unsigned long slot,
09439 [retval] out IParallelPort port
09440 );
09441
09450 void getExtraDataKeys (
09451 [retval] out wstring[] keys
09452 );
09453
09482 void getExtraData (
09483 in wstring key,
09484 [retval] out wstring value
09485 );
09486
09536 void setExtraData (
09537 in wstring key,
09538 in wstring value
09539 );
09540
09562 void getCPUProperty (
09563 in CPUPropertyType property,
09564 [retval] out boolean value
09565 );
09566
09588 void setCPUProperty (
09589 in CPUPropertyType property,
09590 in boolean value
09591 );
09592
09632 void getCPUIDLeaf (
09633 in unsigned long id,
09634 out unsigned long valEax,
09635 out unsigned long valEbx,
09636 out unsigned long valEcx,
09637 out unsigned long valEdx
09638 );
09639
09683 void setCPUIDLeaf (
09684 in unsigned long id,
09685 in unsigned long valEax,
09686 in unsigned long valEbx,
09687 in unsigned long valEcx,
09688 in unsigned long valEdx
09689 );
09690
09708 void removeCPUIDLeaf (
09709 in unsigned long id
09710 );
09711
09717 void removeAllCPUIDLeaves();
09718
09740 void getHWVirtExProperty (
09741 in HWVirtExPropertyType property,
09742 [retval] out boolean value
09743 );
09744
09766 void setHWVirtExProperty (
09767 in HWVirtExPropertyType property,
09768 in boolean value
09769 );
09770
09816 void saveSettings();
09817
09841 void discardSettings();
09842
09926 void unregister (
09927 in CleanupMode cleanupMode,
09928 [retval] out IMedium[] media
09929 );
09930
09987 void deleteConfig (
09988 in IMedium[] media,
09989 [retval] out IProgress progress
09990 );
09991
10003 void exportTo (
10004 in IAppliance appliance,
10005 in wstring location,
10006 [retval] out IVirtualSystemDescription description
10007 );
10008
10032 void findSnapshot (
10033 in wstring nameOrId,
10034 [retval] out ISnapshot snapshot
10035 );
10036
10070 void createSharedFolder (
10071 in wstring name,
10072 in wstring hostPath,
10073 in boolean writable,
10074 in boolean automount
10075 );
10076
10102 void removeSharedFolder (
10103 in wstring name
10104 );
10105
10129 void canShowConsoleWindow (
10130 [retval] out boolean canShow
10131 );
10132
10167 void showConsoleWindow (
10168 [retval] out long long winId
10169 );
10170
10203 void getGuestProperty (
10204 in wstring name,
10205 out wstring value,
10206 out long long timestamp,
10207 out wstring flags
10208 );
10209
10232 void getGuestPropertyValue (
10233 in wstring property,
10234 [retval] out wstring value
10235 );
10236
10259 void getGuestPropertyTimestamp (
10260 in wstring property,
10261 [retval] out long long value
10262 );
10263
10314 void setGuestProperty (
10315 in wstring property,
10316 in wstring value,
10317 in wstring flags
10318 );
10319
10359 void setGuestPropertyValue (
10360 in wstring property,
10361 in wstring value
10362 );
10363
10381 void deleteGuestProperty (
10382 in wstring name
10383 );
10384
10415 void enumerateGuestProperties (
10416 in wstring patterns,
10417 out wstring[] names,
10418 out wstring[] values,
10419 out long long[] timestamps,
10420 out wstring[] flags
10421 );
10422
10452 void querySavedGuestScreenInfo (
10453 in unsigned long screenId,
10454 out unsigned long originX,
10455 out unsigned long originY,
10456 out unsigned long width,
10457 out unsigned long height,
10458 out boolean enabled
10459 );
10460
10482 void querySavedThumbnailSize (
10483 in unsigned long screenId,
10484 out unsigned long size,
10485 out unsigned long width,
10486 out unsigned long height
10487 );
10488
10515 void readSavedThumbnailToArray (
10516 in unsigned long screenId,
10517 in boolean BGR,
10518 out unsigned long width,
10519 out unsigned long height,
10520 [retval] out octet[] data
10521 );
10522
10544 void readSavedThumbnailPNGToArray (
10545 in unsigned long screenId,
10546 out unsigned long width,
10547 out unsigned long height,
10548 [retval] out octet[] data
10549 );
10550
10572 void querySavedScreenshotPNGSize (
10573 in unsigned long screenId,
10574 out unsigned long size,
10575 out unsigned long width,
10576 out unsigned long height
10577 );
10578
10600 void readSavedScreenshotPNGToArray (
10601 in unsigned long screenId,
10602 out unsigned long width,
10603 out unsigned long height,
10604 [retval] out octet[] data
10605 );
10606
10616 void hotPlugCPU (
10617 in unsigned long cpu
10618 );
10619
10629 void hotUnplugCPU (
10630 in unsigned long cpu
10631 );
10632
10646 void getCPUStatus (
10647 in unsigned long cpu,
10648 [retval] out boolean attached
10649 );
10650
10665 void queryLogFilename (
10666 in unsigned long idx,
10667 [retval] out wstring filename
10668 );
10669
10695 void readLog (
10696 in unsigned long idx,
10697 in long long offset,
10698 in long long size,
10699 [retval] out octet[] data
10700 );
10701
10734 void cloneTo (
10735 in IMachine target,
10736 in CloneMode mode,
10737 in CloneOptions[] options,
10738 [retval] out IProgress progress
10739 );
10740
10741 };
10742
10751 interface IVRDEServerInfo : $unknown
10752 {
10758 readonly attribute boolean active;
10759
10768 readonly attribute long port;
10769
10775 readonly attribute unsigned long numberOfClients;
10776
10782 readonly attribute long long beginTime;
10783
10790 readonly attribute long long endTime;
10791
10797 readonly attribute long long bytesSent;
10798
10804 readonly attribute long long bytesSentTotal;
10805
10811 readonly attribute long long bytesReceived;
10812
10818 readonly attribute long long bytesReceivedTotal;
10819
10825 readonly attribute wstring user;
10826
10832 readonly attribute wstring domain;
10833
10839 readonly attribute wstring clientName;
10840
10846 readonly attribute wstring clientIP;
10847
10853 readonly attribute unsigned long clientVersion;
10854
10862 readonly attribute unsigned long encryptionStyle;
10863
10864 };
10865
10887 interface IConsole : $unknown
10888 {
10900 readonly attribute IMachine machine;
10901
10915 readonly attribute MachineState state;
10916
10920 readonly attribute IGuest guest;
10921
10932 readonly attribute IKeyboard keyboard;
10933
10944 readonly attribute IMouse mouse;
10945
10955 readonly attribute IDisplay display;
10956
10960 readonly attribute IMachineDebugger debugger;
10961
10972 readonly attribute IUSBDevice[] USBDevices;
10973
10981 readonly attribute IHostUSBDevice[] remoteUSBDevices;
10982
10998 readonly attribute ISharedFolder[] sharedFolders;
10999
11005 readonly attribute IVRDEServerInfo VRDEServerInfo;
11006
11012 readonly attribute IEventSource eventSource;
11013
11017 readonly attribute IPCIDeviceAttachment[] attachedPCIDevices;
11018
11027 attribute boolean useHostClipboard;
11028
11093 void powerUp (
11094 [retval] out IProgress progress
11095 );
11096
11130 void powerUpPaused (
11131 [retval] out IProgress progress
11132 );
11133
11153 void powerDown (
11154 [retval] out IProgress progress
11155 );
11156
11176 void reset();
11177
11197 void pause();
11198
11218 void resume();
11219
11239 void powerButton();
11240
11260 void sleepButton();
11261
11273 void getPowerButtonHandled (
11274 [retval] out boolean handled
11275 );
11276
11290 void getGuestEnteredACPIMode (
11291 [retval] out boolean entered
11292 );
11293
11346 void saveState (
11347 [retval] out IProgress progress
11348 );
11349
11382 void adoptSavedState (
11383 in wstring savedStateFile
11384 );
11385
11416 void discardSavedState (
11417 in boolean fRemoveFile
11418 );
11419
11432 void getDeviceActivity (
11433 in DeviceType type,
11434 [retval] out DeviceActivity activity
11435 );
11436
11474 void attachUSBDevice (
11475 in wstringUUID id
11476 );
11477
11512 void detachUSBDevice (
11513 in wstringUUID id,
11514 [retval] out IUSBDevice device
11515 );
11516
11539 void findUSBDeviceByAddress (
11540 in wstring name,
11541 [retval] out IUSBDevice device
11542 );
11543
11563 void findUSBDeviceById (
11564 in wstringUUID id,
11565 [retval] out IUSBDevice device
11566 );
11567
11601 void createSharedFolder (
11602 in wstring name,
11603 in wstring hostPath,
11604 in boolean writable,
11605 in boolean automount
11606 );
11607
11632 void removeSharedFolder (
11633 in wstring name
11634 );
11635
11673 void takeSnapshot (
11674 in wstring name,
11675 in wstring description,
11676 [retval] out IProgress progress
11677 );
11678
11751 void deleteSnapshot (
11752 in wstringUUID id,
11753 [retval] out IProgress progress
11754 );
11755
11795 void deleteSnapshotAndAllChildren (
11796 in wstringUUID id,
11797 [retval] out IProgress progress
11798 );
11799
11843 void deleteSnapshotRange (
11844 in wstringUUID startId,
11845 in wstringUUID endId,
11846 [retval] out IProgress progress
11847 );
11848
11889 void restoreSnapshot (
11890 in ISnapshot snapshot,
11891 [retval] out IProgress progress
11892 );
11893
11932 void teleport (
11933 in wstring hostname,
11934 in unsigned long tcpport,
11935 in wstring password,
11936 in unsigned long maxDowntime,
11937 [retval] out IProgress progress
11938 );
11939
11940 };
11941
11952 interface IHostNetworkInterface : $unknown
11953 {
11957 readonly attribute wstring name;
11958
11962 readonly attribute wstringUUID id;
11963
11967 readonly attribute wstring networkName;
11968
11972 readonly attribute boolean DHCPEnabled;
11973
11977 readonly attribute wstring IPAddress;
11978
11982 readonly attribute wstring networkMask;
11983
11987 readonly attribute boolean IPV6Supported;
11988
11992 readonly attribute wstring IPV6Address;
11993
11997 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
11998
12002 readonly attribute wstring hardwareAddress;
12003
12007 readonly attribute HostNetworkInterfaceMediumType mediumType;
12008
12012 readonly attribute HostNetworkInterfaceStatus status;
12013
12017 readonly attribute HostNetworkInterfaceType interfaceType;
12018
12030 void enableStaticIPConfig (
12031 in wstring IPAddress,
12032 in wstring networkMask
12033 );
12034
12046 void enableStaticIPConfigV6 (
12047 in wstring IPV6Address,
12048 in unsigned long IPV6NetworkMaskPrefixLength
12049 );
12050
12054 void enableDynamicIPConfig();
12055
12059 void DHCPRediscover();
12060
12061 };
12062
12079 interface IHost : $unknown
12080 {
12084 readonly attribute IMedium[] DVDDrives;
12085
12089 readonly attribute IMedium[] floppyDrives;
12090
12104 readonly attribute IHostUSBDevice[] USBDevices;
12105
12129 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
12130
12134 readonly attribute IHostNetworkInterface[] networkInterfaces;
12135
12139 readonly attribute wstring[] nameServers;
12140
12144 readonly attribute wstring domainName;
12145
12149 readonly attribute wstring[] searchStrings;
12150
12154 readonly attribute unsigned long processorCount;
12155
12159 readonly attribute unsigned long processorOnlineCount;
12160
12164 readonly attribute unsigned long processorCoreCount;
12165
12169 readonly attribute unsigned long memorySize;
12170
12174 readonly attribute unsigned long memoryAvailable;
12175
12179 readonly attribute wstring operatingSystem;
12180
12184 readonly attribute wstring OSVersion;
12185
12189 readonly attribute long long UTCTime;
12190
12194 readonly attribute boolean acceleration3DAvailable;
12195
12210 void getProcessorSpeed (
12211 in unsigned long cpuId,
12212 [retval] out unsigned long speed
12213 );
12214
12226 void getProcessorFeature (
12227 in ProcessorFeature feature,
12228 [retval] out boolean supported
12229 );
12230
12249 void getProcessorDescription (
12250 in unsigned long cpuId,
12251 [retval] out wstring description
12252 );
12253
12294 void getProcessorCPUIDLeaf (
12295 in unsigned long cpuId,
12296 in unsigned long leaf,
12297 in unsigned long subLeaf,
12298 out unsigned long valEax,
12299 out unsigned long valEbx,
12300 out unsigned long valEcx,
12301 out unsigned long valEdx
12302 );
12303
12324 void createHostOnlyNetworkInterface (
12325 out IHostNetworkInterface hostInterface,
12326 [retval] out IProgress progress
12327 );
12328
12349 void removeHostOnlyNetworkInterface (
12350 in wstringUUID id,
12351 [retval] out IProgress progress
12352 );
12353
12373 void createUSBDeviceFilter (
12374 in wstring name,
12375 [retval] out IHostUSBDeviceFilter filter
12376 );
12377
12420 void insertUSBDeviceFilter (
12421 in unsigned long position,
12422 in IHostUSBDeviceFilter filter
12423 );
12424
12452 void removeUSBDeviceFilter (
12453 in unsigned long position
12454 );
12455
12473 void findHostDVDDrive (
12474 in wstring name,
12475 [retval] out IMedium drive
12476 );
12477
12495 void findHostFloppyDrive (
12496 in wstring name,
12497 [retval] out IMedium drive
12498 );
12499
12515 void findHostNetworkInterfaceByName (
12516 in wstring name,
12517 [retval] out IHostNetworkInterface networkInterface
12518 );
12519
12535 void findHostNetworkInterfaceById (
12536 in wstringUUID id,
12537 [retval] out IHostNetworkInterface networkInterface
12538 );
12539
12549 void findHostNetworkInterfacesOfType (
12550 in HostNetworkInterfaceType type,
12551 [retval] out IHostNetworkInterface[] networkInterfaces
12552 );
12553
12573 void findUSBDeviceById (
12574 in wstringUUID id,
12575 [retval] out IHostUSBDevice device
12576 );
12577
12600 void findUSBDeviceByAddress (
12601 in wstring name,
12602 [retval] out IHostUSBDevice device
12603 );
12604
12612 void generateMACAddress (
12613 [retval] out wstring address
12614 );
12615
12616 };
12617
12630 interface ISystemProperties : $unknown
12631 {
12635 readonly attribute unsigned long minGuestRAM;
12636
12640 readonly attribute unsigned long maxGuestRAM;
12641
12645 readonly attribute unsigned long minGuestVRAM;
12646
12650 readonly attribute unsigned long maxGuestVRAM;
12651
12655 readonly attribute unsigned long minGuestCPUCount;
12656
12660 readonly attribute unsigned long maxGuestCPUCount;
12661
12665 readonly attribute unsigned long maxGuestMonitors;
12666
12671 readonly attribute long long infoVDSize;
12672
12679 readonly attribute unsigned long serialPortCount;
12680
12687 readonly attribute unsigned long parallelPortCount;
12688
12698 readonly attribute unsigned long maxBootPosition;
12699
12723 attribute wstring defaultMachineFolder;
12724
12730 attribute wstring loggingLevel;
12731
12756 readonly attribute IMediumFormat[] mediumFormats;
12757
12791 attribute wstring defaultHardDiskFormat;
12792
12798 attribute long long freeDiskSpaceWarning;
12799
12804 attribute unsigned long freeDiskSpacePercentWarning;
12805
12811 attribute long long freeDiskSpaceError;
12812
12817 attribute unsigned long freeDiskSpacePercentError;
12818
12842 attribute wstring VRDEAuthLibrary;
12843
12872 attribute wstring webServiceAuthLibrary;
12873
12887 attribute wstring defaultVRDEExtPack;
12888
12894 attribute unsigned long logHistoryCount;
12895
12900 readonly attribute AudioDriverType defaultAudioDriver;
12901
12908 attribute wstring autostartDatabasePath;
12909
12916 attribute wstring defaultAdditionsISO;
12917
12932 attribute wstring defaultFrontend;
12933
12944 void getMaxNetworkAdapters (
12945 in ChipsetType chipset,
12946 [retval] out unsigned long maxNetworkAdapters
12947 );
12948
12962 void getMaxNetworkAdaptersOfType (
12963 in ChipsetType chipset,
12964 in NetworkAttachmentType type,
12965 [retval] out unsigned long maxNetworkAdapters
12966 );
12967
12977 void getMaxDevicesPerPortForStorageBus (
12978 in StorageBus bus,
12979 [retval] out unsigned long maxDevicesPerPort
12980 );
12981
12989 void getMinPortCountForStorageBus (
12990 in StorageBus bus,
12991 [retval] out unsigned long minPortCount
12992 );
12993
13001 void getMaxPortCountForStorageBus (
13002 in StorageBus bus,
13003 [retval] out unsigned long maxPortCount
13004 );
13005
13018 void getMaxInstancesOfStorageBus (
13019 in ChipsetType chipset,
13020 in StorageBus bus,
13021 [retval] out unsigned long maxInstances
13022 );
13023
13033 void getDeviceTypesForStorageBus (
13034 in StorageBus bus,
13035 [retval] out DeviceType[] deviceTypes
13036 );
13037
13046 void getDefaultIoCacheSettingForStorageController (
13047 in StorageControllerType controllerType,
13048 [retval] out boolean enabled
13049 );
13050
13063 void getMaxInstancesOfUSBControllerType (
13064 in ChipsetType chipset,
13065 in USBControllerType type,
13066 [retval] out unsigned long maxInstances
13067 );
13068
13069 };
13070
13076 interface IGuestOSType : $unknown
13077 {
13081 readonly attribute wstring familyId;
13082
13086 readonly attribute wstring familyDescription;
13087
13091 readonly attribute wstring id;
13092
13096 readonly attribute wstring description;
13097
13101 readonly attribute boolean is64Bit;
13102
13106 readonly attribute boolean recommendedIOAPIC;
13107
13111 readonly attribute boolean recommendedVirtEx;
13112
13116 readonly attribute unsigned long recommendedRAM;
13117
13121 readonly attribute unsigned long recommendedVRAM;
13122
13126 readonly attribute boolean recommended2DVideoAcceleration;
13127
13131 readonly attribute boolean recommended3DAcceleration;
13132
13136 readonly attribute long long recommendedHDD;
13137
13141 readonly attribute NetworkAdapterType adapterType;
13142
13146 readonly attribute boolean recommendedPAE;
13147
13151 readonly attribute StorageControllerType recommendedDVDStorageController;
13152
13156 readonly attribute StorageBus recommendedDVDStorageBus;
13157
13161 readonly attribute StorageControllerType recommendedHDStorageController;
13162
13166 readonly attribute StorageBus recommendedHDStorageBus;
13167
13171 readonly attribute FirmwareType recommendedFirmware;
13172
13176 readonly attribute boolean recommendedUSBHID;
13177
13181 readonly attribute boolean recommendedHPET;
13182
13186 readonly attribute boolean recommendedUSBTablet;
13187
13191 readonly attribute boolean recommendedRTCUseUTC;
13192
13196 readonly attribute ChipsetType recommendedChipset;
13197
13201 readonly attribute AudioControllerType recommendedAudioController;
13202
13206 readonly attribute boolean recommendedFloppy;
13207
13211 readonly attribute boolean recommendedUSB;
13212
13213 };
13214
13222 interface IAdditionsFacility : $unknown
13223 {
13227 readonly attribute AdditionsFacilityClass classType;
13228
13235 readonly attribute long long lastUpdated;
13236
13240 readonly attribute wstring name;
13241
13245 readonly attribute AdditionsFacilityStatus status;
13246
13250 readonly attribute AdditionsFacilityType type;
13251
13252 };
13253
13282 interface IGuestSession : $unknown
13283 {
13289 readonly attribute wstring user;
13290
13296 readonly attribute wstring domain;
13297
13301 readonly attribute wstring name;
13302
13306 readonly attribute unsigned long id;
13307
13320 attribute unsigned long timeout;
13321
13326 readonly attribute unsigned long protocolVersion;
13327
13331 readonly attribute GuestSessionStatus status;
13332
13338 attribute wstring[] environment;
13339
13345 readonly attribute IGuestProcess[] processes;
13346
13352 readonly attribute IGuestDirectory[] directories;
13353
13359 readonly attribute IGuestFile[] files;
13360
13366 readonly attribute IEventSource eventSource;
13367
13376 void close();
13377
13399 void copyFrom (
13400 in wstring source,
13401 in wstring dest,
13402 in CopyFileFlag[] flags,
13403 [retval] out IProgress progress
13404 );
13405
13427 void copyTo (
13428 in wstring source,
13429 in wstring dest,
13430 in CopyFileFlag[] flags,
13431 [retval] out IProgress progress
13432 );
13433
13453 void directoryCreate (
13454 in wstring path,
13455 in unsigned long mode,
13456 in DirectoryCreateFlag[] flags
13457 );
13458
13510 void directoryCreateTemp (
13511 in wstring templateName,
13512 in unsigned long mode,
13513 in wstring path,
13514 in boolean secure,
13515 [retval] out wstring directory
13516 );
13517
13535 void directoryExists (
13536 in wstring path,
13537 [retval] out boolean exists
13538 );
13539
13570 void directoryOpen (
13571 in wstring path,
13572 in wstring filter,
13573 in DirectoryOpenFlag[] flags,
13574 [retval] out IGuestDirectory directory
13575 );
13576
13602 void directoryQueryInfo (
13603 in wstring path,
13604 [retval] out IGuestFsObjInfo info
13605 );
13606
13622 void directoryRemove (
13623 in wstring path
13624 );
13625
13645 void directoryRemoveRecursive (
13646 in wstring path,
13647 in DirectoryRemoveRecFlag[] flags,
13648 [retval] out IProgress progress
13649 );
13650
13670 void directoryRename (
13671 in wstring source,
13672 in wstring dest,
13673 in PathRenameFlag[] flags
13674 );
13675
13693 void directorySetACL (
13694 in wstring path,
13695 in wstring acl
13696 );
13697
13711 void environmentClear();
13712
13733 void environmentGet (
13734 in wstring name,
13735 [retval] out wstring value
13736 );
13737
13755 void environmentSet (
13756 in wstring name,
13757 in wstring value
13758 );
13759
13775 void environmentUnset (
13776 in wstring name
13777 );
13778
13832 void fileCreateTemp (
13833 in wstring templateName,
13834 in unsigned long mode,
13835 in wstring path,
13836 in boolean secure,
13837 [retval] out IGuestFile file
13838 );
13839
13857 void fileExists (
13858 in wstring path,
13859 [retval] out boolean exists
13860 );
13861
13885 void fileRemove (
13886 in wstring path
13887 );
13888
13947 void fileOpen (
13948 in wstring path,
13949 in wstring openMode,
13950 in wstring disposition,
13951 in unsigned long creationMode,
13952 [retval] out IGuestFile file
13953 );
13954
14018 void fileOpenEx (
14019 in wstring path,
14020 in wstring openMode,
14021 in wstring disposition,
14022 in wstring sharingMode,
14023 in unsigned long creationMode,
14024 in long long offset,
14025 [retval] out IGuestFile file
14026 );
14027
14053 void fileQueryInfo (
14054 in wstring path,
14055 [retval] out IGuestFsObjInfo info
14056 );
14057
14083 void fileQuerySize (
14084 in wstring path,
14085 [retval] out long long size
14086 );
14087
14107 void fileRename (
14108 in wstring source,
14109 in wstring dest,
14110 in PathRenameFlag[] flags
14111 );
14112
14130 void fileSetACL (
14131 in wstring file,
14132 in wstring acl
14133 );
14134
14189 void processCreate (
14190 in wstring command,
14191 in wstring[] arguments,
14192 in wstring[] environment,
14193 in ProcessCreateFlag[] flags,
14194 in unsigned long timeoutMS,
14195 [retval] out IGuestProcess guestProcess
14196 );
14197
14239 void processCreateEx (
14240 in wstring command,
14241 in wstring[] arguments,
14242 in wstring[] environment,
14243 in ProcessCreateFlag[] flags,
14244 in unsigned long timeoutMS,
14245 in ProcessPriority priority,
14246 in long[] affinity,
14247 [retval] out IGuestProcess guestProcess
14248 );
14249
14259 void processGet (
14260 in unsigned long pid,
14261 [retval] out IGuestProcess guestProcess
14262 );
14263
14286 void symlinkCreate (
14287 in wstring source,
14288 in wstring target,
14289 in SymlinkType type
14290 );
14291
14309 void symlinkExists (
14310 in wstring symlink,
14311 [retval] out boolean exists
14312 );
14313
14337 void symlinkRead (
14338 in wstring symlink,
14339 in SymlinkReadFlag[] flags,
14340 [retval] out wstring target
14341 );
14342
14358 void symlinkRemoveDirectory (
14359 in wstring path
14360 );
14361
14377 void symlinkRemoveFile (
14378 in wstring file
14379 );
14380
14401 void waitFor (
14402 in unsigned long waitFor,
14403 in unsigned long timeoutMS,
14404 [retval] out GuestSessionWaitResult reason
14405 );
14406
14428 void waitForArray (
14429 in GuestSessionWaitForFlag[] waitFor,
14430 in unsigned long timeoutMS,
14431 [retval] out GuestSessionWaitResult reason
14432 );
14433
14434 };
14435
14443 interface IProcess : $unknown
14444 {
14450 readonly attribute wstring[] arguments;
14451
14457 readonly attribute wstring[] environment;
14458
14464 readonly attribute IEventSource eventSource;
14465
14469 readonly attribute wstring executablePath;
14470
14477 readonly attribute long exitCode;
14478
14484 readonly attribute wstring name;
14485
14491 readonly attribute unsigned long PID;
14492
14499 readonly attribute ProcessStatus status;
14500
14521 void waitFor (
14522 in unsigned long waitFor,
14523 in unsigned long timeoutMS,
14524 [retval] out ProcessWaitResult reason
14525 );
14526
14548 void waitForArray (
14549 in ProcessWaitForFlag[] waitFor,
14550 in unsigned long timeoutMS,
14551 [retval] out ProcessWaitResult reason
14552 );
14553
14570 void read (
14571 in unsigned long handle,
14572 in unsigned long toRead,
14573 in unsigned long timeoutMS,
14574 [retval] out octet[] data
14575 );
14576
14600 void write (
14601 in unsigned long handle,
14602 in unsigned long flags,
14603 in octet[] data,
14604 in unsigned long timeoutMS,
14605 [retval] out unsigned long written
14606 );
14607
14632 void writeArray (
14633 in unsigned long handle,
14634 in ProcessInputFlag[] flags,
14635 in octet[] data,
14636 in unsigned long timeoutMS,
14637 [retval] out unsigned long written
14638 );
14639
14649 void terminate();
14650
14651 };
14652
14661 interface IGuestProcess : IProcess
14662 {
14663 };
14664
14672 interface IDirectory : $unknown
14673 {
14679 readonly attribute wstring directoryName;
14680
14686 readonly attribute wstring filter;
14687
14694 void close();
14695
14711 void read (
14712 [retval] out IFsObjInfo objInfo
14713 );
14714
14715 };
14716
14725 interface IGuestDirectory : IDirectory
14726 {
14727 };
14728
14736 interface IFile : $unknown
14737 {
14743 readonly attribute unsigned long creationMode;
14744
14750 readonly attribute wstring disposition;
14751
14757 readonly attribute IEventSource eventSource;
14758
14764 readonly attribute wstring fileName;
14765
14771 readonly attribute unsigned long id;
14772
14778 readonly attribute long long initialSize;
14779
14785 readonly attribute wstring openMode;
14786
14792 readonly attribute long long offset;
14793
14799 readonly attribute FileStatus status;
14800
14807 void close();
14808
14825 void queryInfo (
14826 [retval] out IFsObjInfo objInfo
14827 );
14828
14851 void read (
14852 in unsigned long toRead,
14853 in unsigned long timeoutMS,
14854 [retval] out octet[] data
14855 );
14856
14881 void readAt (
14882 in long long offset,
14883 in unsigned long toRead,
14884 in unsigned long timeoutMS,
14885 [retval] out octet[] data
14886 );
14887
14907 void seek (
14908 in long long offset,
14909 in FileSeekType whence
14910 );
14911
14927 void setACL (
14928 in wstring acl
14929 );
14930
14948 void write (
14949 in octet[] data,
14950 in unsigned long timeoutMS,
14951 [retval] out unsigned long written
14952 );
14953
14981 void writeAt (
14982 in long long offset,
14983 in octet[] data,
14984 in unsigned long timeoutMS,
14985 [retval] out unsigned long written
14986 );
14987
14988 };
14989
14998 interface IGuestFile : IFile
14999 {
15000 };
15001
15010 interface IFsObjInfo : $unknown
15011 {
15017 readonly attribute long long accessTime;
15018
15024 readonly attribute long long allocatedSize;
15025
15031 readonly attribute long long birthTime;
15032
15038 readonly attribute long long changeTime;
15039
15045 readonly attribute unsigned long deviceNumber;
15046
15052 readonly attribute wstring fileAttributes;
15053
15059 readonly attribute unsigned long generationId;
15060
15066 readonly attribute unsigned long GID;
15067
15073 readonly attribute wstring groupName;
15074
15080 readonly attribute unsigned long hardLinks;
15081
15087 readonly attribute long long modificationTime;
15088
15094 readonly attribute wstring name;
15095
15101 readonly attribute long long nodeId;
15102
15108 readonly attribute unsigned long nodeIdDevice;
15109
15117 readonly attribute long long objectSize;
15118
15124 readonly attribute FsObjType type;
15125
15131 readonly attribute unsigned long UID;
15132
15138 readonly attribute unsigned long userFlags;
15139
15145 readonly attribute wstring userName;
15146
15147 };
15148
15157 interface IGuestFsObjInfo : IFsObjInfo
15158 {
15159 };
15160
15174 interface IGuest : $unknown
15175 {
15190 readonly attribute wstring OSTypeId;
15191
15197 readonly attribute AdditionsRunLevelType additionsRunLevel;
15198
15205 readonly attribute wstring additionsVersion;
15206
15214 readonly attribute unsigned long additionsRevision;
15215
15221 readonly attribute IEventSource eventSource;
15222
15229 readonly attribute IAdditionsFacility[] facilities;
15230
15234 readonly attribute IGuestSession[] sessions;
15235
15239 attribute unsigned long memoryBalloonSize;
15240
15244 attribute unsigned long statisticsUpdateInterval;
15245
15277 void internalGetStatistics (
15278 out unsigned long cpuUser,
15279 out unsigned long cpuKernel,
15280 out unsigned long cpuIdle,
15281 out unsigned long memTotal,
15282 out unsigned long memFree,
15283 out unsigned long memBalloon,
15284 out unsigned long memShared,
15285 out unsigned long memCache,
15286 out unsigned long pagedTotal,
15287 out unsigned long memAllocTotal,
15288 out unsigned long memFreeTotal,
15289 out unsigned long memBalloonTotal,
15290 out unsigned long memSharedTotal
15291 );
15292
15304 void getFacilityStatus (
15305 in AdditionsFacilityType facility,
15306 out long long timestamp,
15307 [retval] out AdditionsFacilityStatus status
15308 );
15309
15327 void getAdditionsStatus (
15328 in AdditionsRunLevelType level,
15329 [retval] out boolean active
15330 );
15331
15361 void setCredentials (
15362 in wstring userName,
15363 in wstring password,
15364 in wstring domain,
15365 in boolean allowInteractiveLogon
15366 );
15367
15397 void dragHGEnter (
15398 in unsigned long screenId,
15399 in unsigned long y,
15400 in unsigned long x,
15401 in DragAndDropAction defaultAction,
15402 in DragAndDropAction[] allowedActions,
15403 in wstring[] formats,
15404 [retval] out DragAndDropAction resultAction
15405 );
15406
15436 void dragHGMove (
15437 in unsigned long screenId,
15438 in unsigned long x,
15439 in unsigned long y,
15440 in DragAndDropAction defaultAction,
15441 in DragAndDropAction[] allowedActions,
15442 in wstring[] formats,
15443 [retval] out DragAndDropAction resultAction
15444 );
15445
15463 void dragHGLeave (
15464 in unsigned long screenId
15465 );
15466
15498 void dragHGDrop (
15499 in unsigned long screenId,
15500 in unsigned long x,
15501 in unsigned long y,
15502 in DragAndDropAction defaultAction,
15503 in DragAndDropAction[] allowedActions,
15504 in wstring[] formats,
15505 out wstring format,
15506 [retval] out DragAndDropAction resultAction
15507 );
15508
15532 void dragHGPutData (
15533 in unsigned long screenId,
15534 in wstring format,
15535 in octet[] data,
15536 [retval] out IProgress progress
15537 );
15538
15564 void dragGHPending (
15565 in unsigned long screenId,
15566 out wstring[] formats,
15567 out DragAndDropAction[] allowedActions,
15568 [retval] out DragAndDropAction defaultAction
15569 );
15570
15592 void dragGHDropped (
15593 in wstring format,
15594 in DragAndDropAction action,
15595 [retval] out IProgress progress
15596 );
15597
15615 void dragGHGetData (
15616 [retval] out octet[] data
15617 );
15618
15677 void createSession (
15678 in wstring user,
15679 in wstring password,
15680 in wstring domain,
15681 in wstring sessionName,
15682 [retval] out IGuestSession guestSession
15683 );
15684
15699 void findSession (
15700 in wstring sessionName,
15701 [retval] out IGuestSession[] sessions
15702 );
15703
15753 void updateGuestAdditions (
15754 in wstring source,
15755 in wstring[] arguments,
15756 in AdditionsUpdateFlag[] flags,
15757 [retval] out IProgress progress
15758 );
15759
15760 };
15761
15802 interface IProgress : $unknown
15803 {
15807 readonly attribute wstringUUID id;
15808
15812 readonly attribute wstring description;
15813
15817 readonly attribute $unknown initiator;
15818
15822 readonly attribute boolean cancelable;
15823
15831 readonly attribute unsigned long percent;
15832
15846 readonly attribute long timeRemaining;
15847
15851 readonly attribute boolean completed;
15852
15856 readonly attribute boolean canceled;
15857
15864 readonly attribute long resultCode;
15865
15875 readonly attribute IVirtualBoxErrorInfo errorInfo;
15876
15883 readonly attribute unsigned long operationCount;
15884
15888 readonly attribute unsigned long operation;
15889
15895 readonly attribute wstring operationDescription;
15896
15900 readonly attribute unsigned long operationPercent;
15901
15905 readonly attribute unsigned long operationWeight;
15906
15914 attribute unsigned long timeout;
15915
15919 void setCurrentOperationProgress (
15920 in unsigned long percent
15921 );
15922
15926 void setNextOperation (
15927 in wstring nextOperationDescription,
15928 in unsigned long nextOperationsWeight
15929 );
15930
15957 void waitForCompletion (
15958 in long timeout
15959 );
15960
15984 void waitForOperationCompletion (
15985 in unsigned long operation,
15986 in long timeout
15987 );
15988
16014 void waitForAsyncProgressCompletion (
16015 in IProgress pProgressAsync
16016 );
16017
16034 void cancel();
16035
16036 };
16037
16121 interface ISnapshot : $unknown
16122 {
16126 readonly attribute wstringUUID id;
16127
16135 attribute wstring name;
16136
16144 attribute wstring description;
16145
16151 readonly attribute long long timeStamp;
16152
16164 readonly attribute boolean online;
16165
16177 readonly attribute IMachine machine;
16178
16185 readonly attribute ISnapshot parent;
16186
16195 readonly attribute ISnapshot[] children;
16196
16204 void getChildrenCount (
16205 [retval] out unsigned long childrenCount
16206 );
16207
16208 };
16209
16396 interface IMediumAttachment : $unknown
16397 {
16402 readonly attribute IMedium medium;
16403
16409 readonly attribute wstring controller;
16410
16416 readonly attribute long port;
16417
16423 readonly attribute long device;
16424
16428 readonly attribute DeviceType type;
16429
16433 readonly attribute boolean passthrough;
16434
16438 readonly attribute boolean temporaryEject;
16439
16444 readonly attribute boolean isEjected;
16445
16449 readonly attribute boolean nonRotational;
16450
16454 readonly attribute boolean discard;
16455
16459 readonly attribute IBandwidthGroup bandwidthGroup;
16460
16461 };
16462
16620 interface IMedium : $unknown
16621 {
16635 readonly attribute wstringUUID id;
16636
16655 attribute wstring description;
16656
16672 readonly attribute MediumState state;
16673
16682 readonly attribute MediumVariant[] variant;
16683
16705 attribute wstring location;
16706
16726 readonly attribute wstring name;
16727
16732 readonly attribute DeviceType deviceType;
16733
16737 readonly attribute boolean hostDrive;
16738
16751 readonly attribute long long size;
16752
16767 readonly attribute wstring format;
16768
16784 readonly attribute IMediumFormat mediumFormat;
16785
16810 attribute MediumType type;
16811
16825 readonly attribute MediumType[] allowedTypes;
16826
16836 readonly attribute IMedium parent;
16837
16845 readonly attribute IMedium[] children;
16846
16857 readonly attribute IMedium base;
16858
16891 readonly attribute boolean readOnly;
16892
16908 readonly attribute long long logicalSize;
16909
16937 attribute boolean autoReset;
16938
16953 readonly attribute wstring lastAccessError;
16954
16971 readonly attribute wstringUUID[] machineIds;
16972
16998 void setIds (
16999 in boolean setImageId,
17000 in wstringUUID imageId,
17001 in boolean setParentId,
17002 in wstringUUID parentId
17003 );
17004
17039 void refreshState (
17040 [retval] out MediumState state
17041 );
17042
17069 void getSnapshotIds (
17070 in wstringUUID machineId,
17071 [retval] out wstringUUID[] snapshotIds
17072 );
17073
17133 void lockRead (
17134 [retval] out MediumState state
17135 );
17136
17159 void unlockRead (
17160 [retval] out MediumState state
17161 );
17162
17217 void lockWrite (
17218 [retval] out MediumState state
17219 );
17220
17243 void unlockWrite (
17244 [retval] out MediumState state
17245 );
17246
17296 void close();
17297
17327 void getProperty (
17328 in wstring name,
17329 [retval] out wstring value
17330 );
17331
17363 void setProperty (
17364 in wstring name,
17365 in wstring value
17366 );
17367
17402 void getProperties (
17403 in wstring names,
17404 out wstring[] returnNames,
17405 [retval] out wstring[] returnValues
17406 );
17407
17437 void setProperties (
17438 in wstring[] names,
17439 in wstring[] values
17440 );
17441
17474 void createBaseStorage (
17475 in long long logicalSize,
17476 in MediumVariant[] variant,
17477 [retval] out IProgress progress
17478 );
17479
17531 void deleteStorage (
17532 [retval] out IProgress progress
17533 );
17534
17573 void createDiffStorage (
17574 in IMedium target,
17575 in MediumVariant[] variant,
17576 [retval] out IProgress progress
17577 );
17578
17654 void mergeTo (
17655 in IMedium target,
17656 [retval] out IProgress progress
17657 );
17658
17708 void cloneTo (
17709 in IMedium target,
17710 in MediumVariant[] variant,
17711 in IMedium parent,
17712 [retval] out IProgress progress
17713 );
17714
17761 void cloneToBase (
17762 in IMedium target,
17763 in MediumVariant[] variant,
17764 [retval] out IProgress progress
17765 );
17766
17795 void compact (
17796 [retval] out IProgress progress
17797 );
17798
17831 void resize (
17832 in long long logicalSize,
17833 [retval] out IProgress progress
17834 );
17835
17869 void reset (
17870 [retval] out IProgress progress
17871 );
17872
17873 };
17874
17897 interface IMediumFormat : $unknown
17898 {
17917 readonly attribute wstring id;
17918
17926 readonly attribute wstring name;
17927
17936 readonly attribute MediumFormatCapabilities[] capabilities;
17937
17956 void describeFileExtensions (
17957 out wstring[] extensions,
17958 out DeviceType[] types
17959 );
17960
17988 void describeProperties (
17989 out wstring[] names,
17990 out wstring[] descriptions,
17991 out DataType[] types,
17992 out unsigned long[] flags,
17993 out wstring[] defaults
17994 );
17995
17996 };
17997
18010 interface IKeyboard : $unknown
18011 {
18017 readonly attribute IEventSource eventSource;
18018
18031 void putScancode (
18032 in long scancode
18033 );
18034
18047 void putScancodes (
18048 in long[] scancodes,
18049 [retval] out unsigned long codesStored
18050 );
18051
18066 void putCAD();
18067
18068 };
18069
18081 interface IMouse : $unknown
18082 {
18097 readonly attribute boolean absoluteSupported;
18098
18113 readonly attribute boolean relativeSupported;
18114
18128 readonly attribute boolean multiTouchSupported;
18129
18144 readonly attribute boolean needsHostCursor;
18145
18151 readonly attribute IEventSource eventSource;
18152
18218 void putMouseEvent (
18219 in long dx,
18220 in long dy,
18221 in long dz,
18222 in long dw,
18223 in long buttonState
18224 );
18225
18298 void putMouseEventAbsolute (
18299 in long x,
18300 in long y,
18301 in long dz,
18302 in long dw,
18303 in long buttonState
18304 );
18305
18353 void putEventMultiTouch (
18354 in long count,
18355 in long long[] contacts,
18356 in unsigned long scanTime
18357 );
18358
18374 void putEventMultiTouchString (
18375 in long count,
18376 in wstring contacts,
18377 in unsigned long scanTime
18378 );
18379
18380 };
18381
18382 interface IFramebuffer : $unknown
18383 {
18392 readonly attribute octetPtr address;
18393
18397 readonly attribute unsigned long width;
18398
18402 readonly attribute unsigned long height;
18403
18410 readonly attribute unsigned long bitsPerPixel;
18411
18418 readonly attribute unsigned long bytesPerLine;
18419
18430 readonly attribute unsigned long pixelFormat;
18431
18438 readonly attribute boolean usesGuestVRAM;
18439
18449 readonly attribute unsigned long heightReduction;
18450
18465 readonly attribute IFramebufferOverlay overlay;
18466
18473 readonly attribute long long winId;
18474
18482 void lock();
18483
18491 void unlock();
18492
18500 void notifyUpdate (
18501 in unsigned long x,
18502 in unsigned long y,
18503 in unsigned long width,
18504 in unsigned long height
18505 );
18506
18619 void requestResize (
18620 in unsigned long screenId,
18621 in unsigned long pixelFormat,
18622 in octetPtr VRAM,
18623 in unsigned long bitsPerPixel,
18624 in unsigned long bytesPerLine,
18625 in unsigned long width,
18626 in unsigned long height,
18627 [retval] out boolean finished
18628 );
18629
18641 void videoModeSupported (
18642 in unsigned long width,
18643 in unsigned long height,
18644 in unsigned long bpp,
18645 [retval] out boolean supported
18646 );
18647
18684 void getVisibleRegion (
18685 in octetPtr rectangles,
18686 in unsigned long count,
18687 [retval] out unsigned long countCopied
18688 );
18689
18724 void setVisibleRegion (
18725 in octetPtr rectangles,
18726 in unsigned long count
18727 );
18728
18749 void processVHWACommand (
18750 in octetPtr command
18751 );
18752
18767 void notify3DEvent (
18768 in unsigned long type,
18769 in octetPtr data
18770 );
18771
18772 };
18773
18788 interface IFramebufferOverlay : IFramebuffer
18789 {
18793 readonly attribute unsigned long x;
18794
18798 readonly attribute unsigned long y;
18799
18805 attribute boolean visible;
18806
18813 attribute unsigned long alpha;
18814
18820 void move (
18821 in unsigned long x,
18822 in unsigned long y
18823 );
18824
18825 };
18826
18842 interface IDisplay : $unknown
18843 {
18847 void getScreenResolution (
18848 in unsigned long screenId,
18849 out unsigned long width,
18850 out unsigned long height,
18851 out unsigned long bitsPerPixel,
18852 out long xOrigin,
18853 out long yOrigin
18854 );
18855
18861 void setFramebuffer (
18862 in unsigned long screenId,
18863 in IFramebuffer framebuffer
18864 );
18865
18871 void getFramebuffer (
18872 in unsigned long screenId,
18873 out IFramebuffer framebuffer,
18874 out long xOrigin,
18875 out long yOrigin
18876 );
18877
18928 void setVideoModeHint (
18929 in unsigned long display,
18930 in boolean enabled,
18931 in boolean changeOrigin,
18932 in long originX,
18933 in long originY,
18934 in unsigned long width,
18935 in unsigned long height,
18936 in unsigned long bitsPerPixel
18937 );
18938
18950 void setSeamlessMode (
18951 in boolean enabled
18952 );
18953
18989 void takeScreenShot (
18990 in unsigned long screenId,
18991 in octetPtr address,
18992 in unsigned long width,
18993 in unsigned long height
18994 );
18995
19039 void takeScreenShotToArray (
19040 in unsigned long screenId,
19041 in unsigned long width,
19042 in unsigned long height,
19043 [retval] out octet[] screenData
19044 );
19045
19084 void takeScreenShotPNGToArray (
19085 in unsigned long screenId,
19086 in unsigned long width,
19087 in unsigned long height,
19088 [retval] out octet[] screenData
19089 );
19090
19142 void drawToScreen (
19143 in unsigned long screenId,
19144 in octetPtr address,
19145 in unsigned long x,
19146 in unsigned long y,
19147 in unsigned long width,
19148 in unsigned long height
19149 );
19150
19165 void invalidateAndUpdate();
19166
19180 void resizeCompleted (
19181 in unsigned long screenId
19182 );
19183
19196 void completeVHWACommand (
19197 in octetPtr command
19198 );
19199
19233 void viewportChanged (
19234 in unsigned long screenId,
19235 in unsigned long x,
19236 in unsigned long y,
19237 in unsigned long width,
19238 in unsigned long height
19239 );
19240
19241 };
19242
19258 interface INetworkAdapter : $unknown
19259 {
19267 attribute NetworkAdapterType adapterType;
19268
19276 readonly attribute unsigned long slot;
19277
19286 attribute boolean enabled;
19287
19294 attribute wstring MACAddress;
19295
19301 attribute NetworkAttachmentType attachmentType;
19302
19308 attribute wstring bridgedInterface;
19309
19315 attribute wstring hostOnlyInterface;
19316
19322 attribute wstring internalNetwork;
19323
19329 attribute wstring NATNetwork;
19330
19336 attribute wstring genericDriver;
19337
19344 attribute boolean cableConnected;
19345
19351 attribute unsigned long lineSpeed;
19352
19359 attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
19360
19367 attribute boolean traceEnabled;
19368
19375 attribute wstring traceFile;
19376
19384 readonly attribute INATEngine NATEngine;
19385
19392 attribute unsigned long bootPriority;
19393
19397 attribute IBandwidthGroup bandwidthGroup;
19398
19417 void getProperty (
19418 in wstring key,
19419 [retval] out wstring value
19420 );
19421
19440 void setProperty (
19441 in wstring key,
19442 in wstring value
19443 );
19444
19472 void getProperties (
19473 in wstring names,
19474 out wstring[] returnNames,
19475 [retval] out wstring[] returnValues
19476 );
19477
19478 };
19479
19508 interface ISerialPort : $unknown
19509 {
19517 readonly attribute unsigned long slot;
19518
19525 attribute boolean enabled;
19526
19530 attribute unsigned long IOBase;
19531
19535 attribute unsigned long IRQ;
19536
19547 attribute PortMode hostMode;
19548
19556 attribute boolean server;
19557
19567 attribute wstring path;
19568
19569 };
19570
19590 interface IParallelPort : $unknown
19591 {
19599 readonly attribute unsigned long slot;
19600
19607 attribute boolean enabled;
19608
19612 attribute unsigned long IOBase;
19613
19617 attribute unsigned long IRQ;
19618
19626 attribute wstring path;
19627
19628 };
19629
19630 interface IMachineDebugger : $unknown
19631 {
19635 attribute boolean singleStep;
19636
19640 attribute boolean recompileUser;
19641
19645 attribute boolean recompileSupervisor;
19646
19654 attribute boolean executeAllInIEM;
19655
19659 attribute boolean PATMEnabled;
19660
19664 attribute boolean CSAMEnabled;
19665
19669 attribute boolean logEnabled;
19670
19674 readonly attribute wstring logDbgFlags;
19675
19679 readonly attribute wstring logDbgGroups;
19680
19684 readonly attribute wstring logDbgDestinations;
19685
19689 readonly attribute wstring logRelFlags;
19690
19694 readonly attribute wstring logRelGroups;
19695
19699 readonly attribute wstring logRelDestinations;
19700
19707 readonly attribute boolean HWVirtExEnabled;
19708
19715 readonly attribute boolean HWVirtExNestedPagingEnabled;
19716
19723 readonly attribute boolean HWVirtExVPIDEnabled;
19724
19731 readonly attribute boolean HWVirtExUXEnabled;
19732
19741 readonly attribute wstring OSName;
19742
19751 readonly attribute wstring OSVersion;
19752
19759 readonly attribute boolean PAEEnabled;
19760
19767 attribute unsigned long virtualTimeRate;
19768
19776 readonly attribute long long VM;
19777
19793 void dumpGuestCore (
19794 in wstring filename,
19795 in wstring compression
19796 );
19797
19814 void dumpHostProcessCore (
19815 in wstring filename,
19816 in wstring compression
19817 );
19818
19839 void info (
19840 in wstring name,
19841 in wstring args,
19842 [retval] out wstring info
19843 );
19844
19850 void injectNMI();
19851
19862 void modifyLogGroups (
19863 in wstring settings
19864 );
19865
19876 void modifyLogFlags (
19877 in wstring settings
19878 );
19879
19890 void modifyLogDestinations (
19891 in wstring settings
19892 );
19893
19908 void readPhysicalMemory (
19909 in long long address,
19910 in unsigned long size,
19911 [retval] out octet[] bytes
19912 );
19913
19928 void writePhysicalMemory (
19929 in long long address,
19930 in unsigned long size,
19931 in octet[] bytes
19932 );
19933
19950 void readVirtualMemory (
19951 in unsigned long cpuId,
19952 in long long address,
19953 in unsigned long size,
19954 [retval] out octet[] bytes
19955 );
19956
19973 void writeVirtualMemory (
19974 in unsigned long cpuId,
19975 in long long address,
19976 in unsigned long size,
19977 in octet[] bytes
19978 );
19979
19992 void detectOS (
19993 [retval] out wstring os
19994 );
19995
20013 void getRegister (
20014 in unsigned long cpuId,
20015 in wstring name,
20016 [retval] out wstring value
20017 );
20018
20036 void getRegisters (
20037 in unsigned long cpuId,
20038 out wstring[] names,
20039 out wstring[] values
20040 );
20041
20060 void setRegister (
20061 in unsigned long cpuId,
20062 in wstring name,
20063 in wstring value
20064 );
20065
20084 void setRegisters (
20085 in unsigned long cpuId,
20086 in wstring[] names,
20087 in wstring[] values
20088 );
20089
20102 void dumpGuestStack (
20103 in unsigned long cpuId,
20104 [retval] out wstring stack
20105 );
20106
20114 void resetStats (
20115 in wstring pattern
20116 );
20117
20125 void dumpStats (
20126 in wstring pattern
20127 );
20128
20140 void getStats (
20141 in wstring pattern,
20142 in boolean withDescriptions,
20143 [retval] out wstring stats
20144 );
20145
20146 };
20147
20148 interface IUSBDeviceFilters : $unknown
20149 {
20175 readonly attribute IUSBDeviceFilter[] deviceFilters;
20176
20204 void createDeviceFilter (
20205 in wstring name,
20206 [retval] out IUSBDeviceFilter filter
20207 );
20208
20253 void insertDeviceFilter (
20254 in unsigned long position,
20255 in IUSBDeviceFilter filter
20256 );
20257
20290 void removeDeviceFilter (
20291 in unsigned long position,
20292 [retval] out IUSBDeviceFilter filter
20293 );
20294
20295 };
20296
20297 interface IUSBController : $unknown
20298 {
20304 readonly attribute wstring name;
20305
20311 readonly attribute USBControllerType type;
20312
20320 readonly attribute unsigned short USBStandard;
20321
20322 };
20323
20336 interface IUSBDevice : $unknown
20337 {
20344 readonly attribute wstringUUID id;
20345
20349 readonly attribute unsigned short vendorId;
20350
20354 readonly attribute unsigned short productId;
20355
20363 readonly attribute unsigned short revision;
20364
20368 readonly attribute wstring manufacturer;
20369
20373 readonly attribute wstring product;
20374
20378 readonly attribute wstring serialNumber;
20379
20383 readonly attribute wstring address;
20384
20391 readonly attribute unsigned short port;
20392
20398 readonly attribute unsigned short version;
20399
20407 readonly attribute unsigned short portVersion;
20408
20415 readonly attribute boolean remote;
20416
20417 };
20418
20493 interface IUSBDeviceFilter : $unknown
20494 {
20502 attribute wstring name;
20503
20507 attribute boolean active;
20508
20516 attribute wstring vendorId;
20517
20525 attribute wstring productId;
20526
20540 attribute wstring revision;
20541
20546 attribute wstring manufacturer;
20547
20552 attribute wstring product;
20553
20558 attribute wstring serialNumber;
20559
20564 attribute wstring port;
20565
20575 attribute wstring remote;
20576
20586 attribute unsigned long maskedInterfaces;
20587
20588 };
20589
20606 interface IHostUSBDevice : IUSBDevice
20607 {
20613 readonly attribute USBDeviceState state;
20614
20615 };
20616
20639 interface IHostUSBDeviceFilter : IUSBDeviceFilter
20640 {
20647 attribute USBDeviceFilterAction action;
20648
20649 };
20650
20659 interface IAudioAdapter : $unknown
20660 {
20669 attribute boolean enabled;
20670
20676 attribute AudioControllerType audioController;
20677
20684 attribute AudioDriverType audioDriver;
20685
20686 };
20687
20688 interface IVRDEServer : $unknown
20689 {
20693 attribute boolean enabled;
20694
20698 attribute AuthType authType;
20699
20703 attribute unsigned long authTimeout;
20704
20711 attribute boolean allowMultiConnection;
20712
20720 attribute boolean reuseSingleConnection;
20721
20728 attribute wstring VRDEExtPack;
20729
20736 attribute wstring authLibrary;
20737
20743 readonly attribute wstring[] VRDEProperties;
20744
20758 void setVRDEProperty (
20759 in wstring key,
20760 in wstring value
20761 );
20762
20776 void getVRDEProperty (
20777 in wstring key,
20778 [retval] out wstring value
20779 );
20780
20781 };
20782
20840 interface ISharedFolder : $unknown
20841 {
20845 readonly attribute wstring name;
20846
20850 readonly attribute wstring hostPath;
20851
20861 readonly attribute boolean accessible;
20862
20869 readonly attribute boolean writable;
20870
20876 readonly attribute boolean autoMount;
20877
20890 readonly attribute wstring lastAccessError;
20891
20892 };
20893
20894 interface IInternalSessionControl : $unknown
20895 {
20900 void getPID (
20901 [retval] out unsigned long pid
20902 );
20903
20925 void getRemoteConsole (
20926 [retval] out IConsole console
20927 );
20928
20943 void assignRemoteMachine (
20944 in IMachine machine,
20945 in IConsole console
20946 );
20947
20971 void updateMachineState (
20972 in MachineState machineState
20973 );
20974
20990 void uninitialize();
20991
21014 void onNetworkAdapterChange (
21015 in INetworkAdapter networkAdapter,
21016 in boolean changeAdapter
21017 );
21018
21041 void onSerialPortChange (
21042 in ISerialPort serialPort
21043 );
21044
21067 void onParallelPortChange (
21068 in IParallelPort parallelPort
21069 );
21070
21093 void onStorageControllerChange();
21094
21121 void onMediumChange (
21122 in IMediumAttachment mediumAttachment,
21123 in boolean force
21124 );
21125
21155 void onStorageDeviceChange (
21156 in IMediumAttachment mediumAttachment,
21157 in boolean remove,
21158 in boolean silent
21159 );
21160
21168 void onClipboardModeChange (
21169 in ClipboardMode clipboardMode
21170 );
21171
21179 void onDragAndDropModeChange (
21180 in DragAndDropMode dragAndDropMode
21181 );
21182
21192 void onCPUChange (
21193 in unsigned long cpu,
21194 in boolean add
21195 );
21196
21204 void onCPUExecutionCapChange (
21205 in unsigned long executionCap
21206 );
21207
21232 void onVRDEServerChange (
21233 in boolean restart
21234 );
21235
21241 void onVideoCaptureChange();
21242
21265 void onUSBControllerChange();
21266
21295 void onSharedFolderChange (
21296 in boolean global
21297 );
21298
21324 void onUSBDeviceAttach (
21325 in IUSBDevice device,
21326 in IVirtualBoxErrorInfo error,
21327 in unsigned long maskedInterfaces
21328 );
21329
21355 void onUSBDeviceDetach (
21356 in wstringUUID id,
21357 in IVirtualBoxErrorInfo error
21358 );
21359
21377 void onShowWindow (
21378 in boolean check,
21379 out boolean canShow,
21380 out long long winId
21381 );
21382
21390 void onBandwidthGroupChange (
21391 in IBandwidthGroup bandwidthGroup
21392 );
21393
21417 void accessGuestProperty (
21418 in wstring name,
21419 in wstring value,
21420 in wstring flags,
21421 in boolean isSetter,
21422 out wstring retValue,
21423 out long long retTimestamp,
21424 out wstring retFlags
21425 );
21426
21474 void enumerateGuestProperties (
21475 in wstring patterns,
21476 out wstring[] keys,
21477 out wstring[] values,
21478 out long long[] timestamps,
21479 out wstring[] flags
21480 );
21481
21527 void onlineMergeMedium (
21528 in IMediumAttachment mediumAttachment,
21529 in unsigned long sourceIdx,
21530 in unsigned long targetIdx,
21531 in IMedium source,
21532 in IMedium target,
21533 in boolean mergeForward,
21534 in IMedium parentForTarget,
21535 in IMedium[] childrenToReparent,
21536 in IProgress progress
21537 );
21538
21562 void enableVMMStatistics (
21563 in boolean enable
21564 );
21565
21593 void pauseWithReason (
21594 in Reason reason
21595 );
21596
21624 void resumeWithReason (
21625 in Reason reason
21626 );
21627
21657 void saveStateWithReason (
21658 in Reason reason,
21659 [retval] out IProgress progress
21660 );
21661
21685 void assignMachine (
21686 in IMachine machine,
21687 in LockType lockType,
21688 in wstring tokenId
21689 );
21690
21714 void assignMachine (
21715 in IMachine machine,
21716 in LockType lockType,
21717 in wstring tokenId
21718 );
21719
21720 };
21721
21780 interface ISession : $unknown
21781 {
21785 readonly attribute SessionState state;
21786
21794 readonly attribute SessionType type;
21795
21799 readonly attribute IMachine machine;
21800
21804 readonly attribute IConsole console;
21805
21837 void unlockMachine();
21838
21839 };
21840
21863 interface IStorageController : $unknown
21864 {
21873 readonly attribute wstring name;
21874
21880 readonly attribute unsigned long maxDevicesPerPortCount;
21881
21887 readonly attribute unsigned long minPortCount;
21888
21894 readonly attribute unsigned long maxPortCount;
21895
21901 attribute unsigned long instance;
21902
21911 attribute unsigned long portCount;
21912
21918 readonly attribute StorageBus bus;
21919
21932 attribute StorageControllerType controllerType;
21933
21948 attribute boolean useHostIOCache;
21949
21955 readonly attribute boolean bootable;
21956
21957 };
21958
21982 interface IManagedObjectRef : $unknown
21983 {
21990 void getInterfaceName (
21991 [retval] out wstring return
21992 );
21993
22001 void release();
22002
22003 };
22004
22013 interface IWebsessionManager : $unknown
22014 {
22023 void logon (
22024 in wstring username,
22025 in wstring password,
22026 [retval] out IVirtualBox return
22027 );
22028
22038 void getSessionObject (
22039 in IVirtualBox refIVirtualBox,
22040 [retval] out ISession return
22041 );
22042
22050 void logoff (
22051 in IVirtualBox refIVirtualBox
22052 );
22053
22054 };
22055
22064 interface IPerformanceMetric : $unknown
22065 {
22071 readonly attribute wstring metricName;
22072
22078 readonly attribute $unknown object;
22079
22085 readonly attribute wstring description;
22086
22092 readonly attribute unsigned long period;
22093
22103 readonly attribute unsigned long count;
22104
22110 readonly attribute wstring unit;
22111
22117 readonly attribute long minimumValue;
22118
22124 readonly attribute long maximumValue;
22125
22126 };
22127
22234 interface IPerformanceCollector : $unknown
22235 {
22246 readonly attribute wstring[] metricNames;
22247
22271 void getMetrics (
22272 in wstring[] metricNames,
22273 in $unknown[] objects,
22274 [retval] out IPerformanceMetric[] metrics
22275 );
22276
22315 void setupMetrics (
22316 in wstring[] metricNames,
22317 in $unknown[] objects,
22318 in unsigned long period,
22319 in unsigned long count,
22320 [retval] out IPerformanceMetric[] affectedMetrics
22321 );
22322
22351 void enableMetrics (
22352 in wstring[] metricNames,
22353 in $unknown[] objects,
22354 [retval] out IPerformanceMetric[] affectedMetrics
22355 );
22356
22385 void disableMetrics (
22386 in wstring[] metricNames,
22387 in $unknown[] objects,
22388 [retval] out IPerformanceMetric[] affectedMetrics
22389 );
22390
22480 void queryMetricsData (
22481 in wstring[] metricNames,
22482 in $unknown[] objects,
22483 out wstring[] returnMetricNames,
22484 out $unknown[] returnObjects,
22485 out wstring[] returnUnits,
22486 out unsigned long[] returnScales,
22487 out unsigned long[] returnSequenceNumbers,
22488 out unsigned long[] returnDataIndices,
22489 out unsigned long[] returnDataLengths,
22490 [retval] out long[] returnData
22491 );
22492
22493 };
22494
22502 interface INATEngine : $unknown
22503 {
22508 attribute wstring network;
22509
22516 attribute wstring hostIP;
22517
22522 attribute wstring TFTPPrefix;
22523
22528 attribute wstring TFTPBootFile;
22529
22537 attribute wstring TFTPNextServer;
22538
22542 attribute unsigned long aliasMode;
22543
22547 attribute boolean DNSPassDomain;
22548
22553 attribute boolean DNSProxy;
22554
22559 attribute boolean DNSUseHostResolver;
22560
22565 readonly attribute wstring[] redirects;
22566
22582 void setNetworkSettings (
22583 in unsigned long mtu,
22584 in unsigned long sockSnd,
22585 in unsigned long sockRcv,
22586 in unsigned long TcpWndSnd,
22587 in unsigned long TcpWndRcv
22588 );
22589
22594 void getNetworkSettings (
22595 out unsigned long mtu,
22596 out unsigned long sockSnd,
22597 out unsigned long sockRcv,
22598 out unsigned long TcpWndSnd,
22599 out unsigned long TcpWndRcv
22600 );
22601
22621 void addRedirect (
22622 in wstring name,
22623 in NATProtocol proto,
22624 in wstring hostIP,
22625 in unsigned short hostPort,
22626 in wstring guestIP,
22627 in unsigned short guestPort
22628 );
22629
22635 void removeRedirect (
22636 in wstring name
22637 );
22638
22639 };
22640
22649 interface IExtPackPlugIn : $unknown
22650 {
22654 readonly attribute wstring name;
22655
22659 readonly attribute wstring description;
22660
22666 readonly attribute wstring frontend;
22667
22671 readonly attribute wstring modulePath;
22672
22673 };
22674
22683 interface IExtPackBase : $unknown
22684 {
22688 readonly attribute wstring name;
22689
22693 readonly attribute wstring description;
22694
22706 readonly attribute wstring version;
22707
22711 readonly attribute unsigned long revision;
22712
22722 readonly attribute wstring edition;
22723
22727 readonly attribute wstring VRDEModule;
22728
22732 readonly attribute IExtPackPlugIn[] plugIns;
22733
22743 readonly attribute boolean usable;
22744
22751 readonly attribute wstring whyUnusable;
22752
22756 readonly attribute boolean showLicense;
22757
22766 readonly attribute wstring license;
22767
22791 void queryLicense (
22792 in wstring preferredLocale,
22793 in wstring preferredLanguage,
22794 in wstring format,
22795 [retval] out wstring licenseText
22796 );
22797
22798 };
22799
22808 interface IExtPack : IExtPackBase
22809 {
22821 void queryObject (
22822 in wstring objUuid,
22823 [retval] out $unknown returnInterface
22824 );
22825
22826 };
22827
22837 interface IExtPackFile : IExtPackBase
22838 {
22844 readonly attribute wstring filePath;
22845
22864 void install (
22865 in boolean replace,
22866 in wstring displayInfo,
22867 [retval] out IProgress progess
22868 );
22869
22870 };
22871
22882 interface IExtPackManager : $unknown
22883 {
22889 readonly attribute IExtPack[] installedExtPacks;
22890
22908 void find (
22909 in wstring name,
22910 [retval] out IExtPack returnData
22911 );
22912
22924 void openExtPackFile (
22925 in wstring path,
22926 [retval] out IExtPackFile file
22927 );
22928
22947 void uninstall (
22948 in wstring name,
22949 in boolean forcedRemoval,
22950 in wstring displayInfo,
22951 [retval] out IProgress progess
22952 );
22953
22957 void cleanup();
22958
22971 void queryAllPlugInsForFrontend (
22972 in wstring frontendName,
22973 [retval] out wstring[] plugInModules
22974 );
22975
22983 void isExtPackUsable (
22984 in wstring name,
22985 [retval] out boolean usable
22986 );
22987
22988 };
22989
22995 interface IBandwidthGroup : $unknown
22996 {
23000 readonly attribute wstring name;
23001
23005 readonly attribute BandwidthGroupType type;
23006
23010 readonly attribute unsigned long reference;
23011
23016 attribute long long maxBytesPerSec;
23017
23018 };
23019
23028 interface IBandwidthControl : $unknown
23029 {
23035 readonly attribute unsigned long numGroups;
23036
23049 void createBandwidthGroup (
23050 in wstring name,
23051 in BandwidthGroupType type,
23052 in long long maxBytesPerSec
23053 );
23054
23062 void deleteBandwidthGroup (
23063 in wstring name
23064 );
23065
23075 void getBandwidthGroup (
23076 in wstring name,
23077 [retval] out IBandwidthGroup bandwidthGroup
23078 );
23079
23087 void getAllBandwidthGroups (
23088 [retval] out IBandwidthGroup[] bandwidthGroups
23089 );
23090
23091 };
23092
23105 interface IVirtualBoxClient : $unknown
23106 {
23112 readonly attribute IVirtualBox virtualBox;
23113
23119 readonly attribute ISession session;
23120
23126 readonly attribute IEventSource eventSource;
23127
23138 void checkMachineError (
23139 in IMachine machine
23140 );
23141
23142 };
23143
23157 interface IEventSource : $unknown
23158 {
23164 void createListener (
23165 [retval] out IEventListener listener
23166 );
23167
23183 void createAggregator (
23184 in IEventSource[] subordinates,
23185 [retval] out IEventSource result
23186 );
23187
23220 void registerListener (
23221 in IEventListener listener,
23222 in VBoxEventType[] interesting,
23223 in boolean active
23224 );
23225
23234 void unregisterListener (
23235 in IEventListener listener
23236 );
23237
23252 void fireEvent (
23253 in IEvent event,
23254 in long timeout,
23255 [retval] out boolean result
23256 );
23257
23282 void getEvent (
23283 in IEventListener listener,
23284 in long timeout,
23285 [retval] out IEvent event
23286 );
23287
23299 void eventProcessed (
23300 in IEventListener listener,
23301 in IEvent event
23302 );
23303
23304 };
23305
23315 interface IEventListener : $unknown
23316 {
23329 void handleEvent (
23330 in IEvent event
23331 );
23332
23333 };
23334
23411 interface IEvent : $unknown
23412 {
23418 readonly attribute VBoxEventType type;
23419
23425 readonly attribute IEventSource source;
23426
23437 readonly attribute boolean waitable;
23438
23445 void setProcessed();
23446
23460 void waitProcessed (
23461 in long timeout,
23462 [retval] out boolean result
23463 );
23464
23465 };
23466
23472 interface IReusableEvent : IEvent
23473 {
23477 readonly attribute unsigned long generation;
23478
23485 void reuse();
23486
23487 };
23488
23494 interface IMachineEvent : IEvent
23495 {
23499 readonly attribute wstringUUID machineId;
23500
23501 };
23502
23508 interface IMachineStateChangedEvent : IMachineEvent
23509 {
23513 readonly attribute MachineState state;
23514
23515 };
23516
23524 interface IMachineDataChangedEvent : IMachineEvent
23525 {
23532 readonly attribute boolean temporary;
23533
23534 };
23535
23544 interface IMediumRegisteredEvent : IEvent
23545 {
23549 readonly attribute wstringUUID mediumId;
23550
23554 readonly attribute DeviceType mediumType;
23555
23562 readonly attribute boolean registered;
23563
23564 };
23565
23574 interface IMachineRegisteredEvent : IMachineEvent
23575 {
23582 readonly attribute boolean registered;
23583
23584 };
23585
23595 interface ISessionStateChangedEvent : IMachineEvent
23596 {
23602 readonly attribute SessionState state;
23603
23604 };
23605
23613 interface IGuestPropertyChangedEvent : IMachineEvent
23614 {
23620 readonly attribute wstring name;
23621
23627 readonly attribute wstring value;
23628
23634 readonly attribute wstring flags;
23635
23636 };
23637
23643 interface ISnapshotEvent : IMachineEvent
23644 {
23648 readonly attribute wstringUUID snapshotId;
23649
23650 };
23651
23661 interface ISnapshotTakenEvent : ISnapshotEvent
23662 {
23663 };
23664
23681 interface ISnapshotDeletedEvent : ISnapshotEvent
23682 {
23683 };
23684
23694 interface ISnapshotChangedEvent : ISnapshotEvent
23695 {
23696 };
23697
23706 interface IMousePointerShapeChangedEvent : IEvent
23707 {
23713 readonly attribute boolean visible;
23714
23720 readonly attribute boolean alpha;
23721
23727 readonly attribute unsigned long xhot;
23728
23734 readonly attribute unsigned long yhot;
23735
23741 readonly attribute unsigned long width;
23742
23748 readonly attribute unsigned long height;
23749
23782 readonly attribute octet[] shape;
23783
23784 };
23785
23794 interface IMouseCapabilityChangedEvent : IEvent
23795 {
23801 readonly attribute boolean supportsAbsolute;
23802
23808 readonly attribute boolean supportsRelative;
23809
23815 readonly attribute boolean supportsMultiTouch;
23816
23822 readonly attribute boolean needsHostCursor;
23823
23824 };
23825
23834 interface IKeyboardLedsChangedEvent : IEvent
23835 {
23841 readonly attribute boolean numLock;
23842
23848 readonly attribute boolean capsLock;
23849
23855 readonly attribute boolean scrollLock;
23856
23857 };
23858
23867 interface IStateChangedEvent : IEvent
23868 {
23874 readonly attribute MachineState state;
23875
23876 };
23877
23887 interface IAdditionsStateChangedEvent : IEvent
23888 {
23889 };
23890
23901 interface INetworkAdapterChangedEvent : IEvent
23902 {
23908 readonly attribute INetworkAdapter networkAdapter;
23909
23910 };
23911
23922 interface ISerialPortChangedEvent : IEvent
23923 {
23929 readonly attribute ISerialPort serialPort;
23930
23931 };
23932
23943 interface IParallelPortChangedEvent : IEvent
23944 {
23950 readonly attribute IParallelPort parallelPort;
23951
23952 };
23953
23963 interface IStorageControllerChangedEvent : IEvent
23964 {
23965 };
23966
23976 interface IMediumChangedEvent : IEvent
23977 {
23983 readonly attribute IMediumAttachment mediumAttachment;
23984
23985 };
23986
23994 interface IClipboardModeChangedEvent : IEvent
23995 {
24001 readonly attribute ClipboardMode clipboardMode;
24002
24003 };
24004
24012 interface IDragAndDropModeChangedEvent : IEvent
24013 {
24019 readonly attribute DragAndDropMode dragAndDropMode;
24020
24021 };
24022
24030 interface ICPUChangedEvent : IEvent
24031 {
24037 readonly attribute unsigned long CPU;
24038
24044 readonly attribute boolean add;
24045
24046 };
24047
24055 interface ICPUExecutionCapChangedEvent : IEvent
24056 {
24062 readonly attribute unsigned long executionCap;
24063
24064 };
24065
24073 interface IGuestKeyboardEvent : IEvent
24074 {
24080 readonly attribute long[] scancodes;
24081
24082 };
24083
24091 interface IGuestMouseEvent : IReusableEvent
24092 {
24098 readonly attribute GuestMouseEventMode mode;
24099
24105 readonly attribute long x;
24106
24112 readonly attribute long y;
24113
24119 readonly attribute long z;
24120
24126 readonly attribute long w;
24127
24133 readonly attribute long buttons;
24134
24135 };
24136
24144 interface IGuestMultiTouchEvent : IEvent
24145 {
24151 readonly attribute long contactCount;
24152
24158 readonly attribute short[] xPositions;
24159
24165 readonly attribute short[] yPositions;
24166
24172 readonly attribute unsigned short[] contactIds;
24173
24181 readonly attribute unsigned short[] contactFlags;
24182
24188 readonly attribute unsigned long scanTime;
24189
24190 };
24191
24197 interface IGuestSessionEvent : IEvent
24198 {
24202 readonly attribute IGuestSession session;
24203
24204 };
24205
24213 interface IGuestSessionStateChangedEvent : IGuestSessionEvent
24214 {
24220 readonly attribute unsigned long id;
24221
24227 readonly attribute GuestSessionStatus status;
24228
24238 readonly attribute IVirtualBoxErrorInfo error;
24239
24240 };
24241
24249 interface IGuestSessionRegisteredEvent : IGuestSessionEvent
24250 {
24257 readonly attribute boolean registered;
24258
24259 };
24260
24266 interface IGuestProcessEvent : IGuestSessionEvent
24267 {
24273 readonly attribute IGuestProcess process;
24274
24280 readonly attribute unsigned long pid;
24281
24282 };
24283
24291 interface IGuestProcessRegisteredEvent : IGuestProcessEvent
24292 {
24299 readonly attribute boolean registered;
24300
24301 };
24302
24310 interface IGuestProcessStateChangedEvent : IGuestProcessEvent
24311 {
24317 readonly attribute ProcessStatus status;
24318
24328 readonly attribute IVirtualBoxErrorInfo error;
24329
24330 };
24331
24339 interface IGuestProcessIOEvent : IGuestProcessEvent
24340 {
24347 readonly attribute unsigned long handle;
24348
24354 readonly attribute unsigned long processed;
24355
24356 };
24357
24367 interface IGuestProcessInputNotifyEvent : IGuestProcessIOEvent
24368 {
24374 readonly attribute ProcessInputStatus status;
24375
24376 };
24377
24385 interface IGuestProcessOutputEvent : IGuestProcessIOEvent
24386 {
24392 readonly attribute octet[] data;
24393
24394 };
24395
24401 interface IGuestFileEvent : IGuestSessionEvent
24402 {
24408 readonly attribute IGuestFile file;
24409
24410 };
24411
24419 interface IGuestFileRegisteredEvent : IGuestFileEvent
24420 {
24427 readonly attribute boolean registered;
24428
24429 };
24430
24438 interface IGuestFileStateChangedEvent : IGuestFileEvent
24439 {
24445 readonly attribute FileStatus status;
24446
24456 readonly attribute IVirtualBoxErrorInfo error;
24457
24458 };
24459
24467 interface IGuestFileIOEvent : IGuestFileEvent
24468 {
24474 readonly attribute long long offset;
24475
24481 readonly attribute unsigned long processed;
24482
24483 };
24484
24492 interface IGuestFileOffsetChangedEvent : IGuestFileIOEvent
24493 {
24494 };
24495
24503 interface IGuestFileReadEvent : IGuestFileIOEvent
24504 {
24510 readonly attribute octet[] data;
24511
24512 };
24513
24521 interface IGuestFileWriteEvent : IGuestFileIOEvent
24522 {
24523 };
24524
24535 interface IVRDEServerChangedEvent : IEvent
24536 {
24537 };
24538
24548 interface IVRDEServerInfoChangedEvent : IEvent
24549 {
24550 };
24551
24559 interface IVideoCaptureChangedEvent : IEvent
24560 {
24561 };
24562
24573 interface IUSBControllerChangedEvent : IEvent
24574 {
24575 };
24576
24600 interface IUSBDeviceStateChangedEvent : IEvent
24601 {
24607 readonly attribute IUSBDevice device;
24608
24614 readonly attribute boolean attached;
24615
24621 readonly attribute IVirtualBoxErrorInfo error;
24622
24623 };
24624
24640 interface ISharedFolderChangedEvent : IEvent
24641 {
24647 readonly attribute Scope scope;
24648
24649 };
24650
24702 interface IRuntimeErrorEvent : IEvent
24703 {
24709 readonly attribute boolean fatal;
24710
24716 readonly attribute wstring id;
24717
24723 readonly attribute wstring message;
24724
24725 };
24726
24734 interface IEventSourceChangedEvent : IEvent
24735 {
24741 readonly attribute IEventListener listener;
24742
24748 readonly attribute boolean add;
24749
24750 };
24751
24760 interface IExtraDataChangedEvent : IEvent
24761 {
24768 readonly attribute wstringUUID machineId;
24769
24775 readonly attribute wstring key;
24776
24782 readonly attribute wstring value;
24783
24784 };
24785
24791 interface IVetoEvent : IEvent
24792 {
24802 void addVeto (
24803 in wstring reason
24804 );
24805
24815 void isVetoed (
24816 [retval] out boolean result
24817 );
24818
24828 void getVetos (
24829 [retval] out wstring[] result
24830 );
24831
24832 };
24833
24843 interface IExtraDataCanChangeEvent : IVetoEvent
24844 {
24851 readonly attribute wstringUUID machineId;
24852
24858 readonly attribute wstring key;
24859
24865 readonly attribute wstring value;
24866
24867 };
24868
24884 interface ICanShowWindowEvent : IVetoEvent
24885 {
24886 };
24887
24919 interface IShowWindowEvent : IEvent
24920 {
24929 attribute long long winId;
24930
24931 };
24932
24940 interface INATRedirectEvent : IMachineEvent
24941 {
24947 readonly attribute unsigned long slot;
24948
24954 readonly attribute boolean remove;
24955
24961 readonly attribute wstring name;
24962
24968 readonly attribute NATProtocol proto;
24969
24975 readonly attribute wstring hostIP;
24976
24982 readonly attribute long hostPort;
24983
24989 readonly attribute wstring guestIP;
24990
24996 readonly attribute long guestPort;
24997
24998 };
24999
25012 interface IHostPCIDevicePlugEvent : IMachineEvent
25013 {
25019 readonly attribute boolean plugged;
25020
25027 readonly attribute boolean success;
25028
25034 readonly attribute IPCIDeviceAttachment attachment;
25035
25041 readonly attribute wstring message;
25042
25043 };
25044
25053 interface IVBoxSVCAvailabilityChangedEvent : IEvent
25054 {
25060 readonly attribute boolean available;
25061
25062 };
25063
25071 interface IBandwidthGroupChangedEvent : IEvent
25072 {
25078 readonly attribute IBandwidthGroup bandwidthGroup;
25079
25080 };
25081
25089 interface IGuestMonitorChangedEvent : IEvent
25090 {
25096 readonly attribute GuestMonitorChangedEventType changeType;
25097
25103 readonly attribute unsigned long screenId;
25104
25111 readonly attribute unsigned long originX;
25112
25119 readonly attribute unsigned long originY;
25120
25127 readonly attribute unsigned long width;
25128
25135 readonly attribute unsigned long height;
25136
25137 };
25138
25146 interface IGuestUserStateChangedEvent : IEvent
25147 {
25153 readonly attribute wstring name;
25154
25161 readonly attribute wstring domain;
25162
25169 readonly attribute GuestUserState state;
25170
25176 readonly attribute wstring stateDetails;
25177
25178 };
25179
25189 interface IStorageDeviceChangedEvent : IEvent
25190 {
25196 readonly attribute IMediumAttachment storageDevice;
25197
25203 readonly attribute boolean removed;
25204
25210 readonly attribute boolean silent;
25211
25212 };
25213
25214 interface INATNetworkChangedEvent : IEvent
25215 {
25216 readonly attribute wstring networkName;
25217
25218 };
25219
25220 interface INATNetworkStartStopEvent : INATNetworkChangedEvent
25221 {
25227 readonly attribute boolean startEvent;
25228
25229 };
25230
25231 interface INATNetworkAlterEvent : INATNetworkChangedEvent
25232 {
25233 };
25234
25235 interface INATNetworkCreationDeletionEvent : INATNetworkAlterEvent
25236 {
25237 readonly attribute boolean creationEvent;
25238
25239 };
25240
25241 interface INATNetworkSettingEvent : INATNetworkAlterEvent
25242 {
25243 readonly attribute boolean enabled;
25244
25245 readonly attribute wstring network;
25246
25247 readonly attribute wstring gateway;
25248
25249 readonly attribute boolean advertiseDefaultIPv6RouteEnabled;
25250
25251 readonly attribute boolean needDhcpServer;
25252
25253 };
25254
25255 interface INATNetworkPortForwardEvent : INATNetworkAlterEvent
25256 {
25257 readonly attribute boolean create;
25258
25259 readonly attribute boolean ipv6;
25260
25261 readonly attribute wstring name;
25262
25263 readonly attribute NATProtocol proto;
25264
25265 readonly attribute wstring hostIp;
25266
25267 readonly attribute long hostPort;
25268
25269 readonly attribute wstring guestIp;
25270
25271 readonly attribute long guestPort;
25272
25273 };
25274
25275