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 {
340 };
341 
350 {
353 };
354 
468 {
688 };
689 
700 {
748 };
749 
759 {
790 };
791 
802 {
852 };
853 
863 {
895 };
896 
905 {
921 };
922 
931 {
959 };
960 
970 {
998 };
999 
1008 {
1052 };
1053 
1062 {
1067 };
1068 
1077 {
1082 };
1083 
1092 {
1097 };
1098 
1109 enum Scope
1110 {
1114 };
1115 
1124 {
1128 };
1129 
1138 {
1143 };
1144 
1153 {
1179 };
1180 
1189 {
1228 };
1229 
1238 {
1260 };
1261 
1271 {
1295  BitmapFormat_BGR = 0x20524742,
1302  BitmapFormat_BGR0 = 0x30524742,
1309  BitmapFormat_BGRA = 0x41524742,
1316  BitmapFormat_RGBA = 0x41424752,
1323  BitmapFormat_PNG = 0x20474E50,
1330  BitmapFormat_JPEG = 0x4745504A,
1331 };
1332 
1334 {
1398 };
1399 
1401 {
1404 };
1405 
1414 {
1419 };
1420 
1429 {
1445 };
1446 
1455 {
1484 };
1485 
1493 {
1522 };
1523 
1531 {
1536 };
1537 
1545 {
1561 };
1562 
1570 {
1591 };
1592 
1601 {
1617 };
1618 
1627 {
1648 };
1649 
1658 {
1679 };
1680 
1692 {
1721 };
1722 
1733 {
1755 };
1756 
1765 {
1768 };
1769 
1778 {
1822 };
1823 
1832 {
1868 };
1869 
1878 {
1924 };
1925 
1934 {
1955 };
1956 
1965 {
1979 };
1980 
1990 {
2036 };
2037 
2046 {
2067 };
2068 
2083 {
2129 };
2130 
2139 {
2289 };
2290 
2299 {
2316 };
2317 
2326 {
2337 };
2338 
2348 {
2359 };
2360 
2369 {
2400 };
2401 
2421 {
2481 };
2482 
2493 {
2527 };
2528 
2537 {
2568 };
2569 
2578 {
2589 };
2590 
2601 {
2612 };
2613 
2628 {
2644 };
2645 
2655 {
2667 };
2668 
2681 {
2740 };
2741 
2750 {
2761 };
2762 
2772 {
2788 };
2789 
2798 {
2809 };
2810 
2819 {
2880 };
2881 
2890 {
2916 };
2917 
2927 {
2947 };
2948 
2958 {
2992 };
2993 
3003 {
3048 };
3049 
3058 {
3094 };
3095 
3104 {
3110 };
3111 
3120 {
3156 };
3157 
3166 {
3214 };
3215 
3224 {
3245 };
3246 
3255 {
3266 };
3267 
3278 {
3336 };
3337 
3349 {
3404 };
3405 
3416 {
3482 };
3483 
3485 {
3489 };
3490 
3492 {
3498 };
3499 
3508 {
3586 };
3587 
3596 {
3600 };
3601 
3610 {
3619 };
3620 
3629 {
3648 };
3649 
3658 {
3680 };
3681 
3690 {
3705 };
3706 
3715 {
3727 };
3728 
3737 {
3773 };
3774 
3783 {
3805 };
3806 
3816 {
3842 };
3843 
3852 {
3866 };
3867 
3888 {
3931 };
3932 
3972 {
4019 };
4020 
4031 {
4047 };
4048 
4057 {
4103 };
4104 
4113 {
4117 };
4118 
4128 {
4154 };
4155 
4164 {
4172 };
4173 
4182 {
4208 };
4209 
4219 {
4231 };
4232 
4242 {
4293 };
4294 
4303 {
4319 };
4320 
4327 {
4343 };
4344 
4351 {
4362 };
4363 
4372 {
4394 };
4395 
4405 {
4926 };
4927 
4941 {
4956 };
4957 
4966 {
4988 };
4989 
5023 interface IVirtualBoxErrorInfo : $errorinfo
5024 {
5042  readonly attribute long resultCode;
5043 
5050  readonly attribute long resultDetail;
5051 
5063  readonly attribute wstringUUID interfaceID;
5064 
5075  readonly attribute wstring component;
5076 
5087  readonly attribute wstring text;
5088 
5099  readonly attribute IVirtualBoxErrorInfo next;
5100 
5101 }; /* interface IVirtualBoxErrorInfo */
5102 
5103 interface INATNetwork : $unknown
5104 {
5113  attribute wstring networkName;
5114 
5115  attribute boolean enabled;
5116 
5125  attribute wstring network;
5126 
5133  readonly attribute wstring gateway;
5134 
5140  attribute boolean IPv6Enabled;
5141 
5149  attribute wstring IPv6Prefix;
5150 
5152 
5153  attribute boolean needDhcpServer;
5154 
5155  readonly attribute IEventSource eventSource;
5156 
5163  readonly attribute wstring[] portForwardRules4;
5164 
5169  readonly attribute wstring[] localMappings;
5170 
5175  attribute long loopbackIp6;
5176 
5182  readonly attribute wstring[] portForwardRules6;
5183 
5187  void addLocalMapping (
5188  in wstring hostid,
5189  in long offset
5190  );
5191 
5192  void addPortForwardRule (
5193  in boolean isIpv6,
5194  in wstring ruleName,
5195  in NATProtocol proto,
5196  in wstring hostIP,
5197  in unsigned short hostPort,
5198  in wstring guestIP,
5199  in unsigned short guestPort
5200  );
5201 
5202  void removePortForwardRule (
5203  in boolean iSipv6,
5204  in wstring ruleName
5205  );
5206 
5207  void start (
5208  in wstring trunkType
5209  );
5210 
5211  void stop();
5212 
5213 }; /* interface INATNetwork */
5214 
5225 interface IDHCPServer : $unknown
5226 {
5227  readonly attribute IEventSource eventSource;
5228 
5234  attribute boolean enabled;
5235 
5241  readonly attribute wstring IPAddress;
5242 
5248  readonly attribute wstring networkMask;
5249 
5255  readonly attribute wstring networkName;
5256 
5262  readonly attribute wstring lowerIP;
5263 
5269  readonly attribute wstring upperIP;
5270 
5271  readonly attribute wstring[] globalOptions;
5272 
5273  readonly attribute wstring[] vmConfigs;
5274 
5275  void addGlobalOption (
5276  in DhcpOpt option,
5277  in wstring value
5278  );
5279 
5280  void addVmSlotOption (
5281  in wstring vmname,
5282  in long slot,
5283  in DhcpOpt option,
5284  in wstring value
5285  );
5286 
5287  void removeVmSlotOptions (
5288  in wstring vmname,
5289  in long slot
5290  );
5291 
5292  void getVmSlotOptions (
5293  in wstring vmname,
5294  in long slot,
5295  [retval] out wstring[] option
5296  );
5297 
5298  void getMacOptions (
5299  in wstring mac,
5300  [retval] out wstring[] option
5301  );
5302 
5331  void setConfiguration (
5332  in wstring IPAddress,
5333  in wstring networkMask,
5334  in wstring FromIPAddress,
5335  in wstring ToIPAddress
5336  );
5337 
5362  void start (
5363  in wstring networkName,
5364  in wstring trunkName,
5365  in wstring trunkType
5366  );
5367 
5380  void stop();
5381 
5382 }; /* interface IDHCPServer */
5383 
5402 interface IVirtualBox : $unknown
5403 {
5416  readonly attribute wstring version;
5417 
5425  readonly attribute wstring versionNormalized;
5426 
5432  readonly attribute unsigned long revision;
5433 
5443  readonly attribute wstring packageType;
5444 
5456  readonly attribute wstring APIVersion;
5457 
5465  readonly attribute long long APIRevision;
5466 
5482  readonly attribute wstring homeFolder;
5483 
5491  readonly attribute wstring settingsFilePath;
5492 
5496  readonly attribute IHost host;
5497 
5502 
5508  readonly attribute IMachine[] machines;
5509 
5519  readonly attribute wstring[] machineGroups;
5520 
5530  readonly attribute IMedium[] hardDisks;
5531 
5537  readonly attribute IMedium[] DVDImages;
5538 
5544  readonly attribute IMedium[] floppyImages;
5545 
5546  readonly attribute IProgress[] progressOperations;
5547 
5548  readonly attribute IGuestOSType[] guestOSTypes;
5549 
5566  readonly attribute ISharedFolder[] sharedFolders;
5567 
5574 
5580  readonly attribute IDHCPServer[] DHCPServers;
5581 
5582  readonly attribute INATNetwork[] NATNetworks;
5583 
5589  readonly attribute IEventSource eventSource;
5590 
5597 
5603  readonly attribute wstring[] internalNetworks;
5604 
5610  readonly attribute wstring[] genericNetworkDrivers;
5611 
5663  void composeMachineFilename (
5664  in wstring name,
5665  in wstring group,
5666  in wstring createFlags,
5667  in wstring baseFolder,
5668  [retval] out wstring file
5669  );
5670 
5778  void createMachine (
5779  in wstring settingsFile,
5780  in wstring name,
5781  in wstring[] groups,
5782  in wstring osTypeId,
5783  in wstring flags,
5784  [retval] out IMachine machine
5785  );
5786 
5817  void openMachine (
5818  in wstring settingsFile,
5819  [retval] out IMachine machine
5820  );
5821 
5853  void registerMachine (
5854  in IMachine machine
5855  );
5856 
5877  void findMachine (
5878  in wstring nameOrId,
5879  [retval] out IMachine machine
5880  );
5881 
5893  void getMachinesByGroups (
5894  in wstring[] groups,
5895  [retval] out IMachine[] machines
5896  );
5897 
5907  void getMachineStates (
5908  in IMachine[] machines,
5909  [retval] out MachineState[] states
5910  );
5911 
5921  void createAppliance (
5922  [retval] out IAppliance appliance
5923  );
5924 
6010  void createMedium (
6011  in wstring format,
6012  in wstring location,
6013  in AccessMode accessMode,
6014  in DeviceType aDeviceTypeType,
6015  [retval] out IMedium medium
6016  );
6017 
6124  void openMedium (
6125  in wstring location,
6126  in DeviceType deviceType,
6127  in AccessMode accessMode,
6128  in boolean forceNewUuid,
6129  [retval] out IMedium medium
6130  );
6131 
6160  void getGuestOSType (
6161  in wstring id,
6162  [retval] out IGuestOSType type
6163  );
6164 
6187  void createSharedFolder (
6188  in wstring name,
6189  in wstring hostPath,
6190  in boolean writable,
6191  in boolean automount
6192  );
6193 
6208  void removeSharedFolder (
6209  in wstring name
6210  );
6211 
6220  void getExtraDataKeys (
6221  [retval] out wstring[] keys
6222  );
6223 
6252  void getExtraData (
6253  in wstring key,
6254  [retval] out wstring value
6255  );
6256 
6306  void setExtraData (
6307  in wstring key,
6308  in wstring value
6309  );
6310 
6329  void setSettingsSecret (
6330  in wstring password
6331  );
6332 
6349  void createDHCPServer (
6350  in wstring name,
6351  [retval] out IDHCPServer server
6352  );
6353 
6371  in wstring name,
6372  [retval] out IDHCPServer server
6373  );
6374 
6389  void removeDHCPServer (
6390  in IDHCPServer server
6391  );
6392 
6393  void createNATNetwork (
6394  in wstring networkName,
6395  [retval] out INATNetwork network
6396  );
6397 
6398  void findNATNetworkByName (
6399  in wstring networkName,
6400  [retval] out INATNetwork network
6401  );
6402 
6403  void removeNATNetwork (
6404  in INATNetwork network
6405  );
6406 
6431  void checkFirmwarePresent (
6432  in FirmwareType firmwareType,
6433  in wstring version,
6434  out wstring url,
6435  out wstring file,
6436  [retval] out boolean result
6437  );
6438 
6439 }; /* interface IVirtualBox */
6440 
6451 interface IVFSExplorer : $unknown
6452 {
6456  readonly attribute wstring path;
6457 
6461  readonly attribute VFSType type;
6462 
6470  void update (
6471  [retval] out IProgress progress
6472  );
6473 
6481  void cd (
6482  in wstring dir,
6483  [retval] out IProgress progress
6484  );
6485 
6491  void cdUp (
6492  [retval] out IProgress progress
6493  );
6494 
6507  void entryList (
6508  out wstring[] names,
6509  out unsigned long[] types,
6510  out long long[] sizes,
6511  out unsigned long[] modes
6512  );
6513 
6522  void exists (
6523  in wstring[] names,
6524  [retval] out wstring[] exists
6525  );
6526 
6534  void remove (
6535  in wstring[] names,
6536  [retval] out IProgress progress
6537  );
6538 
6539 }; /* interface IVFSExplorer */
6540 
6609 interface IAppliance : $unknown
6610 {
6618  readonly attribute wstring path;
6619 
6651  readonly attribute wstring[] disks;
6652 
6661 
6669  readonly attribute wstring[] machines;
6670 
6687  void read (
6688  in wstring file,
6689  [retval] out IProgress progress
6690  );
6691 
6708  void interpret();
6709 
6732  void importMachines (
6733  in ImportOptions[] options,
6734  [retval] out IProgress progress
6735  );
6736 
6744  void createVFSExplorer (
6745  in wstring URI,
6746  [retval] out IVFSExplorer explorer
6747  );
6748 
6775  void write (
6776  in wstring format,
6777  in ExportOptions[] options,
6778  in wstring path,
6779  [retval] out IProgress progress
6780  );
6781 
6787  void getWarnings (
6788  [retval] out wstring[] warnings
6789  );
6790 
6799  void getPasswordIds (
6800  [retval] out wstring[] identifiers
6801  );
6802 
6813  in wstring passwordId,
6814  [retval] out wstringUUID[] identifiers
6815  );
6816 
6827  void addPasswords (
6828  in wstring[] identifiers,
6829  in wstring[] passwords
6830  );
6831 
6832 }; /* interface IAppliance */
6833 
6845 interface IVirtualSystemDescription : $unknown
6846 {
6850  readonly attribute unsigned long count;
6851 
6976  void getDescription (
6977  out VirtualSystemDescriptionType[] types,
6978  out wstring[] refs,
6979  out wstring[] OVFValues,
6980  out wstring[] VBoxValues,
6981  out wstring[] extraConfigValues
6982  );
6983 
7000  void getDescriptionByType (
7002  out VirtualSystemDescriptionType[] types,
7003  out wstring[] refs,
7004  out wstring[] OVFValues,
7005  out wstring[] VBoxValues,
7006  out wstring[] extraConfigValues
7007  );
7008 
7020  void getValuesByType (
7023  [retval] out wstring[] values
7024  );
7025 
7051  void setFinalValues (
7052  in boolean[] enabled,
7053  in wstring[] VBoxValues,
7054  in wstring[] extraConfigValues
7055  );
7056 
7071  void addDescription (
7073  in wstring VBoxValue,
7074  in wstring extraConfigValue
7075  );
7076 
7077 }; /* interface IVirtualSystemDescription */
7078 
7079 interface IInternalMachineControl : $unknown
7080 {
7092  void updateState (
7093  in MachineState state
7094  );
7095 
7107  void beginPowerUp (
7108  in IProgress progress
7109  );
7110 
7120  void endPowerUp (
7121  in long result
7122  );
7123 
7135  void beginPoweringDown (
7136  out IProgress progress
7137  );
7138 
7168  void endPoweringDown (
7169  in long result,
7170  in wstring errMsg
7171  );
7172 
7186  void runUSBDeviceFilters (
7187  in IUSBDevice device,
7188  out boolean matched,
7189  out unsigned long maskedInterfaces
7190  );
7191 
7200  void captureUSBDevice (
7201  in wstringUUID id,
7202  in wstring captureFilename
7203  );
7204 
7220  void detachUSBDevice (
7221  in wstringUUID id,
7222  in boolean done
7223  );
7224 
7233  void autoCaptureUSBDevices();
7234 
7250  void detachAllUSBDevices (
7251  in boolean done
7252  );
7253 
7268  void onSessionEnd (
7269  in ISession session,
7270  [retval] out IProgress progress
7271  );
7272 
7279  void finishOnlineMergeMedium();
7280 
7307  void pullGuestProperties (
7308  out wstring[] names,
7309  out wstring[] values,
7310  out long long[] timestamps,
7311  out wstring[] flags
7312  );
7313 
7335  void pushGuestProperty (
7336  in wstring name,
7337  in wstring value,
7338  in long long timestamp,
7339  in wstring flags
7340  );
7341 
7353  void lockMedia();
7354 
7364  void unlockMedia();
7365 
7381  void ejectMedium (
7382  in IMediumAttachment attachment,
7383  [retval] out IMediumAttachment newAttachment
7384  );
7385 
7426  void reportVmStatistics (
7427  in unsigned long validStats,
7428  in unsigned long cpuUser,
7429  in unsigned long cpuKernel,
7430  in unsigned long cpuIdle,
7431  in unsigned long memTotal,
7432  in unsigned long memFree,
7433  in unsigned long memBalloon,
7434  in unsigned long memShared,
7435  in unsigned long memCache,
7436  in unsigned long pagedTotal,
7437  in unsigned long memAllocTotal,
7438  in unsigned long memFreeTotal,
7439  in unsigned long memBalloonTotal,
7440  in unsigned long memSharedTotal,
7441  in unsigned long vmNetRx,
7442  in unsigned long vmNetTx
7443  );
7444 
7445 }; /* interface IInternalMachineControl */
7446 
7455 interface IBIOSSettings : $unknown
7456 {
7460  attribute boolean logoFadeIn;
7461 
7465  attribute boolean logoFadeOut;
7466 
7470  attribute unsigned long logoDisplayTime;
7471 
7478  attribute wstring logoImagePath;
7479 
7484 
7488  attribute boolean ACPIEnabled;
7489 
7496  attribute boolean IOAPICEnabled;
7497 
7507  attribute long long timeOffset;
7508 
7515  attribute boolean PXEDebugEnabled;
7516 
7525  readonly attribute wstring nonVolatileStorageFile;
7526 
7527 }; /* interface IBIOSSettings */
7528 
7536 interface IPCIAddress : $unknown
7537 {
7543  attribute short bus;
7544 
7550  attribute short device;
7551 
7557  attribute short devFunction;
7558 
7564  void asLong (
7565  [retval] out long result
7566  );
7567 
7573  void fromLong (
7574  in long number
7575  );
7576 
7577 }; /* interface IPCIAddress */
7578 
7586 interface IPCIDeviceAttachment : $unknown
7587 {
7593  readonly attribute wstring name;
7594 
7600  readonly attribute boolean isPhysicalDevice;
7601 
7607  readonly attribute long hostAddress;
7608 
7614  readonly attribute long guestAddress;
7615 
7616 }; /* interface IPCIDeviceAttachment */
7617 
7658 interface IMachine : $unknown
7659 {
7663  readonly attribute IVirtualBox parent;
7664 
7668  attribute octet[] icon;
7669 
7720  readonly attribute boolean accessible;
7721 
7733  readonly attribute IVirtualBoxErrorInfo accessError;
7734 
7775  attribute wstring name;
7776 
7787  attribute wstring description;
7788 
7792  readonly attribute wstringUUID id;
7793 
7804  attribute wstring[] groups;
7805 
7820  attribute wstring OSTypeId;
7821 
7825  attribute wstring hardwareVersion;
7826 
7836  attribute wstringUUID hardwareUUID;
7837 
7841  attribute unsigned long CPUCount;
7842 
7848  attribute boolean CPUHotPlugEnabled;
7849 
7857  attribute unsigned long CPUExecutionCap;
7858 
7870  attribute unsigned long CPUIDPortabilityLevel;
7871 
7875  attribute unsigned long memorySize;
7876 
7880  attribute unsigned long memoryBalloonSize;
7881 
7888  attribute boolean pageFusionEnabled;
7889 
7894 
7898  attribute unsigned long VRAMSize;
7899 
7905  attribute boolean accelerate3DEnabled;
7906 
7912  attribute boolean accelerate2DVideoEnabled;
7913 
7924  attribute unsigned long monitorCount;
7925 
7931  attribute boolean videoCaptureEnabled;
7932 
7938  attribute boolean[] videoCaptureScreens;
7939 
7953  attribute wstring videoCaptureFile;
7954 
7962  attribute unsigned long videoCaptureWidth;
7963 
7971  attribute unsigned long videoCaptureHeight;
7972 
7981  attribute unsigned long videoCaptureRate;
7982 
7992  attribute unsigned long videoCaptureFPS;
7993 
8003  attribute unsigned long videoCaptureMaxTime;
8004 
8014  attribute unsigned long videoCaptureMaxFileSize;
8015 
8023  attribute wstring videoCaptureOptions;
8024 
8028  readonly attribute IBIOSSettings BIOSSettings;
8029 
8035 
8042 
8049 
8056  attribute boolean HPETEnabled;
8057 
8062 
8096  attribute wstring snapshotFolder;
8097 
8101  readonly attribute IVRDEServer VRDEServer;
8102 
8103  attribute boolean emulatedUSBCardReaderEnabled;
8104 
8108  readonly attribute IMediumAttachment[] mediumAttachments;
8109 
8121  readonly attribute IUSBController[] USBControllers;
8122 
8135 
8139  readonly attribute IAudioAdapter audioAdapter;
8140 
8145 
8151  readonly attribute wstring settingsFilePath;
8152 
8177  readonly attribute boolean settingsModified;
8178 
8182  readonly attribute SessionState sessionState;
8183 
8197  readonly attribute wstring sessionName;
8198 
8208  readonly attribute unsigned long sessionPID;
8209 
8213  readonly attribute MachineState state;
8214 
8221  readonly attribute long long lastStateChange;
8222 
8234  readonly attribute wstring stateFilePath;
8235 
8245  readonly attribute wstring logFolder;
8246 
8256  readonly attribute ISnapshot currentSnapshot;
8257 
8264  readonly attribute unsigned long snapshotCount;
8265 
8298  readonly attribute boolean currentStateModified;
8299 
8311  readonly attribute ISharedFolder[] sharedFolders;
8312 
8320 
8326  attribute DnDMode dnDMode;
8327 
8336  attribute boolean teleporterEnabled;
8337 
8348  attribute unsigned long teleporterPort;
8349 
8356  attribute wstring teleporterAddress;
8357 
8368  attribute wstring teleporterPassword;
8369 
8376 
8385 
8392  attribute unsigned long faultTolerancePort;
8393 
8399  attribute wstring faultToleranceAddress;
8400 
8408  attribute wstring faultTolerancePassword;
8409 
8415  attribute unsigned long faultToleranceSyncInterval;
8416 
8424  attribute boolean RTCUseUTC;
8425 
8432  attribute boolean IOCacheEnabled;
8433 
8439  attribute unsigned long IOCacheSize;
8440 
8451 
8458 
8467  attribute boolean tracingEnabled;
8468 
8483  attribute wstring tracingConfig;
8484 
8497  attribute boolean allowTracingToAccessVM;
8498 
8504  attribute boolean autostartEnabled;
8505 
8511  attribute unsigned long autostartDelay;
8512 
8519 
8535  attribute wstring defaultFrontend;
8536 
8542  readonly attribute boolean USBProxyAvailable;
8543 
8564  attribute wstring VMProcessPriority;
8565 
8673  void lockMachine (
8674  in ISession session,
8675  in LockType lockType
8676  );
8677 
8817  void launchVMProcess (
8818  in ISession session,
8819  in wstring name,
8820  in wstring environment,
8821  [retval] out IProgress progress
8822  );
8823 
8861  void setBootOrder (
8862  in unsigned long position,
8863  in DeviceType device
8864  );
8865 
8900  void getBootOrder (
8901  in unsigned long position,
8902  [retval] out DeviceType device
8903  );
8904 
9007  void attachDevice (
9008  in wstring name,
9009  in long controllerPort,
9010  in long device,
9011  in DeviceType type,
9012  in IMedium medium
9013  );
9014 
9112  in wstring name,
9113  in long controllerPort,
9114  in long device,
9115  in DeviceType type
9116  );
9117 
9171  void detachDevice (
9172  in wstring name,
9173  in long controllerPort,
9174  in long device
9175  );
9176 
9219  void passthroughDevice (
9220  in wstring name,
9221  in long controllerPort,
9222  in long device,
9223  in boolean passthrough
9224  );
9225 
9268  void temporaryEjectDevice (
9269  in wstring name,
9270  in long controllerPort,
9271  in long device,
9272  in boolean temporaryEject
9273  );
9274 
9320  void nonRotationalDevice (
9321  in wstring name,
9322  in long controllerPort,
9323  in long device,
9324  in boolean nonRotational
9325  );
9326 
9373  in wstring name,
9374  in long controllerPort,
9375  in long device,
9376  in boolean discard
9377  );
9378 
9429  in wstring name,
9430  in long controllerPort,
9431  in long device,
9432  in boolean hotPluggable
9433  );
9434 
9476  in wstring name,
9477  in long controllerPort,
9478  in long device,
9479  in IBandwidthGroup bandwidthGroup
9480  );
9481 
9519  in wstring name,
9520  in long controllerPort,
9521  in long device
9522  );
9523 
9588  void unmountMedium (
9589  in wstring name,
9590  in long controllerPort,
9591  in long device,
9592  in boolean force
9593  );
9594 
9657  void mountMedium (
9658  in wstring name,
9659  in long controllerPort,
9660  in long device,
9661  in IMedium medium,
9662  in boolean force
9663  );
9664 
9693  void getMedium (
9694  in wstring name,
9695  in long controllerPort,
9696  in long device,
9697  [retval] out IMedium medium
9698  );
9699 
9715  in wstring name,
9716  [retval] out IMediumAttachment[] mediumAttachments
9717  );
9718 
9733  void getMediumAttachment (
9734  in wstring name,
9735  in long controllerPort,
9736  in long device,
9737  [retval] out IMediumAttachment attachment
9738  );
9739 
9780  void attachHostPCIDevice (
9781  in long hostAddress,
9782  in long desiredGuestAddress,
9783  in boolean tryToUnbind
9784  );
9785 
9826  void detachHostPCIDevice (
9827  in long hostAddress
9828  );
9829 
9847  void getNetworkAdapter (
9848  in unsigned long slot,
9849  [retval] out INetworkAdapter adapter
9850  );
9851 
9884  void addStorageController (
9885  in wstring name,
9886  in StorageBus connectionType,
9887  [retval] out IStorageController controller
9888  );
9889 
9904  in wstring name,
9905  [retval] out IStorageController storageController
9906  );
9907 
9923  in StorageBus connectionType,
9924  in unsigned long instance,
9925  [retval] out IStorageController storageController
9926  );
9927 
9951  in wstring name
9952  );
9953 
9976  in wstring name,
9977  in boolean bootable
9978  );
9979 
10002  void addUSBController (
10003  in wstring name,
10004  in USBControllerType type,
10005  [retval] out IUSBController controller
10006  );
10007 
10021  void removeUSBController (
10022  in wstring name
10023  );
10024 
10038  void getUSBControllerByName (
10039  in wstring name,
10040  [retval] out IUSBController controller
10041  );
10042 
10049  in USBControllerType type,
10050  [retval] out unsigned long controllers
10051  );
10052 
10070  void getSerialPort (
10071  in unsigned long slot,
10072  [retval] out ISerialPort port
10073  );
10074 
10092  void getParallelPort (
10093  in unsigned long slot,
10094  [retval] out IParallelPort port
10095  );
10096 
10105  void getExtraDataKeys (
10106  [retval] out wstring[] keys
10107  );
10108 
10137  void getExtraData (
10138  in wstring key,
10139  [retval] out wstring value
10140  );
10141 
10191  void setExtraData (
10192  in wstring key,
10193  in wstring value
10194  );
10195 
10217  void getCPUProperty (
10218  in CPUPropertyType property,
10219  [retval] out boolean value
10220  );
10221 
10243  void setCPUProperty (
10244  in CPUPropertyType property,
10245  in boolean value
10246  );
10247 
10287  void getCPUIDLeaf (
10288  in unsigned long id,
10289  out unsigned long valEax,
10290  out unsigned long valEbx,
10291  out unsigned long valEcx,
10292  out unsigned long valEdx
10293  );
10294 
10338  void setCPUIDLeaf (
10339  in unsigned long id,
10340  in unsigned long valEax,
10341  in unsigned long valEbx,
10342  in unsigned long valEcx,
10343  in unsigned long valEdx
10344  );
10345 
10363  void removeCPUIDLeaf (
10364  in unsigned long id
10365  );
10366 
10372  void removeAllCPUIDLeaves();
10373 
10395  void getHWVirtExProperty (
10396  in HWVirtExPropertyType property,
10397  [retval] out boolean value
10398  );
10399 
10421  void setHWVirtExProperty (
10422  in HWVirtExPropertyType property,
10423  in boolean value
10424  );
10425 
10455  void setSettingsFilePath (
10456  in wstring settingsFilePath,
10457  [retval] out IProgress progress
10458  );
10459 
10505  void saveSettings();
10506 
10530  void discardSettings();
10531 
10616  void unregister (
10617  in CleanupMode cleanupMode,
10618  [retval] out IMedium[] media
10619  );
10620 
10678  void deleteConfig (
10679  in IMedium[] media,
10680  [retval] out IProgress progress
10681  );
10682 
10694  void exportTo (
10695  in IAppliance appliance,
10696  in wstring location,
10697  [retval] out IVirtualSystemDescription description
10698  );
10699 
10723  void findSnapshot (
10724  in wstring nameOrId,
10725  [retval] out ISnapshot snapshot
10726  );
10727 
10761  void createSharedFolder (
10762  in wstring name,
10763  in wstring hostPath,
10764  in boolean writable,
10765  in boolean automount
10766  );
10767 
10793  void removeSharedFolder (
10794  in wstring name
10795  );
10796 
10820  void canShowConsoleWindow (
10821  [retval] out boolean canShow
10822  );
10823 
10858  void showConsoleWindow (
10859  [retval] out long long winId
10860  );
10861 
10894  void getGuestProperty (
10895  in wstring name,
10896  out wstring value,
10897  out long long timestamp,
10898  out wstring flags
10899  );
10900 
10923  void getGuestPropertyValue (
10924  in wstring property,
10925  [retval] out wstring value
10926  );
10927 
10951  in wstring property,
10952  [retval] out long long value
10953  );
10954 
11005  void setGuestProperty (
11006  in wstring property,
11007  in wstring value,
11008  in wstring flags
11009  );
11010 
11050  void setGuestPropertyValue (
11051  in wstring property,
11052  in wstring value
11053  );
11054 
11072  void deleteGuestProperty (
11073  in wstring name
11074  );
11075 
11107  in wstring patterns,
11108  out wstring[] names,
11109  out wstring[] values,
11110  out long long[] timestamps,
11111  out wstring[] flags
11112  );
11113 
11144  in unsigned long screenId,
11145  out unsigned long originX,
11146  out unsigned long originY,
11147  out unsigned long width,
11148  out unsigned long height,
11149  out boolean enabled
11150  );
11151 
11178  in unsigned long screenId,
11179  in BitmapFormat bitmapFormat,
11180  out unsigned long width,
11181  out unsigned long height,
11182  [retval] out octet[] data
11183  );
11184 
11207  in unsigned long screenId,
11208  out unsigned long width,
11209  out unsigned long height,
11210  [retval] out BitmapFormat[] bitmapFormats
11211  );
11212 
11239  in unsigned long screenId,
11240  in BitmapFormat bitmapFormat,
11241  out unsigned long width,
11242  out unsigned long height,
11243  [retval] out octet[] data
11244  );
11245 
11255  void hotPlugCPU (
11256  in unsigned long cpu
11257  );
11258 
11268  void hotUnplugCPU (
11269  in unsigned long cpu
11270  );
11271 
11285  void getCPUStatus (
11286  in unsigned long cpu,
11287  [retval] out boolean attached
11288  );
11289 
11300  [retval] out ParavirtProvider paravirtProvider
11301  );
11302 
11317  void queryLogFilename (
11318  in unsigned long idx,
11319  [retval] out wstring filename
11320  );
11321 
11347  void readLog (
11348  in unsigned long idx,
11349  in long long offset,
11350  in long long size,
11351  [retval] out octet[] data
11352  );
11353 
11386  void cloneTo (
11387  in IMachine target,
11388  in CloneMode mode,
11389  in CloneOptions[] options,
11390  [retval] out IProgress progress
11391  );
11392 
11445  void saveState (
11446  [retval] out IProgress progress
11447  );
11448 
11481  void adoptSavedState (
11482  in wstring savedStateFile
11483  );
11484 
11515  void discardSavedState (
11516  in boolean fRemoveFile
11517  );
11518 
11564  void takeSnapshot (
11565  in wstring name,
11566  in wstring description,
11567  in boolean pause,
11568  out wstringUUID id,
11569  [retval] out IProgress progress
11570  );
11571 
11645  void deleteSnapshot (
11646  in wstringUUID id,
11647  [retval] out IProgress progress
11648  );
11649 
11690  in wstringUUID id,
11691  [retval] out IProgress progress
11692  );
11693 
11737  void deleteSnapshotRange (
11738  in wstringUUID startId,
11739  in wstringUUID endId,
11740  [retval] out IProgress progress
11741  );
11742 
11783  void restoreSnapshot (
11784  in ISnapshot snapshot,
11785  [retval] out IProgress progress
11786  );
11787 
11814  void applyDefaults (
11815  in wstring flags
11816  );
11817 
11818 }; /* interface IMachine */
11819 
11827 interface IEmulatedUSB : $unknown
11828 {
11832  readonly attribute wstring[] webcams;
11833 
11843  void webcamAttach (
11844  in wstring path,
11845  in wstring settings
11846  );
11847 
11855  void webcamDetach (
11856  in wstring path
11857  );
11858 
11859 }; /* interface IEmulatedUSB */
11860 
11869 interface IVRDEServerInfo : $unknown
11870 {
11876  readonly attribute boolean active;
11877 
11886  readonly attribute long port;
11887 
11893  readonly attribute unsigned long numberOfClients;
11894 
11900  readonly attribute long long beginTime;
11901 
11908  readonly attribute long long endTime;
11909 
11915  readonly attribute long long bytesSent;
11916 
11922  readonly attribute long long bytesSentTotal;
11923 
11929  readonly attribute long long bytesReceived;
11930 
11936  readonly attribute long long bytesReceivedTotal;
11937 
11943  readonly attribute wstring user;
11944 
11950  readonly attribute wstring domain;
11951 
11957  readonly attribute wstring clientName;
11958 
11964  readonly attribute wstring clientIP;
11965 
11971  readonly attribute unsigned long clientVersion;
11972 
11980  readonly attribute unsigned long encryptionStyle;
11981 
11982 }; /* interface IVRDEServerInfo */
11983 
12005 interface IConsole : $unknown
12006 {
12018  readonly attribute IMachine machine;
12019 
12033  readonly attribute MachineState state;
12034 
12038  readonly attribute IGuest guest;
12039 
12050  readonly attribute IKeyboard keyboard;
12051 
12062  readonly attribute IMouse mouse;
12063 
12073  readonly attribute IDisplay display;
12074 
12078  readonly attribute IMachineDebugger debugger;
12079 
12090  readonly attribute IUSBDevice[] USBDevices;
12091 
12099  readonly attribute IHostUSBDevice[] remoteUSBDevices;
12100 
12116  readonly attribute ISharedFolder[] sharedFolders;
12117 
12123  readonly attribute IVRDEServerInfo VRDEServerInfo;
12124 
12130  readonly attribute IEventSource eventSource;
12131 
12136 
12145  attribute boolean useHostClipboard;
12146 
12152  readonly attribute IEmulatedUSB emulatedUSB;
12153 
12218  void powerUp (
12219  [retval] out IProgress progress
12220  );
12221 
12255  void powerUpPaused (
12256  [retval] out IProgress progress
12257  );
12258 
12278  void powerDown (
12279  [retval] out IProgress progress
12280  );
12281 
12301  void reset();
12302 
12322  void pause();
12323 
12343  void resume();
12344 
12364  void powerButton();
12365 
12385  void sleepButton();
12386 
12398  void getPowerButtonHandled (
12399  [retval] out boolean handled
12400  );
12401 
12416  [retval] out boolean entered
12417  );
12418 
12431  void getDeviceActivity (
12432  in DeviceType[] type,
12433  [retval] out DeviceActivity[] activity
12434  );
12435 
12475  void attachUSBDevice (
12476  in wstringUUID id,
12477  in wstring captureFilename
12478  );
12479 
12514  void detachUSBDevice (
12515  in wstringUUID id,
12516  [retval] out IUSBDevice device
12517  );
12518 
12541  void findUSBDeviceByAddress (
12542  in wstring name,
12543  [retval] out IUSBDevice device
12544  );
12545 
12565  void findUSBDeviceById (
12566  in wstringUUID id,
12567  [retval] out IUSBDevice device
12568  );
12569 
12603  void createSharedFolder (
12604  in wstring name,
12605  in wstring hostPath,
12606  in boolean writable,
12607  in boolean automount
12608  );
12609 
12634  void removeSharedFolder (
12635  in wstring name
12636  );
12637 
12676  void teleport (
12677  in wstring hostname,
12678  in unsigned long tcpport,
12679  in wstring password,
12680  in unsigned long maxDowntime,
12681  [retval] out IProgress progress
12682  );
12683 
12711  in wstring id,
12712  in wstring password,
12713  in boolean clearOnSuspend
12714  );
12715 
12743  in wstring[] ids,
12744  in wstring[] passwords,
12745  in boolean clearOnSuspend
12746  );
12747 
12762  in wstring id
12763  );
12764 
12769 
12770 }; /* interface IConsole */
12771 
12782 interface IHostNetworkInterface : $unknown
12783 {
12787  readonly attribute wstring name;
12788 
12792  readonly attribute wstring shortName;
12793 
12797  readonly attribute wstringUUID id;
12798 
12802  readonly attribute wstring networkName;
12803 
12807  readonly attribute boolean DHCPEnabled;
12808 
12812  readonly attribute wstring IPAddress;
12813 
12817  readonly attribute wstring networkMask;
12818 
12822  readonly attribute boolean IPV6Supported;
12823 
12827  readonly attribute wstring IPV6Address;
12828 
12832  readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
12833 
12837  readonly attribute wstring hardwareAddress;
12838 
12843 
12848 
12853 
12865  void enableStaticIPConfig (
12866  in wstring IPAddress,
12867  in wstring networkMask
12868  );
12869 
12881  void enableStaticIPConfigV6 (
12882  in wstring IPV6Address,
12883  in unsigned long IPV6NetworkMaskPrefixLength
12884  );
12885 
12889  void enableDynamicIPConfig();
12890 
12894  void DHCPRediscover();
12895 
12896 }; /* interface IHostNetworkInterface */
12897 
12905 interface IHostVideoInputDevice : $unknown
12906 {
12910  readonly attribute wstring name;
12911 
12915  readonly attribute wstring path;
12916 
12920  readonly attribute wstring alias;
12921 
12922 }; /* interface IHostVideoInputDevice */
12923 
12940 interface IHost : $unknown
12941 {
12945  readonly attribute IMedium[] DVDDrives;
12946 
12950  readonly attribute IMedium[] floppyDrives;
12951 
12965  readonly attribute IHostUSBDevice[] USBDevices;
12966 
12991 
12996 
13000  readonly attribute wstring[] nameServers;
13001 
13005  readonly attribute wstring domainName;
13006 
13010  readonly attribute wstring[] searchStrings;
13011 
13015  readonly attribute unsigned long processorCount;
13016 
13020  readonly attribute unsigned long processorOnlineCount;
13021 
13025  readonly attribute unsigned long processorCoreCount;
13026 
13030  readonly attribute unsigned long processorOnlineCoreCount;
13031 
13035  readonly attribute unsigned long memorySize;
13036 
13040  readonly attribute unsigned long memoryAvailable;
13041 
13045  readonly attribute wstring operatingSystem;
13046 
13050  readonly attribute wstring OSVersion;
13051 
13055  readonly attribute long long UTCTime;
13056 
13060  readonly attribute boolean acceleration3DAvailable;
13061 
13066 
13081  void getProcessorSpeed (
13082  in unsigned long cpuId,
13083  [retval] out unsigned long speed
13084  );
13085 
13097  void getProcessorFeature (
13098  in ProcessorFeature feature,
13099  [retval] out boolean supported
13100  );
13101 
13121  in unsigned long cpuId,
13122  [retval] out wstring description
13123  );
13124 
13165  void getProcessorCPUIDLeaf (
13166  in unsigned long cpuId,
13167  in unsigned long leaf,
13168  in unsigned long subLeaf,
13169  out unsigned long valEax,
13170  out unsigned long valEbx,
13171  out unsigned long valEcx,
13172  out unsigned long valEdx
13173  );
13174 
13196  out IHostNetworkInterface hostInterface,
13197  [retval] out IProgress progress
13198  );
13199 
13221  in wstringUUID id,
13222  [retval] out IProgress progress
13223  );
13224 
13244  void createUSBDeviceFilter (
13245  in wstring name,
13246  [retval] out IHostUSBDeviceFilter filter
13247  );
13248 
13291  void insertUSBDeviceFilter (
13292  in unsigned long position,
13293  in IHostUSBDeviceFilter filter
13294  );
13295 
13323  void removeUSBDeviceFilter (
13324  in unsigned long position
13325  );
13326 
13344  void findHostDVDDrive (
13345  in wstring name,
13346  [retval] out IMedium drive
13347  );
13348 
13366  void findHostFloppyDrive (
13367  in wstring name,
13368  [retval] out IMedium drive
13369  );
13370 
13387  in wstring name,
13388  [retval] out IHostNetworkInterface networkInterface
13389  );
13390 
13407  in wstringUUID id,
13408  [retval] out IHostNetworkInterface networkInterface
13409  );
13410 
13421  in HostNetworkInterfaceType type,
13422  [retval] out IHostNetworkInterface[] networkInterfaces
13423  );
13424 
13444  void findUSBDeviceById (
13445  in wstringUUID id,
13446  [retval] out IHostUSBDevice device
13447  );
13448 
13471  void findUSBDeviceByAddress (
13472  in wstring name,
13473  [retval] out IHostUSBDevice device
13474  );
13475 
13483  void generateMACAddress (
13484  [retval] out wstring address
13485  );
13486 
13487 }; /* interface IHost */
13488 
13501 interface ISystemProperties : $unknown
13502 {
13506  readonly attribute unsigned long minGuestRAM;
13507 
13511  readonly attribute unsigned long maxGuestRAM;
13512 
13516  readonly attribute unsigned long minGuestVRAM;
13517 
13521  readonly attribute unsigned long maxGuestVRAM;
13522 
13526  readonly attribute unsigned long minGuestCPUCount;
13527 
13531  readonly attribute unsigned long maxGuestCPUCount;
13532 
13536  readonly attribute unsigned long maxGuestMonitors;
13537 
13542  readonly attribute long long infoVDSize;
13543 
13550  readonly attribute unsigned long serialPortCount;
13551 
13558  readonly attribute unsigned long parallelPortCount;
13559 
13569  readonly attribute unsigned long maxBootPosition;
13570 
13579  readonly attribute boolean rawModeSupported;
13580 
13593  attribute boolean exclusiveHwVirt;
13594 
13618  attribute wstring defaultMachineFolder;
13619 
13625  attribute wstring loggingLevel;
13626 
13652  readonly attribute IMediumFormat[] mediumFormats;
13653 
13687  attribute wstring defaultHardDiskFormat;
13688 
13694  attribute long long freeDiskSpaceWarning;
13695 
13700  attribute unsigned long freeDiskSpacePercentWarning;
13701 
13707  attribute long long freeDiskSpaceError;
13708 
13713  attribute unsigned long freeDiskSpacePercentError;
13714 
13738  attribute wstring VRDEAuthLibrary;
13739 
13768  attribute wstring webServiceAuthLibrary;
13769 
13783  attribute wstring defaultVRDEExtPack;
13784 
13790  attribute unsigned long logHistoryCount;
13791 
13797 
13804  attribute wstring autostartDatabasePath;
13805 
13812  attribute wstring defaultAdditionsISO;
13813 
13828  attribute wstring defaultFrontend;
13829 
13836  readonly attribute BitmapFormat[] screenShotFormats;
13837 
13848  void getMaxNetworkAdapters (
13849  in ChipsetType chipset,
13850  [retval] out unsigned long maxNetworkAdapters
13851  );
13852 
13867  in ChipsetType chipset,
13868  in NetworkAttachmentType type,
13869  [retval] out unsigned long maxNetworkAdapters
13870  );
13871 
13882  in StorageBus bus,
13883  [retval] out unsigned long maxDevicesPerPort
13884  );
13885 
13894  in StorageBus bus,
13895  [retval] out unsigned long minPortCount
13896  );
13897 
13906  in StorageBus bus,
13907  [retval] out unsigned long maxPortCount
13908  );
13909 
13923  in ChipsetType chipset,
13924  in StorageBus bus,
13925  [retval] out unsigned long maxInstances
13926  );
13927 
13938  in StorageBus bus,
13939  [retval] out DeviceType[] deviceTypes
13940  );
13941 
13951  in StorageControllerType controllerType,
13952  [retval] out boolean enabled
13953  );
13954 
13964  in StorageControllerType controllerType,
13965  [retval] out boolean hotplugCapable
13966  );
13967 
13981  in ChipsetType chipset,
13982  in USBControllerType type,
13983  [retval] out unsigned long maxInstances
13984  );
13985 
13986 }; /* interface ISystemProperties */
13987 
13993 interface IGuestOSType : $unknown
13994 {
13998  readonly attribute wstring familyId;
13999 
14003  readonly attribute wstring familyDescription;
14004 
14008  readonly attribute wstring id;
14009 
14013  readonly attribute wstring description;
14014 
14018  readonly attribute boolean is64Bit;
14019 
14023  readonly attribute boolean recommendedIOAPIC;
14024 
14028  readonly attribute boolean recommendedVirtEx;
14029 
14033  readonly attribute unsigned long recommendedRAM;
14034 
14038  readonly attribute unsigned long recommendedVRAM;
14039 
14043  readonly attribute boolean recommended2DVideoAcceleration;
14044 
14048  readonly attribute boolean recommended3DAcceleration;
14049 
14053  readonly attribute long long recommendedHDD;
14054 
14058  readonly attribute NetworkAdapterType adapterType;
14059 
14063  readonly attribute boolean recommendedPAE;
14064 
14069 
14074 
14079 
14084 
14088  readonly attribute FirmwareType recommendedFirmware;
14089 
14093  readonly attribute boolean recommendedUSBHID;
14094 
14098  readonly attribute boolean recommendedHPET;
14099 
14103  readonly attribute boolean recommendedUSBTablet;
14104 
14108  readonly attribute boolean recommendedRTCUseUTC;
14109 
14113  readonly attribute ChipsetType recommendedChipset;
14114 
14119 
14124 
14128  readonly attribute boolean recommendedFloppy;
14129 
14133  readonly attribute boolean recommendedUSB;
14134 
14138  readonly attribute boolean recommendedTFReset;
14139 
14140 }; /* interface IGuestOSType */
14141 
14149 interface IAdditionsFacility : $unknown
14150 {
14154  readonly attribute AdditionsFacilityClass classType;
14155 
14162  readonly attribute long long lastUpdated;
14163 
14167  readonly attribute wstring name;
14168 
14172  readonly attribute AdditionsFacilityStatus status;
14173 
14177  readonly attribute AdditionsFacilityType type;
14178 
14179 }; /* interface IAdditionsFacility */
14180 
14186 interface IDnDBase : $unknown
14187 {
14191  readonly attribute wstring[] formats;
14192 
14197  readonly attribute unsigned long protocolVersion;
14198 
14208  void isFormatSupported (
14209  in wstring format,
14210  [retval] out boolean supported
14211  );
14212 
14220  void addFormats (
14221  in wstring[] formats
14222  );
14223 
14231  void removeFormats (
14232  in wstring[] formats
14233  );
14234 
14235 }; /* interface IDnDBase */
14236 
14243 {
14266  void dragIsPending (
14267  in unsigned long screenId,
14268  out wstring[] formats,
14269  out DnDAction[] allowedActions,
14270  [retval] out DnDAction defaultAction
14271  );
14272 
14293  void drop (
14294  in wstring format,
14295  in DnDAction action,
14296  [retval] out IProgress progress
14297  );
14298 
14314  void receiveData (
14315  [retval] out octet[] data
14316  );
14317 
14318 }; /* interface IDnDSource */
14319 
14329 {
14330  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
14331 
14332 }; /* interface IGuestDnDSource */
14333 
14340 {
14368  void enter (
14369  in unsigned long screenId,
14370  in unsigned long y,
14371  in unsigned long x,
14372  in DnDAction defaultAction,
14373  in DnDAction[] allowedActions,
14374  in wstring[] formats,
14375  [retval] out DnDAction resultAction
14376  );
14377 
14405  void move (
14406  in unsigned long screenId,
14407  in unsigned long x,
14408  in unsigned long y,
14409  in DnDAction defaultAction,
14410  in DnDAction[] allowedActions,
14411  in wstring[] formats,
14412  [retval] out DnDAction resultAction
14413  );
14414 
14430  void leave (
14431  in unsigned long screenId
14432  );
14433 
14463  void drop (
14464  in unsigned long screenId,
14465  in unsigned long x,
14466  in unsigned long y,
14467  in DnDAction defaultAction,
14468  in DnDAction[] allowedActions,
14469  in wstring[] formats,
14470  out wstring format,
14471  [retval] out DnDAction resultAction
14472  );
14473 
14495  void sendData (
14496  in unsigned long screenId,
14497  in wstring format,
14498  in octet[] data,
14499  [retval] out IProgress progress
14500  );
14501 
14518  void cancel (
14519  [retval] out boolean veto
14520  );
14521 
14522 }; /* interface IDnDTarget */
14523 
14533 {
14534  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
14535 
14536 }; /* interface IGuestDnDTarget */
14537 
14584 interface IGuestSession : $unknown
14585 {
14591  readonly attribute wstring user;
14592 
14598  readonly attribute wstring domain;
14599 
14603  readonly attribute wstring name;
14604 
14608  readonly attribute unsigned long id;
14609 
14622  attribute unsigned long timeout;
14623 
14628  readonly attribute unsigned long protocolVersion;
14629 
14633  readonly attribute GuestSessionStatus status;
14634 
14646  attribute wstring[] environmentChanges;
14647 
14662  readonly attribute wstring[] environmentBase;
14663 
14669  readonly attribute IGuestProcess[] processes;
14670 
14677  readonly attribute PathStyle pathStyle;
14678 
14691  attribute wstring currentDirectory;
14692 
14698  readonly attribute IGuestDirectory[] directories;
14699 
14705  readonly attribute IGuestFile[] files;
14706 
14712  readonly attribute IEventSource eventSource;
14713 
14722  void close();
14723 
14747  void directoryCopy (
14748  in wstring source,
14749  in wstring destination,
14750  in DirectoryCopyFlags[] flags,
14751  [retval] out IProgress progress
14752  );
14753 
14778  void directoryCopyFromGuest (
14779  in wstring source,
14780  in wstring destination,
14781  in DirectoryCopyFlags[] flags,
14782  [retval] out IProgress progress
14783  );
14784 
14809  void directoryCopyToGuest (
14810  in wstring source,
14811  in wstring destination,
14812  in DirectoryCopyFlags[] flags,
14813  [retval] out IProgress progress
14814  );
14815 
14840  void directoryCreate (
14841  in wstring path,
14842  in unsigned long mode,
14843  in DirectoryCreateFlag[] flags
14844  );
14845 
14907  void directoryCreateTemp (
14908  in wstring templateName,
14909  in unsigned long mode,
14910  in wstring path,
14911  in boolean secure,
14912  [retval] out wstring directory
14913  );
14914 
14939  void directoryExists (
14940  in wstring path,
14941  in boolean followSymlinks,
14942  [retval] out boolean exists
14943  );
14944 
14979  void directoryOpen (
14980  in wstring path,
14981  in wstring filter,
14982  in DirectoryOpenFlag[] flags,
14983  [retval] out IGuestDirectory directory
14984  );
14985 
14997  void directoryRemove (
14998  in wstring path
14999  );
15000 
15027  in wstring path,
15028  in DirectoryRemoveRecFlag[] flags,
15029  [retval] out IProgress progress
15030  );
15031 
15044  void environmentScheduleSet (
15045  in wstring name,
15046  in wstring value
15047  );
15048 
15060  in wstring name
15061  );
15062 
15094  in wstring name,
15095  [retval] out wstring value
15096  );
15097 
15125  in wstring name,
15126  [retval] out boolean exists
15127  );
15128 
15154  void fileCopy (
15155  in wstring source,
15156  in wstring destination,
15157  in FileCopyFlag[] flags,
15158  [retval] out IProgress progress
15159  );
15160 
15187  void fileCopyFromGuest (
15188  in wstring source,
15189  in wstring destination,
15190  in FileCopyFlag[] flags,
15191  [retval] out IProgress progress
15192  );
15193 
15220  void fileCopyToGuest (
15221  in wstring source,
15222  in wstring destination,
15223  in FileCopyFlag[] flags,
15224  [retval] out IProgress progress
15225  );
15226 
15288  void fileCreateTemp (
15289  in wstring templateName,
15290  in unsigned long mode,
15291  in wstring path,
15292  in boolean secure,
15293  [retval] out IGuestFile file
15294  );
15295 
15321  void fileExists (
15322  in wstring path,
15323  in boolean followSymlinks,
15324  [retval] out boolean exists
15325  );
15326 
15366  void fileOpen (
15367  in wstring path,
15368  in FileAccessMode accessMode,
15369  in FileOpenAction openAction,
15370  in unsigned long creationMode,
15371  [retval] out IGuestFile file
15372  );
15373 
15421  void fileOpenEx (
15422  in wstring path,
15423  in FileAccessMode accessMode,
15424  in FileOpenAction openAction,
15425  in FileSharingMode sharingMode,
15426  in unsigned long creationMode,
15427  in FileOpenExFlags[] flags,
15428  [retval] out IGuestFile file
15429  );
15430 
15463  void fileQuerySize (
15464  in wstring path,
15465  in boolean followSymlinks,
15466  [retval] out long long size
15467  );
15468 
15495  void fsObjExists (
15496  in wstring path,
15497  in boolean followSymlinks,
15498  [retval] out boolean exists
15499  );
15500 
15534  void fsObjQueryInfo (
15535  in wstring path,
15536  in boolean followSymlinks,
15537  [retval] out IGuestFsObjInfo info
15538  );
15539 
15574  void fsObjRemove (
15575  in wstring path
15576  );
15577 
15606  void fsObjRename (
15607  in wstring oldPath,
15608  in wstring newPath,
15609  in FsObjRenameFlag[] flags
15610  );
15611 
15640  void fsObjMove (
15641  in wstring source,
15642  in wstring destination,
15643  in FsObjMoveFlags[] flags,
15644  [retval] out IProgress progress
15645  );
15646 
15676  void fsObjSetACL (
15677  in wstring path,
15678  in boolean followSymlinks,
15679  in wstring acl,
15680  in unsigned long mode
15681  );
15682 
15755  void processCreate (
15756  in wstring executable,
15757  in wstring[] arguments,
15758  in wstring[] environmentChanges,
15759  in ProcessCreateFlag[] flags,
15760  in unsigned long timeoutMS,
15761  [retval] out IGuestProcess guestProcess
15762  );
15763 
15835  void processCreateEx (
15836  in wstring executable,
15837  in wstring[] arguments,
15838  in wstring[] environmentChanges,
15839  in ProcessCreateFlag[] flags,
15840  in unsigned long timeoutMS,
15841  in ProcessPriority priority,
15842  in long[] affinity,
15843  [retval] out IGuestProcess guestProcess
15844  );
15845 
15855  void processGet (
15856  in unsigned long pid,
15857  [retval] out IGuestProcess guestProcess
15858  );
15859 
15887  void symlinkCreate (
15888  in wstring symlink,
15889  in wstring target,
15890  in SymlinkType type
15891  );
15892 
15915  void symlinkExists (
15916  in wstring symlink,
15917  [retval] out boolean exists
15918  );
15919 
15939  void symlinkRead (
15940  in wstring symlink,
15941  in SymlinkReadFlag[] flags,
15942  [retval] out wstring target
15943  );
15944 
15965  void waitFor (
15966  in unsigned long waitFor,
15967  in unsigned long timeoutMS,
15968  [retval] out GuestSessionWaitResult reason
15969  );
15970 
15992  void waitForArray (
15994  in unsigned long timeoutMS,
15995  [retval] out GuestSessionWaitResult reason
15996  );
15997 
15998 }; /* interface IGuestSession */
15999 
16007 interface IProcess : $unknown
16008 {
16014  readonly attribute wstring[] arguments;
16015 
16021  readonly attribute wstring[] environment;
16022 
16028  readonly attribute IEventSource eventSource;
16029 
16033  readonly attribute wstring executablePath;
16034 
16041  readonly attribute long exitCode;
16042 
16048  readonly attribute wstring name;
16049 
16055  readonly attribute unsigned long PID;
16056 
16063  readonly attribute ProcessStatus status;
16064 
16085  void waitFor (
16086  in unsigned long waitFor,
16087  in unsigned long timeoutMS,
16088  [retval] out ProcessWaitResult reason
16089  );
16090 
16112  void waitForArray (
16114  in unsigned long timeoutMS,
16115  [retval] out ProcessWaitResult reason
16116  );
16117 
16134  void read (
16135  in unsigned long handle,
16136  in unsigned long toRead,
16137  in unsigned long timeoutMS,
16138  [retval] out octet[] data
16139  );
16140 
16164  void write (
16165  in unsigned long handle,
16166  in unsigned long flags,
16167  in octet[] data,
16168  in unsigned long timeoutMS,
16169  [retval] out unsigned long written
16170  );
16171 
16196  void writeArray (
16197  in unsigned long handle,
16198  in ProcessInputFlag[] flags,
16199  in octet[] data,
16200  in unsigned long timeoutMS,
16201  [retval] out unsigned long written
16202  );
16203 
16213  void terminate();
16214 
16215 }; /* interface IProcess */
16216 
16226 {
16227  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
16228 
16229 }; /* interface IGuestProcess */
16230 
16238 interface IDirectory : $unknown
16239 {
16243  readonly attribute wstring directoryName;
16244 
16248  readonly attribute wstring filter;
16249 
16256  void close();
16257 
16273  void read (
16274  [retval] out IFsObjInfo objInfo
16275  );
16276 
16277 }; /* interface IDirectory */
16278 
16288 {
16289  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
16290 
16291 }; /* interface IGuestDirectory */
16292 
16300 interface IFile : $unknown
16301 {
16307  readonly attribute IEventSource eventSource;
16308 
16314  readonly attribute unsigned long id;
16315 
16321  readonly attribute long long initialSize;
16322 
16337  readonly attribute long long offset;
16338 
16344  readonly attribute FileStatus status;
16345 
16350  readonly attribute wstring fileName;
16351 
16355  readonly attribute unsigned long creationMode;
16356 
16360  readonly attribute FileOpenAction openAction;
16361 
16365  readonly attribute FileAccessMode accessMode;
16366 
16373  void close();
16374 
16391  void queryInfo (
16392  [retval] out IFsObjInfo objInfo
16393  );
16394 
16410  void querySize (
16411  [retval] out long long size
16412  );
16413 
16436  void read (
16437  in unsigned long toRead,
16438  in unsigned long timeoutMS,
16439  [retval] out octet[] data
16440  );
16441 
16466  void readAt (
16467  in long long offset,
16468  in unsigned long toRead,
16469  in unsigned long timeoutMS,
16470  [retval] out octet[] data
16471  );
16472 
16491  void seek (
16492  in long long offset,
16493  in FileSeekOrigin whence,
16494  [retval] out long long newOffset
16495  );
16496 
16517  void setACL (
16518  in wstring acl,
16519  in unsigned long mode
16520  );
16521 
16537  void setSize (
16538  in long long size
16539  );
16540 
16558  void write (
16559  in octet[] data,
16560  in unsigned long timeoutMS,
16561  [retval] out unsigned long written
16562  );
16563 
16591  void writeAt (
16592  in long long offset,
16593  in octet[] data,
16594  in unsigned long timeoutMS,
16595  [retval] out unsigned long written
16596  );
16597 
16598 }; /* interface IFile */
16599 
16608 interface IGuestFile : IFile
16609 {
16610  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
16611 
16612 }; /* interface IGuestFile */
16613 
16622 interface IFsObjInfo : $unknown
16623 {
16629  readonly attribute long long accessTime;
16630 
16636  readonly attribute long long allocatedSize;
16637 
16643  readonly attribute long long birthTime;
16644 
16650  readonly attribute long long changeTime;
16651 
16657  readonly attribute unsigned long deviceNumber;
16658 
16664  readonly attribute wstring fileAttributes;
16665 
16671  readonly attribute unsigned long generationId;
16672 
16678  readonly attribute unsigned long GID;
16679 
16685  readonly attribute wstring groupName;
16686 
16692  readonly attribute unsigned long hardLinks;
16693 
16699  readonly attribute long long modificationTime;
16700 
16706  readonly attribute wstring name;
16707 
16713  readonly attribute long long nodeId;
16714 
16720  readonly attribute unsigned long nodeIdDevice;
16721 
16729  readonly attribute long long objectSize;
16730 
16736  readonly attribute FsObjType type;
16737 
16743  readonly attribute unsigned long UID;
16744 
16750  readonly attribute unsigned long userFlags;
16751 
16757  readonly attribute wstring userName;
16758 
16759 }; /* interface IFsObjInfo */
16760 
16770 {
16771  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
16772 
16773 }; /* interface IGuestFsObjInfo */
16774 
16788 interface IGuest : $unknown
16789 {
16804  readonly attribute wstring OSTypeId;
16805 
16812 
16819  readonly attribute wstring additionsVersion;
16820 
16828  readonly attribute unsigned long additionsRevision;
16829 
16836  readonly attribute IGuestDnDSource dnDSource;
16837 
16845  readonly attribute IGuestDnDTarget dnDTarget;
16846 
16852  readonly attribute IEventSource eventSource;
16853 
16860  readonly attribute IAdditionsFacility[] facilities;
16861 
16865  readonly attribute IGuestSession[] sessions;
16866 
16870  attribute unsigned long memoryBalloonSize;
16871 
16875  attribute unsigned long statisticsUpdateInterval;
16876 
16908  void internalGetStatistics (
16909  out unsigned long cpuUser,
16910  out unsigned long cpuKernel,
16911  out unsigned long cpuIdle,
16912  out unsigned long memTotal,
16913  out unsigned long memFree,
16914  out unsigned long memBalloon,
16915  out unsigned long memShared,
16916  out unsigned long memCache,
16917  out unsigned long pagedTotal,
16918  out unsigned long memAllocTotal,
16919  out unsigned long memFreeTotal,
16920  out unsigned long memBalloonTotal,
16921  out unsigned long memSharedTotal
16922  );
16923 
16935  void getFacilityStatus (
16936  in AdditionsFacilityType facility,
16937  out long long timestamp,
16938  [retval] out AdditionsFacilityStatus status
16939  );
16940 
16958  void getAdditionsStatus (
16959  in AdditionsRunLevelType level,
16960  [retval] out boolean active
16961  );
16962 
16992  void setCredentials (
16993  in wstring userName,
16994  in wstring password,
16995  in wstring domain,
16996  in boolean allowInteractiveLogon
16997  );
16998 
17041  void createSession (
17042  in wstring user,
17043  in wstring password,
17044  in wstring domain,
17045  in wstring sessionName,
17046  [retval] out IGuestSession guestSession
17047  );
17048 
17063  void findSession (
17064  in wstring sessionName,
17065  [retval] out IGuestSession[] sessions
17066  );
17067 
17117  void updateGuestAdditions (
17118  in wstring source,
17119  in wstring[] arguments,
17120  in AdditionsUpdateFlag[] flags,
17121  [retval] out IProgress progress
17122  );
17123 
17124 }; /* interface IGuest */
17125 
17166 interface IProgress : $unknown
17167 {
17171  readonly attribute wstringUUID id;
17172 
17176  readonly attribute wstring description;
17177 
17181  readonly attribute $unknown initiator;
17182 
17186  readonly attribute boolean cancelable;
17187 
17195  readonly attribute unsigned long percent;
17196 
17210  readonly attribute long timeRemaining;
17211 
17215  readonly attribute boolean completed;
17216 
17220  readonly attribute boolean canceled;
17221 
17228  readonly attribute long resultCode;
17229 
17239  readonly attribute IVirtualBoxErrorInfo errorInfo;
17240 
17247  readonly attribute unsigned long operationCount;
17248 
17252  readonly attribute unsigned long operation;
17253 
17259  readonly attribute wstring operationDescription;
17260 
17264  readonly attribute unsigned long operationPercent;
17265 
17269  readonly attribute unsigned long operationWeight;
17270 
17278  attribute unsigned long timeout;
17279 
17284  in unsigned long percent
17285  );
17286 
17290  void setNextOperation (
17291  in wstring nextOperationDescription,
17292  in unsigned long nextOperationsWeight
17293  );
17294 
17321  void waitForCompletion (
17322  in long timeout
17323  );
17324 
17349  in unsigned long operation,
17350  in long timeout
17351  );
17352 
17379  in IProgress pProgressAsync
17380  );
17381 
17398  void cancel();
17399 
17400 }; /* interface IProgress */
17401 
17486 interface ISnapshot : $unknown
17487 {
17491  readonly attribute wstringUUID id;
17492 
17500  attribute wstring name;
17501 
17509  attribute wstring description;
17510 
17516  readonly attribute long long timeStamp;
17517 
17529  readonly attribute boolean online;
17530 
17542  readonly attribute IMachine machine;
17543 
17550  readonly attribute ISnapshot parent;
17551 
17560  readonly attribute ISnapshot[] children;
17561 
17569  void getChildrenCount (
17570  [retval] out unsigned long childrenCount
17571  );
17572 
17573 }; /* interface ISnapshot */
17574 
17763 interface IMediumAttachment : $unknown
17764 {
17769  readonly attribute IMedium medium;
17770 
17776  readonly attribute wstring controller;
17777 
17783  readonly attribute long port;
17784 
17790  readonly attribute long device;
17791 
17795  readonly attribute DeviceType type;
17796 
17800  readonly attribute boolean passthrough;
17801 
17805  readonly attribute boolean temporaryEject;
17806 
17811  readonly attribute boolean isEjected;
17812 
17816  readonly attribute boolean nonRotational;
17817 
17821  readonly attribute boolean discard;
17822 
17826  readonly attribute boolean hotPluggable;
17827 
17831  readonly attribute IBandwidthGroup bandwidthGroup;
17832 
17833 }; /* interface IMediumAttachment */
17834 
17995 interface IMedium : $unknown
17996 {
18010  readonly attribute wstringUUID id;
18011 
18030  attribute wstring description;
18031 
18047  readonly attribute MediumState state;
18048 
18057  readonly attribute MediumVariant[] variant;
18058 
18068  readonly attribute wstring location;
18069 
18089  readonly attribute wstring name;
18090 
18095  readonly attribute DeviceType deviceType;
18096 
18100  readonly attribute boolean hostDrive;
18101 
18114  readonly attribute long long size;
18115 
18130  readonly attribute wstring format;
18131 
18147  readonly attribute IMediumFormat mediumFormat;
18148 
18174  attribute MediumType type;
18175 
18189  readonly attribute MediumType[] allowedTypes;
18190 
18200  readonly attribute IMedium parent;
18201 
18209  readonly attribute IMedium[] children;
18210 
18221  readonly attribute IMedium base;
18222 
18255  readonly attribute boolean readOnly;
18256 
18272  readonly attribute long long logicalSize;
18273 
18301  attribute boolean autoReset;
18302 
18317  readonly attribute wstring lastAccessError;
18318 
18335  readonly attribute wstringUUID[] machineIds;
18336 
18362  void setIds (
18363  in boolean setImageId,
18364  in wstringUUID imageId,
18365  in boolean setParentId,
18366  in wstringUUID parentId
18367  );
18368 
18403  void refreshState (
18404  [retval] out MediumState state
18405  );
18406 
18433  void getSnapshotIds (
18434  in wstringUUID machineId,
18435  [retval] out wstringUUID[] snapshotIds
18436  );
18437 
18500  void lockRead (
18501  [retval] out IToken token
18502  );
18503 
18558  void lockWrite (
18559  [retval] out IToken token
18560  );
18561 
18611  void close();
18612 
18642  void getProperty (
18643  in wstring name,
18644  [retval] out wstring value
18645  );
18646 
18678  void setProperty (
18679  in wstring name,
18680  in wstring value
18681  );
18682 
18717  void getProperties (
18718  in wstring names,
18719  out wstring[] returnNames,
18720  [retval] out wstring[] returnValues
18721  );
18722 
18752  void setProperties (
18753  in wstring[] names,
18754  in wstring[] values
18755  );
18756 
18789  void createBaseStorage (
18790  in long long logicalSize,
18791  in MediumVariant[] variant,
18792  [retval] out IProgress progress
18793  );
18794 
18846  void deleteStorage (
18847  [retval] out IProgress progress
18848  );
18849 
18888  void createDiffStorage (
18889  in IMedium target,
18890  in MediumVariant[] variant,
18891  [retval] out IProgress progress
18892  );
18893 
18971  void mergeTo (
18972  in IMedium target,
18973  [retval] out IProgress progress
18974  );
18975 
19025  void cloneTo (
19026  in IMedium target,
19027  in MediumVariant[] variant,
19028  in IMedium parent,
19029  [retval] out IProgress progress
19030  );
19031 
19078  void cloneToBase (
19079  in IMedium target,
19080  in MediumVariant[] variant,
19081  [retval] out IProgress progress
19082  );
19083 
19125  void setLocation (
19126  in wstring location,
19127  [retval] out IProgress progress
19128  );
19129 
19158  void compact (
19159  [retval] out IProgress progress
19160  );
19161 
19194  void resize (
19195  in long long logicalSize,
19196  [retval] out IProgress progress
19197  );
19198 
19232  void reset (
19233  [retval] out IProgress progress
19234  );
19235 
19277  void changeEncryption (
19278  in wstring currentPassword,
19279  in wstring cipher,
19280  in wstring newPassword,
19281  in wstring newPasswordId,
19282  [retval] out IProgress progress
19283  );
19284 
19302  void getEncryptionSettings (
19303  out wstring cipher,
19304  [retval] out wstring passwordId
19305  );
19306 
19331  in wstring password
19332  );
19333 
19334 }; /* interface IMedium */
19335 
19358 interface IMediumFormat : $unknown
19359 {
19379  readonly attribute wstring id;
19380 
19388  readonly attribute wstring name;
19389 
19399 
19418  void describeFileExtensions (
19419  out wstring[] extensions,
19420  out DeviceType[] types
19421  );
19422 
19450  void describeProperties (
19451  out wstring[] names,
19452  out wstring[] descriptions,
19453  out DataType[] types,
19454  out unsigned long[] flags,
19455  out wstring[] defaults
19456  );
19457 
19458 }; /* interface IMediumFormat */
19459 
19474 interface IToken : $unknown
19475 {
19484  void abandon();
19485 
19492  void dummy();
19493 
19494 }; /* interface IToken */
19495 
19507 interface IKeyboard : $unknown
19508 {
19514  readonly attribute KeyboardLED[] keyboardLEDs;
19515 
19521  readonly attribute IEventSource eventSource;
19522 
19535  void putScancode (
19536  in long scancode
19537  );
19538 
19551  void putScancodes (
19552  in long[] scancodes,
19553  [retval] out unsigned long codesStored
19554  );
19555 
19570  void putCAD();
19571 
19586  void releaseKeys();
19587 
19588 }; /* interface IKeyboard */
19589 
19597 interface IMousePointerShape : $unknown
19598 {
19604  readonly attribute boolean visible;
19605 
19611  readonly attribute boolean alpha;
19612 
19618  readonly attribute unsigned long hotX;
19619 
19625  readonly attribute unsigned long hotY;
19626 
19632  readonly attribute unsigned long width;
19633 
19639  readonly attribute unsigned long height;
19640 
19674  readonly attribute octet[] shape;
19675 
19676 }; /* interface IMousePointerShape */
19677 
19689 interface IMouse : $unknown
19690 {
19705  readonly attribute boolean absoluteSupported;
19706 
19721  readonly attribute boolean relativeSupported;
19722 
19736  readonly attribute boolean multiTouchSupported;
19737 
19752  readonly attribute boolean needsHostCursor;
19753 
19759  readonly attribute IMousePointerShape pointerShape;
19760 
19766  readonly attribute IEventSource eventSource;
19767 
19833  void putMouseEvent (
19834  in long dx,
19835  in long dy,
19836  in long dz,
19837  in long dw,
19838  in long buttonState
19839  );
19840 
19913  void putMouseEventAbsolute (
19914  in long x,
19915  in long y,
19916  in long dz,
19917  in long dw,
19918  in long buttonState
19919  );
19920 
19968  void putEventMultiTouch (
19969  in long count,
19970  in long long[] contacts,
19971  in unsigned long scanTime
19972  );
19973 
19990  in long count,
19991  in wstring contacts,
19992  in unsigned long scanTime
19993  );
19994 
19995 }; /* interface IMouse */
19996 
19997 interface IDisplaySourceBitmap : $unknown
19998 {
19999  readonly attribute unsigned long screenId;
20000 
20009  void queryBitmapInfo (
20010  out octetPtr address,
20011  out unsigned long width,
20012  out unsigned long height,
20013  out unsigned long bitsPerPixel,
20014  out unsigned long bytesPerLine,
20015  out BitmapFormat bitmapFormat
20016  );
20017 
20018 }; /* interface IDisplaySourceBitmap */
20019 
20020 interface IFramebuffer : $unknown
20021 {
20025  readonly attribute unsigned long width;
20026 
20030  readonly attribute unsigned long height;
20031 
20037  readonly attribute unsigned long bitsPerPixel;
20038 
20044  readonly attribute unsigned long bytesPerLine;
20045 
20056  readonly attribute BitmapFormat pixelFormat;
20057 
20067  readonly attribute unsigned long heightReduction;
20068 
20083  readonly attribute IFramebufferOverlay overlay;
20084 
20091  readonly attribute long long winId;
20092 
20102 
20110  void notifyUpdate (
20111  in unsigned long x,
20112  in unsigned long y,
20113  in unsigned long width,
20114  in unsigned long height
20115  );
20116 
20126  void notifyUpdateImage (
20127  in unsigned long x,
20128  in unsigned long y,
20129  in unsigned long width,
20130  in unsigned long height,
20131  in octet[] image
20132  );
20133 
20151  void notifyChange (
20152  in unsigned long screenId,
20153  in unsigned long xOrigin,
20154  in unsigned long yOrigin,
20155  in unsigned long width,
20156  in unsigned long height
20157  );
20158 
20170  void videoModeSupported (
20171  in unsigned long width,
20172  in unsigned long height,
20173  in unsigned long bpp,
20174  [retval] out boolean supported
20175  );
20176 
20213  void getVisibleRegion (
20214  in octetPtr rectangles,
20215  in unsigned long count,
20216  [retval] out unsigned long countCopied
20217  );
20218 
20253  void setVisibleRegion (
20254  in octetPtr rectangles,
20255  in unsigned long count
20256  );
20257 
20278  void processVHWACommand (
20279  in octetPtr command
20280  );
20281 
20291  void notify3DEvent (
20292  in unsigned long type,
20293  in octet[] data
20294  );
20295 
20296 }; /* interface IFramebuffer */
20297 
20313 {
20317  readonly attribute unsigned long x;
20318 
20322  readonly attribute unsigned long y;
20323 
20329  attribute boolean visible;
20330 
20337  attribute unsigned long alpha;
20338 
20344  void move (
20345  in unsigned long x,
20346  in unsigned long y
20347  );
20348 
20349 }; /* interface IFramebufferOverlay */
20350 
20366 interface IDisplay : $unknown
20367 {
20378  void getScreenResolution (
20379  in unsigned long screenId,
20380  out unsigned long width,
20381  out unsigned long height,
20382  out unsigned long bitsPerPixel,
20383  out long xOrigin,
20384  out long yOrigin,
20385  out GuestMonitorStatus guestMonitorStatus
20386  );
20387 
20393  void attachFramebuffer (
20394  in unsigned long screenId,
20395  in IFramebuffer framebuffer,
20396  [retval] out wstringUUID id
20397  );
20398 
20404  void detachFramebuffer (
20405  in unsigned long screenId,
20406  in wstringUUID id
20407  );
20408 
20414  void queryFramebuffer (
20415  in unsigned long screenId,
20416  [retval] out IFramebuffer framebuffer
20417  );
20418 
20469  void setVideoModeHint (
20470  in unsigned long display,
20471  in boolean enabled,
20472  in boolean changeOrigin,
20473  in long originX,
20474  in long originY,
20475  in unsigned long width,
20476  in unsigned long height,
20477  in unsigned long bitsPerPixel
20478  );
20479 
20491  void setSeamlessMode (
20492  in boolean enabled
20493  );
20494 
20516  void takeScreenShot (
20517  in unsigned long screenId,
20518  in octetPtr address,
20519  in unsigned long width,
20520  in unsigned long height,
20521  in BitmapFormat bitmapFormat
20522  );
20523 
20550  void takeScreenShotToArray (
20551  in unsigned long screenId,
20552  in unsigned long width,
20553  in unsigned long height,
20554  in BitmapFormat bitmapFormat,
20555  [retval] out octet[] screenData
20556  );
20557 
20609  void drawToScreen (
20610  in unsigned long screenId,
20611  in octetPtr address,
20612  in unsigned long x,
20613  in unsigned long y,
20614  in unsigned long width,
20615  in unsigned long height
20616  );
20617 
20632  void invalidateAndUpdate();
20633 
20644  in unsigned long screenId
20645  );
20646 
20659  void completeVHWACommand (
20660  in octetPtr command
20661  );
20662 
20696  void viewportChanged (
20697  in unsigned long screenId,
20698  in unsigned long x,
20699  in unsigned long y,
20700  in unsigned long width,
20701  in unsigned long height
20702  );
20703 
20709  void querySourceBitmap (
20710  in unsigned long screenId,
20711  out IDisplaySourceBitmap displaySourceBitmap
20712  );
20713 
20720  in unsigned long screenId,
20721  in unsigned long u32ScaleFactorWMultiplied,
20722  in unsigned long u32ScaleFactorHMultiplied
20723  );
20724 
20731  in boolean fUnscaledHiDPI
20732  );
20733 
20734 }; /* interface IDisplay */
20735 
20751 interface INetworkAdapter : $unknown
20752 {
20761 
20769  readonly attribute unsigned long slot;
20770 
20779  attribute boolean enabled;
20780 
20787  attribute wstring MACAddress;
20788 
20795 
20801  attribute wstring bridgedInterface;
20802 
20808  attribute wstring hostOnlyInterface;
20809 
20815  attribute wstring internalNetwork;
20816 
20822  attribute wstring NATNetwork;
20823 
20829  attribute wstring genericDriver;
20830 
20837  attribute boolean cableConnected;
20838 
20844  attribute unsigned long lineSpeed;
20845 
20853 
20860  attribute boolean traceEnabled;
20861 
20868  attribute wstring traceFile;
20869 
20877  readonly attribute INATEngine NATEngine;
20878 
20885  attribute unsigned long bootPriority;
20886 
20891 
20910  void getProperty (
20911  in wstring key,
20912  [retval] out wstring value
20913  );
20914 
20933  void setProperty (
20934  in wstring key,
20935  in wstring value
20936  );
20937 
20965  void getProperties (
20966  in wstring names,
20967  out wstring[] returnNames,
20968  [retval] out wstring[] returnValues
20969  );
20970 
20971 }; /* interface INetworkAdapter */
20972 
21001 interface ISerialPort : $unknown
21002 {
21010  readonly attribute unsigned long slot;
21011 
21018  attribute boolean enabled;
21019 
21023  attribute unsigned long IOBase;
21024 
21028  attribute unsigned long IRQ;
21029 
21040  attribute PortMode hostMode;
21041 
21049  attribute boolean server;
21050 
21062  attribute wstring path;
21063 
21064 }; /* interface ISerialPort */
21065 
21085 interface IParallelPort : $unknown
21086 {
21094  readonly attribute unsigned long slot;
21095 
21102  attribute boolean enabled;
21103 
21107  attribute unsigned long IOBase;
21108 
21112  attribute unsigned long IRQ;
21113 
21121  attribute wstring path;
21122 
21123 }; /* interface IParallelPort */
21124 
21125 interface IMachineDebugger : $unknown
21126 {
21130  attribute boolean singleStep;
21131 
21135  attribute boolean recompileUser;
21136 
21140  attribute boolean recompileSupervisor;
21141 
21149  attribute boolean executeAllInIEM;
21150 
21154  attribute boolean PATMEnabled;
21155 
21159  attribute boolean CSAMEnabled;
21160 
21164  attribute boolean logEnabled;
21165 
21169  readonly attribute wstring logDbgFlags;
21170 
21174  readonly attribute wstring logDbgGroups;
21175 
21179  readonly attribute wstring logDbgDestinations;
21180 
21184  readonly attribute wstring logRelFlags;
21185 
21189  readonly attribute wstring logRelGroups;
21190 
21194  readonly attribute wstring logRelDestinations;
21195 
21202  readonly attribute boolean HWVirtExEnabled;
21203 
21210  readonly attribute boolean HWVirtExNestedPagingEnabled;
21211 
21218  readonly attribute boolean HWVirtExVPIDEnabled;
21219 
21226  readonly attribute boolean HWVirtExUXEnabled;
21227 
21236  readonly attribute wstring OSName;
21237 
21246  readonly attribute wstring OSVersion;
21247 
21254  readonly attribute boolean PAEEnabled;
21255 
21262  attribute unsigned long virtualTimeRate;
21263 
21271  readonly attribute long long VM;
21272 
21288  void dumpGuestCore (
21289  in wstring filename,
21290  in wstring compression
21291  );
21292 
21309  void dumpHostProcessCore (
21310  in wstring filename,
21311  in wstring compression
21312  );
21313 
21334  void info (
21335  in wstring name,
21336  in wstring args,
21337  [retval] out wstring info
21338  );
21339 
21345  void injectNMI();
21346 
21357  void modifyLogGroups (
21358  in wstring settings
21359  );
21360 
21371  void modifyLogFlags (
21372  in wstring settings
21373  );
21374 
21385  void modifyLogDestinations (
21386  in wstring settings
21387  );
21388 
21403  void readPhysicalMemory (
21404  in long long address,
21405  in unsigned long size,
21406  [retval] out octet[] bytes
21407  );
21408 
21423  void writePhysicalMemory (
21424  in long long address,
21425  in unsigned long size,
21426  in octet[] bytes
21427  );
21428 
21445  void readVirtualMemory (
21446  in unsigned long cpuId,
21447  in long long address,
21448  in unsigned long size,
21449  [retval] out octet[] bytes
21450  );
21451 
21468  void writeVirtualMemory (
21469  in unsigned long cpuId,
21470  in long long address,
21471  in unsigned long size,
21472  in octet[] bytes
21473  );
21474 
21482  void loadPlugIn (
21483  in wstring name,
21484  [retval] out wstring plugInName
21485  );
21486 
21492  void unloadPlugIn (
21493  in wstring name
21494  );
21495 
21508  void detectOS (
21509  [retval] out wstring os
21510  );
21511 
21525  void queryOSKernelLog (
21526  in unsigned long maxMessages,
21527  [retval] out wstring dmesg
21528  );
21529 
21544  void getRegister (
21545  in unsigned long cpuId,
21546  in wstring name,
21547  [retval] out wstring value
21548  );
21549 
21564  void getRegisters (
21565  in unsigned long cpuId,
21566  out wstring[] names,
21567  out wstring[] values
21568  );
21569 
21588  void setRegister (
21589  in unsigned long cpuId,
21590  in wstring name,
21591  in wstring value
21592  );
21593 
21612  void setRegisters (
21613  in unsigned long cpuId,
21614  in wstring[] names,
21615  in wstring[] values
21616  );
21617 
21630  void dumpGuestStack (
21631  in unsigned long cpuId,
21632  [retval] out wstring stack
21633  );
21634 
21642  void resetStats (
21643  in wstring pattern
21644  );
21645 
21653  void dumpStats (
21654  in wstring pattern
21655  );
21656 
21668  void getStats (
21669  in wstring pattern,
21670  in boolean withDescriptions,
21671  [retval] out wstring stats
21672  );
21673 
21674 }; /* interface IMachineDebugger */
21675 
21676 interface IUSBDeviceFilters : $unknown
21677 {
21703  readonly attribute IUSBDeviceFilter[] deviceFilters;
21704 
21732  void createDeviceFilter (
21733  in wstring name,
21734  [retval] out IUSBDeviceFilter filter
21735  );
21736 
21781  void insertDeviceFilter (
21782  in unsigned long position,
21783  in IUSBDeviceFilter filter
21784  );
21785 
21818  void removeDeviceFilter (
21819  in unsigned long position,
21820  [retval] out IUSBDeviceFilter filter
21821  );
21822 
21823 }; /* interface IUSBDeviceFilters */
21824 
21825 interface IUSBController : $unknown
21826 {
21832  attribute wstring name;
21833 
21840 
21848  readonly attribute unsigned short USBStandard;
21849 
21850 }; /* interface IUSBController */
21851 
21864 interface IUSBDevice : $unknown
21865 {
21872  readonly attribute wstringUUID id;
21873 
21877  readonly attribute unsigned short vendorId;
21878 
21882  readonly attribute unsigned short productId;
21883 
21891  readonly attribute unsigned short revision;
21892 
21896  readonly attribute wstring manufacturer;
21897 
21901  readonly attribute wstring product;
21902 
21906  readonly attribute wstring serialNumber;
21907 
21911  readonly attribute wstring address;
21912 
21919  readonly attribute unsigned short port;
21920 
21926  readonly attribute unsigned short version;
21927 
21935  readonly attribute unsigned short portVersion;
21936 
21942  readonly attribute USBConnectionSpeed speed;
21943 
21950  readonly attribute boolean remote;
21951 
21952 }; /* interface IUSBDevice */
21953 
22029 interface IUSBDeviceFilter : $unknown
22030 {
22038  attribute wstring name;
22039 
22043  attribute boolean active;
22044 
22052  attribute wstring vendorId;
22053 
22061  attribute wstring productId;
22062 
22076  attribute wstring revision;
22077 
22082  attribute wstring manufacturer;
22083 
22088  attribute wstring product;
22089 
22094  attribute wstring serialNumber;
22095 
22100  attribute wstring port;
22101 
22111  attribute wstring remote;
22112 
22122  attribute unsigned long maskedInterfaces;
22123 
22124 }; /* interface IUSBDeviceFilter */
22125 
22143 {
22149  readonly attribute USBDeviceState state;
22150 
22151 }; /* interface IHostUSBDevice */
22152 
22176 {
22184 
22185 }; /* interface IHostUSBDeviceFilter */
22186 
22195 interface IAudioAdapter : $unknown
22196 {
22205  attribute boolean enabled;
22206 
22213  attribute boolean enabledIn;
22214 
22221  attribute boolean enabledOut;
22222 
22229 
22239 
22247 
22253  readonly attribute wstring[] propertiesList;
22254 
22268  void setProperty (
22269  in wstring key,
22270  in wstring value
22271  );
22272 
22286  void getProperty (
22287  in wstring key,
22288  [retval] out wstring value
22289  );
22290 
22291 }; /* interface IAudioAdapter */
22292 
22293 interface IVRDEServer : $unknown
22294 {
22298  attribute boolean enabled;
22299 
22303  attribute AuthType authType;
22304 
22308  attribute unsigned long authTimeout;
22309 
22316  attribute boolean allowMultiConnection;
22317 
22325  attribute boolean reuseSingleConnection;
22326 
22333  attribute wstring VRDEExtPack;
22334 
22341  attribute wstring authLibrary;
22342 
22348  readonly attribute wstring[] VRDEProperties;
22349 
22363  void setVRDEProperty (
22364  in wstring key,
22365  in wstring value
22366  );
22367 
22381  void getVRDEProperty (
22382  in wstring key,
22383  [retval] out wstring value
22384  );
22385 
22386 }; /* interface IVRDEServer */
22387 
22447 interface ISharedFolder : $unknown
22448 {
22452  readonly attribute wstring name;
22453 
22457  readonly attribute wstring hostPath;
22458 
22468  readonly attribute boolean accessible;
22469 
22476  readonly attribute boolean writable;
22477 
22483  readonly attribute boolean autoMount;
22484 
22497  readonly attribute wstring lastAccessError;
22498 
22499 }; /* interface ISharedFolder */
22500 
22501 interface IInternalSessionControl : $unknown
22502 {
22507  readonly attribute unsigned long PID;
22508 
22530  readonly attribute IConsole remoteConsole;
22531 
22538  readonly attribute MachineState nominalState;
22539 
22554  void assignRemoteMachine (
22555  in IMachine machine,
22556  in IConsole console
22557  );
22558 
22582  void updateMachineState (
22583  in MachineState machineState
22584  );
22585 
22601  void uninitialize();
22602 
22625  void onNetworkAdapterChange (
22626  in INetworkAdapter networkAdapter,
22627  in boolean changeAdapter
22628  );
22629 
22652  void onSerialPortChange (
22653  in ISerialPort serialPort
22654  );
22655 
22678  void onParallelPortChange (
22679  in IParallelPort parallelPort
22680  );
22681 
22705 
22732  void onMediumChange (
22733  in IMediumAttachment mediumAttachment,
22734  in boolean force
22735  );
22736 
22766  void onStorageDeviceChange (
22767  in IMediumAttachment mediumAttachment,
22768  in boolean remove,
22769  in boolean silent
22770  );
22771 
22779  void onClipboardModeChange (
22780  in ClipboardMode clipboardMode
22781  );
22782 
22790  void onDnDModeChange (
22791  in DnDMode dndMode
22792  );
22793 
22803  void onCPUChange (
22804  in unsigned long cpu,
22805  in boolean add
22806  );
22807 
22816  in unsigned long executionCap
22817  );
22818 
22843  void onVRDEServerChange (
22844  in boolean restart
22845  );
22846 
22852  void onVideoCaptureChange();
22853 
22876  void onUSBControllerChange();
22877 
22906  void onSharedFolderChange (
22907  in boolean global
22908  );
22909 
22935  void onUSBDeviceAttach (
22936  in IUSBDevice device,
22937  in IVirtualBoxErrorInfo error,
22938  in unsigned long maskedInterfaces,
22939  in wstring captureFilename
22940  );
22941 
22967  void onUSBDeviceDetach (
22968  in wstringUUID id,
22969  in IVirtualBoxErrorInfo error
22970  );
22971 
22989  void onShowWindow (
22990  in boolean check,
22991  out boolean canShow,
22992  out long long winId
22993  );
22994 
23002  void onBandwidthGroupChange (
23003  in IBandwidthGroup bandwidthGroup
23004  );
23005 
23031  void accessGuestProperty (
23032  in wstring name,
23033  in wstring value,
23034  in wstring flags,
23035  in unsigned long accessMode,
23036  out wstring retValue,
23037  out long long retTimestamp,
23038  out wstring retFlags
23039  );
23040 
23089  in wstring patterns,
23090  out wstring[] keys,
23091  out wstring[] values,
23092  out long long[] timestamps,
23093  out wstring[] flags
23094  );
23095 
23130  void onlineMergeMedium (
23131  in IMediumAttachment mediumAttachment,
23132  in unsigned long sourceIdx,
23133  in unsigned long targetIdx,
23134  in IProgress progress
23135  );
23136 
23163  in IMediumAttachment[] attachments
23164  );
23165 
23189  void enableVMMStatistics (
23190  in boolean enable
23191  );
23192 
23220  void pauseWithReason (
23221  in Reason reason
23222  );
23223 
23251  void resumeWithReason (
23252  in Reason reason
23253  );
23254 
23296  void saveStateWithReason (
23297  in Reason reason,
23298  in IProgress progress,
23299  in wstring stateFilePath,
23300  in boolean pauseVM,
23301  [retval] out boolean leftPaused
23302  );
23303 
23312 
23336  void assignMachine (
23337  in IMachine machine,
23338  in LockType lockType,
23339  in wstring tokenId
23340  );
23341 
23365  void assignMachine (
23366  in IMachine machine,
23367  in LockType lockType,
23368  in IToken token
23369  );
23370 
23371 }; /* interface IInternalSessionControl */
23372 
23433 interface ISession : $unknown
23434 {
23438  readonly attribute SessionState state;
23439 
23447  readonly attribute SessionType type;
23448 
23459  attribute wstring name;
23460 
23464  readonly attribute IMachine machine;
23465 
23470  readonly attribute IConsole console;
23471 
23503  void unlockMachine();
23504 
23505 }; /* interface ISession */
23506 
23529 interface IStorageController : $unknown
23530 {
23539  attribute wstring name;
23540 
23546  readonly attribute unsigned long maxDevicesPerPortCount;
23547 
23553  readonly attribute unsigned long minPortCount;
23554 
23560  readonly attribute unsigned long maxPortCount;
23561 
23567  attribute unsigned long instance;
23568 
23577  attribute unsigned long portCount;
23578 
23584  readonly attribute StorageBus bus;
23585 
23599 
23614  attribute boolean useHostIOCache;
23615 
23621  readonly attribute boolean bootable;
23622 
23623 }; /* interface IStorageController */
23624 
23648 interface IManagedObjectRef : $unknown
23649 {
23656  void getInterfaceName (
23657  [retval] out wstring return
23658  );
23659 
23667  void release();
23668 
23669 }; /* interface IManagedObjectRef */
23670 
23679 interface IWebsessionManager : $unknown
23680 {
23689  void logon (
23690  in wstring username,
23691  in wstring password,
23692  [retval] out IVirtualBox return
23693  );
23694 
23704  void getSessionObject (
23705  in IVirtualBox refIVirtualBox,
23706  [retval] out ISession return
23707  );
23708 
23717  void logoff (
23718  in IVirtualBox refIVirtualBox
23719  );
23720 
23721 }; /* interface IWebsessionManager */
23722 
23731 interface IPerformanceMetric : $unknown
23732 {
23738  readonly attribute wstring metricName;
23739 
23745  readonly attribute $unknown object;
23746 
23752  readonly attribute wstring description;
23753 
23759  readonly attribute unsigned long period;
23760 
23770  readonly attribute unsigned long count;
23771 
23777  readonly attribute wstring unit;
23778 
23784  readonly attribute long minimumValue;
23785 
23791  readonly attribute long maximumValue;
23792 
23793 }; /* interface IPerformanceMetric */
23794 
23905 interface IPerformanceCollector : $unknown
23906 {
23917  readonly attribute wstring[] metricNames;
23918 
23942  void getMetrics (
23943  in wstring[] metricNames,
23944  in $unknown[] objects,
23945  [retval] out IPerformanceMetric[] metrics
23946  );
23947 
23986  void setupMetrics (
23987  in wstring[] metricNames,
23988  in $unknown[] objects,
23989  in unsigned long period,
23990  in unsigned long count,
23991  [retval] out IPerformanceMetric[] affectedMetrics
23992  );
23993 
24022  void enableMetrics (
24023  in wstring[] metricNames,
24024  in $unknown[] objects,
24025  [retval] out IPerformanceMetric[] affectedMetrics
24026  );
24027 
24056  void disableMetrics (
24057  in wstring[] metricNames,
24058  in $unknown[] objects,
24059  [retval] out IPerformanceMetric[] affectedMetrics
24060  );
24061 
24151  void queryMetricsData (
24152  in wstring[] metricNames,
24153  in $unknown[] objects,
24154  out wstring[] returnMetricNames,
24155  out $unknown[] returnObjects,
24156  out wstring[] returnUnits,
24157  out unsigned long[] returnScales,
24158  out unsigned long[] returnSequenceNumbers,
24159  out unsigned long[] returnDataIndices,
24160  out unsigned long[] returnDataLengths,
24161  [retval] out long[] returnData
24162  );
24163 
24164 }; /* interface IPerformanceCollector */
24165 
24173 interface INATEngine : $unknown
24174 {
24179  attribute wstring network;
24180 
24187  attribute wstring hostIP;
24188 
24193  attribute wstring TFTPPrefix;
24194 
24199  attribute wstring TFTPBootFile;
24200 
24208  attribute wstring TFTPNextServer;
24209 
24213  attribute unsigned long aliasMode;
24214 
24218  attribute boolean DNSPassDomain;
24219 
24224  attribute boolean DNSProxy;
24225 
24230  attribute boolean DNSUseHostResolver;
24231 
24236  readonly attribute wstring[] redirects;
24237 
24253  void setNetworkSettings (
24254  in unsigned long mtu,
24255  in unsigned long sockSnd,
24256  in unsigned long sockRcv,
24257  in unsigned long TcpWndSnd,
24258  in unsigned long TcpWndRcv
24259  );
24260 
24265  void getNetworkSettings (
24266  out unsigned long mtu,
24267  out unsigned long sockSnd,
24268  out unsigned long sockRcv,
24269  out unsigned long TcpWndSnd,
24270  out unsigned long TcpWndRcv
24271  );
24272 
24292  void addRedirect (
24293  in wstring name,
24294  in NATProtocol proto,
24295  in wstring hostIP,
24296  in unsigned short hostPort,
24297  in wstring guestIP,
24298  in unsigned short guestPort
24299  );
24300 
24306  void removeRedirect (
24307  in wstring name
24308  );
24309 
24310 }; /* interface INATEngine */
24311 
24320 interface IExtPackPlugIn : $unknown
24321 {
24325  readonly attribute wstring name;
24326 
24330  readonly attribute wstring description;
24331 
24337  readonly attribute wstring frontend;
24338 
24342  readonly attribute wstring modulePath;
24343 
24344 }; /* interface IExtPackPlugIn */
24345 
24354 interface IExtPackBase : $unknown
24355 {
24359  readonly attribute wstring name;
24360 
24364  readonly attribute wstring description;
24365 
24377  readonly attribute wstring version;
24378 
24382  readonly attribute unsigned long revision;
24383 
24393  readonly attribute wstring edition;
24394 
24398  readonly attribute wstring VRDEModule;
24399 
24403  readonly attribute IExtPackPlugIn[] plugIns;
24404 
24414  readonly attribute boolean usable;
24415 
24422  readonly attribute wstring whyUnusable;
24423 
24427  readonly attribute boolean showLicense;
24428 
24437  readonly attribute wstring license;
24438 
24462  void queryLicense (
24463  in wstring preferredLocale,
24464  in wstring preferredLanguage,
24465  in wstring format,
24466  [retval] out wstring licenseText
24467  );
24468 
24469 }; /* interface IExtPackBase */
24470 
24480 {
24492  void queryObject (
24493  in wstring objUuid,
24494  [retval] out $unknown returnInterface
24495  );
24496 
24497 }; /* interface IExtPack */
24498 
24509 {
24515  readonly attribute wstring filePath;
24516 
24535  void install (
24536  in boolean replace,
24537  in wstring displayInfo,
24538  [retval] out IProgress progess
24539  );
24540 
24541 }; /* interface IExtPackFile */
24542 
24552 interface IExtPackManager : $unknown
24553 {
24559  readonly attribute IExtPack[] installedExtPacks;
24560 
24578  void find (
24579  in wstring name,
24580  [retval] out IExtPack returnData
24581  );
24582 
24594  void openExtPackFile (
24595  in wstring path,
24596  [retval] out IExtPackFile file
24597  );
24598 
24617  void uninstall (
24618  in wstring name,
24619  in boolean forcedRemoval,
24620  in wstring displayInfo,
24621  [retval] out IProgress progess
24622  );
24623 
24627  void cleanup();
24628 
24642  in wstring frontendName,
24643  [retval] out wstring[] plugInModules
24644  );
24645 
24653  void isExtPackUsable (
24654  in wstring name,
24655  [retval] out boolean usable
24656  );
24657 
24658 }; /* interface IExtPackManager */
24659 
24665 interface IBandwidthGroup : $unknown
24666 {
24670  readonly attribute wstring name;
24671 
24675  readonly attribute BandwidthGroupType type;
24676 
24680  readonly attribute unsigned long reference;
24681 
24686  attribute long long maxBytesPerSec;
24687 
24688 }; /* interface IBandwidthGroup */
24689 
24698 interface IBandwidthControl : $unknown
24699 {
24705  readonly attribute unsigned long numGroups;
24706 
24719  void createBandwidthGroup (
24720  in wstring name,
24721  in BandwidthGroupType type,
24722  in long long maxBytesPerSec
24723  );
24724 
24732  void deleteBandwidthGroup (
24733  in wstring name
24734  );
24735 
24745  void getBandwidthGroup (
24746  in wstring name,
24747  [retval] out IBandwidthGroup bandwidthGroup
24748  );
24749 
24757  void getAllBandwidthGroups (
24758  [retval] out IBandwidthGroup[] bandwidthGroups
24759  );
24760 
24761 }; /* interface IBandwidthControl */
24762 
24775 interface IVirtualBoxClient : $unknown
24776 {
24782  readonly attribute IVirtualBox virtualBox;
24783 
24789  readonly attribute ISession session;
24790 
24796  readonly attribute IEventSource eventSource;
24797 
24808  void checkMachineError (
24809  in IMachine machine
24810  );
24811 
24812 }; /* interface IVirtualBoxClient */
24813 
24827 interface IEventSource : $unknown
24828 {
24834  void createListener (
24835  [retval] out IEventListener listener
24836  );
24837 
24853  void createAggregator (
24854  in IEventSource[] subordinates,
24855  [retval] out IEventSource result
24856  );
24857 
24890  void registerListener (
24891  in IEventListener listener,
24892  in VBoxEventType[] interesting,
24893  in boolean active
24894  );
24895 
24904  void unregisterListener (
24905  in IEventListener listener
24906  );
24907 
24922  void fireEvent (
24923  in IEvent event,
24924  in long timeout,
24925  [retval] out boolean result
24926  );
24927 
24952  void getEvent (
24953  in IEventListener listener,
24954  in long timeout,
24955  [retval] out IEvent event
24956  );
24957 
24969  void eventProcessed (
24970  in IEventListener listener,
24971  in IEvent event
24972  );
24973 
24974 }; /* interface IEventSource */
24975 
24985 interface IEventListener : $unknown
24986 {
24999  void handleEvent (
25000  in IEvent event
25001  );
25002 
25003 }; /* interface IEventListener */
25004 
25082 interface IEvent : $unknown
25083 {
25089  readonly attribute VBoxEventType type;
25090 
25096  readonly attribute IEventSource source;
25097 
25108  readonly attribute boolean waitable;
25109 
25116  void setProcessed();
25117 
25131  void waitProcessed (
25132  in long timeout,
25133  [retval] out boolean result
25134  );
25135 
25136 }; /* interface IEvent */
25137 
25144 {
25148  readonly attribute unsigned long generation;
25149 
25156  void reuse();
25157 
25158 }; /* interface IReusableEvent */
25159 
25166 {
25170  readonly attribute wstringUUID machineId;
25171 
25172 }; /* interface IMachineEvent */
25173 
25180 {
25184  readonly attribute MachineState state;
25185 
25186 }; /* interface IMachineStateChangedEvent */
25187 
25196 {
25203  readonly attribute boolean temporary;
25204 
25205 }; /* interface IMachineDataChangedEvent */
25206 
25218 {
25222  readonly attribute wstringUUID mediumId;
25223 
25227  readonly attribute DeviceType mediumType;
25228 
25235  readonly attribute boolean registered;
25236 
25237 }; /* interface IMediumRegisteredEvent */
25238 
25250 {
25254  readonly attribute IMedium medium;
25255 
25256 }; /* interface IMediumConfigChangedEvent */
25257 
25267 {
25274  readonly attribute boolean registered;
25275 
25276 }; /* interface IMachineRegisteredEvent */
25277 
25288 {
25294  readonly attribute SessionState state;
25295 
25296 }; /* interface ISessionStateChangedEvent */
25297 
25306 {
25312  readonly attribute wstring name;
25313 
25319  readonly attribute wstring value;
25320 
25326  readonly attribute wstring flags;
25327 
25328 }; /* interface IGuestPropertyChangedEvent */
25329 
25336 {
25340  readonly attribute wstringUUID snapshotId;
25341 
25342 }; /* interface ISnapshotEvent */
25343 
25354 {
25355  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25356 
25357 }; /* interface ISnapshotTakenEvent */
25358 
25376 {
25377  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25378 
25379 }; /* interface ISnapshotDeletedEvent */
25380 
25391 {
25392  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25393 
25394 }; /* interface ISnapshotRestoredEvent */
25395 
25406 {
25407  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25408 
25409 }; /* interface ISnapshotChangedEvent */
25410 
25420 {
25426  readonly attribute boolean visible;
25427 
25433  readonly attribute boolean alpha;
25434 
25440  readonly attribute unsigned long xhot;
25441 
25447  readonly attribute unsigned long yhot;
25448 
25454  readonly attribute unsigned long width;
25455 
25461  readonly attribute unsigned long height;
25462 
25495  readonly attribute octet[] shape;
25496 
25497 }; /* interface IMousePointerShapeChangedEvent */
25498 
25508 {
25514  readonly attribute boolean supportsAbsolute;
25515 
25521  readonly attribute boolean supportsRelative;
25522 
25528  readonly attribute boolean supportsMultiTouch;
25529 
25535  readonly attribute boolean needsHostCursor;
25536 
25537 }; /* interface IMouseCapabilityChangedEvent */
25538 
25548 {
25554  readonly attribute boolean numLock;
25555 
25561  readonly attribute boolean capsLock;
25562 
25568  readonly attribute boolean scrollLock;
25569 
25570 }; /* interface IKeyboardLedsChangedEvent */
25571 
25581 {
25587  readonly attribute MachineState state;
25588 
25589 }; /* interface IStateChangedEvent */
25590 
25601 {
25602  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25603 
25604 }; /* interface IAdditionsStateChangedEvent */
25605 
25617 {
25623  readonly attribute INetworkAdapter networkAdapter;
25624 
25625 }; /* interface INetworkAdapterChangedEvent */
25626 
25638 {
25644  readonly attribute ISerialPort serialPort;
25645 
25646 }; /* interface ISerialPortChangedEvent */
25647 
25659 {
25665  readonly attribute IParallelPort parallelPort;
25666 
25667 }; /* interface IParallelPortChangedEvent */
25668 
25679 {
25680  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25681 
25682 }; /* interface IStorageControllerChangedEvent */
25683 
25696 {
25703 
25704 }; /* interface IMediumChangedEvent */
25705 
25714 {
25720  readonly attribute ClipboardMode clipboardMode;
25721 
25722 }; /* interface IClipboardModeChangedEvent */
25723 
25732 {
25738  readonly attribute DnDMode dndMode;
25739 
25740 }; /* interface IDnDModeChangedEvent */
25741 
25750 {
25756  readonly attribute unsigned long CPU;
25757 
25763  readonly attribute boolean add;
25764 
25765 }; /* interface ICPUChangedEvent */
25766 
25775 {
25781  readonly attribute unsigned long executionCap;
25782 
25783 }; /* interface ICPUExecutionCapChangedEvent */
25784 
25793 {
25799  readonly attribute long[] scancodes;
25800 
25801 }; /* interface IGuestKeyboardEvent */
25802 
25811 {
25817  readonly attribute GuestMouseEventMode mode;
25818 
25824  readonly attribute long x;
25825 
25831  readonly attribute long y;
25832 
25838  readonly attribute long z;
25839 
25845  readonly attribute long w;
25846 
25852  readonly attribute long buttons;
25853 
25854 }; /* interface IGuestMouseEvent */
25855 
25864 {
25870  readonly attribute long contactCount;
25871 
25877  readonly attribute short[] xPositions;
25878 
25884  readonly attribute short[] yPositions;
25885 
25891  readonly attribute unsigned short[] contactIds;
25892 
25900  readonly attribute unsigned short[] contactFlags;
25901 
25907  readonly attribute unsigned long scanTime;
25908 
25909 }; /* interface IGuestMultiTouchEvent */
25910 
25917 {
25921  readonly attribute IGuestSession session;
25922 
25923 }; /* interface IGuestSessionEvent */
25924 
25933 {
25939  readonly attribute unsigned long id;
25940 
25946  readonly attribute GuestSessionStatus status;
25947 
25957  readonly attribute IVirtualBoxErrorInfo error;
25958 
25959 }; /* interface IGuestSessionStateChangedEvent */
25960 
25969 {
25976  readonly attribute boolean registered;
25977 
25978 }; /* interface IGuestSessionRegisteredEvent */
25979 
25986 {
25992  readonly attribute IGuestProcess process;
25993 
25999  readonly attribute unsigned long pid;
26000 
26001 }; /* interface IGuestProcessEvent */
26002