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 };
03198
03206 enum NetworkAdapterType
03207 {
03212 NetworkAdapterType_Null = 0,
03217 NetworkAdapterType_Am79C970A = 1,
03222 NetworkAdapterType_Am79C973 = 2,
03227 NetworkAdapterType_I82540EM = 3,
03232 NetworkAdapterType_I82543GC = 4,
03237 NetworkAdapterType_I82545EM = 5,
03242 NetworkAdapterType_Virtio = 6,
03243 };
03244
03252 enum NetworkAdapterPromiscModePolicy
03253 {
03258 NetworkAdapterPromiscModePolicy_Deny = 1,
03266 NetworkAdapterPromiscModePolicy_AllowNetwork = 2,
03274 NetworkAdapterPromiscModePolicy_AllowAll = 3,
03275 };
03276
03285 enum PortMode
03286 {
03291 PortMode_Disconnected = 0,
03296 PortMode_HostPipe = 1,
03301 PortMode_HostDevice = 2,
03306 PortMode_RawFile = 3,
03307 };
03308
03316 enum USBControllerType
03317 {
03322 USBControllerType_Null = 0,
03323 USBControllerType_OHCI = 1,
03324 USBControllerType_EHCI = 2,
03329 USBControllerType_Last = 3,
03330 };
03331
03370 enum USBDeviceState
03371 {
03378 USBDeviceState_NotSupported = 0,
03386 USBDeviceState_Unavailable = 1,
03393 USBDeviceState_Busy = 2,
03401 USBDeviceState_Available = 3,
03409 USBDeviceState_Held = 4,
03417 USBDeviceState_Captured = 5,
03418 };
03419
03429 enum USBDeviceFilterAction
03430 {
03435 USBDeviceFilterAction_Null = 0,
03440 USBDeviceFilterAction_Ignore = 1,
03445 USBDeviceFilterAction_Hold = 2,
03446 };
03447
03455 enum AudioDriverType
03456 {
03461 AudioDriverType_Null = 0,
03466 AudioDriverType_WinMM = 1,
03471 AudioDriverType_OSS = 2,
03476 AudioDriverType_ALSA = 3,
03481 AudioDriverType_DirectSound = 4,
03486 AudioDriverType_CoreAudio = 5,
03491 AudioDriverType_MMPM = 6,
03496 AudioDriverType_Pulse = 7,
03501 AudioDriverType_SolAudio = 8,
03502 };
03503
03511 enum AudioControllerType
03512 {
03513 AudioControllerType_AC97 = 0,
03514 AudioControllerType_SB16 = 1,
03515 AudioControllerType_HDA = 2,
03516 };
03517
03525 enum AuthType
03526 {
03531 AuthType_Null = 0,
03532 AuthType_External = 1,
03533 AuthType_Guest = 2,
03534 };
03535
03543 enum Reason
03544 {
03549 Reason_Unspecified = 0,
03554 Reason_HostSuspend = 1,
03559 Reason_HostResume = 2,
03564 Reason_HostBatteryLow = 3,
03565 };
03566
03575 enum StorageBus
03576 {
03581 StorageBus_Null = 0,
03582 StorageBus_IDE = 1,
03583 StorageBus_SATA = 2,
03584 StorageBus_SCSI = 3,
03585 StorageBus_Floppy = 4,
03586 StorageBus_SAS = 5,
03587 };
03588
03597 enum StorageControllerType
03598 {
03603 StorageControllerType_Null = 0,
03608 StorageControllerType_LsiLogic = 1,
03613 StorageControllerType_BusLogic = 2,
03618 StorageControllerType_IntelAhci = 3,
03623 StorageControllerType_PIIX3 = 4,
03628 StorageControllerType_PIIX4 = 5,
03633 StorageControllerType_ICH6 = 6,
03638 StorageControllerType_I82078 = 7,
03643 StorageControllerType_LsiLogicSas = 8,
03644 };
03645
03653 enum ChipsetType
03654 {
03659 ChipsetType_Null = 0,
03664 ChipsetType_PIIX3 = 1,
03669 ChipsetType_ICH9 = 2,
03670 };
03671
03677 enum NATAliasMode
03678 {
03683 NATAliasMode_AliasLog = 0x1,
03688 NATAliasMode_AliasProxyOnly = 0x02,
03693 NATAliasMode_AliasUseSamePorts = 0x04,
03694 };
03695
03701 enum NATProtocol
03702 {
03707 NATProtocol_UDP = 0,
03712 NATProtocol_TCP = 1,
03713 };
03714
03722 enum BandwidthGroupType
03723 {
03730 BandwidthGroupType_Null = 0,
03737 BandwidthGroupType_Disk = 1,
03744 BandwidthGroupType_Network = 2,
03745 };
03746
03755 enum VBoxEventType
03756 {
03763 VBoxEventType_Invalid = 0,
03772 VBoxEventType_Any = 1,
03780 VBoxEventType_Vetoable = 2,
03788 VBoxEventType_MachineEvent = 3,
03796 VBoxEventType_SnapshotEvent = 4,
03805 VBoxEventType_InputEvent = 5,
03812 VBoxEventType_LastWildcard = 31,
03819 VBoxEventType_OnMachineStateChanged = 32,
03826 VBoxEventType_OnMachineDataChanged = 33,
03833 VBoxEventType_OnExtraDataChanged = 34,
03840 VBoxEventType_OnExtraDataCanChange = 35,
03847 VBoxEventType_OnMediumRegistered = 36,
03854 VBoxEventType_OnMachineRegistered = 37,
03861 VBoxEventType_OnSessionStateChanged = 38,
03868 VBoxEventType_OnSnapshotTaken = 39,
03875 VBoxEventType_OnSnapshotDeleted = 40,
03882 VBoxEventType_OnSnapshotChanged = 41,
03889 VBoxEventType_OnGuestPropertyChanged = 42,
03896 VBoxEventType_OnMousePointerShapeChanged = 43,
03903 VBoxEventType_OnMouseCapabilityChanged = 44,
03910 VBoxEventType_OnKeyboardLedsChanged = 45,
03917 VBoxEventType_OnStateChanged = 46,
03924 VBoxEventType_OnAdditionsStateChanged = 47,
03931 VBoxEventType_OnNetworkAdapterChanged = 48,
03938 VBoxEventType_OnSerialPortChanged = 49,
03945 VBoxEventType_OnParallelPortChanged = 50,
03952 VBoxEventType_OnStorageControllerChanged = 51,
03959 VBoxEventType_OnMediumChanged = 52,
03966 VBoxEventType_OnVRDEServerChanged = 53,
03973 VBoxEventType_OnUSBControllerChanged = 54,
03980 VBoxEventType_OnUSBDeviceStateChanged = 55,
03987 VBoxEventType_OnSharedFolderChanged = 56,
03994 VBoxEventType_OnRuntimeError = 57,
04001 VBoxEventType_OnCanShowWindow = 58,
04008 VBoxEventType_OnShowWindow = 59,
04015 VBoxEventType_OnCPUChanged = 60,
04022 VBoxEventType_OnVRDEServerInfoChanged = 61,
04029 VBoxEventType_OnEventSourceChanged = 62,
04036 VBoxEventType_OnCPUExecutionCapChanged = 63,
04043 VBoxEventType_OnGuestKeyboard = 64,
04050 VBoxEventType_OnGuestMouse = 65,
04057 VBoxEventType_OnNATRedirect = 66,
04064 VBoxEventType_OnHostPCIDevicePlug = 67,
04071 VBoxEventType_OnVBoxSVCAvailabilityChanged = 68,
04078 VBoxEventType_OnBandwidthGroupChanged = 69,
04085 VBoxEventType_OnGuestMonitorChanged = 70,
04092 VBoxEventType_OnStorageDeviceChanged = 71,
04099 VBoxEventType_OnClipboardModeChanged = 72,
04106 VBoxEventType_OnDragAndDropModeChanged = 73,
04113 VBoxEventType_OnNATNetworkChanged = 74,
04120 VBoxEventType_OnNATNetworkStartStop = 75,
04127 VBoxEventType_OnNATNetworkAlter = 76,
04134 VBoxEventType_OnNATNetworkCreationDeletion = 77,
04141 VBoxEventType_OnNATNetworkSetting = 78,
04148 VBoxEventType_OnNATNetworkPortForward = 79,
04155 VBoxEventType_OnGuestSessionStateChanged = 80,
04162 VBoxEventType_OnGuestSessionRegistered = 81,
04169 VBoxEventType_OnGuestProcessRegistered = 82,
04176 VBoxEventType_OnGuestProcessStateChanged = 83,
04183 VBoxEventType_OnGuestProcessInputNotify = 84,
04190 VBoxEventType_OnGuestProcessOutput = 85,
04197 VBoxEventType_OnGuestFileRegistered = 86,
04204 VBoxEventType_OnGuestFileStateChanged = 87,
04211 VBoxEventType_OnGuestFileOffsetChanged = 88,
04219 VBoxEventType_OnGuestFileRead = 89,
04227 VBoxEventType_OnGuestFileWrite = 90,
04234 VBoxEventType_OnVideoCaptureChanged = 91,
04241 VBoxEventType_OnGuestUserStateChanged = 92,
04248 VBoxEventType_OnGuestMultiTouch = 93,
04255 VBoxEventType_Last = 94,
04256 };
04257
04269 enum GuestMouseEventMode
04270 {
04277 GuestMouseEventMode_Relative = 0,
04284 GuestMouseEventMode_Absolute = 1,
04285 };
04286
04294 enum GuestMonitorChangedEventType
04295 {
04302 GuestMonitorChangedEventType_Enabled = 0,
04309 GuestMonitorChangedEventType_Disabled = 1,
04316 GuestMonitorChangedEventType_NewOrigin = 2,
04317 };
04318
04352 interface IVirtualBoxErrorInfo : $errorinfo
04353 {
04371 readonly attribute long resultCode;
04372
04379 readonly attribute long resultDetail;
04380
04392 readonly attribute wstringUUID interfaceID;
04393
04404 readonly attribute wstring component;
04405
04416 readonly attribute wstring text;
04417
04428 readonly attribute IVirtualBoxErrorInfo next;
04429
04430 };
04431
04432 interface INATNetwork : $unknown
04433 {
04442 attribute wstring networkName;
04443
04444 attribute boolean enabled;
04445
04454 attribute wstring network;
04455
04462 readonly attribute wstring gateway;
04463
04469 attribute boolean IPv6Enabled;
04470
04478 attribute wstring IPv6Prefix;
04479
04480 attribute boolean advertiseDefaultIPv6RouteEnabled;
04481
04482 attribute boolean needDhcpServer;
04483
04484 readonly attribute IEventSource eventSource;
04485
04492 readonly attribute wstring[] portForwardRules4;
04493
04498 readonly attribute wstring[] localMappings;
04499
04504 attribute long loopbackIp6;
04505
04511 readonly attribute wstring[] portForwardRules6;
04512
04516 void addLocalMapping (
04517 in wstring hostid,
04518 in long offset
04519 );
04520
04521 void addPortForwardRule (
04522 in boolean isIpv6,
04523 in wstring ruleName,
04524 in NATProtocol proto,
04525 in wstring hostIP,
04526 in unsigned short hostPort,
04527 in wstring guestIP,
04528 in unsigned short guestPort
04529 );
04530
04531 void removePortForwardRule (
04532 in boolean iSipv6,
04533 in wstring ruleName
04534 );
04535
04536 void start (
04537 in wstring trunkType
04538 );
04539
04540 void stop();
04541
04542 };
04543
04554 interface IDHCPServer : $unknown
04555 {
04556 readonly attribute IEventSource eventSource;
04557
04563 attribute boolean enabled;
04564
04570 readonly attribute wstring IPAddress;
04571
04577 readonly attribute wstring networkMask;
04578
04584 readonly attribute wstring networkName;
04585
04591 readonly attribute wstring lowerIP;
04592
04598 readonly attribute wstring upperIP;
04599
04600 readonly attribute wstring[] globalOptions;
04601
04602 readonly attribute wstring[] vmConfigs;
04603
04604 void addGlobalOption (
04605 in DhcpOpt option,
04606 in wstring value
04607 );
04608
04609 void addVmSlotOption (
04610 in wstring vmname,
04611 in long slot,
04612 in DhcpOpt option,
04613 in wstring value
04614 );
04615
04616 void removeVmSlotOptions (
04617 in wstring vmname,
04618 in long slot
04619 );
04620
04621 void getVmSlotOptions (
04622 in wstring vmname,
04623 in long slot,
04624 [retval] out wstring[] option
04625 );
04626
04627 void getMacOptions (
04628 in wstring mac,
04629 [retval] out wstring[] option
04630 );
04631
04660 void setConfiguration (
04661 in wstring IPAddress,
04662 in wstring networkMask,
04663 in wstring FromIPAddress,
04664 in wstring ToIPAddress
04665 );
04666
04691 void start (
04692 in wstring networkName,
04693 in wstring trunkName,
04694 in wstring trunkType
04695 );
04696
04709 void stop();
04710
04711 };
04712
04731 interface IVirtualBox : $unknown
04732 {
04745 readonly attribute wstring version;
04746
04754 readonly attribute wstring versionNormalized;
04755
04761 readonly attribute unsigned long revision;
04762
04772 readonly attribute wstring packageType;
04773
04785 readonly attribute wstring APIVersion;
04786
04802 readonly attribute wstring homeFolder;
04803
04811 readonly attribute wstring settingsFilePath;
04812
04816 readonly attribute IHost host;
04817
04821 readonly attribute ISystemProperties systemProperties;
04822
04828 readonly attribute IMachine[] machines;
04829
04839 readonly attribute wstring[] machineGroups;
04840
04850 readonly attribute IMedium[] hardDisks;
04851
04857 readonly attribute IMedium[] DVDImages;
04858
04864 readonly attribute IMedium[] floppyImages;
04865
04866 readonly attribute IProgress[] progressOperations;
04867
04868 readonly attribute IGuestOSType[] guestOSTypes;
04869
04886 readonly attribute ISharedFolder[] sharedFolders;
04887
04893 readonly attribute IPerformanceCollector performanceCollector;
04894
04900 readonly attribute IDHCPServer[] DHCPServers;
04901
04902 readonly attribute INATNetwork[] NATNetworks;
04903
04909 readonly attribute IEventSource eventSource;
04910
04916 readonly attribute IExtPackManager extensionPackManager;
04917
04923 readonly attribute wstring[] internalNetworks;
04924
04930 readonly attribute wstring[] genericNetworkDrivers;
04931
04982 void composeMachineFilename (
04983 in wstring name,
04984 in wstring group,
04985 in wstring createFlags,
04986 in wstring baseFolder,
04987 [retval] out wstring file
04988 );
04989
05096 void createMachine (
05097 in wstring settingsFile,
05098 in wstring name,
05099 in wstring[] groups,
05100 in wstring osTypeId,
05101 in wstring flags,
05102 [retval] out IMachine machine
05103 );
05104
05135 void openMachine (
05136 in wstring settingsFile,
05137 [retval] out IMachine machine
05138 );
05139
05171 void registerMachine (
05172 in IMachine machine
05173 );
05174
05195 void findMachine (
05196 in wstring nameOrId,
05197 [retval] out IMachine machine
05198 );
05199
05211 void getMachinesByGroups (
05212 in wstring[] groups,
05213 [retval] out IMachine[] machines
05214 );
05215
05225 void getMachineStates (
05226 in IMachine[] machines,
05227 [retval] out MachineState[] states
05228 );
05229
05239 void createAppliance (
05240 [retval] out IAppliance appliance
05241 );
05242
05305 void createHardDisk (
05306 in wstring format,
05307 in wstring location,
05308 [retval] out IMedium medium
05309 );
05310
05416 void openMedium (
05417 in wstring location,
05418 in DeviceType deviceType,
05419 in AccessMode accessMode,
05420 in boolean forceNewUuid,
05421 [retval] out IMedium medium
05422 );
05423
05452 void getGuestOSType (
05453 in wstringUUID id,
05454 [retval] out IGuestOSType type
05455 );
05456
05479 void createSharedFolder (
05480 in wstring name,
05481 in wstring hostPath,
05482 in boolean writable,
05483 in boolean automount
05484 );
05485
05500 void removeSharedFolder (
05501 in wstring name
05502 );
05503
05512 void getExtraDataKeys (
05513 [retval] out wstring[] keys
05514 );
05515
05544 void getExtraData (
05545 in wstring key,
05546 [retval] out wstring value
05547 );
05548
05598 void setExtraData (
05599 in wstring key,
05600 in wstring value
05601 );
05602
05621 void setSettingsSecret (
05622 in wstring password
05623 );
05624
05641 void createDHCPServer (
05642 in wstring name,
05643 [retval] out IDHCPServer server
05644 );
05645
05662 void findDHCPServerByNetworkName (
05663 in wstring name,
05664 [retval] out IDHCPServer server
05665 );
05666
05681 void removeDHCPServer (
05682 in IDHCPServer server
05683 );
05684
05685 void createNATNetwork (
05686 in wstring networkName,
05687 [retval] out INATNetwork network
05688 );
05689
05690 void findNATNetworkByName (
05691 in wstring networkName,
05692 [retval] out INATNetwork network
05693 );
05694
05695 void removeNATNetwork (
05696 in INATNetwork network
05697 );
05698
05723 void checkFirmwarePresent (
05724 in FirmwareType firmwareType,
05725 in wstring version,
05726 out wstring url,
05727 out wstring file,
05728 [retval] out boolean result
05729 );
05730
05731 };
05732
05743 interface IVFSExplorer : $unknown
05744 {
05748 readonly attribute wstring path;
05749
05753 readonly attribute VFSType type;
05754
05762 void update (
05763 [retval] out IProgress progress
05764 );
05765
05773 void cd (
05774 in wstring dir,
05775 [retval] out IProgress progress
05776 );
05777
05783 void cdUp (
05784 [retval] out IProgress progress
05785 );
05786
05799 void entryList (
05800 out wstring[] names,
05801 out unsigned long[] types,
05802 out long long[] sizes,
05803 out unsigned long[] modes
05804 );
05805
05814 void exists (
05815 in wstring[] names,
05816 [retval] out wstring[] exists
05817 );
05818
05826 void remove (
05827 in wstring[] names,
05828 [retval] out IProgress progress
05829 );
05830
05831 };
05832
05898 interface IAppliance : $unknown
05899 {
05907 readonly attribute wstring path;
05908
05939 readonly attribute wstring[] disks;
05940
05948 readonly attribute IVirtualSystemDescription[] virtualSystemDescriptions;
05949
05957 readonly attribute wstring[] machines;
05958
05975 void read (
05976 in wstring file,
05977 [retval] out IProgress progress
05978 );
05979
05996 void interpret();
05997
06020 void importMachines (
06021 in ImportOptions[] options,
06022 [retval] out IProgress progress
06023 );
06024
06032 void createVFSExplorer (
06033 in wstring URI,
06034 [retval] out IVFSExplorer explorer
06035 );
06036
06066 void write (
06067 in wstring format,
06068 in boolean manifest,
06069 in wstring path,
06070 [retval] out IProgress progress
06071 );
06072
06078 void getWarnings (
06079 [retval] out wstring[] warnings
06080 );
06081
06082 };
06083
06095 interface IVirtualSystemDescription : $unknown
06096 {
06100 readonly attribute unsigned long count;
06101
06225 void getDescription (
06226 out VirtualSystemDescriptionType[] types,
06227 out wstring[] refs,
06228 out wstring[] OVFValues,
06229 out wstring[] VBoxValues,
06230 out wstring[] extraConfigValues
06231 );
06232
06249 void getDescriptionByType (
06250 in VirtualSystemDescriptionType type,
06251 out VirtualSystemDescriptionType[] types,
06252 out wstring[] refs,
06253 out wstring[] OVFValues,
06254 out wstring[] VBoxValues,
06255 out wstring[] extraConfigValues
06256 );
06257
06269 void getValuesByType (
06270 in VirtualSystemDescriptionType type,
06271 in VirtualSystemDescriptionValueType which,
06272 [retval] out wstring[] values
06273 );
06274
06300 void setFinalValues (
06301 in boolean[] enabled,
06302 in wstring[] VBoxValues,
06303 in wstring[] extraConfigValues
06304 );
06305
06320 void addDescription (
06321 in VirtualSystemDescriptionType type,
06322 in wstring VBoxValue,
06323 in wstring extraConfigValue
06324 );
06325
06326 };
06327
06328 interface IInternalMachineControl : $unknown
06329 {
06336 void setRemoveSavedStateFile (
06337 in boolean remove
06338 );
06339
06351 void updateState (
06352 in MachineState state
06353 );
06354
06366 void beginPowerUp (
06367 in IProgress progress
06368 );
06369
06379 void endPowerUp (
06380 in long result
06381 );
06382
06394 void beginPoweringDown (
06395 out IProgress progress
06396 );
06397
06427 void endPoweringDown (
06428 in long result,
06429 in wstring errMsg
06430 );
06431
06445 void runUSBDeviceFilters (
06446 in IUSBDevice device,
06447 out boolean matched,
06448 out unsigned long maskedInterfaces
06449 );
06450
06459 void captureUSBDevice (
06460 in wstringUUID id
06461 );
06462
06478 void detachUSBDevice (
06479 in wstringUUID id,
06480 in boolean done
06481 );
06482
06491 void autoCaptureUSBDevices();
06492
06508 void detachAllUSBDevices (
06509 in boolean done
06510 );
06511
06526 void onSessionEnd (
06527 in ISession session,
06528 [retval] out IProgress progress
06529 );
06530
06546 void beginSavingState (
06547 out IProgress progress,
06548 out wstring stateFilePath
06549 );
06550
06580 void endSavingState (
06581 in long result,
06582 in wstring errMsg
06583 );
06584
06599 void adoptSavedState (
06600 in wstring savedStateFile
06601 );
06602
06651 void beginTakingSnapshot (
06652 in IConsole initiator,
06653 in wstring name,
06654 in wstring description,
06655 in IProgress consoleProgress,
06656 in boolean fTakingSnapshotOnline,
06657 out wstring stateFilePath
06658 );
06659
06669 void endTakingSnapshot (
06670 in boolean success
06671 );
06672
06701 void deleteSnapshot (
06702 in IConsole initiator,
06703 in wstringUUID startId,
06704 in wstringUUID endId,
06705 in boolean deleteAllChildren,
06706 out MachineState machineState,
06707 [retval] out IProgress progress
06708 );
06709
06716 void finishOnlineMergeMedium();
06717
06731 void restoreSnapshot (
06732 in IConsole initiator,
06733 in ISnapshot snapshot,
06734 out MachineState machineState,
06735 [retval] out IProgress progress
06736 );
06737
06764 void pullGuestProperties (
06765 out wstring[] names,
06766 out wstring[] values,
06767 out long long[] timestamps,
06768 out wstring[] flags
06769 );
06770
06792 void pushGuestProperty (
06793 in wstring name,
06794 in wstring value,
06795 in long long timestamp,
06796 in wstring flags
06797 );
06798
06810 void lockMedia();
06811
06821 void unlockMedia();
06822
06838 void ejectMedium (
06839 in IMediumAttachment attachment,
06840 [retval] out IMediumAttachment newAttachment
06841 );
06842
06883 void reportVmStatistics (
06884 in unsigned long validStats,
06885 in unsigned long cpuUser,
06886 in unsigned long cpuKernel,
06887 in unsigned long cpuIdle,
06888 in unsigned long memTotal,
06889 in unsigned long memFree,
06890 in unsigned long memBalloon,
06891 in unsigned long memShared,
06892 in unsigned long memCache,
06893 in unsigned long pagedTotal,
06894 in unsigned long memAllocTotal,
06895 in unsigned long memFreeTotal,
06896 in unsigned long memBalloonTotal,
06897 in unsigned long memSharedTotal,
06898 in unsigned long vmNetRx,
06899 in unsigned long vmNetTx
06900 );
06901
06902 };
06903
06912 interface IBIOSSettings : $unknown
06913 {
06917 attribute boolean logoFadeIn;
06918
06922 attribute boolean logoFadeOut;
06923
06927 attribute unsigned long logoDisplayTime;
06928
06935 attribute wstring logoImagePath;
06936
06940 attribute BIOSBootMenuMode bootMenuMode;
06941
06945 attribute boolean ACPIEnabled;
06946
06953 attribute boolean IOAPICEnabled;
06954
06964 attribute long long timeOffset;
06965
06972 attribute boolean PXEDebugEnabled;
06973
06974 };
06975
06983 interface IPCIAddress : $unknown
06984 {
06990 attribute short bus;
06991
06997 attribute short device;
06998
07004 attribute short devFunction;
07005
07011 void asLong (
07012 [retval] out long result
07013 );
07014
07020 void fromLong (
07021 in long number
07022 );
07023
07024 };
07025
07033 interface IPCIDeviceAttachment : $unknown
07034 {
07040 readonly attribute wstring name;
07041
07047 readonly attribute boolean isPhysicalDevice;
07048
07054 readonly attribute long hostAddress;
07055
07061 readonly attribute long guestAddress;
07062
07063 };
07064
07105 interface IMachine : $unknown
07106 {
07110 readonly attribute IVirtualBox parent;
07111
07115 attribute octet[] icon;
07116
07166 readonly attribute boolean accessible;
07167
07179 readonly attribute IVirtualBoxErrorInfo accessError;
07180
07220 attribute wstring name;
07221
07232 attribute wstring description;
07233
07237 readonly attribute wstringUUID id;
07238
07249 attribute wstring[] groups;
07250
07265 attribute wstring OSTypeId;
07266
07270 attribute wstring hardwareVersion;
07271
07281 attribute wstringUUID hardwareUUID;
07282
07286 attribute unsigned long CPUCount;
07287
07293 attribute boolean CPUHotPlugEnabled;
07294
07302 attribute unsigned long CPUExecutionCap;
07303
07307 attribute unsigned long memorySize;
07308
07312 attribute unsigned long memoryBalloonSize;
07313
07320 attribute boolean pageFusionEnabled;
07321
07325 attribute GraphicsControllerType graphicsControllerType;
07326
07330 attribute unsigned long VRAMSize;
07331
07337 attribute boolean accelerate3DEnabled;
07338
07344 attribute boolean accelerate2DVideoEnabled;
07345
07356 attribute unsigned long monitorCount;
07357
07363 attribute boolean videoCaptureEnabled;
07364
07370 attribute boolean[] videoCaptureScreens;
07371
07385 attribute wstring videoCaptureFile;
07386
07394 attribute unsigned long videoCaptureWidth;
07395
07403 attribute unsigned long videoCaptureHeight;
07404
07413 attribute unsigned long videoCaptureRate;
07414
07424 attribute unsigned long videoCaptureFPS;
07425
07429 readonly attribute IBIOSSettings BIOSSettings;
07430
07435 attribute FirmwareType firmwareType;
07436
07442 attribute PointingHIDType pointingHIDType;
07443
07449 attribute KeyboardHIDType keyboardHIDType;
07450
07457 attribute boolean HPETEnabled;
07458
07462 attribute ChipsetType chipsetType;
07463
07497 attribute wstring snapshotFolder;
07498
07502 readonly attribute IVRDEServer VRDEServer;
07503
07504 attribute boolean emulatedUSBWebcameraEnabled;
07505
07506 attribute boolean emulatedUSBCardReaderEnabled;
07507
07511 readonly attribute IMediumAttachment[] mediumAttachments;
07512
07524 readonly attribute IUSBController[] USBControllers;
07525
07537 readonly attribute IUSBDeviceFilters USBDeviceFilters;
07538
07542 readonly attribute IAudioAdapter audioAdapter;
07543
07547 readonly attribute IStorageController[] storageControllers;
07548
07554 readonly attribute wstring settingsFilePath;
07555
07580 readonly attribute boolean settingsModified;
07581
07585 readonly attribute SessionState sessionState;
07586
07599 readonly attribute wstring sessionType;
07600
07610 readonly attribute unsigned long sessionPID;
07611
07615 readonly attribute MachineState state;
07616
07623 readonly attribute long long lastStateChange;
07624
07636 readonly attribute wstring stateFilePath;
07637
07647 readonly attribute wstring logFolder;
07648
07659 readonly attribute ISnapshot currentSnapshot;
07660
07667 readonly attribute unsigned long snapshotCount;
07668
07700 readonly attribute boolean currentStateModified;
07701
07713 readonly attribute ISharedFolder[] sharedFolders;
07714
07721 attribute ClipboardMode clipboardMode;
07722
07728 attribute DragAndDropMode dragAndDropMode;
07729
07737 attribute wstring guestPropertyNotificationPatterns;
07738
07747 attribute boolean teleporterEnabled;
07748
07759 attribute unsigned long teleporterPort;
07760
07767 attribute wstring teleporterAddress;
07768
07779 attribute wstring teleporterPassword;
07780
07788 attribute FaultToleranceState faultToleranceState;
07789
07796 attribute unsigned long faultTolerancePort;
07797
07803 attribute wstring faultToleranceAddress;
07804
07812 attribute wstring faultTolerancePassword;
07813
07819 attribute unsigned long faultToleranceSyncInterval;
07820
07828 attribute boolean RTCUseUTC;
07829
07836 attribute boolean IOCacheEnabled;
07837
07843 attribute unsigned long IOCacheSize;
07844
07854 readonly attribute IPCIDeviceAttachment[] PCIDeviceAssignments;
07855
07861 readonly attribute IBandwidthControl bandwidthControl;
07862
07871 attribute boolean tracingEnabled;
07872
07887 attribute wstring tracingConfig;
07888
07901 attribute boolean allowTracingToAccessVM;
07902
07908 attribute boolean autostartEnabled;
07909
07915 attribute unsigned long autostartDelay;
07916
07922 attribute AutostopType autostopType;
07923
07939 attribute wstring defaultFrontend;
07940
07946 readonly attribute boolean USBProxyAvailable;
07947
08053 void lockMachine (
08054 in ISession session,
08055 in LockType lockType
08056 );
08057
08194 void launchVMProcess (
08195 in ISession session,
08196 in wstring type,
08197 in wstring environment,
08198 [retval] out IProgress progress
08199 );
08200
08238 void setBootOrder (
08239 in unsigned long position,
08240 in DeviceType device
08241 );
08242
08277 void getBootOrder (
08278 in unsigned long position,
08279 [retval] out DeviceType device
08280 );
08281
08383 void attachDevice (
08384 in wstring name,
08385 in long controllerPort,
08386 in long device,
08387 in DeviceType type,
08388 in IMedium medium
08389 );
08390
08486 void attachDeviceWithoutMedium (
08487 in wstring name,
08488 in long controllerPort,
08489 in long device,
08490 in DeviceType type
08491 );
08492
08546 void detachDevice (
08547 in wstring name,
08548 in long controllerPort,
08549 in long device
08550 );
08551
08594 void passthroughDevice (
08595 in wstring name,
08596 in long controllerPort,
08597 in long device,
08598 in boolean passthrough
08599 );
08600
08643 void temporaryEjectDevice (
08644 in wstring name,
08645 in long controllerPort,
08646 in long device,
08647 in boolean temporaryEject
08648 );
08649
08695 void nonRotationalDevice (
08696 in wstring name,
08697 in long controllerPort,
08698 in long device,
08699 in boolean nonRotational
08700 );
08701
08747 void setAutoDiscardForDevice (
08748 in wstring name,
08749 in long controllerPort,
08750 in long device,
08751 in boolean discard
08752 );
08753
08794 void setBandwidthGroupForDevice (
08795 in wstring name,
08796 in long controllerPort,
08797 in long device,
08798 in IBandwidthGroup bandwidthGroup
08799 );
08800
08837 void setNoBandwidthGroupForDevice (
08838 in wstring name,
08839 in long controllerPort,
08840 in long device
08841 );
08842
08907 void unmountMedium (
08908 in wstring name,
08909 in long controllerPort,
08910 in long device,
08911 in boolean force
08912 );
08913
08976 void mountMedium (
08977 in wstring name,
08978 in long controllerPort,
08979 in long device,
08980 in IMedium medium,
08981 in boolean force
08982 );
08983
09012 void getMedium (
09013 in wstring name,
09014 in long controllerPort,
09015 in long device,
09016 [retval] out IMedium medium
09017 );
09018
09033 void getMediumAttachmentsOfController (
09034 in wstring name,
09035 [retval] out IMediumAttachment[] mediumAttachments
09036 );
09037
09052 void getMediumAttachment (
09053 in wstring name,
09054 in long controllerPort,
09055 in long device,
09056 [retval] out IMediumAttachment attachment
09057 );
09058
09099 void attachHostPCIDevice (
09100 in long hostAddress,
09101 in long desiredGuestAddress,
09102 in boolean tryToUnbind
09103 );
09104
09145 void detachHostPCIDevice (
09146 in long hostAddress
09147 );
09148
09166 void getNetworkAdapter (
09167 in unsigned long slot,
09168 [retval] out INetworkAdapter adapter
09169 );
09170
09203 void addStorageController (
09204 in wstring name,
09205 in StorageBus connectionType,
09206 [retval] out IStorageController controller
09207 );
09208
09222 void getStorageControllerByName (
09223 in wstring name,
09224 [retval] out IStorageController storageController
09225 );
09226
09240 void getStorageControllerByInstance (
09241 in unsigned long instance,
09242 [retval] out IStorageController storageController
09243 );
09244
09267 void removeStorageController (
09268 in wstring name
09269 );
09270
09292 void setStorageControllerBootable (
09293 in wstring name,
09294 in boolean bootable
09295 );
09296
09319 void addUSBController (
09320 in wstring name,
09321 in USBControllerType type,
09322 [retval] out IUSBController controller
09323 );
09324
09338 void removeUSBController (
09339 in wstring name
09340 );
09341
09355 void getUSBControllerByName (
09356 in wstring name,
09357 [retval] out IUSBController controller
09358 );
09359
09365 void getUSBControllerCountByType (
09366 in USBControllerType type,
09367 [retval] out unsigned long controllers
09368 );
09369
09387 void getSerialPort (
09388 in unsigned long slot,
09389 [retval] out ISerialPort port
09390 );
09391
09409 void getParallelPort (
09410 in unsigned long slot,
09411 [retval] out IParallelPort port
09412 );
09413
09422 void getExtraDataKeys (
09423 [retval] out wstring[] keys
09424 );
09425
09454 void getExtraData (
09455 in wstring key,
09456 [retval] out wstring value
09457 );
09458
09508 void setExtraData (
09509 in wstring key,
09510 in wstring value
09511 );
09512
09534 void getCPUProperty (
09535 in CPUPropertyType property,
09536 [retval] out boolean value
09537 );
09538
09560 void setCPUProperty (
09561 in CPUPropertyType property,
09562 in boolean value
09563 );
09564
09604 void getCPUIDLeaf (
09605 in unsigned long id,
09606 out unsigned long valEax,
09607 out unsigned long valEbx,
09608 out unsigned long valEcx,
09609 out unsigned long valEdx
09610 );
09611
09655 void setCPUIDLeaf (
09656 in unsigned long id,
09657 in unsigned long valEax,
09658 in unsigned long valEbx,
09659 in unsigned long valEcx,
09660 in unsigned long valEdx
09661 );
09662
09680 void removeCPUIDLeaf (
09681 in unsigned long id
09682 );
09683
09689 void removeAllCPUIDLeaves();
09690
09712 void getHWVirtExProperty (
09713 in HWVirtExPropertyType property,
09714 [retval] out boolean value
09715 );
09716
09738 void setHWVirtExProperty (
09739 in HWVirtExPropertyType property,
09740 in boolean value
09741 );
09742
09788 void saveSettings();
09789
09813 void discardSettings();
09814
09898 void unregister (
09899 in CleanupMode cleanupMode,
09900 [retval] out IMedium[] media
09901 );
09902
09959 void deleteConfig (
09960 in IMedium[] media,
09961 [retval] out IProgress progress
09962 );
09963
09975 void exportTo (
09976 in IAppliance appliance,
09977 in wstring location,
09978 [retval] out IVirtualSystemDescription description
09979 );
09980
10004 void findSnapshot (
10005 in wstring nameOrId,
10006 [retval] out ISnapshot snapshot
10007 );
10008
10042 void createSharedFolder (
10043 in wstring name,
10044 in wstring hostPath,
10045 in boolean writable,
10046 in boolean automount
10047 );
10048
10074 void removeSharedFolder (
10075 in wstring name
10076 );
10077
10101 void canShowConsoleWindow (
10102 [retval] out boolean canShow
10103 );
10104
10139 void showConsoleWindow (
10140 [retval] out long long winId
10141 );
10142
10175 void getGuestProperty (
10176 in wstring name,
10177 out wstring value,
10178 out long long timestamp,
10179 out wstring flags
10180 );
10181
10204 void getGuestPropertyValue (
10205 in wstring property,
10206 [retval] out wstring value
10207 );
10208
10231 void getGuestPropertyTimestamp (
10232 in wstring property,
10233 [retval] out long long value
10234 );
10235
10286 void setGuestProperty (
10287 in wstring property,
10288 in wstring value,
10289 in wstring flags
10290 );
10291
10331 void setGuestPropertyValue (
10332 in wstring property,
10333 in wstring value
10334 );
10335
10353 void deleteGuestProperty (
10354 in wstring name
10355 );
10356
10387 void enumerateGuestProperties (
10388 in wstring patterns,
10389 out wstring[] names,
10390 out wstring[] values,
10391 out long long[] timestamps,
10392 out wstring[] flags
10393 );
10394
10424 void querySavedGuestScreenInfo (
10425 in unsigned long screenId,
10426 out unsigned long originX,
10427 out unsigned long originY,
10428 out unsigned long width,
10429 out unsigned long height,
10430 out boolean enabled
10431 );
10432
10454 void querySavedThumbnailSize (
10455 in unsigned long screenId,
10456 out unsigned long size,
10457 out unsigned long width,
10458 out unsigned long height
10459 );
10460
10487 void readSavedThumbnailToArray (
10488 in unsigned long screenId,
10489 in boolean BGR,
10490 out unsigned long width,
10491 out unsigned long height,
10492 [retval] out octet[] data
10493 );
10494
10516 void readSavedThumbnailPNGToArray (
10517 in unsigned long screenId,
10518 out unsigned long width,
10519 out unsigned long height,
10520 [retval] out octet[] data
10521 );
10522
10544 void querySavedScreenshotPNGSize (
10545 in unsigned long screenId,
10546 out unsigned long size,
10547 out unsigned long width,
10548 out unsigned long height
10549 );
10550
10572 void readSavedScreenshotPNGToArray (
10573 in unsigned long screenId,
10574 out unsigned long width,
10575 out unsigned long height,
10576 [retval] out octet[] data
10577 );
10578
10588 void hotPlugCPU (
10589 in unsigned long cpu
10590 );
10591
10601 void hotUnplugCPU (
10602 in unsigned long cpu
10603 );
10604
10618 void getCPUStatus (
10619 in unsigned long cpu,
10620 [retval] out boolean attached
10621 );
10622
10637 void queryLogFilename (
10638 in unsigned long idx,
10639 [retval] out wstring filename
10640 );
10641
10667 void readLog (
10668 in unsigned long idx,
10669 in long long offset,
10670 in long long size,
10671 [retval] out octet[] data
10672 );
10673
10706 void cloneTo (
10707 in IMachine target,
10708 in CloneMode mode,
10709 in CloneOptions[] options,
10710 [retval] out IProgress progress
10711 );
10712
10713 };
10714
10723 interface IVRDEServerInfo : $unknown
10724 {
10730 readonly attribute boolean active;
10731
10740 readonly attribute long port;
10741
10747 readonly attribute unsigned long numberOfClients;
10748
10754 readonly attribute long long beginTime;
10755
10762 readonly attribute long long endTime;
10763
10769 readonly attribute long long bytesSent;
10770
10776 readonly attribute long long bytesSentTotal;
10777
10783 readonly attribute long long bytesReceived;
10784
10790 readonly attribute long long bytesReceivedTotal;
10791
10797 readonly attribute wstring user;
10798
10804 readonly attribute wstring domain;
10805
10811 readonly attribute wstring clientName;
10812
10818 readonly attribute wstring clientIP;
10819
10825 readonly attribute unsigned long clientVersion;
10826
10834 readonly attribute unsigned long encryptionStyle;
10835
10836 };
10837
10859 interface IConsole : $unknown
10860 {
10872 readonly attribute IMachine machine;
10873
10887 readonly attribute MachineState state;
10888
10892 readonly attribute IGuest guest;
10893
10904 readonly attribute IKeyboard keyboard;
10905
10916 readonly attribute IMouse mouse;
10917
10927 readonly attribute IDisplay display;
10928
10932 readonly attribute IMachineDebugger debugger;
10933
10944 readonly attribute IUSBDevice[] USBDevices;
10945
10953 readonly attribute IHostUSBDevice[] remoteUSBDevices;
10954
10970 readonly attribute ISharedFolder[] sharedFolders;
10971
10977 readonly attribute IVRDEServerInfo VRDEServerInfo;
10978
10984 readonly attribute IEventSource eventSource;
10985
10989 readonly attribute IPCIDeviceAttachment[] attachedPCIDevices;
10990
10999 attribute boolean useHostClipboard;
11000
11065 void powerUp (
11066 [retval] out IProgress progress
11067 );
11068
11102 void powerUpPaused (
11103 [retval] out IProgress progress
11104 );
11105
11125 void powerDown (
11126 [retval] out IProgress progress
11127 );
11128
11148 void reset();
11149
11169 void pause();
11170
11190 void resume();
11191
11211 void powerButton();
11212
11232 void sleepButton();
11233
11245 void getPowerButtonHandled (
11246 [retval] out boolean handled
11247 );
11248
11262 void getGuestEnteredACPIMode (
11263 [retval] out boolean entered
11264 );
11265
11318 void saveState (
11319 [retval] out IProgress progress
11320 );
11321
11354 void adoptSavedState (
11355 in wstring savedStateFile
11356 );
11357
11388 void discardSavedState (
11389 in boolean fRemoveFile
11390 );
11391
11404 void getDeviceActivity (
11405 in DeviceType type,
11406 [retval] out DeviceActivity activity
11407 );
11408
11446 void attachUSBDevice (
11447 in wstringUUID id
11448 );
11449
11484 void detachUSBDevice (
11485 in wstringUUID id,
11486 [retval] out IUSBDevice device
11487 );
11488
11511 void findUSBDeviceByAddress (
11512 in wstring name,
11513 [retval] out IUSBDevice device
11514 );
11515
11535 void findUSBDeviceById (
11536 in wstringUUID id,
11537 [retval] out IUSBDevice device
11538 );
11539
11573 void createSharedFolder (
11574 in wstring name,
11575 in wstring hostPath,
11576 in boolean writable,
11577 in boolean automount
11578 );
11579
11604 void removeSharedFolder (
11605 in wstring name
11606 );
11607
11645 void takeSnapshot (
11646 in wstring name,
11647 in wstring description,
11648 [retval] out IProgress progress
11649 );
11650
11723 void deleteSnapshot (
11724 in wstringUUID id,
11725 [retval] out IProgress progress
11726 );
11727
11767 void deleteSnapshotAndAllChildren (
11768 in wstringUUID id,
11769 [retval] out IProgress progress
11770 );
11771
11815 void deleteSnapshotRange (
11816 in wstringUUID startId,
11817 in wstringUUID endId,
11818 [retval] out IProgress progress
11819 );
11820
11861 void restoreSnapshot (
11862 in ISnapshot snapshot,
11863 [retval] out IProgress progress
11864 );
11865
11904 void teleport (
11905 in wstring hostname,
11906 in unsigned long tcpport,
11907 in wstring password,
11908 in unsigned long maxDowntime,
11909 [retval] out IProgress progress
11910 );
11911
11912 };
11913
11924 interface IHostNetworkInterface : $unknown
11925 {
11929 readonly attribute wstring name;
11930
11934 readonly attribute wstring shortName;
11935
11939 readonly attribute wstringUUID id;
11940
11944 readonly attribute wstring networkName;
11945
11949 readonly attribute boolean DHCPEnabled;
11950
11954 readonly attribute wstring IPAddress;
11955
11959 readonly attribute wstring networkMask;
11960
11964 readonly attribute boolean IPV6Supported;
11965
11969 readonly attribute wstring IPV6Address;
11970
11974 readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
11975
11979 readonly attribute wstring hardwareAddress;
11980
11984 readonly attribute HostNetworkInterfaceMediumType mediumType;
11985
11989 readonly attribute HostNetworkInterfaceStatus status;
11990
11994 readonly attribute HostNetworkInterfaceType interfaceType;
11995
12007 void enableStaticIPConfig (
12008 in wstring IPAddress,
12009 in wstring networkMask
12010 );
12011
12023 void enableStaticIPConfigV6 (
12024 in wstring IPV6Address,
12025 in unsigned long IPV6NetworkMaskPrefixLength
12026 );
12027
12031 void enableDynamicIPConfig();
12032
12036 void DHCPRediscover();
12037
12038 };
12039
12056 interface IHost : $unknown
12057 {
12061 readonly attribute IMedium[] DVDDrives;
12062
12066 readonly attribute IMedium[] floppyDrives;
12067
12081 readonly attribute IHostUSBDevice[] USBDevices;
12082
12106 readonly attribute IHostUSBDeviceFilter[] USBDeviceFilters;
12107
12111 readonly attribute IHostNetworkInterface[] networkInterfaces;
12112
12116 readonly attribute wstring[] nameServers;
12117
12121 readonly attribute wstring domainName;
12122
12126 readonly attribute wstring[] searchStrings;
12127
12131 readonly attribute unsigned long processorCount;
12132
12136 readonly attribute unsigned long processorOnlineCount;
12137
12141 readonly attribute unsigned long processorCoreCount;
12142
12146 readonly attribute unsigned long memorySize;
12147
12151 readonly attribute unsigned long memoryAvailable;
12152
12156 readonly attribute wstring operatingSystem;
12157
12161 readonly attribute wstring OSVersion;
12162
12166 readonly attribute long long UTCTime;
12167
12171 readonly attribute boolean acceleration3DAvailable;
12172
12187 void getProcessorSpeed (
12188 in unsigned long cpuId,
12189 [retval] out unsigned long speed
12190 );
12191
12203 void getProcessorFeature (
12204 in ProcessorFeature feature,
12205 [retval] out boolean supported
12206 );
12207
12226 void getProcessorDescription (
12227 in unsigned long cpuId,
12228 [retval] out wstring description
12229 );
12230
12271 void getProcessorCPUIDLeaf (
12272 in unsigned long cpuId,
12273 in unsigned long leaf,
12274 in unsigned long subLeaf,
12275 out unsigned long valEax,
12276 out unsigned long valEbx,
12277 out unsigned long valEcx,
12278 out unsigned long valEdx
12279 );
12280
12301 void createHostOnlyNetworkInterface (
12302 out IHostNetworkInterface hostInterface,
12303 [retval] out IProgress progress
12304 );
12305
12326 void removeHostOnlyNetworkInterface (
12327 in wstringUUID id,
12328 [retval] out IProgress progress
12329 );
12330
12350 void createUSBDeviceFilter (
12351 in wstring name,
12352 [retval] out IHostUSBDeviceFilter filter
12353 );
12354
12397 void insertUSBDeviceFilter (
12398 in unsigned long position,
12399 in IHostUSBDeviceFilter filter
12400 );
12401
12429 void removeUSBDeviceFilter (
12430 in unsigned long position
12431 );
12432
12450 void findHostDVDDrive (
12451 in wstring name,
12452 [retval] out IMedium drive
12453 );
12454
12472 void findHostFloppyDrive (
12473 in wstring name,
12474 [retval] out IMedium drive
12475 );
12476
12492 void findHostNetworkInterfaceByName (
12493 in wstring name,
12494 [retval] out IHostNetworkInterface networkInterface
12495 );
12496
12512 void findHostNetworkInterfaceById (
12513 in wstringUUID id,
12514 [retval] out IHostNetworkInterface networkInterface
12515 );
12516
12526 void findHostNetworkInterfacesOfType (
12527 in HostNetworkInterfaceType type,
12528 [retval] out IHostNetworkInterface[] networkInterfaces
12529 );
12530
12550 void findUSBDeviceById (
12551 in wstringUUID id,
12552 [retval] out IHostUSBDevice device
12553 );
12554
12577 void findUSBDeviceByAddress (
12578 in wstring name,
12579 [retval] out IHostUSBDevice device
12580 );
12581
12589 void generateMACAddress (
12590 [retval] out wstring address
12591 );
12592
12593 };
12594
12607 interface ISystemProperties : $unknown
12608 {
12612 readonly attribute unsigned long minGuestRAM;
12613
12617 readonly attribute unsigned long maxGuestRAM;
12618
12622 readonly attribute unsigned long minGuestVRAM;
12623
12627 readonly attribute unsigned long maxGuestVRAM;
12628
12632 readonly attribute unsigned long minGuestCPUCount;
12633
12637 readonly attribute unsigned long maxGuestCPUCount;
12638
12642 readonly attribute unsigned long maxGuestMonitors;
12643
12648 readonly attribute long long infoVDSize;
12649
12656 readonly attribute unsigned long serialPortCount;
12657
12664 readonly attribute unsigned long parallelPortCount;
12665
12675 readonly attribute unsigned long maxBootPosition;
12676
12685 attribute boolean exclusiveHwVirt;
12686
12710 attribute wstring defaultMachineFolder;
12711
12717 attribute wstring loggingLevel;
12718
12743 readonly attribute IMediumFormat[] mediumFormats;
12744
12778 attribute wstring defaultHardDiskFormat;
12779
12785 attribute long long freeDiskSpaceWarning;
12786
12791 attribute unsigned long freeDiskSpacePercentWarning;
12792
12798 attribute long long freeDiskSpaceError;
12799
12804 attribute unsigned long freeDiskSpacePercentError;
12805
12829 attribute wstring VRDEAuthLibrary;
12830
12859 attribute wstring webServiceAuthLibrary;
12860
12874 attribute wstring defaultVRDEExtPack;
12875
12881 attribute unsigned long logHistoryCount;
12882
12887 readonly attribute AudioDriverType defaultAudioDriver;
12888
12895 attribute wstring autostartDatabasePath;
12896
12903 attribute wstring defaultAdditionsISO;
12904
12919 attribute wstring defaultFrontend;
12920
12931 void getMaxNetworkAdapters (
12932 in ChipsetType chipset,
12933 [retval] out unsigned long maxNetworkAdapters
12934 );
12935
12949 void getMaxNetworkAdaptersOfType (
12950 in ChipsetType chipset,
12951 in NetworkAttachmentType type,
12952 [retval] out unsigned long maxNetworkAdapters
12953 );
12954
12964 void getMaxDevicesPerPortForStorageBus (
12965 in StorageBus bus,
12966 [retval] out unsigned long maxDevicesPerPort
12967 );
12968
12976 void getMinPortCountForStorageBus (
12977 in StorageBus bus,
12978 [retval] out unsigned long minPortCount
12979 );
12980
12988 void getMaxPortCountForStorageBus (
12989 in StorageBus bus,
12990 [retval] out unsigned long maxPortCount
12991 );
12992
13005 void getMaxInstancesOfStorageBus (
13006 in ChipsetType chipset,
13007 in StorageBus bus,
13008 [retval] out unsigned long maxInstances
13009 );
13010
13020 void getDeviceTypesForStorageBus (
13021 in StorageBus bus,
13022 [retval] out DeviceType[] deviceTypes
13023 );
13024
13033 void getDefaultIoCacheSettingForStorageController (
13034 in StorageControllerType controllerType,
13035 [retval] out boolean enabled
13036 );
13037
13050 void getMaxInstancesOfUSBControllerType (
13051 in ChipsetType chipset,
13052 in USBControllerType type,
13053 [retval] out unsigned long maxInstances
13054 );
13055
13056 };
13057
13063 interface IGuestOSType : $unknown
13064 {
13068 readonly attribute wstring familyId;
13069
13073 readonly attribute wstring familyDescription;
13074
13078 readonly attribute wstring id;
13079
13083 readonly attribute wstring description;
13084
13088 readonly attribute boolean is64Bit;
13089
13093 readonly attribute boolean recommendedIOAPIC;
13094
13098 readonly attribute boolean recommendedVirtEx;
13099
13103 readonly attribute unsigned long recommendedRAM;
13104
13108 readonly attribute unsigned long recommendedVRAM;
13109
13113 readonly attribute boolean recommended2DVideoAcceleration;
13114
13118 readonly attribute boolean recommended3DAcceleration;
13119
13123 readonly attribute long long recommendedHDD;
13124
13128 readonly attribute NetworkAdapterType adapterType;
13129
13133 readonly attribute boolean recommendedPAE;
13134
13138 readonly attribute StorageControllerType recommendedDVDStorageController;
13139
13143 readonly attribute StorageBus recommendedDVDStorageBus;
13144
13148 readonly attribute StorageControllerType recommendedHDStorageController;
13149
13153 readonly attribute StorageBus recommendedHDStorageBus;
13154
13158 readonly attribute FirmwareType recommendedFirmware;
13159
13163 readonly attribute boolean recommendedUSBHID;
13164
13168 readonly attribute boolean recommendedHPET;
13169
13173 readonly attribute boolean recommendedUSBTablet;
13174
13178 readonly attribute boolean recommendedRTCUseUTC;
13179
13183 readonly attribute ChipsetType recommendedChipset;
13184
13188 readonly attribute AudioControllerType recommendedAudioController;
13189
13193 readonly attribute boolean recommendedFloppy;
13194
13198 readonly attribute boolean recommendedUSB;
13199
13200 };
13201
13209 interface IAdditionsFacility : $unknown
13210 {
13214 readonly attribute AdditionsFacilityClass classType;
13215
13222 readonly attribute long long lastUpdated;
13223
13227 readonly attribute wstring name;
13228
13232 readonly attribute AdditionsFacilityStatus status;
13233
13237 readonly attribute AdditionsFacilityType type;
13238
13239 };
13240
13269 interface IGuestSession : $unknown
13270 {
13276 readonly attribute wstring user;
13277
13283 readonly attribute wstring domain;
13284
13288 readonly attribute wstring name;
13289
13293 readonly attribute unsigned long id;
13294
13307 attribute unsigned long timeout;
13308
13313 readonly attribute unsigned long protocolVersion;
13314
13318 readonly attribute GuestSessionStatus status;
13319
13325 attribute wstring[] environment;
13326
13332 readonly attribute IGuestProcess[] processes;
13333
13339 readonly attribute IGuestDirectory[] directories;
13340
13346 readonly attribute IGuestFile[] files;
13347
13353 readonly attribute IEventSource eventSource;
13354
13363 void close();
13364
13386 void copyFrom (
13387 in wstring source,
13388 in wstring dest,
13389 in CopyFileFlag[] flags,
13390 [retval] out IProgress progress
13391 );
13392
13414 void copyTo (
13415 in wstring source,
13416 in wstring dest,
13417 in CopyFileFlag[] flags,
13418 [retval] out IProgress progress
13419 );
13420
13440 void directoryCreate (
13441 in wstring path,
13442 in unsigned long mode,
13443 in DirectoryCreateFlag[] flags
13444 );
13445
13497 void directoryCreateTemp (
13498 in wstring templateName,
13499 in unsigned long mode,
13500 in wstring path,
13501 in boolean secure,
13502 [retval] out wstring directory
13503 );
13504
13522 void directoryExists (
13523 in wstring path,
13524 [retval] out boolean exists
13525 );
13526
13557 void directoryOpen (
13558 in wstring path,
13559 in wstring filter,
13560 in DirectoryOpenFlag[] flags,
13561 [retval] out IGuestDirectory directory
13562 );
13563
13589 void directoryQueryInfo (
13590 in wstring path,
13591 [retval] out IGuestFsObjInfo info
13592 );
13593
13609 void directoryRemove (
13610 in wstring path
13611 );
13612
13632 void directoryRemoveRecursive (
13633 in wstring path,
13634 in DirectoryRemoveRecFlag[] flags,
13635 [retval] out IProgress progress
13636 );
13637
13657 void directoryRename (
13658 in wstring source,
13659 in wstring dest,
13660 in PathRenameFlag[] flags
13661 );
13662
13680 void directorySetACL (
13681 in wstring path,
13682 in wstring acl
13683 );
13684
13698 void environmentClear();
13699
13720 void environmentGet (
13721 in wstring name,
13722 [retval] out wstring value
13723 );
13724
13742 void environmentSet (
13743 in wstring name,
13744 in wstring value
13745 );
13746
13762 void environmentUnset (
13763 in wstring name
13764 );
13765
13819 void fileCreateTemp (
13820 in wstring templateName,
13821 in unsigned long mode,
13822 in wstring path,
13823 in boolean secure,
13824 [retval] out IGuestFile file
13825 );
13826
13844 void fileExists (
13845 in wstring path,
13846 [retval] out boolean exists
13847 );
13848
13872 void fileRemove (
13873 in wstring path
13874 );
13875
13934 void fileOpen (
13935 in wstring path,
13936 in wstring openMode,
13937 in wstring disposition,
13938 in unsigned long creationMode,
13939 [retval] out IGuestFile file
13940 );
13941
14005 void fileOpenEx (
14006 in wstring path,
14007 in wstring openMode,
14008 in wstring disposition,
14009 in wstring sharingMode,
14010 in unsigned long creationMode,
14011 in long long offset,
14012 [retval] out IGuestFile file
14013 );
14014
14040 void fileQueryInfo (
14041 in wstring path,
14042 [retval] out IGuestFsObjInfo info
14043 );
14044
14070 void fileQuerySize (
14071 in wstring path,
14072 [retval] out long long size
14073 );
14074
14094 void fileRename (
14095 in wstring source,
14096 in wstring dest,
14097 in PathRenameFlag[] flags
14098 );
14099
14117 void fileSetACL (
14118 in wstring file,
14119 in wstring acl
14120 );
14121
14176 void processCreate (
14177 in wstring command,
14178 in wstring[] arguments,
14179 in wstring[] environment,
14180 in ProcessCreateFlag[] flags,
14181 in unsigned long timeoutMS,
14182 [retval] out IGuestProcess guestProcess
14183 );
14184
14226 void processCreateEx (
14227 in wstring command,
14228 in wstring[] arguments,
14229 in wstring[] environment,
14230 in ProcessCreateFlag[] flags,
14231 in unsigned long timeoutMS,
14232 in ProcessPriority priority,
14233 in long[] affinity,
14234 [retval] out IGuestProcess guestProcess
14235 );
14236
14246 void processGet (
14247 in unsigned long pid,
14248 [retval] out IGuestProcess guestProcess
14249 );
14250
14273 void symlinkCreate (
14274 in wstring source,
14275 in wstring target,
14276 in SymlinkType type
14277 );
14278
14296 void symlinkExists (
14297 in wstring symlink,
14298 [retval] out boolean exists
14299 );
14300
14324 void symlinkRead (
14325 in wstring symlink,
14326 in SymlinkReadFlag[] flags,
14327 [retval] out wstring target
14328 );
14329
14345 void symlinkRemoveDirectory (
14346 in wstring path
14347 );
14348
14364 void symlinkRemoveFile (
14365 in wstring file
14366 );
14367
14388 void waitFor (
14389 in unsigned long waitFor,
14390 in unsigned long timeoutMS,
14391 [retval] out GuestSessionWaitResult reason
14392 );
14393
14415 void waitForArray (
14416 in GuestSessionWaitForFlag[] waitFor,
14417 in unsigned long timeoutMS,
14418 [retval] out GuestSessionWaitResult reason
14419 );
14420
14421 };
14422
14430 interface IProcess : $unknown
14431 {
14437 readonly attribute wstring[] arguments;
14438
14444 readonly attribute wstring[] environment;
14445
14451 readonly attribute IEventSource eventSource;
14452
14456 readonly attribute wstring executablePath;
14457
14464 readonly attribute long exitCode;
14465
14471 readonly attribute wstring name;
14472
14478 readonly attribute unsigned long PID;
14479
14486 readonly attribute ProcessStatus status;
14487
14508 void waitFor (
14509 in unsigned long waitFor,
14510 in unsigned long timeoutMS,
14511 [retval] out ProcessWaitResult reason
14512 );
14513
14535 void waitForArray (
14536 in ProcessWaitForFlag[] waitFor,
14537 in unsigned long timeoutMS,
14538 [retval] out ProcessWaitResult reason
14539 );
14540
14557 void read (
14558 in unsigned long handle,
14559 in unsigned long toRead,
14560 in unsigned long timeoutMS,
14561 [retval] out octet[] data
14562 );
14563
14587 void write (
14588 in unsigned long handle,
14589 in unsigned long flags,
14590 in octet[] data,
14591 in unsigned long timeoutMS,
14592 [retval] out unsigned long written
14593 );
14594
14619 void writeArray (
14620 in unsigned long handle,
14621 in ProcessInputFlag[] flags,
14622 in octet[] data,
14623 in unsigned long timeoutMS,
14624 [retval] out unsigned long written
14625 );
14626
14636 void terminate();
14637
14638 };
14639
14648 interface IGuestProcess : IProcess
14649 {
14650 };
14651
14659 interface IDirectory : $unknown
14660 {
14666 readonly attribute wstring directoryName;
14667
14673 readonly attribute wstring filter;
14674
14681 void close();
14682
14698 void read (
14699 [retval] out IFsObjInfo objInfo
14700 );
14701
14702 };
14703
14712 interface IGuestDirectory : IDirectory
14713 {
14714 };
14715
14723 interface IFile : $unknown
14724 {
14730 readonly attribute unsigned long creationMode;
14731
14737 readonly attribute wstring disposition;
14738
14744 readonly attribute IEventSource eventSource;
14745
14751 readonly attribute wstring fileName;
14752
14758 readonly attribute unsigned long id;
14759
14765 readonly attribute long long initialSize;
14766
14772 readonly attribute wstring openMode;
14773
14779 readonly attribute long long offset;
14780
14786 readonly attribute FileStatus status;
14787
14794 void close();
14795
14812 void queryInfo (
14813 [retval] out IFsObjInfo objInfo
14814 );
14815
14838 void read (
14839 in unsigned long toRead,
14840 in unsigned long timeoutMS,
14841 [retval] out octet[] data
14842 );
14843
14868 void readAt (
14869 in long long offset,
14870 in unsigned long toRead,
14871 in unsigned long timeoutMS,
14872 [retval] out octet[] data
14873 );
14874
14894 void seek (
14895 in long long offset,
14896 in FileSeekType whence
14897 );
14898
14914 void setACL (
14915 in wstring acl
14916 );
14917
14935 void write (
14936 in octet[] data,
14937 in unsigned long timeoutMS,
14938 [retval] out unsigned long written
14939 );
14940
14968 void writeAt (
14969 in long long offset,
14970 in octet[] data,
14971 in unsigned long timeoutMS,
14972 [retval] out unsigned long written
14973 );
14974
14975 };
14976
14985 interface IGuestFile : IFile
14986 {
14987 };
14988
14997 interface IFsObjInfo : $unknown
14998 {
15004 readonly attribute long long accessTime;
15005
15011 readonly attribute long long allocatedSize;
15012
15018 readonly attribute long long birthTime;
15019
15025 readonly attribute long long changeTime;
15026
15032 readonly attribute unsigned long deviceNumber;
15033
15039 readonly attribute wstring fileAttributes;
15040
15046 readonly attribute unsigned long generationId;
15047
15053 readonly attribute unsigned long GID;
15054
15060 readonly attribute wstring groupName;
15061
15067 readonly attribute unsigned long hardLinks;
15068
15074 readonly attribute long long modificationTime;
15075
15081 readonly attribute wstring name;
15082
15088 readonly attribute long long nodeId;
15089
15095 readonly attribute unsigned long nodeIdDevice;
15096
15104 readonly attribute long long objectSize;
15105
15111 readonly attribute FsObjType type;
15112
15118 readonly attribute unsigned long UID;
15119
15125 readonly attribute unsigned long userFlags;
15126
15132 readonly attribute wstring userName;
15133
15134 };
15135
15144 interface IGuestFsObjInfo : IFsObjInfo
15145 {
15146 };
15147
15161 interface IGuest : $unknown
15162 {
15177 readonly attribute wstring OSTypeId;
15178
15184 readonly attribute AdditionsRunLevelType additionsRunLevel;
15185
15192 readonly attribute wstring additionsVersion;
15193
15201 readonly attribute unsigned long additionsRevision;
15202
15208 readonly attribute IEventSource eventSource;
15209
15216 readonly attribute IAdditionsFacility[] facilities;
15217
15221 readonly attribute IGuestSession[] sessions;
15222
15226 attribute unsigned long memoryBalloonSize;
15227
15231 attribute unsigned long statisticsUpdateInterval;
15232
15264 void internalGetStatistics (
15265 out unsigned long cpuUser,
15266 out unsigned long cpuKernel,
15267 out unsigned long cpuIdle,
15268 out unsigned long memTotal,
15269 out unsigned long memFree,
15270 out unsigned long memBalloon,
15271 out unsigned long memShared,
15272 out unsigned long memCache,
15273 out unsigned long pagedTotal,
15274 out unsigned long memAllocTotal,
15275 out unsigned long memFreeTotal,
15276 out unsigned long memBalloonTotal,
15277 out unsigned long memSharedTotal
15278 );
15279
15291 void getFacilityStatus (
15292 in AdditionsFacilityType facility,
15293 out long long timestamp,
15294 [retval] out AdditionsFacilityStatus status
15295 );
15296
15314 void getAdditionsStatus (
15315 in AdditionsRunLevelType level,
15316 [retval] out boolean active
15317 );
15318
15348 void setCredentials (
15349 in wstring userName,
15350 in wstring password,
15351 in wstring domain,
15352 in boolean allowInteractiveLogon
15353 );
15354
15384 void dragHGEnter (
15385 in unsigned long screenId,
15386 in unsigned long y,
15387 in unsigned long x,
15388 in DragAndDropAction defaultAction,
15389 in DragAndDropAction[] allowedActions,
15390 in wstring[] formats,
15391 [retval] out DragAndDropAction resultAction
15392 );
15393
15423 void dragHGMove (
15424 in unsigned long screenId,
15425 in unsigned long x,
15426 in unsigned long y,
15427 in DragAndDropAction defaultAction,
15428 in DragAndDropAction[] allowedActions,
15429 in wstring[] formats,
15430 [retval] out DragAndDropAction resultAction
15431 );
15432
15450 void dragHGLeave (
15451 in unsigned long screenId
15452 );
15453
15485 void dragHGDrop (
15486 in unsigned long screenId,
15487 in unsigned long x,
15488 in unsigned long y,
15489 in DragAndDropAction defaultAction,
15490 in DragAndDropAction[] allowedActions,
15491 in wstring[] formats,
15492 out wstring format,
15493 [retval] out DragAndDropAction resultAction
15494 );
15495
15519 void dragHGPutData (
15520 in unsigned long screenId,
15521 in wstring format,
15522 in octet[] data,
15523 [retval] out IProgress progress
15524 );
15525
15551 void dragGHPending (
15552 in unsigned long screenId,
15553 out wstring[] formats,
15554 out DragAndDropAction[] allowedActions,
15555 [retval] out DragAndDropAction defaultAction
15556 );
15557
15579 void dragGHDropped (
15580 in wstring format,
15581 in DragAndDropAction action,
15582 [retval] out IProgress progress
15583 );
15584
15602 void dragGHGetData (
15603 [retval] out octet[] data
15604 );
15605
15664 void createSession (
15665 in wstring user,
15666 in wstring password,
15667 in wstring domain,
15668 in wstring sessionName,
15669 [retval] out IGuestSession guestSession
15670 );
15671
15686 void findSession (
15687 in wstring sessionName,
15688 [retval] out IGuestSession[] sessions
15689 );
15690
15740 void updateGuestAdditions (
15741 in wstring source,
15742 in wstring[] arguments,
15743 in AdditionsUpdateFlag[] flags,
15744 [retval] out IProgress progress
15745 );
15746
15747 };
15748
15789 interface IProgress : $unknown
15790 {
15794 readonly attribute wstringUUID id;
15795
15799 readonly attribute wstring description;
15800
15804 readonly attribute $unknown initiator;
15805
15809 readonly attribute boolean cancelable;
15810
15818 readonly attribute unsigned long percent;
15819
15833 readonly attribute long timeRemaining;
15834
15838 readonly attribute boolean completed;
15839
15843 readonly attribute boolean canceled;
15844
15851 readonly attribute long resultCode;
15852
15862 readonly attribute IVirtualBoxErrorInfo errorInfo;
15863
15870 readonly attribute unsigned long operationCount;
15871
15875 readonly attribute unsigned long operation;
15876
15882 readonly attribute wstring operationDescription;
15883
15887 readonly attribute unsigned long operationPercent;
15888
15892 readonly attribute unsigned long operationWeight;
15893
15901 attribute unsigned long timeout;
15902
15906 void setCurrentOperationProgress (
15907 in unsigned long percent
15908 );
15909
15913 void setNextOperation (
15914 in wstring nextOperationDescription,
15915 in unsigned long nextOperationsWeight
15916 );
15917
15944 void waitForCompletion (
15945 in long timeout
15946 );
15947
15971 void waitForOperationCompletion (
15972 in unsigned long operation,
15973 in long timeout
15974 );
15975
16001 void waitForAsyncProgressCompletion (
16002 in IProgress pProgressAsync
16003 );
16004
16021 void cancel();
16022
16023 };
16024
16108 interface ISnapshot : $unknown
16109 {
16113 readonly attribute wstringUUID id;
16114
16122 attribute wstring name;
16123
16131 attribute wstring description;
16132
16138 readonly attribute long long timeStamp;
16139
16151 readonly attribute boolean online;
16152
16164 readonly attribute IMachine machine;
16165
16172 readonly attribute ISnapshot parent;
16173
16182 readonly attribute ISnapshot[] children;
16183
16191 void getChildrenCount (
16192 [retval] out unsigned long childrenCount
16193 );
16194
16195 };
16196
16383 interface IMediumAttachment : $unknown
16384 {
16389 readonly attribute IMedium medium;
16390
16396 readonly attribute wstring controller;
16397
16403 readonly attribute long port;
16404
16410 readonly attribute long device;
16411
16415 readonly attribute DeviceType type;
16416
16420 readonly attribute boolean passthrough;
16421
16425 readonly attribute boolean temporaryEject;
16426
16431 readonly attribute boolean isEjected;
16432
16436 readonly attribute boolean nonRotational;
16437
16441 readonly attribute boolean discard;
16442
16446 readonly attribute IBandwidthGroup bandwidthGroup;
16447
16448 };
16449
16607 interface IMedium : $unknown
16608 {
16622 readonly attribute wstringUUID id;
16623
16642 attribute wstring description;
16643
16659 readonly attribute MediumState state;
16660
16669 readonly attribute MediumVariant[] variant;
16670
16692 attribute wstring location;
16693
16713 readonly attribute wstring name;
16714
16719 readonly attribute DeviceType deviceType;
16720
16724 readonly attribute boolean hostDrive;
16725
16738 readonly attribute long long size;
16739
16754 readonly attribute wstring format;
16755
16771 readonly attribute IMediumFormat mediumFormat;
16772
16797 attribute MediumType type;
16798
16812 readonly attribute MediumType[] allowedTypes;
16813
16823 readonly attribute IMedium parent;
16824
16832 readonly attribute IMedium[] children;
16833
16844 readonly attribute IMedium base;
16845
16878 readonly attribute boolean readOnly;
16879
16895 readonly attribute long long logicalSize;
16896
16924 attribute boolean autoReset;
16925
16940 readonly attribute wstring lastAccessError;
16941
16958 readonly attribute wstringUUID[] machineIds;
16959
16985 void setIds (
16986 in boolean setImageId,
16987 in wstringUUID imageId,
16988 in boolean setParentId,
16989 in wstringUUID parentId
16990 );
16991
17026 void refreshState (
17027 [retval] out MediumState state
17028 );
17029
17056 void getSnapshotIds (
17057 in wstringUUID machineId,
17058 [retval] out wstringUUID[] snapshotIds
17059 );
17060
17123 void lockRead (
17124 [retval] out IToken token
17125 );
17126
17181 void lockWrite (
17182 [retval] out IToken token
17183 );
17184
17234 void close();
17235
17265 void getProperty (
17266 in wstring name,
17267 [retval] out wstring value
17268 );
17269
17301 void setProperty (
17302 in wstring name,
17303 in wstring value
17304 );
17305
17340 void getProperties (
17341 in wstring names,
17342 out wstring[] returnNames,
17343 [retval] out wstring[] returnValues
17344 );
17345
17375 void setProperties (
17376 in wstring[] names,
17377 in wstring[] values
17378 );
17379
17412 void createBaseStorage (
17413 in long long logicalSize,
17414 in MediumVariant[] variant,
17415 [retval] out IProgress progress
17416 );
17417
17469 void deleteStorage (
17470 [retval] out IProgress progress
17471 );
17472
17511 void createDiffStorage (
17512 in IMedium target,
17513 in MediumVariant[] variant,
17514 [retval] out IProgress progress
17515 );
17516
17592 void mergeTo (
17593 in IMedium target,
17594 [retval] out IProgress progress
17595 );
17596
17646 void cloneTo (
17647 in IMedium target,
17648 in MediumVariant[] variant,
17649 in IMedium parent,
17650 [retval] out IProgress progress
17651 );
17652
17699 void cloneToBase (
17700 in IMedium target,
17701 in MediumVariant[] variant,
17702 [retval] out IProgress progress
17703 );
17704
17733 void compact (
17734 [retval] out IProgress progress
17735 );
17736
17769 void resize (
17770 in long long logicalSize,
17771 [retval] out IProgress progress
17772 );
17773
17807 void reset (
17808 [retval] out IProgress progress
17809 );
17810
17811 };
17812
17835 interface IMediumFormat : $unknown
17836 {
17855 readonly attribute wstring id;
17856
17864 readonly attribute wstring name;
17865
17874 readonly attribute MediumFormatCapabilities[] capabilities;
17875
17894 void describeFileExtensions (
17895 out wstring[] extensions,
17896 out DeviceType[] types
17897 );
17898
17926 void describeProperties (
17927 out wstring[] names,
17928 out wstring[] descriptions,
17929 out DataType[] types,
17930 out unsigned long[] flags,
17931 out wstring[] defaults
17932 );
17933
17934 };
17935
17950 interface IToken : $unknown
17951 {
17960 void abandon();
17961
17968 void dummy();
17969
17970 };
17971
17983 interface IKeyboard : $unknown
17984 {
17990 readonly attribute IEventSource eventSource;
17991
18004 void putScancode (
18005 in long scancode
18006 );
18007
18020 void putScancodes (
18021 in long[] scancodes,
18022 [retval] out unsigned long codesStored
18023 );
18024
18039 void putCAD();
18040
18041 };
18042
18054 interface IMouse : $unknown
18055 {
18070 readonly attribute boolean absoluteSupported;
18071
18086 readonly attribute boolean relativeSupported;
18087
18101 readonly attribute boolean multiTouchSupported;
18102
18117 readonly attribute boolean needsHostCursor;
18118
18124 readonly attribute IEventSource eventSource;
18125
18191 void putMouseEvent (
18192 in long dx,
18193 in long dy,
18194 in long dz,
18195 in long dw,
18196 in long buttonState
18197 );
18198
18271 void putMouseEventAbsolute (
18272 in long x,
18273 in long y,
18274 in long dz,
18275 in long dw,
18276 in long buttonState
18277 );
18278
18326 void putEventMultiTouch (
18327 in long count,
18328 in long long[] contacts,
18329 in unsigned long scanTime
18330 );
18331
18347 void putEventMultiTouchString (
18348 in long count,
18349 in wstring contacts,
18350 in unsigned long scanTime
18351 );
18352
18353 };
18354
18355 interface IFramebuffer : $unknown
18356 {
18365 readonly attribute octetPtr address;
18366
18370 readonly attribute unsigned long width;
18371
18375 readonly attribute unsigned long height;
18376
18383 readonly attribute unsigned long bitsPerPixel;
18384
18391 readonly attribute unsigned long bytesPerLine;
18392
18403 readonly attribute unsigned long pixelFormat;
18404
18411 readonly attribute boolean usesGuestVRAM;
18412
18422 readonly attribute unsigned long heightReduction;
18423
18438 readonly attribute IFramebufferOverlay overlay;
18439
18446 readonly attribute long long winId;
18447
18455 void lock();
18456
18464 void unlock();
18465
18473 void notifyUpdate (
18474 in unsigned long x,
18475 in unsigned long y,
18476 in unsigned long width,
18477 in unsigned long height
18478 );
18479
18592 void requestResize (
18593 in unsigned long screenId,
18594 in unsigned long pixelFormat,
18595 in octetPtr VRAM,
18596 in unsigned long bitsPerPixel,
18597 in unsigned long bytesPerLine,
18598 in unsigned long width,
18599 in unsigned long height,
18600 [retval] out boolean finished
18601 );
18602
18614 void videoModeSupported (
18615 in unsigned long width,
18616 in unsigned long height,
18617 in unsigned long bpp,
18618 [retval] out boolean supported
18619 );
18620
18657 void getVisibleRegion (
18658 in octetPtr rectangles,
18659 in unsigned long count,
18660 [retval] out unsigned long countCopied
18661 );
18662
18697 void setVisibleRegion (
18698 in octetPtr rectangles,
18699 in unsigned long count
18700 );
18701
18722 void processVHWACommand (
18723 in octetPtr command
18724 );
18725
18740 void notify3DEvent (
18741 in unsigned long type,
18742 in octetPtr data
18743 );
18744
18745 };
18746
18761 interface IFramebufferOverlay : IFramebuffer
18762 {
18766 readonly attribute unsigned long x;
18767
18771 readonly attribute unsigned long y;
18772
18778 attribute boolean visible;
18779
18786 attribute unsigned long alpha;
18787
18793 void move (
18794 in unsigned long x,
18795 in unsigned long y
18796 );
18797
18798 };
18799
18815 interface IDisplay : $unknown
18816 {
18820 void getScreenResolution (
18821 in unsigned long screenId,
18822 out unsigned long width,
18823 out unsigned long height,
18824 out unsigned long bitsPerPixel,
18825 out long xOrigin,
18826 out long yOrigin
18827 );
18828
18834 void setFramebuffer (
18835 in unsigned long screenId,
18836 in IFramebuffer framebuffer
18837 );
18838
18844 void getFramebuffer (
18845 in unsigned long screenId,
18846 out IFramebuffer framebuffer,
18847 out long xOrigin,
18848 out long yOrigin
18849 );
18850
18901 void setVideoModeHint (
18902 in unsigned long display,
18903 in boolean enabled,
18904 in boolean changeOrigin,
18905 in long originX,
18906 in long originY,
18907 in unsigned long width,
18908 in unsigned long height,
18909 in unsigned long bitsPerPixel
18910 );
18911
18923 void setSeamlessMode (
18924 in boolean enabled
18925 );
18926
18962 void takeScreenShot (
18963 in unsigned long screenId,
18964 in octetPtr address,
18965 in unsigned long width,
18966 in unsigned long height
18967 );
18968
19012 void takeScreenShotToArray (
19013 in unsigned long screenId,
19014 in unsigned long width,
19015 in unsigned long height,
19016 [retval] out octet[] screenData
19017 );
19018
19057 void takeScreenShotPNGToArray (
19058 in unsigned long screenId,
19059 in unsigned long width,
19060 in unsigned long height,
19061 [retval] out octet[] screenData
19062 );
19063
19115 void drawToScreen (
19116 in unsigned long screenId,
19117 in octetPtr address,
19118 in unsigned long x,
19119 in unsigned long y,
19120 in unsigned long width,
19121 in unsigned long height
19122 );
19123
19138 void invalidateAndUpdate();
19139
19153 void resizeCompleted (
19154 in unsigned long screenId
19155 );
19156
19169 void completeVHWACommand (
19170 in octetPtr command
19171 );
19172
19206 void viewportChanged (
19207 in unsigned long screenId,
19208 in unsigned long x,
19209 in unsigned long y,
19210 in unsigned long width,
19211 in unsigned long height
19212 );
19213
19214 };
19215
19231 interface INetworkAdapter : $unknown
19232 {
19240 attribute NetworkAdapterType adapterType;
19241
19249 readonly attribute unsigned long slot;
19250
19259 attribute boolean enabled;
19260
19267 attribute wstring MACAddress;
19268
19274 attribute NetworkAttachmentType attachmentType;
19275
19281 attribute wstring bridgedInterface;
19282
19288 attribute wstring hostOnlyInterface;
19289
19295 attribute wstring internalNetwork;
19296
19302 attribute wstring NATNetwork;
19303
19309 attribute wstring genericDriver;
19310
19317 attribute boolean cableConnected;
19318
19324 attribute unsigned long lineSpeed;
19325
19332 attribute NetworkAdapterPromiscModePolicy promiscModePolicy;
19333
19340 attribute boolean traceEnabled;
19341
19348 attribute wstring traceFile;
19349
19357 readonly attribute INATEngine NATEngine;
19358
19365 attribute unsigned long bootPriority;
19366
19370 attribute IBandwidthGroup bandwidthGroup;
19371
19390 void getProperty (
19391 in wstring key,
19392 [retval] out wstring value
19393 );
19394
19413 void setProperty (
19414 in wstring key,
19415 in wstring value
19416 );
19417
19445 void getProperties (
19446 in wstring names,
19447 out wstring[] returnNames,
19448 [retval] out wstring[] returnValues
19449 );
19450
19451 };
19452
19481 interface ISerialPort : $unknown
19482 {
19490 readonly attribute unsigned long slot;
19491
19498 attribute boolean enabled;
19499
19503 attribute unsigned long IOBase;
19504
19508 attribute unsigned long IRQ;
19509
19520 attribute PortMode hostMode;
19521
19529 attribute boolean server;
19530
19540 attribute wstring path;
19541
19542 };
19543
19563 interface IParallelPort : $unknown
19564 {
19572 readonly attribute unsigned long slot;
19573
19580 attribute boolean enabled;
19581
19585 attribute unsigned long IOBase;
19586
19590 attribute unsigned long IRQ;
19591
19599 attribute wstring path;
19600
19601 };
19602
19603 interface IMachineDebugger : $unknown
19604 {
19608 attribute boolean singleStep;
19609
19613 attribute boolean recompileUser;
19614
19618 attribute boolean recompileSupervisor;
19619
19627 attribute boolean executeAllInIEM;
19628
19632 attribute boolean PATMEnabled;
19633
19637 attribute boolean CSAMEnabled;
19638
19642 attribute boolean logEnabled;
19643
19647 readonly attribute wstring logDbgFlags;
19648
19652 readonly attribute wstring logDbgGroups;
19653
19657 readonly attribute wstring logDbgDestinations;
19658
19662 readonly attribute wstring logRelFlags;
19663
19667 readonly attribute wstring logRelGroups;
19668
19672 readonly attribute wstring logRelDestinations;
19673
19680 readonly attribute boolean HWVirtExEnabled;
19681
19688 readonly attribute boolean HWVirtExNestedPagingEnabled;
19689
19696 readonly attribute boolean HWVirtExVPIDEnabled;
19697
19704 readonly attribute boolean HWVirtExUXEnabled;
19705
19714 readonly attribute wstring OSName;
19715
19724 readonly attribute wstring OSVersion;
19725
19732 readonly attribute boolean PAEEnabled;
19733
19740 attribute unsigned long virtualTimeRate;
19741
19749 readonly attribute long long VM;
19750
19766 void dumpGuestCore (
19767 in wstring filename,
19768 in wstring compression
19769 );
19770
19787 void dumpHostProcessCore (
19788 in wstring filename,
19789 in wstring compression
19790 );
19791
19812 void info (
19813 in wstring name,
19814 in wstring args,
19815 [retval] out wstring info
19816 );
19817
19823 void injectNMI();
19824
19835 void modifyLogGroups (
19836 in wstring settings
19837 );
19838
19849 void modifyLogFlags (
19850 in wstring settings
19851 );
19852
19863 void modifyLogDestinations (
19864 in wstring settings
19865 );
19866
19881 void readPhysicalMemory (
19882 in long long address,
19883 in unsigned long size,
19884 [retval] out octet[] bytes
19885 );
19886
19901 void writePhysicalMemory (
19902 in long long address,
19903 in unsigned long size,
19904 in octet[] bytes
19905 );
19906
19923 void readVirtualMemory (
19924 in unsigned long cpuId,
19925 in long long address,
19926 in unsigned long size,
19927 [retval] out octet[] bytes
19928 );
19929
19946 void writeVirtualMemory (
19947 in unsigned long cpuId,
19948 in long long address,
19949 in unsigned long size,
19950 in octet[] bytes
19951 );
19952
19965 void detectOS (
19966 [retval] out wstring os
19967 );
19968
19986 void getRegister (
19987 in unsigned long cpuId,
19988 in wstring name,
19989 [retval] out wstring value
19990 );
19991
20009 void getRegisters (
20010 in unsigned long cpuId,
20011 out wstring[] names,
20012 out wstring[] values
20013 );
20014
20033 void setRegister (
20034 in unsigned long cpuId,
20035 in wstring name,
20036 in wstring value
20037 );
20038
20057 void setRegisters (
20058 in unsigned long cpuId,
20059 in wstring[] names,
20060 in wstring[] values
20061 );
20062
20075 void dumpGuestStack (
20076 in unsigned long cpuId,
20077 [retval] out wstring stack
20078 );
20079
20087 void resetStats (
20088 in wstring pattern
20089 );
20090
20098 void dumpStats (
20099 in wstring pattern
20100 );
20101
20113 void getStats (
20114 in wstring pattern,
20115 in boolean withDescriptions,
20116 [retval] out wstring stats
20117 );
20118
20119 };
20120
20121 interface IUSBDeviceFilters : $unknown
20122 {
20148 readonly attribute IUSBDeviceFilter[] deviceFilters;
20149
20177 void createDeviceFilter (
20178 in wstring name,
20179 [retval] out IUSBDeviceFilter filter
20180 );
20181
20226 void insertDeviceFilter (
20227 in unsigned long position,
20228 in IUSBDeviceFilter filter
20229 );
20230
20263 void removeDeviceFilter (
20264 in unsigned long position,
20265 [retval] out IUSBDeviceFilter filter
20266 );
20267
20268 };
20269
20270 interface IUSBController : $unknown
20271 {
20277 readonly attribute wstring name;
20278
20284 readonly attribute USBControllerType type;
20285
20293 readonly attribute unsigned short USBStandard;
20294
20295 };
20296
20309 interface IUSBDevice : $unknown
20310 {
20317 readonly attribute wstringUUID id;
20318
20322 readonly attribute unsigned short vendorId;
20323
20327 readonly attribute unsigned short productId;
20328
20336 readonly attribute unsigned short revision;
20337
20341 readonly attribute wstring manufacturer;
20342
20346 readonly attribute wstring product;
20347
20351 readonly attribute wstring serialNumber;
20352
20356 readonly attribute wstring address;
20357
20364 readonly attribute unsigned short port;
20365
20371 readonly attribute unsigned short version;
20372
20380 readonly attribute unsigned short portVersion;
20381
20388 readonly attribute boolean remote;
20389
20390 };
20391
20466 interface IUSBDeviceFilter : $unknown
20467 {
20475 attribute wstring name;
20476
20480 attribute boolean active;
20481
20489 attribute wstring vendorId;
20490
20498 attribute wstring productId;
20499
20513 attribute wstring revision;
20514
20519 attribute wstring manufacturer;
20520
20525 attribute wstring product;
20526
20531 attribute wstring serialNumber;
20532
20537 attribute wstring port;
20538
20548 attribute wstring remote;
20549
20559 attribute unsigned long maskedInterfaces;
20560
20561 };
20562
20579 interface IHostUSBDevice : IUSBDevice
20580 {
20586 readonly attribute USBDeviceState state;
20587
20588 };
20589
20612 interface IHostUSBDeviceFilter : IUSBDeviceFilter
20613 {
20620 attribute USBDeviceFilterAction action;
20621
20622 };
20623
20632 interface IAudioAdapter : $unknown
20633 {
20642 attribute boolean enabled;
20643
20649 attribute AudioControllerType audioController;
20650
20657 attribute AudioDriverType audioDriver;
20658
20659 };
20660
20661 interface IVRDEServer : $unknown
20662 {
20666 attribute boolean enabled;
20667
20671 attribute AuthType authType;
20672
20676 attribute unsigned long authTimeout;
20677
20684 attribute boolean allowMultiConnection;
20685
20693 attribute boolean reuseSingleConnection;
20694
20701 attribute wstring VRDEExtPack;
20702
20709 attribute wstring authLibrary;
20710
20716 readonly attribute wstring[] VRDEProperties;
20717
20731 void setVRDEProperty (
20732 in wstring key,
20733 in wstring value
20734 );
20735
20749 void getVRDEProperty (
20750 in wstring key,
20751 [retval] out wstring value
20752 );
20753
20754 };
20755
20813 interface ISharedFolder : $unknown
20814 {
20818 readonly attribute wstring name;
20819
20823 readonly attribute wstring hostPath;
20824
20834 readonly attribute boolean accessible;
20835
20842 readonly attribute boolean writable;
20843
20849 readonly attribute boolean autoMount;
20850
20863 readonly attribute wstring lastAccessError;
20864
20865 };
20866
20867 interface IInternalSessionControl : $unknown
20868 {
20873 void getPID (
20874 [retval] out unsigned long pid
20875 );
20876
20898 void getRemoteConsole (
20899 [retval] out IConsole console
20900 );
20901
20916 void assignRemoteMachine (
20917 in IMachine machine,
20918 in IConsole console
20919 );
20920
20944 void updateMachineState (
20945 in MachineState machineState
20946 );
20947
20963 void uninitialize();
20964
20987 void onNetworkAdapterChange (
20988 in INetworkAdapter networkAdapter,
20989 in boolean changeAdapter
20990 );
20991
21014 void onSerialPortChange (
21015 in ISerialPort serialPort
21016 );
21017
21040 void onParallelPortChange (
21041 in IParallelPort parallelPort
21042 );
21043
21066 void onStorageControllerChange();
21067
21094 void onMediumChange (
21095 in IMediumAttachment mediumAttachment,
21096 in boolean force
21097 );
21098
21128 void onStorageDeviceChange (
21129 in IMediumAttachment mediumAttachment,
21130 in boolean remove,
21131 in boolean silent
21132 );
21133
21141 void onClipboardModeChange (
21142 in ClipboardMode clipboardMode
21143 );
21144
21152 void onDragAndDropModeChange (
21153 in DragAndDropMode dragAndDropMode
21154 );
21155
21165 void onCPUChange (
21166 in unsigned long cpu,
21167 in boolean add
21168 );
21169
21177 void onCPUExecutionCapChange (
21178 in unsigned long executionCap
21179 );
21180
21205 void onVRDEServerChange (
21206 in boolean restart
21207 );
21208
21214 void onVideoCaptureChange();
21215
21238 void onUSBControllerChange();
21239
21268 void onSharedFolderChange (
21269 in boolean global
21270 );
21271
21297 void onUSBDeviceAttach (
21298 in IUSBDevice device,
21299 in IVirtualBoxErrorInfo error,
21300 in unsigned long maskedInterfaces
21301 );
21302
21328 void onUSBDeviceDetach (
21329 in wstringUUID id,
21330 in IVirtualBoxErrorInfo error
21331 );
21332
21350 void onShowWindow (
21351 in boolean check,
21352 out boolean canShow,
21353 out long long winId
21354 );
21355
21363 void onBandwidthGroupChange (
21364 in IBandwidthGroup bandwidthGroup
21365 );
21366
21390 void accessGuestProperty (
21391 in wstring name,
21392 in wstring value,
21393 in wstring flags,
21394 in boolean isSetter,
21395 out wstring retValue,
21396 out long long retTimestamp,
21397 out wstring retFlags
21398 );
21399
21447 void enumerateGuestProperties (
21448 in wstring patterns,
21449 out wstring[] keys,
21450 out wstring[] values,
21451 out long long[] timestamps,
21452 out wstring[] flags
21453 );
21454
21489 void onlineMergeMedium (
21490 in IMediumAttachment mediumAttachment,
21491 in unsigned long sourceIdx,
21492 in unsigned long targetIdx,
21493 in IProgress progress
21494 );
21495
21519 void enableVMMStatistics (
21520 in boolean enable
21521 );
21522
21550 void pauseWithReason (
21551 in Reason reason
21552 );
21553
21581 void resumeWithReason (
21582 in Reason reason
21583 );
21584
21614 void saveStateWithReason (
21615 in Reason reason,
21616 [retval] out IProgress progress
21617 );
21618
21642 void assignMachine (
21643 in IMachine machine,
21644 in LockType lockType,
21645 in wstring tokenId
21646 );
21647
21671 void assignMachine (
21672 in IMachine machine,
21673 in LockType lockType,
21674 in wstring tokenId
21675 );
21676
21677 };
21678
21737 interface ISession : $unknown
21738 {
21742 readonly attribute SessionState state;
21743
21751 readonly attribute SessionType type;
21752
21756 readonly attribute IMachine machine;
21757
21761 readonly attribute IConsole console;
21762
21794 void unlockMachine();
21795
21796 };
21797
21820 interface IStorageController : $unknown
21821 {
21830 readonly attribute wstring name;
21831
21837 readonly attribute unsigned long maxDevicesPerPortCount;
21838
21844 readonly attribute unsigned long minPortCount;
21845
21851 readonly attribute unsigned long maxPortCount;
21852
21858 attribute unsigned long instance;
21859
21868 attribute unsigned long portCount;
21869
21875 readonly attribute StorageBus bus;
21876
21889 attribute StorageControllerType controllerType;
21890
21905 attribute boolean useHostIOCache;
21906
21912 readonly attribute boolean bootable;
21913
21914 };
21915
21939 interface IManagedObjectRef : $unknown
21940 {
21947 void getInterfaceName (
21948 [retval] out wstring return
21949 );
21950
21958 void release();
21959
21960 };
21961
21970 interface IWebsessionManager : $unknown
21971 {
21980 void logon (
21981 in wstring username,
21982 in wstring password,
21983 [retval] out IVirtualBox return
21984 );
21985
21995 void getSessionObject (
21996 in IVirtualBox refIVirtualBox,
21997 [retval] out ISession return
21998 );
21999
22007 void logoff (
22008 in IVirtualBox refIVirtualBox
22009 );
22010
22011 };
22012
22021 interface IPerformanceMetric : $unknown
22022 {
22028 readonly attribute wstring metricName;
22029
22035 readonly attribute $unknown object;
22036
22042 readonly attribute wstring description;
22043
22049 readonly attribute unsigned long period;
22050
22060 readonly attribute unsigned long count;
22061
22067 readonly attribute wstring unit;
22068
22074 readonly attribute long minimumValue;
22075
22081 readonly attribute long maximumValue;
22082
22083 };
22084
22191 interface IPerformanceCollector : $unknown
22192 {
22203 readonly attribute wstring[] metricNames;
22204
22228 void getMetrics (
22229 in wstring[] metricNames,
22230 in $unknown[] objects,
22231 [retval] out IPerformanceMetric[] metrics
22232 );
22233
22272 void setupMetrics (
22273 in wstring[] metricNames,
22274 in $unknown[] objects,
22275 in unsigned long period,
22276 in unsigned long count,
22277 [retval] out IPerformanceMetric[] affectedMetrics
22278 );
22279
22308 void enableMetrics (
22309 in wstring[] metricNames,
22310 in $unknown[] objects,
22311 [retval] out IPerformanceMetric[] affectedMetrics
22312 );
22313
22342 void disableMetrics (
22343 in wstring[] metricNames,
22344 in $unknown[] objects,
22345 [retval] out IPerformanceMetric[] affectedMetrics
22346 );
22347
22437 void queryMetricsData (
22438 in wstring[] metricNames,
22439 in $unknown[] objects,
22440 out wstring[] returnMetricNames,
22441 out $unknown[] returnObjects,
22442 out wstring[] returnUnits,
22443 out unsigned long[] returnScales,
22444 out unsigned long[] returnSequenceNumbers,
22445 out unsigned long[] returnDataIndices,
22446 out unsigned long[] returnDataLengths,
22447 [retval] out long[] returnData
22448 );
22449
22450 };
22451
22459 interface INATEngine : $unknown
22460 {
22465 attribute wstring network;
22466
22473 attribute wstring hostIP;
22474
22479 attribute wstring TFTPPrefix;
22480
22485 attribute wstring TFTPBootFile;
22486
22494 attribute wstring TFTPNextServer;
22495
22499 attribute unsigned long aliasMode;
22500
22504 attribute boolean DNSPassDomain;
22505
22510 attribute boolean DNSProxy;
22511
22516 attribute boolean DNSUseHostResolver;
22517
22522 readonly attribute wstring[] redirects;
22523
22539 void setNetworkSettings (
22540 in unsigned long mtu,
22541 in unsigned long sockSnd,
22542 in unsigned long sockRcv,
22543 in unsigned long TcpWndSnd,
22544 in unsigned long TcpWndRcv
22545 );
22546
22551 void getNetworkSettings (
22552 out unsigned long mtu,
22553 out unsigned long sockSnd,
22554 out unsigned long sockRcv,
22555 out unsigned long TcpWndSnd,
22556 out unsigned long TcpWndRcv
22557 );
22558
22578 void addRedirect (
22579 in wstring name,
22580 in NATProtocol proto,
22581 in wstring hostIP,
22582 in unsigned short hostPort,
22583 in wstring guestIP,
22584 in unsigned short guestPort
22585 );
22586
22592 void removeRedirect (
22593 in wstring name
22594 );
22595
22596 };
22597
22606 interface IExtPackPlugIn : $unknown
22607 {
22611 readonly attribute wstring name;
22612
22616 readonly attribute wstring description;
22617
22623 readonly attribute wstring frontend;
22624
22628 readonly attribute wstring modulePath;
22629
22630 };
22631
22640 interface IExtPackBase : $unknown
22641 {
22645 readonly attribute wstring name;
22646
22650 readonly attribute wstring description;
22651
22663 readonly attribute wstring version;
22664
22668 readonly attribute unsigned long revision;
22669
22679 readonly attribute wstring edition;
22680
22684 readonly attribute wstring VRDEModule;
22685
22689 readonly attribute IExtPackPlugIn[] plugIns;
22690
22700 readonly attribute boolean usable;
22701
22708 readonly attribute wstring whyUnusable;
22709
22713 readonly attribute boolean showLicense;
22714
22723 readonly attribute wstring license;
22724
22748 void queryLicense (
22749 in wstring preferredLocale,
22750 in wstring preferredLanguage,
22751 in wstring format,
22752 [retval] out wstring licenseText
22753 );
22754
22755 };
22756
22765 interface IExtPack : IExtPackBase
22766 {
22778 void queryObject (
22779 in wstring objUuid,
22780 [retval] out $unknown returnInterface
22781 );
22782
22783 };
22784
22794 interface IExtPackFile : IExtPackBase
22795 {
22801 readonly attribute wstring filePath;
22802
22821 void install (
22822 in boolean replace,
22823 in wstring displayInfo,
22824 [retval] out IProgress progess
22825 );
22826
22827 };
22828
22839 interface IExtPackManager : $unknown
22840 {
22846 readonly attribute IExtPack[] installedExtPacks;
22847
22865 void find (
22866 in wstring name,
22867 [retval] out IExtPack returnData
22868 );
22869
22881 void openExtPackFile (
22882 in wstring path,
22883 [retval] out IExtPackFile file
22884 );
22885
22904 void uninstall (
22905 in wstring name,
22906 in boolean forcedRemoval,
22907 in wstring displayInfo,
22908 [retval] out IProgress progess
22909 );
22910
22914 void cleanup();
22915
22928 void queryAllPlugInsForFrontend (
22929 in wstring frontendName,
22930 [retval] out wstring[] plugInModules
22931 );
22932
22940 void isExtPackUsable (
22941 in wstring name,
22942 [retval] out boolean usable
22943 );
22944
22945 };
22946
22952 interface IBandwidthGroup : $unknown
22953 {
22957 readonly attribute wstring name;
22958
22962 readonly attribute BandwidthGroupType type;
22963
22967 readonly attribute unsigned long reference;
22968
22973 attribute long long maxBytesPerSec;
22974
22975 };
22976
22985 interface IBandwidthControl : $unknown
22986 {
22992 readonly attribute unsigned long numGroups;
22993
23006 void createBandwidthGroup (
23007 in wstring name,
23008 in BandwidthGroupType type,
23009 in long long maxBytesPerSec
23010 );
23011
23019 void deleteBandwidthGroup (
23020 in wstring name
23021 );
23022
23032 void getBandwidthGroup (
23033 in wstring name,
23034 [retval] out IBandwidthGroup bandwidthGroup
23035 );
23036
23044 void getAllBandwidthGroups (
23045 [retval] out IBandwidthGroup[] bandwidthGroups
23046 );
23047
23048 };
23049
23062 interface IVirtualBoxClient : $unknown
23063 {
23069 readonly attribute IVirtualBox virtualBox;
23070
23076 readonly attribute ISession session;
23077
23083 readonly attribute IEventSource eventSource;
23084
23095 void checkMachineError (
23096 in IMachine machine
23097 );
23098
23099 };
23100
23114 interface IEventSource : $unknown
23115 {
23121 void createListener (
23122 [retval] out IEventListener listener
23123 );
23124
23140 void createAggregator (
23141 in IEventSource[] subordinates,
23142 [retval] out IEventSource result
23143 );
23144
23177 void registerListener (
23178 in IEventListener listener,
23179 in VBoxEventType[] interesting,
23180 in boolean active
23181 );
23182
23191 void unregisterListener (
23192 in IEventListener listener
23193 );
23194
23209 void fireEvent (
23210 in IEvent event,
23211 in long timeout,
23212 [retval] out boolean result
23213 );
23214
23239 void getEvent (
23240 in IEventListener listener,
23241 in long timeout,
23242 [retval] out IEvent event
23243 );
23244
23256 void eventProcessed (
23257 in IEventListener listener,
23258 in IEvent event
23259 );
23260
23261 };
23262
23272 interface IEventListener : $unknown
23273 {
23286 void handleEvent (
23287 in IEvent event
23288 );
23289
23290 };
23291
23368 interface IEvent : $unknown
23369 {
23375 readonly attribute VBoxEventType type;
23376
23382 readonly attribute IEventSource source;
23383
23394 readonly attribute boolean waitable;
23395
23402 void setProcessed();
23403
23417 void waitProcessed (
23418 in long timeout,
23419 [retval] out boolean result
23420 );
23421
23422 };
23423
23429 interface IReusableEvent : IEvent
23430 {
23434 readonly attribute unsigned long generation;
23435
23442 void reuse();
23443
23444 };
23445
23451 interface IMachineEvent : IEvent
23452 {
23456 readonly attribute wstringUUID machineId;
23457
23458 };
23459
23465 interface IMachineStateChangedEvent : IMachineEvent
23466 {
23470 readonly attribute MachineState state;
23471
23472 };
23473
23481 interface IMachineDataChangedEvent : IMachineEvent
23482 {
23489 readonly attribute boolean temporary;
23490
23491 };
23492
23501 interface IMediumRegisteredEvent : IEvent
23502 {
23506 readonly attribute wstringUUID mediumId;
23507
23511 readonly attribute DeviceType mediumType;
23512
23519 readonly attribute boolean registered;
23520
23521 };
23522
23531 interface IMachineRegisteredEvent : IMachineEvent
23532 {
23539 readonly attribute boolean registered;
23540
23541 };
23542
23552 interface ISessionStateChangedEvent : IMachineEvent
23553 {
23559 readonly attribute SessionState state;
23560
23561 };
23562
23570 interface IGuestPropertyChangedEvent : IMachineEvent
23571 {
23577 readonly attribute wstring name;
23578
23584 readonly attribute wstring value;
23585
23591 readonly attribute wstring flags;
23592
23593 };
23594
23600 interface ISnapshotEvent : IMachineEvent
23601 {
23605 readonly attribute wstringUUID snapshotId;
23606
23607 };
23608
23618 interface ISnapshotTakenEvent : ISnapshotEvent
23619 {
23620 };
23621
23638 interface ISnapshotDeletedEvent : ISnapshotEvent
23639 {
23640 };
23641
23651 interface ISnapshotChangedEvent : ISnapshotEvent
23652 {
23653 };
23654
23663 interface IMousePointerShapeChangedEvent : IEvent
23664 {
23670 readonly attribute boolean visible;
23671
23677 readonly attribute boolean alpha;
23678
23684 readonly attribute unsigned long xhot;
23685
23691 readonly attribute unsigned long yhot;
23692
23698 readonly attribute unsigned long width;
23699
23705 readonly attribute unsigned long height;
23706
23739 readonly attribute octet[] shape;
23740
23741 };
23742
23751 interface IMouseCapabilityChangedEvent : IEvent
23752 {
23758 readonly attribute boolean supportsAbsolute;
23759
23765 readonly attribute boolean supportsRelative;
23766
23772 readonly attribute boolean supportsMultiTouch;
23773
23779 readonly attribute boolean needsHostCursor;
23780
23781 };
23782
23791 interface IKeyboardLedsChangedEvent : IEvent
23792 {
23798 readonly attribute boolean numLock;
23799
23805 readonly attribute boolean capsLock;
23806
23812 readonly attribute boolean scrollLock;
23813
23814 };
23815
23824 interface IStateChangedEvent : IEvent
23825 {
23831 readonly attribute MachineState state;
23832
23833 };
23834
23844 interface IAdditionsStateChangedEvent : IEvent
23845 {
23846 };
23847
23858 interface INetworkAdapterChangedEvent : IEvent
23859 {
23865 readonly attribute INetworkAdapter networkAdapter;
23866
23867 };
23868
23879 interface ISerialPortChangedEvent : IEvent
23880 {
23886 readonly attribute ISerialPort serialPort;
23887
23888 };
23889
23900 interface IParallelPortChangedEvent : IEvent
23901 {
23907 readonly attribute IParallelPort parallelPort;
23908
23909 };
23910
23920 interface IStorageControllerChangedEvent : IEvent
23921 {
23922 };
23923
23933 interface IMediumChangedEvent : IEvent
23934 {
23940 readonly attribute IMediumAttachment mediumAttachment;
23941
23942 };
23943
23951 interface IClipboardModeChangedEvent : IEvent
23952 {
23958 readonly attribute ClipboardMode clipboardMode;
23959
23960 };
23961
23969 interface IDragAndDropModeChangedEvent : IEvent
23970 {
23976 readonly attribute DragAndDropMode dragAndDropMode;
23977
23978 };
23979
23987 interface ICPUChangedEvent : IEvent
23988 {
23994 readonly attribute unsigned long CPU;
23995
24001 readonly attribute boolean add;
24002
24003 };
24004
24012 interface ICPUExecutionCapChangedEvent : IEvent
24013 {
24019 readonly attribute unsigned long executionCap;
24020
24021 };
24022
24030 interface IGuestKeyboardEvent : IEvent
24031 {
24037 readonly attribute long[] scancodes;
24038
24039 };
24040
24048 interface IGuestMouseEvent : IReusableEvent
24049 {
24055 readonly attribute GuestMouseEventMode mode;
24056
24062 readonly attribute long x;
24063
24069 readonly attribute long y;
24070
24076 readonly attribute long z;
24077
24083 readonly attribute long w;
24084
24090 readonly attribute long buttons;
24091
24092 };
24093
24101 interface IGuestMultiTouchEvent : IEvent
24102 {
24108 readonly attribute long contactCount;
24109
24115 readonly attribute short[] xPositions;
24116
24122 readonly attribute short[] yPositions;
24123
24129 readonly attribute unsigned short[] contactIds;
24130
24138 readonly attribute unsigned short[] contactFlags;
24139
24145 readonly attribute unsigned long scanTime;
24146
24147 };
24148
24154 interface IGuestSessionEvent : IEvent
24155 {
24159 readonly attribute IGuestSession session;
24160
24161 };
24162
24170 interface IGuestSessionStateChangedEvent : IGuestSessionEvent
24171 {
24177 readonly attribute unsigned long id;
24178
24184 readonly attribute GuestSessionStatus status;
24185
24195 readonly attribute IVirtualBoxErrorInfo error;
24196
24197 };
24198
24206 interface IGuestSessionRegisteredEvent : IGuestSessionEvent
24207 {
24214 readonly attribute boolean registered;
24215
24216 };
24217
24223 interface IGuestProcessEvent : IGuestSessionEvent
24224 {
24230 readonly attribute IGuestProcess process;
24231
24237 readonly attribute unsigned long pid;
24238
24239 };
24240
24248 interface IGuestProcessRegisteredEvent : IGuestProcessEvent
24249 {
24256 readonly attribute boolean registered;
24257
24258 };
24259
24267 interface IGuestProcessStateChangedEvent : IGuestProcessEvent
24268 {
24274 readonly attribute ProcessStatus status;
24275
24285 readonly attribute IVirtualBoxErrorInfo error;
24286
24287 };
24288
24296 interface IGuestProcessIOEvent : IGuestProcessEvent
24297 {
24304 readonly attribute unsigned long handle;
24305
24311 readonly attribute unsigned long processed;
24312
24313 };
24314
24324 interface IGuestProcessInputNotifyEvent : IGuestProcessIOEvent
24325 {
24331 readonly attribute ProcessInputStatus status;
24332
24333 };
24334
24342 interface IGuestProcessOutputEvent : IGuestProcessIOEvent
24343 {
24349 readonly attribute octet[] data;
24350
24351 };
24352
24358 interface IGuestFileEvent : IGuestSessionEvent
24359 {
24365 readonly attribute IGuestFile file;
24366
24367 };
24368
24376 interface IGuestFileRegisteredEvent : IGuestFileEvent
24377 {
24384 readonly attribute boolean registered;
24385
24386 };
24387
24395 interface IGuestFileStateChangedEvent : IGuestFileEvent
24396 {
24402 readonly attribute FileStatus status;
24403
24413 readonly attribute IVirtualBoxErrorInfo error;
24414
24415 };
24416
24424 interface IGuestFileIOEvent : IGuestFileEvent
24425 {
24431 readonly attribute long long offset;
24432
24438 readonly attribute unsigned long processed;
24439
24440 };
24441
24449 interface IGuestFileOffsetChangedEvent : IGuestFileIOEvent
24450 {
24451 };
24452
24460 interface IGuestFileReadEvent : IGuestFileIOEvent
24461 {
24467 readonly attribute octet[] data;
24468
24469 };
24470
24478 interface IGuestFileWriteEvent : IGuestFileIOEvent
24479 {
24480 };
24481
24492 interface IVRDEServerChangedEvent : IEvent
24493 {
24494 };
24495
24505 interface IVRDEServerInfoChangedEvent : IEvent
24506 {
24507 };
24508
24516 interface IVideoCaptureChangedEvent : IEvent
24517 {
24518 };
24519
24530 interface IUSBControllerChangedEvent : IEvent
24531 {
24532 };
24533
24557 interface IUSBDeviceStateChangedEvent : IEvent
24558 {
24564 readonly attribute IUSBDevice device;
24565
24571 readonly attribute boolean attached;
24572
24578 readonly attribute IVirtualBoxErrorInfo error;
24579
24580 };
24581
24597 interface ISharedFolderChangedEvent : IEvent
24598 {
24604 readonly attribute Scope scope;
24605
24606 };
24607
24659 interface IRuntimeErrorEvent : IEvent
24660 {
24666 readonly attribute boolean fatal;
24667
24673 readonly attribute wstring id;
24674
24680 readonly attribute wstring message;
24681
24682 };
24683
24691 interface IEventSourceChangedEvent : IEvent
24692 {
24698 readonly attribute IEventListener listener;
24699
24705 readonly attribute boolean add;
24706
24707 };
24708
24717 interface IExtraDataChangedEvent : IEvent
24718 {
24725 readonly attribute wstringUUID machineId;
24726
24732 readonly attribute wstring key;
24733
24739 readonly attribute wstring value;
24740
24741 };
24742
24748 interface IVetoEvent : IEvent
24749 {
24759 void addVeto (
24760 in wstring reason
24761 );
24762
24772 void isVetoed (
24773 [retval] out boolean result
24774 );
24775
24785 void getVetos (
24786 [retval] out wstring[] result
24787 );
24788
24789 };
24790
24800 interface IExtraDataCanChangeEvent : IVetoEvent
24801 {
24808 readonly attribute wstringUUID machineId;
24809
24815 readonly attribute wstring key;
24816
24822 readonly attribute wstring value;
24823
24824 };
24825
24841 interface ICanShowWindowEvent : IVetoEvent
24842 {
24843 };
24844
24876 interface IShowWindowEvent : IEvent
24877 {
24886 attribute long long winId;
24887
24888 };
24889
24897 interface INATRedirectEvent : IMachineEvent
24898 {
24904 readonly attribute unsigned long slot;
24905
24911 readonly attribute boolean remove;
24912
24918 readonly attribute wstring name;
24919
24925 readonly attribute NATProtocol proto;
24926
24932 readonly attribute wstring hostIP;
24933
24939 readonly attribute long hostPort;
24940
24946 readonly attribute wstring guestIP;
24947
24953 readonly attribute long guestPort;
24954
24955 };
24956
24969 interface IHostPCIDevicePlugEvent : IMachineEvent
24970 {
24976 readonly attribute boolean plugged;
24977
24984 readonly attribute boolean success;
24985
24991 readonly attribute IPCIDeviceAttachment attachment;
24992
24998 readonly attribute wstring message;
24999
25000 };
25001
25010 interface IVBoxSVCAvailabilityChangedEvent : IEvent
25011 {
25017 readonly attribute boolean available;
25018
25019 };
25020
25028 interface IBandwidthGroupChangedEvent : IEvent
25029 {
25035 readonly attribute IBandwidthGroup bandwidthGroup;
25036
25037 };
25038
25046 interface IGuestMonitorChangedEvent : IEvent
25047 {
25053 readonly attribute GuestMonitorChangedEventType changeType;
25054
25060 readonly attribute unsigned long screenId;
25061
25068 readonly attribute unsigned long originX;
25069
25076 readonly attribute unsigned long originY;
25077
25084 readonly attribute unsigned long width;
25085
25092 readonly attribute unsigned long height;
25093
25094 };
25095
25103 interface IGuestUserStateChangedEvent : IEvent
25104 {
25110 readonly attribute wstring name;
25111
25118 readonly attribute wstring domain;
25119
25126 readonly attribute GuestUserState state;
25127
25133 readonly attribute wstring stateDetails;
25134
25135 };
25136
25146 interface IStorageDeviceChangedEvent : IEvent
25147 {
25153 readonly attribute IMediumAttachment storageDevice;
25154
25160 readonly attribute boolean removed;
25161
25167 readonly attribute boolean silent;
25168
25169 };
25170
25171 interface INATNetworkChangedEvent : IEvent
25172 {
25173 readonly attribute wstring networkName;
25174
25175 };
25176
25177 interface INATNetworkStartStopEvent : INATNetworkChangedEvent
25178 {
25184 readonly attribute boolean startEvent;
25185
25186 };
25187
25188 interface INATNetworkAlterEvent : INATNetworkChangedEvent
25189 {
25190 };
25191
25192 interface INATNetworkCreationDeletionEvent : INATNetworkAlterEvent
25193 {
25194 readonly attribute boolean creationEvent;
25195
25196 };
25197
25198 interface INATNetworkSettingEvent : INATNetworkAlterEvent
25199 {
25200 readonly attribute boolean enabled;
25201
25202 readonly attribute wstring network;
25203
25204 readonly attribute wstring gateway;
25205
25206 readonly attribute boolean advertiseDefaultIPv6RouteEnabled;
25207
25208 readonly attribute boolean needDhcpServer;
25209
25210 };
25211
25212 interface INATNetworkPortForwardEvent : INATNetworkAlterEvent
25213 {
25214 readonly attribute boolean create;
25215
25216 readonly attribute boolean ipv6;
25217
25218 readonly attribute wstring name;
25219
25220 readonly attribute NATProtocol proto;
25221
25222 readonly attribute wstring hostIp;
25223
25224 readonly attribute long hostPort;
25225
25226 readonly attribute wstring guestIp;
25227
25228 readonly attribute long guestPort;
25229
25230 };
25231
25232