VirtualBox Main API
VirtualBox.idl
Go to the documentation of this file.
1 
2 /*
3  * DO NOT EDIT! This is a generated file.
4  *
5  * Doxygen IDL definition for VirtualBox Main API (COM interfaces)
6  * generated from XIDL (XML interface definition).
7  *
8  * Source : src/VBox/Main/idl/VirtualBox.xidl
9  * Generator : src/VBox/Main/idl/doxygen.xsl
10  *
11  * This IDL is generated using some generic OMG IDL-like syntax SOLELY
12  * for the purpose of generating the documentation using Doxygen and
13  * is not syntactically valid.
14  *
15  * DO NOT USE THIS HEADER IN ANY OTHER WAY!
16  */
17 
130 const HRESULT VBOX_E_OBJECT_NOT_FOUND = 0x80BB0001;
138 const HRESULT VBOX_E_INVALID_VM_STATE = 0x80BB0002;
146 const HRESULT VBOX_E_VM_ERROR = 0x80BB0003;
154 const HRESULT VBOX_E_FILE_ERROR = 0x80BB0004;
162 const HRESULT VBOX_E_IPRT_ERROR = 0x80BB0005;
170 const HRESULT VBOX_E_PDM_ERROR = 0x80BB0006;
178 const HRESULT VBOX_E_INVALID_OBJECT_STATE = 0x80BB0007;
186 const HRESULT VBOX_E_HOST_ERROR = 0x80BB0008;
194 const HRESULT VBOX_E_NOT_SUPPORTED = 0x80BB0009;
202 const HRESULT VBOX_E_XML_ERROR = 0x80BB000A;
210 const HRESULT VBOX_E_INVALID_SESSION_STATE = 0x80BB000B;
218 const HRESULT VBOX_E_OBJECT_IN_USE = 0x80BB000C;
229 {
310 };
311 
320 {
323 };
324 
443 {
649 };
650 
661 {
709 };
710 
720 {
743 };
744 
755 {
807 };
808 
817 {
833 };
834 
843 {
854 };
855 
865 {
893 };
894 
903 {
942 };
943 
952 {
957 };
958 
967 {
972 };
973 
984 enum Scope
985 {
989 };
990 
999 {
1003 };
1004 
1013 {
1018 };
1019 
1028 {
1054 };
1055 
1064 {
1091 };
1092 
1101 {
1123 };
1124 
1133 {
1138 };
1139 
1148 {
1158 };
1159 
1168 {
1179 };
1180 
1188 {
1217 };
1218 
1226 {
1231 };
1232 
1240 {
1261 };
1262 
1271 {
1287 };
1288 
1297 {
1318 };
1319 
1331 {
1360 };
1361 
1372 {
1394 };
1395 
1404 {
1407 };
1408 
1417 {
1461 };
1462 
1471 {
1507 };
1508 
1517 {
1563 };
1564 
1573 {
1594 };
1595 
1604 {
1616 };
1617 
1626 {
1663 };
1664 
1673 {
1719 };
1720 
1729 {
1740 };
1741 
1751 {
1762 };
1763 
1773 {
1794 };
1795 
1804 {
1815 };
1816 
1825 {
1831 };
1832 
1841 {
1862 };
1863 
1874 {
1932 };
1933 
1945 {
2000 };
2001 
2012 {
2064 };
2065 
2067 {
2071 };
2072 
2074 {
2080 };
2081 
2090 {
2168 };
2169 
2178 {
2187 };
2188 
2200 {
2217 };
2218 
2227 {
2238 };
2239 
2248 {
2284 };
2285 
2294 {
2316 };
2317 
2327 {
2348 };
2349 
2389 {
2436 };
2437 
2448 {
2464 };
2465 
2474 {
2520 };
2521 
2530 {
2534 };
2535 
2544 {
2552 };
2553 
2563 {
2574 };
2575 
2585 {
2631 };
2632 
2641 {
2657 };
2658 
2665 {
2681 };
2682 
2689 {
2700 };
2701 
2710 {
2732 };
2733 
2743 {
3087 };
3088 
3097 {
3119 };
3120 
3154 interface IVirtualBoxErrorInfo : $errorinfo
3155 {
3173  readonly attribute long resultCode;
3174 
3186  readonly attribute wstringUUID interfaceID;
3187 
3198  readonly attribute wstring component;
3199 
3210  readonly attribute wstring text;
3211 
3222  readonly attribute IVirtualBoxErrorInfo next;
3223 
3224 }; /* interface IVirtualBoxErrorInfo */
3225 
3236 interface IDHCPServer : $unknown
3237 {
3243  attribute boolean enabled;
3244 
3250  readonly attribute wstring IPAddress;
3251 
3257  readonly attribute wstring networkMask;
3258 
3264  readonly attribute wstring networkName;
3265 
3271  readonly attribute wstring lowerIP;
3272 
3278  readonly attribute wstring upperIP;
3279 
3308  void setConfiguration (
3309  in wstring IPAddress,
3310  in wstring networkMask,
3311  in wstring FromIPAddress,
3312  in wstring ToIPAddress
3313  );
3314 
3339  void start (
3340  in wstring networkName,
3341  in wstring trunkName,
3342  in wstring trunkType
3343  );
3344 
3357  void stop();
3358 
3359 }; /* interface IDHCPServer */
3360 
3379 interface IVirtualBox : $unknown
3380 {
3388  readonly attribute wstring version;
3389 
3395  readonly attribute unsigned long revision;
3396 
3406  readonly attribute wstring packageType;
3407 
3419  readonly attribute wstring APIVersion;
3420 
3436  readonly attribute wstring homeFolder;
3437 
3445  readonly attribute wstring settingsFilePath;
3446 
3450  readonly attribute IHost host;
3451 
3456 
3462  readonly attribute IMachine[] machines;
3463 
3473  readonly attribute IMedium[] hardDisks;
3474 
3480  readonly attribute IMedium[] DVDImages;
3481 
3487  readonly attribute IMedium[] floppyImages;
3488 
3489  readonly attribute IProgress[] progressOperations;
3490 
3491  readonly attribute IGuestOSType[] guestOSTypes;
3492 
3509  readonly attribute ISharedFolder[] sharedFolders;
3510 
3517 
3523  readonly attribute IDHCPServer[] DHCPServers;
3524 
3530  readonly attribute IEventSource eventSource;
3531 
3538 
3544  readonly attribute wstring[] internalNetworks;
3545 
3551  readonly attribute wstring[] genericNetworkDrivers;
3552 
3592  void composeMachineFilename (
3593  in wstring name,
3594  in wstring baseFolder,
3595  [retval] out wstring file
3596  );
3597 
3694  void createMachine (
3695  in wstring settingsFile,
3696  in wstring name,
3697  in wstring osTypeId,
3698  in wstringUUID id,
3699  in boolean forceOverwrite,
3700  [retval] out IMachine machine
3701  );
3702 
3728  void openMachine (
3729  in wstring settingsFile,
3730  [retval] out IMachine machine
3731  );
3732 
3764  void registerMachine (
3765  in IMachine machine
3766  );
3767 
3788  void findMachine (
3789  in wstring nameOrId,
3790  [retval] out IMachine machine
3791  );
3792 
3802  void createAppliance (
3803  [retval] out IAppliance appliance
3804  );
3805 
3868  void createHardDisk (
3869  in wstring format,
3870  in wstring location,
3871  [retval] out IMedium medium
3872  );
3873 
3978  void openMedium (
3979  in wstring location,
3980  in DeviceType deviceType,
3981  in AccessMode accessMode,
3982  in boolean forceNewUuid,
3983  [retval] out IMedium medium
3984  );
3985 
4017  void findMedium (
4018  in wstring location,
4019  in DeviceType type,
4020  [retval] out IMedium medium
4021  );
4022 
4051  void getGuestOSType (
4052  in wstringUUID id,
4053  [retval] out IGuestOSType type
4054  );
4055 
4078  void createSharedFolder (
4079  in wstring name,
4080  in wstring hostPath,
4081  in boolean writable,
4082  in boolean automount
4083  );
4084 
4099  void removeSharedFolder (
4100  in wstring name
4101  );
4102 
4111  void getExtraDataKeys (
4112  [retval] out wstring[] value
4113  );
4114 
4143  void getExtraData (
4144  in wstring key,
4145  [retval] out wstring value
4146  );
4147 
4197  void setExtraData (
4198  in wstring key,
4199  in wstring value
4200  );
4201 
4218  void createDHCPServer (
4219  in wstring name,
4220  [retval] out IDHCPServer server
4221  );
4222 
4240  in wstring name,
4241  [retval] out IDHCPServer server
4242  );
4243 
4258  void removeDHCPServer (
4259  in IDHCPServer server
4260  );
4261 
4286  void checkFirmwarePresent (
4287  in FirmwareType firmwareType,
4288  in wstring version,
4289  out wstring url,
4290  out wstring file,
4291  [retval] out boolean result
4292  );
4293 
4294 }; /* interface IVirtualBox */
4295 
4306 interface IVFSExplorer : $unknown
4307 {
4311  readonly attribute wstring path;
4312 
4316  readonly attribute VFSType type;
4317 
4325  void update (
4326  [retval] out IProgress aProgress
4327  );
4328 
4336  void cd (
4337  in wstring aDir,
4338  [retval] out IProgress aProgress
4339  );
4340 
4346  void cdUp (
4347  [retval] out IProgress aProgress
4348  );
4349 
4362  void entryList (
4363  out wstring[] aNames,
4364  out unsigned long[] aTypes,
4365  out unsigned long[] aSizes,
4366  out unsigned long[] aModes
4367  );
4368 
4377  void exists (
4378  in wstring[] aNames,
4379  [retval] out wstring[] aExists
4380  );
4381 
4389  void remove (
4390  in wstring[] aNames,
4391  [retval] out IProgress aProgress
4392  );
4393 
4394 }; /* interface IVFSExplorer */
4395 
4461 interface IAppliance : $unknown
4462 {
4470  readonly attribute wstring path;
4471 
4502  readonly attribute wstring[] disks;
4503 
4512 
4520  readonly attribute wstring[] machines;
4521 
4538  void read (
4539  in wstring file,
4540  [retval] out IProgress aProgress
4541  );
4542 
4559  void interpret();
4560 
4583  void importMachines (
4584  in ImportOptions[] options,
4585  [retval] out IProgress aProgress
4586  );
4587 
4595  void createVFSExplorer (
4596  in wstring aUri,
4597  [retval] out IVFSExplorer aExplorer
4598  );
4599 
4629  void write (
4630  in wstring format,
4631  in boolean manifest,
4632  in wstring path,
4633  [retval] out IProgress progress
4634  );
4635 
4641  void getWarnings (
4642  [retval] out wstring[] aWarnings
4643  );
4644 
4645 }; /* interface IAppliance */
4646 
4658 interface IVirtualSystemDescription : $unknown
4659 {
4663  readonly attribute unsigned long count;
4664 
4788  void getDescription (
4789  out VirtualSystemDescriptionType[] aTypes,
4790  out wstring[] aRefs,
4791  out wstring[] aOvfValues,
4792  out wstring[] aVBoxValues,
4793  out wstring[] aExtraConfigValues
4794  );
4795 
4812  void getDescriptionByType (
4814  out VirtualSystemDescriptionType[] aTypes,
4815  out wstring[] aRefs,
4816  out wstring[] aOvfValues,
4817  out wstring[] aVBoxValues,
4818  out wstring[] aExtraConfigValues
4819  );
4820 
4832  void getValuesByType (
4835  [retval] out wstring[] aValues
4836  );
4837 
4863  void setFinalValues (
4864  in boolean[] aEnabled,
4865  in wstring[] aVBoxValues,
4866  in wstring[] aExtraConfigValues
4867  );
4868 
4883  void addDescription (
4885  in wstring aVBoxValue,
4886  in wstring aExtraConfigValue
4887  );
4888 
4889 }; /* interface IVirtualSystemDescription */
4890 
4891 interface IInternalMachineControl : $unknown
4892 {
4900  in boolean aRemove
4901  );
4902 
4914  void updateState (
4915  in MachineState state
4916  );
4917 
4918  void getIPCId (
4919  [retval] out wstring id
4920  );
4921 
4933  void beginPowerUp (
4934  in IProgress aProgress
4935  );
4936 
4946  void endPowerUp (
4947  in long result
4948  );
4949 
4961  void beginPoweringDown (
4962  out IProgress progress
4963  );
4964 
4994  void endPoweringDown (
4995  in long result,
4996  in wstring errMsg
4997  );
4998 
5012  void runUSBDeviceFilters (
5013  in IUSBDevice device,
5014  out boolean matched,
5015  out unsigned long maskedInterfaces
5016  );
5017 
5026  void captureUSBDevice (
5027  in wstringUUID id
5028  );
5029 
5045  void detachUSBDevice (
5046  in wstringUUID id,
5047  in boolean done
5048  );
5049 
5058  void autoCaptureUSBDevices();
5059 
5075  void detachAllUSBDevices (
5076  in boolean done
5077  );
5078 
5093  void onSessionEnd (
5094  in ISession session,
5095  [retval] out IProgress progress
5096  );
5097 
5113  void beginSavingState (
5114  out IProgress progress,
5115  out wstring stateFilePath
5116  );
5117 
5147  void endSavingState (
5148  in long result,
5149  in wstring errMsg
5150  );
5151 
5166  void adoptSavedState (
5167  in wstring savedStateFile
5168  );
5169 
5218  void beginTakingSnapshot (
5219  in IConsole initiator,
5220  in wstring name,
5221  in wstring description,
5222  in IProgress consoleProgress,
5223  in boolean fTakingSnapshotOnline,
5224  out wstring stateFilePath
5225  );
5226 
5236  void endTakingSnapshot (
5237  in boolean success
5238  );
5239 
5268  void deleteSnapshot (
5269  in IConsole initiator,
5270  in wstringUUID startId,
5271  in wstringUUID endId,
5272  in boolean deleteAllChildren,
5273  out MachineState machineState,
5274  [retval] out IProgress progress
5275  );
5276 
5296  in IMediumAttachment mediumAttachment,
5297  in IMedium source,
5298  in IMedium target,
5299  in boolean mergeForward,
5300  in IMedium parentForTarget,
5301  in IMedium[] childrenToReparent
5302  );
5303 
5317  void restoreSnapshot (
5318  in IConsole initiator,
5319  in ISnapshot snapshot,
5320  out MachineState machineState,
5321  [retval] out IProgress progress
5322  );
5323 
5350  void pullGuestProperties (
5351  out wstring[] name,
5352  out wstring[] value,
5353  out long long[] timestamp,
5354  out wstring[] flags
5355  );
5356 
5378  void pushGuestProperty (
5379  in wstring name,
5380  in wstring value,
5381  in long long timestamp,
5382  in wstring flags
5383  );
5384 
5396  void lockMedia();
5397 
5407  void unlockMedia();
5408 
5424  void ejectMedium (
5425  in IMediumAttachment attachment,
5426  [retval] out IMediumAttachment newAttachment
5427  );
5428 
5465  void reportGuestStatistics (
5466  in unsigned long validStats,
5467  in unsigned long cpuUser,
5468  in unsigned long cpuKernel,
5469  in unsigned long cpuIdle,
5470  in unsigned long memTotal,
5471  in unsigned long memFree,
5472  in unsigned long memBalloon,
5473  in unsigned long memShared,
5474  in unsigned long memCache,
5475  in unsigned long pagedTotal,
5476  in unsigned long memAllocTotal,
5477  in unsigned long memFreeTotal,
5478  in unsigned long memBalloonTotal,
5479  in unsigned long memSharedTotal
5480  );
5481 
5482 }; /* interface IInternalMachineControl */
5483 
5492 interface IBIOSSettings : $unknown
5493 {
5497  attribute boolean logoFadeIn;
5498 
5502  attribute boolean logoFadeOut;
5503 
5507  attribute unsigned long logoDisplayTime;
5508 
5515  attribute wstring logoImagePath;
5516 
5521 
5525  attribute boolean ACPIEnabled;
5526 
5533  attribute boolean IOAPICEnabled;
5534 
5544  attribute long long timeOffset;
5545 
5552  attribute boolean PXEDebugEnabled;
5553 
5554 }; /* interface IBIOSSettings */
5555 
5563 interface IPciAddress : $unknown
5564 {
5570  attribute short bus;
5571 
5577  attribute short device;
5578 
5584  attribute short devFunction;
5585 
5591  void asLong (
5592  [retval] out long result
5593  );
5594 
5600  void fromLong (
5601  in long number
5602  );
5603 
5604 }; /* interface IPciAddress */
5605 
5613 interface IPciDeviceAttachment : $unknown
5614 {
5620  readonly attribute wstring name;
5621 
5627  readonly attribute boolean isPhysicalDevice;
5628 
5634  readonly attribute long hostAddress;
5635 
5641  readonly attribute long guestAddress;
5642 
5643 }; /* interface IPciDeviceAttachment */
5644 
5685 interface IMachine : $unknown
5686 {
5690  readonly attribute IVirtualBox parent;
5691 
5741  readonly attribute boolean accessible;
5742 
5754  readonly attribute IVirtualBoxErrorInfo accessError;
5755 
5795  attribute wstring name;
5796 
5807  attribute wstring description;
5808 
5812  readonly attribute wstringUUID id;
5813 
5828  attribute wstring OSTypeId;
5829 
5833  attribute wstring hardwareVersion;
5834 
5844  attribute wstringUUID hardwareUUID;
5845 
5849  attribute unsigned long CPUCount;
5850 
5856  attribute boolean CPUHotPlugEnabled;
5857 
5865  attribute unsigned long CPUExecutionCap;
5866 
5870  attribute unsigned long memorySize;
5871 
5875  attribute unsigned long memoryBalloonSize;
5876 
5883  attribute boolean pageFusionEnabled;
5884 
5888  attribute unsigned long VRAMSize;
5889 
5895  attribute boolean accelerate3DEnabled;
5896 
5902  attribute boolean accelerate2DVideoEnabled;
5903 
5914  attribute unsigned long monitorCount;
5915 
5919  readonly attribute IBIOSSettings BIOSSettings;
5920 
5926 
5933 
5940 
5947  attribute boolean hpetEnabled;
5948 
5953 
5987  attribute wstring snapshotFolder;
5988 
5992  readonly attribute IVRDEServer VRDEServer;
5993 
5994  attribute boolean emulatedUSBWebcameraEnabled;
5995 
5996  attribute boolean emulatedUSBCardReaderEnabled;
5997 
6001  readonly attribute IMediumAttachment[] mediumAttachments;
6002 
6014  readonly attribute IUSBController USBController;
6015 
6019  readonly attribute IAudioAdapter audioAdapter;
6020 
6025 
6031  readonly attribute wstring settingsFilePath;
6032 
6057  readonly attribute boolean settingsModified;
6058 
6062  readonly attribute SessionState sessionState;
6063 
6076  readonly attribute wstring sessionType;
6077 
6087  readonly attribute unsigned long sessionPid;
6088 
6092  readonly attribute MachineState state;
6093 
6100  readonly attribute long long lastStateChange;
6101 
6113  readonly attribute wstring stateFilePath;
6114 
6124  readonly attribute wstring logFolder;
6125 
6136  readonly attribute ISnapshot currentSnapshot;
6137 
6144  readonly attribute unsigned long snapshotCount;
6145 
6177  readonly attribute boolean currentStateModified;
6178 
6190  readonly attribute ISharedFolder[] sharedFolders;
6191 
6199 
6208 
6217  attribute boolean teleporterEnabled;
6218 
6229  attribute unsigned long teleporterPort;
6230 
6237  attribute wstring teleporterAddress;
6238 
6246  attribute wstring teleporterPassword;
6247 
6256 
6263  attribute unsigned long faultTolerancePort;
6264 
6270  attribute wstring faultToleranceAddress;
6271 
6279  attribute wstring faultTolerancePassword;
6280 
6286  attribute unsigned long faultToleranceSyncInterval;
6287 
6295  attribute boolean RTCUseUTC;
6296 
6303  attribute boolean ioCacheEnabled;
6304 
6310  attribute unsigned long ioCacheSize;
6311 
6318 
6329 
6435  void lockMachine (
6436  in ISession session,
6437  in LockType lockType
6438  );
6439 
6569  void launchVMProcess (
6570  in ISession session,
6571  in wstring type,
6572  in wstring environment,
6573  [retval] out IProgress progress
6574  );
6575 
6613  void setBootOrder (
6614  in unsigned long position,
6615  in DeviceType device
6616  );
6617 
6652  void getBootOrder (
6653  in unsigned long position,
6654  [retval] out DeviceType device
6655  );
6656 
6758  void attachDevice (
6759  in wstring name,
6760  in long controllerPort,
6761  in long device,
6762  in DeviceType type,
6763  in IMedium medium
6764  );
6765 
6818  void detachDevice (
6819  in wstring name,
6820  in long controllerPort,
6821  in long device
6822  );
6823 
6866  void passthroughDevice (
6867  in wstring name,
6868  in long controllerPort,
6869  in long device,
6870  in boolean passthrough
6871  );
6872 
6915  void temporaryEjectDevice (
6916  in wstring name,
6917  in long controllerPort,
6918  in long device,
6919  in boolean temporaryEject
6920  );
6921 
6967  void nonRotationalDevice (
6968  in wstring name,
6969  in long controllerPort,
6970  in long device,
6971  in boolean nonRotational
6972  );
6973 
7015  in wstring name,
7016  in long controllerPort,
7017  in long device,
7018  in IBandwidthGroup bandwidthGroup
7019  );
7020 
7083  void mountMedium (
7084  in wstring name,
7085  in long controllerPort,
7086  in long device,
7087  in IMedium medium,
7088  in boolean force
7089  );
7090 
7119  void getMedium (
7120  in wstring name,
7121  in long controllerPort,
7122  in long device,
7123  [retval] out IMedium medium
7124  );
7125 
7141  in wstring name,
7142  [retval] out IMediumAttachment[] mediumAttachments
7143  );
7144 
7159  void getMediumAttachment (
7160  in wstring name,
7161  in long controllerPort,
7162  in long device,
7163  [retval] out IMediumAttachment attachment
7164  );
7165 
7206  void attachHostPciDevice (
7207  in long hostAddress,
7208  in long desiredGuestAddress,
7209  in boolean tryToUnbind
7210  );
7211 
7252  void detachHostPciDevice (
7253  in long hostAddress
7254  );
7255 
7273  void getNetworkAdapter (
7274  in unsigned long slot,
7275  [retval] out INetworkAdapter adapter
7276  );
7277 
7310  void addStorageController (
7311  in wstring name,
7312  in StorageBus connectionType,
7313  [retval] out IStorageController controller
7314  );
7315 
7330  in wstring name,
7331  [retval] out IStorageController storageController
7332  );
7333 
7348  in unsigned long instance,
7349  [retval] out IStorageController storageController
7350  );
7351 
7366  in wstring name
7367  );
7368 
7391  in wstring name,
7392  in boolean bootable
7393  );
7394 
7412  void getSerialPort (
7413  in unsigned long slot,
7414  [retval] out ISerialPort port
7415  );
7416 
7434  void getParallelPort (
7435  in unsigned long slot,
7436  [retval] out IParallelPort port
7437  );
7438 
7447  void getExtraDataKeys (
7448  [retval] out wstring[] value
7449  );
7450 
7479  void getExtraData (
7480  in wstring key,
7481  [retval] out wstring value
7482  );
7483 
7533  void setExtraData (
7534  in wstring key,
7535  in wstring value
7536  );
7537 
7559  void getCPUProperty (
7560  in CPUPropertyType property,
7561  [retval] out boolean value
7562  );
7563 
7585  void setCPUProperty (
7586  in CPUPropertyType property,
7587  in boolean value
7588  );
7589 
7629  void getCPUIDLeaf (
7630  in unsigned long id,
7631  out unsigned long valEax,
7632  out unsigned long valEbx,
7633  out unsigned long valEcx,
7634  out unsigned long valEdx
7635  );
7636 
7680  void setCPUIDLeaf (
7681  in unsigned long id,
7682  in unsigned long valEax,
7683  in unsigned long valEbx,
7684  in unsigned long valEcx,
7685  in unsigned long valEdx
7686  );
7687 
7705  void removeCPUIDLeaf (
7706  in unsigned long id
7707  );
7708 
7714  void removeAllCPUIDLeaves();
7715 
7737  void getHWVirtExProperty (
7738  in HWVirtExPropertyType property,
7739  [retval] out boolean value
7740  );
7741 
7763  void setHWVirtExProperty (
7764  in HWVirtExPropertyType property,
7765  in boolean value
7766  );
7767 
7813  void saveSettings();
7814 
7838  void discardSettings();
7839 
7923  void unregister (
7924  in CleanupMode cleanupMode,
7925  [retval] out IMedium[] aMedia
7926  );
7927 
7984  void delete (
7985  in IMedium[] aMedia,
7986  [retval] out IProgress aProgress
7987  );
7988 
8000  void export (
8001  in IAppliance aAppliance,
8002  in wstring location,
8003  [retval] out IVirtualSystemDescription aDescription
8004  );
8005 
8029  void findSnapshot (
8030  in wstring nameOrId,
8031  [retval] out ISnapshot snapshot
8032  );
8033 
8067  void createSharedFolder (
8068  in wstring name,
8069  in wstring hostPath,
8070  in boolean writable,
8071  in boolean automount
8072  );
8073 
8099  void removeSharedFolder (
8100  in wstring name
8101  );
8102 
8126  void canShowConsoleWindow (
8127  [retval] out boolean canShow
8128  );
8129 
8164  void showConsoleWindow (
8165  [retval] out long long winId
8166  );
8167 
8200  void getGuestProperty (
8201  in wstring name,
8202  out wstring value,
8203  out long long timestamp,
8204  out wstring flags
8205  );
8206 
8229  void getGuestPropertyValue (
8230  in wstring property,
8231  [retval] out wstring value
8232  );
8233 
8257  in wstring property,
8258  [retval] out long long value
8259  );
8260 
8311  void setGuestProperty (
8312  in wstring property,
8313  in wstring value,
8314  in wstring flags
8315  );
8316 
8357  void setGuestPropertyValue (
8358  in wstring property,
8359  in wstring value
8360  );
8361 
8393  in wstring patterns,
8394  out wstring[] name,
8395  out wstring[] value,
8396  out long long[] timestamp,
8397  out wstring[] flags
8398  );
8399 
8417  void querySavedGuestSize (
8418  in unsigned long screenId,
8419  out unsigned long width,
8420  out unsigned long height
8421  );
8422 
8445  in unsigned long screenId,
8446  out unsigned long size,
8447  out unsigned long width,
8448  out unsigned long height
8449  );
8450 
8478  in unsigned long screenId,
8479  in boolean BGR,
8480  out unsigned long width,
8481  out unsigned long height,
8482  [retval] out octet[] data
8483  );
8484 
8507  in unsigned long screenId,
8508  out unsigned long width,
8509  out unsigned long height,
8510  [retval] out octet[] data
8511  );
8512 
8535  in unsigned long screenId,
8536  out unsigned long size,
8537  out unsigned long width,
8538  out unsigned long height
8539  );
8540 
8563  in unsigned long screenId,
8564  out unsigned long width,
8565  out unsigned long height,
8566  [retval] out octet[] data
8567  );
8568 
8578  void hotPlugCPU (
8579  in unsigned long cpu
8580  );
8581 
8591  void hotUnplugCPU (
8592  in unsigned long cpu
8593  );
8594 
8608  void getCPUStatus (
8609  in unsigned long cpu,
8610  [retval] out boolean attached
8611  );
8612 
8627  void queryLogFilename (
8628  in unsigned long idx,
8629  [retval] out wstring filename
8630  );
8631 
8657  void readLog (
8658  in unsigned long idx,
8659  in long long offset,
8660  in long long size,
8661  [retval] out octet[] data
8662  );
8663 
8696  void cloneTo (
8697  in IMachine target,
8698  in CloneMode mode,
8699  in CloneOptions[] options,
8700  [retval] out IProgress progress
8701  );
8702 
8703 }; /* interface IMachine */
8704 
8713 interface IVRDEServerInfo : $unknown
8714 {
8720  readonly attribute boolean active;
8721 
8730  readonly attribute long port;
8731 
8737  readonly attribute unsigned long numberOfClients;
8738 
8744  readonly attribute long long beginTime;
8745 
8752  readonly attribute long long endTime;
8753 
8759  readonly attribute long long bytesSent;
8760 
8766  readonly attribute long long bytesSentTotal;
8767 
8773  readonly attribute long long bytesReceived;
8774 
8780  readonly attribute long long bytesReceivedTotal;
8781 
8787  readonly attribute wstring user;
8788 
8794  readonly attribute wstring domain;
8795 
8801  readonly attribute wstring clientName;
8802 
8808  readonly attribute wstring clientIP;
8809 
8815  readonly attribute unsigned long clientVersion;
8816 
8824  readonly attribute unsigned long encryptionStyle;
8825 
8826 }; /* interface IVRDEServerInfo */
8827 
8849 interface IConsole : $unknown
8850 {
8862  readonly attribute IMachine machine;
8863 
8877  readonly attribute MachineState state;
8878 
8882  readonly attribute IGuest guest;
8883 
8894  readonly attribute IKeyboard keyboard;
8895 
8906  readonly attribute IMouse mouse;
8907 
8917  readonly attribute IDisplay display;
8918 
8922  readonly attribute IMachineDebugger debugger;
8923 
8934  readonly attribute IUSBDevice[] USBDevices;
8935 
8943  readonly attribute IHostUSBDevice[] remoteUSBDevices;
8944 
8960  readonly attribute ISharedFolder[] sharedFolders;
8961 
8967  readonly attribute IVRDEServerInfo VRDEServerInfo;
8968 
8974  readonly attribute IEventSource eventSource;
8975 
8980 
8989  attribute boolean useHostClipboard;
8990 
9055  void powerUp (
9056  [retval] out IProgress progress
9057  );
9058 
9092  void powerUpPaused (
9093  [retval] out IProgress progress
9094  );
9095 
9115  void powerDown (
9116  [retval] out IProgress progress
9117  );
9118 
9138  void reset();
9139 
9159  void pause();
9160 
9180  void resume();
9181 
9201  void powerButton();
9202 
9222  void sleepButton();
9223 
9235  void getPowerButtonHandled (
9236  [retval] out boolean handled
9237  );
9238 
9253  [retval] out boolean entered
9254  );
9255 
9308  void saveState (
9309  [retval] out IProgress progress
9310  );
9311 
9344  void adoptSavedState (
9345  in wstring savedStateFile
9346  );
9347 
9378  void discardSavedState (
9379  in boolean fRemoveFile
9380  );
9381 
9394  void getDeviceActivity (
9395  in DeviceType type,
9396  [retval] out DeviceActivity activity
9397  );
9398 
9436  void attachUSBDevice (
9437  in wstringUUID id
9438  );
9439 
9474  void detachUSBDevice (
9475  in wstringUUID id,
9476  [retval] out IUSBDevice device
9477  );
9478 
9501  void findUSBDeviceByAddress (
9502  in wstring name,
9503  [retval] out IUSBDevice device
9504  );
9505 
9525  void findUSBDeviceById (
9526  in wstringUUID id,
9527  [retval] out IUSBDevice device
9528  );
9529 
9563  void createSharedFolder (
9564  in wstring name,
9565  in wstring hostPath,
9566  in boolean writable,
9567  in boolean automount
9568  );
9569 
9594  void removeSharedFolder (
9595  in wstring name
9596  );
9597 
9635  void takeSnapshot (
9636  in wstring name,
9637  in wstring description,
9638  [retval] out IProgress progress
9639  );
9640 
9713  void deleteSnapshot (
9714  in wstringUUID id,
9715  [retval] out IProgress progress
9716  );
9717 
9758  in wstringUUID id,
9759  [retval] out IProgress progress
9760  );
9761 
9805  void deleteSnapshotRange (
9806  in wstringUUID startId,
9807  in wstringUUID endId,
9808  [retval] out IProgress progress
9809  );
9810 
9851  void restoreSnapshot (
9852  in ISnapshot snapshot,
9853  [retval] out IProgress progress
9854  );
9855 
9894  void teleport (
9895  in wstring hostname,
9896  in unsigned long tcpport,
9897  in wstring password,
9898  in unsigned long maxDowntime,
9899  [retval] out IProgress progress
9900  );
9901 
9902 }; /* interface IConsole */
9903 
9914 interface IHostNetworkInterface : $unknown
9915 {
9919  readonly attribute wstring name;
9920 
9924  readonly attribute wstringUUID id;
9925 
9929  readonly attribute wstring networkName;
9930 
9934  readonly attribute boolean dhcpEnabled;
9935 
9939  readonly attribute wstring IPAddress;
9940 
9944  readonly attribute wstring networkMask;
9945 
9949  readonly attribute boolean IPV6Supported;
9950 
9954  readonly attribute wstring IPV6Address;
9955 
9959  readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
9960 
9964  readonly attribute wstring hardwareAddress;
9965 
9970 
9975 
9980 
9992  void enableStaticIpConfig (
9993  in wstring IPAddress,
9994  in wstring networkMask
9995  );
9996 
10008  void enableStaticIpConfigV6 (
10009  in wstring IPV6Address,
10010  in unsigned long IPV6NetworkMaskPrefixLength
10011  );
10012 
10016  void enableDynamicIpConfig();
10017 
10021  void dhcpRediscover();
10022 
10023 }; /* interface IHostNetworkInterface */
10024 
10041 interface IHost : $unknown
10042 {
10046  readonly attribute IMedium[] DVDDrives;
10047 
10051  readonly attribute IMedium[] floppyDrives;
10052 
10066  readonly attribute IHostUSBDevice[] USBDevices;
10067 
10092 
10097 
10101  readonly attribute unsigned long processorCount;
10102 
10106  readonly attribute unsigned long processorOnlineCount;
10107 
10111  readonly attribute unsigned long processorCoreCount;
10112 
10116  readonly attribute unsigned long memorySize;
10117 
10121  readonly attribute unsigned long memoryAvailable;
10122 
10126  readonly attribute wstring operatingSystem;
10127 
10131  readonly attribute wstring OSVersion;
10132 
10136  readonly attribute long long UTCTime;
10137 
10141  readonly attribute boolean Acceleration3DAvailable;
10142 
10157  void getProcessorSpeed (
10158  in unsigned long cpuId,
10159  [retval] out unsigned long speed
10160  );
10161 
10173  void getProcessorFeature (
10174  in ProcessorFeature feature,
10175  [retval] out boolean supported
10176  );
10177 
10197  in unsigned long cpuId,
10198  [retval] out wstring description
10199  );
10200 
10241  void getProcessorCPUIDLeaf (
10242  in unsigned long cpuId,
10243  in unsigned long leaf,
10244  in unsigned long subLeaf,
10245  out unsigned long valEax,
10246  out unsigned long valEbx,
10247  out unsigned long valEcx,
10248  out unsigned long valEdx
10249  );
10250 
10272  out IHostNetworkInterface hostInterface,
10273  [retval] out IProgress progress
10274  );
10275 
10297  in wstringUUID id,
10298  [retval] out IProgress progress
10299  );
10300 
10320  void createUSBDeviceFilter (
10321  in wstring name,
10322  [retval] out IHostUSBDeviceFilter filter
10323  );
10324 
10367  void insertUSBDeviceFilter (
10368  in unsigned long position,
10369  in IHostUSBDeviceFilter filter
10370  );
10371 
10399  void removeUSBDeviceFilter (
10400  in unsigned long position
10401  );
10402 
10420  void findHostDVDDrive (
10421  in wstring name,
10422  [retval] out IMedium drive
10423  );
10424 
10442  void findHostFloppyDrive (
10443  in wstring name,
10444  [retval] out IMedium drive
10445  );
10446 
10463  in wstring name,
10464  [retval] out IHostNetworkInterface networkInterface
10465  );
10466 
10483  in wstringUUID id,
10484  [retval] out IHostNetworkInterface networkInterface
10485  );
10486 
10497  in HostNetworkInterfaceType type,
10499  );
10500 
10520  void findUSBDeviceById (
10521  in wstringUUID id,
10522  [retval] out IHostUSBDevice device
10523  );
10524 
10547  void findUSBDeviceByAddress (
10548  in wstring name,
10549  [retval] out IHostUSBDevice device
10550  );
10551 
10559  void generateMACAddress (
10560  [retval] out wstring address
10561  );
10562 
10563 }; /* interface IHost */
10564 
10577 interface ISystemProperties : $unknown
10578 {
10582  readonly attribute unsigned long minGuestRAM;
10583 
10587  readonly attribute unsigned long maxGuestRAM;
10588 
10592  readonly attribute unsigned long minGuestVRAM;
10593 
10597  readonly attribute unsigned long maxGuestVRAM;
10598 
10602  readonly attribute unsigned long minGuestCPUCount;
10603 
10607  readonly attribute unsigned long maxGuestCPUCount;
10608 
10612  readonly attribute unsigned long maxGuestMonitors;
10613 
10618  readonly attribute long long infoVDSize;
10619 
10626  readonly attribute unsigned long serialPortCount;
10627 
10634  readonly attribute unsigned long parallelPortCount;
10635 
10645  readonly attribute unsigned long maxBootPosition;
10646 
10670  attribute wstring defaultMachineFolder;
10671 
10696  readonly attribute IMediumFormat[] mediumFormats;
10697 
10731  attribute wstring defaultHardDiskFormat;
10732 
10738  attribute long long freeDiskSpaceWarning;
10739 
10744  attribute unsigned long freeDiskSpacePercentWarning;
10745 
10751  attribute long long freeDiskSpaceError;
10752 
10757  attribute unsigned long freeDiskSpacePercentError;
10758 
10782  attribute wstring VRDEAuthLibrary;
10783 
10812  attribute wstring webServiceAuthLibrary;
10813 
10827  attribute wstring defaultVRDEExtPack;
10828 
10834  attribute unsigned long logHistoryCount;
10835 
10841 
10852  void getMaxNetworkAdapters (
10853  in ChipsetType chipset,
10854  [retval] out unsigned long maxNetworkAdapters
10855  );
10856 
10871  in ChipsetType chipset,
10872  in NetworkAttachmentType type,
10873  [retval] out unsigned long maxNetworkAdapters
10874  );
10875 
10886  in StorageBus bus,
10887  [retval] out unsigned long maxDevicesPerPort
10888  );
10889 
10898  in StorageBus bus,
10899  [retval] out unsigned long minPortCount
10900  );
10901 
10910  in StorageBus bus,
10911  [retval] out unsigned long maxPortCount
10912  );
10913 
10927  in ChipsetType chipset,
10928  in StorageBus bus,
10929  [retval] out unsigned long maxInstances
10930  );
10931 
10942  in StorageBus bus,
10943  [retval] out DeviceType[] deviceTypes
10944  );
10945 
10955  in StorageControllerType controllerType,
10956  [retval] out boolean enabled
10957  );
10958 
10959 }; /* interface ISystemProperties */
10960 
10966 interface IGuestOSType : $unknown
10967 {
10971  readonly attribute wstring familyId;
10972 
10976  readonly attribute wstring familyDescription;
10977 
10981  readonly attribute wstring id;
10982 
10986  readonly attribute wstring description;
10987 
10991  readonly attribute boolean is64Bit;
10992 
10996  readonly attribute boolean recommendedIOAPIC;
10997 
11001  readonly attribute boolean recommendedVirtEx;
11002 
11006  readonly attribute unsigned long recommendedRAM;
11007 
11011  readonly attribute unsigned long recommendedVRAM;
11012 
11016  readonly attribute long long recommendedHDD;
11017 
11021  readonly attribute NetworkAdapterType adapterType;
11022 
11026  readonly attribute boolean recommendedPae;
11027 
11032 
11037 
11042 
11047 
11051  readonly attribute FirmwareType recommendedFirmware;
11052 
11056  readonly attribute boolean recommendedUsbHid;
11057 
11061  readonly attribute boolean recommendedHpet;
11062 
11066  readonly attribute boolean recommendedUsbTablet;
11067 
11071  readonly attribute boolean recommendedRtcUseUtc;
11072 
11076  readonly attribute ChipsetType recommendedChipset;
11077 
11082 
11083 }; /* interface IGuestOSType */
11084 
11092 interface IAdditionsFacility : $unknown
11093 {
11097  readonly attribute AdditionsFacilityClass classType;
11098 
11105  readonly attribute long long lastUpdated;
11106 
11110  readonly attribute wstring name;
11111 
11115  readonly attribute AdditionsFacilityStatus status;
11116 
11120  readonly attribute AdditionsFacilityType type;
11121 
11122 }; /* interface IAdditionsFacility */
11123 
11131 interface IGuestDirEntry : $unknown
11132 {
11136  readonly attribute long long nodeId;
11137 
11141  readonly attribute wstring name;
11142 
11146  readonly attribute GuestDirEntryType type;
11147 
11148 }; /* interface IGuestDirEntry */
11149 
11163 interface IGuest : $unknown
11164 {
11179  readonly attribute wstring OSTypeId;
11180 
11187 
11195  readonly attribute wstring additionsVersion;
11196 
11203  readonly attribute IAdditionsFacility[] facilities;
11204 
11208  attribute unsigned long memoryBalloonSize;
11209 
11213  attribute unsigned long statisticsUpdateInterval;
11214 
11246  void internalGetStatistics (
11247  out unsigned long cpuUser,
11248  out unsigned long cpuKernel,
11249  out unsigned long cpuIdle,
11250  out unsigned long memTotal,
11251  out unsigned long memFree,
11252  out unsigned long memBalloon,
11253  out unsigned long memShared,
11254  out unsigned long memCache,
11255  out unsigned long pagedTotal,
11256  out unsigned long memAllocTotal,
11257  out unsigned long memFreeTotal,
11258  out unsigned long memBalloonTotal,
11259  out unsigned long memSharedTotal
11260  );
11261 
11273  void getFacilityStatus (
11274  in AdditionsFacilityType facility,
11275  out long long timestamp,
11276  [retval] out AdditionsFacilityStatus status
11277  );
11278 
11296  void getAdditionsStatus (
11297  in AdditionsRunLevelType level,
11298  [retval] out boolean active
11299  );
11300 
11330  void setCredentials (
11331  in wstring userName,
11332  in wstring password,
11333  in wstring domain,
11334  in boolean allowInteractiveLogon
11335  );
11336 
11406  void executeProcess (
11407  in wstring execName,
11408  in unsigned long flags,
11409  in wstring[] arguments,
11410  in wstring[] environment,
11411  in wstring userName,
11412  in wstring password,
11413  in unsigned long timeoutMS,
11414  out unsigned long pid,
11415  [retval] out IProgress progress
11416  );
11417 
11462  void getProcessOutput (
11463  in unsigned long pid,
11464  in unsigned long flags,
11465  in unsigned long timeoutMS,
11466  in long long size,
11467  [retval] out octet[] data
11468  );
11469 
11503  void getProcessStatus (
11504  in unsigned long pid,
11505  out unsigned long exitcode,
11506  out unsigned long flags,
11507  [retval] out ExecuteProcessStatus reason
11508  );
11509 
11546  void copyFromGuest (
11547  in wstring source,
11548  in wstring dest,
11549  in wstring userName,
11550  in wstring password,
11551  in unsigned long flags,
11552  [retval] out IProgress progress
11553  );
11554 
11591  void copyToGuest (
11592  in wstring source,
11593  in wstring dest,
11594  in wstring userName,
11595  in wstring password,
11596  in unsigned long flags,
11597  [retval] out IProgress progress
11598  );
11599 
11617  void directoryClose (
11618  in unsigned long handle
11619  );
11620 
11655  void directoryCreate (
11656  in wstring directory,
11657  in wstring userName,
11658  in wstring password,
11659  in unsigned long mode,
11660  in unsigned long flags
11661  );
11662 
11702  void directoryOpen (
11703  in wstring directory,
11704  in wstring filter,
11705  in unsigned long flags,
11706  in wstring userName,
11707  in wstring password,
11708  [retval] out unsigned long handle
11709  );
11710 
11740  void directoryRead (
11741  in unsigned long handle,
11742  [retval] out IGuestDirEntry entry
11743  );
11744 
11780  void fileExists (
11781  in wstring file,
11782  in wstring userName,
11783  in wstring password,
11784  [retval] out boolean exists
11785  );
11786 
11818  void fileQuerySize (
11819  in wstring file,
11820  in wstring userName,
11821  in wstring password,
11822  [retval] out long long size
11823  );
11824 
11858  void setProcessInput (
11859  in unsigned long pid,
11860  in unsigned long flags,
11861  in unsigned long timeoutMS,
11862  in octet[] data,
11863  [retval] out unsigned long written
11864  );
11865 
11889  void updateGuestAdditions (
11890  in wstring source,
11891  in unsigned long flags,
11892  [retval] out IProgress progress
11893  );
11894 
11895 }; /* interface IGuest */
11896 
11937 interface IProgress : $unknown
11938 {
11942  readonly attribute wstringUUID id;
11943 
11947  readonly attribute wstring description;
11948 
11952  readonly attribute $unknown initiator;
11953 
11957  readonly attribute boolean cancelable;
11958 
11966  readonly attribute unsigned long percent;
11967 
11981  readonly attribute long timeRemaining;
11982 
11986  readonly attribute boolean completed;
11987 
11991  readonly attribute boolean canceled;
11992 
11999  readonly attribute long resultCode;
12000 
12010  readonly attribute IVirtualBoxErrorInfo errorInfo;
12011 
12018  readonly attribute unsigned long operationCount;
12019 
12023  readonly attribute unsigned long operation;
12024 
12030  readonly attribute wstring operationDescription;
12031 
12035  readonly attribute unsigned long operationPercent;
12036 
12040  readonly attribute unsigned long operationWeight;
12041 
12049  attribute unsigned long timeout;
12050 
12055  in unsigned long percent
12056  );
12057 
12061  void setNextOperation (
12062  in wstring nextOperationDescription,
12063  in unsigned long nextOperationsWeight
12064  );
12065 
12092  void waitForCompletion (
12093  in long timeout
12094  );
12095 
12120  in unsigned long operation,
12121  in long timeout
12122  );
12123 
12150  in IProgress pProgressAsync
12151  );
12152 
12169  void cancel();
12170 
12171 }; /* interface IProgress */
12172 
12256 interface ISnapshot : $unknown
12257 {
12261  readonly attribute wstringUUID id;
12262 
12270  attribute wstring name;
12271 
12279  attribute wstring description;
12280 
12286  readonly attribute long long timeStamp;
12287 
12299  readonly attribute boolean online;
12300 
12312  readonly attribute IMachine machine;
12313 
12320  readonly attribute ISnapshot parent;
12321 
12330  readonly attribute ISnapshot[] children;
12331 
12339  void getChildrenCount (
12340  [retval] out unsigned long childrenCount
12341  );
12342 
12343 }; /* interface ISnapshot */
12344 
12531 interface IMediumAttachment : $unknown
12532 {
12537  readonly attribute IMedium medium;
12538 
12544  readonly attribute wstring controller;
12545 
12551  readonly attribute long port;
12552 
12558  readonly attribute long device;
12559 
12563  readonly attribute DeviceType type;
12564 
12568  readonly attribute boolean passthrough;
12569 
12573  readonly attribute boolean temporaryEject;
12574 
12579  readonly attribute boolean isEjected;
12580 
12584  readonly attribute boolean nonRotational;
12585 
12589  readonly attribute IBandwidthGroup bandwidthGroup;
12590 
12591 }; /* interface IMediumAttachment */
12592 
12750 interface IMedium : $unknown
12751 {
12765  readonly attribute wstringUUID id;
12766 
12785  attribute wstring description;
12786 
12802  readonly attribute MediumState state;
12803 
12812  readonly attribute unsigned long variant;
12813 
12835  attribute wstring location;
12836 
12856  readonly attribute wstring name;
12857 
12862  readonly attribute DeviceType deviceType;
12863 
12867  readonly attribute boolean hostDrive;
12868 
12881  readonly attribute long long size;
12882 
12897  readonly attribute wstring format;
12898 
12914  readonly attribute IMediumFormat mediumFormat;
12915 
12940  attribute MediumType type;
12941 
12955  readonly attribute MediumType[] allowedTypes;
12956 
12966  readonly attribute IMedium parent;
12967 
12975  readonly attribute IMedium[] children;
12976 
12987  readonly attribute IMedium base;
12988 
13021  readonly attribute boolean readOnly;
13022 
13043  readonly attribute long long logicalSize;
13044 
13072  attribute boolean autoReset;
13073 
13088  readonly attribute wstring lastAccessError;
13089 
13106  readonly attribute wstringUUID[] machineIds;
13107 
13133  void setIDs (
13134  in boolean setImageId,
13135  in wstringUUID imageId,
13136  in boolean setParentId,
13137  in wstringUUID parentId
13138  );
13139 
13174  void refreshState (
13175  [retval] out MediumState state
13176  );
13177 
13204  void getSnapshotIds (
13205  in wstringUUID machineId,
13206  [retval] out wstringUUID[] snapshotIds
13207  );
13208 
13268  void lockRead (
13269  [retval] out MediumState state
13270  );
13271 
13294  void unlockRead (
13295  [retval] out MediumState state
13296  );
13297 
13352  void lockWrite (
13353  [retval] out MediumState state
13354  );
13355 
13378  void unlockWrite (
13379  [retval] out MediumState state
13380  );
13381 
13431  void close();
13432 
13462  void getProperty (
13463  in wstring name,
13464  [retval] out wstring value
13465  );
13466 
13498  void setProperty (
13499  in wstring name,
13500  in wstring value
13501  );
13502 
13537  void getProperties (
13538  in wstring names,
13539  out wstring[] returnNames,
13540  [retval] out wstring[] returnValues
13541  );
13542 
13572  void setProperties (
13573  in wstring[] names,
13574  in wstring[] values
13575  );
13576 
13609  void createBaseStorage (
13610  in long long logicalSize,
13611  in unsigned long variant,
13612  [retval] out IProgress progress
13613  );
13614 
13666  void deleteStorage (
13667  [retval] out IProgress progress
13668  );
13669 
13708  void createDiffStorage (
13709  in IMedium target,
13710  in unsigned long variant,
13711  [retval] out IProgress progress
13712  );
13713 
13789  void mergeTo (
13790  in IMedium target,
13791  [retval] out IProgress progress
13792  );
13793 
13843  void cloneTo (
13844  in IMedium target,
13845  in unsigned long variant,
13846  in IMedium parent,
13847  [retval] out IProgress progress
13848  );
13849 
13878  void compact (
13879  [retval] out IProgress progress
13880  );
13881 
13914  void resize (
13915  in long long logicalSize,
13916  [retval] out IProgress progress
13917  );
13918 
13952  void reset (
13953  [retval] out IProgress progress
13954  );
13955 
13956 }; /* interface IMedium */
13957 
13980 interface IMediumFormat : $unknown
13981 {
14000  readonly attribute wstring id;
14001 
14009  readonly attribute wstring name;
14010 
14019  readonly attribute unsigned long capabilities;
14020 
14039  void describeFileExtensions (
14040  out wstring[] extensions,
14041  out DeviceType[] type
14042  );
14043 
14071  void describeProperties (
14072  out wstring[] names,
14073  out wstring[] description,
14074  out DataType[] types,
14075  out unsigned long[] flags,
14076  out wstring[] defaults
14077  );
14078 
14079 }; /* interface IMediumFormat */
14080 
14093 interface IKeyboard : $unknown
14094 {
14100  readonly attribute IEventSource eventSource;
14101 
14114  void putScancode (
14115  in long scancode
14116  );
14117 
14130  void putScancodes (
14131  in long[] scancodes,
14132  [retval] out unsigned long codesStored
14133  );
14134 
14149  void putCAD();
14150 
14151 }; /* interface IKeyboard */
14152 
14164 interface IMouse : $unknown
14165 {
14180  readonly attribute boolean absoluteSupported;
14181 
14196  readonly attribute boolean relativeSupported;
14197 
14212  readonly attribute boolean needsHostCursor;
14213 
14219  readonly attribute IEventSource eventSource;
14220 
14286  void putMouseEvent (
14287  in long dx,
14288  in long dy,
14289  in long dz,
14290  in long dw,
14291  in long buttonState
14292  );
14293 
14366  void putMouseEventAbsolute (
14367  in long x,
14368  in long y,
14369  in long dz,
14370  in long dw,
14371  in long buttonState
14372  );
14373 
14374 }; /* interface IMouse */
14375 
14376 interface IFramebuffer : $unknown
14377 {
14386  readonly attribute octetPtr address;
14387 
14391  readonly attribute unsigned long width;
14392 
14396  readonly attribute unsigned long height;
14397 
14404  readonly attribute unsigned long bitsPerPixel;
14405 
14412  readonly attribute unsigned long bytesPerLine;
14413 
14424  readonly attribute unsigned long pixelFormat;
14425 
14432  readonly attribute boolean usesGuestVRAM;
14433 
14443  readonly attribute unsigned long heightReduction;
14444 
14459  readonly attribute IFramebufferOverlay overlay;
14460 
14467  readonly attribute long long winId;
14468 
14476  void lock();
14477 
14485  void unlock();
14486 
14494  void notifyUpdate (
14495  in unsigned long x,
14496  in unsigned long y,
14497  in unsigned long width,
14498  in unsigned long height
14499  );
14500 
14613  void requestResize (
14614  in unsigned long screenId,
14615  in unsigned long pixelFormat,
14616  in octetPtr VRAM,
14617  in unsigned long bitsPerPixel,
14618  in unsigned long bytesPerLine,
14619  in unsigned long width,
14620  in unsigned long height,
14621  [retval] out boolean finished
14622  );
14623 
14635  void videoModeSupported (
14636  in unsigned long width,
14637  in unsigned long height,
14638  in unsigned long bpp,
14639  [retval] out boolean supported
14640  );
14641 
14678  void getVisibleRegion (
14679  in octetPtr rectangles,
14680  in unsigned long count,
14681  [retval] out unsigned long countCopied
14682  );
14683 
14718  void setVisibleRegion (
14719  in octetPtr rectangles,
14720  in unsigned long count
14721  );
14722 
14743  void processVHWACommand (
14744  in octetPtr command
14745  );
14746 
14747 }; /* interface IFramebuffer */
14748 
14764 {
14768  readonly attribute unsigned long x;
14769 
14773  readonly attribute unsigned long y;
14774 
14780  attribute boolean visible;
14781 
14788  attribute unsigned long alpha;
14789 
14795  void move (
14796  in unsigned long x,
14797  in unsigned long y
14798  );
14799 
14800 }; /* interface IFramebufferOverlay */
14801 
14817 interface IDisplay : $unknown
14818 {
14822  void getScreenResolution (
14823  in unsigned long screenId,
14824  out unsigned long width,
14825  out unsigned long height,
14826  out unsigned long bitsPerPixel
14827  );
14828 
14834  void setFramebuffer (
14835  in unsigned long screenId,
14836  in IFramebuffer framebuffer
14837  );
14838 
14844  void getFramebuffer (
14845  in unsigned long screenId,
14846  out IFramebuffer framebuffer,
14847  out long xOrigin,
14848  out long yOrigin
14849  );
14850 
14879  void setVideoModeHint (
14880  in unsigned long width,
14881  in unsigned long height,
14882  in unsigned long bitsPerPixel,
14883  in unsigned long display
14884  );
14885 
14897  void setSeamlessMode (
14898  in boolean enabled
14899  );
14900 
14936  void takeScreenShot (
14937  in unsigned long screenId,
14938  in octetPtr address,
14939  in unsigned long width,
14940  in unsigned long height
14941  );
14942 
14986  void takeScreenShotToArray (
14987  in unsigned long screenId,
14988  in unsigned long width,
14989  in unsigned long height,
14990  [retval] out octet[] screenData
14991  );
14992 
15032  in unsigned long screenId,
15033  in unsigned long width,
15034  in unsigned long height,
15035  [retval] out octet[] screenData
15036  );
15037 
15089  void drawToScreen (
15090  in unsigned long screenId,
15091  in octetPtr address,
15092  in unsigned long x,
15093  in unsigned long y,
15094  in unsigned long width,
15095  in unsigned long height
15096  );
15097 
15112  void invalidateAndUpdate();
15113 
15127  void resizeCompleted (
15128  in unsigned long screenId
15129  );
15130 
15143  void completeVHWACommand (
15144  in octetPtr command
15145  );
15146 
15147 }; /* interface IDisplay */
15148 
15164 interface INetworkAdapter : $unknown
15165 {
15174 
15182  readonly attribute unsigned long slot;
15183 
15192  attribute boolean enabled;
15193 
15200  attribute wstring MACAddress;
15201 
15208 
15214  attribute wstring bridgedInterface;
15215 
15221  attribute wstring hostOnlyInterface;
15222 
15228  attribute wstring internalNetwork;
15229 
15235  attribute wstring NATNetwork;
15236 
15242  attribute wstring genericDriver;
15243 
15250  attribute boolean cableConnected;
15251 
15257  attribute unsigned long lineSpeed;
15258 
15266 
15273  attribute boolean traceEnabled;
15274 
15281  attribute wstring traceFile;
15282 
15290  readonly attribute INATEngine natDriver;
15291 
15298  attribute unsigned long bootPriority;
15299 
15304 
15323  void getProperty (
15324  in wstring key,
15325  [retval] out wstring value
15326  );
15327 
15346  void setProperty (
15347  in wstring key,
15348  in wstring value
15349  );
15350 
15378  void getProperties (
15379  in wstring names,
15380  out wstring[] returnNames,
15381  [retval] out wstring[] returnValues
15382  );
15383 
15384 }; /* interface INetworkAdapter */
15385 
15414 interface ISerialPort : $unknown
15415 {
15423  readonly attribute unsigned long slot;
15424 
15431  attribute boolean enabled;
15432 
15436  attribute unsigned long IOBase;
15437 
15441  attribute unsigned long IRQ;
15442 
15453  attribute PortMode hostMode;
15454 
15462  attribute boolean server;
15463 
15473  attribute wstring path;
15474 
15475 }; /* interface ISerialPort */
15476 
15496 interface IParallelPort : $unknown
15497 {
15505  readonly attribute unsigned long slot;
15506 
15513  attribute boolean enabled;
15514 
15518  attribute unsigned long IOBase;
15519 
15523  attribute unsigned long IRQ;
15524 
15532  attribute wstring path;
15533 
15534 }; /* interface IParallelPort */
15535 
15536 interface IMachineDebugger : $unknown
15537 {
15541  attribute boolean singlestep;
15542 
15546  attribute boolean recompileUser;
15547 
15551  attribute boolean recompileSupervisor;
15552 
15556  attribute boolean PATMEnabled;
15557 
15561  attribute boolean CSAMEnabled;
15562 
15566  attribute boolean logEnabled;
15567 
15571  readonly attribute wstring logFlags;
15572 
15576  readonly attribute wstring logGroups;
15577 
15581  readonly attribute wstring logDestinations;
15582 
15589  readonly attribute boolean HWVirtExEnabled;
15590 
15597  readonly attribute boolean HWVirtExNestedPagingEnabled;
15598 
15605  readonly attribute boolean HWVirtExVPIDEnabled;
15606 
15615  readonly attribute wstring OSName;
15616 
15625  readonly attribute wstring OSVersion;
15626 
15633  readonly attribute boolean PAEEnabled;
15634 
15641  attribute unsigned long virtualTimeRate;
15642 
15649  readonly attribute long long VM;
15650 
15666  void dumpGuestCore (
15667  in wstring filename,
15668  in wstring compression
15669  );
15670 
15687  void dumpHostProcessCore (
15688  in wstring filename,
15689  in wstring compression
15690  );
15691 
15712  void info (
15713  in wstring name,
15714  in wstring args,
15715  [retval] out wstring info
15716  );
15717 
15723  void injectNMI();
15724 
15735  void modifyLogGroups (
15736  in wstring settings
15737  );
15738 
15749  void modifyLogFlags (
15750  in wstring settings
15751  );
15752 
15763  void modifyLogDestinations (
15764  in wstring settings
15765  );
15766 
15781  void readPhysicalMemory (
15782  in long long address,
15783  in unsigned long size,
15784  [retval] out octet[] bytes
15785  );
15786 
15801  void writePhysicalMemory (
15802  in long long address,
15803  in unsigned long size,
15804  in octet[] bytes
15805  );
15806 
15823  void readVirtualMemory (
15824  in unsigned long cpuId,
15825  in long long address,
15826  in unsigned long size,
15827  [retval] out octet[] bytes
15828  );
15829 
15846  void writeVirtualMemory (
15847  in unsigned long cpuId,
15848  in long long address,
15849  in unsigned long size,
15850  in octet[] bytes
15851  );
15852 
15865  void detectOS (
15866  [retval] out wstring os
15867  );
15868 
15886  void getRegister (
15887  in unsigned long cpuId,
15888  in wstring name,
15889  [retval] out wstring value
15890  );
15891 
15909  void getRegisters (
15910  in unsigned long cpuId,
15911  out wstring[] names,
15912  out wstring[] values
15913  );
15914 
15933  void setRegister (
15934  in unsigned long cpuId,
15935  in wstring name,
15936  in wstring value
15937  );
15938 
15957  void setRegisters (
15958  in unsigned long cpuId,
15959  in wstring[] names,
15960  in wstring[] values
15961  );
15962 
15975  void dumpGuestStack (
15976  in unsigned long cpuId,
15977  [retval] out wstring stack
15978  );
15979 
15987  void resetStats (
15988  in wstring pattern
15989  );
15990 
15998  void dumpStats (
15999  in wstring pattern
16000  );
16001 
16013  void getStats (
16014  in wstring pattern,
16015  in boolean withDescriptions,
16016  out wstring stats
16017  );
16018 
16019 }; /* interface IMachineDebugger */
16020 
16021 interface IUSBController : $unknown
16022 {
16031  attribute boolean enabled;
16032 
16041  attribute boolean enabledEhci;
16042 
16048  readonly attribute boolean proxyAvailable;
16049 
16057  readonly attribute unsigned short USBStandard;
16058 
16084  readonly attribute IUSBDeviceFilter[] deviceFilters;
16085 
16113  void createDeviceFilter (
16114  in wstring name,
16115  [retval] out IUSBDeviceFilter filter
16116  );
16117 
16162  void insertDeviceFilter (
16163  in unsigned long position,
16164  in IUSBDeviceFilter filter
16165  );
16166 
16199  void removeDeviceFilter (
16200  in unsigned long position,
16201  [retval] out IUSBDeviceFilter filter
16202  );
16203 
16204 }; /* interface IUSBController */
16205 
16218 interface IUSBDevice : $unknown
16219 {
16226  readonly attribute wstringUUID id;
16227 
16231  readonly attribute unsigned short vendorId;
16232 
16236  readonly attribute unsigned short productId;
16237 
16245  readonly attribute unsigned short revision;
16246 
16250  readonly attribute wstring manufacturer;
16251 
16255  readonly attribute wstring product;
16256 
16260  readonly attribute wstring serialNumber;
16261 
16265  readonly attribute wstring address;
16266 
16273  readonly attribute unsigned short port;
16274 
16280  readonly attribute unsigned short version;
16281 
16289  readonly attribute unsigned short portVersion;
16290 
16297  readonly attribute boolean remote;
16298 
16299 }; /* interface IUSBDevice */
16300 
16375 interface IUSBDeviceFilter : $unknown
16376 {
16384  attribute wstring name;
16385 
16389  attribute boolean active;
16390 
16398  attribute wstring vendorId;
16399 
16407  attribute wstring productId;
16408 
16422  attribute wstring revision;
16423 
16428  attribute wstring manufacturer;
16429 
16434  attribute wstring product;
16435 
16440  attribute wstring serialNumber;
16441 
16446  attribute wstring port;
16447 
16457  attribute wstring remote;
16458 
16468  attribute unsigned long maskedInterfaces;
16469 
16470 }; /* interface IUSBDeviceFilter */
16471 
16489 {
16495  readonly attribute USBDeviceState state;
16496 
16497 }; /* interface IHostUSBDevice */
16498 
16522 {
16530 
16531 }; /* interface IHostUSBDeviceFilter */
16532 
16541 interface IAudioAdapter : $unknown
16542 {
16551  attribute boolean enabled;
16552 
16559 
16567 
16568 }; /* interface IAudioAdapter */
16569 
16570 interface IVRDEServer : $unknown
16571 {
16575  attribute boolean enabled;
16576 
16580  attribute AuthType authType;
16581 
16585  attribute unsigned long authTimeout;
16586 
16593  attribute boolean allowMultiConnection;
16594 
16602  attribute boolean reuseSingleConnection;
16603 
16610  attribute wstring VRDEExtPack;
16611 
16618  attribute wstring authLibrary;
16619 
16625  readonly attribute wstring[] VRDEProperties;
16626 
16640  void setVRDEProperty (
16641  in wstring key,
16642  in wstring value
16643  );
16644 
16658  void getVRDEProperty (
16659  in wstring key,
16660  [retval] out wstring value
16661  );
16662 
16663 }; /* interface IVRDEServer */
16664 
16722 interface ISharedFolder : $unknown
16723 {
16727  readonly attribute wstring name;
16728 
16732  readonly attribute wstring hostPath;
16733 
16743  readonly attribute boolean accessible;
16744 
16751  readonly attribute boolean writable;
16752 
16758  readonly attribute boolean autoMount;
16759 
16772  readonly attribute wstring lastAccessError;
16773 
16774 }; /* interface ISharedFolder */
16775 
16776 interface IInternalSessionControl : $unknown
16777 {
16782  void getPID (
16783  [retval] out unsigned long pid
16784  );
16785 
16807  void getRemoteConsole (
16808  [retval] out IConsole console
16809  );
16810 
16834  void assignMachine (
16835  in IMachine machine
16836  );
16837 
16852  void assignRemoteMachine (
16853  in IMachine machine,
16854  in IConsole console
16855  );
16856 
16880  void updateMachineState (
16881  in MachineState aMachineState
16882  );
16883 
16899  void uninitialize();
16900 
16923  void onNetworkAdapterChange (
16924  in INetworkAdapter networkAdapter,
16925  in boolean changeAdapter
16926  );
16927 
16950  void onSerialPortChange (
16951  in ISerialPort serialPort
16952  );
16953 
16976  void onParallelPortChange (
16977  in IParallelPort parallelPort
16978  );
16979 
17003 
17030  void onMediumChange (
17031  in IMediumAttachment mediumAttachment,
17032  in boolean force
17033  );
17034 
17061  void onStorageDeviceChange (
17062  in IMediumAttachment mediumAttachment,
17063  in boolean remove
17064  );
17065 
17075  void onCPUChange (
17076  in unsigned long cpu,
17077  in boolean add
17078  );
17079 
17088  in unsigned long executionCap
17089  );
17090 
17115  void onVRDEServerChange (
17116  in boolean restart
17117  );
17118 
17141  void onUSBControllerChange();
17142 
17171  void onSharedFolderChange (
17172  in boolean global
17173  );
17174 
17200  void onUSBDeviceAttach (
17201  in IUSBDevice device,
17202  in IVirtualBoxErrorInfo error,
17203  in unsigned long maskedInterfaces
17204  );
17205 
17231  void onUSBDeviceDetach (
17232  in wstringUUID id,
17233  in IVirtualBoxErrorInfo error
17234  );
17235 
17253  void onShowWindow (
17254  in boolean check,
17255  out boolean canShow,
17256  out long long winId
17257  );
17258 
17266  void onBandwidthGroupChange (
17267  in IBandwidthGroup bandwidthGroup
17268  );
17269 
17293  void accessGuestProperty (
17294  in wstring name,
17295  in wstring value,
17296  in wstring flags,
17297  in boolean isSetter,
17298  out wstring retValue,
17299  out long long retTimestamp,
17300  out wstring retFlags
17301  );
17302 
17351  in wstring patterns,
17352  out wstring[] key,
17353  out wstring[] value,
17354  out long long[] timestamp,
17355  out wstring[] flags
17356  );
17357 
17403  void onlineMergeMedium (
17404  in IMediumAttachment mediumAttachment,
17405  in unsigned long sourceIdx,
17406  in unsigned long targetIdx,
17407  in IMedium source,
17408  in IMedium target,
17409  in boolean mergeForward,
17410  in IMedium parentForTarget,
17411  in IMedium[] childrenToReparent,
17412  in IProgress progress
17413  );
17414 
17438  void enableVMMStatistics (
17439  in boolean enable
17440  );
17441 
17442 }; /* interface IInternalSessionControl */
17443 
17502 interface ISession : $unknown
17503 {
17507  readonly attribute SessionState state;
17508 
17516  readonly attribute SessionType type;
17517 
17521  readonly attribute IMachine machine;
17522 
17526  readonly attribute IConsole console;
17527 
17559  void unlockMachine();
17560 
17561 }; /* interface ISession */
17562 
17585 interface IStorageController : $unknown
17586 {
17595  readonly attribute wstring name;
17596 
17602  readonly attribute unsigned long maxDevicesPerPortCount;
17603 
17609  readonly attribute unsigned long minPortCount;
17610 
17616  readonly attribute unsigned long maxPortCount;
17617 
17623  attribute unsigned long instance;
17624 
17633  attribute unsigned long portCount;
17634 
17640  readonly attribute StorageBus bus;
17641 
17655 
17670  attribute boolean useHostIOCache;
17671 
17677  readonly attribute boolean bootable;
17678 
17701  void getIDEEmulationPort (
17702  in long devicePosition,
17703  [retval] out long portNumber
17704  );
17705 
17729  void setIDEEmulationPort (
17730  in long devicePosition,
17731  in long portNumber
17732  );
17733 
17734 }; /* interface IStorageController */
17735 
17759 interface IManagedObjectRef : $unknown
17760 {
17767  void getInterfaceName (
17768  [retval] out wstring return
17769  );
17770 
17778  void release();
17779 
17780 }; /* interface IManagedObjectRef */
17781 
17790 interface IWebsessionManager : $unknown
17791 {
17800  void logon (
17801  in wstring username,
17802  in wstring password,
17803  [retval] out IVirtualBox return
17804  );
17805 
17815  void getSessionObject (
17816  in IVirtualBox refIVirtualBox,
17817  [retval] out ISession return
17818  );
17819 
17827  void logoff (
17828  in IVirtualBox refIVirtualBox
17829  );
17830 
17831 }; /* interface IWebsessionManager */
17832 
17841 interface IPerformanceMetric : $unknown
17842 {
17848  readonly attribute wstring metricName;
17849 
17855  readonly attribute $unknown object;
17856 
17862  readonly attribute wstring description;
17863 
17869  readonly attribute unsigned long period;
17870 
17880  readonly attribute unsigned long count;
17881 
17887  readonly attribute wstring unit;
17888 
17894  readonly attribute long minimumValue;
17895 
17901  readonly attribute long maximumValue;
17902 
17903 }; /* interface IPerformanceMetric */
17904 
18011 interface IPerformanceCollector : $unknown
18012 {
18023  readonly attribute wstring[] metricNames;
18024 
18048  void getMetrics (
18049  in wstring[] metricNames,
18050  in $unknown[] objects,
18051  [retval] out IPerformanceMetric[] metrics
18052  );
18053 
18092  void setupMetrics (
18093  in wstring[] metricNames,
18094  in $unknown[] objects,
18095  in unsigned long period,
18096  in unsigned long count,
18097  [retval] out IPerformanceMetric[] affectedMetrics
18098  );
18099 
18128  void enableMetrics (
18129  in wstring[] metricNames,
18130  in $unknown[] objects,
18131  [retval] out IPerformanceMetric[] affectedMetrics
18132  );
18133 
18162  void disableMetrics (
18163  in wstring[] metricNames,
18164  in $unknown[] objects,
18165  [retval] out IPerformanceMetric[] affectedMetrics
18166  );
18167 
18256  void queryMetricsData (
18257  in wstring[] metricNames,
18258  in $unknown[] objects,
18259  out wstring[] returnMetricNames,
18260  out $unknown[] returnObjects,
18261  out wstring[] returnUnits,
18262  out unsigned long[] returnScales,
18263  out unsigned long[] returnSequenceNumbers,
18264  out unsigned long[] returnDataIndices,
18265  out unsigned long[] returnDataLengths,
18266  [retval] out long[] returnData
18267  );
18268 
18269 }; /* interface IPerformanceCollector */
18270 
18278 interface INATEngine : $unknown
18279 {
18284  attribute wstring network;
18285 
18292  attribute wstring hostIP;
18293 
18298  attribute wstring tftpPrefix;
18299 
18304  attribute wstring tftpBootFile;
18305 
18313  attribute wstring tftpNextServer;
18314 
18318  attribute unsigned long aliasMode;
18319 
18323  attribute boolean dnsPassDomain;
18324 
18329  attribute boolean dnsProxy;
18330 
18335  attribute boolean dnsUseHostResolver;
18336 
18341  readonly attribute wstring[] redirects;
18342 
18358  void setNetworkSettings (
18359  in unsigned long mtu,
18360  in unsigned long sockSnd,
18361  in unsigned long sockRcv,
18362  in unsigned long TcpWndSnd,
18363  in unsigned long TcpWndRcv
18364  );
18365 
18370  void getNetworkSettings (
18371  out unsigned long mtu,
18372  out unsigned long sockSnd,
18373  out unsigned long sockRcv,
18374  out unsigned long TcpWndSnd,
18375  out unsigned long TcpWndRcv
18376  );
18377 
18397  void addRedirect (
18398  in wstring name,
18399  in NATProtocol proto,
18400  in wstring hostIp,
18401  in unsigned short hostPort,
18402  in wstring guestIp,
18403  in unsigned short guestPort
18404  );
18405 
18411  void removeRedirect (
18412  in wstring name
18413  );
18414 
18415 }; /* interface INATEngine */
18416 
18425 interface IExtPackPlugIn : $unknown
18426 {
18430  readonly attribute wstring name;
18431 
18435  readonly attribute wstring description;
18436 
18442  readonly attribute wstring frontend;
18443 
18447  readonly attribute wstring modulePath;
18448 
18449 }; /* interface IExtPackPlugIn */
18450 
18459 interface IExtPackBase : $unknown
18460 {
18464  readonly attribute wstring name;
18465 
18469  readonly attribute wstring description;
18470 
18479  readonly attribute wstring version;
18480 
18484  readonly attribute unsigned long revision;
18485 
18489  readonly attribute wstring VRDEModule;
18490 
18494  readonly attribute IExtPackPlugIn[] plugIns;
18495 
18505  readonly attribute boolean usable;
18506 
18513  readonly attribute wstring whyUnusable;
18514 
18518  readonly attribute boolean showLicense;
18519 
18528  readonly attribute wstring license;
18529 
18553  void queryLicense (
18554  in wstring preferredLocale,
18555  in wstring preferredLanguage,
18556  in wstring format,
18557  [retval] out wstring licenseText
18558  );
18559 
18560 }; /* interface IExtPackBase */
18561 
18571 {
18583  void queryObject (
18584  in wstring objUuid,
18585  [retval] out $unknown returnInterface
18586  );
18587 
18588 }; /* interface IExtPack */
18589 
18600 {
18606  readonly attribute wstring filePath;
18607 
18626  void install (
18627  in boolean replace,
18628  in wstring displayInfo,
18629  [retval] out IProgress progess
18630  );
18631 
18632 }; /* interface IExtPackFile */
18633 
18644 interface IExtPackManager : $unknown
18645 {
18651  readonly attribute IExtPack[] installedExtPacks;
18652 
18670  void find (
18671  in wstring name,
18672  [retval] out IExtPack returnData
18673  );
18674 
18686  void openExtPackFile (
18687  in wstring path,
18688  [retval] out IExtPackFile file
18689  );
18690 
18709  void uninstall (
18710  in wstring name,
18711  in boolean forcedRemoval,
18712  in wstring displayInfo,
18713  [retval] out IProgress progess
18714  );
18715 
18719  void cleanup();
18720 
18734  in wstring frontendName,
18735  [retval] out wstring[] plugInModules
18736  );
18737 
18745  void isExtPackUsable (
18746  in wstring name,
18747  [retval] out boolean usable
18748  );
18749 
18750 }; /* interface IExtPackManager */
18751 
18757 interface IBandwidthGroup : $unknown
18758 {
18762  readonly attribute wstring name;
18763 
18767  readonly attribute BandwidthGroupType type;
18768 
18772  readonly attribute unsigned long reference;
18773 
18778  attribute unsigned long maxMbPerSec;
18779 
18780 }; /* interface IBandwidthGroup */
18781 
18790 interface IBandwidthControl : $unknown
18791 {
18797  readonly attribute unsigned long numGroups;
18798 
18811  void createBandwidthGroup (
18812  in wstring name,
18813  in BandwidthGroupType type,
18814  in unsigned long maxMbPerSec
18815  );
18816 
18824  void deleteBandwidthGroup (
18825  in wstring name
18826  );
18827 
18837  void getBandwidthGroup (
18838  in wstring name,
18839  [retval] out IBandwidthGroup bandwidthGroup
18840  );
18841 
18849  void getAllBandwidthGroups (
18850  [retval] out IBandwidthGroup[] bandwidthGroups
18851  );
18852 
18853 }; /* interface IBandwidthControl */
18854 
18867 interface IVirtualBoxClient : $unknown
18868 {
18874  readonly attribute IVirtualBox virtualBox;
18875 
18881  readonly attribute ISession session;
18882 
18888  readonly attribute IEventSource eventSource;
18889 
18890 }; /* interface IVirtualBoxClient */
18891 
18905 interface IEventSource : $unknown
18906 {
18912  void createListener (
18913  [retval] out IEventListener listener
18914  );
18915 
18931  void createAggregator (
18932  in IEventSource[] subordinates,
18933  [retval] out IEventSource result
18934  );
18935 
18968  void registerListener (
18969  in IEventListener listener,
18970  in VBoxEventType[] interesting,
18971  in boolean active
18972  );
18973 
18982  void unregisterListener (
18983  in IEventListener listener
18984  );
18985 
19000  void fireEvent (
19001  in IEvent event,
19002  in long timeout,
19003  [retval] out boolean result
19004  );
19005 
19030  void getEvent (
19031  in IEventListener listener,
19032  in long timeout,
19033  [retval] out IEvent event
19034  );
19035 
19047  void eventProcessed (
19048  in IEventListener listener,
19049  in IEvent event
19050  );
19051 
19052 }; /* interface IEventSource */
19053 
19063 interface IEventListener : $unknown
19064 {
19077  void handleEvent (
19078  in IEvent event
19079  );
19080 
19081 }; /* interface IEventListener */
19082 
19159 interface IEvent : $unknown
19160 {
19166  readonly attribute VBoxEventType type;
19167 
19173  readonly attribute IEventSource source;
19174 
19185  readonly attribute boolean waitable;
19186 
19193  void setProcessed();
19194 
19208  void waitProcessed (
19209  in long timeout,
19210  [retval] out boolean result
19211  );
19212 
19213 }; /* interface IEvent */
19214 
19221 {
19225  readonly attribute unsigned long generation;
19226 
19233  void reuse();
19234 
19235 }; /* interface IReusableEvent */
19236 
19243 {
19247  readonly attribute wstringUUID machineId;
19248 
19249 }; /* interface IMachineEvent */
19250 
19257 {
19261  readonly attribute MachineState state;
19262 
19263 }; /* interface IMachineStateChangedEvent */
19264 
19273 {
19280  readonly attribute boolean temporary;
19281 
19282 }; /* interface IMachineDataChangedEvent */
19283 
19293 {
19297  readonly attribute wstringUUID mediumId;
19298 
19302  readonly attribute DeviceType mediumType;
19303 
19310  readonly attribute boolean registered;
19311 
19312 }; /* interface IMediumRegisteredEvent */
19313 
19323 {
19330  readonly attribute boolean registered;
19331 
19332 }; /* interface IMachineRegisteredEvent */
19333 
19344 {
19350  readonly attribute SessionState state;
19351 
19352 }; /* interface ISessionStateChangedEvent */
19353 
19362 {
19368  readonly attribute wstring name;
19369 
19375  readonly attribute wstring value;
19376 
19382  readonly attribute wstring flags;
19383 
19384 }; /* interface IGuestPropertyChangedEvent */
19385 
19392 {
19396  readonly attribute wstringUUID snapshotId;
19397 
19398 }; /* interface ISnapshotEvent */
19399 
19410 {
19411 }; /* interface ISnapshotTakenEvent */
19412 
19430 {
19431 }; /* interface ISnapshotDeletedEvent */
19432 
19443 {
19444 }; /* interface ISnapshotChangedEvent */
19445 
19455 {
19461  readonly attribute boolean visible;
19462 
19468  readonly attribute boolean alpha;
19469 
19475  readonly attribute unsigned long xhot;
19476 
19482  readonly attribute unsigned long yhot;
19483 
19489  readonly attribute unsigned long width;
19490 
19496  readonly attribute unsigned long height;
19497 
19530  readonly attribute octet[] shape;
19531 
19532 }; /* interface IMousePointerShapeChangedEvent */
19533 
19543 {
19549  readonly attribute boolean supportsAbsolute;
19550 
19556  readonly attribute boolean supportsRelative;
19557 
19563  readonly attribute boolean needsHostCursor;
19564 
19565 }; /* interface IMouseCapabilityChangedEvent */
19566 
19576 {
19582  readonly attribute boolean numLock;
19583 
19589  readonly attribute boolean capsLock;
19590 
19596  readonly attribute boolean scrollLock;
19597 
19598 }; /* interface IKeyboardLedsChangedEvent */
19599 
19609 {
19615  readonly attribute MachineState state;
19616 
19617 }; /* interface IStateChangedEvent */
19618 
19629 {
19630 }; /* interface IAdditionsStateChangedEvent */
19631 
19643 {
19649  readonly attribute INetworkAdapter networkAdapter;
19650 
19651 }; /* interface INetworkAdapterChangedEvent */
19652 
19664 {
19670  readonly attribute ISerialPort serialPort;
19671 
19672 }; /* interface ISerialPortChangedEvent */
19673 
19685 {
19691  readonly attribute IParallelPort parallelPort;
19692 
19693 }; /* interface IParallelPortChangedEvent */
19694 
19705 {
19706 }; /* interface IStorageControllerChangedEvent */
19707 
19718 {
19725 
19726 }; /* interface IMediumChangedEvent */
19727 
19736 {
19742  readonly attribute unsigned long cpu;
19743 
19749  readonly attribute boolean add;
19750 
19751 }; /* interface ICPUChangedEvent */
19752 
19761 {
19767  readonly attribute unsigned long executionCap;
19768 
19769 }; /* interface ICPUExecutionCapChangedEvent */
19770 
19779 {
19785  readonly attribute long[] scancodes;
19786 
19787 }; /* interface IGuestKeyboardEvent */
19788 
19797 {
19803  readonly attribute boolean absolute;
19804 
19810  readonly attribute long x;
19811 
19817  readonly attribute long y;
19818 
19824  readonly attribute long z;
19825 
19831  readonly attribute long w;
19832 
19838  readonly attribute long buttons;
19839 
19840 }; /* interface IGuestMouseEvent */
19841 
19853 {
19854 }; /* interface IVRDEServerChangedEvent */
19855 
19866 {
19867 }; /* interface IVRDEServerInfoChangedEvent */
19868 
19880 {
19881 }; /* interface IUSBControllerChangedEvent */
19882 
19907 {
19913  readonly attribute IUSBDevice device;
19914 
19920  readonly attribute boolean attached;
19921 
19927  readonly attribute IVirtualBoxErrorInfo error;
19928 
19929 }; /* interface IUSBDeviceStateChangedEvent */
19930 
19947 {
19953  readonly attribute Scope scope;
19954 
19955 }; /* interface ISharedFolderChangedEvent */
19956 
20009 {
20015  readonly attribute boolean fatal;
20016 
20022  readonly attribute wstring id;
20023 
20029  readonly attribute wstring message;
20030 
20031 }; /* interface IRuntimeErrorEvent */
20032 
20041 {
20047  readonly attribute IEventListener listener;
20048 
20054  readonly attribute boolean add;
20055 
20056 }; /* interface IEventSourceChangedEvent */
20057 
20067 {
20074  readonly attribute wstringUUID machineId;
20075 
20081  readonly attribute wstring key;
20082 
20088  readonly attribute wstring value;
20089 
20090 }; /* interface IExtraDataChangedEvent */
20091 
20097 interface IVetoEvent : IEvent
20098 {
20108  void addVeto (
20109  in wstring reason
20110  );
20111 
20121  void isVetoed (
20122  [retval] out boolean result
20123  );
20124 
20134  void getVetos (
20135  [retval] out wstring[] result
20136  );
20137 
20138 }; /* interface IVetoEvent */
20139 
20150 {
20157  readonly attribute wstringUUID machineId;
20158 
20164  readonly attribute wstring key;
20165 
20171  readonly attribute wstring value;
20172 
20173 }; /* interface IExtraDataCanChangeEvent */
20174 
20191 {
20192 }; /* interface ICanShowWindowEvent */
20193 
20226 {
20235  attribute long long winId;
20236 
20237 }; /* interface IShowWindowEvent */
20238 
20247 {
20253  readonly attribute unsigned long slot;
20254 
20260  readonly attribute boolean remove;
20261 
20267  readonly attribute wstring name;
20268 
20274  readonly attribute NATProtocol proto;
20275 
20281  readonly attribute wstring hostIp;
20282 
20288  readonly attribute long hostPort;
20289 
20295  readonly attribute wstring guestIp;
20296 
20302  readonly attribute long guestPort;
20303 
20304 }; /* interface INATRedirectEvent */
20305 
20319 {
20325  readonly attribute boolean plugged;
20326 
20333  readonly attribute boolean success;
20334 
20340  readonly attribute IPciDeviceAttachment attachment;
20341 
20347  readonly attribute wstring message;
20348 
20349 }; /* interface IHostPciDevicePlugEvent */
20350 
20360 {
20366  readonly attribute boolean available;
20367 
20368 }; /* interface IVBoxSVCAvailabilityChangedEvent */
20369 
20378 {
20384  readonly attribute IBandwidthGroup bandwidthGroup;
20385 
20386 }; /* interface IBandwidthGroupChangedEvent */
20387 
20396 {
20403 
20409  readonly attribute unsigned long screenId;
20410 
20417  readonly attribute unsigned long originX;
20418 
20425  readonly attribute unsigned long originY;
20426 
20433  readonly attribute unsigned long width;
20434 
20441  readonly attribute unsigned long height;
20442 
20443 }; /* interface IGuestMonitorChangedEvent */
20444 
20455 {
20461  readonly attribute IMediumAttachment storageDevice;
20462 
20468  readonly attribute boolean removed;
20469 
20470 }; /* interface IStorageDeviceChangedEvent */
20471 
20472