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 
137 const HRESULT VBOX_E_OBJECT_NOT_FOUND = 0x80BB0001;
145 const HRESULT VBOX_E_INVALID_VM_STATE = 0x80BB0002;
153 const HRESULT VBOX_E_VM_ERROR = 0x80BB0003;
161 const HRESULT VBOX_E_FILE_ERROR = 0x80BB0004;
169 const HRESULT VBOX_E_IPRT_ERROR = 0x80BB0005;
177 const HRESULT VBOX_E_PDM_ERROR = 0x80BB0006;
185 const HRESULT VBOX_E_INVALID_OBJECT_STATE = 0x80BB0007;
193 const HRESULT VBOX_E_HOST_ERROR = 0x80BB0008;
201 const HRESULT VBOX_E_NOT_SUPPORTED = 0x80BB0009;
209 const HRESULT VBOX_E_XML_ERROR = 0x80BB000A;
217 const HRESULT VBOX_E_INVALID_SESSION_STATE = 0x80BB000B;
225 const HRESULT VBOX_E_OBJECT_IN_USE = 0x80BB000C;
233 const HRESULT VBOX_E_PASSWORD_INCORRECT = 0x80BB000D;
244 {
345 };
346 
355 {
358 };
359 
473 {
693 };
694 
705 {
753 };
754 
764 {
813 };
814 
825 {
875 };
876 
886 {
918 };
919 
928 {
944 };
945 
954 {
982 };
983 
993 {
1021 };
1022 
1031 {
1075 };
1076 
1085 {
1090 };
1091 
1100 {
1105 };
1106 
1115 {
1120 };
1121 
1132 enum Scope
1133 {
1137 };
1138 
1147 {
1151 };
1152 
1162 {
1166 };
1167 
1176 {
1181 };
1182 
1191 {
1217 };
1218 
1227 {
1266 };
1267 
1276 {
1298 };
1299 
1309 {
1333  BitmapFormat_BGR = 0x20524742,
1340  BitmapFormat_BGR0 = 0x30524742,
1347  BitmapFormat_BGRA = 0x41524742,
1354  BitmapFormat_RGBA = 0x41424752,
1361  BitmapFormat_PNG = 0x20474E50,
1368  BitmapFormat_JPEG = 0x4745504A,
1369 };
1370 
1372 {
1436 };
1437 
1439 {
1442 };
1443 
1452 {
1457 };
1458 
1467 {
1483 };
1484 
1493 {
1522 };
1523 
1532 {
1537 };
1538 
1546 {
1575 };
1576 
1584 {
1589 };
1590 
1598 {
1614 };
1615 
1623 {
1644 };
1645 
1654 {
1670 };
1671 
1680 {
1701 };
1702 
1711 {
1732 };
1733 
1745 {
1774 };
1775 
1786 {
1808 };
1809 
1818 {
1821 };
1822 
1831 {
1875 };
1876 
1885 {
1921 };
1922 
1931 {
1977 };
1978 
1987 {
2008 };
2009 
2018 {
2032 };
2033 
2043 {
2089 };
2090 
2099 {
2120 };
2121 
2136 {
2182 };
2183 
2192 {
2342 };
2343 
2352 {
2369 };
2370 
2379 {
2390 };
2391 
2401 {
2412 };
2413 
2422 {
2453 };
2454 
2474 {
2534 };
2535 
2546 {
2580 };
2581 
2590 {
2621 };
2622 
2631 {
2642 };
2643 
2654 {
2665 };
2666 
2681 {
2697 };
2698 
2708 {
2720 };
2721 
2734 {
2793 };
2794 
2803 {
2814 };
2815 
2825 {
2841 };
2842 
2851 {
2862 };
2863 
2872 {
2933 };
2934 
2943 {
2969 };
2970 
2980 {
3000 };
3001 
3011 {
3045 };
3046 
3056 {
3101 };
3102 
3111 {
3147 };
3148 
3157 {
3163 };
3164 
3173 {
3209 };
3210 
3219 {
3267 };
3268 
3277 {
3298 };
3299 
3308 {
3319 };
3320 
3331 {
3389 };
3390 
3402 {
3457 };
3458 
3469 {
3535 };
3536 
3538 {
3542 };
3543 
3545 {
3551 };
3552 
3561 {
3653 };
3654 
3663 {
3667 };
3668 
3677 {
3686 };
3687 
3696 {
3715 };
3716 
3725 {
3747 };
3748 
3757 {
3779 };
3780 
3789 {
3804 };
3805 
3814 {
3826 };
3827 
3836 {
3872 };
3873 
3882 {
3904 };
3905 
3915 {
3941 };
3942 
3951 {
3965 };
3966 
3987 {
4030 };
4031 
4071 {
4118 };
4119 
4130 {
4146 };
4147 
4156 {
4202 };
4203 
4212 {
4216 };
4217 
4227 {
4253 };
4254 
4263 {
4271 };
4272 
4281 {
4307 };
4308 
4318 {
4331 };
4332 
4342 {
4398 };
4399 
4408 {
4424 };
4425 
4432 {
4448 };
4449 
4456 {
4467 };
4468 
4477 {
4499 };
4500 
4510 {
5031 };
5032 
5046 {
5061 };
5062 
5071 {
5093 };
5094 
5128 interface IVirtualBoxErrorInfo : $errorinfo
5129 {
5147  readonly attribute long resultCode;
5148 
5155  readonly attribute long resultDetail;
5156 
5168  readonly attribute wstringUUID interfaceID;
5169 
5180  readonly attribute wstring component;
5181 
5192  readonly attribute wstring text;
5193 
5204  readonly attribute IVirtualBoxErrorInfo next;
5205 
5206 }; /* interface IVirtualBoxErrorInfo */
5207 
5208 interface INATNetwork : $unknown
5209 {
5218  attribute wstring networkName;
5219 
5220  attribute boolean enabled;
5221 
5230  attribute wstring network;
5231 
5238  readonly attribute wstring gateway;
5239 
5245  attribute boolean IPv6Enabled;
5246 
5254  attribute wstring IPv6Prefix;
5255 
5257 
5258  attribute boolean needDhcpServer;
5259 
5260  readonly attribute IEventSource eventSource;
5261 
5268  readonly attribute wstring[] portForwardRules4;
5269 
5274  readonly attribute wstring[] localMappings;
5275 
5280  attribute long loopbackIp6;
5281 
5287  readonly attribute wstring[] portForwardRules6;
5288 
5292  void addLocalMapping (
5293  in wstring hostid,
5294  in long offset
5295  );
5296 
5297  void addPortForwardRule (
5298  in boolean isIpv6,
5299  in wstring ruleName,
5300  in NATProtocol proto,
5301  in wstring hostIP,
5302  in unsigned short hostPort,
5303  in wstring guestIP,
5304  in unsigned short guestPort
5305  );
5306 
5307  void removePortForwardRule (
5308  in boolean iSipv6,
5309  in wstring ruleName
5310  );
5311 
5312  void start (
5313  in wstring trunkType
5314  );
5315 
5316  void stop();
5317 
5318 }; /* interface INATNetwork */
5319 
5330 interface IDHCPServer : $unknown
5331 {
5332  readonly attribute IEventSource eventSource;
5333 
5339  attribute boolean enabled;
5340 
5346  readonly attribute wstring IPAddress;
5347 
5353  readonly attribute wstring networkMask;
5354 
5360  readonly attribute wstring networkName;
5361 
5367  readonly attribute wstring lowerIP;
5368 
5374  readonly attribute wstring upperIP;
5375 
5376  readonly attribute wstring[] globalOptions;
5377 
5378  readonly attribute wstring[] vmConfigs;
5379 
5380  void addGlobalOption (
5381  in DhcpOpt option,
5382  in wstring value
5383  );
5384 
5385  void addVmSlotOption (
5386  in wstring vmname,
5387  in long slot,
5388  in DhcpOpt option,
5389  in wstring value
5390  );
5391 
5392  void removeVmSlotOptions (
5393  in wstring vmname,
5394  in long slot
5395  );
5396 
5397  void getVmSlotOptions (
5398  in wstring vmname,
5399  in long slot,
5400  [retval] out wstring[] option
5401  );
5402 
5403  void getMacOptions (
5404  in wstring mac,
5405  [retval] out wstring[] option
5406  );
5407 
5436  void setConfiguration (
5437  in wstring IPAddress,
5438  in wstring networkMask,
5439  in wstring FromIPAddress,
5440  in wstring ToIPAddress
5441  );
5442 
5467  void start (
5468  in wstring networkName,
5469  in wstring trunkName,
5470  in wstring trunkType
5471  );
5472 
5485  void stop();
5486 
5487 }; /* interface IDHCPServer */
5488 
5513 interface IVirtualBox : $unknown
5514 {
5527  readonly attribute wstring version;
5528 
5536  readonly attribute wstring versionNormalized;
5537 
5543  readonly attribute unsigned long revision;
5544 
5554  readonly attribute wstring packageType;
5555 
5567  readonly attribute wstring APIVersion;
5568 
5576  readonly attribute long long APIRevision;
5577 
5593  readonly attribute wstring homeFolder;
5594 
5602  readonly attribute wstring settingsFilePath;
5603 
5607  readonly attribute IHost host;
5608 
5613 
5619  readonly attribute IMachine[] machines;
5620 
5630  readonly attribute wstring[] machineGroups;
5631 
5641  readonly attribute IMedium[] hardDisks;
5642 
5648  readonly attribute IMedium[] DVDImages;
5649 
5655  readonly attribute IMedium[] floppyImages;
5656 
5657  readonly attribute IProgress[] progressOperations;
5658 
5659  readonly attribute IGuestOSType[] guestOSTypes;
5660 
5677  readonly attribute ISharedFolder[] sharedFolders;
5678 
5685 
5691  readonly attribute IDHCPServer[] DHCPServers;
5692 
5693  readonly attribute INATNetwork[] NATNetworks;
5694 
5700  readonly attribute IEventSource eventSource;
5701 
5708 
5714  readonly attribute wstring[] internalNetworks;
5715 
5721  readonly attribute wstring[] genericNetworkDrivers;
5722 
5774  void composeMachineFilename (
5775  in wstring name,
5776  in wstring group,
5777  in wstring createFlags,
5778  in wstring baseFolder,
5779  [retval] out wstring file
5780  );
5781 
5889  void createMachine (
5890  in wstring settingsFile,
5891  in wstring name,
5892  in wstring[] groups,
5893  in wstring osTypeId,
5894  in wstring flags,
5895  [retval] out IMachine machine
5896  );
5897 
5928  void openMachine (
5929  in wstring settingsFile,
5930  [retval] out IMachine machine
5931  );
5932 
5964  void registerMachine (
5965  in IMachine machine
5966  );
5967 
5988  void findMachine (
5989  in wstring nameOrId,
5990  [retval] out IMachine machine
5991  );
5992 
6004  void getMachinesByGroups (
6005  in wstring[] groups,
6006  [retval] out IMachine[] machines
6007  );
6008 
6018  void getMachineStates (
6019  in IMachine[] machines,
6020  [retval] out MachineState[] states
6021  );
6022 
6032  void createAppliance (
6033  [retval] out IAppliance appliance
6034  );
6035 
6121  void createMedium (
6122  in wstring format,
6123  in wstring location,
6124  in AccessMode accessMode,
6125  in DeviceType aDeviceTypeType,
6126  [retval] out IMedium medium
6127  );
6128 
6235  void openMedium (
6236  in wstring location,
6237  in DeviceType deviceType,
6238  in AccessMode accessMode,
6239  in boolean forceNewUuid,
6240  [retval] out IMedium medium
6241  );
6242 
6271  void getGuestOSType (
6272  in wstring id,
6273  [retval] out IGuestOSType type
6274  );
6275 
6298  void createSharedFolder (
6299  in wstring name,
6300  in wstring hostPath,
6301  in boolean writable,
6302  in boolean automount
6303  );
6304 
6319  void removeSharedFolder (
6320  in wstring name
6321  );
6322 
6331  void getExtraDataKeys (
6332  [retval] out wstring[] keys
6333  );
6334 
6363  void getExtraData (
6364  in wstring key,
6365  [retval] out wstring value
6366  );
6367 
6417  void setExtraData (
6418  in wstring key,
6419  in wstring value
6420  );
6421 
6440  void setSettingsSecret (
6441  in wstring password
6442  );
6443 
6460  void createDHCPServer (
6461  in wstring name,
6462  [retval] out IDHCPServer server
6463  );
6464 
6482  in wstring name,
6483  [retval] out IDHCPServer server
6484  );
6485 
6500  void removeDHCPServer (
6501  in IDHCPServer server
6502  );
6503 
6504  void createNATNetwork (
6505  in wstring networkName,
6506  [retval] out INATNetwork network
6507  );
6508 
6509  void findNATNetworkByName (
6510  in wstring networkName,
6511  [retval] out INATNetwork network
6512  );
6513 
6514  void removeNATNetwork (
6515  in INATNetwork network
6516  );
6517 
6542  void checkFirmwarePresent (
6543  in FirmwareType firmwareType,
6544  in wstring version,
6545  out wstring url,
6546  out wstring file,
6547  [retval] out boolean result
6548  );
6549 
6550 }; /* interface IVirtualBox */
6551 
6562 interface IVFSExplorer : $unknown
6563 {
6567  readonly attribute wstring path;
6568 
6572  readonly attribute VFSType type;
6573 
6581  void update (
6582  [retval] out IProgress progress
6583  );
6584 
6592  void cd (
6593  in wstring dir,
6594  [retval] out IProgress progress
6595  );
6596 
6602  void cdUp (
6603  [retval] out IProgress progress
6604  );
6605 
6618  void entryList (
6619  out wstring[] names,
6620  out unsigned long[] types,
6621  out long long[] sizes,
6622  out unsigned long[] modes
6623  );
6624 
6633  void exists (
6634  in wstring[] names,
6635  [retval] out wstring[] exists
6636  );
6637 
6645  void remove (
6646  in wstring[] names,
6647  [retval] out IProgress progress
6648  );
6649 
6650 }; /* interface IVFSExplorer */
6651 
6659 interface ICertificate : $unknown
6660 {
6664  readonly attribute CertificateVersion versionNumber;
6665 
6669  readonly attribute wstring serialNumber;
6670 
6674  readonly attribute wstring signatureAlgorithmOID;
6675 
6679  readonly attribute wstring signatureAlgorithmName;
6680 
6687  readonly attribute wstring[] issuerName;
6688 
6692  readonly attribute wstring[] subjectName;
6693 
6697  readonly attribute wstring friendlyName;
6698 
6702  readonly attribute wstring validityPeriodNotBefore;
6703 
6707  readonly attribute wstring validityPeriodNotAfter;
6708 
6712  readonly attribute wstring publicKeyAlgorithmOID;
6713 
6717  readonly attribute wstring publicKeyAlgorithm;
6718 
6722  readonly attribute octet[] subjectPublicKey;
6723 
6727  readonly attribute wstring issuerUniqueIdentifier;
6728 
6732  readonly attribute wstring subjectUniqueIdentifier;
6733 
6739  readonly attribute boolean certificateAuthority;
6740 
6744  readonly attribute unsigned long keyUsage;
6745 
6749  readonly attribute wstring[] extendedKeyUsage;
6750 
6754  readonly attribute octet[] rawCertData;
6755 
6759  readonly attribute boolean selfSigned;
6760 
6764  readonly attribute boolean trusted;
6765 
6769  readonly attribute boolean expired;
6770 
6776  void isCurrentlyExpired (
6777  [retval] out boolean result
6778  );
6779 
6783  void queryInfo (
6784  in long what,
6785  [retval] out wstring result
6786  );
6787 
6788 }; /* interface ICertificate */
6789 
6858 interface IAppliance : $unknown
6859 {
6867  readonly attribute wstring path;
6868 
6900  readonly attribute wstring[] disks;
6901 
6910 
6918  readonly attribute wstring[] machines;
6919 
6926  readonly attribute ICertificate certificate;
6927 
6944  void read (
6945  in wstring file,
6946  [retval] out IProgress progress
6947  );
6948 
6965  void interpret();
6966 
6989  void importMachines (
6990  in ImportOptions[] options,
6991  [retval] out IProgress progress
6992  );
6993 
7001  void createVFSExplorer (
7002  in wstring URI,
7003  [retval] out IVFSExplorer explorer
7004  );
7005 
7032  void write (
7033  in wstring format,
7034  in ExportOptions[] options,
7035  in wstring path,
7036  [retval] out IProgress progress
7037  );
7038 
7044  void getWarnings (
7045  [retval] out wstring[] warnings
7046  );
7047 
7056  void getPasswordIds (
7057  [retval] out wstring[] identifiers
7058  );
7059 
7070  in wstring passwordId,
7071  [retval] out wstringUUID[] identifiers
7072  );
7073 
7084  void addPasswords (
7085  in wstring[] identifiers,
7086  in wstring[] passwords
7087  );
7088 
7089 }; /* interface IAppliance */
7090 
7102 interface IVirtualSystemDescription : $unknown
7103 {
7107  readonly attribute unsigned long count;
7108 
7233  void getDescription (
7234  out VirtualSystemDescriptionType[] types,
7235  out wstring[] refs,
7236  out wstring[] OVFValues,
7237  out wstring[] VBoxValues,
7238  out wstring[] extraConfigValues
7239  );
7240 
7257  void getDescriptionByType (
7259  out VirtualSystemDescriptionType[] types,
7260  out wstring[] refs,
7261  out wstring[] OVFValues,
7262  out wstring[] VBoxValues,
7263  out wstring[] extraConfigValues
7264  );
7265 
7277  void getValuesByType (
7280  [retval] out wstring[] values
7281  );
7282 
7308  void setFinalValues (
7309  in boolean[] enabled,
7310  in wstring[] VBoxValues,
7311  in wstring[] extraConfigValues
7312  );
7313 
7328  void addDescription (
7330  in wstring VBoxValue,
7331  in wstring extraConfigValue
7332  );
7333 
7334 }; /* interface IVirtualSystemDescription */
7335 
7336 interface IInternalMachineControl : $unknown
7337 {
7349  void updateState (
7350  in MachineState state
7351  );
7352 
7364  void beginPowerUp (
7365  in IProgress progress
7366  );
7367 
7377  void endPowerUp (
7378  in long result
7379  );
7380 
7392  void beginPoweringDown (
7393  out IProgress progress
7394  );
7395 
7425  void endPoweringDown (
7426  in long result,
7427  in wstring errMsg
7428  );
7429 
7443  void runUSBDeviceFilters (
7444  in IUSBDevice device,
7445  out boolean matched,
7446  out unsigned long maskedInterfaces
7447  );
7448 
7457  void captureUSBDevice (
7458  in wstringUUID id,
7459  in wstring captureFilename
7460  );
7461 
7477  void detachUSBDevice (
7478  in wstringUUID id,
7479  in boolean done
7480  );
7481 
7490  void autoCaptureUSBDevices();
7491 
7507  void detachAllUSBDevices (
7508  in boolean done
7509  );
7510 
7525  void onSessionEnd (
7526  in ISession session,
7527  [retval] out IProgress progress
7528  );
7529 
7536  void finishOnlineMergeMedium();
7537 
7564  void pullGuestProperties (
7565  out wstring[] names,
7566  out wstring[] values,
7567  out long long[] timestamps,
7568  out wstring[] flags
7569  );
7570 
7592  void pushGuestProperty (
7593  in wstring name,
7594  in wstring value,
7595  in long long timestamp,
7596  in wstring flags
7597  );
7598 
7610  void lockMedia();
7611 
7621  void unlockMedia();
7622 
7638  void ejectMedium (
7639  in IMediumAttachment attachment,
7640  [retval] out IMediumAttachment newAttachment
7641  );
7642 
7683  void reportVmStatistics (
7684  in unsigned long validStats,
7685  in unsigned long cpuUser,
7686  in unsigned long cpuKernel,
7687  in unsigned long cpuIdle,
7688  in unsigned long memTotal,
7689  in unsigned long memFree,
7690  in unsigned long memBalloon,
7691  in unsigned long memShared,
7692  in unsigned long memCache,
7693  in unsigned long pagedTotal,
7694  in unsigned long memAllocTotal,
7695  in unsigned long memFreeTotal,
7696  in unsigned long memBalloonTotal,
7697  in unsigned long memSharedTotal,
7698  in unsigned long vmNetRx,
7699  in unsigned long vmNetTx
7700  );
7701 
7715  void authenticateExternal (
7716  in wstring[] authParams,
7717  out wstring result
7718  );
7719 
7720 }; /* interface IInternalMachineControl */
7721 
7730 interface IBIOSSettings : $unknown
7731 {
7735  attribute boolean logoFadeIn;
7736 
7740  attribute boolean logoFadeOut;
7741 
7745  attribute unsigned long logoDisplayTime;
7746 
7753  attribute wstring logoImagePath;
7754 
7759 
7763  attribute boolean ACPIEnabled;
7764 
7771  attribute boolean IOAPICEnabled;
7772 
7778  attribute APICMode APICMode;
7779 
7789  attribute long long timeOffset;
7790 
7797  attribute boolean PXEDebugEnabled;
7798 
7807  readonly attribute wstring nonVolatileStorageFile;
7808 
7809 }; /* interface IBIOSSettings */
7810 
7818 interface IPCIAddress : $unknown
7819 {
7825  attribute short bus;
7826 
7832  attribute short device;
7833 
7839  attribute short devFunction;
7840 
7846  void asLong (
7847  [retval] out long result
7848  );
7849 
7855  void fromLong (
7856  in long number
7857  );
7858 
7859 }; /* interface IPCIAddress */
7860 
7868 interface IPCIDeviceAttachment : $unknown
7869 {
7875  readonly attribute wstring name;
7876 
7882  readonly attribute boolean isPhysicalDevice;
7883 
7889  readonly attribute long hostAddress;
7890 
7896  readonly attribute long guestAddress;
7897 
7898 }; /* interface IPCIDeviceAttachment */
7899 
7940 interface IMachine : $unknown
7941 {
7945  readonly attribute IVirtualBox parent;
7946 
7950  attribute octet[] icon;
7951 
8002  readonly attribute boolean accessible;
8003 
8015  readonly attribute IVirtualBoxErrorInfo accessError;
8016 
8057  attribute wstring name;
8058 
8069  attribute wstring description;
8070 
8074  readonly attribute wstringUUID id;
8075 
8086  attribute wstring[] groups;
8087 
8102  attribute wstring OSTypeId;
8103 
8107  attribute wstring hardwareVersion;
8108 
8118  attribute wstringUUID hardwareUUID;
8119 
8123  attribute unsigned long CPUCount;
8124 
8130  attribute boolean CPUHotPlugEnabled;
8131 
8139  attribute unsigned long CPUExecutionCap;
8140 
8152  attribute unsigned long CPUIDPortabilityLevel;
8153 
8157  attribute unsigned long memorySize;
8158 
8162  attribute unsigned long memoryBalloonSize;
8163 
8170  attribute boolean pageFusionEnabled;
8171 
8176 
8180  attribute unsigned long VRAMSize;
8181 
8187  attribute boolean accelerate3DEnabled;
8188 
8194  attribute boolean accelerate2DVideoEnabled;
8195 
8206  attribute unsigned long monitorCount;
8207 
8213  attribute boolean videoCaptureEnabled;
8214 
8220  attribute boolean[] videoCaptureScreens;
8221 
8235  attribute wstring videoCaptureFile;
8236 
8244  attribute unsigned long videoCaptureWidth;
8245 
8253  attribute unsigned long videoCaptureHeight;
8254 
8263  attribute unsigned long videoCaptureRate;
8264 
8274  attribute unsigned long videoCaptureFPS;
8275 
8285  attribute unsigned long videoCaptureMaxTime;
8286 
8296  attribute unsigned long videoCaptureMaxFileSize;
8297 
8305  attribute wstring videoCaptureOptions;
8306 
8310  readonly attribute IBIOSSettings BIOSSettings;
8311 
8317 
8324 
8331 
8338  attribute boolean HPETEnabled;
8339 
8344 
8378  attribute wstring snapshotFolder;
8379 
8383  readonly attribute IVRDEServer VRDEServer;
8384 
8385  attribute boolean emulatedUSBCardReaderEnabled;
8386 
8390  readonly attribute IMediumAttachment[] mediumAttachments;
8391 
8403  readonly attribute IUSBController[] USBControllers;
8404 
8417 
8421  readonly attribute IAudioAdapter audioAdapter;
8422 
8427 
8433  readonly attribute wstring settingsFilePath;
8434 
8440  readonly attribute wstring settingsAuxFilePath;
8441 
8466  readonly attribute boolean settingsModified;
8467 
8471  readonly attribute SessionState sessionState;
8472 
8486  readonly attribute wstring sessionName;
8487 
8497  readonly attribute unsigned long sessionPID;
8498 
8502  readonly attribute MachineState state;
8503 
8510  readonly attribute long long lastStateChange;
8511 
8523  readonly attribute wstring stateFilePath;
8524 
8534  readonly attribute wstring logFolder;
8535 
8545  readonly attribute ISnapshot currentSnapshot;
8546 
8553  readonly attribute unsigned long snapshotCount;
8554 
8587  readonly attribute boolean currentStateModified;
8588 
8600  readonly attribute ISharedFolder[] sharedFolders;
8601 
8609 
8615  attribute DnDMode dnDMode;
8616 
8625  attribute boolean teleporterEnabled;
8626 
8637  attribute unsigned long teleporterPort;
8638 
8645  attribute wstring teleporterAddress;
8646 
8657  attribute wstring teleporterPassword;
8658 
8665 
8674 
8681  attribute unsigned long faultTolerancePort;
8682 
8688  attribute wstring faultToleranceAddress;
8689 
8697  attribute wstring faultTolerancePassword;
8698 
8704  attribute unsigned long faultToleranceSyncInterval;
8705 
8713  attribute boolean RTCUseUTC;
8714 
8721  attribute boolean IOCacheEnabled;
8722 
8728  attribute unsigned long IOCacheSize;
8729 
8740 
8747 
8756  attribute boolean tracingEnabled;
8757 
8772  attribute wstring tracingConfig;
8773 
8786  attribute boolean allowTracingToAccessVM;
8787 
8793  attribute boolean autostartEnabled;
8794 
8800  attribute unsigned long autostartDelay;
8801 
8808 
8824  attribute wstring defaultFrontend;
8825 
8831  readonly attribute boolean USBProxyAvailable;
8832 
8853  attribute wstring VMProcessPriority;
8854 
8860  attribute wstring paravirtDebug;
8861 
8871  attribute wstring CPUProfile;
8872 
8980  void lockMachine (
8981  in ISession session,
8982  in LockType lockType
8983  );
8984 
9124  void launchVMProcess (
9125  in ISession session,
9126  in wstring name,
9127  in wstring environment,
9128  [retval] out IProgress progress
9129  );
9130 
9168  void setBootOrder (
9169  in unsigned long position,
9170  in DeviceType device
9171  );
9172 
9207  void getBootOrder (
9208  in unsigned long position,
9209  [retval] out DeviceType device
9210  );
9211 
9314  void attachDevice (
9315  in wstring name,
9316  in long controllerPort,
9317  in long device,
9318  in DeviceType type,
9319  in IMedium medium
9320  );
9321 
9419  in wstring name,
9420  in long controllerPort,
9421  in long device,
9422  in DeviceType type
9423  );
9424 
9478  void detachDevice (
9479  in wstring name,
9480  in long controllerPort,
9481  in long device
9482  );
9483 
9526  void passthroughDevice (
9527  in wstring name,
9528  in long controllerPort,
9529  in long device,
9530  in boolean passthrough
9531  );
9532 
9575  void temporaryEjectDevice (
9576  in wstring name,
9577  in long controllerPort,
9578  in long device,
9579  in boolean temporaryEject
9580  );
9581 
9627  void nonRotationalDevice (
9628  in wstring name,
9629  in long controllerPort,
9630  in long device,
9631  in boolean nonRotational
9632  );
9633 
9680  in wstring name,
9681  in long controllerPort,
9682  in long device,
9683  in boolean discard
9684  );
9685 
9736  in wstring name,
9737  in long controllerPort,
9738  in long device,
9739  in boolean hotPluggable
9740  );
9741 
9783  in wstring name,
9784  in long controllerPort,
9785  in long device,
9786  in IBandwidthGroup bandwidthGroup
9787  );
9788 
9826  in wstring name,
9827  in long controllerPort,
9828  in long device
9829  );
9830 
9895  void unmountMedium (
9896  in wstring name,
9897  in long controllerPort,
9898  in long device,
9899  in boolean force
9900  );
9901 
9964  void mountMedium (
9965  in wstring name,
9966  in long controllerPort,
9967  in long device,
9968  in IMedium medium,
9969  in boolean force
9970  );
9971 
10000  void getMedium (
10001  in wstring name,
10002  in long controllerPort,
10003  in long device,
10004  [retval] out IMedium medium
10005  );
10006 
10022  in wstring name,
10023  [retval] out IMediumAttachment[] mediumAttachments
10024  );
10025 
10040  void getMediumAttachment (
10041  in wstring name,
10042  in long controllerPort,
10043  in long device,
10044  [retval] out IMediumAttachment attachment
10045  );
10046 
10087  void attachHostPCIDevice (
10088  in long hostAddress,
10089  in long desiredGuestAddress,
10090  in boolean tryToUnbind
10091  );
10092 
10133  void detachHostPCIDevice (
10134  in long hostAddress
10135  );
10136 
10154  void getNetworkAdapter (
10155  in unsigned long slot,
10156  [retval] out INetworkAdapter adapter
10157  );
10158 
10191  void addStorageController (
10192  in wstring name,
10193  in StorageBus connectionType,
10194  [retval] out IStorageController controller
10195  );
10196 
10211  in wstring name,
10212  [retval] out IStorageController storageController
10213  );
10214 
10230  in StorageBus connectionType,
10231  in unsigned long instance,
10232  [retval] out IStorageController storageController
10233  );
10234 
10258  in wstring name
10259  );
10260 
10283  in wstring name,
10284  in boolean bootable
10285  );
10286 
10309  void addUSBController (
10310  in wstring name,
10311  in USBControllerType type,
10312  [retval] out IUSBController controller
10313  );
10314 
10328  void removeUSBController (
10329  in wstring name
10330  );
10331 
10345  void getUSBControllerByName (
10346  in wstring name,
10347  [retval] out IUSBController controller
10348  );
10349 
10356  in USBControllerType type,
10357  [retval] out unsigned long controllers
10358  );
10359 
10377  void getSerialPort (
10378  in unsigned long slot,
10379  [retval] out ISerialPort port
10380  );
10381 
10399  void getParallelPort (
10400  in unsigned long slot,
10401  [retval] out IParallelPort port
10402  );
10403 
10412  void getExtraDataKeys (
10413  [retval] out wstring[] keys
10414  );
10415 
10444  void getExtraData (
10445  in wstring key,
10446  [retval] out wstring value
10447  );
10448 
10498  void setExtraData (
10499  in wstring key,
10500  in wstring value
10501  );
10502 
10524  void getCPUProperty (
10525  in CPUPropertyType property,
10526  [retval] out boolean value
10527  );
10528 
10550  void setCPUProperty (
10551  in CPUPropertyType property,
10552  in boolean value
10553  );
10554 
10594  void getCPUIDLeaf (
10595  in unsigned long id,
10596  out unsigned long valEax,
10597  out unsigned long valEbx,
10598  out unsigned long valEcx,
10599  out unsigned long valEdx
10600  );
10601 
10645  void setCPUIDLeaf (
10646  in unsigned long id,
10647  in unsigned long valEax,
10648  in unsigned long valEbx,
10649  in unsigned long valEcx,
10650  in unsigned long valEdx
10651  );
10652 
10670  void removeCPUIDLeaf (
10671  in unsigned long id
10672  );
10673 
10679  void removeAllCPUIDLeaves();
10680 
10702  void getHWVirtExProperty (
10703  in HWVirtExPropertyType property,
10704  [retval] out boolean value
10705  );
10706 
10728  void setHWVirtExProperty (
10729  in HWVirtExPropertyType property,
10730  in boolean value
10731  );
10732 
10762  void setSettingsFilePath (
10763  in wstring settingsFilePath,
10764  [retval] out IProgress progress
10765  );
10766 
10812  void saveSettings();
10813 
10837  void discardSettings();
10838 
10923  void unregister (
10924  in CleanupMode cleanupMode,
10925  [retval] out IMedium[] media
10926  );
10927 
10985  void deleteConfig (
10986  in IMedium[] media,
10987  [retval] out IProgress progress
10988  );
10989 
11001  void exportTo (
11002  in IAppliance appliance,
11003  in wstring location,
11004  [retval] out IVirtualSystemDescription description
11005  );
11006 
11030  void findSnapshot (
11031  in wstring nameOrId,
11032  [retval] out ISnapshot snapshot
11033  );
11034 
11068  void createSharedFolder (
11069  in wstring name,
11070  in wstring hostPath,
11071  in boolean writable,
11072  in boolean automount
11073  );
11074 
11100  void removeSharedFolder (
11101  in wstring name
11102  );
11103 
11127  void canShowConsoleWindow (
11128  [retval] out boolean canShow
11129  );
11130 
11165  void showConsoleWindow (
11166  [retval] out long long winId
11167  );
11168 
11201  void getGuestProperty (
11202  in wstring name,
11203  out wstring value,
11204  out long long timestamp,
11205  out wstring flags
11206  );
11207 
11230  void getGuestPropertyValue (
11231  in wstring property,
11232  [retval] out wstring value
11233  );
11234 
11258  in wstring property,
11259  [retval] out long long value
11260  );
11261 
11312  void setGuestProperty (
11313  in wstring property,
11314  in wstring value,
11315  in wstring flags
11316  );
11317 
11357  void setGuestPropertyValue (
11358  in wstring property,
11359  in wstring value
11360  );
11361 
11379  void deleteGuestProperty (
11380  in wstring name
11381  );
11382 
11414  in wstring patterns,
11415  out wstring[] names,
11416  out wstring[] values,
11417  out long long[] timestamps,
11418  out wstring[] flags
11419  );
11420 
11451  in unsigned long screenId,
11452  out unsigned long originX,
11453  out unsigned long originY,
11454  out unsigned long width,
11455  out unsigned long height,
11456  out boolean enabled
11457  );
11458 
11485  in unsigned long screenId,
11486  in BitmapFormat bitmapFormat,
11487  out unsigned long width,
11488  out unsigned long height,
11489  [retval] out octet[] data
11490  );
11491 
11514  in unsigned long screenId,
11515  out unsigned long width,
11516  out unsigned long height,
11517  [retval] out BitmapFormat[] bitmapFormats
11518  );
11519 
11546  in unsigned long screenId,
11547  in BitmapFormat bitmapFormat,
11548  out unsigned long width,
11549  out unsigned long height,
11550  [retval] out octet[] data
11551  );
11552 
11562  void hotPlugCPU (
11563  in unsigned long cpu
11564  );
11565 
11575  void hotUnplugCPU (
11576  in unsigned long cpu
11577  );
11578 
11592  void getCPUStatus (
11593  in unsigned long cpu,
11594  [retval] out boolean attached
11595  );
11596 
11607  [retval] out ParavirtProvider paravirtProvider
11608  );
11609 
11624  void queryLogFilename (
11625  in unsigned long idx,
11626  [retval] out wstring filename
11627  );
11628 
11654  void readLog (
11655  in unsigned long idx,
11656  in long long offset,
11657  in long long size,
11658  [retval] out octet[] data
11659  );
11660 
11693  void cloneTo (
11694  in IMachine target,
11695  in CloneMode mode,
11696  in CloneOptions[] options,
11697  [retval] out IProgress progress
11698  );
11699 
11752  void saveState (
11753  [retval] out IProgress progress
11754  );
11755 
11788  void adoptSavedState (
11789  in wstring savedStateFile
11790  );
11791 
11822  void discardSavedState (
11823  in boolean fRemoveFile
11824  );
11825 
11871  void takeSnapshot (
11872  in wstring name,
11873  in wstring description,
11874  in boolean pause,
11875  out wstringUUID id,
11876  [retval] out IProgress progress
11877  );
11878 
11952  void deleteSnapshot (
11953  in wstringUUID id,
11954  [retval] out IProgress progress
11955  );
11956 
11997  in wstringUUID id,
11998  [retval] out IProgress progress
11999  );
12000 
12044  void deleteSnapshotRange (
12045  in wstringUUID startId,
12046  in wstringUUID endId,
12047  [retval] out IProgress progress
12048  );
12049 
12090  void restoreSnapshot (
12091  in ISnapshot snapshot,
12092  [retval] out IProgress progress
12093  );
12094 
12121  void applyDefaults (
12122  in wstring flags
12123  );
12124 
12125 }; /* interface IMachine */
12126 
12134 interface IEmulatedUSB : $unknown
12135 {
12139  readonly attribute wstring[] webcams;
12140 
12150  void webcamAttach (
12151  in wstring path,
12152  in wstring settings
12153  );
12154 
12162  void webcamDetach (
12163  in wstring path
12164  );
12165 
12166 }; /* interface IEmulatedUSB */
12167 
12176 interface IVRDEServerInfo : $unknown
12177 {
12183  readonly attribute boolean active;
12184 
12193  readonly attribute long port;
12194 
12200  readonly attribute unsigned long numberOfClients;
12201 
12207  readonly attribute long long beginTime;
12208 
12215  readonly attribute long long endTime;
12216 
12222  readonly attribute long long bytesSent;
12223 
12229  readonly attribute long long bytesSentTotal;
12230 
12236  readonly attribute long long bytesReceived;
12237 
12243  readonly attribute long long bytesReceivedTotal;
12244 
12250  readonly attribute wstring user;
12251 
12257  readonly attribute wstring domain;
12258 
12264  readonly attribute wstring clientName;
12265 
12271  readonly attribute wstring clientIP;
12272 
12278  readonly attribute unsigned long clientVersion;
12279 
12287  readonly attribute unsigned long encryptionStyle;
12288 
12289 }; /* interface IVRDEServerInfo */
12290 
12312 interface IConsole : $unknown
12313 {
12325  readonly attribute IMachine machine;
12326 
12340  readonly attribute MachineState state;
12341 
12345  readonly attribute IGuest guest;
12346 
12357  readonly attribute IKeyboard keyboard;
12358 
12369  readonly attribute IMouse mouse;
12370 
12380  readonly attribute IDisplay display;
12381 
12385  readonly attribute IMachineDebugger debugger;
12386 
12397  readonly attribute IUSBDevice[] USBDevices;
12398 
12406  readonly attribute IHostUSBDevice[] remoteUSBDevices;
12407 
12423  readonly attribute ISharedFolder[] sharedFolders;
12424 
12430  readonly attribute IVRDEServerInfo VRDEServerInfo;
12431 
12437  readonly attribute IEventSource eventSource;
12438 
12443 
12452  attribute boolean useHostClipboard;
12453 
12459  readonly attribute IEmulatedUSB emulatedUSB;
12460 
12525  void powerUp (
12526  [retval] out IProgress progress
12527  );
12528 
12562  void powerUpPaused (
12563  [retval] out IProgress progress
12564  );
12565 
12585  void powerDown (
12586  [retval] out IProgress progress
12587  );
12588 
12608  void reset();
12609 
12629  void pause();
12630 
12650  void resume();
12651 
12671  void powerButton();
12672 
12692  void sleepButton();
12693 
12705  void getPowerButtonHandled (
12706  [retval] out boolean handled
12707  );
12708 
12723  [retval] out boolean entered
12724  );
12725 
12738  void getDeviceActivity (
12739  in DeviceType[] type,
12740  [retval] out DeviceActivity[] activity
12741  );
12742 
12782  void attachUSBDevice (
12783  in wstringUUID id,
12784  in wstring captureFilename
12785  );
12786 
12821  void detachUSBDevice (
12822  in wstringUUID id,
12823  [retval] out IUSBDevice device
12824  );
12825 
12848  void findUSBDeviceByAddress (
12849  in wstring name,
12850  [retval] out IUSBDevice device
12851  );
12852 
12872  void findUSBDeviceById (
12873  in wstringUUID id,
12874  [retval] out IUSBDevice device
12875  );
12876 
12910  void createSharedFolder (
12911  in wstring name,
12912  in wstring hostPath,
12913  in boolean writable,
12914  in boolean automount
12915  );
12916 
12941  void removeSharedFolder (
12942  in wstring name
12943  );
12944 
12983  void teleport (
12984  in wstring hostname,
12985  in unsigned long tcpport,
12986  in wstring password,
12987  in unsigned long maxDowntime,
12988  [retval] out IProgress progress
12989  );
12990 
13018  in wstring id,
13019  in wstring password,
13020  in boolean clearOnSuspend
13021  );
13022 
13050  in wstring[] ids,
13051  in wstring[] passwords,
13052  in boolean clearOnSuspend
13053  );
13054 
13069  in wstring id
13070  );
13071 
13076 
13077 }; /* interface IConsole */
13078 
13089 interface IHostNetworkInterface : $unknown
13090 {
13094  readonly attribute wstring name;
13095 
13099  readonly attribute wstring shortName;
13100 
13104  readonly attribute wstringUUID id;
13105 
13109  readonly attribute wstring networkName;
13110 
13114  readonly attribute boolean DHCPEnabled;
13115 
13119  readonly attribute wstring IPAddress;
13120 
13124  readonly attribute wstring networkMask;
13125 
13129  readonly attribute boolean IPV6Supported;
13130 
13134  readonly attribute wstring IPV6Address;
13135 
13139  readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
13140 
13144  readonly attribute wstring hardwareAddress;
13145 
13150 
13155 
13160 
13172  void enableStaticIPConfig (
13173  in wstring IPAddress,
13174  in wstring networkMask
13175  );
13176 
13188  void enableStaticIPConfigV6 (
13189  in wstring IPV6Address,
13190  in unsigned long IPV6NetworkMaskPrefixLength
13191  );
13192 
13196  void enableDynamicIPConfig();
13197 
13201  void DHCPRediscover();
13202 
13203 }; /* interface IHostNetworkInterface */
13204 
13212 interface IHostVideoInputDevice : $unknown
13213 {
13217  readonly attribute wstring name;
13218 
13222  readonly attribute wstring path;
13223 
13227  readonly attribute wstring alias;
13228 
13229 }; /* interface IHostVideoInputDevice */
13230 
13247 interface IHost : $unknown
13248 {
13252  readonly attribute IMedium[] DVDDrives;
13253 
13257  readonly attribute IMedium[] floppyDrives;
13258 
13272  readonly attribute IHostUSBDevice[] USBDevices;
13273 
13298 
13303 
13307  readonly attribute wstring[] nameServers;
13308 
13312  readonly attribute wstring domainName;
13313 
13317  readonly attribute wstring[] searchStrings;
13318 
13322  readonly attribute unsigned long processorCount;
13323 
13327  readonly attribute unsigned long processorOnlineCount;
13328 
13332  readonly attribute unsigned long processorCoreCount;
13333 
13337  readonly attribute unsigned long processorOnlineCoreCount;
13338 
13342  readonly attribute unsigned long memorySize;
13343 
13347  readonly attribute unsigned long memoryAvailable;
13348 
13352  readonly attribute wstring operatingSystem;
13353 
13357  readonly attribute wstring OSVersion;
13358 
13362  readonly attribute long long UTCTime;
13363 
13367  readonly attribute boolean acceleration3DAvailable;
13368 
13373 
13388  void getProcessorSpeed (
13389  in unsigned long cpuId,
13390  [retval] out unsigned long speed
13391  );
13392 
13404  void getProcessorFeature (
13405  in ProcessorFeature feature,
13406  [retval] out boolean supported
13407  );
13408 
13428  in unsigned long cpuId,
13429  [retval] out wstring description
13430  );
13431 
13472  void getProcessorCPUIDLeaf (
13473  in unsigned long cpuId,
13474  in unsigned long leaf,
13475  in unsigned long subLeaf,
13476  out unsigned long valEax,
13477  out unsigned long valEbx,
13478  out unsigned long valEcx,
13479  out unsigned long valEdx
13480  );
13481 
13503  out IHostNetworkInterface hostInterface,
13504  [retval] out IProgress progress
13505  );
13506 
13528  in wstringUUID id,
13529  [retval] out IProgress progress
13530  );
13531 
13551  void createUSBDeviceFilter (
13552  in wstring name,
13553  [retval] out IHostUSBDeviceFilter filter
13554  );
13555 
13598  void insertUSBDeviceFilter (
13599  in unsigned long position,
13600  in IHostUSBDeviceFilter filter
13601  );
13602 
13630  void removeUSBDeviceFilter (
13631  in unsigned long position
13632  );
13633 
13651  void findHostDVDDrive (
13652  in wstring name,
13653  [retval] out IMedium drive
13654  );
13655 
13673  void findHostFloppyDrive (
13674  in wstring name,
13675  [retval] out IMedium drive
13676  );
13677 
13694  in wstring name,
13695  [retval] out IHostNetworkInterface networkInterface
13696  );
13697 
13714  in wstringUUID id,
13715  [retval] out IHostNetworkInterface networkInterface
13716  );
13717 
13728  in HostNetworkInterfaceType type,
13729  [retval] out IHostNetworkInterface[] networkInterfaces
13730  );
13731 
13751  void findUSBDeviceById (
13752  in wstringUUID id,
13753  [retval] out IHostUSBDevice device
13754  );
13755 
13778  void findUSBDeviceByAddress (
13779  in wstring name,
13780  [retval] out IHostUSBDevice device
13781  );
13782 
13790  void generateMACAddress (
13791  [retval] out wstring address
13792  );
13793 
13812  void addUSBDeviceSource (
13813  in wstring backend,
13814  in wstring id,
13815  in wstring address,
13816  in wstring[] propertyNames,
13817  in wstring[] propertyValues
13818  );
13819 
13827  void removeUSBDeviceSource (
13828  in wstring id
13829  );
13830 
13831 }; /* interface IHost */
13832 
13845 interface ISystemProperties : $unknown
13846 {
13850  readonly attribute unsigned long minGuestRAM;
13851 
13855  readonly attribute unsigned long maxGuestRAM;
13856 
13860  readonly attribute unsigned long minGuestVRAM;
13861 
13865  readonly attribute unsigned long maxGuestVRAM;
13866 
13870  readonly attribute unsigned long minGuestCPUCount;
13871 
13875  readonly attribute unsigned long maxGuestCPUCount;
13876 
13880  readonly attribute unsigned long maxGuestMonitors;
13881 
13886  readonly attribute long long infoVDSize;
13887 
13894  readonly attribute unsigned long serialPortCount;
13895 
13902  readonly attribute unsigned long parallelPortCount;
13903 
13913  readonly attribute unsigned long maxBootPosition;
13914 
13923  readonly attribute boolean rawModeSupported;
13924 
13937  attribute boolean exclusiveHwVirt;
13938 
13962  attribute wstring defaultMachineFolder;
13963 
13969  attribute wstring loggingLevel;
13970 
13996  readonly attribute IMediumFormat[] mediumFormats;
13997 
14031  attribute wstring defaultHardDiskFormat;
14032 
14038  attribute long long freeDiskSpaceWarning;
14039 
14044  attribute unsigned long freeDiskSpacePercentWarning;
14045 
14051  attribute long long freeDiskSpaceError;
14052 
14057  attribute unsigned long freeDiskSpacePercentError;
14058 
14082  attribute wstring VRDEAuthLibrary;
14083 
14112  attribute wstring webServiceAuthLibrary;
14113 
14127  attribute wstring defaultVRDEExtPack;
14128 
14134  attribute unsigned long logHistoryCount;
14135 
14141 
14148  attribute wstring autostartDatabasePath;
14149 
14156  attribute wstring defaultAdditionsISO;
14157 
14172  attribute wstring defaultFrontend;
14173 
14180  readonly attribute BitmapFormat[] screenShotFormats;
14181 
14192  void getMaxNetworkAdapters (
14193  in ChipsetType chipset,
14194  [retval] out unsigned long maxNetworkAdapters
14195  );
14196 
14211  in ChipsetType chipset,
14212  in NetworkAttachmentType type,
14213  [retval] out unsigned long maxNetworkAdapters
14214  );
14215 
14226  in StorageBus bus,
14227  [retval] out unsigned long maxDevicesPerPort
14228  );
14229 
14238  in StorageBus bus,
14239  [retval] out unsigned long minPortCount
14240  );
14241 
14250  in StorageBus bus,
14251  [retval] out unsigned long maxPortCount
14252  );
14253 
14267  in ChipsetType chipset,
14268  in StorageBus bus,
14269  [retval] out unsigned long maxInstances
14270  );
14271 
14282  in StorageBus bus,
14283  [retval] out DeviceType[] deviceTypes
14284  );
14285 
14295  in StorageControllerType controllerType,
14296  [retval] out boolean enabled
14297  );
14298 
14308  in StorageControllerType controllerType,
14309  [retval] out boolean hotplugCapable
14310  );
14311 
14325  in ChipsetType chipset,
14326  in USBControllerType type,
14327  [retval] out unsigned long maxInstances
14328  );
14329 
14330 }; /* interface ISystemProperties */
14331 
14337 interface IGuestOSType : $unknown
14338 {
14342  readonly attribute wstring familyId;
14343 
14347  readonly attribute wstring familyDescription;
14348 
14352  readonly attribute wstring id;
14353 
14357  readonly attribute wstring description;
14358 
14362  readonly attribute boolean is64Bit;
14363 
14367  readonly attribute boolean recommendedIOAPIC;
14368 
14372  readonly attribute boolean recommendedVirtEx;
14373 
14377  readonly attribute unsigned long recommendedRAM;
14378 
14382  readonly attribute unsigned long recommendedVRAM;
14383 
14387  readonly attribute boolean recommended2DVideoAcceleration;
14388 
14392  readonly attribute boolean recommended3DAcceleration;
14393 
14397  readonly attribute long long recommendedHDD;
14398 
14402  readonly attribute NetworkAdapterType adapterType;
14403 
14407  readonly attribute boolean recommendedPAE;
14408 
14413 
14418 
14423 
14428 
14432  readonly attribute FirmwareType recommendedFirmware;
14433 
14437  readonly attribute boolean recommendedUSBHID;
14438 
14442  readonly attribute boolean recommendedHPET;
14443 
14447  readonly attribute boolean recommendedUSBTablet;
14448 
14452  readonly attribute boolean recommendedRTCUseUTC;
14453 
14457  readonly attribute ChipsetType recommendedChipset;
14458 
14463 
14468 
14472  readonly attribute boolean recommendedFloppy;
14473 
14477  readonly attribute boolean recommendedUSB;
14478 
14482  readonly attribute boolean recommendedUSB3;
14483 
14487  readonly attribute boolean recommendedTFReset;
14488 
14492  readonly attribute boolean recommendedX2APIC;
14493 
14494 }; /* interface IGuestOSType */
14495 
14503 interface IAdditionsFacility : $unknown
14504 {
14508  readonly attribute AdditionsFacilityClass classType;
14509 
14516  readonly attribute long long lastUpdated;
14517 
14521  readonly attribute wstring name;
14522 
14526  readonly attribute AdditionsFacilityStatus status;
14527 
14531  readonly attribute AdditionsFacilityType type;
14532 
14533 }; /* interface IAdditionsFacility */
14534 
14540 interface IDnDBase : $unknown
14541 {
14545  readonly attribute wstring[] formats;
14546 
14551  readonly attribute unsigned long protocolVersion;
14552 
14562  void isFormatSupported (
14563  in wstring format,
14564  [retval] out boolean supported
14565  );
14566 
14574  void addFormats (
14575  in wstring[] formats
14576  );
14577 
14585  void removeFormats (
14586  in wstring[] formats
14587  );
14588 
14589 }; /* interface IDnDBase */
14590 
14597 {
14620  void dragIsPending (
14621  in unsigned long screenId,
14622  out wstring[] formats,
14623  out DnDAction[] allowedActions,
14624  [retval] out DnDAction defaultAction
14625  );
14626 
14647  void drop (
14648  in wstring format,
14649  in DnDAction action,
14650  [retval] out IProgress progress
14651  );
14652 
14668  void receiveData (
14669  [retval] out octet[] data
14670  );
14671 
14672 }; /* interface IDnDSource */
14673 
14683 {
14684  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
14685 
14686 }; /* interface IGuestDnDSource */
14687 
14694 {
14722  void enter (
14723  in unsigned long screenId,
14724  in unsigned long y,
14725  in unsigned long x,
14726  in DnDAction defaultAction,
14727  in DnDAction[] allowedActions,
14728  in wstring[] formats,
14729  [retval] out DnDAction resultAction
14730  );
14731 
14759  void move (
14760  in unsigned long screenId,
14761  in unsigned long x,
14762  in unsigned long y,
14763  in DnDAction defaultAction,
14764  in DnDAction[] allowedActions,
14765  in wstring[] formats,
14766  [retval] out DnDAction resultAction
14767  );
14768 
14784  void leave (
14785  in unsigned long screenId
14786  );
14787 
14817  void drop (
14818  in unsigned long screenId,
14819  in unsigned long x,
14820  in unsigned long y,
14821  in DnDAction defaultAction,
14822  in DnDAction[] allowedActions,
14823  in wstring[] formats,
14824  out wstring format,
14825  [retval] out DnDAction resultAction
14826  );
14827 
14849  void sendData (
14850  in unsigned long screenId,
14851  in wstring format,
14852  in octet[] data,
14853  [retval] out IProgress progress
14854  );
14855 
14872  void cancel (
14873  [retval] out boolean veto
14874  );
14875 
14876 }; /* interface IDnDTarget */
14877 
14887 {
14888  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
14889 
14890 }; /* interface IGuestDnDTarget */
14891 
14938 interface IGuestSession : $unknown
14939 {
14945  readonly attribute wstring user;
14946 
14952  readonly attribute wstring domain;
14953 
14957  readonly attribute wstring name;
14958 
14962  readonly attribute unsigned long id;
14963 
14976  attribute unsigned long timeout;
14977 
14982  readonly attribute unsigned long protocolVersion;
14983 
14987  readonly attribute GuestSessionStatus status;
14988 
15000  attribute wstring[] environmentChanges;
15001 
15016  readonly attribute wstring[] environmentBase;
15017 
15023  readonly attribute IGuestProcess[] processes;
15024 
15031  readonly attribute PathStyle pathStyle;
15032 
15045  attribute wstring currentDirectory;
15046 
15052  readonly attribute IGuestDirectory[] directories;
15053 
15059  readonly attribute IGuestFile[] files;
15060 
15066  readonly attribute IEventSource eventSource;
15067 
15076  void close();
15077 
15101  void directoryCopy (
15102  in wstring source,
15103  in wstring destination,
15104  in DirectoryCopyFlags[] flags,
15105  [retval] out IProgress progress
15106  );
15107 
15132  void directoryCopyFromGuest (
15133  in wstring source,
15134  in wstring destination,
15135  in DirectoryCopyFlags[] flags,
15136  [retval] out IProgress progress
15137  );
15138 
15163  void directoryCopyToGuest (
15164  in wstring source,
15165  in wstring destination,
15166  in DirectoryCopyFlags[] flags,
15167  [retval] out IProgress progress
15168  );
15169 
15194  void directoryCreate (
15195  in wstring path,
15196  in unsigned long mode,
15197  in DirectoryCreateFlag[] flags
15198  );
15199 
15261  void directoryCreateTemp (
15262  in wstring templateName,
15263  in unsigned long mode,
15264  in wstring path,
15265  in boolean secure,
15266  [retval] out wstring directory
15267  );
15268 
15293  void directoryExists (
15294  in wstring path,
15295  in boolean followSymlinks,
15296  [retval] out boolean exists
15297  );
15298 
15333  void directoryOpen (
15334  in wstring path,
15335  in wstring filter,
15336  in DirectoryOpenFlag[] flags,
15337  [retval] out IGuestDirectory directory
15338  );
15339 
15351  void directoryRemove (
15352  in wstring path
15353  );
15354 
15381  in wstring path,
15382  in DirectoryRemoveRecFlag[] flags,
15383  [retval] out IProgress progress
15384  );
15385 
15398  void environmentScheduleSet (
15399  in wstring name,
15400  in wstring value
15401  );
15402 
15414  in wstring name
15415  );
15416 
15448  in wstring name,
15449  [retval] out wstring value
15450  );
15451 
15479  in wstring name,
15480  [retval] out boolean exists
15481  );
15482 
15508  void fileCopy (
15509  in wstring source,
15510  in wstring destination,
15511  in FileCopyFlag[] flags,
15512  [retval] out IProgress progress
15513  );
15514 
15541  void fileCopyFromGuest (
15542  in wstring source,
15543  in wstring destination,
15544  in FileCopyFlag[] flags,
15545  [retval] out IProgress progress
15546  );
15547 
15574  void fileCopyToGuest (
15575  in wstring source,
15576  in wstring destination,
15577  in FileCopyFlag[] flags,
15578  [retval] out IProgress progress
15579  );
15580 
15642  void fileCreateTemp (
15643  in wstring templateName,
15644  in unsigned long mode,
15645  in wstring path,
15646  in boolean secure,
15647  [retval] out IGuestFile file
15648  );
15649 
15675  void fileExists (
15676  in wstring path,
15677  in boolean followSymlinks,
15678  [retval] out boolean exists
15679  );
15680 
15720  void fileOpen (
15721  in wstring path,
15722  in FileAccessMode accessMode,
15723  in FileOpenAction openAction,
15724  in unsigned long creationMode,
15725  [retval] out IGuestFile file
15726  );
15727 
15775  void fileOpenEx (
15776  in wstring path,
15777  in FileAccessMode accessMode,
15778  in FileOpenAction openAction,
15779  in FileSharingMode sharingMode,
15780  in unsigned long creationMode,
15781  in FileOpenExFlags[] flags,
15782  [retval] out IGuestFile file
15783  );
15784 
15817  void fileQuerySize (
15818  in wstring path,
15819  in boolean followSymlinks,
15820  [retval] out long long size
15821  );
15822 
15849  void fsObjExists (
15850  in wstring path,
15851  in boolean followSymlinks,
15852  [retval] out boolean exists
15853  );
15854 
15888  void fsObjQueryInfo (
15889  in wstring path,
15890  in boolean followSymlinks,
15891  [retval] out IGuestFsObjInfo info
15892  );
15893 
15928  void fsObjRemove (
15929  in wstring path
15930  );
15931 
15960  void fsObjRename (
15961  in wstring oldPath,
15962  in wstring newPath,
15963  in FsObjRenameFlag[] flags
15964  );
15965 
15994  void fsObjMove (
15995  in wstring source,
15996  in wstring destination,
15997  in FsObjMoveFlags[] flags,
15998  [retval] out IProgress progress
15999  );
16000 
16030  void fsObjSetACL (
16031  in wstring path,
16032  in boolean followSymlinks,
16033  in wstring acl,
16034  in unsigned long mode
16035  );
16036 
16109  void processCreate (
16110  in wstring executable,
16111  in wstring[] arguments,
16112  in wstring[] environmentChanges,
16113  in ProcessCreateFlag[] flags,
16114  in unsigned long timeoutMS,
16115  [retval] out IGuestProcess guestProcess
16116  );
16117 
16189  void processCreateEx (
16190  in wstring executable,
16191  in wstring[] arguments,
16192  in wstring[] environmentChanges,
16193  in ProcessCreateFlag[] flags,
16194  in unsigned long timeoutMS,
16195  in ProcessPriority priority,
16196  in long[] affinity,
16197  [retval] out IGuestProcess guestProcess
16198  );
16199 
16209  void processGet (
16210  in unsigned long pid,
16211  [retval] out IGuestProcess guestProcess
16212  );
16213 
16241  void symlinkCreate (
16242  in wstring symlink,
16243  in wstring target,
16244  in SymlinkType type
16245  );
16246 
16269  void symlinkExists (
16270  in wstring symlink,
16271  [retval] out boolean exists
16272  );
16273 
16293  void symlinkRead (
16294  in wstring symlink,
16295  in SymlinkReadFlag[] flags,
16296  [retval] out wstring target
16297  );
16298 
16319  void waitFor (
16320  in unsigned long waitFor,
16321  in unsigned long timeoutMS,
16322  [retval] out GuestSessionWaitResult reason
16323  );
16324 
16346  void waitForArray (
16348  in unsigned long timeoutMS,
16349  [retval] out GuestSessionWaitResult reason
16350  );
16351 
16352 }; /* interface IGuestSession */
16353 
16361 interface IProcess : $unknown
16362 {
16368  readonly attribute wstring[] arguments;
16369 
16375  readonly attribute wstring[] environment;
16376 
16382  readonly attribute IEventSource eventSource;
16383 
16387  readonly attribute wstring executablePath;
16388 
16395  readonly attribute long exitCode;
16396 
16402  readonly attribute wstring name;
16403 
16409  readonly attribute unsigned long PID;
16410 
16417  readonly attribute ProcessStatus status;
16418 
16439  void waitFor (
16440  in unsigned long waitFor,
16441  in unsigned long timeoutMS,
16442  [retval] out ProcessWaitResult reason
16443  );
16444 
16466  void waitForArray (
16468  in unsigned long timeoutMS,
16469  [retval] out ProcessWaitResult reason
16470  );
16471 
16488  void read (
16489  in unsigned long handle,
16490  in unsigned long toRead,
16491  in unsigned long timeoutMS,
16492  [retval] out octet[] data
16493  );
16494 
16518  void write (
16519  in unsigned long handle,
16520  in unsigned long flags,
16521  in octet[] data,
16522  in unsigned long timeoutMS,
16523  [retval] out unsigned long written
16524  );
16525 
16550  void writeArray (
16551  in unsigned long handle,
16552  in ProcessInputFlag[] flags,
16553  in octet[] data,
16554  in unsigned long timeoutMS,
16555  [retval] out unsigned long written
16556  );
16557 
16567  void terminate();
16568 
16569 }; /* interface IProcess */
16570 
16580 {
16581  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
16582 
16583 }; /* interface IGuestProcess */
16584 
16592 interface IDirectory : $unknown
16593 {
16597  readonly attribute wstring directoryName;
16598 
16602  readonly attribute wstring filter;
16603 
16610  void close();
16611 
16627  void read (
16628  [retval] out IFsObjInfo objInfo
16629  );
16630 
16631 }; /* interface IDirectory */
16632 
16642 {
16643  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
16644 
16645 }; /* interface IGuestDirectory */
16646 
16654 interface IFile : $unknown
16655 {
16661  readonly attribute IEventSource eventSource;
16662 
16668  readonly attribute unsigned long id;
16669 
16675  readonly attribute long long initialSize;
16676 
16691  readonly attribute long long offset;
16692 
16698  readonly attribute FileStatus status;
16699 
16704  readonly attribute wstring fileName;
16705 
16709  readonly attribute unsigned long creationMode;
16710 
16714  readonly attribute FileOpenAction openAction;
16715 
16719  readonly attribute FileAccessMode accessMode;
16720 
16727  void close();
16728 
16745  void queryInfo (
16746  [retval] out IFsObjInfo objInfo
16747  );
16748 
16764  void querySize (
16765  [retval] out long long size
16766  );
16767 
16790  void read (
16791  in unsigned long toRead,
16792  in unsigned long timeoutMS,
16793  [retval] out octet[] data
16794  );
16795 
16820  void readAt (
16821  in long long offset,
16822  in unsigned long toRead,
16823  in unsigned long timeoutMS,
16824  [retval] out octet[] data
16825  );
16826 
16845  void seek (
16846  in long long offset,
16847  in FileSeekOrigin whence,
16848  [retval] out long long newOffset
16849  );
16850 
16871  void setACL (
16872  in wstring acl,
16873  in unsigned long mode
16874  );
16875 
16891  void setSize (
16892  in long long size
16893  );
16894 
16912  void write (
16913  in octet[] data,
16914  in unsigned long timeoutMS,
16915  [retval] out unsigned long written
16916  );
16917 
16945  void writeAt (
16946  in long long offset,
16947  in octet[] data,
16948  in unsigned long timeoutMS,
16949  [retval] out unsigned long written
16950  );
16951 
16952 }; /* interface IFile */
16953 
16962 interface IGuestFile : IFile
16963 {
16964  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
16965 
16966 }; /* interface IGuestFile */
16967 
16976 interface IFsObjInfo : $unknown
16977 {
16983  readonly attribute long long accessTime;
16984 
16990  readonly attribute long long allocatedSize;
16991 
16997  readonly attribute long long birthTime;
16998 
17004  readonly attribute long long changeTime;
17005 
17011  readonly attribute unsigned long deviceNumber;
17012 
17018  readonly attribute wstring fileAttributes;
17019 
17025  readonly attribute unsigned long generationId;
17026 
17032  readonly attribute unsigned long GID;
17033 
17039  readonly attribute wstring groupName;
17040 
17046  readonly attribute unsigned long hardLinks;
17047 
17053  readonly attribute long long modificationTime;
17054 
17060  readonly attribute wstring name;
17061 
17067  readonly attribute long long nodeId;
17068 
17074  readonly attribute unsigned long nodeIdDevice;
17075 
17083  readonly attribute long long objectSize;
17084 
17090  readonly attribute FsObjType type;
17091 
17097  readonly attribute unsigned long UID;
17098 
17104  readonly attribute unsigned long userFlags;
17105 
17111  readonly attribute wstring userName;
17112 
17113 }; /* interface IFsObjInfo */
17114 
17124 {
17125  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
17126 
17127 }; /* interface IGuestFsObjInfo */
17128 
17142 interface IGuest : $unknown
17143 {
17158  readonly attribute wstring OSTypeId;
17159 
17166 
17173  readonly attribute wstring additionsVersion;
17174 
17182  readonly attribute unsigned long additionsRevision;
17183 
17190  readonly attribute IGuestDnDSource dnDSource;
17191 
17199  readonly attribute IGuestDnDTarget dnDTarget;
17200 
17206  readonly attribute IEventSource eventSource;
17207 
17214  readonly attribute IAdditionsFacility[] facilities;
17215 
17219  readonly attribute IGuestSession[] sessions;
17220 
17224  attribute unsigned long memoryBalloonSize;
17225 
17229  attribute unsigned long statisticsUpdateInterval;
17230 
17262  void internalGetStatistics (
17263  out unsigned long cpuUser,
17264  out unsigned long cpuKernel,
17265  out unsigned long cpuIdle,
17266  out unsigned long memTotal,
17267  out unsigned long memFree,
17268  out unsigned long memBalloon,
17269  out unsigned long memShared,
17270  out unsigned long memCache,
17271  out unsigned long pagedTotal,
17272  out unsigned long memAllocTotal,
17273  out unsigned long memFreeTotal,
17274  out unsigned long memBalloonTotal,
17275  out unsigned long memSharedTotal
17276  );
17277 
17289  void getFacilityStatus (
17290  in AdditionsFacilityType facility,
17291  out long long timestamp,
17292  [retval] out AdditionsFacilityStatus status
17293  );
17294 
17312  void getAdditionsStatus (
17313  in AdditionsRunLevelType level,
17314  [retval] out boolean active
17315  );
17316 
17346  void setCredentials (
17347  in wstring userName,
17348  in wstring password,
17349  in wstring domain,
17350  in boolean allowInteractiveLogon
17351  );
17352 
17395  void createSession (
17396  in wstring user,
17397  in wstring password,
17398  in wstring domain,
17399  in wstring sessionName,
17400  [retval] out IGuestSession guestSession
17401  );
17402 
17417  void findSession (
17418  in wstring sessionName,
17419  [retval] out IGuestSession[] sessions
17420  );
17421 
17471  void updateGuestAdditions (
17472  in wstring source,
17473  in wstring[] arguments,
17474  in AdditionsUpdateFlag[] flags,
17475  [retval] out IProgress progress
17476  );
17477 
17478 }; /* interface IGuest */
17479 
17520 interface IProgress : $unknown
17521 {
17525  readonly attribute wstringUUID id;
17526 
17530  readonly attribute wstring description;
17531 
17535  readonly attribute $unknown initiator;
17536 
17540  readonly attribute boolean cancelable;
17541 
17549  readonly attribute unsigned long percent;
17550 
17564  readonly attribute long timeRemaining;
17565 
17569  readonly attribute boolean completed;
17570 
17574  readonly attribute boolean canceled;
17575 
17582  readonly attribute long resultCode;
17583 
17593  readonly attribute IVirtualBoxErrorInfo errorInfo;
17594 
17601  readonly attribute unsigned long operationCount;
17602 
17606  readonly attribute unsigned long operation;
17607 
17613  readonly attribute wstring operationDescription;
17614 
17618  readonly attribute unsigned long operationPercent;
17619 
17623  readonly attribute unsigned long operationWeight;
17624 
17632  attribute unsigned long timeout;
17633 
17638  in unsigned long percent
17639  );
17640 
17644  void setNextOperation (
17645  in wstring nextOperationDescription,
17646  in unsigned long nextOperationsWeight
17647  );
17648 
17675  void waitForCompletion (
17676  in long timeout
17677  );
17678 
17703  in unsigned long operation,
17704  in long timeout
17705  );
17706 
17733  in IProgress pProgressAsync
17734  );
17735 
17752  void cancel();
17753 
17754 }; /* interface IProgress */
17755 
17840 interface ISnapshot : $unknown
17841 {
17845  readonly attribute wstringUUID id;
17846 
17854  attribute wstring name;
17855 
17863  attribute wstring description;
17864 
17870  readonly attribute long long timeStamp;
17871 
17883  readonly attribute boolean online;
17884 
17896  readonly attribute IMachine machine;
17897 
17904  readonly attribute ISnapshot parent;
17905 
17914  readonly attribute ISnapshot[] children;
17915 
17923  void getChildrenCount (
17924  [retval] out unsigned long childrenCount
17925  );
17926 
17927 }; /* interface ISnapshot */
17928 
18117 interface IMediumAttachment : $unknown
18118 {
18123  readonly attribute IMedium medium;
18124 
18130  readonly attribute wstring controller;
18131 
18137  readonly attribute long port;
18138 
18144  readonly attribute long device;
18145 
18149  readonly attribute DeviceType type;
18150 
18154  readonly attribute boolean passthrough;
18155 
18159  readonly attribute boolean temporaryEject;
18160 
18165  readonly attribute boolean isEjected;
18166 
18170  readonly attribute boolean nonRotational;
18171 
18175  readonly attribute boolean discard;
18176 
18180  readonly attribute boolean hotPluggable;
18181 
18185  readonly attribute IBandwidthGroup bandwidthGroup;
18186 
18187 }; /* interface IMediumAttachment */
18188 
18349 interface IMedium : $unknown
18350 {
18364  readonly attribute wstringUUID id;
18365 
18384  attribute wstring description;
18385 
18401  readonly attribute MediumState state;
18402 
18411  readonly attribute MediumVariant[] variant;
18412 
18422  readonly attribute wstring location;
18423 
18443  readonly attribute wstring name;
18444 
18449  readonly attribute DeviceType deviceType;
18450 
18454  readonly attribute boolean hostDrive;
18455 
18468  readonly attribute long long size;
18469 
18484  readonly attribute wstring format;
18485 
18501  readonly attribute IMediumFormat mediumFormat;
18502 
18528  attribute MediumType type;
18529 
18543  readonly attribute MediumType[] allowedTypes;
18544 
18554  readonly attribute IMedium parent;
18555 
18563  readonly attribute IMedium[] children;
18564 
18575  readonly attribute IMedium base;
18576 
18609  readonly attribute boolean readOnly;
18610 
18626  readonly attribute long long logicalSize;
18627 
18655  attribute boolean autoReset;
18656 
18671  readonly attribute wstring lastAccessError;
18672 
18689  readonly attribute wstringUUID[] machineIds;
18690 
18716  void setIds (
18717  in boolean setImageId,
18718  in wstringUUID imageId,
18719  in boolean setParentId,
18720  in wstringUUID parentId
18721  );
18722 
18757  void refreshState (
18758  [retval] out MediumState state
18759  );
18760 
18787  void getSnapshotIds (
18788  in wstringUUID machineId,
18789  [retval] out wstringUUID[] snapshotIds
18790  );
18791 
18854  void lockRead (
18855  [retval] out IToken token
18856  );
18857 
18912  void lockWrite (
18913  [retval] out IToken token
18914  );
18915 
18965  void close();
18966 
18996  void getProperty (
18997  in wstring name,
18998  [retval] out wstring value
18999  );
19000 
19032  void setProperty (
19033  in wstring name,
19034  in wstring value
19035  );
19036 
19071  void getProperties (
19072  in wstring names,
19073  out wstring[] returnNames,
19074  [retval] out wstring[] returnValues
19075  );
19076 
19106  void setProperties (
19107  in wstring[] names,
19108  in wstring[] values
19109  );
19110 
19143  void createBaseStorage (
19144  in long long logicalSize,
19145  in MediumVariant[] variant,
19146  [retval] out IProgress progress
19147  );
19148 
19200  void deleteStorage (
19201  [retval] out IProgress progress
19202  );
19203 
19242  void createDiffStorage (
19243  in IMedium target,
19244  in MediumVariant[] variant,
19245  [retval] out IProgress progress
19246  );
19247 
19325  void mergeTo (
19326  in IMedium target,
19327  [retval] out IProgress progress
19328  );
19329 
19379  void cloneTo (
19380  in IMedium target,
19381  in MediumVariant[] variant,
19382  in IMedium parent,
19383  [retval] out IProgress progress
19384  );
19385 
19432  void cloneToBase (
19433  in IMedium target,
19434  in MediumVariant[] variant,
19435  [retval] out IProgress progress
19436  );
19437 
19479  void setLocation (
19480  in wstring location,
19481  [retval] out IProgress progress
19482  );
19483 
19512  void compact (
19513  [retval] out IProgress progress
19514  );
19515 
19548  void resize (
19549  in long long logicalSize,
19550  [retval] out IProgress progress
19551  );
19552 
19586  void reset (
19587  [retval] out IProgress progress
19588  );
19589 
19631  void changeEncryption (
19632  in wstring currentPassword,
19633  in wstring cipher,
19634  in wstring newPassword,
19635  in wstring newPasswordId,
19636  [retval] out IProgress progress
19637  );
19638 
19656  void getEncryptionSettings (
19657  out wstring cipher,
19658  [retval] out wstring passwordId
19659  );
19660 
19685  in wstring password
19686  );
19687 
19688 }; /* interface IMedium */
19689 
19712 interface IMediumFormat : $unknown
19713 {
19733  readonly attribute wstring id;
19734 
19742  readonly attribute wstring name;
19743 
19753 
19772  void describeFileExtensions (
19773  out wstring[] extensions,
19774  out DeviceType[] types
19775  );
19776 
19804  void describeProperties (
19805  out wstring[] names,
19806  out wstring[] descriptions,
19807  out DataType[] types,
19808  out unsigned long[] flags,
19809  out wstring[] defaults
19810  );
19811 
19812 }; /* interface IMediumFormat */
19813 
19828 interface IToken : $unknown
19829 {
19838  void abandon();
19839 
19846  void dummy();
19847 
19848 }; /* interface IToken */
19849 
19861 interface IKeyboard : $unknown
19862 {
19868  readonly attribute KeyboardLED[] keyboardLEDs;
19869 
19875  readonly attribute IEventSource eventSource;
19876 
19889  void putScancode (
19890  in long scancode
19891  );
19892 
19905  void putScancodes (
19906  in long[] scancodes,
19907  [retval] out unsigned long codesStored
19908  );
19909 
19924  void putCAD();
19925 
19940  void releaseKeys();
19941 
19942 }; /* interface IKeyboard */
19943 
19951 interface IMousePointerShape : $unknown
19952 {
19958  readonly attribute boolean visible;
19959 
19965  readonly attribute boolean alpha;
19966 
19972  readonly attribute unsigned long hotX;
19973 
19979  readonly attribute unsigned long hotY;
19980 
19986  readonly attribute unsigned long width;
19987 
19993  readonly attribute unsigned long height;
19994 
20028  readonly attribute octet[] shape;
20029 
20030 }; /* interface IMousePointerShape */
20031 
20043 interface IMouse : $unknown
20044 {
20059  readonly attribute boolean absoluteSupported;
20060 
20075  readonly attribute boolean relativeSupported;
20076 
20090  readonly attribute boolean multiTouchSupported;
20091 
20106  readonly attribute boolean needsHostCursor;
20107 
20113  readonly attribute IMousePointerShape pointerShape;
20114 
20120  readonly attribute IEventSource eventSource;
20121 
20187  void putMouseEvent (
20188  in long dx,
20189  in long dy,
20190  in long dz,
20191  in long dw,
20192  in long buttonState
20193  );
20194 
20267  void putMouseEventAbsolute (
20268  in long x,
20269  in long y,
20270  in long dz,
20271  in long dw,
20272  in long buttonState
20273  );
20274 
20322  void putEventMultiTouch (
20323  in long count,
20324  in long long[] contacts,
20325  in unsigned long scanTime
20326  );
20327 
20344  in long count,
20345  in wstring contacts,
20346  in unsigned long scanTime
20347  );
20348 
20349 }; /* interface IMouse */
20350 
20351 interface IDisplaySourceBitmap : $unknown
20352 {
20353  readonly attribute unsigned long screenId;
20354 
20363  void queryBitmapInfo (
20364  out octetPtr address,
20365  out unsigned long width,
20366  out unsigned long height,
20367  out unsigned long bitsPerPixel,
20368  out unsigned long bytesPerLine,
20369  out BitmapFormat bitmapFormat
20370  );
20371 
20372 }; /* interface IDisplaySourceBitmap */
20373 
20374 interface IFramebuffer : $unknown
20375 {
20379  readonly attribute unsigned long width;
20380 
20384  readonly attribute unsigned long height;
20385 
20391  readonly attribute unsigned long bitsPerPixel;
20392 
20398  readonly attribute unsigned long bytesPerLine;
20399 
20410  readonly attribute BitmapFormat pixelFormat;
20411 
20421  readonly attribute unsigned long heightReduction;
20422 
20437  readonly attribute IFramebufferOverlay overlay;
20438 
20445  readonly attribute long long winId;
20446 
20456 
20464  void notifyUpdate (
20465  in unsigned long x,
20466  in unsigned long y,
20467  in unsigned long width,
20468  in unsigned long height
20469  );
20470 
20480  void notifyUpdateImage (
20481  in unsigned long x,
20482  in unsigned long y,
20483  in unsigned long width,
20484  in unsigned long height,
20485  in octet[] image
20486  );
20487 
20505  void notifyChange (
20506  in unsigned long screenId,
20507  in unsigned long xOrigin,
20508  in unsigned long yOrigin,
20509  in unsigned long width,
20510  in unsigned long height
20511  );
20512 
20524  void videoModeSupported (
20525  in unsigned long width,
20526  in unsigned long height,
20527  in unsigned long bpp,
20528  [retval] out boolean supported
20529  );
20530 
20567  void getVisibleRegion (
20568  in octetPtr rectangles,
20569  in unsigned long count,
20570  [retval] out unsigned long countCopied
20571  );
20572 
20607  void setVisibleRegion (
20608  in octetPtr rectangles,
20609  in unsigned long count
20610  );
20611 
20632  void processVHWACommand (
20633  in octetPtr command
20634  );
20635 
20645  void notify3DEvent (
20646  in unsigned long type,
20647  in octet[] data
20648  );
20649 
20650 }; /* interface IFramebuffer */
20651 
20667 {
20671  readonly attribute unsigned long x;
20672 
20676  readonly attribute unsigned long y;
20677 
20683  attribute boolean visible;
20684 
20691  attribute unsigned long alpha;
20692 
20698  void move (
20699  in unsigned long x,
20700  in unsigned long y
20701  );
20702 
20703 }; /* interface IFramebufferOverlay */
20704 
20705 interface IGuestScreenInfo : $unknown
20706 {
20707  readonly attribute unsigned long screenId;
20708 
20710 
20711  readonly attribute boolean primary;
20712 
20713  readonly attribute boolean origin;
20714 
20715  readonly attribute long originX;
20716 
20717  readonly attribute long originY;
20718 
20719  readonly attribute unsigned long width;
20720 
20721  readonly attribute unsigned long height;
20722 
20723  readonly attribute unsigned long bitsPerPixel;
20724 
20725 }; /* interface IGuestScreenInfo */
20726 
20742 interface IDisplay : $unknown
20743 {
20749  readonly attribute IGuestScreenInfo[] guestScreenLayout;
20750 
20761  void getScreenResolution (
20762  in unsigned long screenId,
20763  out unsigned long width,
20764  out unsigned long height,
20765  out unsigned long bitsPerPixel,
20766  out long xOrigin,
20767  out long yOrigin,
20768  out GuestMonitorStatus guestMonitorStatus
20769  );
20770 
20776  void attachFramebuffer (
20777  in unsigned long screenId,
20778  in IFramebuffer framebuffer,
20779  [retval] out wstringUUID id
20780  );
20781 
20787  void detachFramebuffer (
20788  in unsigned long screenId,
20789  in wstringUUID id
20790  );
20791 
20797  void queryFramebuffer (
20798  in unsigned long screenId,
20799  [retval] out IFramebuffer framebuffer
20800  );
20801 
20864  void setVideoModeHint (
20865  in unsigned long display,
20866  in boolean enabled,
20867  in boolean changeOrigin,
20868  in long originX,
20869  in long originY,
20870  in unsigned long width,
20871  in unsigned long height,
20872  in unsigned long bitsPerPixel
20873  );
20874 
20886  void setSeamlessMode (
20887  in boolean enabled
20888  );
20889 
20911  void takeScreenShot (
20912  in unsigned long screenId,
20913  in octetPtr address,
20914  in unsigned long width,
20915  in unsigned long height,
20916  in BitmapFormat bitmapFormat
20917  );
20918 
20945  void takeScreenShotToArray (
20946  in unsigned long screenId,
20947  in unsigned long width,
20948  in unsigned long height,
20949  in BitmapFormat bitmapFormat,
20950  [retval] out octet[] screenData
20951  );
20952 
21004  void drawToScreen (
21005  in unsigned long screenId,
21006  in octetPtr address,
21007  in unsigned long x,
21008  in unsigned long y,
21009  in unsigned long width,
21010  in unsigned long height
21011  );
21012 
21027  void invalidateAndUpdate();
21028 
21039  in unsigned long screenId
21040  );
21041 
21054  void completeVHWACommand (
21055  in octetPtr command
21056  );
21057 
21091  void viewportChanged (
21092  in unsigned long screenId,
21093  in unsigned long x,
21094  in unsigned long y,
21095  in unsigned long width,
21096  in unsigned long height
21097  );
21098 
21104  void querySourceBitmap (
21105  in unsigned long screenId,
21106  out IDisplaySourceBitmap displaySourceBitmap
21107  );
21108 
21115  in unsigned long screenId,
21116  in unsigned long u32ScaleFactorWMultiplied,
21117  in unsigned long u32ScaleFactorHMultiplied
21118  );
21119 
21126  in boolean fUnscaledHiDPI
21127  );
21128 
21134  void setScreenLayout (
21135  in ScreenLayoutMode screenLayoutMode,
21136  in IGuestScreenInfo[] guestScreenInfo
21137  );
21138 
21139 }; /* interface IDisplay */
21140 
21156 interface INetworkAdapter : $unknown
21157 {
21166 
21174  readonly attribute unsigned long slot;
21175 
21184  attribute boolean enabled;
21185 
21194  attribute wstring MACAddress;
21195 
21202 
21208  attribute wstring bridgedInterface;
21209 
21215  attribute wstring hostOnlyInterface;
21216 
21222  attribute wstring internalNetwork;
21223 
21229  attribute wstring NATNetwork;
21230 
21236  attribute wstring genericDriver;
21237 
21244  attribute boolean cableConnected;
21245 
21251  attribute unsigned long lineSpeed;
21252 
21260 
21267  attribute boolean traceEnabled;
21268 
21275  attribute wstring traceFile;
21276 
21284  readonly attribute INATEngine NATEngine;
21285 
21292  attribute unsigned long bootPriority;
21293 
21298 
21317  void getProperty (
21318  in wstring key,
21319  [retval] out wstring value
21320  );
21321 
21340  void setProperty (
21341  in wstring key,
21342  in wstring value
21343  );
21344 
21372  void getProperties (
21373  in wstring names,
21374  out wstring[] returnNames,
21375  [retval] out wstring[] returnValues
21376  );
21377 
21378 }; /* interface INetworkAdapter */
21379 
21408 interface ISerialPort : $unknown
21409 {
21417  readonly attribute unsigned long slot;
21418 
21425  attribute boolean enabled;
21426 
21430  attribute unsigned long IOBase;
21431 
21435  attribute unsigned long IRQ;
21436 
21447  attribute PortMode hostMode;
21448 
21456  attribute boolean server;
21457 
21469  attribute wstring path;
21470 
21471 }; /* interface ISerialPort */
21472 
21492 interface IParallelPort : $unknown
21493 {
21501  readonly attribute unsigned long slot;
21502 
21509  attribute boolean enabled;
21510 
21514  attribute unsigned long IOBase;
21515 
21519  attribute unsigned long IRQ;
21520 
21528  attribute wstring path;
21529 
21530 }; /* interface IParallelPort */
21531 
21532 interface IMachineDebugger : $unknown
21533 {
21537  attribute boolean singleStep;
21538 
21542  attribute boolean recompileUser;
21543 
21547  attribute boolean recompileSupervisor;
21548 
21556  attribute boolean executeAllInIEM;
21557 
21561  attribute boolean PATMEnabled;
21562 
21566  attribute boolean CSAMEnabled;
21567 
21571  attribute boolean logEnabled;
21572 
21576  readonly attribute wstring logDbgFlags;
21577 
21581  readonly attribute wstring logDbgGroups;
21582 
21586  readonly attribute wstring logDbgDestinations;
21587 
21591  readonly attribute wstring logRelFlags;
21592 
21596  readonly attribute wstring logRelGroups;
21597 
21601  readonly attribute wstring logRelDestinations;
21602 
21609  readonly attribute boolean HWVirtExEnabled;
21610 
21617  readonly attribute boolean HWVirtExNestedPagingEnabled;
21618 
21625  readonly attribute boolean HWVirtExVPIDEnabled;
21626 
21633  readonly attribute boolean HWVirtExUXEnabled;
21634 
21643  readonly attribute wstring OSName;
21644 
21653  readonly attribute wstring OSVersion;
21654 
21661  readonly attribute boolean PAEEnabled;
21662 
21669  attribute unsigned long virtualTimeRate;
21670 
21678  readonly attribute long long VM;
21679 
21695  void dumpGuestCore (
21696  in wstring filename,
21697  in wstring compression
21698  );
21699 
21716  void dumpHostProcessCore (
21717  in wstring filename,
21718  in wstring compression
21719  );
21720 
21741  void info (
21742  in wstring name,
21743  in wstring args,
21744  [retval] out wstring info
21745  );
21746 
21752  void injectNMI();
21753 
21764  void modifyLogGroups (
21765  in wstring settings
21766  );
21767 
21778  void modifyLogFlags (
21779  in wstring settings
21780  );
21781 
21792  void modifyLogDestinations (
21793  in wstring settings
21794  );
21795 
21810  void readPhysicalMemory (
21811  in long long address,
21812  in unsigned long size,
21813  [retval] out octet[] bytes
21814  );
21815 
21830  void writePhysicalMemory (
21831  in long long address,
21832  in unsigned long size,
21833  in octet[] bytes
21834  );
21835 
21852  void readVirtualMemory (
21853  in unsigned long cpuId,
21854  in long long address,
21855  in unsigned long size,
21856  [retval] out octet[] bytes
21857  );
21858 
21875  void writeVirtualMemory (
21876  in unsigned long cpuId,
21877  in long long address,
21878  in unsigned long size,
21879  in octet[] bytes
21880  );
21881 
21889  void loadPlugIn (
21890  in wstring name,
21891  [retval] out wstring plugInName
21892  );
21893 
21899  void unloadPlugIn (
21900  in wstring name
21901  );
21902 
21915  void detectOS (
21916  [retval] out wstring os
21917  );
21918 
21932  void queryOSKernelLog (
21933  in unsigned long maxMessages,
21934  [retval] out wstring dmesg
21935  );
21936 
21951  void getRegister (
21952  in unsigned long cpuId,
21953  in wstring name,
21954  [retval] out wstring value
21955  );
21956 
21971  void getRegisters (
21972  in unsigned long cpuId,
21973  out wstring[] names,
21974  out wstring[] values
21975  );
21976 
21995  void setRegister (
21996  in unsigned long cpuId,
21997  in wstring name,
21998  in wstring value
21999  );
22000 
22019  void setRegisters (
22020  in unsigned long cpuId,
22021  in wstring[] names,
22022  in wstring[] values
22023  );
22024 
22037  void dumpGuestStack (
22038  in unsigned long cpuId,
22039  [retval] out wstring stack
22040  );
22041 
22049  void resetStats (
22050  in wstring pattern
22051  );
22052 
22060  void dumpStats (
22061  in wstring pattern
22062  );
22063 
22075  void getStats (
22076  in wstring pattern,
22077  in boolean withDescriptions,
22078  [retval] out wstring stats
22079  );
22080 
22081 }; /* interface IMachineDebugger */
22082 
22083 interface IUSBDeviceFilters : $unknown
22084 {
22110  readonly attribute IUSBDeviceFilter[] deviceFilters;
22111 
22139  void createDeviceFilter (
22140  in wstring name,
22141  [retval] out IUSBDeviceFilter filter
22142  );
22143 
22188  void insertDeviceFilter (
22189  in unsigned long position,
22190  in IUSBDeviceFilter filter
22191  );
22192 
22225  void removeDeviceFilter (
22226  in unsigned long position,
22227  [retval] out IUSBDeviceFilter filter
22228  );
22229 
22230 }; /* interface IUSBDeviceFilters */
22231 
22232 interface IUSBController : $unknown
22233 {
22239  attribute wstring name;
22240 
22247 
22255  readonly attribute unsigned short USBStandard;
22256 
22257 }; /* interface IUSBController */
22258 
22271 interface IUSBDevice : $unknown
22272 {
22279  readonly attribute wstringUUID id;
22280 
22284  readonly attribute unsigned short vendorId;
22285 
22289  readonly attribute unsigned short productId;
22290 
22298  readonly attribute unsigned short revision;
22299 
22303  readonly attribute wstring manufacturer;
22304 
22308  readonly attribute wstring product;
22309 
22313  readonly attribute wstring serialNumber;
22314 
22318  readonly attribute wstring address;
22319 
22326  readonly attribute unsigned short port;
22327 
22333  readonly attribute unsigned short version;
22334 
22342  readonly attribute unsigned short portVersion;
22343 
22349  readonly attribute USBConnectionSpeed speed;
22350 
22357  readonly attribute boolean remote;
22358 
22370  readonly attribute wstring[] deviceInfo;
22371 
22377  readonly attribute wstring backend;
22378 
22379 }; /* interface IUSBDevice */
22380 
22456 interface IUSBDeviceFilter : $unknown
22457 {
22465  attribute wstring name;
22466 
22470  attribute boolean active;
22471 
22479  attribute wstring vendorId;
22480 
22488  attribute wstring productId;
22489 
22503  attribute wstring revision;
22504 
22509  attribute wstring manufacturer;
22510 
22515  attribute wstring product;
22516 
22521  attribute wstring serialNumber;
22522 
22527  attribute wstring port;
22528 
22538  attribute wstring remote;
22539 
22549  attribute unsigned long maskedInterfaces;
22550 
22551 }; /* interface IUSBDeviceFilter */
22552 
22570 {
22576  readonly attribute USBDeviceState state;
22577 
22578 }; /* interface IHostUSBDevice */
22579 
22603 {
22611 
22612 }; /* interface IHostUSBDeviceFilter */
22613 
22622 interface IUSBProxyBackend : $unknown
22623 {
22629  readonly attribute wstring name;
22630 
22636  readonly attribute wstring type;
22637 
22638 }; /* interface IUSBProxyBackend */
22639 
22648 interface IAudioAdapter : $unknown
22649 {
22658  attribute boolean enabled;
22659 
22666  attribute boolean enabledIn;
22667 
22674  attribute boolean enabledOut;
22675 
22682 
22692 
22700 
22706  readonly attribute wstring[] propertiesList;
22707 
22721  void setProperty (
22722  in wstring key,
22723  in wstring value
22724  );
22725 
22739  void getProperty (
22740  in wstring key,
22741  [retval] out wstring value
22742  );
22743 
22744 }; /* interface IAudioAdapter */
22745 
22746 interface IVRDEServer : $unknown
22747 {
22751  attribute boolean enabled;
22752 
22756  attribute AuthType authType;
22757 
22761  attribute unsigned long authTimeout;
22762 
22769  attribute boolean allowMultiConnection;
22770 
22778  attribute boolean reuseSingleConnection;
22779 
22786  attribute wstring VRDEExtPack;
22787 
22794  attribute wstring authLibrary;
22795 
22801  readonly attribute wstring[] VRDEProperties;
22802 
22816  void setVRDEProperty (
22817  in wstring key,
22818  in wstring value
22819  );
22820 
22834  void getVRDEProperty (
22835  in wstring key,
22836  [retval] out wstring value
22837  );
22838 
22839 }; /* interface IVRDEServer */
22840 
22900 interface ISharedFolder : $unknown
22901 {
22905  readonly attribute wstring name;
22906 
22910  readonly attribute wstring hostPath;
22911 
22921  readonly attribute boolean accessible;
22922 
22929  readonly attribute boolean writable;
22930 
22936  readonly attribute boolean autoMount;
22937 
22950  readonly attribute wstring lastAccessError;
22951 
22952 }; /* interface ISharedFolder */
22953 
22954 interface IInternalSessionControl : $unknown
22955 {
22960  readonly attribute unsigned long PID;
22961 
22983  readonly attribute IConsole remoteConsole;
22984 
22991  readonly attribute MachineState nominalState;
22992 
23007  void assignRemoteMachine (
23008  in IMachine machine,
23009  in IConsole console
23010  );
23011 
23035  void updateMachineState (
23036  in MachineState machineState
23037  );
23038 
23054  void uninitialize();
23055 
23078  void onNetworkAdapterChange (
23079  in INetworkAdapter networkAdapter,
23080  in boolean changeAdapter
23081  );
23082 
23105  void onSerialPortChange (
23106  in ISerialPort serialPort
23107  );
23108 
23131  void onParallelPortChange (
23132  in IParallelPort parallelPort
23133  );
23134 
23158 
23185  void onMediumChange (
23186  in IMediumAttachment mediumAttachment,
23187  in boolean force
23188  );
23189 
23219  void onStorageDeviceChange (
23220  in IMediumAttachment mediumAttachment,
23221  in boolean remove,
23222  in boolean silent
23223  );
23224 
23232  void onClipboardModeChange (
23233  in ClipboardMode clipboardMode
23234  );
23235 
23243  void onDnDModeChange (
23244  in DnDMode dndMode
23245  );
23246 
23256  void onCPUChange (
23257  in unsigned long cpu,
23258  in boolean add
23259  );
23260 
23269  in unsigned long executionCap
23270  );
23271 
23296  void onVRDEServerChange (
23297  in boolean restart
23298  );
23299 
23305  void onVideoCaptureChange();
23306 
23329  void onUSBControllerChange();
23330 
23359  void onSharedFolderChange (
23360  in boolean global
23361  );
23362 
23388  void onUSBDeviceAttach (
23389  in IUSBDevice device,
23390  in IVirtualBoxErrorInfo error,
23391  in unsigned long maskedInterfaces,
23392  in wstring captureFilename
23393  );
23394 
23420  void onUSBDeviceDetach (
23421  in wstringUUID id,
23422  in IVirtualBoxErrorInfo error
23423  );
23424 
23442  void onShowWindow (
23443  in boolean check,
23444  out boolean canShow,
23445  out long long winId
23446  );
23447 
23455  void onBandwidthGroupChange (
23456  in IBandwidthGroup bandwidthGroup
23457  );
23458 
23484  void accessGuestProperty (
23485  in wstring name,
23486  in wstring value,
23487  in wstring flags,
23488  in unsigned long accessMode,
23489  out wstring retValue,
23490  out long long retTimestamp,
23491  out wstring retFlags
23492  );
23493 
23542  in wstring patterns,
23543  out wstring[] keys,
23544  out wstring[] values,
23545  out long long[] timestamps,
23546  out wstring[] flags
23547  );
23548 
23583  void onlineMergeMedium (
23584  in IMediumAttachment mediumAttachment,
23585  in unsigned long sourceIdx,
23586  in unsigned long targetIdx,
23587  in IProgress progress
23588  );
23589 
23616  in IMediumAttachment[] attachments
23617  );
23618 
23642  void enableVMMStatistics (
23643  in boolean enable
23644  );
23645 
23673  void pauseWithReason (
23674  in Reason reason
23675  );
23676 
23704  void resumeWithReason (
23705  in Reason reason
23706  );
23707 
23749  void saveStateWithReason (
23750  in Reason reason,
23751  in IProgress progress,
23752  in wstring stateFilePath,
23753  in boolean pauseVM,
23754  [retval] out boolean leftPaused
23755  );
23756 
23765 
23789  void assignMachine (
23790  in IMachine machine,
23791  in LockType lockType,
23792  in wstring tokenId
23793  );
23794 
23818  void assignMachine (
23819  in IMachine machine,
23820  in LockType lockType,
23821  in IToken token
23822  );
23823 
23824 }; /* interface IInternalSessionControl */
23825 
23886 interface ISession : $unknown
23887 {
23891  readonly attribute SessionState state;
23892 
23900  readonly attribute SessionType type;
23901 
23912  attribute wstring name;
23913 
23917  readonly attribute IMachine machine;
23918 
23923  readonly attribute IConsole console;
23924 
23956  void unlockMachine();
23957 
23958 }; /* interface ISession */
23959 
23982 interface IStorageController : $unknown
23983 {
23992  attribute wstring name;
23993 
23999  readonly attribute unsigned long maxDevicesPerPortCount;
24000 
24006  readonly attribute unsigned long minPortCount;
24007 
24013  readonly attribute unsigned long maxPortCount;
24014 
24020  attribute unsigned long instance;
24021 
24030  attribute unsigned long portCount;
24031 
24037  readonly attribute StorageBus bus;
24038 
24052 
24067  attribute boolean useHostIOCache;
24068 
24074  readonly attribute boolean bootable;
24075 
24076 }; /* interface IStorageController */
24077 
24101 interface IManagedObjectRef : $unknown
24102 {
24109  void getInterfaceName (
24110  [retval] out wstring return
24111  );
24112 
24120  void release();
24121 
24122 }; /* interface IManagedObjectRef */
24123 
24132 interface IWebsessionManager : $unknown
24133 {
24142  void logon (
24143  in wstring username,
24144  in wstring password,
24145  [retval] out IVirtualBox return
24146  );
24147 
24157  void getSessionObject (
24158  in IVirtualBox refIVirtualBox,
24159  [retval] out ISession return
24160  );
24161 
24170  void logoff (
24171  in IVirtualBox refIVirtualBox
24172  );
24173 
24174 }; /* interface IWebsessionManager */
24175 
24184 interface IPerformanceMetric : $unknown
24185 {
24191  readonly attribute wstring metricName;
24192 
24198  readonly attribute $unknown object;
24199 
24205  readonly attribute wstring description;
24206 
24212  readonly attribute unsigned long period;
24213 
24223  readonly attribute unsigned long count;
24224 
24230  readonly attribute wstring unit;
24231 
24237  readonly attribute long minimumValue;
24238 
24244  readonly attribute long maximumValue;
24245 
24246 }; /* interface IPerformanceMetric */
24247 
24358 interface IPerformanceCollector : $unknown
24359 {
24370  readonly attribute wstring[] metricNames;
24371 
24395  void getMetrics (
24396  in wstring[] metricNames,
24397  in $unknown[] objects,
24398  [retval] out IPerformanceMetric[] metrics
24399  );
24400 
24439  void setupMetrics (
24440  in wstring[] metricNames,
24441  in $unknown[] objects,
24442  in unsigned long period,
24443  in unsigned long count,
24444  [retval] out IPerformanceMetric[] affectedMetrics
24445  );
24446 
24475  void enableMetrics (
24476  in wstring[] metricNames,
24477  in $unknown[] objects,
24478  [retval] out IPerformanceMetric[] affectedMetrics
24479  );
24480 
24509  void disableMetrics (
24510  in wstring[] metricNames,
24511  in $unknown[] objects,
24512  [retval] out IPerformanceMetric[] affectedMetrics
24513  );
24514 
24604  void queryMetricsData (
24605  in wstring[] metricNames,
24606  in $unknown[] objects,
24607  out wstring[] returnMetricNames,
24608  out $unknown[] returnObjects,
24609  out wstring[] returnUnits,
24610  out unsigned long[] returnScales,
24611  out unsigned long[] returnSequenceNumbers,
24612  out unsigned long[] returnDataIndices,
24613  out unsigned long[] returnDataLengths,
24614  [retval] out long[] returnData
24615  );
24616 
24617 }; /* interface IPerformanceCollector */
24618 
24626 interface INATEngine : $unknown
24627 {
24632  attribute wstring network;
24633 
24640  attribute wstring hostIP;
24641 
24646  attribute wstring TFTPPrefix;
24647 
24652  attribute wstring TFTPBootFile;
24653 
24661  attribute wstring TFTPNextServer;
24662 
24666  attribute unsigned long aliasMode;
24667 
24671  attribute boolean DNSPassDomain;
24672 
24677  attribute boolean DNSProxy;
24678 
24683  attribute boolean DNSUseHostResolver;
24684 
24689  readonly attribute wstring[] redirects;
24690 
24706  void setNetworkSettings (
24707  in unsigned long mtu,
24708  in unsigned long sockSnd,
24709  in unsigned long sockRcv,
24710  in unsigned long TcpWndSnd,
24711  in unsigned long TcpWndRcv
24712  );
24713 
24718  void getNetworkSettings (
24719  out unsigned long mtu,
24720  out unsigned long sockSnd,
24721  out unsigned long sockRcv,
24722  out unsigned long TcpWndSnd,
24723  out unsigned long TcpWndRcv
24724  );
24725 
24745  void addRedirect (
24746  in wstring name,
24747  in NATProtocol proto,
24748  in wstring hostIP,
24749  in unsigned short hostPort,
24750  in wstring guestIP,
24751  in unsigned short guestPort
24752  );
24753 
24759  void removeRedirect (
24760  in wstring name
24761  );
24762 
24763 }; /* interface INATEngine */
24764 
24773 interface IExtPackPlugIn : $unknown
24774 {
24778  readonly attribute wstring name;
24779 
24783  readonly attribute wstring description;
24784 
24790  readonly attribute wstring frontend;
24791 
24795  readonly attribute wstring modulePath;
24796 
24797 }; /* interface IExtPackPlugIn */
24798 
24807 interface IExtPackBase : $unknown
24808 {
24812  readonly attribute wstring name;
24813 
24817  readonly attribute wstring description;
24818 
24830  readonly attribute wstring version;
24831 
24835  readonly attribute unsigned long revision;
24836 
24846  readonly attribute wstring edition;
24847 
24851  readonly attribute wstring VRDEModule;
24852 
24856  readonly attribute IExtPackPlugIn[] plugIns;
24857 
24867  readonly attribute boolean usable;
24868 
24875  readonly attribute wstring whyUnusable;
24876 
24880  readonly attribute boolean showLicense;
24881 
24890  readonly attribute wstring license;
24891 
24915  void queryLicense (
24916  in wstring preferredLocale,
24917  in wstring preferredLanguage,
24918  in wstring format,
24919  [retval] out wstring licenseText
24920  );
24921 
24922 }; /* interface IExtPackBase */
24923 
24933 {
24945  void queryObject (
24946  in wstring objUuid,
24947  [retval] out $unknown returnInterface
24948  );
24949 
24950 }; /* interface IExtPack */
24951 
24962 {
24968  readonly attribute wstring filePath;
24969 
24988  void install (
24989  in boolean replace,
24990  in wstring displayInfo,
24991  [retval] out IProgress progess
24992  );
24993 
24994 }; /* interface IExtPackFile */
24995 
25005 interface IExtPackManager : $unknown
25006 {
25012  readonly attribute IExtPack[] installedExtPacks;
25013 
25031  void find (
25032  in wstring name,
25033  [retval] out IExtPack returnData
25034  );
25035 
25047  void openExtPackFile (
25048  in wstring path,
25049  [retval] out IExtPackFile file
25050  );
25051 
25070  void uninstall (
25071  in wstring name,
25072  in boolean forcedRemoval,
25073  in wstring displayInfo,
25074  [retval] out IProgress progess
25075  );
25076 
25080  void cleanup();
25081 
25095  in wstring frontendName,
25096  [retval] out wstring[] plugInModules
25097  );
25098 
25106  void isExtPackUsable (
25107  in wstring name,
25108  [retval] out boolean usable
25109  );
25110 
25111 }; /* interface IExtPackManager */
25112 
25118 interface IBandwidthGroup : $unknown
25119 {
25123  readonly attribute wstring name;
25124 
25128  readonly attribute BandwidthGroupType type;
25129 
25133  readonly attribute unsigned long reference;
25134 
25139  attribute long long maxBytesPerSec;
25140 
25141 }; /* interface IBandwidthGroup */
25142 
25151 interface IBandwidthControl : $unknown
25152 {
25158  readonly attribute unsigned long numGroups;
25159 
25172  void createBandwidthGroup (
25173  in wstring name,
25174  in BandwidthGroupType type,
25175  in long long maxBytesPerSec
25176  );
25177 
25185  void deleteBandwidthGroup (
25186  in wstring name
25187  );
25188 
25198  void getBandwidthGroup (
25199  in wstring name,
25200  [retval] out IBandwidthGroup bandwidthGroup
25201  );
25202 
25210  void getAllBandwidthGroups (
25211  [retval] out IBandwidthGroup[] bandwidthGroups
25212  );
25213 
25214 }; /* interface IBandwidthControl */
25215 
25234 interface IVirtualBoxClient : $unknown
25235 {
25241  readonly attribute IVirtualBox virtualBox;
25242 
25248  readonly attribute ISession session;
25249 
25255  readonly attribute IEventSource eventSource;
25256 
25267  void checkMachineError (
25268  in IMachine machine
25269  );
25270 
25271 }; /* interface IVirtualBoxClient */
25272 
25286 interface IEventSource : $unknown
25287 {
25293  void createListener (
25294  [retval] out IEventListener listener
25295  );
25296 
25312  void createAggregator (
25313  in IEventSource[] subordinates,
25314  [retval] out IEventSource result
25315  );
25316 
25349  void registerListener (
25350  in IEventListener listener,
25351  in VBoxEventType[] interesting,
25352  in boolean active
25353  );
25354 
25363  void unregisterListener (
25364  in IEventListener listener
25365  );
25366 
25381  void fireEvent (
25382  in IEvent event,
25383  in long timeout,
25384  [retval] out boolean result
25385  );
25386 
25411  void getEvent (
25412  in IEventListener listener,
25413  in long timeout,
25414  [retval] out IEvent event
25415  );
25416 
25428  void eventProcessed (
25429  in IEventListener listener,
25430  in IEvent event
25431  );
25432 
25433 }; /* interface IEventSource */
25434 
25444 interface IEventListener : $unknown
25445 {
25458  void handleEvent (
25459  in IEvent event
25460  );
25461 
25462 }; /* interface IEventListener */
25463 
25541 interface IEvent : $unknown
25542 {
25548  readonly attribute VBoxEventType type;
25549 
25555  readonly attribute IEventSource source;
25556 
25567  readonly attribute boolean waitable;
25568 
25575  void setProcessed();
25576 
25590  void waitProcessed (
25591  in long timeout,
25592  [retval] out boolean result
25593  );
25594 
25595 }; /* interface IEvent */
25596 
25603 {
25607  readonly attribute unsigned long generation;
25608 
25615  void reuse();
25616 
25617 }; /* interface IReusableEvent */
25618 
25625 {
25629  readonly attribute wstringUUID machineId;
25630 
25631 }; /* interface IMachineEvent */
25632 
25639 {
25643  readonly attribute MachineState state;
25644 
25645 }; /* interface IMachineStateChangedEvent */
25646 
25655 {
25662  readonly attribute boolean temporary;
25663 
25664 }; /* interface IMachineDataChangedEvent */
25665 
25677 {
25681  readonly attribute wstringUUID mediumId;
25682 
25686  readonly attribute DeviceType mediumType;
25687 
25694  readonly attribute boolean registered;
25695 
25696 }; /* interface IMediumRegisteredEvent */
25697 
25709 {
25713  readonly attribute IMedium medium;
25714 
25715 }; /* interface IMediumConfigChangedEvent */
25716 
25726 {
25733  readonly attribute boolean registered;
25734 
25735 }; /* interface IMachineRegisteredEvent */
25736 
25747 {
25753  readonly attribute SessionState state;
25754 
25755 }; /* interface ISessionStateChangedEvent */
25756 
25765 {
25771  readonly attribute wstring name;
25772 
25778  readonly attribute wstring value;
25779 
25785  readonly attribute wstring flags;
25786 
25787 }; /* interface IGuestPropertyChangedEvent */
25788 
25795 {
25799  readonly attribute wstringUUID snapshotId;
25800 
25801 }; /* interface ISnapshotEvent */
25802 
25813 {
25814  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25815 
25816 }; /* interface ISnapshotTakenEvent */
25817 
25835 {
25836  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25837 
25838 }; /* interface ISnapshotDeletedEvent */
25839 
25850 {
25851  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25852 
25853 }; /* interface ISnapshotRestoredEvent */
25854 
25865 {
25866  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25867 
25868 }; /* interface ISnapshotChangedEvent */
25869 
25879 {
25885  readonly attribute boolean visible;
25886 
25892  readonly attribute boolean alpha;
25893 
25899  readonly attribute unsigned long xhot;
25900 
25906  readonly attribute unsigned long yhot;
25907 
25913  readonly attribute unsigned long width;
25914 
25920  readonly attribute unsigned long height;
25921 
25954  readonly attribute octet[] shape;
25955 
25956 }; /* interface IMousePointerShapeChangedEvent */
25957 
25967 {
25973  readonly attribute boolean supportsAbsolute;
25974 
25980  readonly attribute boolean supportsRelative;
25981 
25987  readonly attribute boolean supportsMultiTouch;
25988 
25994  readonly attribute boolean needsHostCursor;
2