00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00137 const HRESULT VBOX_E_OBJECT_NOT_FOUND = 0x80BB0001;
00145 const HRESULT VBOX_E_INVALID_VM_STATE = 0x80BB0002;
00153 const HRESULT VBOX_E_VM_ERROR = 0x80BB0003;
00161 const HRESULT VBOX_E_FILE_ERROR = 0x80BB0004;
00169 const HRESULT VBOX_E_IPRT_ERROR = 0x80BB0005;
00177 const HRESULT VBOX_E_PDM_ERROR = 0x80BB0006;
00185 const HRESULT VBOX_E_INVALID_OBJECT_STATE = 0x80BB0007;
00193 const HRESULT VBOX_E_HOST_ERROR = 0x80BB0008;
00201 const HRESULT VBOX_E_NOT_SUPPORTED = 0x80BB0009;
00209 const HRESULT VBOX_E_XML_ERROR = 0x80BB000A;
00217 const HRESULT VBOX_E_INVALID_SESSION_STATE = 0x80BB000B;
00225 const HRESULT VBOX_E_OBJECT_IN_USE = 0x80BB000C;
00235 enum SettingsVersion
00236 {
00241 SettingsVersion_Null = 0,
00246 SettingsVersion_v1_0 = 1,
00251 SettingsVersion_v1_1 = 2,
00256 SettingsVersion_v1_2 = 3,
00261 SettingsVersion_v1_3pre = 4,
00266 SettingsVersion_v1_3 = 5,
00271 SettingsVersion_v1_4 = 6,
00276 SettingsVersion_v1_5 = 7,
00281 SettingsVersion_v1_6 = 8,
00286 SettingsVersion_v1_7 = 9,
00291 SettingsVersion_v1_8 = 10,
00296 SettingsVersion_v1_9 = 11,
00301 SettingsVersion_v1_10 = 12,
00306 SettingsVersion_v1_11 = 13,
00311 SettingsVersion_v1_12 = 14,
00316 SettingsVersion_v1_13 = 15,
00321 SettingsVersion_v1_14 = 16,
00326 SettingsVersion_Future = 99999,
00327 };
00328
00336 enum AccessMode
00337 {
00338 AccessMode_ReadOnly = 1,
00339 AccessMode_ReadWrite = 2,
00340 };
00341
00459 enum MachineState
00460 {
00465 MachineState_Null = 0,
00473 MachineState_PoweredOff = 1,
00482 MachineState_Saved = 2,
00491 MachineState_Teleported = 3,
00500 MachineState_Aborted = 4,
00507 MachineState_Running = 5,
00514 MachineState_Paused = 6,
00522 MachineState_Stuck = 7,
00532 MachineState_Teleporting = 8,
00543 MachineState_LiveSnapshotting = 9,
00551 MachineState_Starting = 10,
00559 MachineState_Stopping = 11,
00567 MachineState_Saving = 12,
00575 MachineState_Restoring = 13,
00584 MachineState_TeleportingPausedVM = 14,
00591 MachineState_TeleportingIn = 15,
00598 MachineState_FaultTolerantSyncing = 16,
00606 MachineState_DeletingSnapshotOnline = 17,
00614 MachineState_DeletingSnapshotPaused = 18,
00621 MachineState_RestoringSnapshot = 19,
00630 MachineState_DeletingSnapshot = 20,
00637 MachineState_SettingUp = 21,
00644 MachineState_FirstOnline = 5,
00651 MachineState_LastOnline = 18,
00658 MachineState_FirstTransient = 8,
00665 MachineState_LastTransient = 21,
00666 };
00667
00677 enum SessionState
00678 {
00683 SessionState_Null = 0,
00694 SessionState_Unlocked = 1,
00708 SessionState_Locked = 2,
00718 SessionState_Spawning = 3,
00725 SessionState_Unlocking = 4,
00726 };
00727
00736 enum CPUPropertyType
00737 {
00742 CPUPropertyType_Null = 0,
00751 CPUPropertyType_PAE = 1,
00759 CPUPropertyType_Synthetic = 2,
00767 CPUPropertyType_LongMode = 3,
00768 };
00769
00779 enum HWVirtExPropertyType
00780 {
00785 HWVirtExPropertyType_Null = 0,
00793 HWVirtExPropertyType_Enabled = 1,
00800 HWVirtExPropertyType_VPID = 2,
00807 HWVirtExPropertyType_NestedPaging = 3,
00814 HWVirtExPropertyType_UnrestrictedExecution = 4,
00821 HWVirtExPropertyType_LargePages = 5,
00829 HWVirtExPropertyType_Force = 6,
00830 };
00831
00839 enum FaultToleranceState
00840 {
00845 FaultToleranceState_Inactive = 1,
00850 FaultToleranceState_Master = 2,
00855 FaultToleranceState_Standby = 3,
00856 };
00857
00865 enum LockType
00866 {
00875 LockType_Write = 2,
00882 LockType_Shared = 1,
00888 LockType_VM = 3,
00889 };
00890
00899 enum SessionType
00900 {
00905 SessionType_Null = 0,
00913 SessionType_WriteLock = 1,
00920 SessionType_Remote = 2,
00927 SessionType_Shared = 3,
00928 };
00929
00937 enum DeviceType
00938 {
00946 DeviceType_Null = 0,
00951 DeviceType_Floppy = 1,
00956 DeviceType_DVD = 2,
00961 DeviceType_HardDisk = 3,
00966 DeviceType_Network = 4,
00971 DeviceType_USB = 5,
00976 DeviceType_SharedFolder = 6,
00977 };
00978
00986 enum DeviceActivity
00987 {
00988 DeviceActivity_Null = 0,
00989 DeviceActivity_Idle = 1,
00990 DeviceActivity_Reading = 2,
00991 DeviceActivity_Writing = 3,
00992 };
00993
01001 enum ClipboardMode
01002 {
01003 ClipboardMode_Disabled = 0,
01004 ClipboardMode_HostToGuest = 1,
01005 ClipboardMode_GuestToHost = 2,
01006 ClipboardMode_Bidirectional = 3,
01007 };
01008
01016 enum DragAndDropMode
01017 {
01018 DragAndDropMode_Disabled = 0,
01019 DragAndDropMode_HostToGuest = 1,
01020 DragAndDropMode_GuestToHost = 2,
01021 DragAndDropMode_Bidirectional = 3,
01022 };
01023
01034 enum Scope
01035 {
01036 Scope_Global = 0,
01037 Scope_Machine = 1,
01038 Scope_Session = 2,
01039 };
01040
01048 enum BIOSBootMenuMode
01049 {
01050 BIOSBootMenuMode_Disabled = 0,
01051 BIOSBootMenuMode_MenuOnly = 1,
01052 BIOSBootMenuMode_MessageAndMenu = 2,
01053 };
01054
01062 enum ProcessorFeature
01063 {
01064 ProcessorFeature_HWVirtEx = 0,
01065 ProcessorFeature_PAE = 1,
01066 ProcessorFeature_LongMode = 2,
01067 ProcessorFeature_NestedPaging = 3,
01068 };
01069
01077 enum FirmwareType
01078 {
01083 FirmwareType_BIOS = 1,
01088 FirmwareType_EFI = 2,
01093 FirmwareType_EFI32 = 3,
01098 FirmwareType_EFI64 = 4,
01103 FirmwareType_EFIDUAL = 5,
01104 };
01105
01113 enum PointingHIDType
01114 {
01119 PointingHIDType_None = 1,
01124 PointingHIDType_PS2Mouse = 2,
01129 PointingHIDType_USBMouse = 3,
01137 PointingHIDType_USBTablet = 4,
01145 PointingHIDType_ComboMouse = 5,
01152 PointingHIDType_USBMultiTouch = 6,
01153 };
01154
01162 enum KeyboardHIDType
01163 {
01168 KeyboardHIDType_None = 1,
01173 KeyboardHIDType_PS2Keyboard = 2,
01178 KeyboardHIDType_USBKeyboard = 3,
01184 KeyboardHIDType_ComboKeyboard = 4,
01185 };
01186
01187 enum DhcpOpt
01188 {
01189 DhcpOpt_SubnetMask = 1,
01190 DhcpOpt_TimeOffset = 2,
01191 DhcpOpt_Router = 3,
01192 DhcpOpt_TimeServer = 4,
01193 DhcpOpt_NameServer = 5,
01194 DhcpOpt_DomainNameServer = 6,
01195 DhcpOpt_LogServer = 7,
01196 DhcpOpt_Cookie = 8,
01197 DhcpOpt_LPRServer = 9,
01198 DhcpOpt_ImpressServer = 10,
01199 DhcpOpt_ResourseLocationServer = 11,
01200 DhcpOpt_HostName = 12,
01201 DhcpOpt_BootFileSize = 13,
01202 DhcpOpt_MeritDumpFile = 14,
01203 DhcpOpt_DomainName = 15,
01204 DhcpOpt_SwapServer = 16,
01205 DhcpOpt_RootPath = 17,
01206 DhcpOpt_ExtensionPath = 18,
01207 DhcpOpt_IPForwardingEnableDisable = 19,
01208 DhcpOpt_NonLocalSourceRoutingEnableDisable = 20,
01209 DhcpOpt_PolicyFilter = 21,
01210 DhcpOpt_MaximumDatagramReassemblySize = 22,
01211 DhcpOpt_DefaultIPTime2Live = 23,
01212 DhcpOpt_PathMTUAgingTimeout = 24,
01213 DhcpOpt_IPLayerParametersPerInterface = 25,
01214 DhcpOpt_InterfaceMTU = 26,
01215 DhcpOpt_AllSubnetsAreLocal = 27,
01216 DhcpOpt_BroadcastAddress = 28,
01217 DhcpOpt_PerformMaskDiscovery = 29,
01218 DhcpOpt_MaskSupplier = 30,
01219 DhcpOpt_PerformRouteDiscovery = 31,
01220 DhcpOpt_RouterSolicitationAddress = 32,
01221 DhcpOpt_StaticRoute = 33,
01222 DhcpOpt_TrailerEncapsulation = 34,
01223 DhcpOpt_ARPCacheTimeout = 35,
01224 DhcpOpt_EthernetEncapsulation = 36,
01225 DhcpOpt_TCPDefaultTTL = 37,
01226 DhcpOpt_TCPKeepAliveInterval = 38,
01227 DhcpOpt_TCPKeepAliveGarbage = 39,
01228 DhcpOpt_NetworkInformationServiceDomain = 40,
01229 DhcpOpt_NetworkInformationServiceServers = 41,
01230 DhcpOpt_NetworkTimeProtocolServers = 42,
01231 DhcpOpt_VendorSpecificInformation = 43,
01232 DhcpOpt_Option_44 = 44,
01233 DhcpOpt_Option_45 = 45,
01234 DhcpOpt_Option_46 = 46,
01235 DhcpOpt_Option_47 = 47,
01236 DhcpOpt_Option_48 = 48,
01237 DhcpOpt_Option_49 = 49,
01238 DhcpOpt_IPAddressLeaseTime = 51,
01239 DhcpOpt_Option_64 = 64,
01240 DhcpOpt_Option_65 = 65,
01241 DhcpOpt_TFTPServerName = 66,
01242 DhcpOpt_BootfileName = 67,
01243 DhcpOpt_Option_68 = 68,
01244 DhcpOpt_Option_69 = 69,
01245 DhcpOpt_Option_70 = 70,
01246 DhcpOpt_Option_71 = 71,
01247 DhcpOpt_Option_72 = 72,
01248 DhcpOpt_Option_73 = 73,
01249 DhcpOpt_Option_74 = 74,
01250 DhcpOpt_Option_75 = 75,
01251 DhcpOpt_Option_119 = 119,
01252 };
01253
01261 enum VFSType
01262 {
01263 VFSType_File = 1,
01264 VFSType_Cloud = 2,
01265 VFSType_S3 = 3,
01266 VFSType_WebDav = 4,
01267 };
01268
01276 enum VFSFileType
01277 {
01278 VFSFileType_Unknown = 1,
01279 VFSFileType_Fifo = 2,
01280 VFSFileType_DevChar = 3,
01281 VFSFileType_Directory = 4,
01282 VFSFileType_DevBlock = 5,
01283 VFSFileType_File = 6,
01284 VFSFileType_SymLink = 7,
01285 VFSFileType_Socket = 8,
01286 VFSFileType_WhiteOut = 9,
01287 };
01288
01296 enum ImportOptions
01297 {
01302 ImportOptions_KeepAllMACs = 1,
01307 ImportOptions_KeepNATMACs = 2,
01308 };
01309
01316 enum VirtualSystemDescriptionType
01317 {
01318 VirtualSystemDescriptionType_Ignore = 1,
01319 VirtualSystemDescriptionType_OS = 2,
01320 VirtualSystemDescriptionType_Name = 3,
01321 VirtualSystemDescriptionType_Product = 4,
01322 VirtualSystemDescriptionType_Vendor = 5,
01323 VirtualSystemDescriptionType_Version = 6,
01324 VirtualSystemDescriptionType_ProductUrl = 7,
01325 VirtualSystemDescriptionType_VendorUrl = 8,
01326 VirtualSystemDescriptionType_Description = 9,
01327 VirtualSystemDescriptionType_License = 10,
01328 VirtualSystemDescriptionType_Miscellaneous = 11,
01329 VirtualSystemDescriptionType_CPU = 12,
01330 VirtualSystemDescriptionType_Memory = 13,
01331 VirtualSystemDescriptionType_HardDiskControllerIDE = 14,
01332 VirtualSystemDescriptionType_HardDiskControllerSATA = 15,
01333 VirtualSystemDescriptionType_HardDiskControllerSCSI = 16,
01334 VirtualSystemDescriptionType_HardDiskControllerSAS = 17,
01335 VirtualSystemDescriptionType_HardDiskImage = 18,
01336 VirtualSystemDescriptionType_Floppy = 19,
01337 VirtualSystemDescriptionType_CDROM = 20,
01338 VirtualSystemDescriptionType_NetworkAdapter = 21,
01339 VirtualSystemDescriptionType_USBController = 22,
01340 VirtualSystemDescriptionType_SoundCard = 23,
01345 VirtualSystemDescriptionType_SettingsFile = 24,
01346 };
01347
01354 enum VirtualSystemDescriptionValueType
01355 {
01356 VirtualSystemDescriptionValueType_Reference = 1,
01357 VirtualSystemDescriptionValueType_Original = 2,
01358 VirtualSystemDescriptionValueType_Auto = 3,
01359 VirtualSystemDescriptionValueType_ExtraConfig = 4,
01360 };
01361
01368 enum GraphicsControllerType
01369 {
01374 GraphicsControllerType_Null = 0,
01379 GraphicsControllerType_VBoxVGA = 1,
01380 };
01381
01388 enum CleanupMode
01389 {
01394 CleanupMode_UnregisterOnly = 1,
01399 CleanupMode_DetachAllReturnNone = 2,
01404 CleanupMode_DetachAllReturnHardDisksOnly = 3,
01409 CleanupMode_Full = 4,
01410 };
01411
01419 enum CloneMode
01420 {
01425 CloneMode_MachineState = 1,
01430 CloneMode_MachineAndChildStates = 2,
01435 CloneMode_AllStates = 3,
01436 };
01437
01445 enum CloneOptions
01446 {
01451 CloneOptions_Link = 1,
01456 CloneOptions_KeepAllMACs = 2,
01461 CloneOptions_KeepNATMACs = 3,
01466 CloneOptions_KeepDiskNames = 4,
01467 };
01468
01476 enum AutostopType
01477 {
01482 AutostopType_Disabled = 1,
01487 AutostopType_SaveState = 2,
01492 AutostopType_PowerOff = 3,
01497 AutostopType_AcpiShutdown = 4,
01498 };
01499
01510 enum HostNetworkInterfaceMediumType
01511 {
01518 HostNetworkInterfaceMediumType_Unknown = 0,
01525 HostNetworkInterfaceMediumType_Ethernet = 1,
01532 HostNetworkInterfaceMediumType_PPP = 2,
01539 HostNetworkInterfaceMediumType_SLIP = 3,
01540 };
01541
01551 enum HostNetworkInterfaceStatus
01552 {
01559 HostNetworkInterfaceStatus_Unknown = 0,
01566 HostNetworkInterfaceStatus_Up = 1,
01573 HostNetworkInterfaceStatus_Down = 2,
01574 };
01575
01583 enum HostNetworkInterfaceType
01584 {
01585 HostNetworkInterfaceType_Bridged = 1,
01586 HostNetworkInterfaceType_HostOnly = 2,
01587 };
01588
01596 enum AdditionsFacilityType
01597 {
01602 AdditionsFacilityType_None = 0,
01607 AdditionsFacilityType_VBoxGuestDriver = 20,
01612 AdditionsFacilityType_AutoLogon = 90,
01617 AdditionsFacilityType_VBoxService = 100,
01622 AdditionsFacilityType_VBoxTrayClient = 101,
01627 AdditionsFacilityType_Seamless = 1000,
01635 AdditionsFacilityType_Graphics = 1100,
01640 AdditionsFacilityType_All = 2147483646,
01641 };
01642
01650 enum AdditionsFacilityClass
01651 {
01656 AdditionsFacilityClass_None = 0,
01661 AdditionsFacilityClass_Driver = 10,
01666 AdditionsFacilityClass_Service = 30,
01671 AdditionsFacilityClass_Program = 50,
01676 AdditionsFacilityClass_Feature = 100,
01681 AdditionsFacilityClass_ThirdParty = 999,
01686 AdditionsFacilityClass_All = 2147483646,
01687 };
01688
01696 enum AdditionsFacilityStatus
01697 {
01702 AdditionsFacilityStatus_Inactive = 0,
01707 AdditionsFacilityStatus_Paused = 1,
01712 AdditionsFacilityStatus_PreInit = 20,
01717 AdditionsFacilityStatus_Init = 30,
01722 AdditionsFacilityStatus_Active = 50,
01727 AdditionsFacilityStatus_Terminating = 100,
01732 AdditionsFacilityStatus_Terminated = 101,
01737 AdditionsFacilityStatus_Failed = 800,
01742 AdditionsFacilityStatus_Unknown = 999,
01743 };
01744
01752 enum AdditionsRunLevelType
01753 {
01758 AdditionsRunLevelType_None = 0,
01763 AdditionsRunLevelType_System = 1,
01768 AdditionsRunLevelType_Userland = 2,
01773 AdditionsRunLevelType_Desktop = 3,
01774 };
01775
01783 enum AdditionsUpdateFlag
01784 {
01789 AdditionsUpdateFlag_None = 0,
01797 AdditionsUpdateFlag_WaitForUpdateStartOnly = 1,
01798 };
01799
01808 enum GuestSessionStatus
01809 {
01814 GuestSessionStatus_Undefined = 0,
01819 GuestSessionStatus_Starting = 10,
01824 GuestSessionStatus_Started = 100,
01829 GuestSessionStatus_Terminating = 480,
01834 GuestSessionStatus_Terminated = 500,
01839 GuestSessionStatus_TimedOutKilled = 512,
01844 GuestSessionStatus_TimedOutAbnormally = 513,
01849 GuestSessionStatus_Down = 600,
01854 GuestSessionStatus_Error = 800,
01855 };
01856
01864 enum GuestSessionWaitForFlag
01865 {
01870 GuestSessionWaitForFlag_None = 0,
01875 GuestSessionWaitForFlag_Start = 1,
01880 GuestSessionWaitForFlag_Terminate = 2,
01885 GuestSessionWaitForFlag_Status = 4,
01886 };
01887
01901 enum GuestSessionWaitResult
01902 {
01907 GuestSessionWaitResult_None = 0,
01912 GuestSessionWaitResult_Start = 1,
01917 GuestSessionWaitResult_Terminate = 2,
01925 GuestSessionWaitResult_Status = 3,
01930 GuestSessionWaitResult_Error = 4,
01939 GuestSessionWaitResult_Timeout = 5,
01947 GuestSessionWaitResult_WaitFlagNotSupported = 6,
01948 };
01949
01957 enum GuestUserState
01958 {
01963 GuestUserState_Unknown = 0,
01972 GuestUserState_LoggedIn = 1,
01981 GuestUserState_LoggedOut = 2,
01991 GuestUserState_Locked = 3,
01999 GuestUserState_Unlocked = 4,
02007 GuestUserState_Disabled = 5,
02029 GuestUserState_Idle = 6,
02035 GuestUserState_InUse = 7,
02043 GuestUserState_Created = 8,
02051 GuestUserState_Deleted = 9,
02059 GuestUserState_SessionChanged = 10,
02069 GuestUserState_CredentialsChanged = 11,
02078 GuestUserState_RoleChanged = 12,
02087 GuestUserState_GroupAdded = 13,
02096 GuestUserState_GroupRemoved = 14,
02105 GuestUserState_Elevated = 15,
02106 };
02107
02115 enum FileSeekType
02116 {
02121 FileSeekType_Set = 0,
02126 FileSeekType_Current = 1,
02127 };
02128
02136 enum ProcessInputFlag
02137 {
02142 ProcessInputFlag_None = 0,
02147 ProcessInputFlag_EndOfFile = 1,
02148 };
02149
02158 enum ProcessOutputFlag
02159 {
02164 ProcessOutputFlag_None = 0,
02169 ProcessOutputFlag_StdErr = 1,
02170 };
02171
02179 enum ProcessWaitForFlag
02180 {
02185 ProcessWaitForFlag_None = 0,
02190 ProcessWaitForFlag_Start = 1,
02195 ProcessWaitForFlag_Terminate = 2,
02200 ProcessWaitForFlag_StdIn = 4,
02205 ProcessWaitForFlag_StdOut = 8,
02210 ProcessWaitForFlag_StdErr = 16,
02211 };
02212
02231 enum ProcessWaitResult
02232 {
02237 ProcessWaitResult_None = 0,
02242 ProcessWaitResult_Start = 1,
02247 ProcessWaitResult_Terminate = 2,
02255 ProcessWaitResult_Status = 3,
02260 ProcessWaitResult_Error = 4,
02269 ProcessWaitResult_Timeout = 5,
02276 ProcessWaitResult_StdIn = 6,
02281 ProcessWaitResult_StdOut = 7,
02286 ProcessWaitResult_StdErr = 8,
02294 ProcessWaitResult_WaitFlagNotSupported = 9,
02295 };
02296
02304 enum CopyFileFlag
02305 {
02310 CopyFileFlag_None = 0,
02315 CopyFileFlag_Recursive = 1,
02320 CopyFileFlag_Update = 2,
02325 CopyFileFlag_FollowLinks = 4,
02326 };
02327
02335 enum DirectoryCreateFlag
02336 {
02341 DirectoryCreateFlag_None = 0,
02346 DirectoryCreateFlag_Parents = 1,
02347 };
02348
02356 enum DirectoryRemoveRecFlag
02357 {
02362 DirectoryRemoveRecFlag_None = 0,
02367 DirectoryRemoveRecFlag_ContentAndDir = 1,
02372 DirectoryRemoveRecFlag_ContentOnly = 2,
02373 };
02374
02382 enum PathRenameFlag
02383 {
02388 PathRenameFlag_None = 0,
02393 PathRenameFlag_NoReplace = 1,
02398 PathRenameFlag_Replace = 2,
02403 PathRenameFlag_NoSymlinks = 4,
02404 };
02405
02413 enum ProcessCreateFlag
02414 {
02419 ProcessCreateFlag_None = 0,
02425 ProcessCreateFlag_WaitForProcessStartOnly = 1,
02430 ProcessCreateFlag_IgnoreOrphanedProcesses = 2,
02435 ProcessCreateFlag_Hidden = 4,
02440 ProcessCreateFlag_NoProfile = 8,
02445 ProcessCreateFlag_WaitForStdOut = 16,
02450 ProcessCreateFlag_WaitForStdErr = 32,
02455 ProcessCreateFlag_ExpandArguments = 64,
02456 };
02457
02465 enum ProcessPriority
02466 {
02471 ProcessPriority_Invalid = 0,
02476 ProcessPriority_Default = 1,
02477 };
02478
02486 enum SymlinkType
02487 {
02492 SymlinkType_Unknown = 0,
02497 SymlinkType_Directory = 1,
02502 SymlinkType_File = 2,
02503 };
02504
02512 enum SymlinkReadFlag
02513 {
02518 SymlinkReadFlag_None = 0,
02523 SymlinkReadFlag_NoSymlinks = 1,
02524 };
02525
02533 enum ProcessStatus
02534 {
02539 ProcessStatus_Undefined = 0,
02544 ProcessStatus_Starting = 10,
02549 ProcessStatus_Started = 100,
02554 ProcessStatus_Paused = 110,
02559 ProcessStatus_Terminating = 480,
02564 ProcessStatus_TerminatedNormally = 500,
02569 ProcessStatus_TerminatedSignal = 510,
02574 ProcessStatus_TerminatedAbnormally = 511,
02579 ProcessStatus_TimedOutKilled = 512,
02584 ProcessStatus_TimedOutAbnormally = 513,
02589 ProcessStatus_Down = 600,
02594 ProcessStatus_Error = 800,
02595 };
02596
02604 enum ProcessInputStatus
02605 {
02610 ProcessInputStatus_Undefined = 0,
02615 ProcessInputStatus_Broken = 1,
02620 ProcessInputStatus_Available = 10,
02625 ProcessInputStatus_Written = 50,
02630 ProcessInputStatus_Overflow = 100,
02631 };
02632
02640 enum FileStatus
02641 {
02646 FileStatus_Undefined = 0,
02651 FileStatus_Opening = 10,
02656 FileStatus_Open = 100,
02661 FileStatus_Closing = 150,
02666 FileStatus_Closed = 200,
02671 FileStatus_Down = 600,
02676 FileStatus_Error = 800,
02677 };
02678
02686 enum FsObjType
02687 {
02692 FsObjType_Undefined = 0,
02697 FsObjType_FIFO = 1,
02702 FsObjType_DevChar = 10,
02707 FsObjType_DevBlock = 11,
02712 FsObjType_Directory = 50,
02717 FsObjType_File = 80,
02722 FsObjType_Symlink = 100,
02727 FsObjType_Socket = 200,
02732 FsObjType_Whiteout = 400,
02733 };
02734
02742 enum DragAndDropAction
02743 {
02748 DragAndDropAction_Ignore = 0,
02753 DragAndDropAction_Copy = 1,
02758 DragAndDropAction_Move = 2,
02763 DragAndDropAction_Link = 3,
02764 };
02765
02773 enum DirectoryOpenFlag
02774 {
02779 DirectoryOpenFlag_None = 0,
02784 DirectoryOpenFlag_NoSymlinks = 1,
02785 };
02786
02796 enum MediumState
02797 {
02805 MediumState_NotCreated = 0,
02814 MediumState_Created = 1,
02822 MediumState_LockedRead = 2,
02830 MediumState_LockedWrite = 3,
02840 MediumState_Inaccessible = 4,
02847 MediumState_Creating = 5,
02854 MediumState_Deleting = 6,
02855 };
02856
02867 enum MediumType
02868 {
02876 MediumType_Normal = 0,
02884 MediumType_Immutable = 1,
02892 MediumType_Writethrough = 2,
02901 MediumType_Shareable = 3,
02910 MediumType_Readonly = 4,
02922 MediumType_MultiAttach = 5,
02923 };
02924
02934 enum MediumVariant
02935 {
02942 MediumVariant_Standard = 0,
02949 MediumVariant_VmdkSplit2G = 0x01,
02956 MediumVariant_VmdkRawDisk = 0x02,
02964 MediumVariant_VmdkStreamOptimized = 0x04,
02971 MediumVariant_VmdkESX = 0x08,
02978 MediumVariant_Fixed = 0x10000,
02985 MediumVariant_Diff = 0x20000,
02993 MediumVariant_NoCreateDir = 0x40000000,
02994 };
02995
02996 enum DataType
02997 {
02998 DataType_Int32 = 0,
02999 DataType_Int8 = 1,
03000 DataType_String = 2,
03001 };
03002
03003 enum DataFlags
03004 {
03005 DataFlags_None = 0x00,
03006 DataFlags_Mandatory = 0x01,
03007 DataFlags_Expert = 0x02,
03008 DataFlags_Array = 0x04,
03009 DataFlags_FlagMask = 0x07,
03010 };
03011
03019 enum MediumFormatCapabilities
03020 {
03027 MediumFormatCapabilities_Uuid = 0x01,
03034 MediumFormatCapabilities_CreateFixed = 0x02,
03042 MediumFormatCapabilities_CreateDynamic = 0x04,
03049 MediumFormatCapabilities_CreateSplit2G = 0x08,
03056 MediumFormatCapabilities_Differencing = 0x10,
03063 MediumFormatCapabilities_Asynchronous = 0x20,
03073 MediumFormatCapabilities_File = 0x40,
03082 MediumFormatCapabilities_Properties = 0x80,
03089 MediumFormatCapabilities_TcpNetworking = 0x100,
03096 MediumFormatCapabilities_VFS = 0x200,
03097 MediumFormatCapabilities_CapabilityMask = 0x3FF,
03098 };
03099
03107 enum MouseButtonState
03108 {
03109 MouseButtonState_LeftButton = 0x01,
03110 MouseButtonState_RightButton = 0x02,
03111 MouseButtonState_MiddleButton = 0x04,
03112 MouseButtonState_WheelUp = 0x08,
03113 MouseButtonState_WheelDown = 0x10,
03114 MouseButtonState_XButton1 = 0x20,
03115 MouseButtonState_XButton2 = 0x40,
03116 MouseButtonState_MouseStateMask = 0x7F,
03117 };
03118
03126 enum TouchContactState
03127 {
03132 TouchContactState_None = 0x00,
03137 TouchContactState_InContact = 0x01,
03144 TouchContactState_InRange = 0x02,
03145 TouchContactState_ContactStateMask = 0x03,
03146 };
03147
03158 enum FramebufferPixelFormat
03159 {
03167 FramebufferPixelFormat_Opaque = 0,
03175 FramebufferPixelFormat_FOURCC_RGB = 0x32424752,
03176 };
03177
03185 enum NetworkAttachmentType
03186 {
03191 NetworkAttachmentType_Null = 0,
03192 NetworkAttachmentType_NAT = 1,
03193 NetworkAttachmentType_Bridged = 2,
03194 NetworkAttachmentType_Internal = 3,
03195 NetworkAttachmentType_HostOnly = 4,
03196 NetworkAttachmentType_Generic = 5,
03197 NetworkAttachmentType_NATNetwork = 6,
03198 };
03199
03207 enum NetworkAdapterType
03208 {
03213 NetworkAdapterType_Null = 0,
03218 NetworkAdapterType_Am79C970A = 1,
03223 NetworkAdapterType_Am79C973 = 2,
03228 NetworkAdapterType_I82540EM = 3,
03233 NetworkAdapterType_I82543GC = 4,
03238 NetworkAdapterType_I82545EM = 5,
03243 NetworkAdapterType_Virtio = 6,
03244 };
03245
03253 enum NetworkAdapterPromiscModePolicy
03254 {
03259 NetworkAdapterPromiscModePolicy_Deny = 1,
03267 NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
03275 NetworkAdapterPromiscModePolicy_AllowAll = 3,
03276 };
03277
03286 enum PortMode
03287 {
03292 PortMode_Disconnected = 0,
03297 PortMode_HostPipe = 1,
03302 PortMode_HostDevice = 2,
03307 PortMode_RawFile = 3,
03308 };
03309
03317 enum USBControllerType
03318 {
03323 USBControllerType_Null = 0,
03324 USBControllerType_OHCI = 1,
03325 USBControllerType_EHCI = 2,
03330 USBControllerType_Last = 3,
03331 };
03332
03371 enum USBDeviceState
03372 {
03379 USBDeviceState_NotSupported = 0,
03387 USBDeviceState_Unavailable = 1,
03394 USBDeviceState_Busy = 2,
03402 USBDeviceState_Available = 3,
03410 USBDeviceState_Held = 4,
03418 USBDeviceState_Captured = 5,
03419 };
03420
03430 enum USBDeviceFilterAction
03431 {
03436 USBDeviceFilterAction_Null = 0,
03441 USBDeviceFilterAction_Ignore = 1,
03446 USBDeviceFilterAction_Hold = 2,
03447 };
03448
03456 enum AudioDriverType
03457 {
03462 AudioDriverType_Null = 0,
03467 AudioDriverType_WinMM = 1,
03472 AudioDriverType_OSS = 2,
03477 AudioDriverType_ALSA = 3,
03482 AudioDriverType_DirectSound = 4,
03487 AudioDriverType_CoreAudio = 5,
03492 AudioDriverType_MMPM = 6,
03497 AudioDriverType_Pulse = 7,
03502 AudioDriverType_SolAudio = 8,
03503 };
03504
03512 enum AudioControllerType
03513 {
03514 AudioControllerType_AC97 = 0,
03515 AudioControllerType_SB16 = 1,
03516 AudioControllerType_HDA = 2,
03517 };
03518
03526 enum AuthType
03527 {
03532 AuthType_Null = 0,
03533 AuthType_External = 1,
03534 AuthType_Guest = 2,
03535 };
03536
03544 enum Reason
03545 {
03550 Reason_Unspecified = 0,
03555 Reason_HostSuspend = 1,
03560 Reason_HostResume = 2,
03565 Reason_HostBatteryLow = 3,
03566 };
03567
03576 enum StorageBus
03577 {
03582 StorageBus_Null = 0,
03583 StorageBus_IDE = 1,
03584 StorageBus_SATA = 2,
03585 StorageBus_SCSI = 3,
03586 StorageBus_Floppy = 4,
03587 StorageBus_SAS = 5,
03588 };
03589
03598 enum StorageControllerType
03599 {
03604 StorageControllerType_Null = 0,
03609 StorageControllerType_LsiLogic = 1,
03614 StorageControllerType_BusLogic = 2,
03619 StorageControllerType_IntelAhci = 3,
03624 StorageControllerType_PIIX3 = 4,
03629 StorageControllerType_PIIX4 = 5,
03634 StorageControllerType_ICH6 = 6,
03639 StorageControllerType_I82078 = 7,
03644 StorageControllerType_LsiLogicSas = 8,
03645 };
03646
03654 enum ChipsetType
03655 {
03660 ChipsetType_Null = 0,
03665 ChipsetType_PIIX3 = 1,
03670 ChipsetType_ICH9 = 2,
03671 };
03672
03678 enum NATAliasMode
03679 {
03684 NATAliasMode_AliasLog = 0x1,
03689 NATAliasMode_AliasProxyOnly = 0x02,
03694 NATAliasMode_AliasUseSamePorts = 0x04,
03695 };
03696
03702 enum NATProtocol
03703 {
03708 NATProtocol_UDP = 0,
03713 NATProtocol_TCP = 1,
03714 };
03715
03723 enum BandwidthGroupType
03724 {
03731 BandwidthGroupType_Null = 0,
03738 BandwidthGroupType_Disk = 1,
03745 BandwidthGroupType_Network = 2,
03746 };
03747
03756 enum VBoxEventType
03757 {
03764 VBoxEventType_Invalid = 0,
03773 VBoxEventType_Any = 1,
03781 VBoxEventType_Vetoable = 2,
03789 VBoxEventType_MachineEvent = 3,
03797 VBoxEventType_SnapshotEvent = 4,
03806 VBoxEventType_InputEvent = 5,
03813 VBoxEventType_LastWildcard = 31,
03820 VBoxEventType_OnMachineStateChanged = 32,
03827 VBoxEventType_OnMachineDataChanged = 33,
03834 VBoxEventType_OnExtraDataChanged = 34,
03841 VBoxEventType_OnExtraDataCanChange = 35,
03848 VBoxEventType_OnMediumRegistered = 36,
03855 VBoxEventType_OnMachineRegistered = 37,
03862 VBoxEventType_OnSessionStateChanged = 38,
03869 VBoxEventType_OnSnapshotTaken = 39,
03876 VBoxEventType_OnSnapshotDeleted = 40,
03883 VBoxEventType_OnSnapshotChanged = 41,
03890 VBoxEventType_OnGuestPropertyChanged = 42,
03897 VBoxEventType_OnMousePointerShapeChanged = 43,
03904 VBoxEventType_OnMouseCapabilityChanged = 44,
03911 VBoxEventType_OnKeyboardLedsChanged = 45,
03918 VBoxEventType_OnStateChanged = 46,
03925 VBoxEventType_OnAdditionsStateChanged = 47,
03932 VBoxEventType_OnNetworkAdapterChanged = 48,
03939 VBoxEventType_OnSerialPortChanged = 49,
03946 VBoxEventType_OnParallelPortChanged = 50,
03953 VBoxEventType_OnStorageControllerChanged = 51,
03960 VBoxEventType_OnMediumChanged = 52,
03967 VBoxEventType_OnVRDEServerChanged = 53,
03974 VBoxEventType_OnUSBControllerChanged = 54,
03981 VBoxEventType_OnUSBDeviceStateChanged = 55,
03988 VBoxEventType_OnSharedFolderChanged = 56,
03995 VBoxEventType_OnRuntimeError = 57,
04002 VBoxEventType_OnCanShowWindow = 58,
04009 VBoxEventType_OnShowWindow = 59,
04016 VBoxEventType_OnCPUChanged = 60,
04023 VBoxEventType_OnVRDEServerInfoChanged = 61,
04030 VBoxEventType_OnEventSourceChanged = 62,
04037 VBoxEventType_OnCPUExecutionCapChanged = 63,
04044 VBoxEventType_OnGuestKeyboard = 64,
04051 VBoxEventType_OnGuestMouse = 65,
04058 VBoxEventType_OnNATRedirect = 66,
04065 VBoxEventType_OnHostPCIDevicePlug = 67,
04072 VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
04079 VBoxEventType_OnBandwidthGroupChanged = 69,
04086 VBoxEventType_OnGuestMonitorChanged = 70,
04093 VBoxEventType_OnStorageDeviceChanged = 71,
04100 VBoxEventType_OnClipboardModeChanged = 72,
04107 VBoxEventType_OnDragAndDropModeChanged = 73,
04114 VBoxEventType_OnNATNetworkChanged = 74,
04121 VBoxEventType_OnNATNetworkStartStop = 75,
04128 VBoxEventType_OnNATNetworkAlter = 76,
04135 VBoxEventType_OnNATNetworkCreationDeletion = 77,
04142 VBoxEventType_OnNATNetworkSetting = 78,
04149 VBoxEventType_OnNATNetworkPortForward = 79,
04156 VBoxEventType_OnGuestSessionStateChanged = 80,
04163 VBoxEventType_OnGuestSessionRegistered = 81,
04170 VBoxEventType_OnGuestProcessRegistered = 82,
04177 VBoxEventType_OnGuestProcessStateChanged = 83,
04184 VBoxEventType_OnGuestProcessInputNotify = 84,
04191 VBoxEventType_OnGuestProcessOutput = 85,
04198 VBoxEventType_OnGuestFileRegistered = 86,
04205 VBoxEventType_OnGuestFileStateChanged = 87,
04212 VBoxEventType_OnGuestFileOffsetChanged = 88,
04220 VBoxEventType_OnGuestFileRead = 89,
04228 VBoxEventType_OnGuestFileWrite = 90,
04235 VBoxEventType_OnVideoCaptureChanged = 91,
04242 VBoxEventType_OnGuestUserStateChanged = 92,
04249 VBoxEventType_OnGuestMultiTouch = 93,
04256 VBoxEventType_Last = 94,
04257 };
04258
04270 enum GuestMouseEventMode
04271 {
04278 GuestMouseEventMode_Relative = 0,
04285 GuestMouseEventMode_Absolute = 1,
04286 };
04287
04295 enum GuestMonitorChangedEventType
04296 {
04303 GuestMonitorChangedEventType_Enabled = 0,
04310 GuestMonitorChangedEventType_Disabled = 1,
04317 GuestMonitorChangedEventType_NewOrigin = 2,
04318 };
04319
04353 interface IVirtualBoxErrorInfo : $errorinfo
04354 {
04372 readonly attribute long resultCode;
04373
04380 readonly attribute long resultDetail;
04381
04393 readonly attribute wstringUUID interfaceID;
04394
04405 readonly attribute wstring component;
04406
04417 readonly attribute wstring text;
04418
04429 readonly attribute IVirtualBoxErrorInfo next;
04430
04431 };
04432
04433 interface INATNetwork : $unknown
04434 {
04443 attribute wstring networkName;
04444
04445 attribute boolean enabled;
04446
04455 attribute wstring network;
04456
04463 readonly attribute wstring gateway;
04464
04470 attribute boolean IPv6Enabled;
04471
04479 attribute wstring IPv6Prefix;
04480
04481 attribute boolean advertiseDefaultIPv6RouteEnabled;
04482
04483 attribute boolean needDhcpServer;
04484
04485 readonly attribute IEventSource eventSource;
04486
04493 readonly attribute wstring[] portForwardRules4;
04494
04499 readonly attribute wstring[] localMappings;
04500
04505 attribute long loopbackIp6;
04506
04512 readonly attribute wstring[] portForwardRules6;
04513
04517 void addLocalMapping (
04518 in wstring hostid,
04519 in long offset
04520 );
04521
04522 void addPortForwardRule (
04523 in boolean isIpv6,
04524 in wstring ruleName,
04525 in NATProtocol proto,
04526 in wstring hostIP,
04527 in unsigned short hostPort,
04528 in wstring guestIP,
04529 in unsigned short guestPort
04530 );
04531
04532 void removePortForwardRule (
04533 in boolean iSipv6,
04534 in wstring ruleName
04535 );
04536
04537 void start (
04538 in wstring trunkType
04539 );
04540
04541 void stop();
04542
04543 };
04544
04555 interface IDHCPServer : $unknown
04556 {
04557 readonly attribute IEventSource eventSource;
04558
04564 attribute boolean enabled;
04565
04571 readonly attribute wstring IPAddress;
04572
04578 readonly attribute wstring networkMask;
04579
04585 readonly attribute wstring networkName;
04586
04592 readonly attribute wstring lowerIP;
04593
04599 readonly attribute wstring upperIP;
04600
04601 readonly attribute wstring[] globalOptions;
04602
04603 readonly attribute wstring[] vmConfigs;
04604
04605 void addGlobalOption (
04606 in DhcpOpt option,
04607 in wstring value
04608 );
04609
04610 void addVmSlotOption (
04611 in wstring vmname,
04612 in long slot,
04613 in DhcpOpt option,
04614 in wstring value
04615 );
04616
04617 void removeVmSlotOptions (
04618 in wstring vmname,
04619 in long slot
04620 );
04621
04622 void getVmSlotOptions (
04623 in wstring vmname,
04624 in long slot,
04625 [retval] out wstring[] option
04626 );
04627
04628 void getMacOptions (
04629 in wstring mac,
04630 [retval] out wstring[] option
04631 );
04632
04661 void setConfiguration (
04662 in wstring IPAddress,
04663 in wstring networkMask,
04664 in wstring FromIPAddress,
04665 in wstring ToIPAddress
04666 );
04667
04692 void start (
04693 in wstring networkName,
04694 in wstring trunkName,
04695 in wstring trunkType
04696 );
04697
04710 void stop();
04711
04712 };
04713
04732 interface IVirtualBox : $unknown
04733 {
04746 readonly attribute wstring version;
04747
04755 readonly attribute wstring versionNormalized;
04756
04762 readonly attribute unsigned long revision;
04763
04773 readonly attribute wstring packageType;
04774
04786 readonly attribute wstring APIVersion;
04787
04803 readonly attribute wstring homeFolder;
04804
04812 readonly attribute wstring settingsFilePath;
04813
04817 readonly attribute IHost host;
04818
04822 readonly attribute ISystemProperties systemProperties;
04823
04829 readonly attribute IMachine[] machines;
04830
04840 readonly attribute wstring[] machineGroups;
04841
04851 readonly attribute IMedium[] hardDisks;
04852
04858 readonly attribute IMedium[] DVDImages;
04859
04865 readonly attribute IMedium[] floppyImages;
04866
04867 readonly attribute IProgress[] progressOperations;
04868
04869 readonly attribute IGuestOSType[] guestOSTypes;
04870
04887 readonly attribute ISharedFolder[] sharedFolders;
04888
04894 readonly attribute IPerformanceCollector performanceCollector;
04895
04901 readonly attribute IDHCPServer[] DHCPServers;
04902
04903 readonly attribute INATNetwork[] NATNetworks;
04904
04910 readonly attribute IEventSource eventSource;
04911
04917 readonly attribute IExtPackManager extensionPackManager;
04918
04924 readonly attribute wstring[] internalNetworks;
04925
04931 readonly attribute wstring[] genericNetworkDrivers;
04932
04983 void composeMachineFilename (
04984 in wstring name,
04985 in wstring group,
04986 in wstring createFlags,
04987 in wstring baseFolder,
04988 [retval] out wstring file
04989 );
04990
05097 void createMachine (
05098 in wstring settingsFile,
05099 in wstring name,
05100 in wstring[] groups,
05101 in wstring osTypeId,
05102 in wstring flags,
05103 [retval] out IMachine machine
05104 );
05105
05136 void openMachine (
05137 in wstring settingsFile,
05138 [retval] out IMachine machine
05139 );
05140
05172 void registerMachine (
05173 in IMachine machine
05174 );
05175
05196 void findMachine (
05197 in wstring nameOrId,
05198 [retval] out IMachine machine
05199 );
05200
05212 void getMachinesByGroups (
05213 in wstring[] groups,
05214 [retval] out IMachine[] machines
05215 );
05216
05226 void getMachineStates (
05227 in IMachine[] machines,
05228 [retval] out MachineState[] states
05229 );
05230
05240 void createAppliance (
05241 [retval] out IAppliance appliance
05242 );
05243
05306 void createHardDisk (
05307 in wstring format,
05308 in wstring location,
05309 [retval] out IMedium medium
05310 );
05311
05417 void openMedium (
05418 in wstring location,
05419 in DeviceType deviceType,
05420 in AccessMode accessMode,
05421 in boolean forceNewUuid,
05422 [retval] out IMedium medium
05423 );
05424
05453 void getGuestOSType (
05454 in wstringUUID id,
05455 [retval] out IGuestOSType type
05456 );
05457
05480 void createSharedFolder (
05481 in wstring name,
05482 in wstring hostPath,
05483 in boolean writable,
05484 in boolean automount
05485 );
05486
05501 void removeSharedFolder (
05502 in wstring name
05503 );
05504
05513 void getExtraDataKeys (
05514 [retval] out wstring[] keys
05515 );
05516
05545 void getExtraData (
05546 in wstring key,
05547 [retval] out wstring value
05548 );
05549
05599 void setExtraData (
05600 in wstring key,
05601 in wstring value
05602 );
05603
05622 void setSettingsSecret (
05623 in wstring password
05624 );
05625
05642 void createDHCPServer (
05643 in wstring name,
05644 [retval] out IDHCPServer server
05645 );
05646
05663 void findDHCPServerByNetworkName (
05664 in wstring name,
05665 [retval] out IDHCPServer server
05666 );
05667
05682 void removeDHCPServer (
05683 in IDHCPServer server
05684 );
05685
05686 void createNATNetwork (
05687 in wstring networkName,
05688 [retval] out INATNetwork network
05689 );
05690
05691 void findNATNetworkByName (
05692 in wstring networkName,
05693 [retval] out INATNetwork network
05694 );
05695
05696 void removeNATNetwork (
05697 in INATNetwork network
05698 );
05699
05724 void checkFirmwarePresent (
05725 in FirmwareType firmwareType,
05726 in wstring version,
05727 out wstring url,
05728 out wstring file,
05729 [retval] out boolean result
05730 );
05731
05732 };
05733
05744 interface IVFSExplorer : $unknown
05745 {
05749 readonly attribute wstring path;
05750
05754 readonly attribute VFSType type;
05755
05763 void update (
05764 [retval] out IProgress progress
05765 );
05766
05774 void cd (
05775 in wstring dir,
05776 [retval] out IProgress progress
05777 );
05778
05784 void cdUp (
05785 [retval] out IProgress progress
05786 );
05787
05800 void entryList (
05801 out wstring[] names,
05802 out unsigned long[] types,
05803 out long long[] sizes,
05804 out unsigned long[] modes
05805 );
05806
05815 void exists (
05816 in wstring[] names,
05817 [retval] out wstring[] exists
05818 );
05819
05827 void remove (
05828 in wstring[] names,
05829 [retval] out IProgress progress
05830 );
05831
05832 };
05833
05899 interface IAppliance : $unknown
05900 {
05908 readonly attribute wstring path;
05909
05940 readonly attribute wstring[] disks;
05941
05949 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
05950
05958 readonly attribute wstring[] machines;
05959
05976 void read (
05977 in wstring file,
05978 [retval] out IProgress progress
05979 );
05980
05997 void interpret();
05998
06021 void importMachines (
06022 in ImportOptions[] options,
06023 [retval] out IProgress progress
06024 );
06025
06033 void createVFSExplorer (
06034 in wstring URI,
06035 [retval] out IVFSExplorer explorer
06036 );
06037
06067 void write (
06068 in wstring format,
06069 in boolean manifest,
06070 in wstring path,
06071 [retval] out IProgress progress
06072 );
06073
06079 void getWarnings (
06080 [retval] out wstring[] warnings
06081 );
06082
06083 };
06084
06096 interface IVirtualSystemDescription : $unknown
06097 {
06101 readonly attribute unsigned long count;
06102
06226 void getDescription (
06227 out VirtualSystemDescriptionType[] types,
06228 out wstring[] refs,
06229 out wstring[] OVFValues,
06230 out wstring[] VBoxValues,
06231 out wstring[] extraConfigValues
06232 );
06233
06250 void getDescriptionByType (
06251 in VirtualSystemDescriptionType type,
06252 out VirtualSystemDescriptionType[] types,
06253 out wstring[] refs,
06254 out wstring[] OVFValues,
06255 out wstring[] VBoxValues,
06256 out wstring[] extraConfigValues
06257 );
06258
06270 void getValuesByType (
06271 in VirtualSystemDescriptionType type,
06272 in VirtualSystemDescriptionValueType which,
06273 [retval] out wstring[] values
06274 );
06275
06301 void setFinalValues (
06302 in boolean[] enabled,
06303 in wstring[] VBoxValues,
06304 in wstring[] extraConfigValues
06305 );
06306
06321 void addDescription (
06322 in VirtualSystemDescriptionType type,
06323 in wstring VBoxValue,
06324 in wstring extraConfigValue
06325 );
06326
06327 };
06328
06329 interface IInternalMachineControl : $unknown
06330 {
06337 void setRemoveSavedStateFile (
06338 in boolean remove
06339 );
06340
06352 void updateState (
06353 in MachineState state
06354 );
06355
06367 void beginPowerUp (
06368 in IProgress progress
06369 );
06370
06380 void endPowerUp (
06381 in long result
06382 );
06383
06395 void beginPoweringDown (
06396 out IProgress progress
06397 );
06398
06428 void endPoweringDown (
06429 in long result,
06430 in wstring errMsg
06431 );
06432
06446 void runUSBDeviceFilters (
06447 in IUSBDevice device,
06448 out boolean matched,
06449 out unsigned long maskedInterfaces
06450 );
06451
06460 void captureUSBDevice (
06461 in wstringUUID id
06462 );
06463
06479 void detachUSBDevice (
06480 in wstringUUID id,
06481 in boolean done
06482 );
06483
06492 void autoCaptureUSBDevices();
06493
06509 void detachAllUSBDevices (
06510 in boolean done
06511 );
06512
06527 void onSessionEnd (
06528 in ISession session,
06529 [retval] out IProgress progress
06530 );
06531
06547 void beginSavingState (
06548 out IProgress progress,
06549 out wstring stateFilePath
06550 );
06551
06581 void endSavingState (
06582 in long result,
06583 in wstring errMsg
06584 );
06585
06600 void adoptSavedState (
06601 in wstring savedStateFile
06602 );
06603
06652 void beginTakingSnapshot (
06653 in IConsole initiator,
06654 in wstring name,
06655 in wstring description,
06656 in IProgress consoleProgress,
06657 in boolean fTakingSnapshotOnline,
06658 out wstring stateFilePath
06659 );
06660
06670 void endTakingSnapshot (
06671 in boolean success
06672 );
06673
06702 void deleteSnapshot (
06703 in IConsole initiator,
06704 in wstringUUID startId,
06705 in wstringUUID endId,
06706 in boolean deleteAllChildren,
06707 out MachineState machineState,
06708 [retval] out IProgress progress
06709 );
06710
06717 void finishOnlineMergeMedium();
06718
06732 void restoreSnapshot (
06733 in IConsole initiator,
06734 in ISnapshot snapshot,
06735 out MachineState machineState,
06736 [retval] out IProgress progress
06737 );
06738
06765 void pullGuestProperties (
06766 out wstring[] names,
06767 out wstring[] values,
06768 out long long[] timestamps,
06769 out wstring[] flags
06770 );
06771
06793 void pushGuestProperty (
06794 in wstring name,
06795 in wstring value,
06796 in long long timestamp,
06797 in wstring flags
06798 );
06799
06811 void lockMedia();
06812
06822 void unlockMedia();
06823
06839 void ejectMedium (
06840 in IMediumAttachment attachment,
06841 [retval] out IMediumAttachment newAttachment
06842 );
06843
06884 void reportVmStatistics (
06885 in unsigned long validStats,
06886 in unsigned long cpuUser,
06887 in unsigned long cpuKernel,
06888 in unsigned long cpuIdle,
06889 in unsigned long memTotal,
06890 in unsigned long memFree,
06891 in unsigned long memBalloon,
06892 in unsigned long memShared,
06893 in unsigned long memCache,
06894 in unsigned long pagedTotal,
06895 in unsigned long memAllocTotal,
06896 in unsigned long memFreeTotal,
06897 in unsigned long memBalloonTotal,
06898 in unsigned long memSharedTotal,
06899 in unsigned long vmNetRx,
06900 in unsigned long vmNetTx
06901 );
06902
06903 };
06904
06913 interface IBIOSSettings : $unknown
06914 {
06918 attribute boolean logoFadeIn;
06919
06923 attribute boolean logoFadeOut;
06924
06928 attribute unsigned long logoDisplayTime;
06929
06936 attribute wstring logoImagePath;
06937
06941 attribute BIOSBootMenuMode bootMenuMode;
06942
06946 attribute boolean ACPIEnabled;
06947
06954 attribute boolean IOAPICEnabled;
06955
06965 attribute long long timeOffset;
06966
06973 attribute boolean PXEDebugEnabled;
06974
06975 };
06976
06984 interface IPCIAddress : $unknown
06985 {
06991 attribute short bus;
06992
06998 attribute short device;
06999
07005 attribute short devFunction;
07006
07012 void asLong (
07013 [retval] out long result
07014 );
07015
07021 void fromLong (
07022 in long number
07023 );
07024
07025 };
07026
07034 interface IPCIDeviceAttachment : $unknown
07035 {
07041 readonly attribute wstring name;
07042
07048 readonly attribute boolean isPhysicalDevice;
07049
07055 readonly attribute long hostAddress;
07056
07062 readonly attribute long guestAddress;
07063
07064 };
07065
07106 interface IMachine : $unknown
07107 {
07111 readonly attribute IVirtualBox parent;
07112
07116 attribute octet[] icon;
07117
07167 readonly attribute boolean accessible;
07168
07180 readonly attribute IVirtualBoxErrorInfo accessError;
07181
07221 attribute wstring name;
07222
07233 attribute wstring description;
07234
07238 readonly attribute wstringUUID id;
07239
07250 attribute wstring[] groups;
07251
07266 attribute wstring OSTypeId;
07267
07271 attribute wstring hardwareVersion;
07272
07282 attribute wstringUUID hardwareUUID;
07283
07287 attribute unsigned long CPUCount;
07288
07294 attribute boolean CPUHotPlugEnabled;
07295
07303 attribute unsigned long CPUExecutionCap;
07304
07308 attribute unsigned long memorySize;
07309
07313 attribute unsigned long memoryBalloonSize;
07314
07321 attribute boolean pageFusionEnabled;
07322
07326 attribute GraphicsControllerType graphicsControllerType;
07327
07331 attribute unsigned long VRAMSize;
07332
07338 attribute boolean accelerate3DEnabled;
07339
07345 attribute boolean accelerate2DVideoEnabled;
07346
07357 attribute unsigned long monitorCount;
07358
07364 attribute boolean videoCaptureEnabled;
07365
07371 attribute boolean[] videoCaptureScreens;
07372
07386 attribute wstring videoCaptureFile;
07387
07395 attribute unsigned long videoCaptureWidth;
07396
07404 attribute unsigned long videoCaptureHeight;
07405
07414 attribute unsigned long videoCaptureRate;
07415
07425 attribute unsigned long videoCaptureFPS;
07426
07430 readonly attribute IBIOSSettings BIOSSettings;
07431
07436 attribute FirmwareType firmwareType;
07437
07443 attribute PointingHIDType pointingHIDType;
07444
07450 attribute KeyboardHIDType keyboardHIDType;
07451
07458 attribute boolean HPETEnabled;
07459
07463 attribute ChipsetType chipsetType;
07464
07498 attribute wstring snapshotFolder;
07499
07503 readonly attribute IVRDEServer VRDEServer;
07504
07505 attribute boolean emulatedUSBCardReaderEnabled;
07506
07510 readonly attribute IMediumAttachment[] mediumAttachments;
07511
07523 readonly attribute IUSBController[] USBControllers;
07524
07536 readonly attribute IUSBDeviceFilters USBDeviceFilters;
07537
07541 readonly attribute IAudioAdapter audioAdapter;
07542
07546 readonly attribute IStorageController[] storageControllers;
07547
07553 readonly attribute wstring settingsFilePath;
07554
07579 readonly attribute boolean settingsModified;
07580
07584 readonly attribute SessionState sessionState;
07585
07598 readonly attribute wstring sessionType;
07599
07609 readonly attribute unsigned long sessionPID;
07610
07614 readonly attribute MachineState state;
07615
07622 readonly attribute long long lastStateChange;
07623
07635 readonly attribute wstring stateFilePath;
07636
07646 readonly attribute wstring logFolder;
07647
07658 readonly attribute ISnapshot currentSnapshot;
07659
07666 readonly attribute unsigned long snapshotCount;
07667
07699 readonly attribute boolean currentStateModified;
07700
07712 readonly attribute ISharedFolder[] sharedFolders;
07713
07720 attribute ClipboardMode clipboardMode;
07721
07727 attribute DragAndDropMode dragAndDropMode;
07728
07736 attribute wstring guestPropertyNotificationPatterns;
07737
07746 attribute boolean teleporterEnabled;
07747
07758 attribute unsigned long teleporterPort;
07759
07766 attribute wstring teleporterAddress;
07767
07778 attribute wstring teleporterPassword;
07779
07787 attribute FaultToleranceState faultToleranceState;
07788
07795 attribute unsigned long faultTolerancePort;
07796
07802 attribute wstring faultToleranceAddress;
07803
07811 attribute wstring faultTolerancePassword;
07812
07818 attribute unsigned long faultToleranceSyncInterval;
07819
07827 attribute boolean RTCUseUTC;
07828
07835 attribute boolean IOCacheEnabled;
07836
07842 attribute unsigned long IOCacheSize;
07843
07853 readonly attribute IPCIDeviceAttachment[] PCIDeviceAssignments;
07854
07860 readonly attribute IBandwidthControl bandwidthControl;
07861
07870 attribute boolean tracingEnabled;
07871
07886 attribute wstring tracingConfig;
07887
07900 attribute boolean allowTracingToAccessVM;
07901
07907 attribute boolean autostartEnabled;
07908
07914 attribute unsigned long autostartDelay;
07915
07921 attribute AutostopType autostopType;
07922
07938 attribute wstring defaultFrontend;
07939
07945 readonly attribute boolean USBProxyAvailable;
07946
08052 void lockMachine (
08053 in ISession session,
08054 in LockType lockType
08055 );
08056
08193 void launchVMProcess (
08194 in ISession session,
08195 in wstring type,
08196 in wstring environment,
08197 [retval] out IProgress progress
08198 );
08199
08237 void setBootOrder (
08238 in unsigned long position,
08239 in DeviceType device
08240 );
08241
08276 void getBootOrder (
08277 in unsigned long position,
08278 [retval] out DeviceType device
08279 );
08280
08382 void attachDevice (
08383 in wstring name,
08384 in long controllerPort,
08385 in long device,
08386 in DeviceType type,
08387 in IMedium medium
08388 );
08389
08485 void attachDeviceWithoutMedium (
08486 in wstring name,
08487 in long controllerPort,
08488 in long device,
08489 in DeviceType type
08490 );
08491
08545 void detachDevice (
08546 in wstring name,
08547 in long controllerPort,
08548 in long device
08549 );
08550
08593 void passthroughDevice (
08594 in wstring name,
08595 in long controllerPort,
08596 in long device,
08597 in boolean passthrough
08598 );
08599
08642 void temporaryEjectDevice (
08643 in wstring name,
08644 in long controllerPort,
08645 in long device,
08646 in boolean temporaryEject
08647 );
08648
08694 void nonRotationalDevice (
08695 in wstring name,
08696 in long controllerPort,
08697 in long device,
08698 in boolean nonRotational
08699 );
08700
08746 void setAutoDiscardForDevice (
08747 in wstring name,
08748 in long controllerPort,
08749 in long device,
08750 in boolean discard
08751 );
08752
08793 void setBandwidthGroupForDevice (
08794 in wstring name,
08795 in long controllerPort,
08796 in long device,
08797 in IBandwidthGroup bandwidthGroup
08798 );
08799
08836 void setNoBandwidthGroupForDevice (
08837 in wstring name,
08838 in long controllerPort,
08839 in long device
08840 );
08841
08906 void unmountMedium (
08907 in wstring name,
08908 in long controllerPort,
08909 in long device,
08910 in boolean force
08911 );
08912
08975 void mountMedium (
08976 in wstring name,
08977 in long controllerPort,
08978 in long device,
08979 in IMedium medium,
08980 in boolean force
08981 );
08982
09011 void getMedium (
09012 in wstring name,
09013 in long controllerPort,
09014 in long device,
09015 [retval] out IMedium medium
09016 );
09017
09032 void getMediumAttachmentsOfController (
09033 in wstring name,
09034 [retval] out IMediumAttachment[] mediumAttachments
09035 );
09036
09051 void getMediumAttachment (
09052 in wstring name,
09053 in long controllerPort,
09054 in long device,
09055 [retval] out IMediumAttachment attachment
09056 );
09057
09098 void attachHostPCIDevice (
09099 in long hostAddress,
09100 in long desiredGuestAddress,
09101 in boolean tryToUnbind
09102 );
09103
09144 void detachHostPCIDevice (
09145 in long hostAddress
09146 );
09147
09165 void getNetworkAdapter (
09166 in unsigned long slot,
09167 [retval] out INetworkAdapter adapter
09168 );
09169
09202 void addStorageController (
09203 in wstring name,
09204 in StorageBus connectionType,
09205 [retval] out IStorageController controller
09206 );
09207
09221 void getStorageControllerByName (
09222 in wstring name,
09223 [retval] out IStorageController storageController
09224 );
09225
09239 void getStorageControllerByInstance (
09240 in unsigned long instance,
09241 [retval] out IStorageController storageController
09242 );
09243
09266 void removeStorageController (
09267 in wstring name
09268 );
09269
09291 void setStorageControllerBootable (
09292 in wstring name,
09293 in boolean bootable
09294 );
09295
09318 void addUSBController (
09319 in wstring name,
09320 in USBControllerType type,
09321 [retval] out IUSBController controller
09322 );
09323
09337 void removeUSBController (
09338 in wstring name
09339 );
09340
09354 void getUSBControllerByName (
09355 in wstring name,
09356 [retval] out IUSBController controller
09357 );
09358
09364 void getUSBControllerCountByType (
09365 in USBControllerType type,
09366 [retval] out unsigned long controllers
09367 );
09368
09386 void getSerialPort (
09387 in unsigned long slot,
09388 [retval] out ISerialPort port
09389 );
09390
09408 void getParallelPort (
09409 in unsigned long slot,
09410 [retval] out IParallelPort port
09411 );
09412
09421 void getExtraDataKeys (
09422 [retval] out wstring[] keys
09423 );
09424
09453 void getExtraData (
09454 in wstring key,
09455 [retval] out wstring value
09456 );
09457
09507 void setExtraData (
09508 in wstring key,
09509 in wstring value
09510 );
09511
09533 void getCPUProperty (
09534 in CPUPropertyType property,
09535 [retval] out boolean value
09536 );
09537
09559 void setCPUProperty (
09560 in CPUPropertyType property,
09561 in boolean value
09562 );
09563
09603 void getCPUIDLeaf (
09604 in unsigned long id,
09605 out unsigned long valEax,
09606 out unsigned long valEbx,
09607 out unsigned long valEcx,
09608 out unsigned long valEdx
09609 );
09610
09654 void setCPUIDLeaf (
09655 in unsigned long id,
09656 in unsigned long valEax,
09657 in unsigned long valEbx,
09658 in unsigned long valEcx,
09659 in unsigned long valEdx
09660 );
09661
09679 void removeCPUIDLeaf (
09680 in unsigned long id
09681 );
09682
09688 void removeAllCPUIDLeaves();
09689
09711 void getHWVirtExProperty (
09712 in HWVirtExPropertyType property,
09713 [retval] out boolean value
09714 );
09715
09737 void setHWVirtExProperty (
09738 in HWVirtExPropertyType property,
09739 in boolean value
09740 );
09741
09771 void setSettingsFilePath (
09772 in wstring settingsFilePath,
09773 [retval] out IProgress progress
09774 );
09775
09821 void saveSettings();
09822
09846 void discardSettings();
09847
09931 void unregister (
09932 in CleanupMode cleanupMode,
09933 [retval] out IMedium[] media
09934 );
09935
09992 void deleteConfig (
09993 in IMedium[] media,
09994 [retval] out IProgress progress
09995 );
09996
10008 void exportTo (
10009 in IAppliance appliance,
10010 in wstring location,
10011 [retval] out IVirtualSystemDescription description
10012 );
10013
10037 void findSnapshot (
10038 in wstring nameOrId,
10039 [retval] out ISnapshot snapshot
10040 );
10041
10075 void createSharedFolder (
10076 in wstring name,
10077 in wstring hostPath,
10078 in boolean writable,
10079 in boolean automount
10080 );
10081
10107 void removeSharedFolder (
10108 in wstring name
10109 );
10110
10134 void canShowConsoleWindow (
10135 [retval] out boolean canShow
10136 );
10137
10172 void showConsoleWindow (
10173 [retval] out long long winId
10174 );
10175
10208 void getGuestProperty (
10209 in wstring name,
10210 out wstring value,
10211 out long long timestamp,
10212 out wstring flags
10213 );
10214
10237 void getGuestPropertyValue (
10238 in wstring property,
10239 [retval] out wstring value
10240 );
10241
10264 void getGuestPropertyTimestamp (
10265 in wstring property,
10266 [retval] out long long value
10267 );
10268
10319 void setGuestProperty (
10320 in wstring property,
10321 in wstring value,
10322 in wstring flags
10323 );
10324
10364 void setGuestPropertyValue (
10365 in wstring property,
10366 in wstring value
10367 );
10368
10386 void deleteGuestProperty (
10387 in wstring name
10388 );
10389
10420 void enumerateGuestProperties (
10421 in wstring patterns,
10422 out wstring[] names,
10423 out wstring[] values,
10424 out long long[] timestamps,
10425 out wstring[] flags
10426 );
10427
10457 void querySavedGuestScreenInfo (
10458 in unsigned long screenId,
10459 out unsigned long originX,
10460 out unsigned long originY,
10461 out unsigned long width,
10462 out unsigned long height,
10463 out boolean enabled
10464 );
10465
10487 void querySavedThumbnailSize (
10488 in unsigned long screenId,
10489 out unsigned long size,
10490 out unsigned long width,
10491 out unsigned long height
10492 );
10493
10520 void readSavedThumbnailToArray (
10521 in unsigned long screenId,
10522 in boolean BGR,
10523 out unsigned long width,
10524 out unsigned long height,
10525 [retval] out octet[] data
10526 );
10527
10549 void readSavedThumbnailPNGToArray (
10550 in unsigned long screenId,
10551 out unsigned long width,
10552 out unsigned long height,
10553 [retval] out octet[] data
10554 );
10555
10577 void querySavedScreenshotPNGSize (
10578 in unsigned long screenId,
10579 out unsigned long size,
10580 out unsigned long width,
10581 out unsigned long height
10582 );
10583
10605 void readSavedScreenshotPNGToArray (
10606 in unsigned long screenId,
10607 out unsigned long width,
10608 out unsigned long height,
10609 [retval] out octet[] data
10610 );
10611
10621 void hotPlugCPU (
10622 in unsigned long cpu
10623 );
10624
10634 void hotUnplugCPU (
10635 in unsigned long cpu
10636 );
10637
10651 void getCPUStatus (
10652 in unsigned long cpu,
10653 [retval] out boolean attached
10654 );
10655
10670 void queryLogFilename (
10671 in unsigned long idx,
10672 [retval] out wstring filename
10673 );
10674
10700 void readLog (
10701 in unsigned long idx,
10702 in long long offset,
10703 in long long size,
10704 [retval] out octet[] data
10705 );
10706
10739 void cloneTo (
10740 in IMachine target,
10741 in CloneMode mode,
10742 in CloneOptions[] options,
10743 [retval] out IProgress progress
10744 );
10745
10746 };
10747
10755 interface IEmulatedUSB : $unknown
10756 {
10760 readonly attribute wstring[] webcams;
10761
10771 void webcamAttach (
10772 in wstring path,
10773 in wstring settings
10774 );
10775
10783 void webcamDetach (
10784 in wstring path
10785 );
10786
10787 };
10788
10797 interface IVRDEServerInfo : $unknown
10798 {
10804 readonly attribute boolean active;
10805
10814 readonly attribute long port;
10815
10821 readonly attribute unsigned long numberOfClients;
10822
10828 readonly attribute long long beginTime;
10829
10836 readonly attribute long long endTime;
10837
10843 readonly attribute long long bytesSent;
10844
10850 readonly attribute long long bytesSentTotal;
10851
10857 readonly attribute long long bytesReceived;
10858
10864 readonly attribute long long bytesReceivedTotal;
10865
10871 readonly attribute wstring user;
10872
10878 readonly attribute wstring domain;
10879
10885 readonly attribute wstring clientName;
10886
10892 readonly attribute wstring clientIP;
10893
10899 readonly attribute unsigned long clientVersion;
10900
10908 readonly attribute unsigned long encryptionStyle;
10909
10910 };
10911
10933 interface IConsole : $unknown
10934 {
10946 readonly attribute IMachine machine;
10947
10961 readonly attribute MachineState state;
10962
10966 readonly attribute IGuest guest;
10967
10978 readonly attribute IKeyboard keyboard;
10979
10990 readonly attribute IMouse mouse;
10991
11001 readonly attribute IDisplay display;
11002
11006 readonly attribute IMachineDebugger debugger;
11007
11018 readonly attribute IUSBDevice[] USBDevices;
11019
11027 readonly attribute IHostUSBDevice[] remoteUSBDevices;
11028
11044 readonly attribute ISharedFolder[] sharedFolders;
11045
11051 readonly attribute IVRDEServerInfo VRDEServerInfo;
11052
11058 readonly attribute IEventSource eventSource;
11059
11063 readonly attribute IPCIDeviceAttachment[] attachedPCIDevices;
11064
11073 attribute boolean useHostClipboard;
11074
11080 readonly attribute IEmulatedUSB emulatedUSB;
11081
11146 void powerUp (
11147 [retval] out IProgress progress
11148 );
11149
11183 void powerUpPaused (
11184 [retval] out IProgress progress
11185 );
11186
11206 void powerDown (
11207 [retval] out IProgress progress
11208 );
11209
11229 void reset();
11230
11250 void pause();
11251
11271 void resume();
11272
11292 void powerButton();
11293
11313 void sleepButton();
11314
11326 void getPowerButtonHandled (
11327 [retval] out boolean handled
11328 );
11329
11343 void getGuestEnteredACPIMode (
11344 [retval] out boolean entered
11345 );
11346
11399 void saveState (
11400 [retval] out IProgress progress
11401 );
11402
11435 void adoptSavedState (
11436 in wstring savedStateFile
11437 );
11438
11469 void discardSavedState (
11470 in boolean fRemoveFile
11471 );
11472
11485 void getDeviceActivity (
11486 in DeviceType type,
11487 [retval] out DeviceActivity activity
11488 );
11489
11527 void attachUSBDevice (
11528 in wstringUUID id
11529 );
11530
11565 void detachUSBDevice (
11566 in wstringUUID id,
11567 [retval] out IUSBDevice device
11568 );
11569
11592 void findUSBDeviceByAddress (
11593 in wstring name,
11594 [retval] out IUSBDevice device
11595 );
11596
11616 void findUSBDeviceById (
11617 in wstringUUID id,
11618 [retval] out IUSBDevice device
11619 );
11620
11654 void createSharedFolder (
11655 in wstring name,
11656 in wstring hostPath,
11657 in boolean writable,
11658 in boolean automount
11659 );
11660
11685 void removeSharedFolder (
11686 in wstring name
11687 );
11688
11726 void takeSnapshot (
11727 in wstring name,
11728 in wstring description,
11729 [retval] out IProgress progress
11730 );
11731
11804 void deleteSnapshot (
11805 in wstringUUID id,
11806 [retval] out IProgress progress
11807 );
11808
11848 void deleteSnapshotAndAllChildren (
11849 in wstringUUID id,
11850 [retval] out IProgress progress
11851 );
11852
11896 void deleteSnapshotRange (
11897 in wstringUUID startId,
11898 in wstringUUID endId,
11899 [retval] out IProgress progress
11900 );
11901
11942 void restoreSnapshot (
11943 in ISnapshot snapshot,
11944 [retval] out IProgress progress
11945 );
11946
11985 void teleport (
11986 in wstring hostname,
11987 in unsigned long tcpport,
11988 in wstring password,
11989 in unsigned long maxDowntime,
11990 [retval] out IProgress progress
11991 );
11992
11993 };
11994
12005 interface IHostNetworkInterface : $unknown
12006 {
12010 readonly attribute wstring name;
12011
12015 readonly attribute wstring shortName;
12016
12020 readonly attribute wstringUUID id;
12021
12025 readonly attribute wstring networkName;
12026
12030 readonly attribute boolean DHCPEnabled;
12031
12035 readonly attribute wstring IPAddress;
12036
12040 readonly attribute wstring networkMask;
12041
12045 readonly attribute boolean IPV6Supported;
12046
12050 readonly attribute wstring IPV6Address;
12051
12055 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
12056
12060 readonly attribute wstring hardwareAddress;
12061
12065 readonly attribute HostNetworkInterfaceMediumType mediumType;
12066
12070 readonly attribute HostNetworkInterfaceStatus status;
12071
12075 readonly attribute HostNetworkInterfaceType interfaceType;
12076
12088 void enableStaticIPConfig (
12089 in wstring IPAddress,
12090 in wstring networkMask
12091 );
12092
12104 void enableStaticIPConfigV6 (
12105 in wstring IPV6Address,
12106 in unsigned long IPV6NetworkMaskPrefixLength
12107 );
12108
12112 void enableDynamicIPConfig();
12113
12117 void DHCPRediscover();
12118
12119 };
12120
12128 interface IHostVideoInputDevice : $unknown
12129 {
12133 readonly attribute wstring name;
12134
12138 readonly attribute wstring path;
12139
12143 readonly attribute wstring alias;
12144
12145 };
12146
12163 interface IHost : $unknown
12164 {
12168 readonly attribute IMedium[] DVDDrives;
12169
12173 readonly attribute IMedium[] floppyDrives;
12174
12188 readonly attribute IHostUSBDevice[] USBDevices;
12189
12213 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
12214
12218 readonly attribute IHostNetworkInterface[] networkInterfaces;
12219
12223 readonly attribute wstring[] nameServers;
12224
12228 readonly attribute wstring domainName;
12229
12233 readonly attribute wstring[] searchStrings;
12234
12238 readonly attribute unsigned long processorCount;
12239
12243 readonly attribute unsigned long processorOnlineCount;
12244
12248 readonly attribute unsigned long processorCoreCount;
12249
12253 readonly attribute unsigned long memorySize;
12254
12258 readonly attribute unsigned long memoryAvailable;
12259
12263 readonly attribute wstring operatingSystem;
12264
12268 readonly attribute wstring OSVersion;
12269
12273 readonly attribute long long UTCTime;
12274
12278 readonly attribute boolean acceleration3DAvailable;
12279
12283 readonly attribute IHostVideoInputDevice[] videoInputDevices;
12284
12299 void getProcessorSpeed (
12300 in unsigned long cpuId,
12301 [retval] out unsigned long speed
12302 );
12303
12315 void getProcessorFeature (
12316 in ProcessorFeature feature,
12317 [retval] out boolean supported
12318 );
12319
12338 void getProcessorDescription (
12339 in unsigned long cpuId,
12340 [retval] out wstring description
12341 );
12342
12383 void getProcessorCPUIDLeaf (
12384 in unsigned long cpuId,
12385 in unsigned long leaf,
12386 in unsigned long subLeaf,
12387 out unsigned long valEax,
12388 out unsigned long valEbx,
12389 out unsigned long valEcx,
12390 out unsigned long valEdx
12391 );
12392
12413 void createHostOnlyNetworkInterface (
12414 out IHostNetworkInterface hostInterface,
12415 [retval] out IProgress progress
12416 );
12417
12438 void removeHostOnlyNetworkInterface (
12439 in wstringUUID id,
12440 [retval] out IProgress progress
12441 );
12442
12462 void createUSBDeviceFilter (
12463 in wstring name,
12464 [retval] out IHostUSBDeviceFilter filter
12465 );
12466
12509 void insertUSBDeviceFilter (
12510 in unsigned long position,
12511 in IHostUSBDeviceFilter filter
12512 );
12513
12541 void removeUSBDeviceFilter (
12542 in unsigned long position
12543 );
12544
12562 void findHostDVDDrive (
12563 in wstring name,
12564 [retval] out IMedium drive
12565 );
12566
12584 void findHostFloppyDrive (
12585 in wstring name,
12586 [retval] out IMedium drive
12587 );
12588
12604 void findHostNetworkInterfaceByName (
12605 in wstring name,
12606 [retval] out IHostNetworkInterface networkInterface
12607 );
12608
12624 void findHostNetworkInterfaceById (
12625 in wstringUUID id,
12626 [retval] out IHostNetworkInterface networkInterface
12627 );
12628
12638 void findHostNetworkInterfacesOfType (
12639 in HostNetworkInterfaceType type,
12640 [retval] out IHostNetworkInterface[] networkInterfaces
12641 );
12642
12662 void findUSBDeviceById (
12663 in wstringUUID id,
12664 [retval] out IHostUSBDevice device
12665 );
12666
12689 void findUSBDeviceByAddress (
12690 in wstring name,
12691 [retval] out IHostUSBDevice device
12692 );
12693
12701 void generateMACAddress (
12702 [retval] out wstring address
12703 );
12704
12705 };
12706
12719 interface ISystemProperties : $unknown
12720 {
12724 readonly attribute unsigned long minGuestRAM;
12725
12729 readonly attribute unsigned long maxGuestRAM;
12730
12734 readonly attribute unsigned long minGuestVRAM;
12735
12739 readonly attribute unsigned long maxGuestVRAM;
12740
12744 readonly attribute unsigned long minGuestCPUCount;
12745
12749 readonly attribute unsigned long maxGuestCPUCount;
12750
12754 readonly attribute unsigned long maxGuestMonitors;
12755
12760 readonly attribute long long infoVDSize;
12761
12768 readonly attribute unsigned long serialPortCount;
12769
12776 readonly attribute unsigned long parallelPortCount;
12777
12787 readonly attribute unsigned long maxBootPosition;
12788
12797 attribute boolean exclusiveHwVirt;
12798
12822 attribute wstring defaultMachineFolder;
12823
12829 attribute wstring loggingLevel;
12830
12855 readonly attribute IMediumFormat[] mediumFormats;
12856
12890 attribute wstring defaultHardDiskFormat;
12891
12897 attribute long long freeDiskSpaceWarning;
12898
12903 attribute unsigned long freeDiskSpacePercentWarning;
12904
12910 attribute long long freeDiskSpaceError;
12911
12916 attribute unsigned long freeDiskSpacePercentError;
12917
12941 attribute wstring VRDEAuthLibrary;
12942
12971 attribute wstring webServiceAuthLibrary;
12972
12986 attribute wstring defaultVRDEExtPack;
12987
12993 attribute unsigned long logHistoryCount;
12994
12999 readonly attribute AudioDriverType defaultAudioDriver;
13000
13007 attribute wstring autostartDatabasePath;
13008
13015 attribute wstring defaultAdditionsISO;
13016
13031 attribute wstring defaultFrontend;
13032
13043 void getMaxNetworkAdapters (
13044 in ChipsetType chipset,
13045 [retval] out unsigned long maxNetworkAdapters
13046 );
13047
13061 void getMaxNetworkAdaptersOfType (
13062 in ChipsetType chipset,
13063 in NetworkAttachmentType type,
13064 [retval] out unsigned long maxNetworkAdapters
13065 );
13066
13076 void getMaxDevicesPerPortForStorageBus (
13077 in StorageBus bus,
13078 [retval] out unsigned long maxDevicesPerPort
13079 );
13080
13088 void getMinPortCountForStorageBus (
13089 in StorageBus bus,
13090 [retval] out unsigned long minPortCount
13091 );
13092
13100 void getMaxPortCountForStorageBus (
13101 in StorageBus bus,
13102 [retval] out unsigned long maxPortCount
13103 );
13104
13117 void getMaxInstancesOfStorageBus (
13118 in ChipsetType chipset,
13119 in StorageBus bus,
13120 [retval] out unsigned long maxInstances
13121 );
13122
13132 void getDeviceTypesForStorageBus (
13133 in StorageBus bus,
13134 [retval] out DeviceType[] deviceTypes
13135 );
13136
13145 void getDefaultIoCacheSettingForStorageController (
13146 in StorageControllerType controllerType,
13147 [retval] out boolean enabled
13148 );
13149
13162 void getMaxInstancesOfUSBControllerType (
13163 in ChipsetType chipset,
13164 in USBControllerType type,
13165 [retval] out unsigned long maxInstances
13166 );
13167
13168 };
13169
13175 interface IGuestOSType : $unknown
13176 {
13180 readonly attribute wstring familyId;
13181
13185 readonly attribute wstring familyDescription;
13186
13190 readonly attribute wstring id;
13191
13195 readonly attribute wstring description;
13196
13200 readonly attribute boolean is64Bit;
13201
13205 readonly attribute boolean recommendedIOAPIC;
13206
13210 readonly attribute boolean recommendedVirtEx;
13211
13215 readonly attribute unsigned long recommendedRAM;
13216
13220 readonly attribute unsigned long recommendedVRAM;
13221
13225 readonly attribute boolean recommended2DVideoAcceleration;
13226
13230 readonly attribute boolean recommended3DAcceleration;
13231
13235 readonly attribute long long recommendedHDD;
13236
13240 readonly attribute NetworkAdapterType adapterType;
13241
13245 readonly attribute boolean recommendedPAE;
13246
13250 readonly attribute StorageControllerType recommendedDVDStorageController;
13251
13255 readonly attribute StorageBus recommendedDVDStorageBus;
13256
13260 readonly attribute StorageControllerType recommendedHDStorageController;
13261
13265 readonly attribute StorageBus recommendedHDStorageBus;
13266
13270 readonly attribute FirmwareType recommendedFirmware;
13271
13275 readonly attribute boolean recommendedUSBHID;
13276
13280 readonly attribute boolean recommendedHPET;
13281
13285 readonly attribute boolean recommendedUSBTablet;
13286
13290 readonly attribute boolean recommendedRTCUseUTC;
13291
13295 readonly attribute ChipsetType recommendedChipset;
13296
13300 readonly attribute AudioControllerType recommendedAudioController;
13301
13305 readonly attribute boolean recommendedFloppy;
13306
13310 readonly attribute boolean recommendedUSB;
13311
13312 };
13313
13321 interface IAdditionsFacility : $unknown
13322 {
13326 readonly attribute AdditionsFacilityClass classType;
13327
13334 readonly attribute long long lastUpdated;
13335
13339 readonly attribute wstring name;
13340
13344 readonly attribute AdditionsFacilityStatus status;
13345
13349 readonly attribute AdditionsFacilityType type;
13350
13351 };
13352
13381 interface IGuestSession : $unknown
13382 {
13388 readonly attribute wstring user;
13389
13395 readonly attribute wstring domain;
13396
13400 readonly attribute wstring name;
13401
13405 readonly attribute unsigned long id;
13406
13419 attribute unsigned long timeout;
13420
13425 readonly attribute unsigned long protocolVersion;
13426
13430 readonly attribute GuestSessionStatus status;
13431
13437 attribute wstring[] environment;
13438
13444 readonly attribute IGuestProcess[] processes;
13445
13451 readonly attribute IGuestDirectory[] directories;
13452
13458 readonly attribute IGuestFile[] files;
13459
13465 readonly attribute IEventSource eventSource;
13466
13475 void close();
13476
13498 void copyFrom (
13499 in wstring source,
13500 in wstring dest,
13501 in CopyFileFlag[] flags,
13502 [retval] out IProgress progress
13503 );
13504
13526 void copyTo (
13527 in wstring source,
13528 in wstring dest,
13529 in CopyFileFlag[] flags,
13530 [retval] out IProgress progress
13531 );
13532
13552 void directoryCreate (
13553 in wstring path,
13554 in unsigned long mode,
13555 in DirectoryCreateFlag[] flags
13556 );
13557
13609 void directoryCreateTemp (
13610 in wstring templateName,
13611 in unsigned long mode,
13612 in wstring path,
13613 in boolean secure,
13614 [retval] out wstring directory
13615 );
13616
13634 void directoryExists (
13635 in wstring path,
13636 [retval] out boolean exists
13637 );
13638
13669 void directoryOpen (
13670 in wstring path,
13671 in wstring filter,
13672 in DirectoryOpenFlag[] flags,
13673 [retval] out IGuestDirectory directory
13674 );
13675
13701 void directoryQueryInfo (
13702 in wstring path,
13703 [retval] out IGuestFsObjInfo info
13704 );
13705
13721 void directoryRemove (
13722 in wstring path
13723 );
13724
13744 void directoryRemoveRecursive (
13745 in wstring path,
13746 in DirectoryRemoveRecFlag[] flags,
13747 [retval] out IProgress progress
13748 );
13749
13769 void directoryRename (
13770 in wstring source,
13771 in wstring dest,
13772 in PathRenameFlag[] flags
13773 );
13774
13792 void directorySetACL (
13793 in wstring path,
13794 in wstring acl
13795 );
13796
13810 void environmentClear();
13811
13832 void environmentGet (
13833 in wstring name,
13834 [retval] out wstring value
13835 );
13836
13854 void environmentSet (
13855 in wstring name,
13856 in wstring value
13857 );
13858
13874 void environmentUnset (
13875 in wstring name
13876 );
13877
13931 void fileCreateTemp (
13932 in wstring templateName,
13933 in unsigned long mode,
13934 in wstring path,
13935 in boolean secure,
13936 [retval] out IGuestFile file
13937 );
13938
13956 void fileExists (
13957 in wstring path,
13958 [retval] out boolean exists
13959 );
13960
13984 void fileRemove (
13985 in wstring path
13986 );
13987
14046 void fileOpen (
14047 in wstring path,
14048 in wstring openMode,
14049 in wstring disposition,
14050 in unsigned long creationMode,
14051 [retval] out IGuestFile file
14052 );
14053
14117 void fileOpenEx (
14118 in wstring path,
14119 in wstring openMode,
14120 in wstring disposition,
14121 in wstring sharingMode,
14122 in unsigned long creationMode,
14123 in long long offset,
14124 [retval] out IGuestFile file
14125 );
14126
14152 void fileQueryInfo (
14153 in wstring path,
14154 [retval] out IGuestFsObjInfo info
14155 );
14156
14182 void fileQuerySize (
14183 in wstring path,
14184 [retval] out long long size
14185 );
14186
14206 void fileRename (
14207 in wstring source,
14208 in wstring dest,
14209 in PathRenameFlag[] flags
14210 );
14211
14229 void fileSetACL (
14230 in wstring file,
14231 in wstring acl
14232 );
14233
14288 void processCreate (
14289 in wstring command,
14290 in wstring[] arguments,
14291 in wstring[] environment,
14292 in ProcessCreateFlag[] flags,
14293 in unsigned long timeoutMS,
14294 [retval] out IGuestProcess guestProcess
14295 );
14296
14338 void processCreateEx (
14339 in wstring command,
14340 in wstring[] arguments,
14341 in wstring[] environment,
14342 in ProcessCreateFlag[] flags,
14343 in unsigned long timeoutMS,
14344 in ProcessPriority priority,
14345 in long[] affinity,
14346 [retval] out IGuestProcess guestProcess
14347 );
14348
14358 void processGet (
14359 in unsigned long pid,
14360 [retval] out IGuestProcess guestProcess
14361 );
14362
14385 void symlinkCreate (
14386 in wstring source,
14387 in wstring target,
14388 in SymlinkType type
14389 );
14390
14408 void symlinkExists (
14409 in wstring symlink,
14410 [retval] out boolean exists
14411 );
14412
14436 void symlinkRead (
14437 in wstring symlink,
14438 in SymlinkReadFlag[] flags,
14439 [retval] out wstring target
14440 );
14441
14457 void symlinkRemoveDirectory (
14458 in wstring path
14459 );
14460
14476 void symlinkRemoveFile (
14477 in wstring file
14478 );
14479
14500 void waitFor (
14501 in unsigned long waitFor,
14502 in unsigned long timeoutMS,
14503 [retval] out GuestSessionWaitResult reason
14504 );
14505
14527 void waitForArray (
14528 in GuestSessionWaitForFlag[] waitFor,
14529 in unsigned long timeoutMS,
14530 [retval] out GuestSessionWaitResult reason
14531 );
14532
14533 };
14534
14542 interface IProcess : $unknown
14543 {
14549 readonly attribute wstring[] arguments;
14550
14556 readonly attribute wstring[] environment;
14557
14563 readonly attribute IEventSource eventSource;
14564
14568 readonly attribute wstring executablePath;
14569
14576 readonly attribute long exitCode;
14577
14583 readonly attribute wstring name;
14584
14590 readonly attribute unsigned long PID;
14591
14598 readonly attribute ProcessStatus status;
14599
14620 void waitFor (
14621 in unsigned long waitFor,
14622 in unsigned long timeoutMS,
14623 [retval] out ProcessWaitResult reason
14624 );
14625
14647 void waitForArray (
14648 in ProcessWaitForFlag[] waitFor,
14649 in unsigned long timeoutMS,
14650 [retval] out ProcessWaitResult reason
14651 );
14652
14669 void read (
14670 in unsigned long handle,
14671 in unsigned long toRead,
14672 in unsigned long timeoutMS,
14673 [retval] out octet[] data
14674 );
14675
14699 void write (
14700 in unsigned long handle,
14701 in unsigned long flags,
14702 in octet[] data,
14703 in unsigned long timeoutMS,
14704 [retval] out unsigned long written
14705 );
14706
14731 void writeArray (
14732 in unsigned long handle,
14733 in ProcessInputFlag[] flags,
14734 in octet[] data,
14735 in unsigned long timeoutMS,
14736 [retval] out unsigned long written
14737 );
14738
14748 void terminate();
14749
14750 };
14751
14760 interface IGuestProcess : IProcess
14761 {
14762 };
14763
14771 interface IDirectory : $unknown
14772 {
14778 readonly attribute wstring directoryName;
14779
14785 readonly attribute wstring filter;
14786
14793 void close();
14794
14810 void read (
14811 [retval] out IFsObjInfo objInfo
14812 );
14813
14814 };
14815
14824 interface IGuestDirectory : IDirectory
14825 {
14826 };
14827
14835 interface IFile : $unknown
14836 {
14842 readonly attribute unsigned long creationMode;
14843
14849 readonly attribute wstring disposition;
14850
14856 readonly attribute IEventSource eventSource;
14857
14863 readonly attribute wstring fileName;
14864
14870 readonly attribute unsigned long id;
14871
14877 readonly attribute long long initialSize;
14878
14884 readonly attribute wstring openMode;
14885
14891 readonly attribute long long offset;
14892
14898 readonly attribute FileStatus status;
14899
14906 void close();
14907
14924 void queryInfo (
14925 [retval] out IFsObjInfo objInfo
14926 );
14927
14950 void read (
14951 in unsigned long toRead,
14952 in unsigned long timeoutMS,
14953 [retval] out octet[] data
14954 );
14955
14980 void readAt (
14981 in long long offset,
14982 in unsigned long toRead,
14983 in unsigned long timeoutMS,
14984 [retval] out octet[] data
14985 );
14986
15006 void seek (
15007 in long long offset,
15008 in FileSeekType whence
15009 );
15010
15026 void setACL (
15027 in wstring acl
15028 );
15029
15047 void write (
15048 in octet[] data,
15049 in unsigned long timeoutMS,
15050 [retval] out unsigned long written
15051 );
15052
15080 void writeAt (
15081 in long long offset,
15082 in octet[] data,
15083 in unsigned long timeoutMS,
15084 [retval] out unsigned long written
15085 );
15086
15087 };
15088
15097 interface IGuestFile : IFile
15098 {
15099 };
15100
15109 interface IFsObjInfo : $unknown
15110 {
15116 readonly attribute long long accessTime;
15117
15123 readonly attribute long long allocatedSize;
15124
15130 readonly attribute long long birthTime;
15131
15137 readonly attribute long long changeTime;
15138
15144 readonly attribute unsigned long deviceNumber;
15145
15151 readonly attribute wstring fileAttributes;
15152
15158 readonly attribute unsigned long generationId;
15159
15165 readonly attribute unsigned long GID;
15166
15172 readonly attribute wstring groupName;
15173
15179 readonly attribute unsigned long hardLinks;
15180
15186 readonly attribute long long modificationTime;
15187
15193 readonly attribute wstring name;
15194
15200 readonly attribute long long nodeId;
15201
15207 readonly attribute unsigned long nodeIdDevice;
15208
15216 readonly attribute long long objectSize;
15217
15223 readonly attribute FsObjType type;
15224
15230 readonly attribute unsigned long UID;
15231
15237 readonly attribute unsigned long userFlags;
15238
15244 readonly attribute wstring userName;
15245
15246 };
15247
15256 interface IGuestFsObjInfo : IFsObjInfo
15257 {
15258 };
15259
15273 interface IGuest : $unknown
15274 {
15289 readonly attribute wstring OSTypeId;
15290
15296 readonly attribute AdditionsRunLevelType additionsRunLevel;
15297
15304 readonly attribute wstring additionsVersion;
15305
15313 readonly attribute unsigned long additionsRevision;
15314
15320 readonly attribute IEventSource eventSource;
15321
15328 readonly attribute IAdditionsFacility[] facilities;
15329
15333 readonly attribute IGuestSession[] sessions;
15334
15338 attribute unsigned long memoryBalloonSize;
15339
15343 attribute unsigned long statisticsUpdateInterval;
15344
15376 void internalGetStatistics (
15377 out unsigned long cpuUser,
15378 out unsigned long cpuKernel,
15379 out unsigned long cpuIdle,
15380 out unsigned long memTotal,
15381 out unsigned long memFree,
15382 out unsigned long memBalloon,
15383 out unsigned long memShared,
15384 out unsigned long memCache,
15385 out unsigned long pagedTotal,
15386 out unsigned long memAllocTotal,
15387 out unsigned long memFreeTotal,
15388 out unsigned long memBalloonTotal,
15389 out unsigned long memSharedTotal
15390 );
15391
15403 void getFacilityStatus (
15404 in AdditionsFacilityType facility,
15405 out long long timestamp,
15406 [retval] out AdditionsFacilityStatus status
15407 );
15408
15426 void getAdditionsStatus (
15427 in AdditionsRunLevelType level,
15428 [retval] out boolean active
15429 );
15430
15460 void setCredentials (
15461 in wstring userName,
15462 in wstring password,
15463 in wstring domain,
15464 in boolean allowInteractiveLogon
15465 );
15466
15496 void dragHGEnter (
15497 in unsigned long screenId,
15498 in unsigned long y,
15499 in unsigned long x,
15500 in DragAndDropAction defaultAction,
15501 in DragAndDropAction[] allowedActions,
15502 in wstring[] formats,
15503 [retval] out DragAndDropAction resultAction
15504 );
15505
15535 void dragHGMove (
15536 in unsigned long screenId,
15537 in unsigned long x,
15538 in unsigned long y,
15539 in DragAndDropAction defaultAction,
15540 in DragAndDropAction[] allowedActions,
15541 in wstring[] formats,
15542 [retval] out DragAndDropAction resultAction
15543 );
15544
15562 void dragHGLeave (
15563 in unsigned long screenId
15564 );
15565
15597 void dragHGDrop (
15598 in unsigned long screenId,
15599 in unsigned long x,
15600 in unsigned long y,
15601 in DragAndDropAction defaultAction,
15602 in DragAndDropAction[] allowedActions,
15603 in wstring[] formats,
15604 out wstring format,
15605 [retval] out DragAndDropAction resultAction
15606 );
15607
15631 void dragHGPutData (
15632 in unsigned long screenId,
15633 in wstring format,
15634 in octet[] data,
15635 [retval] out IProgress progress
15636 );
15637
15663 void dragGHPending (
15664 in unsigned long screenId,
15665 out wstring[] formats,
15666 out DragAndDropAction[] allowedActions,
15667 [retval] out DragAndDropAction defaultAction
15668 );
15669
15691 void dragGHDropped (
15692 in wstring format,
15693 in DragAndDropAction action,
15694 [retval] out IProgress progress
15695 );
15696
15714 void dragGHGetData (
15715 [retval] out octet[] data
15716 );
15717
15776 void createSession (
15777 in wstring user,
15778 in wstring password,
15779 in wstring domain,
15780 in wstring sessionName,
15781 [retval] out IGuestSession guestSession
15782 );
15783
15798 void findSession (
15799 in wstring sessionName,
15800 [retval] out IGuestSession[] sessions
15801 );
15802
15852 void updateGuestAdditions (
15853 in wstring source,
15854 in wstring[] arguments,
15855 in AdditionsUpdateFlag[] flags,
15856 [retval] out IProgress progress
15857 );
15858
15859 };
15860
15901 interface IProgress : $unknown
15902 {
15906 readonly attribute wstringUUID id;
15907
15911 readonly attribute wstring description;
15912
15916 readonly attribute $unknown initiator;
15917
15921 readonly attribute boolean cancelable;
15922
15930 readonly attribute unsigned long percent;
15931
15945 readonly attribute long timeRemaining;
15946
15950 readonly attribute boolean completed;
15951
15955 readonly attribute boolean canceled;
15956
15963 readonly attribute long resultCode;
15964
15974 readonly attribute IVirtualBoxErrorInfo errorInfo;
15975
15982 readonly attribute unsigned long operationCount;
15983
15987 readonly attribute unsigned long operation;
15988
15994 readonly attribute wstring operationDescription;
15995
15999 readonly attribute unsigned long operationPercent;
16000
16004 readonly attribute unsigned long operationWeight;
16005
16013 attribute unsigned long timeout;
16014
16018 void setCurrentOperationProgress (
16019 in unsigned long percent
16020 );
16021
16025 void setNextOperation (
16026 in wstring nextOperationDescription,
16027 in unsigned long nextOperationsWeight
16028 );
16029
16056 void waitForCompletion (
16057 in long timeout
16058 );
16059
16083 void waitForOperationCompletion (
16084 in unsigned long operation,
16085 in long timeout
16086 );
16087
16113 void waitForAsyncProgressCompletion (
16114 in IProgress pProgressAsync
16115 );
16116
16133 void cancel();
16134
16135 };
16136
16220 interface ISnapshot : $unknown
16221 {
16225 readonly attribute wstringUUID id;
16226
16234 attribute wstring name;
16235
16243 attribute wstring description;
16244
16250 readonly attribute long long timeStamp;
16251
16263 readonly attribute boolean online;
16264
16276 readonly attribute IMachine machine;
16277
16284 readonly attribute ISnapshot parent;
16285
16294 readonly attribute ISnapshot[] children;
16295
16303 void getChildrenCount (
16304 [retval] out unsigned long childrenCount
16305 );
16306
16307 };
16308
16495 interface IMediumAttachment : $unknown
16496 {
16501 readonly attribute IMedium medium;
16502
16508 readonly attribute wstring controller;
16509
16515 readonly attribute long port;
16516
16522 readonly attribute long device;
16523
16527 readonly attribute DeviceType type;
16528
16532 readonly attribute boolean passthrough;
16533
16537 readonly attribute boolean temporaryEject;
16538
16543 readonly attribute boolean isEjected;
16544
16548 readonly attribute boolean nonRotational;
16549
16553 readonly attribute boolean discard;
16554
16558 readonly attribute IBandwidthGroup bandwidthGroup;
16559
16560 };
16561
16719 interface IMedium : $unknown
16720 {
16734 readonly attribute wstringUUID id;
16735
16754 attribute wstring description;
16755
16771 readonly attribute MediumState state;
16772
16781 readonly attribute MediumVariant[] variant;
16782
16792 readonly attribute wstring location;
16793
16813 readonly attribute wstring name;
16814
16819 readonly attribute DeviceType deviceType;
16820
16824 readonly attribute boolean hostDrive;
16825
16838 readonly attribute long long size;
16839
16854 readonly attribute wstring format;
16855
16871 readonly attribute IMediumFormat mediumFormat;
16872
16897 attribute MediumType type;
16898
16912 readonly attribute MediumType[] allowedTypes;
16913
16923 readonly attribute IMedium parent;
16924
16932 readonly attribute IMedium[] children;
16933
16944 readonly attribute IMedium base;
16945
16978 readonly attribute boolean readOnly;
16979
16995 readonly attribute long long logicalSize;
16996
17024 attribute boolean autoReset;
17025
17040 readonly attribute wstring lastAccessError;
17041
17058 readonly attribute wstringUUID[] machineIds;
17059
17085 void setIds (
17086 in boolean setImageId,
17087 in wstringUUID imageId,
17088 in boolean setParentId,
17089 in wstringUUID parentId
17090 );
17091
17126 void refreshState (
17127 [retval] out MediumState state
17128 );
17129
17156 void getSnapshotIds (
17157 in wstringUUID machineId,
17158 [retval] out wstringUUID[] snapshotIds
17159 );
17160
17223 void lockRead (
17224 [retval] out IToken token
17225 );
17226
17281 void lockWrite (
17282 [retval] out IToken token
17283 );
17284
17334 void close();
17335
17365 void getProperty (
17366 in wstring name,
17367 [retval] out wstring value
17368 );
17369
17401 void setProperty (
17402 in wstring name,
17403 in wstring value
17404 );
17405
17440 void getProperties (
17441 in wstring names,
17442 out wstring[] returnNames,
17443 [retval] out wstring[] returnValues
17444 );
17445
17475 void setProperties (
17476 in wstring[] names,
17477 in wstring[] values
17478 );
17479
17512 void createBaseStorage (
17513 in long long logicalSize,
17514 in MediumVariant[] variant,
17515 [retval] out IProgress progress
17516 );
17517
17569 void deleteStorage (
17570 [retval] out IProgress progress
17571 );
17572
17611 void createDiffStorage (
17612 in IMedium target,
17613 in MediumVariant[] variant,
17614 [retval] out IProgress progress
17615 );
17616
17692 void mergeTo (
17693 in IMedium target,
17694 [retval] out IProgress progress
17695 );
17696
17746 void cloneTo (
17747 in IMedium target,
17748 in MediumVariant[] variant,
17749 in IMedium parent,
17750 [retval] out IProgress progress
17751 );
17752
17799 void cloneToBase (
17800 in IMedium target,
17801 in MediumVariant[] variant,
17802 [retval] out IProgress progress
17803 );
17804
17846 void setLocation (
17847 in wstring location,
17848 [retval] out IProgress progress
17849 );
17850
17879 void compact (
17880 [retval] out IProgress progress
17881 );
17882
17915 void resize (
17916 in long long logicalSize,
17917 [retval] out IProgress progress
17918 );
17919
17953 void reset (
17954 [retval] out IProgress progress
17955 );
17956
17957 };
17958
17981 interface IMediumFormat : $unknown
17982 {
18001 readonly attribute wstring id;
18002
18010 readonly attribute wstring name;
18011
18020 readonly attribute MediumFormatCapabilities[] capabilities;
18021
18040 void describeFileExtensions (
18041 out wstring[] extensions,
18042 out DeviceType[] types
18043 );
18044
18072 void describeProperties (
18073 out wstring[] names,
18074 out wstring[] descriptions,
18075 out DataType[] types,
18076 out unsigned long[] flags,
18077 out wstring[] defaults
18078 );
18079
18080 };
18081
18096 interface IToken : $unknown
18097 {
18106 void abandon();
18107
18114 void dummy();
18115
18116 };
18117
18129 interface IKeyboard : $unknown
18130 {
18136 readonly attribute IEventSource eventSource;
18137
18150 void putScancode (
18151 in long scancode
18152 );
18153
18166 void putScancodes (
18167 in long[] scancodes,
18168 [retval] out unsigned long codesStored
18169 );
18170
18185 void putCAD();
18186
18187 };
18188
18200 interface IMouse : $unknown
18201 {
18216 readonly attribute boolean absoluteSupported;
18217
18232 readonly attribute boolean relativeSupported;
18233
18247 readonly attribute boolean multiTouchSupported;
18248
18263 readonly attribute boolean needsHostCursor;
18264
18270 readonly attribute IEventSource eventSource;
18271
18337 void putMouseEvent (
18338 in long dx,
18339 in long dy,
18340 in long dz,
18341 in long dw,
18342 in long buttonState
18343 );
18344
18417 void putMouseEventAbsolute (
18418 in long x,
18419 in long y,
18420 in long dz,
18421 in long dw,
18422 in long buttonState
18423 );
18424
18472 void putEventMultiTouch (
18473 in long count,
18474 in long long[] contacts,
18475 in unsigned long scanTime
18476 );
18477
18493 void putEventMultiTouchString (
18494 in long count,
18495 in wstring contacts,
18496 in unsigned long scanTime
18497 );
18498
18499 };
18500
18501 interface IFramebuffer : $unknown
18502 {
18511 readonly attribute octetPtr address;
18512
18516 readonly attribute unsigned long width;
18517
18521 readonly attribute unsigned long height;
18522
18529 readonly attribute unsigned long bitsPerPixel;
18530
18537 readonly attribute unsigned long bytesPerLine;
18538
18549 readonly attribute unsigned long pixelFormat;
18550
18557 readonly attribute boolean usesGuestVRAM;
18558
18568 readonly attribute unsigned long heightReduction;
18569
18584 readonly attribute IFramebufferOverlay overlay;
18585
18592 readonly attribute long long winId;
18593
18601 void lock();
18602
18610 void unlock();
18611
18619 void notifyUpdate (
18620 in unsigned long x,
18621 in unsigned long y,
18622 in unsigned long width,
18623 in unsigned long height
18624 );
18625
18738 void requestResize (
18739 in unsigned long screenId,
18740 in unsigned long pixelFormat,
18741 in octetPtr VRAM,
18742 in unsigned long bitsPerPixel,
18743 in unsigned long bytesPerLine,
18744 in unsigned long width,
18745 in unsigned long height,
18746 [retval] out boolean finished
18747 );
18748
18760 void videoModeSupported (
18761 in unsigned long width,
18762 in unsigned long height,
18763 in unsigned long bpp,
18764 [retval] out boolean supported
18765 );
18766
18803 void getVisibleRegion (
18804 in octetPtr rectangles,
18805 in unsigned long count,
18806 [retval] out unsigned long countCopied
18807 );
18808
18843 void setVisibleRegion (
18844 in octetPtr rectangles,
18845 in unsigned long count
18846 );
18847
18868 void processVHWACommand (
18869 in octetPtr command
18870 );
18871
18886 void notify3DEvent (
18887 in unsigned long type,
18888 in octetPtr data
18889 );
18890
18891 };
18892
18907 interface IFramebufferOverlay : IFramebuffer
18908 {
18912 readonly attribute unsigned long x;
18913
18917 readonly attribute unsigned long y;
18918
18924 attribute boolean visible;
18925
18932 attribute unsigned long alpha;
18933
18939 void move (
18940 in unsigned long x,
18941 in unsigned long y
18942 );
18943
18944 };
18945
18961 interface IDisplay : $unknown
18962 {
18966 void getScreenResolution (
18967 in unsigned long screenId,
18968 out unsigned long width,
18969 out unsigned long height,
18970 out unsigned long bitsPerPixel,
18971 out long xOrigin,
18972 out long yOrigin
18973 );
18974
18980 void setFramebuffer (
18981 in unsigned long screenId,
18982 in IFramebuffer framebuffer
18983 );
18984
18990 void getFramebuffer (
18991 in unsigned long screenId,
18992 out IFramebuffer framebuffer,
18993 out long xOrigin,
18994 out long yOrigin
18995 );
18996
19047 void setVideoModeHint (
19048 in unsigned long display,
19049 in boolean enabled,
19050 in boolean changeOrigin,
19051 in long originX,
19052 in long originY,
19053 in unsigned long width,
19054 in unsigned long height,
19055 in unsigned long bitsPerPixel
19056 );
19057
19069 void setSeamlessMode (
19070 in boolean enabled
19071 );
19072
19108 void takeScreenShot (
19109 in unsigned long screenId,
19110 in octetPtr address,
19111 in unsigned long width,
19112 in unsigned long height
19113 );
19114
19158 void takeScreenShotToArray (
19159 in unsigned long screenId,
19160 in unsigned long width,
19161 in unsigned long height,
19162 [retval] out octet[] screenData
19163 );
19164
19203 void takeScreenShotPNGToArray (
19204 in unsigned long screenId,
19205 in unsigned long width,
19206 in unsigned long height,
19207 [retval] out octet[] screenData
19208 );
19209
19261 void drawToScreen (
19262 in unsigned long screenId,
19263 in octetPtr address,
19264 in unsigned long x,
19265 in unsigned long y,
19266 in unsigned long width,
19267 in unsigned long height
19268 );
19269
19284 void invalidateAndUpdate();
19285
19299 void resizeCompleted (
19300 in unsigned long screenId
19301 );
19302
19315 void completeVHWACommand (
19316 in octetPtr command
19317 );
19318
19352 void viewportChanged (
19353 in unsigned long screenId,
19354 in unsigned long x,
19355 in unsigned long y,
19356 in unsigned long width,
19357 in unsigned long height
19358 );
19359
19360 };
19361
19377 interface INetworkAdapter : $unknown
19378 {
19386 attribute NetworkAdapterType adapterType;
19387
19395 readonly attribute unsigned long slot;
19396
19405 attribute boolean enabled;
19406
19413 attribute wstring MACAddress;
19414
19420 attribute NetworkAttachmentType attachmentType;
19421
19427 attribute wstring bridgedInterface;
19428
19434 attribute wstring hostOnlyInterface;
19435
19441 attribute wstring internalNetwork;
19442
19448 attribute wstring NATNetwork;
19449
19455 attribute wstring genericDriver;
19456
19463 attribute boolean cableConnected;
19464
19470 attribute unsigned long lineSpeed;
19471
19478 attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
19479
19486 attribute boolean traceEnabled;
19487
19494 attribute wstring traceFile;
19495
19503 readonly attribute INATEngine NATEngine;
19504
19511 attribute unsigned long bootPriority;
19512
19516 attribute IBandwidthGroup bandwidthGroup;
19517
19536 void getProperty (
19537 in wstring key,
19538 [retval] out wstring value
19539 );
19540
19559 void setProperty (
19560 in wstring key,
19561 in wstring value
19562 );
19563
19591 void getProperties (
19592 in wstring names,
19593 out wstring[] returnNames,
19594 [retval] out wstring[] returnValues
19595 );
19596
19597 };
19598
19627 interface ISerialPort : $unknown
19628 {
19636 readonly attribute unsigned long slot;
19637
19644 attribute boolean enabled;
19645
19649 attribute unsigned long IOBase;
19650
19654 attribute unsigned long IRQ;
19655
19666 attribute PortMode hostMode;
19667
19675 attribute boolean server;
19676
19686 attribute wstring path;
19687
19688 };
19689
19709 interface IParallelPort : $unknown
19710 {
19718 readonly attribute unsigned long slot;
19719
19726 attribute boolean enabled;
19727
19731 attribute unsigned long IOBase;
19732
19736 attribute unsigned long IRQ;
19737
19745 attribute wstring path;
19746
19747 };
19748
19749 interface IMachineDebugger : $unknown
19750 {
19754 attribute boolean singleStep;
19755
19759 attribute boolean recompileUser;
19760
19764 attribute boolean recompileSupervisor;
19765
19773 attribute boolean executeAllInIEM;
19774
19778 attribute boolean PATMEnabled;
19779
19783 attribute boolean CSAMEnabled;
19784
19788 attribute boolean logEnabled;
19789
19793 readonly attribute wstring logDbgFlags;
19794
19798 readonly attribute wstring logDbgGroups;
19799
19803 readonly attribute wstring logDbgDestinations;
19804
19808 readonly attribute wstring logRelFlags;
19809
19813 readonly attribute wstring logRelGroups;
19814
19818 readonly attribute wstring logRelDestinations;
19819
19826 readonly attribute boolean HWVirtExEnabled;
19827
19834 readonly attribute boolean HWVirtExNestedPagingEnabled;
19835
19842 readonly attribute boolean HWVirtExVPIDEnabled;
19843
19850 readonly attribute boolean HWVirtExUXEnabled;
19851
19860 readonly attribute wstring OSName;
19861
19870 readonly attribute wstring OSVersion;
19871
19878 readonly attribute boolean PAEEnabled;
19879
19886 attribute unsigned long virtualTimeRate;
19887
19895 readonly attribute long long VM;
19896
19912 void dumpGuestCore (
19913 in wstring filename,
19914 in wstring compression
19915 );
19916
19933 void dumpHostProcessCore (
19934 in wstring filename,
19935 in wstring compression
19936 );
19937
19958 void info (
19959 in wstring name,
19960 in wstring args,
19961 [retval] out wstring info
19962 );
19963
19969 void injectNMI();
19970
19981 void modifyLogGroups (
19982 in wstring settings
19983 );
19984
19995 void modifyLogFlags (
19996 in wstring settings
19997 );
19998
20009 void modifyLogDestinations (
20010 in wstring settings
20011 );
20012
20027 void readPhysicalMemory (
20028 in long long address,
20029 in unsigned long size,
20030 [retval] out octet[] bytes
20031 );
20032
20047 void writePhysicalMemory (
20048 in long long address,
20049 in unsigned long size,
20050 in octet[] bytes
20051 );
20052
20069 void readVirtualMemory (
20070 in unsigned long cpuId,
20071 in long long address,
20072 in unsigned long size,
20073 [retval] out octet[] bytes
20074 );
20075
20092 void writeVirtualMemory (
20093 in unsigned long cpuId,
20094 in long long address,
20095 in unsigned long size,
20096 in octet[] bytes
20097 );
20098
20111 void detectOS (
20112 [retval] out wstring os
20113 );
20114
20132 void getRegister (
20133 in unsigned long cpuId,
20134 in wstring name,
20135 [retval] out wstring value
20136 );
20137
20155 void getRegisters (
20156 in unsigned long cpuId,
20157 out wstring[] names,
20158 out wstring[] values
20159 );
20160
20179 void setRegister (
20180 in unsigned long cpuId,
20181 in wstring name,
20182 in wstring value
20183 );
20184
20203 void setRegisters (
20204 in unsigned long cpuId,
20205 in wstring[] names,
20206 in wstring[] values
20207 );
20208
20221 void dumpGuestStack (
20222 in unsigned long cpuId,
20223 [retval] out wstring stack
20224 );
20225
20233 void resetStats (
20234 in wstring pattern
20235 );
20236
20244 void dumpStats (
20245 in wstring pattern
20246 );
20247
20259 void getStats (
20260 in wstring pattern,
20261 in boolean withDescriptions,
20262 [retval] out wstring stats
20263 );
20264
20265 };
20266
20267 interface IUSBDeviceFilters : $unknown
20268 {
20294 readonly attribute IUSBDeviceFilter[] deviceFilters;
20295
20323 void createDeviceFilter (
20324 in wstring name,
20325 [retval] out IUSBDeviceFilter filter
20326 );
20327
20372 void insertDeviceFilter (
20373 in unsigned long position,
20374 in IUSBDeviceFilter filter
20375 );
20376
20409 void removeDeviceFilter (
20410 in unsigned long position,
20411 [retval] out IUSBDeviceFilter filter
20412 );
20413
20414 };
20415
20416 interface IUSBController : $unknown
20417 {
20423 readonly attribute wstring name;
20424
20430 readonly attribute USBControllerType type;
20431
20439 readonly attribute unsigned short USBStandard;
20440
20441 };
20442
20455 interface IUSBDevice : $unknown
20456 {
20463 readonly attribute wstringUUID id;
20464
20468 readonly attribute unsigned short vendorId;
20469
20473 readonly attribute unsigned short productId;
20474
20482 readonly attribute unsigned short revision;
20483
20487 readonly attribute wstring manufacturer;
20488
20492 readonly attribute wstring product;
20493
20497 readonly attribute wstring serialNumber;
20498
20502 readonly attribute wstring address;
20503
20510 readonly attribute unsigned short port;
20511
20517 readonly attribute unsigned short version;
20518
20526 readonly attribute unsigned short portVersion;
20527
20534 readonly attribute boolean remote;
20535
20536 };
20537
20612 interface IUSBDeviceFilter : $unknown
20613 {
20621 attribute wstring name;
20622
20626 attribute boolean active;
20627
20635 attribute wstring vendorId;
20636
20644 attribute wstring productId;
20645
20659 attribute wstring revision;
20660
20665 attribute wstring manufacturer;
20666
20671 attribute wstring product;
20672
20677 attribute wstring serialNumber;
20678
20683 attribute wstring port;
20684
20694 attribute wstring remote;
20695
20705 attribute unsigned long maskedInterfaces;
20706
20707 };
20708
20725 interface IHostUSBDevice : IUSBDevice
20726 {
20732 readonly attribute USBDeviceState state;
20733
20734 };
20735
20758 interface IHostUSBDeviceFilter : IUSBDeviceFilter
20759 {
20766 attribute USBDeviceFilterAction action;
20767
20768 };
20769
20778 interface IAudioAdapter : $unknown
20779 {
20788 attribute boolean enabled;
20789
20795 attribute AudioControllerType audioController;
20796
20803 attribute AudioDriverType audioDriver;
20804
20805 };
20806
20807 interface IVRDEServer : $unknown
20808 {
20812 attribute boolean enabled;
20813
20817 attribute AuthType authType;
20818
20822 attribute unsigned long authTimeout;
20823
20830 attribute boolean allowMultiConnection;
20831
20839 attribute boolean reuseSingleConnection;
20840
20847 attribute wstring VRDEExtPack;
20848
20855 attribute wstring authLibrary;
20856
20862 readonly attribute wstring[] VRDEProperties;
20863
20877 void setVRDEProperty (
20878 in wstring key,
20879 in wstring value
20880 );
20881
20895 void getVRDEProperty (
20896 in wstring key,
20897 [retval] out wstring value
20898 );
20899
20900 };
20901
20959 interface ISharedFolder : $unknown
20960 {
20964 readonly attribute wstring name;
20965
20969 readonly attribute wstring hostPath;
20970
20980 readonly attribute boolean accessible;
20981
20988 readonly attribute boolean writable;
20989
20995 readonly attribute boolean autoMount;
20996
21009 readonly attribute wstring lastAccessError;
21010
21011 };
21012
21013 interface IInternalSessionControl : $unknown
21014 {
21019 void getPID (
21020 [retval] out unsigned long pid
21021 );
21022
21044 void getRemoteConsole (
21045 [retval] out IConsole console
21046 );
21047
21062 void assignRemoteMachine (
21063 in IMachine machine,
21064 in IConsole console
21065 );
21066
21090 void updateMachineState (
21091 in MachineState machineState
21092 );
21093
21109 void uninitialize();
21110
21133 void onNetworkAdapterChange (
21134 in INetworkAdapter networkAdapter,
21135 in boolean changeAdapter
21136 );
21137
21160 void onSerialPortChange (
21161 in ISerialPort serialPort
21162 );
21163
21186 void onParallelPortChange (
21187 in IParallelPort parallelPort
21188 );
21189
21212 void onStorageControllerChange();
21213
21240 void onMediumChange (
21241 in IMediumAttachment mediumAttachment,
21242 in boolean force
21243 );
21244
21274 void onStorageDeviceChange (
21275 in IMediumAttachment mediumAttachment,
21276 in boolean remove,
21277 in boolean silent
21278 );
21279
21287 void onClipboardModeChange (
21288 in ClipboardMode clipboardMode
21289 );
21290
21298 void onDragAndDropModeChange (
21299 in DragAndDropMode dragAndDropMode
21300 );
21301
21311 void onCPUChange (
21312 in unsigned long cpu,
21313 in boolean add
21314 );
21315
21323 void onCPUExecutionCapChange (
21324 in unsigned long executionCap
21325 );
21326
21351 void onVRDEServerChange (
21352 in boolean restart
21353 );
21354
21360 void onVideoCaptureChange();
21361
21384 void onUSBControllerChange();
21385
21414 void onSharedFolderChange (
21415 in boolean global
21416 );
21417
21443 void onUSBDeviceAttach (
21444 in IUSBDevice device,
21445 in IVirtualBoxErrorInfo error,
21446 in unsigned long maskedInterfaces
21447 );
21448
21474 void onUSBDeviceDetach (
21475 in wstringUUID id,
21476 in IVirtualBoxErrorInfo error
21477 );
21478
21496 void onShowWindow (
21497 in boolean check,
21498 out boolean canShow,
21499 out long long winId
21500 );
21501
21509 void onBandwidthGroupChange (
21510 in IBandwidthGroup bandwidthGroup
21511 );
21512
21536 void accessGuestProperty (
21537 in wstring name,
21538 in wstring value,
21539 in wstring flags,
21540 in boolean isSetter,
21541 out wstring retValue,
21542 out long long retTimestamp,
21543 out wstring retFlags
21544 );
21545
21593 void enumerateGuestProperties (
21594 in wstring patterns,
21595 out wstring[] keys,
21596 out wstring[] values,
21597 out long long[] timestamps,
21598 out wstring[] flags
21599 );
21600
21635 void onlineMergeMedium (
21636 in IMediumAttachment mediumAttachment,
21637 in unsigned long sourceIdx,
21638 in unsigned long targetIdx,
21639 in IProgress progress
21640 );
21641
21665 void enableVMMStatistics (
21666 in boolean enable
21667 );
21668
21696 void pauseWithReason (
21697 in Reason reason
21698 );
21699
21727 void resumeWithReason (
21728 in Reason reason
21729 );
21730
21760 void saveStateWithReason (
21761 in Reason reason,
21762 [retval] out IProgress progress
21763 );
21764
21788 void assignMachine (
21789 in IMachine machine,
21790 in LockType lockType,
21791 in wstring tokenId
21792 );
21793
21817 void assignMachine (
21818 in IMachine machine,
21819 in LockType lockType,
21820 in IToken token
21821 );
21822
21823 };
21824
21883 interface ISession : $unknown
21884 {
21888 readonly attribute SessionState state;
21889
21897 readonly attribute SessionType type;
21898
21902 readonly attribute IMachine machine;
21903
21907 readonly attribute IConsole console;
21908
21940 void unlockMachine();
21941
21942 };
21943
21966 interface IStorageController : $unknown
21967 {
21976 readonly attribute wstring name;
21977
21983 readonly attribute unsigned long maxDevicesPerPortCount;
21984
21990 readonly attribute unsigned long minPortCount;
21991
21997 readonly attribute unsigned long maxPortCount;
21998
22004 attribute unsigned long instance;
22005
22014 attribute unsigned long portCount;
22015
22021 readonly attribute StorageBus bus;
22022
22035 attribute StorageControllerType controllerType;
22036
22051 attribute boolean useHostIOCache;
22052
22058 readonly attribute boolean bootable;
22059
22060 };
22061
22085 interface IManagedObjectRef : $unknown
22086 {
22093 void getInterfaceName (
22094 [retval] out wstring return
22095 );
22096
22104 void release();
22105
22106 };
22107
22116 interface IWebsessionManager : $unknown
22117 {
22126 void logon (
22127 in wstring username,
22128 in wstring password,
22129 [retval] out IVirtualBox return
22130 );
22131
22141 void getSessionObject (
22142 in IVirtualBox refIVirtualBox,
22143 [retval] out ISession return
22144 );
22145
22153 void logoff (
22154 in IVirtualBox refIVirtualBox
22155 );
22156
22157 };
22158
22167 interface IPerformanceMetric : $unknown
22168 {
22174 readonly attribute wstring metricName;
22175
22181 readonly attribute $unknown object;
22182
22188 readonly attribute wstring description;
22189
22195 readonly attribute unsigned long period;
22196
22206 readonly attribute unsigned long count;
22207
22213 readonly attribute wstring unit;
22214
22220 readonly attribute long minimumValue;
22221
22227 readonly attribute long maximumValue;
22228
22229 };
22230
22337 interface IPerformanceCollector : $unknown
22338 {
22349 readonly attribute wstring[] metricNames;
22350
22374 void getMetrics (
22375 in wstring[] metricNames,
22376 in $unknown[] objects,
22377 [retval] out IPerformanceMetric[] metrics
22378 );
22379
22418 void setupMetrics (
22419 in wstring[] metricNames,
22420 in $unknown[] objects,
22421 in unsigned long period,
22422 in unsigned long count,
22423 [retval] out IPerformanceMetric[] affectedMetrics
22424 );
22425
22454 void enableMetrics (
22455 in wstring[] metricNames,
22456 in $unknown[] objects,
22457 [retval] out IPerformanceMetric[] affectedMetrics
22458 );
22459
22488 void disableMetrics (
22489 in wstring[] metricNames,
22490 in $unknown[] objects,
22491 [retval] out IPerformanceMetric[] affectedMetrics
22492 );
22493
22583 void queryMetricsData (
22584 in wstring[] metricNames,
22585 in $unknown[] objects,
22586 out wstring[] returnMetricNames,
22587 out $unknown[] returnObjects,
22588 out wstring[] returnUnits,
22589 out unsigned long[] returnScales,
22590 out unsigned long[] returnSequenceNumbers,
22591 out unsigned long[] returnDataIndices,
22592 out unsigned long[] returnDataLengths,
22593 [retval] out long[] returnData
22594 );
22595
22596 };
22597
22605 interface INATEngine : $unknown
22606 {
22611 attribute wstring network;
22612
22619 attribute wstring hostIP;
22620
22625 attribute wstring TFTPPrefix;
22626
22631 attribute wstring TFTPBootFile;
22632
22640 attribute wstring TFTPNextServer;
22641
22645 attribute unsigned long aliasMode;
22646
22650 attribute boolean DNSPassDomain;
22651
22656 attribute boolean DNSProxy;
22657
22662 attribute boolean DNSUseHostResolver;
22663
22668 readonly attribute wstring[] redirects;
22669
22685 void setNetworkSettings (
22686 in unsigned long mtu,
22687 in unsigned long sockSnd,
22688 in unsigned long sockRcv,
22689 in unsigned long TcpWndSnd,
22690 in unsigned long TcpWndRcv
22691 );
22692
22697 void getNetworkSettings (
22698 out unsigned long mtu,
22699 out unsigned long sockSnd,
22700 out unsigned long sockRcv,
22701 out unsigned long TcpWndSnd,
22702 out unsigned long TcpWndRcv
22703 );
22704
22724 void addRedirect (
22725 in wstring name,
22726 in NATProtocol proto,
22727 in wstring hostIP,
22728 in unsigned short hostPort,
22729 in wstring guestIP,
22730 in unsigned short guestPort
22731 );
22732
22738 void removeRedirect (
22739 in wstring name
22740 );
22741
22742 };
22743
22752 interface IExtPackPlugIn : $unknown
22753 {
22757 readonly attribute wstring name;
22758
22762 readonly attribute wstring description;
22763
22769 readonly attribute wstring frontend;
22770
22774 readonly attribute wstring modulePath;
22775
22776 };
22777
22786 interface IExtPackBase : $unknown
22787 {
22791 readonly attribute wstring name;
22792
22796 readonly attribute wstring description;
22797
22809 readonly attribute wstring version;
22810
22814 readonly attribute unsigned long revision;
22815
22825 readonly attribute wstring edition;
22826
22830 readonly attribute wstring VRDEModule;
22831
22835 readonly attribute IExtPackPlugIn[] plugIns;
22836
22846 readonly attribute boolean usable;
22847
22854 readonly attribute wstring whyUnusable;
22855
22859 readonly attribute boolean showLicense;
22860
22869 readonly attribute wstring license;
22870
22894 void queryLicense (
22895 in wstring preferredLocale,
22896 in wstring preferredLanguage,
22897 in wstring format,
22898 [retval] out wstring licenseText
22899 );
22900
22901 };
22902
22911 interface IExtPack : IExtPackBase
22912 {
22924 void queryObject (
22925 in wstring objUuid,
22926 [retval] out $unknown returnInterface
22927 );
22928
22929 };
22930
22940 interface IExtPackFile : IExtPackBase
22941 {
22947 readonly attribute wstring filePath;
22948
22967 void install (
22968 in boolean replace,
22969 in wstring displayInfo,
22970 [retval] out IProgress progess
22971 );
22972
22973 };
22974
22985 interface IExtPackManager : $unknown
22986 {
22992 readonly attribute IExtPack[] installedExtPacks;
22993
23011 void find (
23012 in wstring name,
23013 [retval] out IExtPack returnData
23014 );
23015
23027 void openExtPackFile (
23028 in wstring path,
23029 [retval] out IExtPackFile file
23030 );
23031
23050 void uninstall (
23051 in wstring name,
23052 in boolean forcedRemoval,
23053 in wstring displayInfo,
23054 [retval] out IProgress progess
23055 );
23056
23060 void cleanup();
23061
23074 void queryAllPlugInsForFrontend (
23075 in wstring frontendName,
23076 [retval] out wstring[] plugInModules
23077 );
23078
23086 void isExtPackUsable (
23087 in wstring name,
23088 [retval] out boolean usable
23089 );
23090
23091 };
23092
23098 interface IBandwidthGroup : $unknown
23099 {
23103 readonly attribute wstring name;
23104
23108 readonly attribute BandwidthGroupType type;
23109
23113 readonly attribute unsigned long reference;
23114
23119 attribute long long maxBytesPerSec;
23120
23121 };
23122
23131 interface IBandwidthControl : $unknown
23132 {
23138 readonly attribute unsigned long numGroups;
23139
23152 void createBandwidthGroup (
23153 in wstring name,
23154 in BandwidthGroupType type,
23155 in long long maxBytesPerSec
23156 );
23157
23165 void deleteBandwidthGroup (
23166 in wstring name
23167 );
23168
23178 void getBandwidthGroup (
23179 in wstring name,
23180 [retval] out IBandwidthGroup bandwidthGroup
23181 );
23182
23190 void getAllBandwidthGroups (
23191 [retval] out IBandwidthGroup[] bandwidthGroups
23192 );
23193
23194 };
23195
23208 interface IVirtualBoxClient : $unknown
23209 {
23215 readonly attribute IVirtualBox virtualBox;
23216
23222 readonly attribute ISession session;
23223
23229 readonly attribute IEventSource eventSource;
23230
23241 void checkMachineError (
23242 in IMachine machine
23243 );
23244
23245 };
23246
23260 interface IEventSource : $unknown
23261 {
23267 void createListener (
23268 [retval] out IEventListener listener
23269 );
23270
23286 void createAggregator (
23287 in IEventSource[] subordinates,
23288 [retval] out IEventSource result
23289 );
23290
23323 void registerListener (
23324 in IEventListener listener,
23325 in VBoxEventType[] interesting,
23326 in boolean active
23327 );
23328
23337 void unregisterListener (
23338 in IEventListener listener
23339 );
23340
23355 void fireEvent (
23356 in IEvent event,
23357 in long timeout,
23358 [retval] out boolean result
23359 );
23360
23385 void getEvent (
23386 in IEventListener listener,
23387 in long timeout,
23388 [retval] out IEvent event
23389 );
23390
23402 void eventProcessed (
23403 in IEventListener listener,
23404 in IEvent event
23405 );
23406
23407 };
23408
23418 interface IEventListener : $unknown
23419 {
23432 void handleEvent (
23433 in IEvent event
23434 );
23435
23436 };
23437
23514 interface IEvent : $unknown
23515 {
23521 readonly attribute VBoxEventType type;
23522
23528 readonly attribute IEventSource source;
23529
23540 readonly attribute boolean waitable;
23541
23548 void setProcessed();
23549
23563 void waitProcessed (
23564 in long timeout,
23565 [retval] out boolean result
23566 );
23567
23568 };
23569
23575 interface IReusableEvent : IEvent
23576 {
23580 readonly attribute unsigned long generation;
23581
23588 void reuse();
23589
23590 };
23591
23597 interface IMachineEvent : IEvent
23598 {
23602 readonly attribute wstringUUID machineId;
23603
23604 };
23605
23611 interface IMachineStateChangedEvent : IMachineEvent
23612 {
23616 readonly attribute MachineState state;
23617
23618 };
23619
23627 interface IMachineDataChangedEvent : IMachineEvent
23628 {
23635 readonly attribute boolean temporary;
23636
23637 };
23638
23647 interface IMediumRegisteredEvent : IEvent
23648 {
23652 readonly attribute wstringUUID mediumId;
23653
23657 readonly attribute DeviceType mediumType;
23658
23665 readonly attribute boolean registered;
23666
23667 };
23668
23677 interface IMachineRegisteredEvent : IMachineEvent
23678 {
23685 readonly attribute boolean registered;
23686
23687 };
23688
23698 interface ISessionStateChangedEvent : IMachineEvent
23699 {
23705 readonly attribute SessionState state;
23706
23707 };
23708
23716 interface IGuestPropertyChangedEvent : IMachineEvent
23717 {
23723 readonly attribute wstring name;
23724
23730 readonly attribute wstring value;
23731
23737 readonly attribute wstring flags;
23738
23739 };
23740
23746 interface ISnapshotEvent : IMachineEvent
23747 {
23751 readonly attribute wstringUUID snapshotId;
23752
23753 };
23754
23764 interface ISnapshotTakenEvent : ISnapshotEvent
23765 {
23766 };
23767
23784 interface ISnapshotDeletedEvent : ISnapshotEvent
23785 {
23786 };
23787
23797 interface ISnapshotChangedEvent : ISnapshotEvent
23798 {
23799 };
23800
23809 interface IMousePointerShapeChangedEvent : IEvent
23810 {
23816 readonly attribute boolean visible;
23817
23823 readonly attribute boolean alpha;
23824
23830 readonly attribute unsigned long xhot;
23831
23837 readonly attribute unsigned long yhot;
23838
23844 readonly attribute unsigned long width;
23845
23851 readonly attribute unsigned long height;
23852
23885 readonly attribute octet[] shape;
23886
23887 };
23888
23897 interface IMouseCapabilityChangedEvent : IEvent
23898 {
23904 readonly attribute boolean supportsAbsolute;
23905
23911 readonly attribute boolean supportsRelative;
23912
23918 readonly attribute boolean supportsMultiTouch;
23919
23925 readonly attribute boolean needsHostCursor;
23926
23927 };
23928
23937 interface IKeyboardLedsChangedEvent : IEvent
23938 {
23944 readonly attribute boolean numLock;
23945
23951 readonly attribute boolean capsLock;
23952
23958 readonly attribute boolean scrollLock;
23959
23960 };
23961
23970 interface IStateChangedEvent : IEvent
23971 {
23977 readonly attribute MachineState state;
23978
23979 };
23980
23990 interface IAdditionsStateChangedEvent : IEvent
23991 {
23992 };
23993
24004 interface INetworkAdapterChangedEvent : IEvent
24005 {
24011 readonly attribute INetworkAdapter networkAdapter;
24012
24013 };
24014
24025 interface ISerialPortChangedEvent : IEvent
24026 {
24032 readonly attribute ISerialPort serialPort;
24033
24034 };
24035
24046 interface IParallelPortChangedEvent : IEvent
24047 {
24053 readonly attribute IParallelPort parallelPort;
24054
24055 };
24056
24066 interface IStorageControllerChangedEvent : IEvent
24067 {
24068 };
24069
24079 interface IMediumChangedEvent : IEvent
24080 {
24086 readonly attribute IMediumAttachment mediumAttachment;
24087
24088 };
24089
24097 interface IClipboardModeChangedEvent : IEvent
24098 {
24104 readonly attribute ClipboardMode clipboardMode;
24105
24106 };
24107
24115 interface IDragAndDropModeChangedEvent : IEvent
24116 {
24122 readonly attribute DragAndDropMode dragAndDropMode;
24123
24124 };
24125
24133 interface ICPUChangedEvent : IEvent
24134 {
24140 readonly attribute unsigned long CPU;
24141
24147 readonly attribute boolean add;
24148
24149 };
24150
24158 interface ICPUExecutionCapChangedEvent : IEvent
24159 {
24165 readonly attribute unsigned long executionCap;
24166
24167 };
24168
24176 interface IGuestKeyboardEvent : IEvent
24177 {
24183 readonly attribute long[] scancodes;
24184
24185 };
24186
24194 interface IGuestMouseEvent : IReusableEvent
24195 {
24201 readonly attribute GuestMouseEventMode mode;
24202
24208 readonly attribute long x;
24209
24215 readonly attribute long y;
24216
24222 readonly attribute long z;
24223
24229 readonly attribute long w;
24230
24236 readonly attribute long buttons;
24237
24238 };
24239
24247 interface IGuestMultiTouchEvent : IEvent
24248 {
24254 readonly attribute long contactCount;
24255
24261 readonly attribute short[] xPositions;
24262
24268 readonly attribute short[] yPositions;
24269
24275 readonly attribute unsigned short[] contactIds;
24276
24284 readonly attribute unsigned short[] contactFlags;
24285
24291 readonly attribute unsigned long scanTime;
24292
24293 };
24294
24300 interface IGuestSessionEvent : IEvent
24301 {
24305 readonly attribute IGuestSession session;
24306
24307 };
24308
24316 interface IGuestSessionStateChangedEvent : IGuestSessionEvent
24317 {
24323 readonly attribute unsigned long id;
24324
24330 readonly attribute GuestSessionStatus status;
24331
24341 readonly attribute IVirtualBoxErrorInfo error;
24342
24343 };
24344
24352 interface IGuestSessionRegisteredEvent : IGuestSessionEvent
24353 {
24360 readonly attribute boolean registered;
24361
24362 };
24363
24369 interface IGuestProcessEvent : IGuestSessionEvent
24370 {
24376 readonly attribute IGuestProcess process;
24377
24383 readonly attribute unsigned long pid;
24384
24385 };
24386
24394 interface IGuestProcessRegisteredEvent : IGuestProcessEvent
24395 {
24402 readonly attribute boolean registered;
24403
24404 };
24405
24413 interface IGuestProcessStateChangedEvent : IGuestProcessEvent
24414 {
24420 readonly attribute ProcessStatus status;
24421
24431 readonly attribute IVirtualBoxErrorInfo error;
24432
24433 };
24434
24442 interface IGuestProcessIOEvent : IGuestProcessEvent
24443 {
24450 readonly attribute unsigned long handle;
24451
24457 readonly attribute unsigned long processed;
24458
24459 };
24460
24470 interface IGuestProcessInputNotifyEvent : IGuestProcessIOEvent
24471 {
24477 readonly attribute ProcessInputStatus status;
24478
24479 };
24480
24488 interface IGuestProcessOutputEvent : IGuestProcessIOEvent
24489 {
24495 readonly attribute octet[] data;
24496
24497 };
24498
24504 interface IGuestFileEvent : IGuestSessionEvent
24505 {
24511 readonly attribute IGuestFile file;
24512
24513 };
24514
24522 interface IGuestFileRegisteredEvent : IGuestFileEvent
24523 {
24530 readonly attribute boolean registered;
24531
24532 };
24533
24541 interface IGuestFileStateChangedEvent : IGuestFileEvent
24542 {
24548 readonly attribute FileStatus status;
24549
24559 readonly attribute IVirtualBoxErrorInfo error;
24560
24561 };
24562
24570 interface IGuestFileIOEvent : IGuestFileEvent
24571 {
24577 readonly attribute long long offset;
24578
24584 readonly attribute unsigned long processed;
24585
24586 };
24587
24595 interface IGuestFileOffsetChangedEvent : IGuestFileIOEvent
24596 {
24597 };
24598
24606 interface IGuestFileReadEvent : IGuestFileIOEvent
24607 {
24613 readonly attribute octet[] data;
24614
24615 };
24616
24624 interface IGuestFileWriteEvent : IGuestFileIOEvent
24625 {
24626 };
24627
24638 interface IVRDEServerChangedEvent : IEvent
24639 {
24640 };
24641
24651 interface IVRDEServerInfoChangedEvent : IEvent
24652 {
24653 };
24654
24662 interface IVideoCaptureChangedEvent : IEvent
24663 {
24664 };
24665
24676 interface IUSBControllerChangedEvent : IEvent
24677 {
24678 };
24679
24703 interface IUSBDeviceStateChangedEvent : IEvent
24704 {
24710 readonly attribute IUSBDevice device;
24711
24717 readonly attribute boolean attached;
24718
24724 readonly attribute IVirtualBoxErrorInfo error;
24725
24726 };
24727
24743 interface ISharedFolderChangedEvent : IEvent
24744 {
24750 readonly attribute Scope scope;
24751
24752 };
24753
24805 interface IRuntimeErrorEvent : IEvent
24806 {
24812 readonly attribute boolean fatal;
24813
24819 readonly attribute wstring id;
24820
24826 readonly attribute wstring message;
24827
24828 };
24829
24837 interface IEventSourceChangedEvent : IEvent
24838 {
24844 readonly attribute IEventListener listener;
24845
24851 readonly attribute boolean add;
24852
24853 };
24854
24863 interface IExtraDataChangedEvent : IEvent
24864 {
24871 readonly attribute wstringUUID machineId;
24872
24878 readonly attribute wstring key;
24879
24885 readonly attribute wstring value;
24886
24887 };
24888
24894 interface IVetoEvent : IEvent
24895 {
24905 void addVeto (
24906 in wstring reason
24907 );
24908
24918 void isVetoed (
24919 [retval] out boolean result
24920 );
24921
24931 void getVetos (
24932 [retval] out wstring[] result
24933 );
24934
24935 };
24936
24946 interface IExtraDataCanChangeEvent : IVetoEvent
24947 {
24954 readonly attribute wstringUUID machineId;
24955
24961 readonly attribute wstring key;
24962
24968 readonly attribute wstring value;
24969
24970 };
24971
24987 interface ICanShowWindowEvent : IVetoEvent
24988 {
24989 };
24990
25022 interface IShowWindowEvent : IEvent
25023 {
25032 attribute long long winId;
25033
25034 };
25035
25043 interface INATRedirectEvent : IMachineEvent
25044 {
25050 readonly attribute unsigned long slot;
25051
25057 readonly attribute boolean remove;
25058
25064 readonly attribute wstring name;
25065
25071 readonly attribute NATProtocol proto;
25072
25078 readonly attribute wstring hostIP;
25079
25085 readonly attribute long hostPort;
25086
25092 readonly attribute wstring guestIP;
25093
25099 readonly attribute long guestPort;
25100
25101 };
25102
25115 interface IHostPCIDevicePlugEvent : IMachineEvent
25116 {
25122 readonly attribute boolean plugged;
25123
25130 readonly attribute boolean success;
25131
25137 readonly attribute IPCIDeviceAttachment attachment;
25138
25144 readonly attribute wstring message;
25145
25146 };
25147
25156 interface IVBoxSVCAvailabilityChangedEvent : IEvent
25157 {
25163 readonly attribute boolean available;
25164
25165 };
25166
25174 interface IBandwidthGroupChangedEvent : IEvent
25175 {
25181 readonly attribute IBandwidthGroup bandwidthGroup;
25182
25183 };
25184
25192 interface IGuestMonitorChangedEvent : IEvent
25193 {
25199 readonly attribute GuestMonitorChangedEventType changeType;
25200
25206 readonly attribute unsigned long screenId;
25207
25214 readonly attribute unsigned long originX;
25215
25222 readonly attribute unsigned long originY;
25223
25230 readonly attribute unsigned long width;
25231
25238 readonly attribute unsigned long height;
25239
25240 };
25241
25249 interface IGuestUserStateChangedEvent : IEvent
25250 {
25256 readonly attribute wstring name;
25257
25264 readonly attribute wstring domain;
25265
25272 readonly attribute GuestUserState state;
25273
25279 readonly attribute wstring stateDetails;
25280
25281 };
25282
25292 interface IStorageDeviceChangedEvent : IEvent
25293 {
25299 readonly attribute IMediumAttachment storageDevice;
25300
25306 readonly attribute boolean removed;
25307
25313 readonly attribute boolean silent;
25314
25315 };
25316
25317 interface INATNetworkChangedEvent : IEvent
25318 {
25319 readonly attribute wstring networkName;
25320
25321 };
25322
25323 interface INATNetworkStartStopEvent : INATNetworkChangedEvent
25324 {
25330 readonly attribute boolean startEvent;
25331
25332 };
25333
25334 interface INATNetworkAlterEvent : INATNetworkChangedEvent
25335 {
25336 };
25337
25338 interface INATNetworkCreationDeletionEvent : INATNetworkAlterEvent
25339 {
25340 readonly attribute boolean creationEvent;
25341
25342 };
25343
25344 interface INATNetworkSettingEvent : INATNetworkAlterEvent
25345 {
25346 readonly attribute boolean enabled;
25347
25348 readonly attribute wstring network;
25349
25350 readonly attribute wstring gateway;
25351
25352 readonly attribute boolean advertiseDefaultIPv6RouteEnabled;
25353
25354 readonly attribute boolean needDhcpServer;
25355
25356 };
25357
25358 interface INATNetworkPortForwardEvent : INATNetworkAlterEvent
25359 {
25360 readonly attribute boolean create;
25361
25362 readonly attribute boolean ipv6;
25363
25364 readonly attribute wstring name;
25365
25366 readonly attribute NATProtocol proto;
25367
25368 readonly attribute wstring hostIp;
25369
25370 readonly attribute long hostPort;
25371
25372 readonly attribute wstring guestIp;
25373
25374 readonly attribute long guestPort;
25375
25376 };
25377
25378