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 {
350 };
351 
360 {
363 };
364 
478 {
698 };
699 
710 {
758 };
759 
769 {
855 };
856 
867 {
917 };
918 
928 {
960 };
961 
970 {
986 };
987 
996 {
1024 };
1025 
1035 {
1063 };
1064 
1073 {
1117 };
1118 
1127 {
1132 };
1133 
1142 {
1147 };
1148 
1157 {
1162 };
1163 
1174 enum Scope
1175 {
1179 };
1180 
1189 {
1193 };
1194 
1204 {
1208 };
1209 
1218 {
1223 };
1224 
1233 {
1259 };
1260 
1269 {
1308 };
1309 
1318 {
1340 };
1341 
1351 {
1375  BitmapFormat_BGR = 0x20524742,
1382  BitmapFormat_BGR0 = 0x30524742,
1389  BitmapFormat_BGRA = 0x41524742,
1396  BitmapFormat_RGBA = 0x41424752,
1403  BitmapFormat_PNG = 0x20474E50,
1410  BitmapFormat_JPEG = 0x4745504A,
1411 };
1412 
1414 {
1478 };
1479 
1481 {
1484 };
1485 
1494 {
1499 };
1500 
1509 {
1525 };
1526 
1535 {
1564 };
1565 
1574 {
1579 };
1580 
1588 {
1617 };
1618 
1626 {
1631 };
1632 
1640 {
1656 };
1657 
1665 {
1686 };
1687 
1696 {
1712 };
1713 
1722 {
1743 };
1744 
1753 {
1774 };
1775 
1787 {
1816 };
1817 
1828 {
1850 };
1851 
1860 {
1863 };
1864 
1873 {
1923 };
1924 
1933 {
1969 };
1970 
1979 {
2025 };
2026 
2035 {
2056 };
2057 
2066 {
2080 };
2081 
2091 {
2137 };
2138 
2147 {
2168 };
2169 
2184 {
2230 };
2231 
2240 {
2390 };
2391 
2400 {
2417 };
2418 
2427 {
2438 };
2439 
2449 {
2460 };
2461 
2470 {
2501 };
2502 
2522 {
2582 };
2583 
2594 {
2628 };
2629 
2638 {
2669 };
2670 
2679 {
2690 };
2691 
2702 {
2713 };
2714 
2729 {
2745 };
2746 
2756 {
2768 };
2769 
2782 {
2841 };
2842 
2851 {
2862 };
2863 
2873 {
2889 };
2890 
2899 {
2910 };
2911 
2920 {
2981 };
2982 
2991 {
3017 };
3018 
3028 {
3048 };
3049 
3059 {
3093 };
3094 
3104 {
3149 };
3150 
3159 {
3195 };
3196 
3205 {
3211 };
3212 
3221 {
3257 };
3258 
3267 {
3315 };
3316 
3325 {
3346 };
3347 
3356 {
3367 };
3368 
3379 {
3437 };
3438 
3450 {
3505 };
3506 
3517 {
3583 };
3584 
3586 {
3590 };
3591 
3593 {
3599 };
3600 
3609 {
3701 };
3702 
3711 {
3715 };
3716 
3725 {
3734 };
3735 
3744 {
3763 };
3764 
3773 {
3795 };
3796 
3805 {
3827 };
3828 
3837 {
3859 };
3860 
3869 {
3881 };
3882 
3891 {
3927 };
3928 
3937 {
3959 };
3960 
3970 {
3996 };
3997 
4006 {
4020 };
4021 
4042 {
4085 };
4086 
4126 {
4173 };
4174 
4185 {
4201 };
4202 
4211 {
4257 };
4258 
4267 {
4271 };
4272 
4282 {
4308 };
4309 
4318 {
4326 };
4327 
4336 {
4362 };
4363 
4373 {
4386 };
4387 
4397 {
4453 };
4454 
4463 {
4479 };
4480 
4487 {
4503 };
4504 
4511 {
4522 };
4523 
4532 {
4554 };
4555 
4565 {
5107 };
5108 
5122 {
5137 };
5138 
5147 {
5169 };
5170 
5204 interface IVirtualBoxErrorInfo : $errorinfo
5205 {
5223  readonly attribute long resultCode;
5224 
5231  readonly attribute long resultDetail;
5232 
5244  readonly attribute wstringUUID interfaceID;
5245 
5256  readonly attribute wstring component;
5257 
5268  readonly attribute wstring text;
5269 
5280  readonly attribute IVirtualBoxErrorInfo next;
5281 
5282 }; /* interface IVirtualBoxErrorInfo */
5283 
5284 interface INATNetwork : $unknown
5285 {
5294  attribute wstring networkName;
5295 
5296  attribute boolean enabled;
5297 
5306  attribute wstring network;
5307 
5314  readonly attribute wstring gateway;
5315 
5321  attribute boolean IPv6Enabled;
5322 
5330  attribute wstring IPv6Prefix;
5331 
5333 
5334  attribute boolean needDhcpServer;
5335 
5336  readonly attribute IEventSource eventSource;
5337 
5344  readonly attribute wstring[] portForwardRules4;
5345 
5350  readonly attribute wstring[] localMappings;
5351 
5356  attribute long loopbackIp6;
5357 
5363  readonly attribute wstring[] portForwardRules6;
5364 
5368  void addLocalMapping (
5369  in wstring hostid,
5370  in long offset
5371  );
5372 
5373  void addPortForwardRule (
5374  in boolean isIpv6,
5375  in wstring ruleName,
5376  in NATProtocol proto,
5377  in wstring hostIP,
5378  in unsigned short hostPort,
5379  in wstring guestIP,
5380  in unsigned short guestPort
5381  );
5382 
5383  void removePortForwardRule (
5384  in boolean iSipv6,
5385  in wstring ruleName
5386  );
5387 
5388  void start (
5389  in wstring trunkType
5390  );
5391 
5392  void stop();
5393 
5394 }; /* interface INATNetwork */
5395 
5406 interface IDHCPServer : $unknown
5407 {
5408  readonly attribute IEventSource eventSource;
5409 
5415  attribute boolean enabled;
5416 
5422  readonly attribute wstring IPAddress;
5423 
5429  readonly attribute wstring networkMask;
5430 
5436  readonly attribute wstring networkName;
5437 
5443  readonly attribute wstring lowerIP;
5444 
5450  readonly attribute wstring upperIP;
5451 
5452  readonly attribute wstring[] globalOptions;
5453 
5454  readonly attribute wstring[] vmConfigs;
5455 
5456  void addGlobalOption (
5457  in DhcpOpt option,
5458  in wstring value
5459  );
5460 
5461  void addVmSlotOption (
5462  in wstring vmname,
5463  in long slot,
5464  in DhcpOpt option,
5465  in wstring value
5466  );
5467 
5468  void removeVmSlotOptions (
5469  in wstring vmname,
5470  in long slot
5471  );
5472 
5473  void getVmSlotOptions (
5474  in wstring vmname,
5475  in long slot,
5476  [retval] out wstring[] option
5477  );
5478 
5479  void getMacOptions (
5480  in wstring mac,
5481  [retval] out wstring[] option
5482  );
5483 
5512  void setConfiguration (
5513  in wstring IPAddress,
5514  in wstring networkMask,
5515  in wstring FromIPAddress,
5516  in wstring ToIPAddress
5517  );
5518 
5543  void start (
5544  in wstring networkName,
5545  in wstring trunkName,
5546  in wstring trunkType
5547  );
5548 
5561  void stop();
5562 
5563 }; /* interface IDHCPServer */
5564 
5589 interface IVirtualBox : $unknown
5590 {
5603  readonly attribute wstring version;
5604 
5612  readonly attribute wstring versionNormalized;
5613 
5619  readonly attribute unsigned long revision;
5620 
5630  readonly attribute wstring packageType;
5631 
5643  readonly attribute wstring APIVersion;
5644 
5652  readonly attribute long long APIRevision;
5653 
5669  readonly attribute wstring homeFolder;
5670 
5678  readonly attribute wstring settingsFilePath;
5679 
5683  readonly attribute IHost host;
5684 
5689 
5695  readonly attribute IMachine[] machines;
5696 
5706  readonly attribute wstring[] machineGroups;
5707 
5717  readonly attribute IMedium[] hardDisks;
5718 
5724  readonly attribute IMedium[] DVDImages;
5725 
5731  readonly attribute IMedium[] floppyImages;
5732 
5733  readonly attribute IProgress[] progressOperations;
5734 
5735  readonly attribute IGuestOSType[] guestOSTypes;
5736 
5753  readonly attribute ISharedFolder[] sharedFolders;
5754 
5761 
5767  readonly attribute IDHCPServer[] DHCPServers;
5768 
5769  readonly attribute INATNetwork[] NATNetworks;
5770 
5776  readonly attribute IEventSource eventSource;
5777 
5784 
5790  readonly attribute wstring[] internalNetworks;
5791 
5797  readonly attribute wstring[] genericNetworkDrivers;
5798 
5850  void composeMachineFilename (
5851  in wstring name,
5852  in wstring group,
5853  in wstring createFlags,
5854  in wstring baseFolder,
5855  [retval] out wstring file
5856  );
5857 
5965  void createMachine (
5966  in wstring settingsFile,
5967  in wstring name,
5968  in wstring[] groups,
5969  in wstring osTypeId,
5970  in wstring flags,
5971  [retval] out IMachine machine
5972  );
5973 
6004  void openMachine (
6005  in wstring settingsFile,
6006  [retval] out IMachine machine
6007  );
6008 
6040  void registerMachine (
6041  in IMachine machine
6042  );
6043 
6064  void findMachine (
6065  in wstring nameOrId,
6066  [retval] out IMachine machine
6067  );
6068 
6080  void getMachinesByGroups (
6081  in wstring[] groups,
6082  [retval] out IMachine[] machines
6083  );
6084 
6094  void getMachineStates (
6095  in IMachine[] machines,
6096  [retval] out MachineState[] states
6097  );
6098 
6108  void createAppliance (
6109  [retval] out IAppliance appliance
6110  );
6111 
6121  void createUnattendedInstaller (
6122  [retval] out IUnattended unattended
6123  );
6124 
6210  void createMedium (
6211  in wstring format,
6212  in wstring location,
6213  in AccessMode accessMode,
6214  in DeviceType aDeviceTypeType,
6215  [retval] out IMedium medium
6216  );
6217 
6324  void openMedium (
6325  in wstring location,
6326  in DeviceType deviceType,
6327  in AccessMode accessMode,
6328  in boolean forceNewUuid,
6329  [retval] out IMedium medium
6330  );
6331 
6360  void getGuestOSType (
6361  in wstring id,
6362  [retval] out IGuestOSType type
6363  );
6364 
6387  void createSharedFolder (
6388  in wstring name,
6389  in wstring hostPath,
6390  in boolean writable,
6391  in boolean automount
6392  );
6393 
6408  void removeSharedFolder (
6409  in wstring name
6410  );
6411 
6420  void getExtraDataKeys (
6421  [retval] out wstring[] keys
6422  );
6423 
6452  void getExtraData (
6453  in wstring key,
6454  [retval] out wstring value
6455  );
6456 
6506  void setExtraData (
6507  in wstring key,
6508  in wstring value
6509  );
6510 
6529  void setSettingsSecret (
6530  in wstring password
6531  );
6532 
6549  void createDHCPServer (
6550  in wstring name,
6551  [retval] out IDHCPServer server
6552  );
6553 
6570  void findDHCPServerByNetworkName (
6571  in wstring name,
6572  [retval] out IDHCPServer server
6573  );
6574 
6589  void removeDHCPServer (
6590  in IDHCPServer server
6591  );
6592 
6593  void createNATNetwork (
6594  in wstring networkName,
6595  [retval] out INATNetwork network
6596  );
6597 
6598  void findNATNetworkByName (
6599  in wstring networkName,
6600  [retval] out INATNetwork network
6601  );
6602 
6603  void removeNATNetwork (
6604  in INATNetwork network
6605  );
6606 
6631  void checkFirmwarePresent (
6632  in FirmwareType firmwareType,
6633  in wstring version,
6634  out wstring url,
6635  out wstring file,
6636  [retval] out boolean result
6637  );
6638 
6639 }; /* interface IVirtualBox */
6640 
6651 interface IVFSExplorer : $unknown
6652 {
6656  readonly attribute wstring path;
6657 
6661  readonly attribute VFSType type;
6662 
6670  void update (
6671  [retval] out IProgress progress
6672  );
6673 
6681  void cd (
6682  in wstring dir,
6683  [retval] out IProgress progress
6684  );
6685 
6691  void cdUp (
6692  [retval] out IProgress progress
6693  );
6694 
6707  void entryList (
6708  out wstring[] names,
6709  out unsigned long[] types,
6710  out long long[] sizes,
6711  out unsigned long[] modes
6712  );
6713 
6722  void exists (
6723  in wstring[] names,
6724  [retval] out wstring[] exists
6725  );
6726 
6734  void remove (
6735  in wstring[] names,
6736  [retval] out IProgress progress
6737  );
6738 
6739 }; /* interface IVFSExplorer */
6740 
6748 interface ICertificate : $unknown
6749 {
6753  readonly attribute CertificateVersion versionNumber;
6754 
6758  readonly attribute wstring serialNumber;
6759 
6763  readonly attribute wstring signatureAlgorithmOID;
6764 
6768  readonly attribute wstring signatureAlgorithmName;
6769 
6776  readonly attribute wstring[] issuerName;
6777 
6781  readonly attribute wstring[] subjectName;
6782 
6786  readonly attribute wstring friendlyName;
6787 
6791  readonly attribute wstring validityPeriodNotBefore;
6792 
6796  readonly attribute wstring validityPeriodNotAfter;
6797 
6801  readonly attribute wstring publicKeyAlgorithmOID;
6802 
6806  readonly attribute wstring publicKeyAlgorithm;
6807 
6811  readonly attribute octet[] subjectPublicKey;
6812 
6816  readonly attribute wstring issuerUniqueIdentifier;
6817 
6821  readonly attribute wstring subjectUniqueIdentifier;
6822 
6828  readonly attribute boolean certificateAuthority;
6829 
6833  readonly attribute unsigned long keyUsage;
6834 
6838  readonly attribute wstring[] extendedKeyUsage;
6839 
6843  readonly attribute octet[] rawCertData;
6844 
6848  readonly attribute boolean selfSigned;
6849 
6853  readonly attribute boolean trusted;
6854 
6858  readonly attribute boolean expired;
6859 
6865  void isCurrentlyExpired (
6866  [retval] out boolean result
6867  );
6868 
6872  void queryInfo (
6873  in long what,
6874  [retval] out wstring result
6875  );
6876 
6877 }; /* interface ICertificate */
6878 
6947 interface IAppliance : $unknown
6948 {
6956  readonly attribute wstring path;
6957 
6989  readonly attribute wstring[] disks;
6990 
6999 
7007  readonly attribute wstring[] machines;
7008 
7015  readonly attribute ICertificate certificate;
7016 
7033  void read (
7034  in wstring file,
7035  [retval] out IProgress progress
7036  );
7037 
7054  void interpret();
7055 
7078  void importMachines (
7079  in ImportOptions[] options,
7080  [retval] out IProgress progress
7081  );
7082 
7090  void createVFSExplorer (
7091  in wstring URI,
7092  [retval] out IVFSExplorer explorer
7093  );
7094 
7125  void write (
7126  in wstring format,
7127  in ExportOptions[] options,
7128  in wstring path,
7129  [retval] out IProgress progress
7130  );
7131 
7137  void getWarnings (
7138  [retval] out wstring[] warnings
7139  );
7140 
7149  void getPasswordIds (
7150  [retval] out wstring[] identifiers
7151  );
7152 
7162  void getMediumIdsForPasswordId (
7163  in wstring passwordId,
7164  [retval] out wstringUUID[] identifiers
7165  );
7166 
7177  void addPasswords (
7178  in wstring[] identifiers,
7179  in wstring[] passwords
7180  );
7181 
7182 }; /* interface IAppliance */
7183 
7195 interface IVirtualSystemDescription : $unknown
7196 {
7200  readonly attribute unsigned long count;
7201 
7326  void getDescription (
7327  out VirtualSystemDescriptionType[] types,
7328  out wstring[] refs,
7329  out wstring[] OVFValues,
7330  out wstring[] VBoxValues,
7331  out wstring[] extraConfigValues
7332  );
7333 
7350  void getDescriptionByType (
7352  out VirtualSystemDescriptionType[] types,
7353  out wstring[] refs,
7354  out wstring[] OVFValues,
7355  out wstring[] VBoxValues,
7356  out wstring[] extraConfigValues
7357  );
7358 
7370  void getValuesByType (
7373  [retval] out wstring[] values
7374  );
7375 
7401  void setFinalValues (
7402  in boolean[] enabled,
7403  in wstring[] VBoxValues,
7404  in wstring[] extraConfigValues
7405  );
7406 
7421  void addDescription (
7423  in wstring VBoxValue,
7424  in wstring extraConfigValue
7425  );
7426 
7427 }; /* interface IVirtualSystemDescription */
7428 
7459 interface IUnattended : $unknown
7460 {
7466  attribute wstring isoPath;
7467 
7476  attribute IMachine machine;
7477 
7483  attribute wstring user;
7484 
7491  attribute wstring password;
7492 
7500  attribute wstring fullUserName;
7501 
7507  attribute wstring productKey;
7508 
7518  attribute wstring additionsIsoPath;
7519 
7529  attribute boolean installGuestAdditions;
7530 
7537  attribute wstring validationKitIsoPath;
7538 
7548  attribute boolean installTestExecService;
7549 
7573  attribute wstring timeZone;
7574 
7586  attribute wstring locale;
7587 
7606  attribute wstring language;
7607 
7618  attribute wstring country;
7619 
7633  attribute wstring proxy;
7634 
7644  attribute wstring packageSelectionAdjustments;
7645 
7654  attribute wstring hostname;
7655 
7667  attribute wstring auxiliaryBasePath;
7668 
7677  attribute unsigned long imageIndex;
7678 
7691  attribute wstring scriptTemplatePath;
7692 
7706 
7717  attribute wstring postInstallCommand;
7718 
7730  attribute wstring extraInstallKernelParameters;
7731 
7741  readonly attribute wstring detectedOSTypeId;
7742 
7752  readonly attribute wstring detectedOSVersion;
7753 
7763  readonly attribute wstring detectedOSFlavor;
7764 
7777  readonly attribute wstring detectedOSLanguages;
7778 
7789  readonly attribute wstring detectedOSHints;
7790 
7800  void detectIsoOS();
7801 
7812  void prepare();
7813 
7820  void constructMedia();
7821 
7831  void reconfigureVM();
7832 
7842  void done();
7843 
7844 }; /* interface IUnattended */
7845 
7846 interface IInternalMachineControl : $unknown
7847 {
7859  void updateState (
7860  in MachineState state
7861  );
7862 
7874  void beginPowerUp (
7875  in IProgress progress
7876  );
7877 
7887  void endPowerUp (
7888  in long result
7889  );
7890 
7902  void beginPoweringDown (
7903  out IProgress progress
7904  );
7905 
7935  void endPoweringDown (
7936  in long result,
7937  in wstring errMsg
7938  );
7939 
7953  void runUSBDeviceFilters (
7954  in IUSBDevice device,
7955  out boolean matched,
7956  out unsigned long maskedInterfaces
7957  );
7958 
7967  void captureUSBDevice (
7968  in wstringUUID id,
7969  in wstring captureFilename
7970  );
7971 
7987  void detachUSBDevice (
7988  in wstringUUID id,
7989  in boolean done
7990  );
7991 
8000  void autoCaptureUSBDevices();
8001 
8017  void detachAllUSBDevices (
8018  in boolean done
8019  );
8020 
8035  void onSessionEnd (
8036  in ISession session,
8037  [retval] out IProgress progress
8038  );
8039 
8046  void finishOnlineMergeMedium();
8047 
8074  void pullGuestProperties (
8075  out wstring[] names,
8076  out wstring[] values,
8077  out long long[] timestamps,
8078  out wstring[] flags
8079  );
8080 
8102  void pushGuestProperty (
8103  in wstring name,
8104  in wstring value,
8105  in long long timestamp,
8106  in wstring flags
8107  );
8108 
8120  void lockMedia();
8121 
8131  void unlockMedia();
8132 
8148  void ejectMedium (
8149  in IMediumAttachment attachment,
8150  [retval] out IMediumAttachment newAttachment
8151  );
8152 
8193  void reportVmStatistics (
8194  in unsigned long validStats,
8195  in unsigned long cpuUser,
8196  in unsigned long cpuKernel,
8197  in unsigned long cpuIdle,
8198  in unsigned long memTotal,
8199  in unsigned long memFree,
8200  in unsigned long memBalloon,
8201  in unsigned long memShared,
8202  in unsigned long memCache,
8203  in unsigned long pagedTotal,
8204  in unsigned long memAllocTotal,
8205  in unsigned long memFreeTotal,
8206  in unsigned long memBalloonTotal,
8207  in unsigned long memSharedTotal,
8208  in unsigned long vmNetRx,
8209  in unsigned long vmNetTx
8210  );
8211 
8225  void authenticateExternal (
8226  in wstring[] authParams,
8227  out wstring result
8228  );
8229 
8230 }; /* interface IInternalMachineControl */
8231 
8240 interface IBIOSSettings : $unknown
8241 {
8245  attribute boolean logoFadeIn;
8246 
8250  attribute boolean logoFadeOut;
8251 
8255  attribute unsigned long logoDisplayTime;
8256 
8263  attribute wstring logoImagePath;
8264 
8269 
8273  attribute boolean ACPIEnabled;
8274 
8281  attribute boolean IOAPICEnabled;
8282 
8288  attribute APICMode APICMode;
8289 
8299  attribute long long timeOffset;
8300 
8307  attribute boolean PXEDebugEnabled;
8308 
8317  readonly attribute wstring nonVolatileStorageFile;
8318 
8319 }; /* interface IBIOSSettings */
8320 
8328 interface IPCIAddress : $unknown
8329 {
8335  attribute short bus;
8336 
8342  attribute short device;
8343 
8349  attribute short devFunction;
8350 
8356  void asLong (
8357  [retval] out long result
8358  );
8359 
8365  void fromLong (
8366  in long number
8367  );
8368 
8369 }; /* interface IPCIAddress */
8370 
8378 interface IPCIDeviceAttachment : $unknown
8379 {
8385  readonly attribute wstring name;
8386 
8392  readonly attribute boolean isPhysicalDevice;
8393 
8399  readonly attribute long hostAddress;
8400 
8406  readonly attribute long guestAddress;
8407 
8408 }; /* interface IPCIDeviceAttachment */
8409 
8450 interface IMachine : $unknown
8451 {
8455  readonly attribute IVirtualBox parent;
8456 
8460  attribute octet[] icon;
8461 
8512  readonly attribute boolean accessible;
8513 
8525  readonly attribute IVirtualBoxErrorInfo accessError;
8526 
8567  attribute wstring name;
8568 
8579  attribute wstring description;
8580 
8584  readonly attribute wstringUUID id;
8585 
8596  attribute wstring[] groups;
8597 
8612  attribute wstring OSTypeId;
8613 
8617  attribute wstring hardwareVersion;
8618 
8628  attribute wstringUUID hardwareUUID;
8629 
8633  attribute unsigned long CPUCount;
8634 
8640  attribute boolean CPUHotPlugEnabled;
8641 
8649  attribute unsigned long CPUExecutionCap;
8650 
8662  attribute unsigned long CPUIDPortabilityLevel;
8663 
8667  attribute unsigned long memorySize;
8668 
8672  attribute unsigned long memoryBalloonSize;
8673 
8680  attribute boolean pageFusionEnabled;
8681 
8686 
8690  attribute unsigned long VRAMSize;
8691 
8697  attribute boolean accelerate3DEnabled;
8698 
8704  attribute boolean accelerate2DVideoEnabled;
8705 
8716  attribute unsigned long monitorCount;
8717 
8723  attribute boolean videoCaptureEnabled;
8724 
8730  attribute boolean[] videoCaptureScreens;
8731 
8745  attribute wstring videoCaptureFile;
8746 
8754  attribute unsigned long videoCaptureWidth;
8755 
8763  attribute unsigned long videoCaptureHeight;
8764 
8773  attribute unsigned long videoCaptureRate;
8774 
8784  attribute unsigned long videoCaptureFPS;
8785 
8795  attribute unsigned long videoCaptureMaxTime;
8796 
8806  attribute unsigned long videoCaptureMaxFileSize;
8807 
8827  attribute wstring videoCaptureOptions;
8828 
8832  readonly attribute IBIOSSettings BIOSSettings;
8833 
8839 
8846 
8853 
8860  attribute boolean HPETEnabled;
8861 
8866 
8900  attribute wstring snapshotFolder;
8901 
8905  readonly attribute IVRDEServer VRDEServer;
8906 
8907  attribute boolean emulatedUSBCardReaderEnabled;
8908 
8912  readonly attribute IMediumAttachment[] mediumAttachments;
8913 
8925  readonly attribute IUSBController[] USBControllers;
8926 
8939 
8943  readonly attribute IAudioAdapter audioAdapter;
8944 
8949 
8955  readonly attribute wstring settingsFilePath;
8956 
8962  readonly attribute wstring settingsAuxFilePath;
8963 
8988  readonly attribute boolean settingsModified;
8989 
8993  readonly attribute SessionState sessionState;
8994 
9008  readonly attribute wstring sessionName;
9009 
9019  readonly attribute unsigned long sessionPID;
9020 
9024  readonly attribute MachineState state;
9025 
9032  readonly attribute long long lastStateChange;
9033 
9045  readonly attribute wstring stateFilePath;
9046 
9056  readonly attribute wstring logFolder;
9057 
9067  readonly attribute ISnapshot currentSnapshot;
9068 
9075  readonly attribute unsigned long snapshotCount;
9076 
9109  readonly attribute boolean currentStateModified;
9110 
9122  readonly attribute ISharedFolder[] sharedFolders;
9123 
9131 
9137  attribute DnDMode dnDMode;
9138 
9147  attribute boolean teleporterEnabled;
9148 
9159  attribute unsigned long teleporterPort;
9160 
9167  attribute wstring teleporterAddress;
9168 
9179  attribute wstring teleporterPassword;
9180 
9187 
9196 
9203  attribute unsigned long faultTolerancePort;
9204 
9210  attribute wstring faultToleranceAddress;
9211 
9219  attribute wstring faultTolerancePassword;
9220 
9226  attribute unsigned long faultToleranceSyncInterval;
9227 
9235  attribute boolean RTCUseUTC;
9236 
9243  attribute boolean IOCacheEnabled;
9244 
9250  attribute unsigned long IOCacheSize;
9251 
9262 
9269 
9278  attribute boolean tracingEnabled;
9279 
9294  attribute wstring tracingConfig;
9295 
9308  attribute boolean allowTracingToAccessVM;
9309 
9315  attribute boolean autostartEnabled;
9316 
9322  attribute unsigned long autostartDelay;
9323 
9330 
9346  attribute wstring defaultFrontend;
9347 
9353  readonly attribute boolean USBProxyAvailable;
9354 
9375  attribute wstring VMProcessPriority;
9376 
9382  attribute wstring paravirtDebug;
9383 
9393  attribute wstring CPUProfile;
9394 
9502  void lockMachine (
9503  in ISession session,
9504  in LockType lockType
9505  );
9506 
9646  void launchVMProcess (
9647  in ISession session,
9648  in wstring name,
9649  in wstring environment,
9650  [retval] out IProgress progress
9651  );
9652 
9690  void setBootOrder (
9691  in unsigned long position,
9692  in DeviceType device
9693  );
9694 
9729  void getBootOrder (
9730  in unsigned long position,
9731  [retval] out DeviceType device
9732  );
9733 
9836  void attachDevice (
9837  in wstring name,
9838  in long controllerPort,
9839  in long device,
9840  in DeviceType type,
9841  in IMedium medium
9842  );
9843 
9940  void attachDeviceWithoutMedium (
9941  in wstring name,
9942  in long controllerPort,
9943  in long device,
9944  in DeviceType type
9945  );
9946 
10000  void detachDevice (
10001  in wstring name,
10002  in long controllerPort,
10003  in long device
10004  );
10005 
10048  void passthroughDevice (
10049  in wstring name,
10050  in long controllerPort,
10051  in long device,
10052  in boolean passthrough
10053  );
10054 
10097  void temporaryEjectDevice (
10098  in wstring name,
10099  in long controllerPort,
10100  in long device,
10101  in boolean temporaryEject
10102  );
10103 
10149  void nonRotationalDevice (
10150  in wstring name,
10151  in long controllerPort,
10152  in long device,
10153  in boolean nonRotational
10154  );
10155 
10201  void setAutoDiscardForDevice (
10202  in wstring name,
10203  in long controllerPort,
10204  in long device,
10205  in boolean discard
10206  );
10207 
10257  void setHotPluggableForDevice (
10258  in wstring name,
10259  in long controllerPort,
10260  in long device,
10261  in boolean hotPluggable
10262  );
10263 
10304  void setBandwidthGroupForDevice (
10305  in wstring name,
10306  in long controllerPort,
10307  in long device,
10308  in IBandwidthGroup bandwidthGroup
10309  );
10310 
10347  void setNoBandwidthGroupForDevice (
10348  in wstring name,
10349  in long controllerPort,
10350  in long device
10351  );
10352 
10417  void unmountMedium (
10418  in wstring name,
10419  in long controllerPort,
10420  in long device,
10421  in boolean force
10422  );
10423 
10486  void mountMedium (
10487  in wstring name,
10488  in long controllerPort,
10489  in long device,
10490  in IMedium medium,
10491  in boolean force
10492  );
10493 
10522  void getMedium (
10523  in wstring name,
10524  in long controllerPort,
10525  in long device,
10526  [retval] out IMedium medium
10527  );
10528 
10543  void getMediumAttachmentsOfController (
10544  in wstring name,
10545  [retval] out IMediumAttachment[] mediumAttachments
10546  );
10547 
10562  void getMediumAttachment (
10563  in wstring name,
10564  in long controllerPort,
10565  in long device,
10566  [retval] out IMediumAttachment attachment
10567  );
10568 
10609  void attachHostPCIDevice (
10610  in long hostAddress,
10611  in long desiredGuestAddress,
10612  in boolean tryToUnbind
10613  );
10614 
10655  void detachHostPCIDevice (
10656  in long hostAddress
10657  );
10658 
10676  void getNetworkAdapter (
10677  in unsigned long slot,
10678  [retval] out INetworkAdapter adapter
10679  );
10680 
10713  void addStorageController (
10714  in wstring name,
10715  in StorageBus connectionType,
10716  [retval] out IStorageController controller
10717  );
10718 
10732  void getStorageControllerByName (
10733  in wstring name,
10734  [retval] out IStorageController storageController
10735  );
10736 
10751  void getStorageControllerByInstance (
10752  in StorageBus connectionType,
10753  in unsigned long instance,
10754  [retval] out IStorageController storageController
10755  );
10756 
10779  void removeStorageController (
10780  in wstring name
10781  );
10782 
10804  void setStorageControllerBootable (
10805  in wstring name,
10806  in boolean bootable
10807  );
10808 
10831  void addUSBController (
10832  in wstring name,
10833  in USBControllerType type,
10834  [retval] out IUSBController controller
10835  );
10836 
10850  void removeUSBController (
10851  in wstring name
10852  );
10853 
10867  void getUSBControllerByName (
10868  in wstring name,
10869  [retval] out IUSBController controller
10870  );
10871 
10877  void getUSBControllerCountByType (
10878  in USBControllerType type,
10879  [retval] out unsigned long controllers
10880  );
10881 
10899  void getSerialPort (
10900  in unsigned long slot,
10901  [retval] out ISerialPort port
10902  );
10903 
10921  void getParallelPort (
10922  in unsigned long slot,
10923  [retval] out IParallelPort port
10924  );
10925 
10934  void getExtraDataKeys (
10935  [retval] out wstring[] keys
10936  );
10937 
10966  void getExtraData (
10967  in wstring key,
10968  [retval] out wstring value
10969  );
10970 
11020  void setExtraData (
11021  in wstring key,
11022  in wstring value
11023  );
11024 
11046  void getCPUProperty (
11047  in CPUPropertyType property,
11048  [retval] out boolean value
11049  );
11050 
11072  void setCPUProperty (
11073  in CPUPropertyType property,
11074  in boolean value
11075  );
11076 
11118  void getCPUIDLeafByOrdinal (
11119  in unsigned long ordinal,
11120  out unsigned long idx,
11121  out unsigned long idxSub,
11122  out unsigned long valEax,
11123  out unsigned long valEbx,
11124  out unsigned long valEcx,
11125  out unsigned long valEdx
11126  );
11127 
11172  void getCPUIDLeaf (
11173  in unsigned long idx,
11174  in unsigned long idxSub,
11175  out unsigned long valEax,
11176  out unsigned long valEbx,
11177  out unsigned long valEcx,
11178  out unsigned long valEdx
11179  );
11180 
11234  void setCPUIDLeaf (
11235  in unsigned long idx,
11236  in unsigned long idxSub,
11237  in unsigned long valEax,
11238  in unsigned long valEbx,
11239  in unsigned long valEcx,
11240  in unsigned long valEdx
11241  );
11242 
11265  void removeCPUIDLeaf (
11266  in unsigned long idx,
11267  in unsigned long idxSub
11268  );
11269 
11275  void removeAllCPUIDLeaves();
11276 
11298  void getHWVirtExProperty (
11299  in HWVirtExPropertyType property,
11300  [retval] out boolean value
11301  );
11302 
11324  void setHWVirtExProperty (
11325  in HWVirtExPropertyType property,
11326  in boolean value
11327  );
11328 
11358  void setSettingsFilePath (
11359  in wstring settingsFilePath,
11360  [retval] out IProgress progress
11361  );
11362 
11408  void saveSettings();
11409 
11433  void discardSettings();
11434 
11519  void unregister (
11520  in CleanupMode cleanupMode,
11521  [retval] out IMedium[] media
11522  );
11523 
11581  void deleteConfig (
11582  in IMedium[] media,
11583  [retval] out IProgress progress
11584  );
11585 
11597  void exportTo (
11598  in IAppliance appliance,
11599  in wstring location,
11600  [retval] out IVirtualSystemDescription description
11601  );
11602 
11626  void findSnapshot (
11627  in wstring nameOrId,
11628  [retval] out ISnapshot snapshot
11629  );
11630 
11664  void createSharedFolder (
11665  in wstring name,
11666  in wstring hostPath,
11667  in boolean writable,
11668  in boolean automount
11669  );
11670 
11696  void removeSharedFolder (
11697  in wstring name
11698  );
11699 
11723  void canShowConsoleWindow (
11724  [retval] out boolean canShow
11725  );
11726 
11761  void showConsoleWindow (
11762  [retval] out long long winId
11763  );
11764 
11797  void getGuestProperty (
11798  in wstring name,
11799  out wstring value,
11800  out long long timestamp,
11801  out wstring flags
11802  );
11803 
11826  void getGuestPropertyValue (
11827  in wstring property,
11828  [retval] out wstring value
11829  );
11830 
11853  void getGuestPropertyTimestamp (
11854  in wstring property,
11855  [retval] out long long value
11856  );
11857 
11908  void setGuestProperty (
11909  in wstring property,
11910  in wstring value,
11911  in wstring flags
11912  );
11913 
11953  void setGuestPropertyValue (
11954  in wstring property,
11955  in wstring value
11956  );
11957 
11975  void deleteGuestProperty (
11976  in wstring name
11977  );
11978 
12009  void enumerateGuestProperties (
12010  in wstring patterns,
12011  out wstring[] names,
12012  out wstring[] values,
12013  out long long[] timestamps,
12014  out wstring[] flags
12015  );
12016 
12046  void querySavedGuestScreenInfo (
12047  in unsigned long screenId,
12048  out unsigned long originX,
12049  out unsigned long originY,
12050  out unsigned long width,
12051  out unsigned long height,
12052  out boolean enabled
12053  );
12054 
12080  void readSavedThumbnailToArray (
12081  in unsigned long screenId,
12082  in BitmapFormat bitmapFormat,
12083  out unsigned long width,
12084  out unsigned long height,
12085  [retval] out octet[] data
12086  );
12087 
12109  void querySavedScreenshotInfo (
12110  in unsigned long screenId,
12111  out unsigned long width,
12112  out unsigned long height,
12113  [retval] out BitmapFormat[] bitmapFormats
12114  );
12115 
12141  void readSavedScreenshotToArray (
12142  in unsigned long screenId,
12143  in BitmapFormat bitmapFormat,
12144  out unsigned long width,
12145  out unsigned long height,
12146  [retval] out octet[] data
12147  );
12148 
12158  void hotPlugCPU (
12159  in unsigned long cpu
12160  );
12161 
12171  void hotUnplugCPU (
12172  in unsigned long cpu
12173  );
12174 
12188  void getCPUStatus (
12189  in unsigned long cpu,
12190  [retval] out boolean attached
12191  );
12192 
12202  void getEffectiveParavirtProvider (
12203  [retval] out ParavirtProvider paravirtProvider
12204  );
12205 
12220  void queryLogFilename (
12221  in unsigned long idx,
12222  [retval] out wstring filename
12223  );
12224 
12250  void readLog (
12251  in unsigned long idx,
12252  in long long offset,
12253  in long long size,
12254  [retval] out octet[] data
12255  );
12256 
12289  void cloneTo (
12290  in IMachine target,
12291  in CloneMode mode,
12292  in CloneOptions[] options,
12293  [retval] out IProgress progress
12294  );
12295 
12348  void saveState (
12349  [retval] out IProgress progress
12350  );
12351 
12384  void adoptSavedState (
12385  in wstring savedStateFile
12386  );
12387 
12418  void discardSavedState (
12419  in boolean fRemoveFile
12420  );
12421 
12467  void takeSnapshot (
12468  in wstring name,
12469  in wstring description,
12470  in boolean pause,
12471  out wstringUUID id,
12472  [retval] out IProgress progress
12473  );
12474 
12548  void deleteSnapshot (
12549  in wstringUUID id,
12550  [retval] out IProgress progress
12551  );
12552 
12592  void deleteSnapshotAndAllChildren (
12593  in wstringUUID id,
12594  [retval] out IProgress progress
12595  );
12596 
12640  void deleteSnapshotRange (
12641  in wstringUUID startId,
12642  in wstringUUID endId,
12643  [retval] out IProgress progress
12644  );
12645 
12686  void restoreSnapshot (
12687  in ISnapshot snapshot,
12688  [retval] out IProgress progress
12689  );
12690 
12717  void applyDefaults (
12718  in wstring flags
12719  );
12720 
12721 }; /* interface IMachine */
12722 
12730 interface IEmulatedUSB : $unknown
12731 {
12735  readonly attribute wstring[] webcams;
12736 
12746  void webcamAttach (
12747  in wstring path,
12748  in wstring settings
12749  );
12750 
12758  void webcamDetach (
12759  in wstring path
12760  );
12761 
12762 }; /* interface IEmulatedUSB */
12763 
12772 interface IVRDEServerInfo : $unknown
12773 {
12779  readonly attribute boolean active;
12780 
12789  readonly attribute long port;
12790 
12796  readonly attribute unsigned long numberOfClients;
12797 
12803  readonly attribute long long beginTime;
12804 
12811  readonly attribute long long endTime;
12812 
12818  readonly attribute long long bytesSent;
12819 
12825  readonly attribute long long bytesSentTotal;
12826 
12832  readonly attribute long long bytesReceived;
12833 
12839  readonly attribute long long bytesReceivedTotal;
12840 
12846  readonly attribute wstring user;
12847 
12853  readonly attribute wstring domain;
12854 
12860  readonly attribute wstring clientName;
12861 
12867  readonly attribute wstring clientIP;
12868 
12874  readonly attribute unsigned long clientVersion;
12875 
12883  readonly attribute unsigned long encryptionStyle;
12884 
12885 }; /* interface IVRDEServerInfo */
12886 
12908 interface IConsole : $unknown
12909 {
12921  readonly attribute IMachine machine;
12922 
12936  readonly attribute MachineState state;
12937 
12941  readonly attribute IGuest guest;
12942 
12953  readonly attribute IKeyboard keyboard;
12954 
12965  readonly attribute IMouse mouse;
12966 
12976  readonly attribute IDisplay display;
12977 
12981  readonly attribute IMachineDebugger debugger;
12982 
12993  readonly attribute IUSBDevice[] USBDevices;
12994 
13002  readonly attribute IHostUSBDevice[] remoteUSBDevices;
13003 
13019  readonly attribute ISharedFolder[] sharedFolders;
13020 
13026  readonly attribute IVRDEServerInfo VRDEServerInfo;
13027 
13033  readonly attribute IEventSource eventSource;
13034 
13039 
13048  attribute boolean useHostClipboard;
13049 
13055  readonly attribute IEmulatedUSB emulatedUSB;
13056 
13121  void powerUp (
13122  [retval] out IProgress progress
13123  );
13124 
13158  void powerUpPaused (
13159  [retval] out IProgress progress
13160  );
13161 
13181  void powerDown (
13182  [retval] out IProgress progress
13183  );
13184 
13204  void reset();
13205 
13225  void pause();
13226 
13246  void resume();
13247 
13267  void powerButton();
13268 
13288  void sleepButton();
13289 
13301  void getPowerButtonHandled (
13302  [retval] out boolean handled
13303  );
13304 
13318  void getGuestEnteredACPIMode (
13319  [retval] out boolean entered
13320  );
13321 
13334  void getDeviceActivity (
13335  in DeviceType[] type,
13336  [retval] out DeviceActivity[] activity
13337  );
13338 
13378  void attachUSBDevice (
13379  in wstringUUID id,
13380  in wstring captureFilename
13381  );
13382 
13417  void detachUSBDevice (
13418  in wstringUUID id,
13419  [retval] out IUSBDevice device
13420  );
13421 
13444  void findUSBDeviceByAddress (
13445  in wstring name,
13446  [retval] out IUSBDevice device
13447  );
13448 
13468  void findUSBDeviceById (
13469  in wstringUUID id,
13470  [retval] out IUSBDevice device
13471  );
13472 
13506  void createSharedFolder (
13507  in wstring name,
13508  in wstring hostPath,
13509  in boolean writable,
13510  in boolean automount
13511  );
13512 
13537  void removeSharedFolder (
13538  in wstring name
13539  );
13540 
13579  void teleport (
13580  in wstring hostname,
13581  in unsigned long tcpport,
13582  in wstring password,
13583  in unsigned long maxDowntime,
13584  [retval] out IProgress progress
13585  );
13586 
13613  void addDiskEncryptionPassword (
13614  in wstring id,
13615  in wstring password,
13616  in boolean clearOnSuspend
13617  );
13618 
13645  void addDiskEncryptionPasswords (
13646  in wstring[] ids,
13647  in wstring[] passwords,
13648  in boolean clearOnSuspend
13649  );
13650 
13664  void removeDiskEncryptionPassword (
13665  in wstring id
13666  );
13667 
13671  void clearAllDiskEncryptionPasswords();
13672 
13673 }; /* interface IConsole */
13674 
13685 interface IHostNetworkInterface : $unknown
13686 {
13690  readonly attribute wstring name;
13691 
13695  readonly attribute wstring shortName;
13696 
13700  readonly attribute wstringUUID id;
13701 
13705  readonly attribute wstring networkName;
13706 
13710  readonly attribute boolean DHCPEnabled;
13711 
13715  readonly attribute wstring IPAddress;
13716 
13720  readonly attribute wstring networkMask;
13721 
13725  readonly attribute boolean IPV6Supported;
13726 
13730  readonly attribute wstring IPV6Address;
13731 
13735  readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
13736 
13740  readonly attribute wstring hardwareAddress;
13741 
13746 
13751 
13756 
13760  readonly attribute boolean wireless;
13761 
13773  void enableStaticIPConfig (
13774  in wstring IPAddress,
13775  in wstring networkMask
13776  );
13777 
13789  void enableStaticIPConfigV6 (
13790  in wstring IPV6Address,
13791  in unsigned long IPV6NetworkMaskPrefixLength
13792  );
13793 
13797  void enableDynamicIPConfig();
13798 
13802  void DHCPRediscover();
13803 
13804 }; /* interface IHostNetworkInterface */
13805 
13813 interface IHostVideoInputDevice : $unknown
13814 {
13818  readonly attribute wstring name;
13819 
13823  readonly attribute wstring path;
13824 
13828  readonly attribute wstring alias;
13829 
13830 }; /* interface IHostVideoInputDevice */
13831 
13848 interface IHost : $unknown
13849 {
13853  readonly attribute IMedium[] DVDDrives;
13854 
13858  readonly attribute IMedium[] floppyDrives;
13859 
13873  readonly attribute IHostUSBDevice[] USBDevices;
13874 
13899 
13904 
13908  readonly attribute wstring[] nameServers;
13909 
13913  readonly attribute wstring domainName;
13914 
13918  readonly attribute wstring[] searchStrings;
13919 
13923  readonly attribute unsigned long processorCount;
13924 
13928  readonly attribute unsigned long processorOnlineCount;
13929 
13933  readonly attribute unsigned long processorCoreCount;
13934 
13938  readonly attribute unsigned long processorOnlineCoreCount;
13939 
13943  readonly attribute unsigned long memorySize;
13944 
13948  readonly attribute unsigned long memoryAvailable;
13949 
13953  readonly attribute wstring operatingSystem;
13954 
13958  readonly attribute wstring OSVersion;
13959 
13963  readonly attribute long long UTCTime;
13964 
13968  readonly attribute boolean acceleration3DAvailable;
13969 
13974 
13989  void getProcessorSpeed (
13990  in unsigned long cpuId,
13991  [retval] out unsigned long speed
13992  );
13993 
14005  void getProcessorFeature (
14006  in ProcessorFeature feature,
14007  [retval] out boolean supported
14008  );
14009 
14028  void getProcessorDescription (
14029  in unsigned long cpuId,
14030  [retval] out wstring description
14031  );
14032 
14073  void getProcessorCPUIDLeaf (
14074  in unsigned long cpuId,
14075  in unsigned long leaf,
14076  in unsigned long subLeaf,
14077  out unsigned long valEax,
14078  out unsigned long valEbx,
14079  out unsigned long valEcx,
14080  out unsigned long valEdx
14081  );
14082 
14103  void createHostOnlyNetworkInterface (
14104  out IHostNetworkInterface hostInterface,
14105  [retval] out IProgress progress
14106  );
14107 
14128  void removeHostOnlyNetworkInterface (
14129  in wstringUUID id,
14130  [retval] out IProgress progress
14131  );
14132 
14152  void createUSBDeviceFilter (
14153  in wstring name,
14154  [retval] out IHostUSBDeviceFilter filter
14155  );
14156 
14199  void insertUSBDeviceFilter (
14200  in unsigned long position,
14201  in IHostUSBDeviceFilter filter
14202  );
14203 
14231  void removeUSBDeviceFilter (
14232  in unsigned long position
14233  );
14234 
14252  void findHostDVDDrive (
14253  in wstring name,
14254  [retval] out IMedium drive
14255  );
14256 
14274  void findHostFloppyDrive (
14275  in wstring name,
14276  [retval] out IMedium drive
14277  );
14278 
14294  void findHostNetworkInterfaceByName (
14295  in wstring name,
14296  [retval] out IHostNetworkInterface networkInterface
14297  );
14298 
14314  void findHostNetworkInterfaceById (
14315  in wstringUUID id,
14316  [retval] out IHostNetworkInterface networkInterface
14317  );
14318 
14328  void findHostNetworkInterfacesOfType (
14329  in HostNetworkInterfaceType type,
14330  [retval] out IHostNetworkInterface[] networkInterfaces
14331  );
14332 
14352  void findUSBDeviceById (
14353  in wstringUUID id,
14354  [retval] out IHostUSBDevice device
14355  );
14356 
14379  void findUSBDeviceByAddress (
14380  in wstring name,
14381  [retval] out IHostUSBDevice device
14382  );
14383 
14391  void generateMACAddress (
14392  [retval] out wstring address
14393  );
14394 
14413  void addUSBDeviceSource (
14414  in wstring backend,
14415  in wstring id,
14416  in wstring address,
14417  in wstring[] propertyNames,
14418  in wstring[] propertyValues
14419  );
14420 
14428  void removeUSBDeviceSource (
14429  in wstring id
14430  );
14431 
14432 }; /* interface IHost */
14433 
14446 interface ISystemProperties : $unknown
14447 {
14451  readonly attribute unsigned long minGuestRAM;
14452 
14456  readonly attribute unsigned long maxGuestRAM;
14457 
14461  readonly attribute unsigned long minGuestVRAM;
14462 
14466  readonly attribute unsigned long maxGuestVRAM;
14467 
14471  readonly attribute unsigned long minGuestCPUCount;
14472 
14476  readonly attribute unsigned long maxGuestCPUCount;
14477 
14481  readonly attribute unsigned long maxGuestMonitors;
14482 
14487  readonly attribute long long infoVDSize;
14488 
14495  readonly attribute unsigned long serialPortCount;
14496 
14503  readonly attribute unsigned long parallelPortCount;
14504 
14514  readonly attribute unsigned long maxBootPosition;
14515 
14524  readonly attribute boolean rawModeSupported;
14525 
14538  attribute boolean exclusiveHwVirt;
14539 
14563  attribute wstring defaultMachineFolder;
14564 
14570  attribute wstring loggingLevel;
14571 
14597  readonly attribute IMediumFormat[] mediumFormats;
14598 
14632  attribute wstring defaultHardDiskFormat;
14633 
14639  attribute long long freeDiskSpaceWarning;
14640 
14645  attribute unsigned long freeDiskSpacePercentWarning;
14646 
14652  attribute long long freeDiskSpaceError;
14653 
14658  attribute unsigned long freeDiskSpacePercentError;
14659 
14683  attribute wstring VRDEAuthLibrary;
14684 
14713  attribute wstring webServiceAuthLibrary;
14714 
14728  attribute wstring defaultVRDEExtPack;
14729 
14735  attribute unsigned long logHistoryCount;
14736 
14742 
14749  attribute wstring autostartDatabasePath;
14750 
14757  attribute wstring defaultAdditionsISO;
14758 
14773  attribute wstring defaultFrontend;
14774 
14781  readonly attribute BitmapFormat[] screenShotFormats;
14782 
14793  void getMaxNetworkAdapters (
14794  in ChipsetType chipset,
14795  [retval] out unsigned long maxNetworkAdapters
14796  );
14797 
14811  void getMaxNetworkAdaptersOfType (
14812  in ChipsetType chipset,
14813  in NetworkAttachmentType type,
14814  [retval] out unsigned long maxNetworkAdapters
14815  );
14816 
14826  void getMaxDevicesPerPortForStorageBus (
14827  in StorageBus bus,
14828  [retval] out unsigned long maxDevicesPerPort
14829  );
14830 
14838  void getMinPortCountForStorageBus (
14839  in StorageBus bus,
14840  [retval] out unsigned long minPortCount
14841  );
14842 
14850  void getMaxPortCountForStorageBus (
14851  in StorageBus bus,
14852  [retval] out unsigned long maxPortCount
14853  );
14854 
14867  void getMaxInstancesOfStorageBus (
14868  in ChipsetType chipset,
14869  in StorageBus bus,
14870  [retval] out unsigned long maxInstances
14871  );
14872 
14882  void getDeviceTypesForStorageBus (
14883  in StorageBus bus,
14884  [retval] out DeviceType[] deviceTypes
14885  );
14886 
14895  void getDefaultIoCacheSettingForStorageController (
14896  in StorageControllerType controllerType,
14897  [retval] out boolean enabled
14898  );
14899 
14908  void getStorageControllerHotplugCapable (
14909  in StorageControllerType controllerType,
14910  [retval] out boolean hotplugCapable
14911  );
14912 
14925  void getMaxInstancesOfUSBControllerType (
14926  in ChipsetType chipset,
14927  in USBControllerType type,
14928  [retval] out unsigned long maxInstances
14929  );
14930 
14931 }; /* interface ISystemProperties */
14932 
14938 interface IGuestOSType : $unknown
14939 {
14943  readonly attribute wstring familyId;
14944 
14948  readonly attribute wstring familyDescription;
14949 
14953  readonly attribute wstring id;
14954 
14958  readonly attribute wstring description;
14959 
14963  readonly attribute boolean is64Bit;
14964 
14968  readonly attribute boolean recommendedIOAPIC;
14969 
14973  readonly attribute boolean recommendedVirtEx;
14974 
14978  readonly attribute unsigned long recommendedRAM;
14979 
14983  readonly attribute unsigned long recommendedVRAM;
14984 
14988  readonly attribute boolean recommended2DVideoAcceleration;
14989 
14993  readonly attribute boolean recommended3DAcceleration;
14994 
14998  readonly attribute long long recommendedHDD;
14999 
15003  readonly attribute NetworkAdapterType adapterType;
15004 
15008  readonly attribute boolean recommendedPAE;
15009 
15014 
15019 
15024 
15029 
15033  readonly attribute FirmwareType recommendedFirmware;
15034 
15038  readonly attribute boolean recommendedUSBHID;
15039 
15043  readonly attribute boolean recommendedHPET;
15044 
15048  readonly attribute boolean recommendedUSBTablet;
15049 
15053  readonly attribute boolean recommendedRTCUseUTC;
15054 
15058  readonly attribute ChipsetType recommendedChipset;
15059 
15064 
15069 
15073  readonly attribute boolean recommendedFloppy;
15074 
15078  readonly attribute boolean recommendedUSB;
15079 
15083  readonly attribute boolean recommendedUSB3;
15084 
15088  readonly attribute boolean recommendedTFReset;
15089 
15093  readonly attribute boolean recommendedX2APIC;
15094 
15095 }; /* interface IGuestOSType */
15096 
15104 interface IAdditionsFacility : $unknown
15105 {
15109  readonly attribute AdditionsFacilityClass classType;
15110 
15117  readonly attribute long long lastUpdated;
15118 
15122  readonly attribute wstring name;
15123 
15127  readonly attribute AdditionsFacilityStatus status;
15128 
15132  readonly attribute AdditionsFacilityType type;
15133 
15134 }; /* interface IAdditionsFacility */
15135 
15141 interface IDnDBase : $unknown
15142 {
15146  readonly attribute wstring[] formats;
15147 
15152  readonly attribute unsigned long protocolVersion;
15153 
15163  void isFormatSupported (
15164  in wstring format,
15165  [retval] out boolean supported
15166  );
15167 
15175  void addFormats (
15176  in wstring[] formats
15177  );
15178 
15186  void removeFormats (
15187  in wstring[] formats
15188  );
15189 
15190 }; /* interface IDnDBase */
15191 
15198 {
15221  void dragIsPending (
15222  in unsigned long screenId,
15223  out wstring[] formats,
15224  out DnDAction[] allowedActions,
15225  [retval] out DnDAction defaultAction
15226  );
15227 
15248  void drop (
15249  in wstring format,
15250  in DnDAction action,
15251  [retval] out IProgress progress
15252  );
15253 
15269  void receiveData (
15270  [retval] out octet[] data
15271  );
15272 
15273 }; /* interface IDnDSource */
15274 
15284 {
15285  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
15286 
15287 }; /* interface IGuestDnDSource */
15288 
15295 {
15323  void enter (
15324  in unsigned long screenId,
15325  in unsigned long y,
15326  in unsigned long x,
15327  in DnDAction defaultAction,
15328  in DnDAction[] allowedActions,
15329  in wstring[] formats,
15330  [retval] out DnDAction resultAction
15331  );
15332 
15360  void move (
15361  in unsigned long screenId,
15362  in unsigned long x,
15363  in unsigned long y,
15364  in DnDAction defaultAction,
15365  in DnDAction[] allowedActions,
15366  in wstring[] formats,
15367  [retval] out DnDAction resultAction
15368  );
15369 
15385  void leave (
15386  in unsigned long screenId
15387  );
15388 
15418  void drop (
15419  in unsigned long screenId,
15420  in unsigned long x,
15421  in unsigned long y,
15422  in DnDAction defaultAction,
15423  in DnDAction[] allowedActions,
15424  in wstring[] formats,
15425  out wstring format,
15426  [retval] out DnDAction resultAction
15427  );
15428 
15450  void sendData (
15451  in unsigned long screenId,
15452  in wstring format,
15453  in octet[] data,
15454  [retval] out IProgress progress
15455  );
15456 
15473  void cancel (
15474  [retval] out boolean veto
15475  );
15476 
15477 }; /* interface IDnDTarget */
15478 
15488 {
15489  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
15490 
15491 }; /* interface IGuestDnDTarget */
15492 
15539 interface IGuestSession : $unknown
15540 {
15546  readonly attribute wstring user;
15547 
15553  readonly attribute wstring domain;
15554 
15558  readonly attribute wstring name;
15559 
15563  readonly attribute unsigned long id;
15564 
15577  attribute unsigned long timeout;
15578 
15583  readonly attribute unsigned long protocolVersion;
15584 
15588  readonly attribute GuestSessionStatus status;
15589 
15601  attribute wstring[] environmentChanges;
15602 
15617  readonly attribute wstring[] environmentBase;
15618 
15624  readonly attribute IGuestProcess[] processes;
15625 
15632  readonly attribute PathStyle pathStyle;
15633 
15646  attribute wstring currentDirectory;
15647 
15653  readonly attribute IGuestDirectory[] directories;
15654 
15660  readonly attribute IGuestFile[] files;
15661 
15667  readonly attribute IEventSource eventSource;
15668 
15677  void close();
15678 
15702  void directoryCopy (
15703  in wstring source,
15704  in wstring destination,
15705  in DirectoryCopyFlags[] flags,
15706  [retval] out IProgress progress
15707  );
15708 
15733  void directoryCopyFromGuest (
15734  in wstring source,
15735  in wstring destination,
15736  in DirectoryCopyFlags[] flags,
15737  [retval] out IProgress progress
15738  );
15739 
15764  void directoryCopyToGuest (
15765  in wstring source,
15766  in wstring destination,
15767  in DirectoryCopyFlags[] flags,
15768  [retval] out IProgress progress
15769  );
15770 
15795  void directoryCreate (
15796  in wstring path,
15797  in unsigned long mode,
15798  in DirectoryCreateFlag[] flags
15799  );
15800 
15862  void directoryCreateTemp (
15863  in wstring templateName,
15864  in unsigned long mode,
15865  in wstring path,
15866  in boolean secure,
15867  [retval] out wstring directory
15868  );
15869 
15894  void directoryExists (
15895  in wstring path,
15896  in boolean followSymlinks,
15897  [retval] out boolean exists
15898  );
15899 
15934  void directoryOpen (
15935  in wstring path,
15936  in wstring filter,
15937  in DirectoryOpenFlag[] flags,
15938  [retval] out IGuestDirectory directory
15939  );
15940 
15952  void directoryRemove (
15953  in wstring path
15954  );
15955 
15981  void directoryRemoveRecursive (
15982  in wstring path,
15983  in DirectoryRemoveRecFlag[] flags,
15984  [retval] out IProgress progress
15985  );
15986 
15999  void environmentScheduleSet (
16000  in wstring name,
16001  in wstring value
16002  );
16003 
16014  void environmentScheduleUnset (
16015  in wstring name
16016  );
16017 
16048  void environmentGetBaseVariable (
16049  in wstring name,
16050  [retval] out wstring value
16051  );
16052 
16079  void environmentDoesBaseVariableExist (
16080  in wstring name,
16081  [retval] out boolean exists
16082  );
16083 
16109  void fileCopy (
16110  in wstring source,
16111  in wstring destination,
16112  in FileCopyFlag[] flags,
16113  [retval] out IProgress progress
16114  );
16115 
16142  void fileCopyFromGuest (
16143  in wstring source,
16144  in wstring destination,
16145  in FileCopyFlag[] flags,
16146  [retval] out IProgress progress
16147  );
16148 
16175  void fileCopyToGuest (
16176  in wstring source,
16177  in wstring destination,
16178  in FileCopyFlag[] flags,
16179  [retval] out IProgress progress
16180  );
16181 
16243  void fileCreateTemp (
16244  in wstring templateName,
16245  in unsigned long mode,
16246  in wstring path,
16247  in boolean secure,
16248  [retval] out IGuestFile file
16249  );
16250 
16276  void fileExists (
16277  in wstring path,
16278  in boolean followSymlinks,
16279  [retval] out boolean exists
16280  );
16281 
16321  void fileOpen (
16322  in wstring path,
16323  in FileAccessMode accessMode,
16324  in FileOpenAction openAction,
16325  in unsigned long creationMode,
16326  [retval] out IGuestFile file
16327  );
16328 
16376  void fileOpenEx (
16377  in wstring path,
16378  in FileAccessMode accessMode,
16379  in FileOpenAction openAction,
16380  in FileSharingMode sharingMode,
16381  in unsigned long creationMode,
16382  in FileOpenExFlags[] flags,
16383  [retval] out IGuestFile file
16384  );
16385 
16418  void fileQuerySize (
16419  in wstring path,
16420  in boolean followSymlinks,
16421  [retval] out long long size
16422  );
16423 
16450  void fsObjExists (
16451  in wstring path,
16452  in boolean followSymlinks,
16453  [retval] out boolean exists
16454  );
16455 
16489  void fsObjQueryInfo (
16490  in wstring path,
16491  in boolean followSymlinks,
16492  [retval] out IGuestFsObjInfo info
16493  );
16494 
16529  void fsObjRemove (
16530  in wstring path
16531  );
16532 
16561  void fsObjRename (
16562  in wstring oldPath,
16563  in wstring newPath,
16564  in FsObjRenameFlag[] flags
16565  );
16566 
16595  void fsObjMove (
16596  in wstring source,
16597  in wstring destination,
16598  in FsObjMoveFlags[] flags,
16599  [retval] out IProgress progress
16600  );
16601 
16631  void fsObjSetACL (
16632  in wstring path,
16633  in boolean followSymlinks,
16634  in wstring acl,
16635  in unsigned long mode
16636  );
16637 
16710  void processCreate (
16711  in wstring executable,
16712  in wstring[] arguments,
16713  in wstring[] environmentChanges,
16714  in ProcessCreateFlag[] flags,
16715  in unsigned long timeoutMS,
16716  [retval] out IGuestProcess guestProcess
16717  );
16718 
16790  void processCreateEx (
16791  in wstring executable,
16792  in wstring[] arguments,
16793  in wstring[] environmentChanges,
16794  in ProcessCreateFlag[] flags,
16795  in unsigned long timeoutMS,
16796  in ProcessPriority priority,
16797  in long[] affinity,
16798  [retval] out IGuestProcess guestProcess
16799  );
16800 
16810  void processGet (
16811  in unsigned long pid,
16812  [retval] out IGuestProcess guestProcess
16813  );
16814 
16842  void symlinkCreate (
16843  in wstring symlink,
16844  in wstring target,
16845  in SymlinkType type
16846  );
16847 
16870  void symlinkExists (
16871  in wstring symlink,
16872  [retval] out boolean exists
16873  );
16874 
16894  void symlinkRead (
16895  in wstring symlink,
16896  in SymlinkReadFlag[] flags,
16897  [retval] out wstring target
16898  );
16899 
16920  void waitFor (
16921  in unsigned long waitFor,
16922  in unsigned long timeoutMS,
16923  [retval] out GuestSessionWaitResult reason
16924  );
16925 
16947  void waitForArray (
16948  in GuestSessionWaitForFlag[] waitFor,
16949  in unsigned long timeoutMS,
16950  [retval] out GuestSessionWaitResult reason
16951  );
16952 
16953 }; /* interface IGuestSession */
16954 
16962 interface IProcess : $unknown
16963 {
16969  readonly attribute wstring[] arguments;
16970 
16976  readonly attribute wstring[] environment;
16977 
16983  readonly attribute IEventSource eventSource;
16984 
16988  readonly attribute wstring executablePath;
16989 
16996  readonly attribute long exitCode;
16997 
17003  readonly attribute wstring name;
17004 
17010  readonly attribute unsigned long PID;
17011 
17018  readonly attribute ProcessStatus status;
17019 
17040  void waitFor (
17041  in unsigned long waitFor,
17042  in unsigned long timeoutMS,
17043  [retval] out ProcessWaitResult reason
17044  );
17045 
17067  void waitForArray (
17068  in ProcessWaitForFlag[] waitFor,
17069  in unsigned long timeoutMS,
17070  [retval] out ProcessWaitResult reason
17071  );
17072 
17089  void read (
17090  in unsigned long handle,
17091  in unsigned long toRead,
17092  in unsigned long timeoutMS,
17093  [retval] out octet[] data
17094  );
17095 
17119  void write (
17120  in unsigned long handle,
17121  in unsigned long flags,
17122  in octet[] data,
17123  in unsigned long timeoutMS,
17124  [retval] out unsigned long written
17125  );
17126 
17151  void writeArray (
17152  in unsigned long handle,
17153  in ProcessInputFlag[] flags,
17154  in octet[] data,
17155  in unsigned long timeoutMS,
17156  [retval] out unsigned long written
17157  );
17158 
17168  void terminate();
17169 
17170 }; /* interface IProcess */
17171 
17181 {
17182  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
17183 
17184 }; /* interface IGuestProcess */
17185 
17193 interface IDirectory : $unknown
17194 {
17198  readonly attribute wstring directoryName;
17199 
17203  readonly attribute wstring filter;
17204 
17211  void close();
17212 
17228  void read (
17229  [retval] out IFsObjInfo objInfo
17230  );
17231 
17232 }; /* interface IDirectory */
17233 
17243 {
17244  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
17245 
17246 }; /* interface IGuestDirectory */
17247 
17255 interface IFile : $unknown
17256 {
17262  readonly attribute IEventSource eventSource;
17263 
17269  readonly attribute unsigned long id;
17270 
17276  readonly attribute long long initialSize;
17277 
17292  readonly attribute long long offset;
17293 
17299  readonly attribute FileStatus status;
17300 
17305  readonly attribute wstring fileName;
17306 
17310  readonly attribute unsigned long creationMode;
17311 
17315  readonly attribute FileOpenAction openAction;
17316 
17320  readonly attribute FileAccessMode accessMode;
17321 
17328  void close();
17329 
17346  void queryInfo (
17347  [retval] out IFsObjInfo objInfo
17348  );
17349 
17365  void querySize (
17366  [retval] out long long size
17367  );
17368 
17391  void read (
17392  in unsigned long toRead,
17393  in unsigned long timeoutMS,
17394  [retval] out octet[] data
17395  );
17396 
17421  void readAt (
17422  in long long offset,
17423  in unsigned long toRead,
17424  in unsigned long timeoutMS,
17425  [retval] out octet[] data
17426  );
17427 
17446  void seek (
17447  in long long offset,
17448  in FileSeekOrigin whence,
17449  [retval] out long long newOffset
17450  );
17451 
17472  void setACL (
17473  in wstring acl,
17474  in unsigned long mode
17475  );
17476 
17492  void setSize (
17493  in long long size
17494  );
17495 
17513  void write (
17514  in octet[] data,
17515  in unsigned long timeoutMS,
17516  [retval] out unsigned long written
17517  );
17518 
17546  void writeAt (
17547  in long long offset,
17548  in octet[] data,
17549  in unsigned long timeoutMS,
17550  [retval] out unsigned long written
17551  );
17552 
17553 }; /* interface IFile */
17554 
17563 interface IGuestFile : IFile
17564 {
17565  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
17566 
17567 }; /* interface IGuestFile */
17568 
17577 interface IFsObjInfo : $unknown
17578 {
17584  readonly attribute long long accessTime;
17585 
17591  readonly attribute long long allocatedSize;
17592 
17598  readonly attribute long long birthTime;
17599 
17605  readonly attribute long long changeTime;
17606 
17612  readonly attribute unsigned long deviceNumber;
17613 
17619  readonly attribute wstring fileAttributes;
17620 
17626  readonly attribute unsigned long generationId;
17627 
17633  readonly attribute unsigned long GID;
17634 
17640  readonly attribute wstring groupName;
17641 
17647  readonly attribute unsigned long hardLinks;
17648 
17654  readonly attribute long long modificationTime;
17655 
17661  readonly attribute wstring name;
17662 
17668  readonly attribute long long nodeId;
17669 
17675  readonly attribute unsigned long nodeIdDevice;
17676 
17684  readonly attribute long long objectSize;
17685 
17691  readonly attribute FsObjType type;
17692 
17698  readonly attribute unsigned long UID;
17699 
17705  readonly attribute unsigned long userFlags;
17706 
17712  readonly attribute wstring userName;
17713 
17714 }; /* interface IFsObjInfo */
17715 
17725 {
17726  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
17727 
17728 }; /* interface IGuestFsObjInfo */
17729 
17743 interface IGuest : $unknown
17744 {
17759  readonly attribute wstring OSTypeId;
17760 
17767 
17774  readonly attribute wstring additionsVersion;
17775 
17783  readonly attribute unsigned long additionsRevision;
17784 
17791  readonly attribute IGuestDnDSource dnDSource;
17792 
17800  readonly attribute IGuestDnDTarget dnDTarget;
17801 
17807  readonly attribute IEventSource eventSource;
17808 
17815  readonly attribute IAdditionsFacility[] facilities;
17816 
17820  readonly attribute IGuestSession[] sessions;
17821 
17825  attribute unsigned long memoryBalloonSize;
17826 
17830  attribute unsigned long statisticsUpdateInterval;
17831 
17863  void internalGetStatistics (
17864  out unsigned long cpuUser,
17865  out unsigned long cpuKernel,
17866  out unsigned long cpuIdle,
17867  out unsigned long memTotal,
17868  out unsigned long memFree,
17869  out unsigned long memBalloon,
17870  out unsigned long memShared,
17871  out unsigned long memCache,
17872  out unsigned long pagedTotal,
17873  out unsigned long memAllocTotal,
17874  out unsigned long memFreeTotal,
17875  out unsigned long memBalloonTotal,
17876  out unsigned long memSharedTotal
17877  );
17878 
17890  void getFacilityStatus (
17891  in AdditionsFacilityType facility,
17892  out long long timestamp,
17893  [retval] out AdditionsFacilityStatus status
17894  );
17895 
17913  void getAdditionsStatus (
17914  in AdditionsRunLevelType level,
17915  [retval] out boolean active
17916  );
17917 
17947  void setCredentials (
17948  in wstring userName,
17949  in wstring password,
17950  in wstring domain,
17951  in boolean allowInteractiveLogon
17952  );
17953 
17996  void createSession (
17997  in wstring user,
17998  in wstring password,
17999  in wstring domain,
18000  in wstring sessionName,
18001  [retval] out IGuestSession guestSession
18002  );
18003 
18018  void findSession (
18019  in wstring sessionName,
18020  [retval] out IGuestSession[] sessions
18021  );
18022 
18072  void updateGuestAdditions (
18073  in wstring source,
18074  in wstring[] arguments,
18075  in AdditionsUpdateFlag[] flags,
18076  [retval] out IProgress progress
18077  );
18078 
18079 }; /* interface IGuest */
18080 
18121 interface IProgress : $unknown
18122 {
18126  readonly attribute wstringUUID id;
18127 
18131  readonly attribute wstring description;
18132 
18136  readonly attribute $unknown initiator;
18137 
18141  readonly attribute boolean cancelable;
18142 
18150  readonly attribute unsigned long percent;
18151 
18165  readonly attribute long timeRemaining;
18166 
18170  readonly attribute boolean completed;
18171 
18175  readonly attribute boolean canceled;
18176 
18183  readonly attribute long resultCode;
18184 
18194  readonly attribute IVirtualBoxErrorInfo errorInfo;
18195 
18202  readonly attribute unsigned long operationCount;
18203 
18207  readonly attribute unsigned long operation;
18208 
18214  readonly attribute wstring operationDescription;
18215 
18219  readonly attribute unsigned long operationPercent;
18220 
18224  readonly attribute unsigned long operationWeight;
18225 
18233  attribute unsigned long timeout;
18234 
18235  readonly attribute IEventSource eventSource;
18236 
18240  void setCurrentOperationProgress (
18241  in unsigned long percent
18242  );
18243 
18247  void setNextOperation (
18248  in wstring nextOperationDescription,
18249  in unsigned long nextOperationsWeight
18250  );
18251 
18278  void waitForCompletion (
18279  in long timeout
18280  );
18281 
18305  void waitForOperationCompletion (
18306  in unsigned long operation,
18307  in long timeout
18308  );
18309 
18335  void waitForAsyncProgressCompletion (
18336  in IProgress pProgressAsync
18337  );
18338 
18355  void cancel();
18356 
18357 }; /* interface IProgress */
18358 
18443 interface ISnapshot : $unknown
18444 {
18448  readonly attribute wstringUUID id;
18449 
18457  attribute wstring name;
18458 
18466  attribute wstring description;
18467 
18473  readonly attribute long long timeStamp;
18474 
18486  readonly attribute boolean online;
18487 
18499  readonly attribute IMachine machine;
18500 
18507  readonly attribute ISnapshot parent;
18508 
18517  readonly attribute ISnapshot[] children;
18518 
18526  void getChildrenCount (
18527  [retval] out unsigned long childrenCount
18528  );
18529 
18530 }; /* interface ISnapshot */
18531 
18720 interface IMediumAttachment : $unknown
18721 {
18726  readonly attribute IMedium medium;
18727 
18733  readonly attribute wstring controller;
18734 
18740  readonly attribute long port;
18741 
18747  readonly attribute long device;
18748 
18752  readonly attribute DeviceType type;
18753 
18757  readonly attribute boolean passthrough;
18758 
18762  readonly attribute boolean temporaryEject;
18763 
18768  readonly attribute boolean isEjected;
18769 
18773  readonly attribute boolean nonRotational;
18774 
18778  readonly attribute boolean discard;
18779 
18783  readonly attribute boolean hotPluggable;
18784 
18788  readonly attribute IBandwidthGroup bandwidthGroup;
18789 
18790 }; /* interface IMediumAttachment */
18791 
18952 interface IMedium : $unknown
18953 {
18967  readonly attribute wstringUUID id;
18968 
18987  attribute wstring description;
18988 
19004  readonly attribute MediumState state;
19005 
19014  readonly attribute MediumVariant[] variant;
19015 
19025  readonly attribute wstring location;
19026 
19046  readonly attribute wstring name;
19047 
19052  readonly attribute DeviceType deviceType;
19053 
19057  readonly attribute boolean hostDrive;
19058 
19071  readonly attribute long long size;
19072 
19087  readonly attribute wstring format;
19088 
19104  readonly attribute IMediumFormat mediumFormat;
19105 
19131  attribute MediumType type;
19132 
19146  readonly attribute MediumType[] allowedTypes;
19147 
19157  readonly attribute IMedium parent;
19158 
19166  readonly attribute IMedium[] children;
19167 
19178  readonly attribute IMedium base;
19179 
19212  readonly attribute boolean readOnly;
19213 
19229  readonly attribute long long logicalSize;
19230 
19258  attribute boolean autoReset;
19259 
19274  readonly attribute wstring lastAccessError;
19275 
19292  readonly attribute wstringUUID[] machineIds;
19293 
19319  void setIds (
19320  in boolean setImageId,
19321  in wstringUUID imageId,
19322  in boolean setParentId,
19323  in wstringUUID parentId
19324  );
19325 
19360  void refreshState (
19361  [retval] out MediumState state
19362  );
19363 
19390  void getSnapshotIds (
19391  in wstringUUID machineId,
19392  [retval] out wstringUUID[] snapshotIds
19393  );
19394 
19457  void lockRead (
19458  [retval] out IToken token
19459  );
19460 
19515  void lockWrite (
19516  [retval] out IToken token
19517  );
19518 
19568  void close();
19569 
19599  void getProperty (
19600  in wstring name,
19601  [retval] out wstring value
19602  );
19603 
19635  void setProperty (
19636  in wstring name,
19637  in wstring value
19638  );
19639 
19674  void getProperties (
19675  in wstring names,
19676  out wstring[] returnNames,
19677  [retval] out wstring[] returnValues
19678  );
19679 
19709  void setProperties (
19710  in wstring[] names,
19711  in wstring[] values
19712  );
19713 
19746  void createBaseStorage (
19747  in long long logicalSize,
19748  in MediumVariant[] variant,
19749  [retval] out IProgress progress
19750  );
19751 
19803  void deleteStorage (
19804  [retval] out IProgress progress
19805  );
19806 
19845  void createDiffStorage (
19846  in IMedium target,
19847  in MediumVariant[] variant,
19848  [retval] out IProgress progress
19849  );
19850 
19928  void mergeTo (
19929  in IMedium target,
19930  [retval] out IProgress progress
19931  );
19932 
19982  void cloneTo (
19983  in IMedium target,
19984  in MediumVariant[] variant,
19985  in IMedium parent,
19986  [retval] out IProgress progress
19987  );
19988 
20035  void cloneToBase (
20036  in IMedium target,
20037  in MediumVariant[] variant,
20038  [retval] out IProgress progress
20039  );
20040 
20082  void setLocation (
20083  in wstring location,
20084  [retval] out IProgress progress
20085  );
20086 
20115  void compact (
20116  [retval] out IProgress progress
20117  );
20118 
20151  void resize (
20152  in long long logicalSize,
20153  [retval] out IProgress progress
20154  );
20155 
20189  void reset (
20190  [retval] out IProgress progress
20191  );
20192 
20234  void changeEncryption (
20235  in wstring currentPassword,
20236  in wstring cipher,
20237  in wstring newPassword,
20238  in wstring newPasswordId,
20239  [retval] out IProgress progress
20240  );
20241 
20259  void getEncryptionSettings (
20260  out wstring cipher,
20261  [retval] out wstring passwordId
20262  );
20263 
20287  void checkEncryptionPassword (
20288  in wstring password
20289  );
20290 
20291 }; /* interface IMedium */
20292 
20315 interface IMediumFormat : $unknown
20316 {
20336  readonly attribute wstring id;
20337 
20345  readonly attribute wstring name;
20346 
20356 
20375  void describeFileExtensions (
20376  out wstring[] extensions,
20377  out DeviceType[] types
20378  );
20379 
20407  void describeProperties (
20408  out wstring[] names,
20409  out wstring[] descriptions,
20410  out DataType[] types,
20411  out unsigned long[] flags,
20412  out wstring[] defaults
20413  );
20414 
20415 }; /* interface IMediumFormat */
20416 
20431 interface IToken : $unknown
20432 {
20441  void abandon();
20442 
20449  void dummy();
20450 
20451 }; /* interface IToken */
20452 
20464 interface IKeyboard : $unknown
20465 {
20471  readonly attribute KeyboardLED[] keyboardLEDs;
20472 
20478  readonly attribute IEventSource eventSource;
20479 
20492  void putScancode (
20493  in long scancode
20494  );
20495 
20508  void putScancodes (
20509  in long[] scancodes,
20510  [retval] out unsigned long codesStored
20511  );
20512 
20527  void putCAD();
20528 
20543  void releaseKeys();
20544 
20545 }; /* interface IKeyboard */
20546 
20554 interface IMousePointerShape : $unknown
20555 {
20561  readonly attribute boolean visible;
20562 
20568  readonly attribute boolean alpha;
20569 
20575  readonly attribute unsigned long hotX;
20576 
20582  readonly attribute unsigned long hotY;
20583 
20589  readonly attribute unsigned long width;
20590 
20596  readonly attribute unsigned long height;
20597 
20631  readonly attribute octet[] shape;
20632 
20633 }; /* interface IMousePointerShape */
20634 
20646 interface IMouse : $unknown
20647 {
20662  readonly attribute boolean absoluteSupported;
20663 
20678  readonly attribute boolean relativeSupported;
20679 
20693  readonly attribute boolean multiTouchSupported;
20694 
20709  readonly attribute boolean needsHostCursor;
20710 
20716  readonly attribute IMousePointerShape pointerShape;
20717 
20723  readonly attribute IEventSource eventSource;
20724 
20790  void putMouseEvent (
20791  in long dx,
20792  in long dy,
20793  in long dz,
20794  in long dw,
20795  in long buttonState
20796  );
20797 
20870  void putMouseEventAbsolute (
20871  in long x,
20872  in long y,
20873  in long dz,
20874  in long dw,
20875  in long buttonState
20876  );
20877 
20925  void putEventMultiTouch (
20926  in long count,
20927  in long long[] contacts,
20928  in unsigned long scanTime
20929  );
20930 
20946  void putEventMultiTouchString (
20947  in long count,
20948  in wstring contacts,
20949  in unsigned long scanTime
20950  );
20951 
20952 }; /* interface IMouse */
20953 
20954 interface IDisplaySourceBitmap : $unknown
20955 {
20956  readonly attribute unsigned long screenId;
20957 
20966  void queryBitmapInfo (
20967  out octetPtr address,
20968  out unsigned long width,
20969  out unsigned long height,
20970  out unsigned long bitsPerPixel,
20971  out unsigned long bytesPerLine,
20972  out BitmapFormat bitmapFormat
20973  );
20974 
20975 }; /* interface IDisplaySourceBitmap */
20976 
20977 interface IFramebuffer : $unknown
20978 {
20982  readonly attribute unsigned long width;
20983 
20987  readonly attribute unsigned long height;
20988 
20994  readonly attribute unsigned long bitsPerPixel;
20995 
21001  readonly attribute unsigned long bytesPerLine;
21002 
21013  readonly attribute BitmapFormat pixelFormat;
21014 
21024  readonly attribute unsigned long heightReduction;
21025 
21040  readonly attribute IFramebufferOverlay overlay;
21041 
21048  readonly attribute long long winId;
21049 
21059 
21067  void notifyUpdate (
21068  in unsigned long x,
21069  in unsigned long y,
21070  in unsigned long width,
21071  in unsigned long height
21072  );
21073 
21083  void notifyUpdateImage (
21084  in unsigned long x,
21085  in unsigned long y,
21086  in unsigned long width,
21087  in unsigned long height,
21088  in octet[] image
21089  );
21090 
21108  void notifyChange (
21109  in unsigned long screenId,
21110  in unsigned long xOrigin,
21111  in unsigned long yOrigin,
21112  in unsigned long width,
21113  in unsigned long height
21114  );
21115 
21127  void videoModeSupported (
21128  in unsigned long width,
21129  in unsigned long height,
21130  in unsigned long bpp,
21131  [retval] out boolean supported
21132  );
21133 
21170  void getVisibleRegion (
21171  in octetPtr rectangles,
21172  in unsigned long count,
21173  [retval] out unsigned long countCopied
21174  );
21175 
21210  void setVisibleRegion (
21211  in octetPtr rectangles,
21212  in unsigned long count
21213  );
21214 
21239  void processVHWACommand (
21240  in octetPtr command,
21241  in long enmCmd,
21242  in boolean fromGuest
21243  );
21244 
21254  void notify3DEvent (
21255  in unsigned long type,
21256  in octet[] data
21257  );
21258 
21259 }; /* interface IFramebuffer */
21260 
21276 {
21280  readonly attribute unsigned long x;
21281 
21285  readonly attribute unsigned long y;
21286 
21292  attribute boolean visible;
21293 
21300  attribute unsigned long alpha;
21301 
21307  void move (
21308  in unsigned long x,
21309  in unsigned long y
21310  );
21311 
21312 }; /* interface IFramebufferOverlay */
21313 
21314 interface IGuestScreenInfo : $unknown
21315 {
21316  readonly attribute unsigned long screenId;
21317 
21319 
21320  readonly attribute boolean primary;
21321 
21322  readonly attribute boolean origin;
21323 
21324  readonly attribute long originX;
21325 
21326  readonly attribute long originY;
21327 
21328  readonly attribute unsigned long width;
21329 
21330  readonly attribute unsigned long height;
21331 
21332  readonly attribute unsigned long bitsPerPixel;
21333 
21334  readonly attribute wstring extendedInfo;
21335 
21336 }; /* interface IGuestScreenInfo */
21337 
21353 interface IDisplay : $unknown
21354 {
21360  readonly attribute IGuestScreenInfo[] guestScreenLayout;
21361 
21372  void getScreenResolution (
21373  in unsigned long screenId,
21374  out unsigned long width,
21375  out unsigned long height,
21376  out unsigned long bitsPerPixel,
21377  out long xOrigin,
21378  out long yOrigin,
21379  out GuestMonitorStatus guestMonitorStatus
21380  );
21381 
21387  void attachFramebuffer (
21388  in unsigned long screenId,
21389  in IFramebuffer framebuffer,
21390  [retval] out wstringUUID id
21391  );
21392 
21398  void detachFramebuffer (
21399  in unsigned long screenId,
21400  in wstringUUID id
21401  );
21402 
21408  void queryFramebuffer (
21409  in unsigned long screenId,
21410  [retval] out IFramebuffer framebuffer
21411  );
21412 
21475  void setVideoModeHint (
21476  in unsigned long display,
21477  in boolean enabled,
21478  in boolean changeOrigin,
21479  in long originX,
21480  in long originY,
21481  in unsigned long width,
21482  in unsigned long height,
21483  in unsigned long bitsPerPixel
21484  );
21485 
21497  void setSeamlessMode (
21498  in boolean enabled
21499  );
21500 
21522  void takeScreenShot (
21523  in unsigned long screenId,
21524  in octetPtr address,
21525  in unsigned long width,
21526  in unsigned long height,
21527  in BitmapFormat bitmapFormat
21528  );
21529 
21556  void takeScreenShotToArray (
21557  in unsigned long screenId,
21558  in unsigned long width,
21559  in unsigned long height,
21560  in BitmapFormat bitmapFormat,
21561  [retval] out octet[] screenData
21562  );
21563 
21615  void drawToScreen (
21616  in unsigned long screenId,
21617  in octetPtr address,
21618  in unsigned long x,
21619  in unsigned long y,
21620  in unsigned long width,
21621  in unsigned long height
21622  );
21623 
21638  void invalidateAndUpdate();
21639 
21649  void invalidateAndUpdateScreen (
21650  in unsigned long screenId
21651  );
21652 
21665  void completeVHWACommand (
21666  in octetPtr command
21667  );
21668 
21702  void viewportChanged (
21703  in unsigned long screenId,
21704  in unsigned long x,
21705  in unsigned long y,
21706  in unsigned long width,
21707  in unsigned long height
21708  );
21709 
21715  void querySourceBitmap (
21716  in unsigned long screenId,
21717  out IDisplaySourceBitmap displaySourceBitmap
21718  );
21719 
21725  void notifyScaleFactorChange (
21726  in unsigned long screenId,
21727  in unsigned long u32ScaleFactorWMultiplied,
21728  in unsigned long u32ScaleFactorHMultiplied
21729  );
21730 
21736  void notifyHiDPIOutputPolicyChange (
21737  in boolean fUnscaledHiDPI
21738  );
21739 
21745  void setScreenLayout (
21746  in ScreenLayoutMode screenLayoutMode,
21747  in IGuestScreenInfo[] guestScreenInfo
21748  );
21749 
21755  void detachScreens (
21756  in long[] screenIds
21757  );
21758 
21759 }; /* interface IDisplay */
21760 
21776 interface INetworkAdapter : $unknown
21777 {
21786 
21794  readonly attribute unsigned long slot;
21795 
21804  attribute boolean enabled;
21805 
21814  attribute wstring MACAddress;
21815 
21822 
21828  attribute wstring bridgedInterface;
21829 
21835  attribute wstring hostOnlyInterface;
21836 
21842  attribute wstring internalNetwork;
21843 
21849  attribute wstring NATNetwork;
21850 
21856  attribute wstring genericDriver;
21857 
21864  attribute boolean cableConnected;
21865 
21871  attribute unsigned long lineSpeed;
21872 
21880 
21887  attribute boolean traceEnabled;
21888 
21895  attribute wstring traceFile;
21896 
21904  readonly attribute INATEngine NATEngine;
21905 
21912  attribute unsigned long bootPriority;
21913 
21918 
21937  void getProperty (
21938  in wstring key,
21939  [retval] out wstring value
21940  );
21941 
21960  void setProperty (
21961  in wstring key,
21962  in wstring value
21963  );
21964 
21992  void getProperties (
21993  in wstring names,
21994  out wstring[] returnNames,
21995  [retval] out wstring[] returnValues
21996  );
21997 
21998 }; /* interface INetworkAdapter */
21999 
22028 interface ISerialPort : $unknown
22029 {
22037  readonly attribute unsigned long slot;
22038 
22045  attribute boolean enabled;
22046 
22050  attribute unsigned long IOBase;
22051 
22055  attribute unsigned long IRQ;
22056 
22067  attribute PortMode hostMode;
22068 
22076  attribute boolean server;
22077 
22089  attribute wstring path;
22090 
22091 }; /* interface ISerialPort */
22092 
22112 interface IParallelPort : $unknown
22113 {
22121  readonly attribute unsigned long slot;
22122 
22129  attribute boolean enabled;
22130 
22134  attribute unsigned long IOBase;
22135 
22139  attribute unsigned long IRQ;
22140 
22148  attribute wstring path;
22149 
22150 }; /* interface IParallelPort */
22151 
22152 interface IMachineDebugger : $unknown
22153 {
22157  attribute boolean singleStep;
22158 
22162  attribute boolean recompileUser;
22163 
22167  attribute boolean recompileSupervisor;
22168 
22176  attribute boolean executeAllInIEM;
22177 
22181  attribute boolean PATMEnabled;
22182 
22186  attribute boolean CSAMEnabled;
22187 
22191  attribute boolean logEnabled;
22192 
22196  readonly attribute wstring logDbgFlags;
22197 
22201  readonly attribute wstring logDbgGroups;
22202 
22206  readonly attribute wstring logDbgDestinations;
22207 
22211  readonly attribute wstring logRelFlags;
22212 
22216  readonly attribute wstring logRelGroups;
22217 
22221  readonly attribute wstring logRelDestinations;
22222 
22229  readonly attribute boolean HWVirtExEnabled;
22230 
22237  readonly attribute boolean HWVirtExNestedPagingEnabled;
22238 
22245  readonly attribute boolean HWVirtExVPIDEnabled;
22246 
22253  readonly attribute boolean HWVirtExUXEnabled;
22254 
22263  readonly attribute wstring OSName;
22264 
22273  readonly attribute wstring OSVersion;
22274 
22281  readonly attribute boolean PAEEnabled;
22282 
22289  attribute unsigned long virtualTimeRate;
22290 
22298  readonly attribute long long VM;
22299 
22304  readonly attribute long long uptime;
22305 
22321  void dumpGuestCore (
22322  in wstring filename,
22323  in wstring compression
22324  );
22325 
22342  void dumpHostProcessCore (
22343  in wstring filename,
22344  in wstring compression
22345  );
22346 
22367  void info (
22368  in wstring name,
22369  in wstring args,
22370  [retval] out wstring info
22371  );
22372 
22378  void injectNMI();
22379 
22390  void modifyLogGroups (
22391  in wstring settings
22392  );
22393 
22404  void modifyLogFlags (
22405  in wstring settings
22406  );
22407 
22418  void modifyLogDestinations (
22419  in wstring settings
22420  );
22421 
22436  void readPhysicalMemory (
22437  in long long address,
22438  in unsigned long size,
22439  [retval] out octet[] bytes
22440  );
22441 
22456  void writePhysicalMemory (
22457  in long long address,
22458  in unsigned long size,
22459  in octet[] bytes
22460  );
22461 
22478  void readVirtualMemory (
22479  in unsigned long cpuId,
22480  in long long address,
22481  in unsigned long size,
22482  [retval] out octet[] bytes
22483  );
22484 
22501  void writeVirtualMemory (
22502  in unsigned long cpuId,
22503  in long long address,
22504  in unsigned long size,
22505  in octet[] bytes
22506  );
22507 
22515  void loadPlugIn (
22516  in wstring name,
22517  [retval] out wstring plugInName
22518  );
22519 
22525  void unloadPlugIn (
22526  in wstring name
22527  );
22528 
22541  void detectOS (
22542  [retval] out wstring os
22543  );
22544 
22558  void queryOSKernelLog (
22559  in unsigned long maxMessages,
22560  [retval] out wstring dmesg
22561  );
22562 
22577  void getRegister (
22578  in unsigned long cpuId,
22579  in wstring name,
22580  [retval] out wstring value
22581  );
22582 
22597  void getRegisters (
22598  in unsigned long cpuId,
22599  out wstring[] names,
22600  out wstring[] values
22601  );
22602 
22621  void setRegister (
22622  in unsigned long cpuId,
22623  in wstring name,
22624  in wstring value
22625  );
22626 
22645  void setRegisters (
22646  in unsigned long cpuId,
22647  in wstring[] names,
22648  in wstring[] values
22649  );
22650 
22663  void dumpGuestStack (
22664  in unsigned long cpuId,
22665  [retval] out wstring stack
22666  );
22667 
22675  void resetStats (
22676  in wstring pattern
22677  );
22678 
22686  void dumpStats (
22687  in wstring pattern
22688  );
22689 
22701  void getStats (
22702  in wstring pattern,
22703  in boolean withDescriptions,
22704  [retval] out wstring stats
22705  );
22706 
22707 }; /* interface IMachineDebugger */
22708 
22709 interface IUSBDeviceFilters : $unknown
22710 {
22736  readonly attribute IUSBDeviceFilter[] deviceFilters;
22737 
22765  void createDeviceFilter (
22766  in wstring name,
22767  [retval] out IUSBDeviceFilter filter
22768  );
22769 
22814  void insertDeviceFilter (
22815  in unsigned long position,
22816  in IUSBDeviceFilter filter
22817  );
22818 
22851  void removeDeviceFilter (
22852  in unsigned long position,
22853  [retval] out IUSBDeviceFilter filter
22854  );
22855 
22856 }; /* interface IUSBDeviceFilters */
22857 
22858 interface IUSBController : $unknown
22859 {
22865  attribute wstring name;
22866 
22873 
22881  readonly attribute unsigned short USBStandard;
22882 
22883 }; /* interface IUSBController */
22884 
22897 interface IUSBDevice : $unknown
22898 {
22905  readonly attribute wstringUUID id;
22906 
22910  readonly attribute unsigned short vendorId;
22911 
22915  readonly attribute unsigned short productId;
22916 
22924  readonly attribute unsigned short revision;
22925 
22929  readonly attribute wstring manufacturer;
22930 
22934  readonly attribute wstring product;
22935 
22939  readonly attribute wstring serialNumber;
22940 
22944  readonly attribute wstring address;
22945 
22952  readonly attribute unsigned short port;
22953 
22959  readonly attribute unsigned short version;
22960 
22968  readonly attribute unsigned short portVersion;
22969 
22975  readonly attribute USBConnectionSpeed speed;
22976 
22983  readonly attribute boolean remote;
22984 
22996  readonly attribute wstring[] deviceInfo;
22997 
23003  readonly attribute wstring backend;
23004 
23005 }; /* interface IUSBDevice */
23006 
23082 interface IUSBDeviceFilter : $unknown
23083 {
23091  attribute wstring name;
23092 
23096  attribute boolean active;
23097 
23105  attribute wstring vendorId;
23106 
23114  attribute wstring productId;
23115 
23129  attribute wstring revision;
23130 
23135  attribute wstring manufacturer;
23136 
23141  attribute wstring product;
23142 
23147  attribute wstring serialNumber;
23148 
23153  attribute wstring port;
23154 
23164  attribute wstring remote;
23165 
23175  attribute unsigned long maskedInterfaces;
23176 
23177 }; /* interface IUSBDeviceFilter */
23178 
23196 {
23202  readonly attribute USBDeviceState state;
23203 
23204 }; /* interface IHostUSBDevice */
23205 
23229 {
23237 
23238 }; /* interface IHostUSBDeviceFilter */
23239 
23248 interface IUSBProxyBackend : $unknown
23249 {
23255  readonly attribute wstring name;
23256 
23262  readonly attribute wstring type;
23263 
23264 }; /* interface IUSBProxyBackend */
23265 
23274 interface IAudioAdapter : $unknown
23275 {
23284  attribute boolean enabled;
23285 
23292  attribute boolean enabledIn;
23293 
23300  attribute boolean enabledOut;
23301 
23308 
23318 
23326 
23332  readonly attribute wstring[] propertiesList;
23333 
23347  void setProperty (
23348  in wstring key,
23349  in wstring value
23350  );
23351 
23365  void getProperty (
23366  in wstring key,
23367  [retval] out wstring value
23368  );
23369 
23370 }; /* interface IAudioAdapter */
23371 
23372 interface IVRDEServer : $unknown
23373 {
23377  attribute boolean enabled;
23378 
23382  attribute AuthType authType;
23383 
23387  attribute unsigned long authTimeout;
23388 
23395  attribute boolean allowMultiConnection;
23396 
23404  attribute boolean reuseSingleConnection;
23405 
23412  attribute wstring VRDEExtPack;
23413 
23420  attribute wstring authLibrary;
23421 
23427  readonly attribute wstring[] VRDEProperties;
23428 
23442  void setVRDEProperty (
23443  in wstring key,
23444  in wstring value
23445  );
23446 
23460  void getVRDEProperty (
23461  in wstring key,
23462  [retval] out wstring value
23463  );
23464 
23465 }; /* interface IVRDEServer */
23466 
23526 interface ISharedFolder : $unknown
23527 {
23531  readonly attribute wstring name;
23532 
23536  readonly attribute wstring hostPath;
23537 
23547  readonly attribute boolean accessible;
23548 
23555  readonly attribute boolean writable;
23556 
23562  readonly attribute boolean autoMount;
23563 
23576  readonly attribute wstring lastAccessError;
23577 
23578 }; /* interface ISharedFolder */
23579 
23580 interface IInternalSessionControl : $unknown
23581 {
23586  readonly attribute unsigned long PID;
23587 
23609  readonly attribute IConsole remoteConsole;
23610 
23617  readonly attribute MachineState nominalState;
23618 
23633  void assignRemoteMachine (
23634  in IMachine machine,
23635  in IConsole console
23636  );
23637 
23661  void updateMachineState (
23662  in MachineState machineState
23663  );
23664 
23680  void uninitialize();
23681 
23704  void onNetworkAdapterChange (
23705  in INetworkAdapter networkAdapter,
23706  in boolean changeAdapter
23707  );
23708 
23731  void onAudioAdapterChange (
23732  in IAudioAdapter audioAdapter
23733  );
23734 
23757  void onSerialPortChange (
23758  in ISerialPort serialPort
23759  );
23760 
23783  void onParallelPortChange (
23784  in IParallelPort parallelPort
23785  );
23786 
23809  void onStorageControllerChange();
23810 
23837  void onMediumChange (
23838  in IMediumAttachment mediumAttachment,
23839  in boolean force
23840  );
23841 
23871  void onStorageDeviceChange (
23872  in IMediumAttachment mediumAttachment,
23873  in boolean remove,
23874  in boolean silent
23875  );
23876 
23884  void onClipboardModeChange (
23885  in ClipboardMode clipboardMode
23886  );
23887 
23895  void onDnDModeChange (
23896  in DnDMode dndMode
23897  );
23898 
23908  void onCPUChange (
23909  in unsigned long cpu,
23910  in boolean add
23911  );
23912 
23920  void onCPUExecutionCapChange (
23921  in unsigned long executionCap
23922  );
23923 
23948  void onVRDEServerChange (
23949  in boolean restart
23950  );
23951 
23957  void onVideoCaptureChange();
23958 
23981  void onUSBControllerChange();
23982 
24011  void onSharedFolderChange (
24012  in boolean global
24013  );
24014 
24040  void onUSBDeviceAttach (
24041  in IUSBDevice device,
24042  in IVirtualBoxErrorInfo error,
24043  in unsigned long maskedInterfaces,
24044  in wstring captureFilename
24045  );
24046 
24072  void onUSBDeviceDetach (
24073  in wstringUUID id,
24074  in IVirtualBoxErrorInfo error
24075  );
24076 
24094  void onShowWindow (
24095  in boolean check,
24096  out boolean canShow,
24097  out long long winId
24098  );
24099 
24107  void onBandwidthGroupChange (
24108  in IBandwidthGroup bandwidthGroup
24109  );
24110 
24136  void accessGuestProperty (
24137  in wstring name,
24138  in wstring value,
24139  in wstring flags,
24140  in unsigned long accessMode,
24141  out wstring retValue,
24142  out long long retTimestamp,
24143  out wstring retFlags
24144  );
24145 
24193  void enumerateGuestProperties (
24194  in wstring patterns,
24195  out wstring[] keys,
24196  out wstring[] values,
24197  out long long[] timestamps,
24198  out wstring[] flags
24199  );
24200 
24235  void onlineMergeMedium (
24236  in IMediumAttachment mediumAttachment,
24237  in unsigned long sourceIdx,
24238  in unsigned long targetIdx,
24239  in IProgress progress
24240  );
24241 
24267  void reconfigureMediumAttachments (
24268  in IMediumAttachment[] attachments
24269  );
24270 
24294  void enableVMMStatistics (
24295  in boolean enable
24296  );
24297 
24325  void pauseWithReason (
24326  in Reason reason
24327  );
24328 
24356  void resumeWithReason (
24357  in Reason reason
24358  );
24359 
24403  void saveStateWithReason (
24404  in Reason reason,
24405  in IProgress progress,
24406  in ISnapshot snapshot,
24407  in wstring stateFilePath,
24408  in boolean pauseVM,
24409  [retval] out boolean leftPaused
24410  );
24411 
24419  void cancelSaveStateWithReason();
24420 
24444  void assignMachine (
24445  in IMachine machine,
24446  in LockType lockType,
24447  in wstring tokenId
24448  );
24449 
24473  void assignMachine (
24474  in IMachine machine,
24475  in LockType lockType,
24476  in IToken token
24477  );
24478 
24479 }; /* interface IInternalSessionControl */
24480 
24541 interface ISession : $unknown
24542 {
24546  readonly attribute SessionState state;
24547 
24555  readonly attribute SessionType type;
24556 
24567  attribute wstring name;
24568 
24572  readonly attribute IMachine machine;
24573 
24578  readonly attribute IConsole console;
24579 
24611  void unlockMachine();
24612 
24613 }; /* interface ISession */
24614 
24637 interface IStorageController : $unknown
24638 {
24647  attribute wstring name;
24648 
24654  readonly attribute unsigned long maxDevicesPerPortCount;
24655 
24661  readonly attribute unsigned long minPortCount;
24662 
24668  readonly attribute unsigned long maxPortCount;
24669 
24675  attribute unsigned long instance;
24676 
24685  attribute unsigned long portCount;
24686 
24692  readonly attribute StorageBus bus;
24693 
24707 
24722  attribute boolean useHostIOCache;
24723 
24729  readonly attribute boolean bootable;
24730 
24731 }; /* interface IStorageController */
24732 
24756 interface IManagedObjectRef : $unknown
24757 {
24764  void getInterfaceName (
24765  [retval] out wstring return
24766  );
24767 
24775  void release();
24776 
24777 }; /* interface IManagedObjectRef */
24778 
24787 interface IWebsessionManager : $unknown
24788 {
24797  void logon (
24798  in wstring username,
24799  in wstring password,
24800  [retval] out IVirtualBox return
24801  );
24802 
24812  void getSessionObject (
24813  in IVirtualBox refIVirtualBox,
24814  [retval] out ISession return
24815  );
24816 
24825  void logoff (
24826  in IVirtualBox refIVirtualBox
24827  );
24828 
24829 }; /* interface IWebsessionManager */
24830 
24839 interface IPerformanceMetric : $unknown
24840 {
24846  readonly attribute wstring metricName;
24847 
24853  readonly attribute $unknown object;
24854 
24860  readonly attribute wstring description;
24861 
24867  readonly attribute unsigned long period;
24868 
24878  readonly attribute unsigned long count;
24879 
24885  readonly attribute wstring unit;
24886 
24892  readonly attribute long minimumValue;
24893 
24899  readonly attribute long maximumValue;
24900 
24901 }; /* interface IPerformanceMetric */
24902 
25013 interface IPerformanceCollector : $unknown
25014 {
25025  readonly attribute wstring[] metricNames;
25026 
25050  void getMetrics (
25051  in wstring[] metricNames,
25052  in $unknown[] objects,
25053  [retval] out IPerformanceMetric[] metrics
25054  );
25055 
25094  void setupMetrics (
25095  in wstring[] metricNames,
25096  in $unknown[] objects,
25097  in unsigned long period,
25098  in unsigned long count,
25099  [retval] out IPerformanceMetric[] affectedMetrics
25100  );
25101 
25130  void enableMetrics (
25131  in wstring[] metricNames,
25132  in $unknown[] objects,
25133  [retval] out IPerformanceMetric[] affectedMetrics
25134  );
25135 
25164  void disableMetrics (
25165  in wstring[] metricNames,
25166  in $unknown[] objects,
25167  [retval] out IPerformanceMetric[] affectedMetrics
25168  );
25169 
25259  void queryMetricsData (
25260  in wstring[] metricNames,
25261  in $unknown[] objects,
25262  out wstring[] returnMetricNames,
25263  out $unknown[] returnObjects,
25264  out wstring[] returnUnits,
25265  out unsigned long[] returnScales,
25266  out unsigned long[] returnSequenceNumbers,
25267  out unsigned long[] returnDataIndices,
25268  out unsigned long[] returnDataLengths,
25269  [retval] out long[] returnData
25270  );
25271 
25272 }; /* interface IPerformanceCollector */
25273 
25281 interface INATEngine : $unknown
25282 {
25287  attribute wstring network;
25288 
25295  attribute wstring hostIP;
25296 
25301  attribute wstring TFTPPrefix;
25302 
25307  attribute wstring TFTPBootFile;
25308 
25316  attribute wstring TFTPNextServer;
25317 
25321  attribute unsigned long aliasMode;
25322 
25326  attribute boolean DNSPassDomain;
25327 
25332  attribute boolean DNSProxy;
25333 
25338  attribute boolean DNSUseHostResolver;
25339 
25344  readonly attribute wstring[] redirects;
25345 
25361  void setNetworkSettings (
25362  in unsigned long mtu,
25363  in unsigned long sockSnd,
25364  in unsigned long sockRcv,
25365  in unsigned long TcpWndSnd,
25366  in unsigned long TcpWndRcv
25367  );
25368 
25373  void getNetworkSettings (
25374  out unsigned long mtu,
25375  out unsigned long sockSnd,
25376  out unsigned long sockRcv,
25377  out unsigned long TcpWndSnd,
25378  out unsigned long TcpWndRcv
25379  );
25380 
25400  void addRedirect (
25401  in wstring name,
25402  in NATProtocol proto,
25403  in wstring hostIP,
25404  in unsigned short hostPort,
25405  in wstring guestIP,
25406  in unsigned short guestPort
25407  );
25408 
25414  void removeRedirect (
25415  in wstring name
25416  );
25417 
25418 }; /* interface INATEngine */
25419 
25428 interface IExtPackPlugIn : $unknown
25429 {
25433  readonly attribute wstring name;
25434 
25438  readonly attribute wstring description;
25439 
25445  readonly attribute wstring frontend;
25446 
25450  readonly attribute wstring modulePath;
25451 
25452 }; /* interface IExtPackPlugIn */
25453 
25462 interface IExtPackBase : $unknown
25463 {
25467  readonly attribute wstring name;
25468 
25472  readonly attribute wstring description;
25473 
25485  readonly attribute wstring version;
25486 
25490  readonly attribute unsigned long revision;
25491 
25501  readonly attribute wstring edition;
25502 
25506  readonly attribute wstring VRDEModule;
25507 
25511  readonly attribute IExtPackPlugIn[] plugIns;
25512 
25522  readonly attribute boolean usable;
25523 
25530  readonly attribute wstring whyUnusable;
25531 
25535  readonly attribute boolean showLicense;
25536 
25545  readonly attribute wstring license;
25546 
25570  void queryLicense (
25571  in wstring preferredLocale,
25572  in wstring preferredLanguage,
25573  in wstring format,
25574  [retval] out wstring licenseText
25575  );
25576 
25577 }; /* interface IExtPackBase */
25578 
25588 {
25600  void queryObject (
25601  in wstring objUuid,
25602  [retval] out $unknown returnInterface
25603  );
25604 
25605 }; /* interface IExtPack */
25606 
25617 {
25623  readonly attribute wstring filePath;
25624 
25643  void install (
25644  in boolean replace,
25645  in wstring displayInfo,
25646  [retval] out IProgress progess
25647  );
25648 
25649 }; /* interface IExtPackFile */
25650 
25660 interface IExtPackManager : $unknown
25661 {
25667  readonly attribute IExtPack[] installedExtPacks;
25668 
25686  void find (
25687  in wstring name,
25688  [retval] out IExtPack returnData
25689  );
25690 
25702  void openExtPackFile (
25703  in wstring path,
25704  [retval] out IExtPackFile file
25705  );
25706 
25725  void uninstall (
25726  in wstring name,
25727  in boolean forcedRemoval,
25728  in wstring displayInfo,
25729  [retval] out IProgress progess
25730  );
25731 
25735  void cleanup();
25736 
25749  void queryAllPlugInsForFrontend (
25750  in wstring frontendName,
25751  [retval] out wstring[] plugInModules
25752  );
25753 
25761  void isExtPackUsable (
25762  in wstring name,
25763  [retval] out boolean usable
25764  );
25765 
25766 }; /* interface IExtPackManager */
25767 
25773 interface IBandwidthGroup : $unknown
25774 {
25778  readonly attribute wstring name;
25779 
25783  readonly attribute BandwidthGroupType type;
25784 
25788  readonly attribute unsigned long reference;
25789 
25794  attribute long long maxBytesPerSec;
25795 
25796 }; /* interface IBandwidthGroup */
25797 
25806 interface IBandwidthControl : $unknown
25807 {
25813  readonly attribute unsigned long numGroups;
25814 
25827  void createBandwidthGroup (
25828  in wstring name,
25829  in BandwidthGroupType type,
25830  in long long maxBytesPerSec
25831  );
25832 
25840  void deleteBandwidthGroup (
25841  in wstring name
25842  );
25843 
25853  void getBandwidthGroup (
25854  in wstring name,
25855  [retval] out IBandwidthGroup bandwidthGroup
25856  );
25857 
25865  void getAllBandwidthGroups (
25866  [retval] out IBandwidthGroup[] bandwidthGroups
25867  );
25868 
25869 }; /* interface IBandwidthControl */
25870 
25889 interface IVirtualBoxClient : $unknown
25890 {
25896  readonly attribute IVirtualBox virtualBox;
25897 
25903  readonly attribute ISession session;
25904 
25910  readonly attribute IEventSource eventSource;
25911 
25922  void checkMachineError (
25923  in IMachine machine
25924  );
25925 
25926 }; /* interface IVirtualBoxClient */
25927 
25941 interface IEventSource : $unknown
25942 {
25948  void createListener (
25949  [retval] out IEventListener listener
25950  );
25951 
25967  void createAggregator (
25968  in IEventSource[] subordinates,
25969  [retval] out IEventSource result
25970  );
25971 
26004  void registerListener (
26005  in IEventListener listener,
26006  in VBoxEventType[] interesting,
26007  in boolean active
26008  );
26009 
26018  void unregisterListener (
26019  in IEventListener listener
26020  );
26021 
26036  void fireEvent (
26037  in IEvent event,
26038  in long timeout,
26039  [retval] out boolean result
26040  );
26041 
26066  void getEvent (
26067  in IEventListener listener,
26068  in long timeout,
26069  [retval] out IEvent event
26070  );
26071 
26083  void eventProcessed (
26084  in IEventListener listener,
26085  in IEvent event
26086  );
26087 
26088 }; /* interface IEventSource */
26089 
26099 interface IEventListener : $unknown
26100 {
26113  void handleEvent (
26114  in IEvent event
26115  );
26116 
26117 }; /* interface IEventListener */
26118 
26196 interface IEvent : $unknown
26197 {
26203  readonly attribute VBoxEventType type;
26204 
26210  readonly attribute IEventSource source;
26211 
26222  readonly attribute boolean waitable;
26223 
26230  void setProcessed();
26231 
26245  void waitProcessed (
26246  in long timeout,
26247  [retval] out boolean result
26248  );
26249 
26250 }; /* interface IEvent */
26251 
26258 {
26262  readonly attribute unsigned long generation;
26263 
26270  void reuse();
26271 
26272 }; /* interface IReusableEvent */
26273 
26280 {
26284  readonly attribute wstringUUID machineId;
26285 
26286 }; /* interface IMachineEvent */
26287 
26294 {
26298  readonly attribute MachineState state;
26299 
26300 }; /* interface IMachineStateChangedEvent */
26301 
26310 {
26317  readonly attribute boolean temporary;
26318 
26319 }; /* interface IMachineDataChangedEvent */
26320 
26332 {
26336  readonly attribute wstringUUID mediumId;
26337 
26341  readonly attribute DeviceType mediumType;
26342 
26349  readonly attribute boolean registered;
26350 
26351 }; /* interface IMediumRegisteredEvent */
26352 
26364 {
26368  readonly attribute IMedium medium;
26369 
26370 }; /* interface IMediumConfigChangedEvent */
26371 
26381 {
26388  readonly attribute boolean registered;
26389 
26390 }; /* interface IMachineRegisteredEvent */
26391 
26402 {
26408  readonly attribute SessionState state;
26409 
26410 }; /* interface ISessionStateChangedEvent */
26411 
26420 {
26426  readonly attribute wstring name;
26427 
26433  readonly attribute wstring value;
26434 
26440  readonly attribute wstring flags;
26441 
26442 }; /* interface IGuestPropertyChangedEvent */
26443 
26450 {
26454  readonly attribute wstringUUID snapshotId;
26455 
26456 }; /* interface ISnapshotEvent */
26457 
26468 {
26469  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
26470 
26471 }; /* interface ISnapshotTakenEvent */
26472 
26490 {
26491  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
26492 
26493 }; /* interface ISnapshotDeletedEvent */
26494 
26505 {
26506  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
26507 
26508 }; /* interface ISnapshotRestoredEvent */
26509 
26520 {
26521  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
26522 
26523 }; /* interface ISnapshotChangedEvent */
26524 
26534 {
26540  readonly attribute boolean visible;
26541 
26547  readonly attribute boolean alpha;
26548 
26554  readonly attribute unsigned long xhot;
26555 
26561  readonly attribute unsigned long yhot;
26562 
26568  readonly attribute unsigned long width;
26569 
26575  readonly attribute unsigned long height;
26576 
26609  readonly attribute octet[] shape;
26610 
26611 }; /* interface IMousePointerShapeChangedEvent */
26612 
26622 {
26628  readonly attribute boolean supportsAbsolute;
26629 
26635  readonly attribute boolean supportsRelative;
26636 
26642  readonly attribute boolean supportsMultiTouch;
26643 
26649  readonly attribute boolean needsHostCursor;
26650 
26651 }; /* interface IMouseCapabilityChangedEvent */
26652 
26662 {
26668  readonly attribute boolean numLock;
26669 
26675  readonly attribute boolean capsLock;
26676 
26682  readonly attribute boolean scrollLock;
26683 
26684 }; /* interface IKeyboardLedsChangedEvent */
26685 
26695 {
26701  readonly attribute MachineState state;
26702 
26703 }; /* interface IStateChangedEvent */
26704 
26715 {
26716  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
26717 
26718 }; /* interface IAdditionsStateChangedEvent */
26719 
26731 {
26737  readonly attribute INetworkAdapter networkAdapter;
26738 
26739 }; /* interface INetworkAdapterChangedEvent */
26740 
26751 {
26757  readonly attribute IAudioAdapter audioAdapter;
26758 
26759 }; /* interface IAudioAdapterChangedEvent */
26760 
26772 {
26778  readonly attribute ISerialPort serialPort;
26779 
26780 }; /* interface ISerialPortChangedEvent */
26781 
26793 {
26799  readonly attribute IParallelPort parallelPort;
26800 
26801 }; /* interface IParallelPortChangedEvent */
26802 
26813 {
26814  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
26815 
26816 }; /* interface IStorageControllerChangedEvent */
26817 
26830 {
26837 
26838 }; /* interface IMediumChangedEvent */
26839 
26848 {
26854  readonly attribute ClipboardMode clipboardMode;
26855 
26856 }; /* interface IClipboardModeChangedEvent */
26857 
26866 {
26872  readonly attribute DnDMode dndMode;
26873 
26874 }; /* interface IDnDModeChangedEvent */
26875 
26884 {
26890  readonly attribute unsigned long CPU;
26891 
26897  readonly attribute boolean add;
26898 
26899 }; /* interface ICPUChangedEvent */
26900 
26909 {
26915  readonly attribute unsigned long executionCap;
26916 
26917 }; /* interface ICPUExecutionCapChangedEvent */
26918 
26927 {
26933  readonly attribute long[] scancodes;
26934 
26935 }; /* interface IGuestKeyboardEvent */
26936 
26945 {
26951  readonly attribute GuestMouseEventMode mode;
26952 
26958  readonly attribute long x;
26959 
26965  readonly attribute long y;
26966 
26972  readonly attribute long z;
26973 
26979  readonly attribute long w;
26980 
26986  readonly attribute long buttons;
26987 
26988 }; /* interface IGuestMouseEvent */
26989 
26998 {
27004  readonly attribute long contactCount;
27005 
27011  readonly attribute short[] xPositions;
27012 
27018  readonly attribute short[] yPositions;
27019 
27025  readonly attribute unsigned short[] contactIds;
27026 
27034  readonly attribute unsigned short[] contactFlags;
27035 
27041  readonly attribute unsigned long scanTime;
27042 
27043 }; /* interface IGuestMultiTouchEvent */
27044 
27051 {
27055  readonly attribute IGuestSession session;
27056 
27057 }; /* interface IGuestSessionEvent */
27058 
27067 {
27073  readonly attribute unsigned long id;
27074 
27080  readonly attribute GuestSessionStatus status;
27081 
27091  readonly attribute IVirtualBoxErrorInfo error;
27092 
27093 }; /* interface IGuestSessionStateChangedEvent */
27094 
27103 {
27110  readonly attribute boolean registered;
27111 
27112 }; /* interface IGuestSessionRegisteredEvent */
27113