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 
7458  void authenticateExternal (
7459  in wstring[] authParams,
7460  out wstring result
7461  );
7462 
7463 }; /* interface IInternalMachineControl */
7464 
7473 interface IBIOSSettings : $unknown
7474 {
7478  attribute boolean logoFadeIn;
7479 
7483  attribute boolean logoFadeOut;
7484 
7488  attribute unsigned long logoDisplayTime;
7489 
7496  attribute wstring logoImagePath;
7497 
7502 
7506  attribute boolean ACPIEnabled;
7507 
7514  attribute boolean IOAPICEnabled;
7515 
7525  attribute long long timeOffset;
7526 
7533  attribute boolean PXEDebugEnabled;
7534 
7543  readonly attribute wstring nonVolatileStorageFile;
7544 
7545 }; /* interface IBIOSSettings */
7546 
7554 interface IPCIAddress : $unknown
7555 {
7561  attribute short bus;
7562 
7568  attribute short device;
7569 
7575  attribute short devFunction;
7576 
7582  void asLong (
7583  [retval] out long result
7584  );
7585 
7591  void fromLong (
7592  in long number
7593  );
7594 
7595 }; /* interface IPCIAddress */
7596 
7604 interface IPCIDeviceAttachment : $unknown
7605 {
7611  readonly attribute wstring name;
7612 
7618  readonly attribute boolean isPhysicalDevice;
7619 
7625  readonly attribute long hostAddress;
7626 
7632  readonly attribute long guestAddress;
7633 
7634 }; /* interface IPCIDeviceAttachment */
7635 
7676 interface IMachine : $unknown
7677 {
7681  readonly attribute IVirtualBox parent;
7682 
7686  attribute octet[] icon;
7687 
7738  readonly attribute boolean accessible;
7739 
7751  readonly attribute IVirtualBoxErrorInfo accessError;
7752 
7793  attribute wstring name;
7794 
7805  attribute wstring description;
7806 
7810  readonly attribute wstringUUID id;
7811 
7822  attribute wstring[] groups;
7823 
7838  attribute wstring OSTypeId;
7839 
7843  attribute wstring hardwareVersion;
7844 
7854  attribute wstringUUID hardwareUUID;
7855 
7859  attribute unsigned long CPUCount;
7860 
7866  attribute boolean CPUHotPlugEnabled;
7867 
7875  attribute unsigned long CPUExecutionCap;
7876 
7888  attribute unsigned long CPUIDPortabilityLevel;
7889 
7893  attribute unsigned long memorySize;
7894 
7898  attribute unsigned long memoryBalloonSize;
7899 
7906  attribute boolean pageFusionEnabled;
7907 
7912 
7916  attribute unsigned long VRAMSize;
7917 
7923  attribute boolean accelerate3DEnabled;
7924 
7930  attribute boolean accelerate2DVideoEnabled;
7931 
7942  attribute unsigned long monitorCount;
7943 
7949  attribute boolean videoCaptureEnabled;
7950 
7956  attribute boolean[] videoCaptureScreens;
7957 
7971  attribute wstring videoCaptureFile;
7972 
7980  attribute unsigned long videoCaptureWidth;
7981 
7989  attribute unsigned long videoCaptureHeight;
7990 
7999  attribute unsigned long videoCaptureRate;
8000 
8010  attribute unsigned long videoCaptureFPS;
8011 
8021  attribute unsigned long videoCaptureMaxTime;
8022 
8032  attribute unsigned long videoCaptureMaxFileSize;
8033 
8041  attribute wstring videoCaptureOptions;
8042 
8046  readonly attribute IBIOSSettings BIOSSettings;
8047 
8053 
8060 
8067 
8074  attribute boolean HPETEnabled;
8075 
8080 
8114  attribute wstring snapshotFolder;
8115 
8119  readonly attribute IVRDEServer VRDEServer;
8120 
8121  attribute boolean emulatedUSBCardReaderEnabled;
8122 
8126  readonly attribute IMediumAttachment[] mediumAttachments;
8127 
8139  readonly attribute IUSBController[] USBControllers;
8140 
8153 
8157  readonly attribute IAudioAdapter audioAdapter;
8158 
8163 
8169  readonly attribute wstring settingsFilePath;
8170 
8195  readonly attribute boolean settingsModified;
8196 
8200  readonly attribute SessionState sessionState;
8201 
8215  readonly attribute wstring sessionName;
8216 
8226  readonly attribute unsigned long sessionPID;
8227 
8231  readonly attribute MachineState state;
8232 
8239  readonly attribute long long lastStateChange;
8240 
8252  readonly attribute wstring stateFilePath;
8253 
8263  readonly attribute wstring logFolder;
8264 
8274  readonly attribute ISnapshot currentSnapshot;
8275 
8282  readonly attribute unsigned long snapshotCount;
8283 
8316  readonly attribute boolean currentStateModified;
8317 
8329  readonly attribute ISharedFolder[] sharedFolders;
8330 
8338 
8344  attribute DnDMode dnDMode;
8345 
8354  attribute boolean teleporterEnabled;
8355 
8366  attribute unsigned long teleporterPort;
8367 
8374  attribute wstring teleporterAddress;
8375 
8386  attribute wstring teleporterPassword;
8387 
8394 
8403 
8410  attribute unsigned long faultTolerancePort;
8411 
8417  attribute wstring faultToleranceAddress;
8418 
8426  attribute wstring faultTolerancePassword;
8427 
8433  attribute unsigned long faultToleranceSyncInterval;
8434 
8442  attribute boolean RTCUseUTC;
8443 
8450  attribute boolean IOCacheEnabled;
8451 
8457  attribute unsigned long IOCacheSize;
8458 
8469 
8476 
8485  attribute boolean tracingEnabled;
8486 
8501  attribute wstring tracingConfig;
8502 
8515  attribute boolean allowTracingToAccessVM;
8516 
8522  attribute boolean autostartEnabled;
8523 
8529  attribute unsigned long autostartDelay;
8530 
8537 
8553  attribute wstring defaultFrontend;
8554 
8560  readonly attribute boolean USBProxyAvailable;
8561 
8582  attribute wstring VMProcessPriority;
8583 
8691  void lockMachine (
8692  in ISession session,
8693  in LockType lockType
8694  );
8695 
8844  void launchVMProcess (
8845  in ISession session,
8846  in wstring name,
8847  in wstring environment,
8848  [retval] out IProgress progress
8849  );
8850 
8888  void setBootOrder (
8889  in unsigned long position,
8890  in DeviceType device
8891  );
8892 
8927  void getBootOrder (
8928  in unsigned long position,
8929  [retval] out DeviceType device
8930  );
8931 
9034  void attachDevice (
9035  in wstring name,
9036  in long controllerPort,
9037  in long device,
9038  in DeviceType type,
9039  in IMedium medium
9040  );
9041 
9139  in wstring name,
9140  in long controllerPort,
9141  in long device,
9142  in DeviceType type
9143  );
9144 
9198  void detachDevice (
9199  in wstring name,
9200  in long controllerPort,
9201  in long device
9202  );
9203 
9246  void passthroughDevice (
9247  in wstring name,
9248  in long controllerPort,
9249  in long device,
9250  in boolean passthrough
9251  );
9252 
9295  void temporaryEjectDevice (
9296  in wstring name,
9297  in long controllerPort,
9298  in long device,
9299  in boolean temporaryEject
9300  );
9301 
9347  void nonRotationalDevice (
9348  in wstring name,
9349  in long controllerPort,
9350  in long device,
9351  in boolean nonRotational
9352  );
9353 
9400  in wstring name,
9401  in long controllerPort,
9402  in long device,
9403  in boolean discard
9404  );
9405 
9456  in wstring name,
9457  in long controllerPort,
9458  in long device,
9459  in boolean hotPluggable
9460  );
9461 
9503  in wstring name,
9504  in long controllerPort,
9505  in long device,
9506  in IBandwidthGroup bandwidthGroup
9507  );
9508 
9546  in wstring name,
9547  in long controllerPort,
9548  in long device
9549  );
9550 
9615  void unmountMedium (
9616  in wstring name,
9617  in long controllerPort,
9618  in long device,
9619  in boolean force
9620  );
9621 
9684  void mountMedium (
9685  in wstring name,
9686  in long controllerPort,
9687  in long device,
9688  in IMedium medium,
9689  in boolean force
9690  );
9691 
9720  void getMedium (
9721  in wstring name,
9722  in long controllerPort,
9723  in long device,
9724  [retval] out IMedium medium
9725  );
9726 
9742  in wstring name,
9743  [retval] out IMediumAttachment[] mediumAttachments
9744  );
9745 
9760  void getMediumAttachment (
9761  in wstring name,
9762  in long controllerPort,
9763  in long device,
9764  [retval] out IMediumAttachment attachment
9765  );
9766 
9807  void attachHostPCIDevice (
9808  in long hostAddress,
9809  in long desiredGuestAddress,
9810  in boolean tryToUnbind
9811  );
9812 
9853  void detachHostPCIDevice (
9854  in long hostAddress
9855  );
9856 
9874  void getNetworkAdapter (
9875  in unsigned long slot,
9876  [retval] out INetworkAdapter adapter
9877  );
9878 
9911  void addStorageController (
9912  in wstring name,
9913  in StorageBus connectionType,
9914  [retval] out IStorageController controller
9915  );
9916 
9931  in wstring name,
9932  [retval] out IStorageController storageController
9933  );
9934 
9950  in StorageBus connectionType,
9951  in unsigned long instance,
9952  [retval] out IStorageController storageController
9953  );
9954 
9978  in wstring name
9979  );
9980 
10003  in wstring name,
10004  in boolean bootable
10005  );
10006 
10029  void addUSBController (
10030  in wstring name,
10031  in USBControllerType type,
10032  [retval] out IUSBController controller
10033  );
10034 
10048  void removeUSBController (
10049  in wstring name
10050  );
10051 
10065  void getUSBControllerByName (
10066  in wstring name,
10067  [retval] out IUSBController controller
10068  );
10069 
10076  in USBControllerType type,
10077  [retval] out unsigned long controllers
10078  );
10079 
10097  void getSerialPort (
10098  in unsigned long slot,
10099  [retval] out ISerialPort port
10100  );
10101 
10119  void getParallelPort (
10120  in unsigned long slot,
10121  [retval] out IParallelPort port
10122  );
10123 
10132  void getExtraDataKeys (
10133  [retval] out wstring[] keys
10134  );
10135 
10164  void getExtraData (
10165  in wstring key,
10166  [retval] out wstring value
10167  );
10168 
10218  void setExtraData (
10219  in wstring key,
10220  in wstring value
10221  );
10222 
10244  void getCPUProperty (
10245  in CPUPropertyType property,
10246  [retval] out boolean value
10247  );
10248 
10270  void setCPUProperty (
10271  in CPUPropertyType property,
10272  in boolean value
10273  );
10274 
10314  void getCPUIDLeaf (
10315  in unsigned long id,
10316  out unsigned long valEax,
10317  out unsigned long valEbx,
10318  out unsigned long valEcx,
10319  out unsigned long valEdx
10320  );
10321 
10365  void setCPUIDLeaf (
10366  in unsigned long id,
10367  in unsigned long valEax,
10368  in unsigned long valEbx,
10369  in unsigned long valEcx,
10370  in unsigned long valEdx
10371  );
10372 
10390  void removeCPUIDLeaf (
10391  in unsigned long id
10392  );
10393 
10399  void removeAllCPUIDLeaves();
10400 
10422  void getHWVirtExProperty (
10423  in HWVirtExPropertyType property,
10424  [retval] out boolean value
10425  );
10426 
10448  void setHWVirtExProperty (
10449  in HWVirtExPropertyType property,
10450  in boolean value
10451  );
10452 
10482  void setSettingsFilePath (
10483  in wstring settingsFilePath,
10484  [retval] out IProgress progress
10485  );
10486 
10532  void saveSettings();
10533 
10557  void discardSettings();
10558 
10643  void unregister (
10644  in CleanupMode cleanupMode,
10645  [retval] out IMedium[] media
10646  );
10647 
10705  void deleteConfig (
10706  in IMedium[] media,
10707  [retval] out IProgress progress
10708  );
10709 
10721  void exportTo (
10722  in IAppliance appliance,
10723  in wstring location,
10724  [retval] out IVirtualSystemDescription description
10725  );
10726 
10750  void findSnapshot (
10751  in wstring nameOrId,
10752  [retval] out ISnapshot snapshot
10753  );
10754 
10788  void createSharedFolder (
10789  in wstring name,
10790  in wstring hostPath,
10791  in boolean writable,
10792  in boolean automount
10793  );
10794 
10820  void removeSharedFolder (
10821  in wstring name
10822  );
10823 
10847  void canShowConsoleWindow (
10848  [retval] out boolean canShow
10849  );
10850 
10885  void showConsoleWindow (
10886  [retval] out long long winId
10887  );
10888 
10921  void getGuestProperty (
10922  in wstring name,
10923  out wstring value,
10924  out long long timestamp,
10925  out wstring flags
10926  );
10927 
10950  void getGuestPropertyValue (
10951  in wstring property,
10952  [retval] out wstring value
10953  );
10954 
10978  in wstring property,
10979  [retval] out long long value
10980  );
10981 
11032  void setGuestProperty (
11033  in wstring property,
11034  in wstring value,
11035  in wstring flags
11036  );
11037 
11077  void setGuestPropertyValue (
11078  in wstring property,
11079  in wstring value
11080  );
11081 
11099  void deleteGuestProperty (
11100  in wstring name
11101  );
11102 
11134  in wstring patterns,
11135  out wstring[] names,
11136  out wstring[] values,
11137  out long long[] timestamps,
11138  out wstring[] flags
11139  );
11140 
11171  in unsigned long screenId,
11172  out unsigned long originX,
11173  out unsigned long originY,
11174  out unsigned long width,
11175  out unsigned long height,
11176  out boolean enabled
11177  );
11178 
11205  in unsigned long screenId,
11206  in BitmapFormat bitmapFormat,
11207  out unsigned long width,
11208  out unsigned long height,
11209  [retval] out octet[] data
11210  );
11211 
11234  in unsigned long screenId,
11235  out unsigned long width,
11236  out unsigned long height,
11237  [retval] out BitmapFormat[] bitmapFormats
11238  );
11239 
11266  in unsigned long screenId,
11267  in BitmapFormat bitmapFormat,
11268  out unsigned long width,
11269  out unsigned long height,
11270  [retval] out octet[] data
11271  );
11272 
11282  void hotPlugCPU (
11283  in unsigned long cpu
11284  );
11285 
11295  void hotUnplugCPU (
11296  in unsigned long cpu
11297  );
11298 
11312  void getCPUStatus (
11313  in unsigned long cpu,
11314  [retval] out boolean attached
11315  );
11316 
11327  [retval] out ParavirtProvider paravirtProvider
11328  );
11329 
11344  void queryLogFilename (
11345  in unsigned long idx,
11346  [retval] out wstring filename
11347  );
11348 
11374  void readLog (
11375  in unsigned long idx,
11376  in long long offset,
11377  in long long size,
11378  [retval] out octet[] data
11379  );
11380 
11413  void cloneTo (
11414  in IMachine target,
11415  in CloneMode mode,
11416  in CloneOptions[] options,
11417  [retval] out IProgress progress
11418  );
11419 
11472  void saveState (
11473  [retval] out IProgress progress
11474  );
11475 
11508  void adoptSavedState (
11509  in wstring savedStateFile
11510  );
11511 
11542  void discardSavedState (
11543  in boolean fRemoveFile
11544  );
11545 
11591  void takeSnapshot (
11592  in wstring name,
11593  in wstring description,
11594  in boolean pause,
11595  out wstringUUID id,
11596  [retval] out IProgress progress
11597  );
11598 
11672  void deleteSnapshot (
11673  in wstringUUID id,
11674  [retval] out IProgress progress
11675  );
11676 
11717  in wstringUUID id,
11718  [retval] out IProgress progress
11719  );
11720 
11764  void deleteSnapshotRange (
11765  in wstringUUID startId,
11766  in wstringUUID endId,
11767  [retval] out IProgress progress
11768  );
11769 
11810  void restoreSnapshot (
11811  in ISnapshot snapshot,
11812  [retval] out IProgress progress
11813  );
11814 
11841  void applyDefaults (
11842  in wstring flags
11843  );
11844 
11845 }; /* interface IMachine */
11846 
11854 interface IEmulatedUSB : $unknown
11855 {
11859  readonly attribute wstring[] webcams;
11860 
11870  void webcamAttach (
11871  in wstring path,
11872  in wstring settings
11873  );
11874 
11882  void webcamDetach (
11883  in wstring path
11884  );
11885 
11886 }; /* interface IEmulatedUSB */
11887 
11896 interface IVRDEServerInfo : $unknown
11897 {
11903  readonly attribute boolean active;
11904 
11913  readonly attribute long port;
11914 
11920  readonly attribute unsigned long numberOfClients;
11921 
11927  readonly attribute long long beginTime;
11928 
11935  readonly attribute long long endTime;
11936 
11942  readonly attribute long long bytesSent;
11943 
11949  readonly attribute long long bytesSentTotal;
11950 
11956  readonly attribute long long bytesReceived;
11957 
11963  readonly attribute long long bytesReceivedTotal;
11964 
11970  readonly attribute wstring user;
11971 
11977  readonly attribute wstring domain;
11978 
11984  readonly attribute wstring clientName;
11985 
11991  readonly attribute wstring clientIP;
11992 
11998  readonly attribute unsigned long clientVersion;
11999 
12007  readonly attribute unsigned long encryptionStyle;
12008 
12009 }; /* interface IVRDEServerInfo */
12010 
12032 interface IConsole : $unknown
12033 {
12045  readonly attribute IMachine machine;
12046 
12060  readonly attribute MachineState state;
12061 
12065  readonly attribute IGuest guest;
12066 
12077  readonly attribute IKeyboard keyboard;
12078 
12089  readonly attribute IMouse mouse;
12090 
12100  readonly attribute IDisplay display;
12101 
12105  readonly attribute IMachineDebugger debugger;
12106 
12117  readonly attribute IUSBDevice[] USBDevices;
12118 
12126  readonly attribute IHostUSBDevice[] remoteUSBDevices;
12127 
12143  readonly attribute ISharedFolder[] sharedFolders;
12144 
12150  readonly attribute IVRDEServerInfo VRDEServerInfo;
12151 
12157  readonly attribute IEventSource eventSource;
12158 
12163 
12172  attribute boolean useHostClipboard;
12173 
12179  readonly attribute IEmulatedUSB emulatedUSB;
12180 
12245  void powerUp (
12246  [retval] out IProgress progress
12247  );
12248 
12282  void powerUpPaused (
12283  [retval] out IProgress progress
12284  );
12285 
12305  void powerDown (
12306  [retval] out IProgress progress
12307  );
12308 
12328  void reset();
12329 
12349  void pause();
12350 
12370  void resume();
12371 
12391  void powerButton();
12392 
12412  void sleepButton();
12413 
12425  void getPowerButtonHandled (
12426  [retval] out boolean handled
12427  );
12428 
12443  [retval] out boolean entered
12444  );
12445 
12458  void getDeviceActivity (
12459  in DeviceType[] type,
12460  [retval] out DeviceActivity[] activity
12461  );
12462 
12502  void attachUSBDevice (
12503  in wstringUUID id,
12504  in wstring captureFilename
12505  );
12506 
12541  void detachUSBDevice (
12542  in wstringUUID id,
12543  [retval] out IUSBDevice device
12544  );
12545 
12568  void findUSBDeviceByAddress (
12569  in wstring name,
12570  [retval] out IUSBDevice device
12571  );
12572 
12592  void findUSBDeviceById (
12593  in wstringUUID id,
12594  [retval] out IUSBDevice device
12595  );
12596 
12630  void createSharedFolder (
12631  in wstring name,
12632  in wstring hostPath,
12633  in boolean writable,
12634  in boolean automount
12635  );
12636 
12661  void removeSharedFolder (
12662  in wstring name
12663  );
12664 
12703  void teleport (
12704  in wstring hostname,
12705  in unsigned long tcpport,
12706  in wstring password,
12707  in unsigned long maxDowntime,
12708  [retval] out IProgress progress
12709  );
12710 
12738  in wstring id,
12739  in wstring password,
12740  in boolean clearOnSuspend
12741  );
12742 
12770  in wstring[] ids,
12771  in wstring[] passwords,
12772  in boolean clearOnSuspend
12773  );
12774 
12789  in wstring id
12790  );
12791 
12796 
12797 }; /* interface IConsole */
12798 
12809 interface IHostNetworkInterface : $unknown
12810 {
12814  readonly attribute wstring name;
12815 
12819  readonly attribute wstring shortName;
12820 
12824  readonly attribute wstringUUID id;
12825 
12829  readonly attribute wstring networkName;
12830 
12834  readonly attribute boolean DHCPEnabled;
12835 
12839  readonly attribute wstring IPAddress;
12840 
12844  readonly attribute wstring networkMask;
12845 
12849  readonly attribute boolean IPV6Supported;
12850 
12854  readonly attribute wstring IPV6Address;
12855 
12859  readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
12860 
12864  readonly attribute wstring hardwareAddress;
12865 
12870 
12875 
12880 
12892  void enableStaticIPConfig (
12893  in wstring IPAddress,
12894  in wstring networkMask
12895  );
12896 
12908  void enableStaticIPConfigV6 (
12909  in wstring IPV6Address,
12910  in unsigned long IPV6NetworkMaskPrefixLength
12911  );
12912 
12916  void enableDynamicIPConfig();
12917 
12921  void DHCPRediscover();
12922 
12923 }; /* interface IHostNetworkInterface */
12924 
12932 interface IHostVideoInputDevice : $unknown
12933 {
12937  readonly attribute wstring name;
12938 
12942  readonly attribute wstring path;
12943 
12947  readonly attribute wstring alias;
12948 
12949 }; /* interface IHostVideoInputDevice */
12950 
12967 interface IHost : $unknown
12968 {
12972  readonly attribute IMedium[] DVDDrives;
12973 
12977  readonly attribute IMedium[] floppyDrives;
12978 
12992  readonly attribute IHostUSBDevice[] USBDevices;
12993 
13018 
13023 
13027  readonly attribute wstring[] nameServers;
13028 
13032  readonly attribute wstring domainName;
13033 
13037  readonly attribute wstring[] searchStrings;
13038 
13042  readonly attribute unsigned long processorCount;
13043 
13047  readonly attribute unsigned long processorOnlineCount;
13048 
13052  readonly attribute unsigned long processorCoreCount;
13053 
13057  readonly attribute unsigned long processorOnlineCoreCount;
13058 
13062  readonly attribute unsigned long memorySize;
13063 
13067  readonly attribute unsigned long memoryAvailable;
13068 
13072  readonly attribute wstring operatingSystem;
13073 
13077  readonly attribute wstring OSVersion;
13078 
13082  readonly attribute long long UTCTime;
13083 
13087  readonly attribute boolean acceleration3DAvailable;
13088 
13093 
13108  void getProcessorSpeed (
13109  in unsigned long cpuId,
13110  [retval] out unsigned long speed
13111  );
13112 
13124  void getProcessorFeature (
13125  in ProcessorFeature feature,
13126  [retval] out boolean supported
13127  );
13128 
13148  in unsigned long cpuId,
13149  [retval] out wstring description
13150  );
13151 
13192  void getProcessorCPUIDLeaf (
13193  in unsigned long cpuId,
13194  in unsigned long leaf,
13195  in unsigned long subLeaf,
13196  out unsigned long valEax,
13197  out unsigned long valEbx,
13198  out unsigned long valEcx,
13199  out unsigned long valEdx
13200  );
13201 
13223  out IHostNetworkInterface hostInterface,
13224  [retval] out IProgress progress
13225  );
13226 
13248  in wstringUUID id,
13249  [retval] out IProgress progress
13250  );
13251 
13271  void createUSBDeviceFilter (
13272  in wstring name,
13273  [retval] out IHostUSBDeviceFilter filter
13274  );
13275 
13318  void insertUSBDeviceFilter (
13319  in unsigned long position,
13320  in IHostUSBDeviceFilter filter
13321  );
13322 
13350  void removeUSBDeviceFilter (
13351  in unsigned long position
13352  );
13353 
13371  void findHostDVDDrive (
13372  in wstring name,
13373  [retval] out IMedium drive
13374  );
13375 
13393  void findHostFloppyDrive (
13394  in wstring name,
13395  [retval] out IMedium drive
13396  );
13397 
13414  in wstring name,
13415  [retval] out IHostNetworkInterface networkInterface
13416  );
13417 
13434  in wstringUUID id,
13435  [retval] out IHostNetworkInterface networkInterface
13436  );
13437 
13448  in HostNetworkInterfaceType type,
13449  [retval] out IHostNetworkInterface[] networkInterfaces
13450  );
13451 
13471  void findUSBDeviceById (
13472  in wstringUUID id,
13473  [retval] out IHostUSBDevice device
13474  );
13475 
13498  void findUSBDeviceByAddress (
13499  in wstring name,
13500  [retval] out IHostUSBDevice device
13501  );
13502 
13510  void generateMACAddress (
13511  [retval] out wstring address
13512  );
13513 
13514 }; /* interface IHost */
13515 
13528 interface ISystemProperties : $unknown
13529 {
13533  readonly attribute unsigned long minGuestRAM;
13534 
13538  readonly attribute unsigned long maxGuestRAM;
13539 
13543  readonly attribute unsigned long minGuestVRAM;
13544 
13548  readonly attribute unsigned long maxGuestVRAM;
13549 
13553  readonly attribute unsigned long minGuestCPUCount;
13554 
13558  readonly attribute unsigned long maxGuestCPUCount;
13559 
13563  readonly attribute unsigned long maxGuestMonitors;
13564 
13569  readonly attribute long long infoVDSize;
13570 
13577  readonly attribute unsigned long serialPortCount;
13578 
13585  readonly attribute unsigned long parallelPortCount;
13586 
13596  readonly attribute unsigned long maxBootPosition;
13597 
13606  readonly attribute boolean rawModeSupported;
13607 
13620  attribute boolean exclusiveHwVirt;
13621 
13645  attribute wstring defaultMachineFolder;
13646 
13652  attribute wstring loggingLevel;
13653 
13679  readonly attribute IMediumFormat[] mediumFormats;
13680 
13714  attribute wstring defaultHardDiskFormat;
13715 
13721  attribute long long freeDiskSpaceWarning;
13722 
13727  attribute unsigned long freeDiskSpacePercentWarning;
13728 
13734  attribute long long freeDiskSpaceError;
13735 
13740  attribute unsigned long freeDiskSpacePercentError;
13741 
13765  attribute wstring VRDEAuthLibrary;
13766 
13795  attribute wstring webServiceAuthLibrary;
13796 
13810  attribute wstring defaultVRDEExtPack;
13811 
13817  attribute unsigned long logHistoryCount;
13818 
13824 
13831  attribute wstring autostartDatabasePath;
13832 
13839  attribute wstring defaultAdditionsISO;
13840 
13855  attribute wstring defaultFrontend;
13856 
13863  readonly attribute BitmapFormat[] screenShotFormats;
13864 
13875  void getMaxNetworkAdapters (
13876  in ChipsetType chipset,
13877  [retval] out unsigned long maxNetworkAdapters
13878  );
13879 
13894  in ChipsetType chipset,
13895  in NetworkAttachmentType type,
13896  [retval] out unsigned long maxNetworkAdapters
13897  );
13898 
13909  in StorageBus bus,
13910  [retval] out unsigned long maxDevicesPerPort
13911  );
13912 
13921  in StorageBus bus,
13922  [retval] out unsigned long minPortCount
13923  );
13924 
13933  in StorageBus bus,
13934  [retval] out unsigned long maxPortCount
13935  );
13936 
13950  in ChipsetType chipset,
13951  in StorageBus bus,
13952  [retval] out unsigned long maxInstances
13953  );
13954 
13965  in StorageBus bus,
13966  [retval] out DeviceType[] deviceTypes
13967  );
13968 
13978  in StorageControllerType controllerType,
13979  [retval] out boolean enabled
13980  );
13981 
13991  in StorageControllerType controllerType,
13992  [retval] out boolean hotplugCapable
13993  );
13994 
14008  in ChipsetType chipset,
14009  in USBControllerType type,
14010  [retval] out unsigned long maxInstances
14011  );
14012 
14013 }; /* interface ISystemProperties */
14014 
14020 interface IGuestOSType : $unknown
14021 {
14025  readonly attribute wstring familyId;
14026 
14030  readonly attribute wstring familyDescription;
14031 
14035  readonly attribute wstring id;
14036 
14040  readonly attribute wstring description;
14041 
14045  readonly attribute boolean is64Bit;
14046 
14050  readonly attribute boolean recommendedIOAPIC;
14051 
14055  readonly attribute boolean recommendedVirtEx;
14056 
14060  readonly attribute unsigned long recommendedRAM;
14061 
14065  readonly attribute unsigned long recommendedVRAM;
14066 
14070  readonly attribute boolean recommended2DVideoAcceleration;
14071 
14075  readonly attribute boolean recommended3DAcceleration;
14076 
14080  readonly attribute long long recommendedHDD;
14081 
14085  readonly attribute NetworkAdapterType adapterType;
14086 
14090  readonly attribute boolean recommendedPAE;
14091 
14096 
14101 
14106 
14111 
14115  readonly attribute FirmwareType recommendedFirmware;
14116 
14120  readonly attribute boolean recommendedUSBHID;
14121 
14125  readonly attribute boolean recommendedHPET;
14126 
14130  readonly attribute boolean recommendedUSBTablet;
14131 
14135  readonly attribute boolean recommendedRTCUseUTC;
14136 
14140  readonly attribute ChipsetType recommendedChipset;
14141 
14146 
14151 
14155  readonly attribute boolean recommendedFloppy;
14156 
14160  readonly attribute boolean recommendedUSB;
14161 
14165  readonly attribute boolean recommendedTFReset;
14166 
14167 }; /* interface IGuestOSType */
14168 
14176 interface IAdditionsFacility : $unknown
14177 {
14181  readonly attribute AdditionsFacilityClass classType;
14182 
14189  readonly attribute long long lastUpdated;
14190 
14194  readonly attribute wstring name;
14195 
14199  readonly attribute AdditionsFacilityStatus status;
14200 
14204  readonly attribute AdditionsFacilityType type;
14205 
14206 }; /* interface IAdditionsFacility */
14207 
14213 interface IDnDBase : $unknown
14214 {
14218  readonly attribute wstring[] formats;
14219 
14224  readonly attribute unsigned long protocolVersion;
14225 
14235  void isFormatSupported (
14236  in wstring format,
14237  [retval] out boolean supported
14238  );
14239 
14247  void addFormats (
14248  in wstring[] formats
14249  );
14250 
14258  void removeFormats (
14259  in wstring[] formats
14260  );
14261 
14262 }; /* interface IDnDBase */
14263 
14270 {
14293  void dragIsPending (
14294  in unsigned long screenId,
14295  out wstring[] formats,
14296  out DnDAction[] allowedActions,
14297  [retval] out DnDAction defaultAction
14298  );
14299 
14320  void drop (
14321  in wstring format,
14322  in DnDAction action,
14323  [retval] out IProgress progress
14324  );
14325 
14341  void receiveData (
14342  [retval] out octet[] data
14343  );
14344 
14345 }; /* interface IDnDSource */
14346 
14356 {
14357  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
14358 
14359 }; /* interface IGuestDnDSource */
14360 
14367 {
14395  void enter (
14396  in unsigned long screenId,
14397  in unsigned long y,
14398  in unsigned long x,
14399  in DnDAction defaultAction,
14400  in DnDAction[] allowedActions,
14401  in wstring[] formats,
14402  [retval] out DnDAction resultAction
14403  );
14404 
14432  void move (
14433  in unsigned long screenId,
14434  in unsigned long x,
14435  in unsigned long y,
14436  in DnDAction defaultAction,
14437  in DnDAction[] allowedActions,
14438  in wstring[] formats,
14439  [retval] out DnDAction resultAction
14440  );
14441 
14457  void leave (
14458  in unsigned long screenId
14459  );
14460 
14490  void drop (
14491  in unsigned long screenId,
14492  in unsigned long x,
14493  in unsigned long y,
14494  in DnDAction defaultAction,
14495  in DnDAction[] allowedActions,
14496  in wstring[] formats,
14497  out wstring format,
14498  [retval] out DnDAction resultAction
14499  );
14500 
14522  void sendData (
14523  in unsigned long screenId,
14524  in wstring format,
14525  in octet[] data,
14526  [retval] out IProgress progress
14527  );
14528 
14545  void cancel (
14546  [retval] out boolean veto
14547  );
14548 
14549 }; /* interface IDnDTarget */
14550 
14560 {
14561  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
14562 
14563 }; /* interface IGuestDnDTarget */
14564 
14611 interface IGuestSession : $unknown
14612 {
14618  readonly attribute wstring user;
14619 
14625  readonly attribute wstring domain;
14626 
14630  readonly attribute wstring name;
14631 
14635  readonly attribute unsigned long id;
14636 
14649  attribute unsigned long timeout;
14650 
14655  readonly attribute unsigned long protocolVersion;
14656 
14660  readonly attribute GuestSessionStatus status;
14661 
14673  attribute wstring[] environmentChanges;
14674 
14689  readonly attribute wstring[] environmentBase;
14690 
14696  readonly attribute IGuestProcess[] processes;
14697 
14704  readonly attribute PathStyle pathStyle;
14705 
14718  attribute wstring currentDirectory;
14719 
14725  readonly attribute IGuestDirectory[] directories;
14726 
14732  readonly attribute IGuestFile[] files;
14733 
14739  readonly attribute IEventSource eventSource;
14740 
14749  void close();
14750 
14774  void directoryCopy (
14775  in wstring source,
14776  in wstring destination,
14777  in DirectoryCopyFlags[] flags,
14778  [retval] out IProgress progress
14779  );
14780 
14805  void directoryCopyFromGuest (
14806  in wstring source,
14807  in wstring destination,
14808  in DirectoryCopyFlags[] flags,
14809  [retval] out IProgress progress
14810  );
14811 
14836  void directoryCopyToGuest (
14837  in wstring source,
14838  in wstring destination,
14839  in DirectoryCopyFlags[] flags,
14840  [retval] out IProgress progress
14841  );
14842 
14867  void directoryCreate (
14868  in wstring path,
14869  in unsigned long mode,
14870  in DirectoryCreateFlag[] flags
14871  );
14872 
14934  void directoryCreateTemp (
14935  in wstring templateName,
14936  in unsigned long mode,
14937  in wstring path,
14938  in boolean secure,
14939  [retval] out wstring directory
14940  );
14941 
14966  void directoryExists (
14967  in wstring path,
14968  in boolean followSymlinks,
14969  [retval] out boolean exists
14970  );
14971 
15006  void directoryOpen (
15007  in wstring path,
15008  in wstring filter,
15009  in DirectoryOpenFlag[] flags,
15010  [retval] out IGuestDirectory directory
15011  );
15012 
15024  void directoryRemove (
15025  in wstring path
15026  );
15027 
15054  in wstring path,
15055  in DirectoryRemoveRecFlag[] flags,
15056  [retval] out IProgress progress
15057  );
15058 
15071  void environmentScheduleSet (
15072  in wstring name,
15073  in wstring value
15074  );
15075 
15087  in wstring name
15088  );
15089 
15121  in wstring name,
15122  [retval] out wstring value
15123  );
15124 
15152  in wstring name,
15153  [retval] out boolean exists
15154  );
15155 
15181  void fileCopy (
15182  in wstring source,
15183  in wstring destination,
15184  in FileCopyFlag[] flags,
15185  [retval] out IProgress progress
15186  );
15187 
15214  void fileCopyFromGuest (
15215  in wstring source,
15216  in wstring destination,
15217  in FileCopyFlag[] flags,
15218  [retval] out IProgress progress
15219  );
15220 
15247  void fileCopyToGuest (
15248  in wstring source,
15249  in wstring destination,
15250  in FileCopyFlag[] flags,
15251  [retval] out IProgress progress
15252  );
15253 
15315  void fileCreateTemp (
15316  in wstring templateName,
15317  in unsigned long mode,
15318  in wstring path,
15319  in boolean secure,
15320  [retval] out IGuestFile file
15321  );
15322 
15348  void fileExists (
15349  in wstring path,
15350  in boolean followSymlinks,
15351  [retval] out boolean exists
15352  );
15353 
15393  void fileOpen (
15394  in wstring path,
15395  in FileAccessMode accessMode,
15396  in FileOpenAction openAction,
15397  in unsigned long creationMode,
15398  [retval] out IGuestFile file
15399  );
15400 
15448  void fileOpenEx (
15449  in wstring path,
15450  in FileAccessMode accessMode,
15451  in FileOpenAction openAction,
15452  in FileSharingMode sharingMode,
15453  in unsigned long creationMode,
15454  in FileOpenExFlags[] flags,
15455  [retval] out IGuestFile file
15456  );
15457 
15490  void fileQuerySize (
15491  in wstring path,
15492  in boolean followSymlinks,
15493  [retval] out long long size
15494  );
15495 
15522  void fsObjExists (
15523  in wstring path,
15524  in boolean followSymlinks,
15525  [retval] out boolean exists
15526  );
15527 
15561  void fsObjQueryInfo (
15562  in wstring path,
15563  in boolean followSymlinks,
15564  [retval] out IGuestFsObjInfo info
15565  );
15566 
15601  void fsObjRemove (
15602  in wstring path
15603  );
15604 
15633  void fsObjRename (
15634  in wstring oldPath,
15635  in wstring newPath,
15636  in FsObjRenameFlag[] flags
15637  );
15638 
15667  void fsObjMove (
15668  in wstring source,
15669  in wstring destination,
15670  in FsObjMoveFlags[] flags,
15671  [retval] out IProgress progress
15672  );
15673 
15703  void fsObjSetACL (
15704  in wstring path,
15705  in boolean followSymlinks,
15706  in wstring acl,
15707  in unsigned long mode
15708  );
15709 
15782  void processCreate (
15783  in wstring executable,
15784  in wstring[] arguments,
15785  in wstring[] environmentChanges,
15786  in ProcessCreateFlag[] flags,
15787  in unsigned long timeoutMS,
15788  [retval] out IGuestProcess guestProcess
15789  );
15790 
15862  void processCreateEx (
15863  in wstring executable,
15864  in wstring[] arguments,
15865  in wstring[] environmentChanges,
15866  in ProcessCreateFlag[] flags,
15867  in unsigned long timeoutMS,
15868  in ProcessPriority priority,
15869  in long[] affinity,
15870  [retval] out IGuestProcess guestProcess
15871  );
15872 
15882  void processGet (
15883  in unsigned long pid,
15884  [retval] out IGuestProcess guestProcess
15885  );
15886 
15914  void symlinkCreate (
15915  in wstring symlink,
15916  in wstring target,
15917  in SymlinkType type
15918  );
15919 
15942  void symlinkExists (
15943  in wstring symlink,
15944  [retval] out boolean exists
15945  );
15946 
15966  void symlinkRead (
15967  in wstring symlink,
15968  in SymlinkReadFlag[] flags,
15969  [retval] out wstring target
15970  );
15971 
15992  void waitFor (
15993  in unsigned long waitFor,
15994  in unsigned long timeoutMS,
15995  [retval] out GuestSessionWaitResult reason
15996  );
15997 
16019  void waitForArray (
16021  in unsigned long timeoutMS,
16022  [retval] out GuestSessionWaitResult reason
16023  );
16024 
16025 }; /* interface IGuestSession */
16026 
16034 interface IProcess : $unknown
16035 {
16041  readonly attribute wstring[] arguments;
16042 
16048  readonly attribute wstring[] environment;
16049 
16055  readonly attribute IEventSource eventSource;
16056 
16060  readonly attribute wstring executablePath;
16061 
16068  readonly attribute long exitCode;
16069 
16075  readonly attribute wstring name;
16076 
16082  readonly attribute unsigned long PID;
16083 
16090  readonly attribute ProcessStatus status;
16091 
16112  void waitFor (
16113  in unsigned long waitFor,
16114  in unsigned long timeoutMS,
16115  [retval] out ProcessWaitResult reason
16116  );
16117 
16139  void waitForArray (
16141  in unsigned long timeoutMS,
16142  [retval] out ProcessWaitResult reason
16143  );
16144 
16161  void read (
16162  in unsigned long handle,
16163  in unsigned long toRead,
16164  in unsigned long timeoutMS,
16165  [retval] out octet[] data
16166  );
16167 
16191  void write (
16192  in unsigned long handle,
16193  in unsigned long flags,
16194  in octet[] data,
16195  in unsigned long timeoutMS,
16196  [retval] out unsigned long written
16197  );
16198 
16223  void writeArray (
16224  in unsigned long handle,
16225  in ProcessInputFlag[] flags,
16226  in octet[] data,
16227  in unsigned long timeoutMS,
16228  [retval] out unsigned long written
16229  );
16230 
16240  void terminate();
16241 
16242 }; /* interface IProcess */
16243 
16253 {
16254  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
16255 
16256 }; /* interface IGuestProcess */
16257 
16265 interface IDirectory : $unknown
16266 {
16270  readonly attribute wstring directoryName;
16271 
16275  readonly attribute wstring filter;
16276 
16283  void close();
16284 
16300  void read (
16301  [retval] out IFsObjInfo objInfo
16302  );
16303 
16304 }; /* interface IDirectory */
16305 
16315 {
16316  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
16317 
16318 }; /* interface IGuestDirectory */
16319 
16327 interface IFile : $unknown
16328 {
16334  readonly attribute IEventSource eventSource;
16335 
16341  readonly attribute unsigned long id;
16342 
16348  readonly attribute long long initialSize;
16349 
16364  readonly attribute long long offset;
16365 
16371  readonly attribute FileStatus status;
16372 
16377  readonly attribute wstring fileName;
16378 
16382  readonly attribute unsigned long creationMode;
16383 
16387  readonly attribute FileOpenAction openAction;
16388 
16392  readonly attribute FileAccessMode accessMode;
16393 
16400  void close();
16401 
16418  void queryInfo (
16419  [retval] out IFsObjInfo objInfo
16420  );
16421 
16437  void querySize (
16438  [retval] out long long size
16439  );
16440 
16463  void read (
16464  in unsigned long toRead,
16465  in unsigned long timeoutMS,
16466  [retval] out octet[] data
16467  );
16468 
16493  void readAt (
16494  in long long offset,
16495  in unsigned long toRead,
16496  in unsigned long timeoutMS,
16497  [retval] out octet[] data
16498  );
16499 
16518  void seek (
16519  in long long offset,
16520  in FileSeekOrigin whence,
16521  [retval] out long long newOffset
16522  );
16523 
16544  void setACL (
16545  in wstring acl,
16546  in unsigned long mode
16547  );
16548 
16564  void setSize (
16565  in long long size
16566  );
16567 
16585  void write (
16586  in octet[] data,
16587  in unsigned long timeoutMS,
16588  [retval] out unsigned long written
16589  );
16590 
16618  void writeAt (
16619  in long long offset,
16620  in octet[] data,
16621  in unsigned long timeoutMS,
16622  [retval] out unsigned long written
16623  );
16624 
16625 }; /* interface IFile */
16626 
16635 interface IGuestFile : IFile
16636 {
16637  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
16638 
16639 }; /* interface IGuestFile */
16640 
16649 interface IFsObjInfo : $unknown
16650 {
16656  readonly attribute long long accessTime;
16657 
16663  readonly attribute long long allocatedSize;
16664 
16670  readonly attribute long long birthTime;
16671 
16677  readonly attribute long long changeTime;
16678 
16684  readonly attribute unsigned long deviceNumber;
16685 
16691  readonly attribute wstring fileAttributes;
16692 
16698  readonly attribute unsigned long generationId;
16699 
16705  readonly attribute unsigned long GID;
16706 
16712  readonly attribute wstring groupName;
16713 
16719  readonly attribute unsigned long hardLinks;
16720 
16726  readonly attribute long long modificationTime;
16727 
16733  readonly attribute wstring name;
16734 
16740  readonly attribute long long nodeId;
16741 
16747  readonly attribute unsigned long nodeIdDevice;
16748 
16756  readonly attribute long long objectSize;
16757 
16763  readonly attribute FsObjType type;
16764 
16770  readonly attribute unsigned long UID;
16771 
16777  readonly attribute unsigned long userFlags;
16778 
16784  readonly attribute wstring userName;
16785 
16786 }; /* interface IFsObjInfo */
16787 
16797 {
16798  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
16799 
16800 }; /* interface IGuestFsObjInfo */
16801 
16815 interface IGuest : $unknown
16816 {
16831  readonly attribute wstring OSTypeId;
16832 
16839 
16846  readonly attribute wstring additionsVersion;
16847 
16855  readonly attribute unsigned long additionsRevision;
16856 
16863  readonly attribute IGuestDnDSource dnDSource;
16864 
16872  readonly attribute IGuestDnDTarget dnDTarget;
16873 
16879  readonly attribute IEventSource eventSource;
16880 
16887  readonly attribute IAdditionsFacility[] facilities;
16888 
16892  readonly attribute IGuestSession[] sessions;
16893 
16897  attribute unsigned long memoryBalloonSize;
16898 
16902  attribute unsigned long statisticsUpdateInterval;
16903 
16935  void internalGetStatistics (
16936  out unsigned long cpuUser,
16937  out unsigned long cpuKernel,
16938  out unsigned long cpuIdle,
16939  out unsigned long memTotal,
16940  out unsigned long memFree,
16941  out unsigned long memBalloon,
16942  out unsigned long memShared,
16943  out unsigned long memCache,
16944  out unsigned long pagedTotal,
16945  out unsigned long memAllocTotal,
16946  out unsigned long memFreeTotal,
16947  out unsigned long memBalloonTotal,
16948  out unsigned long memSharedTotal
16949  );
16950 
16962  void getFacilityStatus (
16963  in AdditionsFacilityType facility,
16964  out long long timestamp,
16965  [retval] out AdditionsFacilityStatus status
16966  );
16967 
16985  void getAdditionsStatus (
16986  in AdditionsRunLevelType level,
16987  [retval] out boolean active
16988  );
16989 
17019  void setCredentials (
17020  in wstring userName,
17021  in wstring password,
17022  in wstring domain,
17023  in boolean allowInteractiveLogon
17024  );
17025 
17068  void createSession (
17069  in wstring user,
17070  in wstring password,
17071  in wstring domain,
17072  in wstring sessionName,
17073  [retval] out IGuestSession guestSession
17074  );
17075 
17090  void findSession (
17091  in wstring sessionName,
17092  [retval] out IGuestSession[] sessions
17093  );
17094 
17144  void updateGuestAdditions (
17145  in wstring source,
17146  in wstring[] arguments,
17147  in AdditionsUpdateFlag[] flags,
17148  [retval] out IProgress progress
17149  );
17150 
17151 }; /* interface IGuest */
17152 
17193 interface IProgress : $unknown
17194 {
17198  readonly attribute wstringUUID id;
17199 
17203  readonly attribute wstring description;
17204 
17208  readonly attribute $unknown initiator;
17209 
17213  readonly attribute boolean cancelable;
17214 
17222  readonly attribute unsigned long percent;
17223 
17237  readonly attribute long timeRemaining;
17238 
17242  readonly attribute boolean completed;
17243 
17247  readonly attribute boolean canceled;
17248 
17255  readonly attribute long resultCode;
17256 
17266  readonly attribute IVirtualBoxErrorInfo errorInfo;
17267 
17274  readonly attribute unsigned long operationCount;
17275 
17279  readonly attribute unsigned long operation;
17280 
17286  readonly attribute wstring operationDescription;
17287 
17291  readonly attribute unsigned long operationPercent;
17292 
17296  readonly attribute unsigned long operationWeight;
17297 
17305  attribute unsigned long timeout;
17306 
17311  in unsigned long percent
17312  );
17313 
17317  void setNextOperation (
17318  in wstring nextOperationDescription,
17319  in unsigned long nextOperationsWeight
17320  );
17321 
17348  void waitForCompletion (
17349  in long timeout
17350  );
17351 
17376  in unsigned long operation,
17377  in long timeout
17378  );
17379 
17406  in IProgress pProgressAsync
17407  );
17408 
17425  void cancel();
17426 
17427 }; /* interface IProgress */
17428 
17513 interface ISnapshot : $unknown
17514 {
17518  readonly attribute wstringUUID id;
17519 
17527  attribute wstring name;
17528 
17536  attribute wstring description;
17537 
17543  readonly attribute long long timeStamp;
17544 
17556  readonly attribute boolean online;
17557 
17569  readonly attribute IMachine machine;
17570 
17577  readonly attribute ISnapshot parent;
17578 
17587  readonly attribute ISnapshot[] children;
17588 
17596  void getChildrenCount (
17597  [retval] out unsigned long childrenCount
17598  );
17599 
17600 }; /* interface ISnapshot */
17601 
17790 interface IMediumAttachment : $unknown
17791 {
17796  readonly attribute IMedium medium;
17797 
17803  readonly attribute wstring controller;
17804 
17810  readonly attribute long port;
17811 
17817  readonly attribute long device;
17818 
17822  readonly attribute DeviceType type;
17823 
17827  readonly attribute boolean passthrough;
17828 
17832  readonly attribute boolean temporaryEject;
17833 
17838  readonly attribute boolean isEjected;
17839 
17843  readonly attribute boolean nonRotational;
17844 
17848  readonly attribute boolean discard;
17849 
17853  readonly attribute boolean hotPluggable;
17854 
17858  readonly attribute IBandwidthGroup bandwidthGroup;
17859 
17860 }; /* interface IMediumAttachment */
17861 
18022 interface IMedium : $unknown
18023 {
18037  readonly attribute wstringUUID id;
18038 
18057  attribute wstring description;
18058 
18074  readonly attribute MediumState state;
18075 
18084  readonly attribute MediumVariant[] variant;
18085 
18095  readonly attribute wstring location;
18096 
18116  readonly attribute wstring name;
18117 
18122  readonly attribute DeviceType deviceType;
18123 
18127  readonly attribute boolean hostDrive;
18128 
18141  readonly attribute long long size;
18142 
18157  readonly attribute wstring format;
18158 
18174  readonly attribute IMediumFormat mediumFormat;
18175 
18201  attribute MediumType type;
18202 
18216  readonly attribute MediumType[] allowedTypes;
18217 
18227  readonly attribute IMedium parent;
18228 
18236  readonly attribute IMedium[] children;
18237 
18248  readonly attribute IMedium base;
18249 
18282  readonly attribute boolean readOnly;
18283 
18299  readonly attribute long long logicalSize;
18300 
18328  attribute boolean autoReset;
18329 
18344  readonly attribute wstring lastAccessError;
18345 
18362  readonly attribute wstringUUID[] machineIds;
18363 
18389  void setIds (
18390  in boolean setImageId,
18391  in wstringUUID imageId,
18392  in boolean setParentId,
18393  in wstringUUID parentId
18394  );
18395 
18430  void refreshState (
18431  [retval] out MediumState state
18432  );
18433 
18460  void getSnapshotIds (
18461  in wstringUUID machineId,
18462  [retval] out wstringUUID[] snapshotIds
18463  );
18464 
18527  void lockRead (
18528  [retval] out IToken token
18529  );
18530 
18585  void lockWrite (
18586  [retval] out IToken token
18587  );
18588 
18638  void close();
18639 
18669  void getProperty (
18670  in wstring name,
18671  [retval] out wstring value
18672  );
18673 
18705  void setProperty (
18706  in wstring name,
18707  in wstring value
18708  );
18709 
18744  void getProperties (
18745  in wstring names,
18746  out wstring[] returnNames,
18747  [retval] out wstring[] returnValues
18748  );
18749 
18779  void setProperties (
18780  in wstring[] names,
18781  in wstring[] values
18782  );
18783 
18816  void createBaseStorage (
18817  in long long logicalSize,
18818  in MediumVariant[] variant,
18819  [retval] out IProgress progress
18820  );
18821 
18873  void deleteStorage (
18874  [retval] out IProgress progress
18875  );
18876 
18915  void createDiffStorage (
18916  in IMedium target,
18917  in MediumVariant[] variant,
18918  [retval] out IProgress progress
18919  );
18920 
18998  void mergeTo (
18999  in IMedium target,
19000  [retval] out IProgress progress
19001  );
19002 
19052  void cloneTo (
19053  in IMedium target,
19054  in MediumVariant[] variant,
19055  in IMedium parent,
19056  [retval] out IProgress progress
19057  );
19058 
19105  void cloneToBase (
19106  in IMedium target,
19107  in MediumVariant[] variant,
19108  [retval] out IProgress progress
19109  );
19110 
19152  void setLocation (
19153  in wstring location,
19154  [retval] out IProgress progress
19155  );
19156 
19185  void compact (
19186  [retval] out IProgress progress
19187  );
19188 
19221  void resize (
19222  in long long logicalSize,
19223  [retval] out IProgress progress
19224  );
19225 
19259  void reset (
19260  [retval] out IProgress progress
19261  );
19262 
19304  void changeEncryption (
19305  in wstring currentPassword,
19306  in wstring cipher,
19307  in wstring newPassword,
19308  in wstring newPasswordId,
19309  [retval] out IProgress progress
19310  );
19311 
19329  void getEncryptionSettings (
19330  out wstring cipher,
19331  [retval] out wstring passwordId
19332  );
19333 
19358  in wstring password
19359  );
19360 
19361 }; /* interface IMedium */
19362 
19385 interface IMediumFormat : $unknown
19386 {
19406  readonly attribute wstring id;
19407 
19415  readonly attribute wstring name;
19416 
19426 
19445  void describeFileExtensions (
19446  out wstring[] extensions,
19447  out DeviceType[] types
19448  );
19449 
19477  void describeProperties (
19478  out wstring[] names,
19479  out wstring[] descriptions,
19480  out DataType[] types,
19481  out unsigned long[] flags,
19482  out wstring[] defaults
19483  );
19484 
19485 }; /* interface IMediumFormat */
19486 
19501 interface IToken : $unknown
19502 {
19511  void abandon();
19512 
19519  void dummy();
19520 
19521 }; /* interface IToken */
19522 
19534 interface IKeyboard : $unknown
19535 {
19541  readonly attribute KeyboardLED[] keyboardLEDs;
19542 
19548  readonly attribute IEventSource eventSource;
19549 
19562  void putScancode (
19563  in long scancode
19564  );
19565 
19578  void putScancodes (
19579  in long[] scancodes,
19580  [retval] out unsigned long codesStored
19581  );
19582 
19597  void putCAD();
19598 
19613  void releaseKeys();
19614 
19615 }; /* interface IKeyboard */
19616 
19624 interface IMousePointerShape : $unknown
19625 {
19631  readonly attribute boolean visible;
19632 
19638  readonly attribute boolean alpha;
19639 
19645  readonly attribute unsigned long hotX;
19646 
19652  readonly attribute unsigned long hotY;
19653 
19659  readonly attribute unsigned long width;
19660 
19666  readonly attribute unsigned long height;
19667 
19701  readonly attribute octet[] shape;
19702 
19703 }; /* interface IMousePointerShape */
19704 
19716 interface IMouse : $unknown
19717 {
19732  readonly attribute boolean absoluteSupported;
19733 
19748  readonly attribute boolean relativeSupported;
19749 
19763  readonly attribute boolean multiTouchSupported;
19764 
19779  readonly attribute boolean needsHostCursor;
19780 
19786  readonly attribute IMousePointerShape pointerShape;
19787 
19793  readonly attribute IEventSource eventSource;
19794 
19860  void putMouseEvent (
19861  in long dx,
19862  in long dy,
19863  in long dz,
19864  in long dw,
19865  in long buttonState
19866  );
19867 
19940  void putMouseEventAbsolute (
19941  in long x,
19942  in long y,
19943  in long dz,
19944  in long dw,
19945  in long buttonState
19946  );
19947 
19995  void putEventMultiTouch (
19996  in long count,
19997  in long long[] contacts,
19998  in unsigned long scanTime
19999  );
20000 
20017  in long count,
20018  in wstring contacts,
20019  in unsigned long scanTime
20020  );
20021 
20022 }; /* interface IMouse */
20023 
20024 interface IDisplaySourceBitmap : $unknown
20025 {
20026  readonly attribute unsigned long screenId;
20027 
20036  void queryBitmapInfo (
20037  out octetPtr address,
20038  out unsigned long width,
20039  out unsigned long height,
20040  out unsigned long bitsPerPixel,
20041  out unsigned long bytesPerLine,
20042  out BitmapFormat bitmapFormat
20043  );
20044 
20045 }; /* interface IDisplaySourceBitmap */
20046 
20047 interface IFramebuffer : $unknown
20048 {
20052  readonly attribute unsigned long width;
20053 
20057  readonly attribute unsigned long height;
20058 
20064  readonly attribute unsigned long bitsPerPixel;
20065 
20071  readonly attribute unsigned long bytesPerLine;
20072 
20083  readonly attribute BitmapFormat pixelFormat;
20084 
20094  readonly attribute unsigned long heightReduction;
20095 
20110  readonly attribute IFramebufferOverlay overlay;
20111 
20118  readonly attribute long long winId;
20119 
20129 
20137  void notifyUpdate (
20138  in unsigned long x,
20139  in unsigned long y,
20140  in unsigned long width,
20141  in unsigned long height
20142  );
20143 
20153  void notifyUpdateImage (
20154  in unsigned long x,
20155  in unsigned long y,
20156  in unsigned long width,
20157  in unsigned long height,
20158  in octet[] image
20159  );
20160 
20178  void notifyChange (
20179  in unsigned long screenId,
20180  in unsigned long xOrigin,
20181  in unsigned long yOrigin,
20182  in unsigned long width,
20183  in unsigned long height
20184  );
20185 
20197  void videoModeSupported (
20198  in unsigned long width,
20199  in unsigned long height,
20200  in unsigned long bpp,
20201  [retval] out boolean supported
20202  );
20203 
20240  void getVisibleRegion (
20241  in octetPtr rectangles,
20242  in unsigned long count,
20243  [retval] out unsigned long countCopied
20244  );
20245 
20280  void setVisibleRegion (
20281  in octetPtr rectangles,
20282  in unsigned long count
20283  );
20284 
20305  void processVHWACommand (
20306  in octetPtr command
20307  );
20308 
20318  void notify3DEvent (
20319  in unsigned long type,
20320  in octet[] data
20321  );
20322 
20323 }; /* interface IFramebuffer */
20324 
20340 {
20344  readonly attribute unsigned long x;
20345 
20349  readonly attribute unsigned long y;
20350 
20356  attribute boolean visible;
20357 
20364  attribute unsigned long alpha;
20365 
20371  void move (
20372  in unsigned long x,
20373  in unsigned long y
20374  );
20375 
20376 }; /* interface IFramebufferOverlay */
20377 
20393 interface IDisplay : $unknown
20394 {
20405  void getScreenResolution (
20406  in unsigned long screenId,
20407  out unsigned long width,
20408  out unsigned long height,
20409  out unsigned long bitsPerPixel,
20410  out long xOrigin,
20411  out long yOrigin,
20412  out GuestMonitorStatus guestMonitorStatus
20413  );
20414 
20420  void attachFramebuffer (
20421  in unsigned long screenId,
20422  in IFramebuffer framebuffer,
20423  [retval] out wstringUUID id
20424  );
20425 
20431  void detachFramebuffer (
20432  in unsigned long screenId,
20433  in wstringUUID id
20434  );
20435 
20441  void queryFramebuffer (
20442  in unsigned long screenId,
20443  [retval] out IFramebuffer framebuffer
20444  );
20445 
20508  void setVideoModeHint (
20509  in unsigned long display,
20510  in boolean enabled,
20511  in boolean changeOrigin,
20512  in long originX,
20513  in long originY,
20514  in unsigned long width,
20515  in unsigned long height,
20516  in unsigned long bitsPerPixel
20517  );
20518 
20530  void setSeamlessMode (
20531  in boolean enabled
20532  );
20533 
20555  void takeScreenShot (
20556  in unsigned long screenId,
20557  in octetPtr address,
20558  in unsigned long width,
20559  in unsigned long height,
20560  in BitmapFormat bitmapFormat
20561  );
20562 
20589  void takeScreenShotToArray (
20590  in unsigned long screenId,
20591  in unsigned long width,
20592  in unsigned long height,
20593  in BitmapFormat bitmapFormat,
20594  [retval] out octet[] screenData
20595  );
20596 
20648  void drawToScreen (
20649  in unsigned long screenId,
20650  in octetPtr address,
20651  in unsigned long x,
20652  in unsigned long y,
20653  in unsigned long width,
20654  in unsigned long height
20655  );
20656 
20671  void invalidateAndUpdate();
20672 
20683  in unsigned long screenId
20684  );
20685 
20698  void completeVHWACommand (
20699  in octetPtr command
20700  );
20701 
20735  void viewportChanged (
20736  in unsigned long screenId,
20737  in unsigned long x,
20738  in unsigned long y,
20739  in unsigned long width,
20740  in unsigned long height
20741  );
20742 
20748  void querySourceBitmap (
20749  in unsigned long screenId,
20750  out IDisplaySourceBitmap displaySourceBitmap
20751  );
20752 
20759  in unsigned long screenId,
20760  in unsigned long u32ScaleFactorWMultiplied,
20761  in unsigned long u32ScaleFactorHMultiplied
20762  );
20763 
20770  in boolean fUnscaledHiDPI
20771  );
20772 
20773 }; /* interface IDisplay */
20774 
20790 interface INetworkAdapter : $unknown
20791 {
20800 
20808  readonly attribute unsigned long slot;
20809 
20818  attribute boolean enabled;
20819 
20826  attribute wstring MACAddress;
20827 
20834 
20840  attribute wstring bridgedInterface;
20841 
20847  attribute wstring hostOnlyInterface;
20848 
20854  attribute wstring internalNetwork;
20855 
20861  attribute wstring NATNetwork;
20862 
20868  attribute wstring genericDriver;
20869 
20876  attribute boolean cableConnected;
20877 
20883  attribute unsigned long lineSpeed;
20884 
20892 
20899  attribute boolean traceEnabled;
20900 
20907  attribute wstring traceFile;
20908 
20916  readonly attribute INATEngine NATEngine;
20917 
20924  attribute unsigned long bootPriority;
20925 
20930 
20949  void getProperty (
20950  in wstring key,
20951  [retval] out wstring value
20952  );
20953 
20972  void setProperty (
20973  in wstring key,
20974  in wstring value
20975  );
20976 
21004  void getProperties (
21005  in wstring names,
21006  out wstring[] returnNames,
21007  [retval] out wstring[] returnValues
21008  );
21009 
21010 }; /* interface INetworkAdapter */
21011 
21040 interface ISerialPort : $unknown
21041 {
21049  readonly attribute unsigned long slot;
21050 
21057  attribute boolean enabled;
21058 
21062  attribute unsigned long IOBase;
21063 
21067  attribute unsigned long IRQ;
21068 
21079  attribute PortMode hostMode;
21080 
21088  attribute boolean server;
21089 
21101  attribute wstring path;
21102 
21103 }; /* interface ISerialPort */
21104 
21124 interface IParallelPort : $unknown
21125 {
21133  readonly attribute unsigned long slot;
21134 
21141  attribute boolean enabled;
21142 
21146  attribute unsigned long IOBase;
21147 
21151  attribute unsigned long IRQ;
21152 
21160  attribute wstring path;
21161 
21162 }; /* interface IParallelPort */
21163 
21164 interface IMachineDebugger : $unknown
21165 {
21169  attribute boolean singleStep;
21170 
21174  attribute boolean recompileUser;
21175 
21179  attribute boolean recompileSupervisor;
21180 
21188  attribute boolean executeAllInIEM;
21189 
21193  attribute boolean PATMEnabled;
21194 
21198  attribute boolean CSAMEnabled;
21199 
21203  attribute boolean logEnabled;
21204 
21208  readonly attribute wstring logDbgFlags;
21209 
21213  readonly attribute wstring logDbgGroups;
21214 
21218  readonly attribute wstring logDbgDestinations;
21219 
21223  readonly attribute wstring logRelFlags;
21224 
21228  readonly attribute wstring logRelGroups;
21229 
21233  readonly attribute wstring logRelDestinations;
21234 
21241  readonly attribute boolean HWVirtExEnabled;
21242 
21249  readonly attribute boolean HWVirtExNestedPagingEnabled;
21250 
21257  readonly attribute boolean HWVirtExVPIDEnabled;
21258 
21265  readonly attribute boolean HWVirtExUXEnabled;
21266 
21275  readonly attribute wstring OSName;
21276 
21285  readonly attribute wstring OSVersion;
21286 
21293  readonly attribute boolean PAEEnabled;
21294 
21301  attribute unsigned long virtualTimeRate;
21302 
21310  readonly attribute long long VM;
21311 
21327  void dumpGuestCore (
21328  in wstring filename,
21329  in wstring compression
21330  );
21331 
21348  void dumpHostProcessCore (
21349  in wstring filename,
21350  in wstring compression
21351  );
21352 
21373  void info (
21374  in wstring name,
21375  in wstring args,
21376  [retval] out wstring info
21377  );
21378 
21384  void injectNMI();
21385 
21396  void modifyLogGroups (
21397  in wstring settings
21398  );
21399 
21410  void modifyLogFlags (
21411  in wstring settings
21412  );
21413 
21424  void modifyLogDestinations (
21425  in wstring settings
21426  );
21427 
21442  void readPhysicalMemory (
21443  in long long address,
21444  in unsigned long size,
21445  [retval] out octet[] bytes
21446  );
21447 
21462  void writePhysicalMemory (
21463  in long long address,
21464  in unsigned long size,
21465  in octet[] bytes
21466  );
21467 
21484  void readVirtualMemory (
21485  in unsigned long cpuId,
21486  in long long address,
21487  in unsigned long size,
21488  [retval] out octet[] bytes
21489  );
21490 
21507  void writeVirtualMemory (
21508  in unsigned long cpuId,
21509  in long long address,
21510  in unsigned long size,
21511  in octet[] bytes
21512  );
21513 
21521  void loadPlugIn (
21522  in wstring name,
21523  [retval] out wstring plugInName
21524  );
21525 
21531  void unloadPlugIn (
21532  in wstring name
21533  );
21534 
21547  void detectOS (
21548  [retval] out wstring os
21549  );
21550 
21564  void queryOSKernelLog (
21565  in unsigned long maxMessages,
21566  [retval] out wstring dmesg
21567  );
21568 
21583  void getRegister (
21584  in unsigned long cpuId,
21585  in wstring name,
21586  [retval] out wstring value
21587  );
21588 
21603  void getRegisters (
21604  in unsigned long cpuId,
21605  out wstring[] names,
21606  out wstring[] values
21607  );
21608 
21627  void setRegister (
21628  in unsigned long cpuId,
21629  in wstring name,
21630  in wstring value
21631  );
21632 
21651  void setRegisters (
21652  in unsigned long cpuId,
21653  in wstring[] names,
21654  in wstring[] values
21655  );
21656 
21669  void dumpGuestStack (
21670  in unsigned long cpuId,
21671  [retval] out wstring stack
21672  );
21673 
21681  void resetStats (
21682  in wstring pattern
21683  );
21684 
21692  void dumpStats (
21693  in wstring pattern
21694  );
21695 
21707  void getStats (
21708  in wstring pattern,
21709  in boolean withDescriptions,
21710  [retval] out wstring stats
21711  );
21712 
21713 }; /* interface IMachineDebugger */
21714 
21715 interface IUSBDeviceFilters : $unknown
21716 {
21742  readonly attribute IUSBDeviceFilter[] deviceFilters;
21743 
21771  void createDeviceFilter (
21772  in wstring name,
21773  [retval] out IUSBDeviceFilter filter
21774  );
21775 
21820  void insertDeviceFilter (
21821  in unsigned long position,
21822  in IUSBDeviceFilter filter
21823  );
21824 
21857  void removeDeviceFilter (
21858  in unsigned long position,
21859  [retval] out IUSBDeviceFilter filter
21860  );
21861 
21862 }; /* interface IUSBDeviceFilters */
21863 
21864 interface IUSBController : $unknown
21865 {
21871  attribute wstring name;
21872 
21879 
21887  readonly attribute unsigned short USBStandard;
21888 
21889 }; /* interface IUSBController */
21890 
21903 interface IUSBDevice : $unknown
21904 {
21911  readonly attribute wstringUUID id;
21912 
21916  readonly attribute unsigned short vendorId;
21917 
21921  readonly attribute unsigned short productId;
21922 
21930  readonly attribute unsigned short revision;
21931 
21935  readonly attribute wstring manufacturer;
21936 
21940  readonly attribute wstring product;
21941 
21945  readonly attribute wstring serialNumber;
21946 
21950  readonly attribute wstring address;
21951 
21958  readonly attribute unsigned short port;
21959 
21965  readonly attribute unsigned short version;
21966 
21974  readonly attribute unsigned short portVersion;
21975 
21981  readonly attribute USBConnectionSpeed speed;
21982 
21989  readonly attribute boolean remote;
21990 
22002  readonly attribute wstring[] deviceInfo;
22003 
22004 }; /* interface IUSBDevice */
22005 
22081 interface IUSBDeviceFilter : $unknown
22082 {
22090  attribute wstring name;
22091 
22095  attribute boolean active;
22096 
22104  attribute wstring vendorId;
22105 
22113  attribute wstring productId;
22114 
22128  attribute wstring revision;
22129 
22134  attribute wstring manufacturer;
22135 
22140  attribute wstring product;
22141 
22146  attribute wstring serialNumber;
22147 
22152  attribute wstring port;
22153 
22163  attribute wstring remote;
22164 
22174  attribute unsigned long maskedInterfaces;
22175 
22176 }; /* interface IUSBDeviceFilter */
22177 
22195 {
22201  readonly attribute USBDeviceState state;
22202 
22203 }; /* interface IHostUSBDevice */
22204 
22228 {
22236 
22237 }; /* interface IHostUSBDeviceFilter */
22238 
22247 interface IAudioAdapter : $unknown
22248 {
22257  attribute boolean enabled;
22258 
22265  attribute boolean enabledIn;
22266 
22273  attribute boolean enabledOut;
22274 
22281 
22291 
22299 
22305  readonly attribute wstring[] propertiesList;
22306 
22320  void setProperty (
22321  in wstring key,
22322  in wstring value
22323  );
22324 
22338  void getProperty (
22339  in wstring key,
22340  [retval] out wstring value
22341  );
22342 
22343 }; /* interface IAudioAdapter */
22344 
22345 interface IVRDEServer : $unknown
22346 {
22350  attribute boolean enabled;
22351 
22355  attribute AuthType authType;
22356 
22360  attribute unsigned long authTimeout;
22361 
22368  attribute boolean allowMultiConnection;
22369 
22377  attribute boolean reuseSingleConnection;
22378 
22385  attribute wstring VRDEExtPack;
22386 
22393  attribute wstring authLibrary;
22394 
22400  readonly attribute wstring[] VRDEProperties;
22401 
22415  void setVRDEProperty (
22416  in wstring key,
22417  in wstring value
22418  );
22419 
22433  void getVRDEProperty (
22434  in wstring key,
22435  [retval] out wstring value
22436  );
22437 
22438 }; /* interface IVRDEServer */
22439 
22499 interface ISharedFolder : $unknown
22500 {
22504  readonly attribute wstring name;
22505 
22509  readonly attribute wstring hostPath;
22510 
22520  readonly attribute boolean accessible;
22521 
22528  readonly attribute boolean writable;
22529 
22535  readonly attribute boolean autoMount;
22536 
22549  readonly attribute wstring lastAccessError;
22550 
22551 }; /* interface ISharedFolder */
22552 
22553 interface IInternalSessionControl : $unknown
22554 {
22559  readonly attribute unsigned long PID;
22560 
22582  readonly attribute IConsole remoteConsole;
22583 
22590  readonly attribute MachineState nominalState;
22591 
22606  void assignRemoteMachine (
22607  in IMachine machine,
22608  in IConsole console
22609  );
22610 
22634  void updateMachineState (
22635  in MachineState machineState
22636  );
22637 
22653  void uninitialize();
22654 
22677  void onNetworkAdapterChange (
22678  in INetworkAdapter networkAdapter,
22679  in boolean changeAdapter
22680  );
22681 
22704  void onSerialPortChange (
22705  in ISerialPort serialPort
22706  );
22707 
22730  void onParallelPortChange (
22731  in IParallelPort parallelPort
22732  );
22733 
22757 
22784  void onMediumChange (
22785  in IMediumAttachment mediumAttachment,
22786  in boolean force
22787  );
22788 
22818  void onStorageDeviceChange (
22819  in IMediumAttachment mediumAttachment,
22820  in boolean remove,
22821  in boolean silent
22822  );
22823 
22831  void onClipboardModeChange (
22832  in ClipboardMode clipboardMode
22833  );
22834 
22842  void onDnDModeChange (
22843  in DnDMode dndMode
22844  );
22845 
22855  void onCPUChange (
22856  in unsigned long cpu,
22857  in boolean add
22858  );
22859 
22868  in unsigned long executionCap
22869  );
22870 
22895  void onVRDEServerChange (
22896  in boolean restart
22897  );
22898 
22904  void onVideoCaptureChange();
22905 
22928  void onUSBControllerChange();
22929 
22958  void onSharedFolderChange (
22959  in boolean global
22960  );
22961 
22987  void onUSBDeviceAttach (
22988  in IUSBDevice device,
22989  in IVirtualBoxErrorInfo error,
22990  in unsigned long maskedInterfaces,
22991  in wstring captureFilename
22992  );
22993 
23019  void onUSBDeviceDetach (
23020  in wstringUUID id,
23021  in IVirtualBoxErrorInfo error
23022  );
23023 
23041  void onShowWindow (
23042  in boolean check,
23043  out boolean canShow,
23044  out long long winId
23045  );
23046 
23054  void onBandwidthGroupChange (
23055  in IBandwidthGroup bandwidthGroup
23056  );
23057 
23083  void accessGuestProperty (
23084  in wstring name,
23085  in wstring value,
23086  in wstring flags,
23087  in unsigned long accessMode,
23088  out wstring retValue,
23089  out long long retTimestamp,
23090  out wstring retFlags
23091  );
23092 
23141  in wstring patterns,
23142  out wstring[] keys,
23143  out wstring[] values,
23144  out long long[] timestamps,
23145  out wstring[] flags
23146  );
23147 
23182  void onlineMergeMedium (
23183  in IMediumAttachment mediumAttachment,
23184  in unsigned long sourceIdx,
23185  in unsigned long targetIdx,
23186  in IProgress progress
23187  );
23188 
23215  in IMediumAttachment[] attachments
23216  );
23217 
23241  void enableVMMStatistics (
23242  in boolean enable
23243  );
23244 
23272  void pauseWithReason (
23273  in Reason reason
23274  );
23275 
23303  void resumeWithReason (
23304  in Reason reason
23305  );
23306 
23348  void saveStateWithReason (
23349  in Reason reason,
23350  in IProgress progress,
23351  in wstring stateFilePath,
23352  in boolean pauseVM,
23353  [retval] out boolean leftPaused
23354  );
23355 
23364 
23388  void assignMachine (
23389  in IMachine machine,
23390  in LockType lockType,
23391  in wstring tokenId
23392  );
23393 
23417  void assignMachine (
23418  in IMachine machine,
23419  in LockType lockType,
23420  in IToken token
23421  );
23422 
23423 }; /* interface IInternalSessionControl */
23424 
23485 interface ISession : $unknown
23486 {
23490  readonly attribute SessionState state;
23491 
23499  readonly attribute SessionType type;
23500 
23511  attribute wstring name;
23512 
23516  readonly attribute IMachine machine;
23517 
23522  readonly attribute IConsole console;
23523 
23555  void unlockMachine();
23556 
23557 }; /* interface ISession */
23558 
23581 interface IStorageController : $unknown
23582 {
23591  attribute wstring name;
23592 
23598  readonly attribute unsigned long maxDevicesPerPortCount;
23599 
23605  readonly attribute unsigned long minPortCount;
23606 
23612  readonly attribute unsigned long maxPortCount;
23613 
23619  attribute unsigned long instance;
23620 
23629  attribute unsigned long portCount;
23630 
23636  readonly attribute StorageBus bus;
23637 
23651 
23666  attribute boolean useHostIOCache;
23667 
23673  readonly attribute boolean bootable;
23674 
23675 }; /* interface IStorageController */
23676 
23700 interface IManagedObjectRef : $unknown
23701 {
23708  void getInterfaceName (
23709  [retval] out wstring return
23710  );
23711 
23719  void release();
23720 
23721 }; /* interface IManagedObjectRef */
23722 
23731 interface IWebsessionManager : $unknown
23732 {
23741  void logon (
23742  in wstring username,
23743  in wstring password,
23744  [retval] out IVirtualBox return
23745  );
23746 
23756  void getSessionObject (
23757  in IVirtualBox refIVirtualBox,
23758  [retval] out ISession return
23759  );
23760 
23769  void logoff (
23770  in IVirtualBox refIVirtualBox
23771  );
23772 
23773 }; /* interface IWebsessionManager */
23774 
23783 interface IPerformanceMetric : $unknown
23784 {
23790  readonly attribute wstring metricName;
23791 
23797  readonly attribute $unknown object;
23798 
23804  readonly attribute wstring description;
23805 
23811  readonly attribute unsigned long period;
23812 
23822  readonly attribute unsigned long count;
23823 
23829  readonly attribute wstring unit;
23830 
23836  readonly attribute long minimumValue;
23837 
23843  readonly attribute long maximumValue;
23844 
23845 }; /* interface IPerformanceMetric */
23846 
23957 interface IPerformanceCollector : $unknown
23958 {
23969  readonly attribute wstring[] metricNames;
23970 
23994  void getMetrics (
23995  in wstring[] metricNames,
23996  in $unknown[] objects,
23997  [retval] out IPerformanceMetric[] metrics
23998  );
23999 
24038  void setupMetrics (
24039  in wstring[] metricNames,
24040  in $unknown[] objects,
24041  in unsigned long period,
24042  in unsigned long count,
24043  [retval] out IPerformanceMetric[] affectedMetrics
24044  );
24045 
24074  void enableMetrics (
24075  in wstring[] metricNames,
24076  in $unknown[] objects,
24077  [retval] out IPerformanceMetric[] affectedMetrics
24078  );
24079 
24108  void disableMetrics (
24109  in wstring[] metricNames,
24110  in $unknown[] objects,
24111  [retval] out IPerformanceMetric[] affectedMetrics
24112  );
24113 
24203  void queryMetricsData (
24204  in wstring[] metricNames,
24205  in $unknown[] objects,
24206  out wstring[] returnMetricNames,
24207  out $unknown[] returnObjects,
24208  out wstring[] returnUnits,
24209  out unsigned long[] returnScales,
24210  out unsigned long[] returnSequenceNumbers,
24211  out unsigned long[] returnDataIndices,
24212  out unsigned long[] returnDataLengths,
24213  [retval] out long[] returnData
24214  );
24215 
24216 }; /* interface IPerformanceCollector */
24217 
24225 interface INATEngine : $unknown
24226 {
24231  attribute wstring network;
24232 
24239  attribute wstring hostIP;
24240 
24245  attribute wstring TFTPPrefix;
24246 
24251  attribute wstring TFTPBootFile;
24252 
24260  attribute wstring TFTPNextServer;
24261 
24265  attribute unsigned long aliasMode;
24266 
24270  attribute boolean DNSPassDomain;
24271 
24276  attribute boolean DNSProxy;
24277 
24282  attribute boolean DNSUseHostResolver;
24283 
24288  readonly attribute wstring[] redirects;
24289 
24305  void setNetworkSettings (
24306  in unsigned long mtu,
24307  in unsigned long sockSnd,
24308  in unsigned long sockRcv,
24309  in unsigned long TcpWndSnd,
24310  in unsigned long TcpWndRcv
24311  );
24312 
24317  void getNetworkSettings (
24318  out unsigned long mtu,
24319  out unsigned long sockSnd,
24320  out unsigned long sockRcv,
24321  out unsigned long TcpWndSnd,
24322  out unsigned long TcpWndRcv
24323  );
24324 
24344  void addRedirect (
24345  in wstring name,
24346  in NATProtocol proto,
24347  in wstring hostIP,
24348  in unsigned short hostPort,
24349  in wstring guestIP,
24350  in unsigned short guestPort
24351  );
24352 
24358  void removeRedirect (
24359  in wstring name
24360  );
24361 
24362 }; /* interface INATEngine */
24363 
24372 interface IExtPackPlugIn : $unknown
24373 {
24377  readonly attribute wstring name;
24378 
24382  readonly attribute wstring description;
24383 
24389  readonly attribute wstring frontend;
24390 
24394  readonly attribute wstring modulePath;
24395 
24396 }; /* interface IExtPackPlugIn */
24397 
24406 interface IExtPackBase : $unknown
24407 {
24411  readonly attribute wstring name;
24412 
24416  readonly attribute wstring description;
24417 
24429  readonly attribute wstring version;
24430 
24434  readonly attribute unsigned long revision;
24435 
24445  readonly attribute wstring edition;
24446 
24450  readonly attribute wstring VRDEModule;
24451 
24455  readonly attribute IExtPackPlugIn[] plugIns;
24456 
24466  readonly attribute boolean usable;
24467 
24474  readonly attribute wstring whyUnusable;
24475 
24479  readonly attribute boolean showLicense;
24480 
24489  readonly attribute wstring license;
24490 
24514  void queryLicense (
24515  in wstring preferredLocale,
24516  in wstring preferredLanguage,
24517  in wstring format,
24518  [retval] out wstring licenseText
24519  );
24520 
24521 }; /* interface IExtPackBase */
24522 
24532 {
24544  void queryObject (
24545  in wstring objUuid,
24546  [retval] out $unknown returnInterface
24547  );
24548 
24549 }; /* interface IExtPack */
24550 
24561 {
24567  readonly attribute wstring filePath;
24568 
24587  void install (
24588  in boolean replace,
24589  in wstring displayInfo,
24590  [retval] out IProgress progess
24591  );
24592 
24593 }; /* interface IExtPackFile */
24594 
24604 interface IExtPackManager : $unknown
24605 {
24611  readonly attribute IExtPack[] installedExtPacks;
24612 
24630  void find (
24631  in wstring name,
24632  [retval] out IExtPack returnData
24633  );
24634 
24646  void openExtPackFile (
24647  in wstring path,
24648  [retval] out IExtPackFile file
24649  );
24650 
24669  void uninstall (
24670  in wstring name,
24671  in boolean forcedRemoval,
24672  in wstring displayInfo,
24673  [retval] out IProgress progess
24674  );
24675 
24679  void cleanup();
24680 
24694  in wstring frontendName,
24695  [retval] out wstring[] plugInModules
24696  );
24697 
24705  void isExtPackUsable (
24706  in wstring name,
24707  [retval] out boolean usable
24708  );
24709 
24710 }; /* interface IExtPackManager */
24711 
24717 interface IBandwidthGroup : $unknown
24718 {
24722  readonly attribute wstring name;
24723 
24727  readonly attribute BandwidthGroupType type;
24728 
24732  readonly attribute unsigned long reference;
24733 
24738  attribute long long maxBytesPerSec;
24739 
24740 }; /* interface IBandwidthGroup */
24741 
24750 interface IBandwidthControl : $unknown
24751 {
24757  readonly attribute unsigned long numGroups;
24758 
24771  void createBandwidthGroup (
24772  in wstring name,
24773  in BandwidthGroupType type,
24774  in long long maxBytesPerSec
24775  );
24776 
24784  void deleteBandwidthGroup (
24785  in wstring name
24786  );
24787 
24797  void getBandwidthGroup (
24798  in wstring name,
24799  [retval] out IBandwidthGroup bandwidthGroup
24800  );
24801 
24809  void getAllBandwidthGroups (
24810  [retval] out IBandwidthGroup[] bandwidthGroups
24811  );
24812 
24813 }; /* interface IBandwidthControl */
24814 
24827 interface IVirtualBoxClient : $unknown
24828 {
24834  readonly attribute IVirtualBox virtualBox;
24835 
24841  readonly attribute ISession session;
24842 
24848  readonly attribute IEventSource eventSource;
24849 
24860  void checkMachineError (
24861  in IMachine machine
24862  );
24863 
24864 }; /* interface IVirtualBoxClient */
24865 
24879 interface IEventSource : $unknown
24880 {
24886  void createListener (
24887  [retval] out IEventListener listener
24888  );
24889 
24905  void createAggregator (
24906  in IEventSource[] subordinates,
24907  [retval] out IEventSource result
24908  );
24909 
24942  void registerListener (
24943  in IEventListener listener,
24944  in VBoxEventType[] interesting,
24945  in boolean active
24946  );
24947 
24956  void unregisterListener (
24957  in IEventListener listener
24958  );
24959 
24974  void fireEvent (
24975  in IEvent event,
24976  in long timeout,
24977  [retval] out boolean result
24978  );
24979 
25004  void getEvent (
25005  in IEventListener listener,
25006  in long timeout,
25007  [retval] out IEvent event
25008  );
25009 
25021  void eventProcessed (
25022  in IEventListener listener,
25023  in IEvent event
25024  );
25025 
25026 }; /* interface IEventSource */
25027 
25037 interface IEventListener : $unknown
25038 {
25051  void handleEvent (
25052  in IEvent event
25053  );
25054 
25055 }; /* interface IEventListener */
25056 
25134 interface IEvent : $unknown
25135 {
25141  readonly attribute VBoxEventType type;
25142 
25148  readonly attribute IEventSource source;
25149 
25160  readonly attribute boolean waitable;
25161 
25168  void setProcessed();
25169 
25183  void waitProcessed (
25184  in long timeout,
25185  [retval] out boolean result
25186  );
25187 
25188 }; /* interface IEvent */
25189 
25196 {
25200  readonly attribute unsigned long generation;
25201 
25208  void reuse();
25209 
25210 }; /* interface IReusableEvent */
25211 
25218 {
25222  readonly attribute wstringUUID machineId;
25223 
25224 }; /* interface IMachineEvent */
25225 
25232 {
25236  readonly attribute MachineState state;
25237 
25238 }; /* interface IMachineStateChangedEvent */
25239 
25248 {
25255  readonly attribute boolean temporary;
25256 
25257 }; /* interface IMachineDataChangedEvent */
25258 
25270 {
25274  readonly attribute wstringUUID mediumId;
25275 
25279  readonly attribute DeviceType mediumType;
25280 
25287  readonly attribute boolean registered;
25288 
25289 }; /* interface IMediumRegisteredEvent */
25290 
25302 {
25306  readonly attribute IMedium medium;
25307 
25308 }; /* interface IMediumConfigChangedEvent */
25309 
25319 {
25326  readonly attribute boolean registered;
25327 
25328 }; /* interface IMachineRegisteredEvent */
25329 
25340 {
25346  readonly attribute SessionState state;
25347 
25348 }; /* interface ISessionStateChangedEvent */
25349 
25358 {
25364  readonly attribute wstring name;
25365 
25371  readonly attribute wstring value;
25372 
25378  readonly attribute wstring flags;
25379 
25380 }; /* interface IGuestPropertyChangedEvent */
25381 
25388 {
25392  readonly attribute wstringUUID snapshotId;
25393 
25394 }; /* interface ISnapshotEvent */
25395 
25406 {
25407  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25408 
25409 }; /* interface ISnapshotTakenEvent */
25410 
25428 {
25429  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25430 
25431 }; /* interface ISnapshotDeletedEvent */
25432 
25443 {
25444  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25445 
25446 }; /* interface ISnapshotRestoredEvent */
25447 
25458 {
25459  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25460 
25461 }; /* interface ISnapshotChangedEvent */
25462 
25472 {
25478  readonly attribute boolean visible;
25479 
25485  readonly attribute boolean alpha;
25486 
25492  readonly attribute unsigned long xhot;
25493 
25499  readonly attribute unsigned long yhot;
25500 
25506  readonly attribute unsigned long width;
25507 
25513  readonly attribute unsigned long height;
25514 
25547  readonly attribute octet[] shape;
25548 
25549 }; /* interface IMousePointerShapeChangedEvent */
25550 
25560 {
25566  readonly attribute boolean supportsAbsolute;
25567 
25573  readonly attribute boolean supportsRelative;
25574 
25580  readonly attribute boolean supportsMultiTouch;
25581 
25587  readonly attribute boolean needsHostCursor;
25588 
25589 }; /* interface IMouseCapabilityChangedEvent */
25590 
25600 {
25606  readonly attribute boolean numLock;
25607 
25613  readonly attribute boolean capsLock;
25614 
25620  readonly attribute boolean scrollLock;
25621 
25622 }; /* interface IKeyboardLedsChangedEvent */
25623 
25633 {
25639  readonly attribute MachineState state;
25640 
25641 }; /* interface IStateChangedEvent */
25642 
25653 {
25654  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25655 
25656 }; /* interface IAdditionsStateChangedEvent */
25657 
25669 {
25675  readonly attribute INetworkAdapter networkAdapter;
25676 
25677 }; /* interface INetworkAdapterChangedEvent */
25678 
25690 {
25696  readonly attribute ISerialPort serialPort;
25697 
25698 }; /* interface ISerialPortChangedEvent */
25699 
25711 {
25717  readonly attribute IParallelPort parallelPort;
25718 
25719 }; /* interface IParallelPortChangedEvent */
25720 
25731 {
25732  readonly attribute boolean midlDoesNotLikeEmptyInterfaces;
25733 
25734 }; /* interface IStorageControllerChangedEvent */
25735 
25748 {
25755 
25756 }; /* interface IMediumChangedEvent */
25757 
25766 {
25772  readonly attribute ClipboardMode clipboardMode;
25773 
25774 }; /* interface IClipboardModeChangedEvent */
25775 
25784 {
25790  readonly attribute DnDMode dndMode;
25791 
25792 }; /* interface IDnDModeChangedEvent */
25793 
25802 {
25808  readonly attribute unsigned long CPU;
25809 
25815  readonly attribute boolean add;
25816 
25817 }; /* interface ICPUChangedEvent */
25818 
25827 {
25833  readonly attribute unsigned long executionCap;
25834 
25835 }; /* interface ICPUExecutionCapChangedEvent */
25836 
25845 {
25851  readonly attribute long[] scancodes;
25852 
25853 }; /* interface IGuestKeyboardEvent */
25854 
25863 {
25869  readonly attribute GuestMouseEventMode mode;
25870 
25876  readonly attribute long x;
25877 
25883  readonly attribute long y;
25884 
25890  readonly attribute long z;
25891 
25897  readonly attribute long w;
25898 
25904  readonly attribute long buttons;
25905 
25906 }; /* interface IGuestMouseEvent */
25907 
25916 {
25922  readonly attribute long contactCount;
25923 
25929  readonly attribute short[] xPositions;
25930 
25936  readonly attribute short[] yPositions;
25937 
25943  readonly attribute unsigned short[] contactIds;
25944 
25952  readonly attribute unsigned short[] contactFlags;
25953 
25959  readonly attribute unsigned long scanTime;
25960 
25961 }; /* interface IGuestMultiTouchEvent */
25962 
25969 {
25973  readonly attribute IGuestSession session;
25974 
25975 }; /* interface IGuestSessionEvent */
25976 
25985 {
25991  readonly attribute unsigned long id;
25992 
25998  readonly attribute GuestSessionStatus status;
25999 
26009  readonly attribute IVirtualBoxErrorInfo error;
26010 
26011 }; /* interface IGuestSessionStateChangedEvent */
26012 
26021 {
26028  readonly attribute boolean registered;
26029 
26030 }; /* interface IGuestSessionRegisteredEvent */
26031 
26038 {
26044  readonly attribute IGuestProcess process;
26045