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;
236 {
327 };
328 
337 {
340 };
341 
460 {
666 };
667 
678 {
726 };
727 
737 {
776 };
777 
788 {
838 };
839 
848 {
864 };
865 
874 {
897 };
898 
908 {
936 };
937 
946 {
985 };
986 
995 {
1000 };
1001 
1010 {
1015 };
1016 
1025 {
1030 };
1031 
1042 enum Scope
1043 {
1047 };
1048 
1057 {
1061 };
1062 
1071 {
1076 };
1077 
1086 {
1112 };
1113 
1122 {
1161 };
1162 
1171 {
1193 };
1194 
1196 {
1260 };
1261 
1270 {
1275 };
1276 
1285 {
1295 };
1296 
1305 {
1316 };
1317 
1326 {
1355 };
1356 
1364 {
1393 };
1394 
1402 {
1407 };
1408 
1416 {
1432 };
1433 
1441 {
1462 };
1463 
1472 {
1488 };
1489 
1498 {
1519 };
1520 
1529 {
1550 };
1551 
1563 {
1592 };
1593 
1604 {
1626 };
1627 
1636 {
1639 };
1640 
1649 {
1693 };
1694 
1703 {
1739 };
1740 
1749 {
1795 };
1796 
1805 {
1826 };
1827 
1836 {
1850 };
1851 
1861 {
1907 };
1908 
1917 {
1938 };
1939 
1954 {
2000 };
2001 
2010 {
2158 };
2159 
2168 {
2179 };
2180 
2189 {
2200 };
2201 
2211 {
2222 };
2223 
2232 {
2263 };
2264 
2284 {
2347 };
2348 
2357 {
2381 };
2382 
2391 {
2402 };
2403 
2412 {
2428 };
2429 
2438 {
2459 };
2460 
2469 {
2511 };
2512 
2521 {
2532 };
2533 
2542 {
2558 };
2559 
2568 {
2579 };
2580 
2589 {
2650 };
2651 
2660 {
2686 };
2687 
2696 {
2732 };
2733 
2742 {
2788 };
2789 
2798 {
2819 };
2820 
2829 {
2840 };
2841 
2852 {
2910 };
2911 
2923 {
2978 };
2979 
2990 {
3049 };
3050 
3052 {
3056 };
3057 
3059 {
3065 };
3066 
3075 {
3153 };
3154 
3163 {
3172 };
3173 
3182 {
3201 };
3202 
3214 {
3231 };
3232 
3241 {
3253 };
3254 
3263 {
3299 };
3300 
3309 {
3331 };
3332 
3342 {
3363 };
3364 
3373 {
3386 };
3387 
3427 {
3474 };
3475 
3486 {
3502 };
3503 
3512 {
3558 };
3559 
3568 {
3572 };
3573 
3582 {
3590 };
3591 
3600 {
3621 };
3622 
3632 {
3643 };
3644 
3654 {
3700 };
3701 
3710 {
3726 };
3727 
3734 {
3750 };
3751 
3758 {
3769 };
3770 
3779 {
3801 };
3802 
3812 {
4319 };
4320 
4333 {
4348 };
4349 
4358 {
4380 };
4381 
4415 interface IVirtualBoxErrorInfo : $errorinfo
4416 {
4434  readonly attribute long resultCode;
4435 
4442  readonly attribute long resultDetail;
4443 
4455  readonly attribute wstringUUID interfaceID;
4456 
4467  readonly attribute wstring component;
4468 
4479  readonly attribute wstring text;
4480 
4491  readonly attribute IVirtualBoxErrorInfo next;
4492 
4493 }; /* interface IVirtualBoxErrorInfo */
4494 
4495 interface INATNetwork : $unknown
4496 {
4505  attribute wstring networkName;
4506 
4507  attribute boolean enabled;
4508 
4517  attribute wstring network;
4518 
4525  readonly attribute wstring gateway;
4526 
4532  attribute boolean IPv6Enabled;
4533 
4541  attribute wstring IPv6Prefix;
4542 
4544 
4545  attribute boolean needDhcpServer;
4546 
4547  readonly attribute IEventSource eventSource;
4548 
4555  readonly attribute wstring[] portForwardRules4;
4556 
4561  readonly attribute wstring[] localMappings;
4562 
4567  attribute long loopbackIp6;
4568 
4574  readonly attribute wstring[] portForwardRules6;
4575 
4579  void addLocalMapping (
4580  in wstring hostid,
4581  in long offset
4582  );
4583 
4584  void addPortForwardRule (
4585  in boolean isIpv6,
4586  in wstring ruleName,
4587  in NATProtocol proto,
4588  in wstring hostIP,
4589  in unsigned short hostPort,
4590  in wstring guestIP,
4591  in unsigned short guestPort
4592  );
4593 
4594  void removePortForwardRule (
4595  in boolean iSipv6,
4596  in wstring ruleName
4597  );
4598 
4599  void start (
4600  in wstring trunkType
4601  );
4602 
4603  void stop();
4604 
4605 }; /* interface INATNetwork */
4606 
4617 interface IDHCPServer : $unknown
4618 {
4619  readonly attribute IEventSource eventSource;
4620 
4626  attribute boolean enabled;
4627 
4633  readonly attribute wstring IPAddress;
4634 
4640  readonly attribute wstring networkMask;
4641 
4647  readonly attribute wstring networkName;
4648 
4654  readonly attribute wstring lowerIP;
4655 
4661  readonly attribute wstring upperIP;
4662 
4663  readonly attribute wstring[] globalOptions;
4664 
4665  readonly attribute wstring[] vmConfigs;
4666 
4667  void addGlobalOption (
4668  in DhcpOpt option,
4669  in wstring value
4670  );
4671 
4672  void addVmSlotOption (
4673  in wstring vmname,
4674  in long slot,
4675  in DhcpOpt option,
4676  in wstring value
4677  );
4678 
4679  void removeVmSlotOptions (
4680  in wstring vmname,
4681  in long slot
4682  );
4683 
4684  void getVmSlotOptions (
4685  in wstring vmname,
4686  in long slot,
4687  [retval] out wstring[] option
4688  );
4689 
4690  void getMacOptions (
4691  in wstring mac,
4692  [retval] out wstring[] option
4693  );
4694 
4723  void setConfiguration (
4724  in wstring IPAddress,
4725  in wstring networkMask,
4726  in wstring FromIPAddress,
4727  in wstring ToIPAddress
4728  );
4729 
4754  void start (
4755  in wstring networkName,
4756  in wstring trunkName,
4757  in wstring trunkType
4758  );
4759 
4772  void stop();
4773 
4774 }; /* interface IDHCPServer */
4775 
4794 interface IVirtualBox : $unknown
4795 {
4808  readonly attribute wstring version;
4809 
4817  readonly attribute wstring versionNormalized;
4818 
4824  readonly attribute unsigned long revision;
4825 
4835  readonly attribute wstring packageType;
4836 
4848  readonly attribute wstring APIVersion;
4849 
4865  readonly attribute wstring homeFolder;
4866 
4874  readonly attribute wstring settingsFilePath;
4875 
4879  readonly attribute IHost host;
4880 
4885 
4891  readonly attribute IMachine[] machines;
4892 
4902  readonly attribute wstring[] machineGroups;
4903 
4913  readonly attribute IMedium[] hardDisks;
4914 
4920  readonly attribute IMedium[] DVDImages;
4921 
4927  readonly attribute IMedium[] floppyImages;
4928 
4929  readonly attribute IProgress[] progressOperations;
4930 
4931  readonly attribute IGuestOSType[] guestOSTypes;
4932 
4949  readonly attribute ISharedFolder[] sharedFolders;
4950 
4957 
4963  readonly attribute IDHCPServer[] DHCPServers;
4964 
4965  readonly attribute INATNetwork[] NATNetworks;
4966 
4972  readonly attribute IEventSource eventSource;
4973 
4980 
4986  readonly attribute wstring[] internalNetworks;
4987 
4993  readonly attribute wstring[] genericNetworkDrivers;
4994 
5045  void composeMachineFilename (
5046  in wstring name,
5047  in wstring group,
5048  in wstring createFlags,
5049  in wstring baseFolder,
5050  [retval] out wstring file
5051  );
5052 
5159  void createMachine (
5160  in wstring settingsFile,
5161  in wstring name,
5162  in wstring[] groups,
5163  in wstring osTypeId,
5164  in wstring flags,
5165  [retval] out IMachine machine
5166  );
5167 
5198  void openMachine (
5199  in wstring settingsFile,
5200  [retval] out IMachine machine
5201  );
5202 
5234  void registerMachine (
5235  in IMachine machine
5236  );
5237 
5258  void findMachine (
5259  in wstring nameOrId,
5260  [retval] out IMachine machine
5261  );
5262 
5274  void getMachinesByGroups (
5275  in wstring[] groups,
5276  [retval] out IMachine[] machines
5277  );
5278 
5288  void getMachineStates (
5289  in IMachine[] machines,
5290  [retval] out MachineState[] states
5291  );
5292 
5302  void createAppliance (
5303  [retval] out IAppliance appliance
5304  );
5305 
5368  void createHardDisk (
5369  in wstring format,
5370  in wstring location,
5371  [retval] out IMedium medium
5372  );
5373 
5479  void openMedium (
5480  in wstring location,
5481  in DeviceType deviceType,
5482  in AccessMode accessMode,
5483  in boolean forceNewUuid,
5484  [retval] out IMedium medium
5485  );
5486 
5515  void getGuestOSType (
5516  in wstringUUID id,
5517  [retval] out IGuestOSType type
5518  );
5519 
5542  void createSharedFolder (
5543  in wstring name,
5544  in wstring hostPath,
5545  in boolean writable,
5546  in boolean automount
5547  );
5548 
5563  void removeSharedFolder (
5564  in wstring name
5565  );
5566 
5575  void getExtraDataKeys (
5576  [retval] out wstring[] keys
5577  );
5578 
5607  void getExtraData (
5608  in wstring key,
5609  [retval] out wstring value
5610  );
5611 
5661  void setExtraData (
5662  in wstring key,
5663  in wstring value
5664  );
5665 
5684  void setSettingsSecret (
5685  in wstring password
5686  );
5687 
5704  void createDHCPServer (
5705  in wstring name,
5706  [retval] out IDHCPServer server
5707  );
5708 
5726  in wstring name,
5727  [retval] out IDHCPServer server
5728  );
5729 
5744  void removeDHCPServer (
5745  in IDHCPServer server
5746  );
5747 
5748  void createNATNetwork (
5749  in wstring networkName,
5750  [retval] out INATNetwork network
5751  );
5752 
5753  void findNATNetworkByName (
5754  in wstring networkName,
5755  [retval] out INATNetwork network
5756  );
5757 
5758  void removeNATNetwork (
5759  in INATNetwork network
5760  );
5761 
5786  void checkFirmwarePresent (
5787  in FirmwareType firmwareType,
5788  in wstring version,
5789  out wstring url,
5790  out wstring file,
5791  [retval] out boolean result
5792  );
5793 
5794 }; /* interface IVirtualBox */
5795 
5806 interface IVFSExplorer : $unknown
5807 {
5811  readonly attribute wstring path;
5812 
5816  readonly attribute VFSType type;
5817 
5825  void update (
5826  [retval] out IProgress progress
5827  );
5828 
5836  void cd (
5837  in wstring dir,
5838  [retval] out IProgress progress
5839  );
5840 
5846  void cdUp (
5847  [retval] out IProgress progress
5848  );
5849 
5862  void entryList (
5863  out wstring[] names,
5864  out unsigned long[] types,
5865  out long long[] sizes,
5866  out unsigned long[] modes
5867  );
5868 
5877  void exists (
5878  in wstring[] names,
5879  [retval] out wstring[] exists
5880  );
5881 
5889  void remove (
5890  in wstring[] names,
5891  [retval] out IProgress progress
5892  );
5893 
5894 }; /* interface IVFSExplorer */
5895 
5961 interface IAppliance : $unknown
5962 {
5970  readonly attribute wstring path;
5971 
6002  readonly attribute wstring[] disks;
6003 
6012 
6020  readonly attribute wstring[] machines;
6021 
6038  void read (
6039  in wstring file,
6040  [retval] out IProgress progress
6041  );
6042 
6059  void interpret();
6060 
6083  void importMachines (
6084  in ImportOptions[] options,
6085  [retval] out IProgress progress
6086  );
6087 
6095  void createVFSExplorer (
6096  in wstring URI,
6097  [retval] out IVFSExplorer explorer
6098  );
6099 
6126  void write (
6127  in wstring format,
6128  in ExportOptions[] options,
6129  in wstring path,
6130  [retval] out IProgress progress
6131  );
6132 
6138  void getWarnings (
6139  [retval] out wstring[] warnings
6140  );
6141 
6142 }; /* interface IAppliance */
6143 
6155 interface IVirtualSystemDescription : $unknown
6156 {
6160  readonly attribute unsigned long count;
6161 
6285  void getDescription (
6286  out VirtualSystemDescriptionType[] types,
6287  out wstring[] refs,
6288  out wstring[] OVFValues,
6289  out wstring[] VBoxValues,
6290  out wstring[] extraConfigValues
6291  );
6292 
6309  void getDescriptionByType (
6311  out VirtualSystemDescriptionType[] types,
6312  out wstring[] refs,
6313  out wstring[] OVFValues,
6314  out wstring[] VBoxValues,
6315  out wstring[] extraConfigValues
6316  );
6317 
6329  void getValuesByType (
6332  [retval] out wstring[] values
6333  );
6334 
6360  void setFinalValues (
6361  in boolean[] enabled,
6362  in wstring[] VBoxValues,
6363  in wstring[] extraConfigValues
6364  );
6365 
6380  void addDescription (
6382  in wstring VBoxValue,
6383  in wstring extraConfigValue
6384  );
6385 
6386 }; /* interface IVirtualSystemDescription */
6387 
6388 interface IInternalMachineControl : $unknown
6389 {
6397  in boolean remove
6398  );
6399 
6411  void updateState (
6412  in MachineState state
6413  );
6414 
6426  void beginPowerUp (
6427  in IProgress progress
6428  );
6429 
6439  void endPowerUp (
6440  in long result
6441  );
6442 
6454  void beginPoweringDown (
6455  out IProgress progress
6456  );
6457 
6487  void endPoweringDown (
6488  in long result,
6489  in wstring errMsg
6490  );
6491 
6505  void runUSBDeviceFilters (
6506  in IUSBDevice device,
6507  out boolean matched,
6508  out unsigned long maskedInterfaces
6509  );
6510 
6519  void captureUSBDevice (
6520  in wstringUUID id
6521  );
6522 
6538  void detachUSBDevice (
6539  in wstringUUID id,
6540  in boolean done
6541  );
6542 
6551  void autoCaptureUSBDevices();
6552 
6568  void detachAllUSBDevices (
6569  in boolean done
6570  );
6571 
6586  void onSessionEnd (
6587  in ISession session,
6588  [retval] out IProgress progress
6589  );
6590 
6606  void beginSavingState (
6607  out IProgress progress,
6608  out wstring stateFilePath
6609  );
6610 
6640  void endSavingState (
6641  in long result,
6642  in wstring errMsg
6643  );
6644 
6659  void adoptSavedState (
6660  in wstring savedStateFile
6661  );
6662 
6711  void beginTakingSnapshot (
6712  in IConsole initiator,
6713  in wstring name,
6714  in wstring description,
6715  in IProgress consoleProgress,
6716  in boolean fTakingSnapshotOnline,
6717  out wstring stateFilePath
6718  );
6719 
6729  void endTakingSnapshot (
6730  in boolean success
6731  );
6732 
6761  void deleteSnapshot (
6762  in IConsole initiator,
6763  in wstringUUID startId,
6764  in wstringUUID endId,
6765  in boolean deleteAllChildren,
6766  out MachineState machineState,
6767  [retval] out IProgress progress
6768  );
6769 
6776  void finishOnlineMergeMedium();
6777 
6791  void restoreSnapshot (
6792  in IConsole initiator,
6793  in ISnapshot snapshot,
6794  out MachineState machineState,
6795  [retval] out IProgress progress
6796  );
6797 
6824  void pullGuestProperties (
6825  out wstring[] names,
6826  out wstring[] values,
6827  out long long[] timestamps,
6828  out wstring[] flags
6829  );
6830 
6852  void pushGuestProperty (
6853  in wstring name,
6854  in wstring value,
6855  in long long timestamp,
6856  in wstring flags
6857  );
6858 
6870  void lockMedia();
6871 
6881  void unlockMedia();
6882 
6898  void ejectMedium (
6899  in IMediumAttachment attachment,
6900  [retval] out IMediumAttachment newAttachment
6901  );
6902 
6943  void reportVmStatistics (
6944  in unsigned long validStats,
6945  in unsigned long cpuUser,
6946  in unsigned long cpuKernel,
6947  in unsigned long cpuIdle,
6948  in unsigned long memTotal,
6949  in unsigned long memFree,
6950  in unsigned long memBalloon,
6951  in unsigned long memShared,
6952  in unsigned long memCache,
6953  in unsigned long pagedTotal,
6954  in unsigned long memAllocTotal,
6955  in unsigned long memFreeTotal,
6956  in unsigned long memBalloonTotal,
6957  in unsigned long memSharedTotal,
6958  in unsigned long vmNetRx,
6959  in unsigned long vmNetTx
6960  );
6961 
6962 }; /* interface IInternalMachineControl */
6963 
6972 interface IBIOSSettings : $unknown
6973 {
6977  attribute boolean logoFadeIn;
6978 
6982  attribute boolean logoFadeOut;
6983 
6987  attribute unsigned long logoDisplayTime;
6988 
6995  attribute wstring logoImagePath;
6996 
7001 
7005  attribute boolean ACPIEnabled;
7006 
7013  attribute boolean IOAPICEnabled;
7014 
7024  attribute long long timeOffset;
7025 
7032  attribute boolean PXEDebugEnabled;
7033 
7042  readonly attribute wstring nonVolatileStorageFile;
7043 
7044 }; /* interface IBIOSSettings */
7045 
7053 interface IPCIAddress : $unknown
7054 {
7060  attribute short bus;
7061 
7067  attribute short device;
7068 
7074  attribute short devFunction;
7075 
7081  void asLong (
7082  [retval] out long result
7083  );
7084 
7090  void fromLong (
7091  in long number
7092  );
7093 
7094 }; /* interface IPCIAddress */
7095 
7103 interface IPCIDeviceAttachment : $unknown
7104 {
7110  readonly attribute wstring name;
7111 
7117  readonly attribute boolean isPhysicalDevice;
7118 
7124  readonly attribute long hostAddress;
7125 
7131  readonly attribute long guestAddress;
7132 
7133 }; /* interface IPCIDeviceAttachment */
7134 
7175 interface IMachine : $unknown
7176 {
7180  readonly attribute IVirtualBox parent;
7181 
7185  attribute octet[] icon;
7186 
7236  readonly attribute boolean accessible;
7237 
7249  readonly attribute IVirtualBoxErrorInfo accessError;
7250 
7290  attribute wstring name;
7291 
7302  attribute wstring description;
7303 
7307  readonly attribute wstringUUID id;
7308 
7319  attribute wstring[] groups;
7320 
7335  attribute wstring OSTypeId;
7336 
7340  attribute wstring hardwareVersion;
7341 
7351  attribute wstringUUID hardwareUUID;
7352 
7356  attribute unsigned long CPUCount;
7357 
7363  attribute boolean CPUHotPlugEnabled;
7364 
7372  attribute unsigned long CPUExecutionCap;
7373 
7377  attribute unsigned long memorySize;
7378 
7382  attribute unsigned long memoryBalloonSize;
7383 
7390  attribute boolean pageFusionEnabled;
7391 
7396 
7400  attribute unsigned long VRAMSize;
7401 
7407  attribute boolean accelerate3DEnabled;
7408 
7414  attribute boolean accelerate2DVideoEnabled;
7415 
7426  attribute unsigned long monitorCount;
7427 
7433  attribute boolean videoCaptureEnabled;
7434 
7440  attribute boolean[] videoCaptureScreens;
7441 
7455  attribute wstring videoCaptureFile;
7456 
7464  attribute unsigned long videoCaptureWidth;
7465 
7473  attribute unsigned long videoCaptureHeight;
7474 
7483  attribute unsigned long videoCaptureRate;
7484 
7494  attribute unsigned long videoCaptureFPS;
7495 
7499  readonly attribute IBIOSSettings BIOSSettings;
7500 
7506 
7513 
7520 
7527  attribute boolean HPETEnabled;
7528 
7533 
7567  attribute wstring snapshotFolder;
7568 
7572  readonly attribute IVRDEServer VRDEServer;
7573 
7574  attribute boolean emulatedUSBCardReaderEnabled;
7575 
7579  readonly attribute IMediumAttachment[] mediumAttachments;
7580 
7592  readonly attribute IUSBController[] USBControllers;
7593 
7606 
7610  readonly attribute IAudioAdapter audioAdapter;
7611 
7616 
7622  readonly attribute wstring settingsFilePath;
7623 
7648  readonly attribute boolean settingsModified;
7649 
7653  readonly attribute SessionState sessionState;
7654 
7667  readonly attribute wstring sessionType;
7668 
7678  readonly attribute unsigned long sessionPID;
7679 
7683  readonly attribute MachineState state;
7684 
7691  readonly attribute long long lastStateChange;
7692 
7704  readonly attribute wstring stateFilePath;
7705 
7715  readonly attribute wstring logFolder;
7716 
7727  readonly attribute ISnapshot currentSnapshot;
7728 
7735  readonly attribute unsigned long snapshotCount;
7736 
7768  readonly attribute boolean currentStateModified;
7769 
7781  readonly attribute ISharedFolder[] sharedFolders;
7782 
7790 
7797 
7806 
7815  attribute boolean teleporterEnabled;
7816 
7827  attribute unsigned long teleporterPort;
7828 
7835  attribute wstring teleporterAddress;
7836 
7847  attribute wstring teleporterPassword;
7848 
7857 
7864  attribute unsigned long faultTolerancePort;
7865 
7871  attribute wstring faultToleranceAddress;
7872 
7880  attribute wstring faultTolerancePassword;
7881 
7887  attribute unsigned long faultToleranceSyncInterval;
7888 
7896  attribute boolean RTCUseUTC;
7897 
7904  attribute boolean IOCacheEnabled;
7905 
7911  attribute unsigned long IOCacheSize;
7912 
7923 
7930 
7939  attribute boolean tracingEnabled;
7940 
7955  attribute wstring tracingConfig;
7956 
7969  attribute boolean allowTracingToAccessVM;
7970 
7976  attribute boolean autostartEnabled;
7977 
7983  attribute unsigned long autostartDelay;
7984 
7991 
8007  attribute wstring defaultFrontend;
8008 
8014  readonly attribute boolean USBProxyAvailable;
8015 
8121  void lockMachine (
8122  in ISession session,
8123  in LockType lockType
8124  );
8125 
8262  void launchVMProcess (
8263  in ISession session,
8264  in wstring type,
8265  in wstring environment,
8266  [retval] out IProgress progress
8267  );
8268 
8306  void setBootOrder (
8307  in unsigned long position,
8308  in DeviceType device
8309  );
8310 
8345  void getBootOrder (
8346  in unsigned long position,
8347  [retval] out DeviceType device
8348  );
8349 
8451  void attachDevice (
8452  in wstring name,
8453  in long controllerPort,
8454  in long device,
8455  in DeviceType type,
8456  in IMedium medium
8457  );
8458 
8555  in wstring name,
8556  in long controllerPort,
8557  in long device,
8558  in DeviceType type
8559  );
8560 
8614  void detachDevice (
8615  in wstring name,
8616  in long controllerPort,
8617  in long device
8618  );
8619 
8662  void passthroughDevice (
8663  in wstring name,
8664  in long controllerPort,
8665  in long device,
8666  in boolean passthrough
8667  );
8668 
8711  void temporaryEjectDevice (
8712  in wstring name,
8713  in long controllerPort,
8714  in long device,
8715  in boolean temporaryEject
8716  );
8717 
8763  void nonRotationalDevice (
8764  in wstring name,
8765  in long controllerPort,
8766  in long device,
8767  in boolean nonRotational
8768  );
8769 
8816  in wstring name,
8817  in long controllerPort,
8818  in long device,
8819  in boolean discard
8820  );
8821 
8872  in wstring name,
8873  in long controllerPort,
8874  in long device,
8875  in boolean hotPluggable
8876  );
8877 
8919  in wstring name,
8920  in long controllerPort,
8921  in long device,
8922  in IBandwidthGroup bandwidthGroup
8923  );
8924 
8962  in wstring name,
8963  in long controllerPort,
8964  in long device
8965  );
8966 
9031  void unmountMedium (
9032  in wstring name,
9033  in long controllerPort,
9034  in long device,
9035  in boolean force
9036  );
9037 
9100  void mountMedium (
9101  in wstring name,
9102  in long controllerPort,
9103  in long device,
9104  in IMedium medium,
9105  in boolean force
9106  );
9107 
9136  void getMedium (
9137  in wstring name,
9138  in long controllerPort,
9139  in long device,
9140  [retval] out IMedium medium
9141  );
9142 
9158  in wstring name,
9159  [retval] out IMediumAttachment[] mediumAttachments
9160  );
9161 
9176  void getMediumAttachment (
9177  in wstring name,
9178  in long controllerPort,
9179  in long device,
9180  [retval] out IMediumAttachment attachment
9181  );
9182 
9223  void attachHostPCIDevice (
9224  in long hostAddress,
9225  in long desiredGuestAddress,
9226  in boolean tryToUnbind
9227  );
9228 
9269  void detachHostPCIDevice (
9270  in long hostAddress
9271  );
9272 
9290  void getNetworkAdapter (
9291  in unsigned long slot,
9292  [retval] out INetworkAdapter adapter
9293  );
9294 
9327  void addStorageController (
9328  in wstring name,
9329  in StorageBus connectionType,
9330  [retval] out IStorageController controller
9331  );
9332 
9347  in wstring name,
9348  [retval] out IStorageController storageController
9349  );
9350 
9365  in unsigned long instance,
9366  [retval] out IStorageController storageController
9367  );
9368 
9392  in wstring name
9393  );
9394 
9417  in wstring name,
9418  in boolean bootable
9419  );
9420 
9443  void addUSBController (
9444  in wstring name,
9445  in USBControllerType type,
9446  [retval] out IUSBController controller
9447  );
9448 
9462  void removeUSBController (
9463  in wstring name
9464  );
9465 
9479  void getUSBControllerByName (
9480  in wstring name,
9481  [retval] out IUSBController controller
9482  );
9483 
9490  in USBControllerType type,
9491  [retval] out unsigned long controllers
9492  );
9493 
9511  void getSerialPort (
9512  in unsigned long slot,
9513  [retval] out ISerialPort port
9514  );
9515 
9533  void getParallelPort (
9534  in unsigned long slot,
9535  [retval] out IParallelPort port
9536  );
9537 
9546  void getExtraDataKeys (
9547  [retval] out wstring[] keys
9548  );
9549 
9578  void getExtraData (
9579  in wstring key,
9580  [retval] out wstring value
9581  );
9582 
9632  void setExtraData (
9633  in wstring key,
9634  in wstring value
9635  );
9636 
9658  void getCPUProperty (
9659  in CPUPropertyType property,
9660  [retval] out boolean value
9661  );
9662 
9684  void setCPUProperty (
9685  in CPUPropertyType property,
9686  in boolean value
9687  );
9688 
9728  void getCPUIDLeaf (
9729  in unsigned long id,
9730  out unsigned long valEax,
9731  out unsigned long valEbx,
9732  out unsigned long valEcx,
9733  out unsigned long valEdx
9734  );
9735 
9779  void setCPUIDLeaf (
9780  in unsigned long id,
9781  in unsigned long valEax,
9782  in unsigned long valEbx,
9783  in unsigned long valEcx,
9784  in unsigned long valEdx
9785  );
9786 
9804  void removeCPUIDLeaf (
9805  in unsigned long id
9806  );
9807 
9813  void removeAllCPUIDLeaves();
9814 
9836  void getHWVirtExProperty (
9837  in HWVirtExPropertyType property,
9838  [retval] out boolean value
9839  );
9840 
9862  void setHWVirtExProperty (
9863  in HWVirtExPropertyType property,
9864  in boolean value
9865  );
9866 
9896  void setSettingsFilePath (
9897  in wstring settingsFilePath,
9898  [retval] out IProgress progress
9899  );
9900 
9946  void saveSettings();
9947 
9971  void discardSettings();
9972 
10056  void unregister (
10057  in CleanupMode cleanupMode,
10058  [retval] out IMedium[] media
10059  );
10060 
10117  void deleteConfig (
10118  in IMedium[] media,
10119  [retval] out IProgress progress
10120  );
10121 
10133  void exportTo (
10134  in IAppliance appliance,
10135  in wstring location,
10137  );
10138 
10162  void findSnapshot (
10163  in wstring nameOrId,
10164  [retval] out ISnapshot snapshot
10165  );
10166 
10200  void createSharedFolder (
10201  in wstring name,
10202  in wstring hostPath,
10203  in boolean writable,
10204  in boolean automount
10205  );
10206 
10232  void removeSharedFolder (
10233  in wstring name
10234  );
10235 
10259  void canShowConsoleWindow (
10260  [retval] out boolean canShow
10261  );
10262 
10297  void showConsoleWindow (
10298  [retval] out long long winId
10299  );
10300 
10333  void getGuestProperty (
10334  in wstring name,
10335  out wstring value,
10336  out long long timestamp,
10337  out wstring flags
10338  );
10339 
10362  void getGuestPropertyValue (
10363  in wstring property,
10364  [retval] out wstring value
10365  );
10366 
10390  in wstring property,
10391  [retval] out long long value
10392  );
10393 
10444  void setGuestProperty (
10445  in wstring property,
10446  in wstring value,
10447  in wstring flags
10448  );
10449 
10489  void setGuestPropertyValue (
10490  in wstring property,
10491  in wstring value
10492  );
10493 
10511  void deleteGuestProperty (
10512  in wstring name
10513  );
10514 
10546  in wstring patterns,
10547  out wstring[] names,
10548  out wstring[] values,
10549  out long long[] timestamps,
10550  out wstring[] flags
10551  );
10552 
10583  in unsigned long screenId,
10584  out unsigned long originX,
10585  out unsigned long originY,
10586  out unsigned long width,
10587  out unsigned long height,
10588  out boolean enabled
10589  );
10590 
10613  in unsigned long screenId,
10614  out unsigned long size,
10615  out unsigned long width,
10616  out unsigned long height
10617  );
10618 
10646  in unsigned long screenId,
10647  in boolean BGR,
10648  out unsigned long width,
10649  out unsigned long height,
10650  [retval] out octet[] data
10651  );
10652 
10675  in unsigned long screenId,
10676  out unsigned long width,
10677  out unsigned long height,
10678  [retval] out octet[] data
10679  );
10680 
10703  in unsigned long screenId,
10704  out unsigned long size,
10705  out unsigned long width,
10706  out unsigned long height
10707  );
10708 
10731  in unsigned long screenId,
10732  out unsigned long width,
10733  out unsigned long height,
10734  [retval] out octet[] data
10735  );
10736 
10746  void hotPlugCPU (
10747  in unsigned long cpu
10748  );
10749 
10759  void hotUnplugCPU (
10760  in unsigned long cpu
10761  );
10762 
10776  void getCPUStatus (
10777  in unsigned long cpu,
10778  [retval] out boolean attached
10779  );
10780 
10795  void queryLogFilename (
10796  in unsigned long idx,
10797  [retval] out wstring filename
10798  );
10799 
10825  void readLog (
10826  in unsigned long idx,
10827  in long long offset,
10828  in long long size,
10829  [retval] out octet[] data
10830  );
10831 
10864  void cloneTo (
10865  in IMachine target,
10866  in CloneMode mode,
10867  in CloneOptions[] options,
10868  [retval] out IProgress progress
10869  );
10870 
10871 }; /* interface IMachine */
10872 
10880 interface IEmulatedUSB : $unknown
10881 {
10885  readonly attribute wstring[] webcams;
10886 
10896  void webcamAttach (
10897  in wstring path,
10898  in wstring settings
10899  );
10900 
10908  void webcamDetach (
10909  in wstring path
10910  );
10911 
10912 }; /* interface IEmulatedUSB */
10913 
10922 interface IVRDEServerInfo : $unknown
10923 {
10929  readonly attribute boolean active;
10930 
10939  readonly attribute long port;
10940 
10946  readonly attribute unsigned long numberOfClients;
10947 
10953  readonly attribute long long beginTime;
10954 
10961  readonly attribute long long endTime;
10962 
10968  readonly attribute long long bytesSent;
10969 
10975  readonly attribute long long bytesSentTotal;
10976 
10982  readonly attribute long long bytesReceived;
10983 
10989  readonly attribute long long bytesReceivedTotal;
10990 
10996  readonly attribute wstring user;
10997 
11003  readonly attribute wstring domain;
11004 
11010  readonly attribute wstring clientName;
11011 
11017  readonly attribute wstring clientIP;
11018 
11024  readonly attribute unsigned long clientVersion;
11025 
11033  readonly attribute unsigned long encryptionStyle;
11034 
11035 }; /* interface IVRDEServerInfo */
11036 
11058 interface IConsole : $unknown
11059 {
11071  readonly attribute IMachine machine;
11072 
11086  readonly attribute MachineState state;
11087 
11091  readonly attribute IGuest guest;
11092 
11103  readonly attribute IKeyboard keyboard;
11104 
11115  readonly attribute IMouse mouse;
11116 
11126  readonly attribute IDisplay display;
11127 
11131  readonly attribute IMachineDebugger debugger;
11132 
11143  readonly attribute IUSBDevice[] USBDevices;
11144 
11152  readonly attribute IHostUSBDevice[] remoteUSBDevices;
11153 
11169  readonly attribute ISharedFolder[] sharedFolders;
11170 
11176  readonly attribute IVRDEServerInfo VRDEServerInfo;
11177 
11183  readonly attribute IEventSource eventSource;
11184 
11189 
11198  attribute boolean useHostClipboard;
11199 
11205  readonly attribute IEmulatedUSB emulatedUSB;
11206 
11271  void powerUp (
11272  [retval] out IProgress progress
11273  );
11274 
11308  void powerUpPaused (
11309  [retval] out IProgress progress
11310  );
11311 
11331  void powerDown (
11332  [retval] out IProgress progress
11333  );
11334 
11354  void reset();
11355 
11375  void pause();
11376 
11396  void resume();
11397 
11417  void powerButton();
11418 
11438  void sleepButton();
11439 
11451  void getPowerButtonHandled (
11452  [retval] out boolean handled
11453  );
11454 
11469  [retval] out boolean entered
11470  );
11471 
11524  void saveState (
11525  [retval] out IProgress progress
11526  );
11527 
11560  void adoptSavedState (
11561  in wstring savedStateFile
11562  );
11563 
11594  void discardSavedState (
11595  in boolean fRemoveFile
11596  );
11597 
11610  void getDeviceActivity (
11611  in DeviceType type,
11612  [retval] out DeviceActivity activity
11613  );
11614 
11652  void attachUSBDevice (
11653  in wstringUUID id
11654  );
11655 
11690  void detachUSBDevice (
11691  in wstringUUID id,
11692  [retval] out IUSBDevice device
11693  );
11694 
11717  void findUSBDeviceByAddress (
11718  in wstring name,
11719  [retval] out IUSBDevice device
11720  );
11721 
11741  void findUSBDeviceById (
11742  in wstringUUID id,
11743  [retval] out IUSBDevice device
11744  );
11745 
11779  void createSharedFolder (
11780  in wstring name,
11781  in wstring hostPath,
11782  in boolean writable,
11783  in boolean automount
11784  );
11785 
11810  void removeSharedFolder (
11811  in wstring name
11812  );
11813 
11851  void takeSnapshot (
11852  in wstring name,
11853  in wstring description,
11854  [retval] out IProgress progress
11855  );
11856 
11929  void deleteSnapshot (
11930  in wstringUUID id,
11931  [retval] out IProgress progress
11932  );
11933 
11974  in wstringUUID id,
11975  [retval] out IProgress progress
11976  );
11977 
12021  void deleteSnapshotRange (
12022  in wstringUUID startId,
12023  in wstringUUID endId,
12024  [retval] out IProgress progress
12025  );
12026 
12067  void restoreSnapshot (
12068  in ISnapshot snapshot,
12069  [retval] out IProgress progress
12070  );
12071 
12110  void teleport (
12111  in wstring hostname,
12112  in unsigned long tcpport,
12113  in wstring password,
12114  in unsigned long maxDowntime,
12115  [retval] out IProgress progress
12116  );
12117 
12118 }; /* interface IConsole */
12119 
12130 interface IHostNetworkInterface : $unknown
12131 {
12135  readonly attribute wstring name;
12136 
12140  readonly attribute wstring shortName;
12141 
12145  readonly attribute wstringUUID id;
12146 
12150  readonly attribute wstring networkName;
12151 
12155  readonly attribute boolean DHCPEnabled;
12156 
12160  readonly attribute wstring IPAddress;
12161 
12165  readonly attribute wstring networkMask;
12166 
12170  readonly attribute boolean IPV6Supported;
12171 
12175  readonly attribute wstring IPV6Address;
12176 
12180  readonly attribute unsigned long IPV6NetworkMaskPrefixLength;
12181 
12185  readonly attribute wstring hardwareAddress;
12186 
12191 
12196 
12201 
12213  void enableStaticIPConfig (
12214  in wstring IPAddress,
12215  in wstring networkMask
12216  );
12217 
12229  void enableStaticIPConfigV6 (
12230  in wstring IPV6Address,
12231  in unsigned long IPV6NetworkMaskPrefixLength
12232  );
12233 
12237  void enableDynamicIPConfig();
12238 
12242  void DHCPRediscover();
12243 
12244 }; /* interface IHostNetworkInterface */
12245 
12253 interface IHostVideoInputDevice : $unknown
12254 {
12258  readonly attribute wstring name;
12259 
12263  readonly attribute wstring path;
12264 
12268  readonly attribute wstring alias;
12269 
12270 }; /* interface IHostVideoInputDevice */
12271 
12288 interface IHost : $unknown
12289 {
12293  readonly attribute IMedium[] DVDDrives;
12294 
12298  readonly attribute IMedium[] floppyDrives;
12299 
12313  readonly attribute IHostUSBDevice[] USBDevices;
12314 
12339 
12344 
12348  readonly attribute wstring[] nameServers;
12349 
12353  readonly attribute wstring domainName;
12354 
12358  readonly attribute wstring[] searchStrings;
12359 
12363  readonly attribute unsigned long processorCount;
12364 
12368  readonly attribute unsigned long processorOnlineCount;
12369 
12373  readonly attribute unsigned long processorCoreCount;
12374 
12378  readonly attribute unsigned long processorOnlineCoreCount;
12379 
12383  readonly attribute unsigned long memorySize;
12384 
12388  readonly attribute unsigned long memoryAvailable;
12389 
12393  readonly attribute wstring operatingSystem;
12394 
12398  readonly attribute wstring OSVersion;
12399 
12403  readonly attribute long long UTCTime;
12404 
12408  readonly attribute boolean acceleration3DAvailable;
12409 
12414 
12429  void getProcessorSpeed (
12430  in unsigned long cpuId,
12431  [retval] out unsigned long speed
12432  );
12433 
12445  void getProcessorFeature (
12446  in ProcessorFeature feature,
12447  [retval] out boolean supported
12448  );
12449 
12469  in unsigned long cpuId,
12470  [retval] out wstring description
12471  );
12472 
12513  void getProcessorCPUIDLeaf (
12514  in unsigned long cpuId,
12515  in unsigned long leaf,
12516  in unsigned long subLeaf,
12517  out unsigned long valEax,
12518  out unsigned long valEbx,
12519  out unsigned long valEcx,
12520  out unsigned long valEdx
12521  );
12522 
12544  out IHostNetworkInterface hostInterface,
12545  [retval] out IProgress progress
12546  );
12547 
12569  in wstringUUID id,
12570  [retval] out IProgress progress
12571  );
12572 
12592  void createUSBDeviceFilter (
12593  in wstring name,
12594  [retval] out IHostUSBDeviceFilter filter
12595  );
12596 
12639  void insertUSBDeviceFilter (
12640  in unsigned long position,
12641  in IHostUSBDeviceFilter filter
12642  );
12643 
12671  void removeUSBDeviceFilter (
12672  in unsigned long position
12673  );
12674 
12692  void findHostDVDDrive (
12693  in wstring name,
12694  [retval] out IMedium drive
12695  );
12696 
12714  void findHostFloppyDrive (
12715  in wstring name,
12716  [retval] out IMedium drive
12717  );
12718 
12735  in wstring name,
12736  [retval] out IHostNetworkInterface networkInterface
12737  );
12738 
12755  in wstringUUID id,
12756  [retval] out IHostNetworkInterface networkInterface
12757  );
12758 
12769  in HostNetworkInterfaceType type,
12771  );
12772 
12792  void findUSBDeviceById (
12793  in wstringUUID id,
12794  [retval] out IHostUSBDevice device
12795  );
12796 
12819  void findUSBDeviceByAddress (
12820  in wstring name,
12821  [retval] out IHostUSBDevice device
12822  );
12823 
12831  void generateMACAddress (
12832  [retval] out wstring address
12833  );
12834 
12835 }; /* interface IHost */
12836 
12849 interface ISystemProperties : $unknown
12850 {
12854  readonly attribute unsigned long minGuestRAM;
12855 
12859  readonly attribute unsigned long maxGuestRAM;
12860 
12864  readonly attribute unsigned long minGuestVRAM;
12865 
12869  readonly attribute unsigned long maxGuestVRAM;
12870 
12874  readonly attribute unsigned long minGuestCPUCount;
12875 
12879  readonly attribute unsigned long maxGuestCPUCount;
12880 
12884  readonly attribute unsigned long maxGuestMonitors;
12885 
12890  readonly attribute long long infoVDSize;
12891 
12898  readonly attribute unsigned long serialPortCount;
12899 
12906  readonly attribute unsigned long parallelPortCount;
12907 
12917  readonly attribute unsigned long maxBootPosition;
12918 
12927  attribute boolean exclusiveHwVirt;
12928 
12952  attribute wstring defaultMachineFolder;
12953 
12959  attribute wstring loggingLevel;
12960 
12985  readonly attribute IMediumFormat[] mediumFormats;
12986 
13020  attribute wstring defaultHardDiskFormat;
13021 
13027  attribute long long freeDiskSpaceWarning;
13028 
13033  attribute unsigned long freeDiskSpacePercentWarning;
13034 
13040  attribute long long freeDiskSpaceError;
13041 
13046  attribute unsigned long freeDiskSpacePercentError;
13047 
13071  attribute wstring VRDEAuthLibrary;
13072 
13101  attribute wstring webServiceAuthLibrary;
13102 
13116  attribute wstring defaultVRDEExtPack;
13117 
13123  attribute unsigned long logHistoryCount;
13124 
13130 
13137  attribute wstring autostartDatabasePath;
13138 
13145  attribute wstring defaultAdditionsISO;
13146 
13161  attribute wstring defaultFrontend;
13162 
13173  void getMaxNetworkAdapters (
13174  in ChipsetType chipset,
13175  [retval] out unsigned long maxNetworkAdapters
13176  );
13177 
13192  in ChipsetType chipset,
13193  in NetworkAttachmentType type,
13194  [retval] out unsigned long maxNetworkAdapters
13195  );
13196 
13207  in StorageBus bus,
13208  [retval] out unsigned long maxDevicesPerPort
13209  );
13210 
13219  in StorageBus bus,
13220  [retval] out unsigned long minPortCount
13221  );
13222 
13231  in StorageBus bus,
13232  [retval] out unsigned long maxPortCount
13233  );
13234 
13248  in ChipsetType chipset,
13249  in StorageBus bus,
13250  [retval] out unsigned long maxInstances
13251  );
13252 
13263  in StorageBus bus,
13264  [retval] out DeviceType[] deviceTypes
13265  );
13266 
13276  in StorageControllerType controllerType,
13277  [retval] out boolean enabled
13278  );
13279 
13293  in ChipsetType chipset,
13294  in USBControllerType type,
13295  [retval] out unsigned long maxInstances
13296  );
13297 
13298 }; /* interface ISystemProperties */
13299 
13305 interface IGuestOSType : $unknown
13306 {
13310  readonly attribute wstring familyId;
13311 
13315  readonly attribute wstring familyDescription;
13316 
13320  readonly attribute wstring id;
13321 
13325  readonly attribute wstring description;
13326 
13330  readonly attribute boolean is64Bit;
13331 
13335  readonly attribute boolean recommendedIOAPIC;
13336 
13340  readonly attribute boolean recommendedVirtEx;
13341 
13345  readonly attribute unsigned long recommendedRAM;
13346 
13350  readonly attribute unsigned long recommendedVRAM;
13351 
13355  readonly attribute boolean recommended2DVideoAcceleration;
13356 
13360  readonly attribute boolean recommended3DAcceleration;
13361 
13365  readonly attribute long long recommendedHDD;
13366 
13370  readonly attribute NetworkAdapterType adapterType;
13371 
13375  readonly attribute boolean recommendedPAE;
13376 
13381 
13386 
13391 
13396 
13400  readonly attribute FirmwareType recommendedFirmware;
13401 
13405  readonly attribute boolean recommendedUSBHID;
13406 
13410  readonly attribute boolean recommendedHPET;
13411 
13415  readonly attribute boolean recommendedUSBTablet;
13416 
13420  readonly attribute boolean recommendedRTCUseUTC;
13421 
13425  readonly attribute ChipsetType recommendedChipset;
13426 
13431 
13435  readonly attribute boolean recommendedFloppy;
13436 
13440  readonly attribute boolean recommendedUSB;
13441 
13442 }; /* interface IGuestOSType */
13443 
13451 interface IAdditionsFacility : $unknown
13452 {
13456  readonly attribute AdditionsFacilityClass classType;
13457 
13464  readonly attribute long long lastUpdated;
13465 
13469  readonly attribute wstring name;
13470 
13474  readonly attribute AdditionsFacilityStatus status;
13475 
13479  readonly attribute AdditionsFacilityType type;
13480 
13481 }; /* interface IAdditionsFacility */
13482 
13511 interface IGuestSession : $unknown
13512 {
13518  readonly attribute wstring user;
13519 
13525  readonly attribute wstring domain;
13526 
13530  readonly attribute wstring name;
13531 
13535  readonly attribute unsigned long id;
13536 
13549  attribute unsigned long timeout;
13550 
13555  readonly attribute unsigned long protocolVersion;
13556 
13560  readonly attribute GuestSessionStatus status;
13561 
13567  attribute wstring[] environment;
13568 
13574  readonly attribute IGuestProcess[] processes;
13575 
13581  readonly attribute IGuestDirectory[] directories;
13582 
13588  readonly attribute IGuestFile[] files;
13589 
13595  readonly attribute IEventSource eventSource;
13596 
13605  void close();
13606 
13628  void copyFrom (
13629  in wstring source,
13630  in wstring dest,
13631  in CopyFileFlag[] flags,
13632  [retval] out IProgress progress
13633  );
13634 
13656  void copyTo (
13657  in wstring source,
13658  in wstring dest,
13659  in CopyFileFlag[] flags,
13660  [retval] out IProgress progress
13661  );
13662 
13682  void directoryCreate (
13683  in wstring path,
13684  in unsigned long mode,
13685  in DirectoryCreateFlag[] flags
13686  );
13687 
13739  void directoryCreateTemp (
13740  in wstring templateName,
13741  in unsigned long mode,
13742  in wstring path,
13743  in boolean secure,
13744  [retval] out wstring directory
13745  );
13746 
13764  void directoryExists (
13765  in wstring path,
13766  [retval] out boolean exists
13767  );
13768 
13799  void directoryOpen (
13800  in wstring path,
13801  in wstring filter,
13802  in DirectoryOpenFlag[] flags,
13803  [retval] out IGuestDirectory directory
13804  );
13805 
13831  void directoryQueryInfo (
13832  in wstring path,
13833  [retval] out IGuestFsObjInfo info
13834  );
13835 
13843  void directoryRemove (
13844  in wstring path
13845  );
13846 
13860  in wstring path,
13861  in DirectoryRemoveRecFlag[] flags,
13862  [retval] out IProgress progress
13863  );
13864 
13876  void directoryRename (
13877  in wstring source,
13878  in wstring dest,
13879  in PathRenameFlag[] flags
13880  );
13881 
13899  void directorySetACL (
13900  in wstring path,
13901  in wstring acl
13902  );
13903 
13917  void environmentClear();
13918 
13939  void environmentGet (
13940  in wstring name,
13941  [retval] out wstring value
13942  );
13943 
13961  void environmentSet (
13962  in wstring name,
13963  in wstring value
13964  );
13965 
13981  void environmentUnset (
13982  in wstring name
13983  );
13984 
14038  void fileCreateTemp (
14039  in wstring templateName,
14040  in unsigned long mode,
14041  in wstring path,
14042  in boolean secure,
14043  [retval] out IGuestFile file
14044  );
14045 
14063  void fileExists (
14064  in wstring path,
14065  [retval] out boolean exists
14066  );
14067 
14091  void fileRemove (
14092  in wstring path
14093  );
14094 
14156  void fileOpen (
14157  in wstring path,
14158  in wstring openMode,
14159  in wstring disposition,
14160  in unsigned long creationMode,
14161  [retval] out IGuestFile file
14162  );
14163 
14230  void fileOpenEx (
14231  in wstring path,
14232  in wstring openMode,
14233  in wstring disposition,
14234  in wstring sharingMode,
14235  in unsigned long creationMode,
14236  in long long offset,
14237  [retval] out IGuestFile file
14238  );
14239 
14265  void fileQueryInfo (
14266  in wstring path,
14267  [retval] out IGuestFsObjInfo info
14268  );
14269 
14295  void fileQuerySize (
14296  in wstring path,
14297  [retval] out long long size
14298  );
14299 
14311  void fileRename (
14312  in wstring source,
14313  in wstring dest,
14314  in PathRenameFlag[] flags
14315  );
14316 
14334  void fileSetACL (
14335  in wstring file,
14336  in wstring acl
14337  );
14338 
14393  void processCreate (
14394  in wstring command,
14395  in wstring[] arguments,
14396  in wstring[] environment,
14397  in ProcessCreateFlag[] flags,
14398  in unsigned long timeoutMS,
14399  [retval] out IGuestProcess guestProcess
14400  );
14401 
14443  void processCreateEx (
14444  in wstring command,
14445  in wstring[] arguments,
14446  in wstring[] environment,
14447  in ProcessCreateFlag[] flags,
14448  in unsigned long timeoutMS,
14449  in ProcessPriority priority,
14450  in long[] affinity,
14451  [retval] out IGuestProcess guestProcess
14452  );
14453 
14463  void processGet (
14464  in unsigned long pid,
14465  [retval] out IGuestProcess guestProcess
14466  );
14467 
14490  void symlinkCreate (
14491  in wstring source,
14492  in wstring target,
14493  in SymlinkType type
14494  );
14495 
14513  void symlinkExists (
14514  in wstring symlink,
14515  [retval] out boolean exists
14516  );
14517 
14541  void symlinkRead (
14542  in wstring symlink,
14543  in SymlinkReadFlag[] flags,
14544  [retval] out wstring target
14545  );
14546 
14562  void symlinkRemoveDirectory (
14563  in wstring path
14564  );
14565 
14581  void symlinkRemoveFile (
14582  in wstring file
14583  );
14584 
14605  void waitFor (
14606  in unsigned long waitFor,
14607  in unsigned long timeoutMS,
14608  [retval] out GuestSessionWaitResult reason
14609  );
14610 
14632  void waitForArray (
14634  in unsigned long timeoutMS,
14635  [retval] out GuestSessionWaitResult reason
14636  );
14637 
14638 }; /* interface IGuestSession */
14639 
14647 interface IProcess : $unknown
14648 {
14654  readonly attribute wstring[] arguments;
14655 
14661  readonly attribute wstring[] environment;
14662 
14668  readonly attribute IEventSource eventSource;
14669 
14673  readonly attribute wstring executablePath;
14674 
14681  readonly attribute long exitCode;
14682 
14688  readonly attribute wstring name;
14689 
14695  readonly attribute unsigned long PID;
14696 
14703  readonly attribute ProcessStatus status;
14704 
14725  void waitFor (
14726  in unsigned long waitFor,
14727  in unsigned long timeoutMS,
14728  [retval] out ProcessWaitResult reason
14729  );
14730 
14752  void waitForArray (
14754  in unsigned long timeoutMS,
14755  [retval] out ProcessWaitResult reason
14756  );
14757 
14774  void read (
14775  in unsigned long handle,
14776  in unsigned long toRead,
14777  in unsigned long timeoutMS,
14778  [retval] out octet[] data
14779  );
14780 
14804  void write (
14805  in unsigned long handle,
14806  in unsigned long flags,
14807  in octet[] data,
14808  in unsigned long timeoutMS,
14809  [retval] out unsigned long written
14810  );
14811 
14836  void writeArray (
14837  in unsigned long handle,
14838  in ProcessInputFlag[] flags,
14839  in octet[] data,
14840  in unsigned long timeoutMS,
14841  [retval] out unsigned long written
14842  );
14843 
14853  void terminate();
14854 
14855 }; /* interface IProcess */
14856 
14866 {
14867 }; /* interface IGuestProcess */
14868 
14876 interface IDirectory : $unknown
14877 {
14883  readonly attribute wstring directoryName;
14884 
14890  readonly attribute wstring filter;
14891 
14898  void close();
14899 
14915  void read (
14916  [retval] out IFsObjInfo objInfo
14917  );
14918 
14919 }; /* interface IDirectory */
14920 
14930 {
14931 }; /* interface IGuestDirectory */
14932 
14940 interface IFile : $unknown
14941 {
14947  readonly attribute unsigned long creationMode;
14948 
14954  readonly attribute wstring disposition;
14955 
14961  readonly attribute IEventSource eventSource;
14962 
14968  readonly attribute wstring fileName;
14969 
14975  readonly attribute unsigned long id;
14976 
14982  readonly attribute long long initialSize;
14983 
14989  readonly attribute wstring openMode;
14990 
14996  readonly attribute long long offset;
14997 
15003  readonly attribute FileStatus status;
15004 
15011  void close();
15012 
15029  void queryInfo (
15030  [retval] out IFsObjInfo objInfo
15031  );
15032 
15055  void read (
15056  in unsigned long toRead,
15057  in unsigned long timeoutMS,
15058  [retval] out octet[] data
15059  );
15060 
15085  void readAt (
15086  in long long offset,
15087  in unsigned long toRead,
15088  in unsigned long timeoutMS,
15089  [retval] out octet[] data
15090  );
15091 
15111  void seek (
15112  in long long offset,
15113  in FileSeekType whence
15114  );
15115 
15131  void setACL (
15132  in wstring acl
15133  );
15134 
15152  void write (
15153  in octet[] data,
15154  in unsigned long timeoutMS,
15155  [retval] out unsigned long written
15156  );
15157 
15185  void writeAt (
15186  in long long offset,
15187  in octet[] data,
15188  in unsigned long timeoutMS,
15189  [retval] out unsigned long written
15190  );
15191 
15192 }; /* interface IFile */
15193 
15202 interface IGuestFile : IFile
15203 {
15204 }; /* interface IGuestFile */
15205 
15214 interface IFsObjInfo : $unknown
15215 {
15221  readonly attribute long long accessTime;
15222 
15228  readonly attribute long long allocatedSize;
15229 
15235  readonly attribute long long birthTime;
15236 
15242  readonly attribute long long changeTime;
15243 
15249  readonly attribute unsigned long deviceNumber;
15250 
15256  readonly attribute wstring fileAttributes;
15257 
15263  readonly attribute unsigned long generationId;
15264 
15270  readonly attribute unsigned long GID;
15271 
15277  readonly attribute wstring groupName;
15278 
15284  readonly attribute unsigned long hardLinks;
15285 
15291  readonly attribute long long modificationTime;
15292 
15298  readonly attribute wstring name;
15299 
15305  readonly attribute long long nodeId;
15306 
15312  readonly attribute unsigned long nodeIdDevice;
15313 
15321  readonly attribute long long objectSize;
15322 
15328  readonly attribute FsObjType type;
15329 
15335  readonly attribute unsigned long UID;
15336 
15342  readonly attribute unsigned long userFlags;
15343 
15349  readonly attribute wstring userName;
15350 
15351 }; /* interface IFsObjInfo */
15352 
15362 {
15363 }; /* interface IGuestFsObjInfo */
15364 
15378 interface IGuest : $unknown
15379 {
15394  readonly attribute wstring OSTypeId;
15395 
15402 
15409  readonly attribute wstring additionsVersion;
15410 
15418  readonly attribute unsigned long additionsRevision;
15419 
15425  readonly attribute IEventSource eventSource;
15426 
15433  readonly attribute IAdditionsFacility[] facilities;
15434 
15438  readonly attribute IGuestSession[] sessions;
15439 
15443  attribute unsigned long memoryBalloonSize;
15444 
15448  attribute unsigned long statisticsUpdateInterval;
15449 
15481  void internalGetStatistics (
15482  out unsigned long cpuUser,
15483  out unsigned long cpuKernel,
15484  out unsigned long cpuIdle,
15485  out unsigned long memTotal,
15486  out unsigned long memFree,
15487  out unsigned long memBalloon,
15488  out unsigned long memShared,
15489  out unsigned long memCache,
15490  out unsigned long pagedTotal,
15491  out unsigned long memAllocTotal,
15492  out unsigned long memFreeTotal,
15493  out unsigned long memBalloonTotal,
15494  out unsigned long memSharedTotal
15495  );
15496 
15508  void getFacilityStatus (
15509  in AdditionsFacilityType facility,
15510  out long long timestamp,
15511  [retval] out AdditionsFacilityStatus status
15512  );
15513 
15531  void getAdditionsStatus (
15532  in AdditionsRunLevelType level,
15533  [retval] out boolean active
15534  );
15535 
15565  void setCredentials (
15566  in wstring userName,
15567  in wstring password,
15568  in wstring domain,
15569  in boolean allowInteractiveLogon
15570  );
15571 
15601  void dragHGEnter (
15602  in unsigned long screenId,
15603  in unsigned long y,
15604  in unsigned long x,
15605  in DragAndDropAction defaultAction,
15606  in DragAndDropAction[] allowedActions,
15607  in wstring[] formats,
15608  [retval] out DragAndDropAction resultAction
15609  );
15610 
15640  void dragHGMove (
15641  in unsigned long screenId,
15642  in unsigned long x,
15643  in unsigned long y,
15644  in DragAndDropAction defaultAction,
15645  in DragAndDropAction[] allowedActions,
15646  in wstring[] formats,
15647  [retval] out DragAndDropAction resultAction
15648  );
15649 
15667  void dragHGLeave (
15668  in unsigned long screenId
15669  );
15670 
15702  void dragHGDrop (
15703  in unsigned long screenId,
15704  in unsigned long x,
15705  in unsigned long y,
15706  in DragAndDropAction defaultAction,
15707  in DragAndDropAction[] allowedActions,
15708  in wstring[] formats,
15709  out wstring format,
15710  [retval] out DragAndDropAction resultAction
15711  );
15712 
15736  void dragHGPutData (
15737  in unsigned long screenId,
15738  in wstring format,
15739  in octet[] data,
15740  [retval] out IProgress progress
15741  );
15742 
15768  void dragGHPending (
15769  in unsigned long screenId,
15770  out wstring[] formats,
15771  out DragAndDropAction[] allowedActions,
15772  [retval] out DragAndDropAction defaultAction
15773  );
15774 
15796  void dragGHDropped (
15797  in wstring format,
15798  in DragAndDropAction action,
15799  [retval] out IProgress progress
15800  );
15801 
15819  void dragGHGetData (
15820  [retval] out octet[] data
15821  );
15822 
15885  void createSession (
15886  in wstring user,
15887  in wstring password,
15888  in wstring domain,
15889  in wstring sessionName,
15890  [retval] out IGuestSession guestSession
15891  );
15892 
15907  void findSession (
15908  in wstring sessionName,
15909  [retval] out IGuestSession[] sessions
15910  );
15911 
15961  void updateGuestAdditions (
15962  in wstring source,
15963  in wstring[] arguments,
15964  in AdditionsUpdateFlag[] flags,
15965  [retval] out IProgress progress
15966  );
15967 
15968 }; /* interface IGuest */
15969 
16010 interface IProgress : $unknown
16011 {
16015  readonly attribute wstringUUID id;
16016 
16020  readonly attribute wstring description;
16021 
16025  readonly attribute $unknown initiator;
16026 
16030  readonly attribute boolean cancelable;
16031 
16039  readonly attribute unsigned long percent;
16040 
16054  readonly attribute long timeRemaining;
16055 
16059  readonly attribute boolean completed;
16060 
16064  readonly attribute boolean canceled;
16065 
16072  readonly attribute long resultCode;
16073 
16083  readonly attribute IVirtualBoxErrorInfo errorInfo;
16084 
16091  readonly attribute unsigned long operationCount;
16092 
16096  readonly attribute unsigned long operation;
16097 
16103  readonly attribute wstring operationDescription;
16104 
16108  readonly attribute unsigned long operationPercent;
16109 
16113  readonly attribute unsigned long operationWeight;
16114 
16122  attribute unsigned long timeout;
16123 
16128  in unsigned long percent
16129  );
16130 
16134  void setNextOperation (
16135  in wstring nextOperationDescription,
16136  in unsigned long nextOperationsWeight
16137  );
16138 
16165  void waitForCompletion (
16166  in long timeout
16167  );
16168 
16193  in unsigned long operation,
16194  in long timeout
16195  );
16196 
16223  in IProgress pProgressAsync
16224  );
16225 
16242  void cancel();
16243 
16244 }; /* interface IProgress */
16245 
16329 interface ISnapshot : $unknown
16330 {
16334  readonly attribute wstringUUID id;
16335 
16343  attribute wstring name;
16344 
16352  attribute wstring description;
16353 
16359  readonly attribute long long timeStamp;
16360 
16372  readonly attribute boolean online;
16373 
16385  readonly attribute IMachine machine;
16386 
16393  readonly attribute ISnapshot parent;
16394 
16403  readonly attribute ISnapshot[] children;
16404 
16412  void getChildrenCount (
16413  [retval] out unsigned long childrenCount
16414  );
16415 
16416 }; /* interface ISnapshot */
16417 
16604 interface IMediumAttachment : $unknown
16605 {
16610  readonly attribute IMedium medium;
16611 
16617  readonly attribute wstring controller;
16618 
16624  readonly attribute long port;
16625 
16631  readonly attribute long device;
16632 
16636  readonly attribute DeviceType type;
16637 
16641  readonly attribute boolean passthrough;
16642 
16646  readonly attribute boolean temporaryEject;
16647 
16652  readonly attribute boolean isEjected;
16653 
16657  readonly attribute boolean nonRotational;
16658 
16662  readonly attribute boolean discard;
16663 
16667  readonly attribute boolean hotPluggable;
16668 
16672  readonly attribute IBandwidthGroup bandwidthGroup;
16673 
16674 }; /* interface IMediumAttachment */
16675 
16833 interface IMedium : $unknown
16834 {
16848  readonly attribute wstringUUID id;
16849 
16868  attribute wstring description;
16869 
16885  readonly attribute MediumState state;
16886 
16895  readonly attribute MediumVariant[] variant;
16896 
16906  readonly attribute wstring location;
16907 
16927  readonly attribute wstring name;
16928 
16933  readonly attribute DeviceType deviceType;
16934 
16938  readonly attribute boolean hostDrive;
16939 
16952  readonly attribute long long size;
16953 
16968  readonly attribute wstring format;
16969 
16985  readonly attribute IMediumFormat mediumFormat;
16986 
17011  attribute MediumType type;
17012 
17026  readonly attribute MediumType[] allowedTypes;
17027 
17037  readonly attribute IMedium parent;
17038 
17046  readonly attribute IMedium[] children;
17047 
17058  readonly attribute IMedium base;
17059 
17092  readonly attribute boolean readOnly;
17093 
17109  readonly attribute long long logicalSize;
17110 
17138  attribute boolean autoReset;
17139 
17154  readonly attribute wstring lastAccessError;
17155 
17172  readonly attribute wstringUUID[] machineIds;
17173 
17199  void setIds (
17200  in boolean setImageId,
17201  in wstringUUID imageId,
17202  in boolean setParentId,
17203  in wstringUUID parentId
17204  );
17205 
17240  void refreshState (
17241  [retval] out MediumState state
17242  );
17243 
17270  void getSnapshotIds (
17271  in wstringUUID machineId,
17272  [retval] out wstringUUID[] snapshotIds
17273  );
17274 
17337  void lockRead (
17338  [retval] out IToken token
17339  );
17340 
17395  void lockWrite (
17396  [retval] out IToken token
17397  );
17398 
17448  void close();
17449 
17479  void getProperty (
17480  in wstring name,
17481  [retval] out wstring value
17482  );
17483 
17515  void setProperty (
17516  in wstring name,
17517  in wstring value
17518  );
17519 
17554  void getProperties (
17555  in wstring names,
17556  out wstring[] returnNames,
17557  [retval] out wstring[] returnValues
17558  );
17559 
17589  void setProperties (
17590  in wstring[] names,
17591  in wstring[] values
17592  );
17593 
17626  void createBaseStorage (
17627  in long long logicalSize,
17628  in MediumVariant[] variant,
17629  [retval] out IProgress progress
17630  );
17631 
17683  void deleteStorage (
17684  [retval] out IProgress progress
17685  );
17686 
17725  void createDiffStorage (
17726  in IMedium target,
17727  in MediumVariant[] variant,
17728  [retval] out IProgress progress
17729  );
17730 
17806  void mergeTo (
17807  in IMedium target,
17808  [retval] out IProgress progress
17809  );
17810 
17860  void cloneTo (
17861  in IMedium target,
17862  in MediumVariant[] variant,
17863  in IMedium parent,
17864  [retval] out IProgress progress
17865  );
17866 
17913  void cloneToBase (
17914  in IMedium target,
17915  in MediumVariant[] variant,
17916  [retval] out IProgress progress
17917  );
17918 
17960  void setLocation (
17961  in wstring location,
17962  [retval] out IProgress progress
17963  );
17964 
17993  void compact (
17994  [retval] out IProgress progress
17995  );
17996 
18029  void resize (
18030  in long long logicalSize,
18031  [retval] out IProgress progress
18032  );
18033 
18067  void reset (
18068  [retval] out IProgress progress
18069  );
18070 
18071 }; /* interface IMedium */
18072 
18095 interface IMediumFormat : $unknown
18096 {
18115  readonly attribute wstring id;
18116 
18124  readonly attribute wstring name;
18125 
18135 
18154  void describeFileExtensions (
18155  out wstring[] extensions,
18156  out DeviceType[] types
18157  );
18158 
18186  void describeProperties (
18187  out wstring[] names,
18188  out wstring[] descriptions,
18189  out DataType[] types,
18190  out unsigned long[] flags,
18191  out wstring[] defaults
18192  );
18193 
18194 }; /* interface IMediumFormat */
18195 
18210 interface IToken : $unknown
18211 {
18220  void abandon();
18221 
18228  void dummy();
18229 
18230 }; /* interface IToken */
18231 
18243 interface IKeyboard : $unknown
18244 {
18250  readonly attribute IEventSource eventSource;
18251 
18264  void putScancode (
18265  in long scancode
18266  );
18267 
18280  void putScancodes (
18281  in long[] scancodes,
18282  [retval] out unsigned long codesStored
18283  );
18284 
18299  void putCAD();
18300 
18301 }; /* interface IKeyboard */
18302 
18314 interface IMouse : $unknown
18315 {
18330  readonly attribute boolean absoluteSupported;
18331 
18346  readonly attribute boolean relativeSupported;
18347 
18361  readonly attribute boolean multiTouchSupported;
18362 
18377  readonly attribute boolean needsHostCursor;
18378 
18384  readonly attribute IEventSource eventSource;
18385 
18451  void putMouseEvent (
18452  in long dx,
18453  in long dy,
18454  in long dz,
18455  in long dw,
18456  in long buttonState
18457  );
18458 
18531  void putMouseEventAbsolute (
18532  in long x,
18533  in long y,
18534  in long dz,
18535  in long dw,
18536  in long buttonState
18537  );
18538 
18586  void putEventMultiTouch (
18587  in long count,
18588  in long long[] contacts,
18589  in unsigned long scanTime
18590  );
18591 
18608  in long count,
18609  in wstring contacts,
18610  in unsigned long scanTime
18611  );
18612 
18613 }; /* interface IMouse */
18614 
18615 interface IFramebuffer : $unknown
18616 {
18625  readonly attribute octetPtr address;
18626 
18630  readonly attribute unsigned long width;
18631 
18635  readonly attribute unsigned long height;
18636 
18643  readonly attribute unsigned long bitsPerPixel;
18644 
18651  readonly attribute unsigned long bytesPerLine;
18652 
18663  readonly attribute unsigned long pixelFormat;
18664 
18671  readonly attribute boolean usesGuestVRAM;
18672 
18682  readonly attribute unsigned long heightReduction;
18683 
18698  readonly attribute IFramebufferOverlay overlay;
18699 
18706  readonly attribute long long winId;
18707 
18715  void lock();
18716 
18724  void unlock();
18725 
18733  void notifyUpdate (
18734  in unsigned long x,
18735  in unsigned long y,
18736  in unsigned long width,
18737  in unsigned long height
18738  );
18739 
18852  void requestResize (
18853  in unsigned long screenId,
18854  in unsigned long pixelFormat,
18855  in octetPtr VRAM,
18856  in unsigned long bitsPerPixel,
18857  in unsigned long bytesPerLine,
18858  in unsigned long width,
18859  in unsigned long height,
18860  [retval] out boolean finished
18861  );
18862 
18874  void videoModeSupported (
18875  in unsigned long width,
18876  in unsigned long height,
18877  in unsigned long bpp,
18878  [retval] out boolean supported
18879  );
18880 
18917  void getVisibleRegion (
18918  in octetPtr rectangles,
18919  in unsigned long count,
18920  [retval] out unsigned long countCopied
18921  );
18922 
18957  void setVisibleRegion (
18958  in octetPtr rectangles,
18959  in unsigned long count
18960  );
18961 
18982  void processVHWACommand (
18983  in octetPtr command
18984  );
18985 
19000  void notify3DEvent (
19001  in unsigned long type,
19002  in octetPtr data
19003  );
19004 
19005 }; /* interface IFramebuffer */
19006 
19022 {
19026  readonly attribute unsigned long x;
19027 
19031  readonly attribute unsigned long y;
19032 
19038  attribute boolean visible;
19039 
19046  attribute unsigned long alpha;
19047 
19053  void move (
19054  in unsigned long x,
19055  in unsigned long y
19056  );
19057 
19058 }; /* interface IFramebufferOverlay */
19059 
19075 interface IDisplay : $unknown
19076 {
19080  void getScreenResolution (
19081  in unsigned long screenId,
19082  out unsigned long width,
19083  out unsigned long height,
19084  out unsigned long bitsPerPixel,
19085  out long xOrigin,
19086  out long yOrigin
19087  );
19088 
19094  void setFramebuffer (
19095  in unsigned long screenId,
19096  in IFramebuffer framebuffer
19097  );
19098 
19104  void getFramebuffer (
19105  in unsigned long screenId,
19106  out IFramebuffer framebuffer,
19107  out long xOrigin,
19108  out long yOrigin
19109  );
19110 
19161  void setVideoModeHint (
19162  in unsigned long display,
19163  in boolean enabled,
19164  in boolean changeOrigin,
19165  in long originX,
19166  in long originY,
19167  in unsigned long width,
19168  in unsigned long height,
19169  in unsigned long bitsPerPixel
19170  );
19171 
19183  void setSeamlessMode (
19184  in boolean enabled
19185  );
19186 
19222  void takeScreenShot (
19223  in unsigned long screenId,
19224  in octetPtr address,
19225  in unsigned long width,
19226  in unsigned long height
19227  );
19228 
19272  void takeScreenShotToArray (
19273  in unsigned long screenId,
19274  in unsigned long width,
19275  in unsigned long height,
19276  [retval] out octet[] screenData
19277  );
19278 
19318  in unsigned long screenId,
19319  in unsigned long width,
19320  in unsigned long height,
19321  [retval] out octet[] screenData
19322  );
19323 
19375  void drawToScreen (
19376  in unsigned long screenId,
19377  in octetPtr address,
19378  in unsigned long x,
19379  in unsigned long y,
19380  in unsigned long width,
19381  in unsigned long height
19382  );
19383 
19398  void invalidateAndUpdate();
19399 
19413  void resizeCompleted (
19414  in unsigned long screenId
19415  );
19416 
19429  void completeVHWACommand (
19430  in octetPtr command
19431  );
19432 
19466  void viewportChanged (
19467  in unsigned long screenId,
19468  in unsigned long x,
19469  in unsigned long y,
19470  in unsigned long width,
19471  in unsigned long height
19472  );
19473 
19474 }; /* interface IDisplay */
19475 
19491 interface INetworkAdapter : $unknown
19492 {
19501 
19509  readonly attribute unsigned long slot;
19510 
19519  attribute boolean enabled;
19520 
19527  attribute wstring MACAddress;
19528 
19535 
19541  attribute wstring bridgedInterface;
19542 
19548  attribute wstring hostOnlyInterface;
19549 
19555  attribute wstring internalNetwork;
19556 
19562  attribute wstring NATNetwork;
19563 
19569  attribute wstring genericDriver;
19570 
19577  attribute boolean cableConnected;
19578 
19584  attribute unsigned long lineSpeed;
19585 
19593 
19600  attribute boolean traceEnabled;
19601 
19608  attribute wstring traceFile;
19609 
19617  readonly attribute INATEngine NATEngine;
19618 
19625  attribute unsigned long bootPriority;
19626 
19631 
19650  void getProperty (
19651  in wstring key,
19652  [retval] out wstring value
19653  );
19654 
19673  void setProperty (
19674  in wstring key,
19675  in wstring value
19676  );
19677 
19705  void getProperties (
19706  in wstring names,
19707  out wstring[] returnNames,
19708  [retval] out wstring[] returnValues
19709  );
19710 
19711 }; /* interface INetworkAdapter */
19712 
19741 interface ISerialPort : $unknown
19742 {
19750  readonly attribute unsigned long slot;
19751 
19758  attribute boolean enabled;
19759 
19763  attribute unsigned long IOBase;
19764 
19768  attribute unsigned long IRQ;
19769 
19780  attribute PortMode hostMode;
19781 
19789  attribute boolean server;
19790 
19800  attribute wstring path;
19801 
19802 }; /* interface ISerialPort */
19803 
19823 interface IParallelPort : $unknown
19824 {
19832  readonly attribute unsigned long slot;
19833 
19840  attribute boolean enabled;
19841 
19845  attribute unsigned long IOBase;
19846 
19850  attribute unsigned long IRQ;
19851 
19859  attribute wstring path;
19860 
19861 }; /* interface IParallelPort */
19862 
19863 interface IMachineDebugger : $unknown
19864 {
19868  attribute boolean singleStep;
19869 
19873  attribute boolean recompileUser;
19874 
19878  attribute boolean recompileSupervisor;
19879 
19887  attribute boolean executeAllInIEM;
19888 
19892  attribute boolean PATMEnabled;
19893 
19897  attribute boolean CSAMEnabled;
19898 
19902  attribute boolean logEnabled;
19903 
19907  readonly attribute wstring logDbgFlags;
19908 
19912  readonly attribute wstring logDbgGroups;
19913 
19917  readonly attribute wstring logDbgDestinations;
19918 
19922  readonly attribute wstring logRelFlags;
19923 
19927  readonly attribute wstring logRelGroups;
19928 
19932  readonly attribute wstring logRelDestinations;
19933 
19940  readonly attribute boolean HWVirtExEnabled;
19941 
19948  readonly attribute boolean HWVirtExNestedPagingEnabled;
19949 
19956  readonly attribute boolean HWVirtExVPIDEnabled;
19957 
19964  readonly attribute boolean HWVirtExUXEnabled;
19965 
19974  readonly attribute wstring OSName;
19975 
19984  readonly attribute wstring OSVersion;
19985 
19992  readonly attribute boolean PAEEnabled;
19993 
20000  attribute unsigned long virtualTimeRate;
20001 
20009  readonly attribute long long VM;
20010 
20026  void dumpGuestCore (
20027  in wstring filename,
20028  in wstring compression
20029  );
20030 
20047  void dumpHostProcessCore (
20048  in wstring filename,
20049  in wstring compression
20050  );
20051 
20072  void info (
20073  in wstring name,
20074  in wstring args,
20075  [retval] out wstring info
20076  );
20077 
20083  void injectNMI();
20084 
20095  void modifyLogGroups (
20096  in wstring settings
20097  );
20098 
20109  void modifyLogFlags (
20110  in wstring settings
20111  );
20112 
20123  void modifyLogDestinations (
20124  in wstring settings
20125  );
20126 
20141  void readPhysicalMemory (
20142  in long long address,
20143  in unsigned long size,
20144  [retval] out octet[] bytes
20145  );
20146 
20161  void writePhysicalMemory (
20162  in long long address,
20163  in unsigned long size,
20164  in octet[] bytes
20165  );
20166 
20183  void readVirtualMemory (
20184  in unsigned long cpuId,
20185  in long long address,
20186  in unsigned long size,
20187  [retval] out octet[] bytes
20188  );
20189 
20206  void writeVirtualMemory (
20207  in unsigned long cpuId,
20208  in long long address,
20209  in unsigned long size,
20210  in octet[] bytes
20211  );
20212 
20225  void detectOS (
20226  [retval] out wstring os
20227  );
20228 
20246  void getRegister (
20247  in unsigned long cpuId,
20248  in wstring name,
20249  [retval] out wstring value
20250  );
20251 
20269  void getRegisters (
20270  in unsigned long cpuId,
20271  out wstring[] names,
20272  out wstring[] values
20273  );
20274 
20293  void setRegister (
20294  in unsigned long cpuId,
20295  in wstring name,
20296  in wstring value
20297  );
20298 
20317  void setRegisters (
20318  in unsigned long cpuId,
20319  in wstring[] names,
20320  in wstring[] values
20321  );
20322 
20335  void dumpGuestStack (
20336  in unsigned long cpuId,
20337  [retval] out wstring stack
20338  );
20339 
20347  void resetStats (
20348  in wstring pattern
20349  );
20350 
20358  void dumpStats (
20359  in wstring pattern
20360  );
20361 
20373  void getStats (
20374  in wstring pattern,
20375  in boolean withDescriptions,
20376  [retval] out wstring stats
20377  );
20378 
20379 }; /* interface IMachineDebugger */
20380 
20381 interface IUSBDeviceFilters : $unknown
20382 {
20408  readonly attribute IUSBDeviceFilter[] deviceFilters;
20409 
20437  void createDeviceFilter (
20438  in wstring name,
20439  [retval] out IUSBDeviceFilter filter
20440  );
20441 
20486  void insertDeviceFilter (
20487  in unsigned long position,
20488  in IUSBDeviceFilter filter
20489  );
20490 
20523  void removeDeviceFilter (
20524  in unsigned long position,
20525  [retval] out IUSBDeviceFilter filter
20526  );
20527 
20528 }; /* interface IUSBDeviceFilters */
20529 
20530 interface IUSBController : $unknown
20531 {
20537  readonly attribute wstring name;
20538 
20544  readonly attribute USBControllerType type;
20545 
20553  readonly attribute unsigned short USBStandard;
20554 
20555 }; /* interface IUSBController */
20556 
20569 interface IUSBDevice : $unknown
20570 {
20577  readonly attribute wstringUUID id;
20578 
20582  readonly attribute unsigned short vendorId;
20583 
20587  readonly attribute unsigned short productId;
20588 
20596  readonly attribute unsigned short revision;
20597 
20601  readonly attribute wstring manufacturer;
20602 
20606  readonly attribute wstring product;
20607 
20611  readonly attribute wstring serialNumber;
20612 
20616  readonly attribute wstring address;
20617 
20624  readonly attribute unsigned short port;
20625 
20631  readonly attribute unsigned short version;
20632 
20640  readonly attribute unsigned short portVersion;
20641 
20648  readonly attribute boolean remote;
20649 
20650 }; /* interface IUSBDevice */
20651 
20726 interface IUSBDeviceFilter : $unknown
20727 {
20735  attribute wstring name;
20736 
20740  attribute boolean active;
20741 
20749  attribute wstring vendorId;
20750 
20758  attribute wstring productId;
20759 
20773  attribute wstring revision;
20774 
20779  attribute wstring manufacturer;
20780 
20785  attribute wstring product;
20786 
20791  attribute wstring serialNumber;
20792 
20797  attribute wstring port;
20798 
20808  attribute wstring remote;
20809 
20819  attribute unsigned long maskedInterfaces;
20820 
20821 }; /* interface IUSBDeviceFilter */
20822 
20840 {
20846  readonly attribute USBDeviceState state;
20847 
20848 }; /* interface IHostUSBDevice */
20849 
20873 {
20881 
20882 }; /* interface IHostUSBDeviceFilter */
20883 
20892 interface IAudioAdapter : $unknown
20893 {
20902  attribute boolean enabled;
20903 
20910 
20918 
20919 }; /* interface IAudioAdapter */
20920 
20921 interface IVRDEServer : $unknown
20922 {
20926  attribute boolean enabled;
20927 
20931  attribute AuthType authType;
20932 
20936  attribute unsigned long authTimeout;
20937 
20944  attribute boolean allowMultiConnection;
20945 
20953  attribute boolean reuseSingleConnection;
20954 
20961  attribute wstring VRDEExtPack;
20962 
20969  attribute wstring authLibrary;
20970 
20976  readonly attribute wstring[] VRDEProperties;
20977 
20991  void setVRDEProperty (
20992  in wstring key,
20993  in wstring value
20994  );
20995 
21009  void getVRDEProperty (
21010  in wstring key,
21011  [retval] out wstring value
21012  );
21013 
21014 }; /* interface IVRDEServer */
21015 
21073 interface ISharedFolder : $unknown
21074 {
21078  readonly attribute wstring name;
21079 
21083  readonly attribute wstring hostPath;
21084 
21094  readonly attribute boolean accessible;
21095 
21102  readonly attribute boolean writable;
21103 
21109  readonly attribute boolean autoMount;
21110 
21123  readonly attribute wstring lastAccessError;
21124 
21125 }; /* interface ISharedFolder */
21126 
21127 interface IInternalSessionControl : $unknown
21128 {
21133  void getPID (
21134  [retval] out unsigned long pid
21135  );
21136 
21158  void getRemoteConsole (
21159  [retval] out IConsole console
21160  );
21161 
21176  void assignRemoteMachine (
21177  in IMachine machine,
21178  in IConsole console
21179  );
21180 
21204  void updateMachineState (
21205  in MachineState machineState
21206  );
21207 
21223  void uninitialize();
21224 
21247  void onNetworkAdapterChange (
21248  in INetworkAdapter networkAdapter,
21249  in boolean changeAdapter
21250  );
21251 
21274  void onSerialPortChange (
21275  in ISerialPort serialPort
21276  );
21277 
21300  void onParallelPortChange (
21301  in IParallelPort parallelPort
21302  );
21303 
21327 
21354  void onMediumChange (
21355  in IMediumAttachment mediumAttachment,
21356  in boolean force
21357  );
21358 
21388  void onStorageDeviceChange (
21389  in IMediumAttachment mediumAttachment,
21390  in boolean remove,
21391  in boolean silent
21392  );
21393 
21401  void onClipboardModeChange (
21402  in ClipboardMode clipboardMode
21403  );
21404 
21413  in DragAndDropMode dragAndDropMode
21414  );
21415 
21425  void onCPUChange (
21426  in unsigned long cpu,
21427  in boolean add
21428  );
21429 
21438  in unsigned long executionCap
21439  );
21440 
21465  void onVRDEServerChange (
21466  in boolean restart
21467  );
21468 
21474  void onVideoCaptureChange();
21475 
21498  void onUSBControllerChange();
21499 
21528  void onSharedFolderChange (
21529  in boolean global
21530  );
21531 
21557  void onUSBDeviceAttach (
21558  in IUSBDevice device,
21559  in IVirtualBoxErrorInfo error,
21560  in unsigned long maskedInterfaces
21561  );
21562 
21588  void onUSBDeviceDetach (
21589  in wstringUUID id,
21590  in IVirtualBoxErrorInfo error
21591  );
21592 
21610  void onShowWindow (
21611  in boolean check,
21612  out boolean canShow,
21613  out long long winId
21614  );
21615 
21623  void onBandwidthGroupChange (
21624  in IBandwidthGroup bandwidthGroup
21625  );
21626 
21650  void accessGuestProperty (
21651  in wstring name,
21652  in wstring value,
21653  in wstring flags,
21654  in boolean isSetter,
21655  out wstring retValue,
21656  out long long retTimestamp,
21657  out wstring retFlags
21658  );
21659 
21708  in wstring patterns,
21709  out wstring[] keys,
21710  out wstring[] values,
21711  out long long[] timestamps,
21712  out wstring[] flags
21713  );
21714 
21749  void onlineMergeMedium (
21750  in IMediumAttachment mediumAttachment,
21751  in unsigned long sourceIdx,
21752  in unsigned long targetIdx,
21753  in IProgress progress
21754  );
21755 
21779  void enableVMMStatistics (
21780  in boolean enable
21781  );
21782 
21810  void pauseWithReason (
21811  in Reason reason
21812  );
21813 
21841  void resumeWithReason (
21842  in Reason reason
21843  );
21844 
21874  void saveStateWithReason (
21875  in Reason reason,
21876  [retval] out IProgress progress
21877  );
21878 
21902  void assignMachine (
21903  in IMachine machine,
21904  in LockType lockType,
21905  in wstring tokenId
21906  );
21907 
21931  void assignMachine (
21932  in IMachine machine,
21933  in LockType lockType,
21934  in IToken token
21935  );
21936 
21937 }; /* interface IInternalSessionControl */
21938 
21997 interface ISession : $unknown
21998 {
22002  readonly attribute SessionState state;
22003 
22011  readonly attribute SessionType type;
22012 
22016  readonly attribute IMachine machine;
22017 
22021  readonly attribute IConsole console;
22022 
22054  void unlockMachine();
22055 
22056 }; /* interface ISession */
22057 
22080 interface IStorageController : $unknown
22081 {
22090  readonly attribute wstring name;
22091 
22097  readonly attribute unsigned long maxDevicesPerPortCount;
22098 
22104  readonly attribute unsigned long minPortCount;
22105 
22111  readonly attribute unsigned long maxPortCount;
22112 
22118  attribute unsigned long instance;
22119 
22128  attribute unsigned long portCount;
22129 
22135  readonly attribute StorageBus bus;
22136 
22150 
22165  attribute boolean useHostIOCache;
22166 
22172  readonly attribute boolean bootable;
22173 
22174 }; /* interface IStorageController */
22175 
22199 interface IManagedObjectRef : $unknown
22200 {
22207  void getInterfaceName (
22208  [retval] out wstring return
22209  );
22210 
22218  void release();
22219 
22220 }; /* interface IManagedObjectRef */
22221 
22230 interface IWebsessionManager : $unknown
22231 {
22240  void logon (
22241  in wstring username,
22242  in wstring password,
22243  [retval] out IVirtualBox return
22244  );
22245 
22255  void getSessionObject (
22256  in IVirtualBox refIVirtualBox,
22257  [retval] out ISession return
22258  );
22259 
22267  void logoff (
22268  in IVirtualBox refIVirtualBox
22269  );
22270 
22271 }; /* interface IWebsessionManager */
22272 
22281 interface IPerformanceMetric : $unknown
22282 {
22288  readonly attribute wstring metricName;
22289 
22295  readonly attribute $unknown object;
22296 
22302  readonly attribute wstring description;
22303 
22309  readonly attribute unsigned long period;
22310 
22320  readonly attribute unsigned long count;
22321 
22327  readonly attribute wstring unit;
22328 
22334  readonly attribute long minimumValue;
22335 
22341  readonly attribute long maximumValue;
22342 
22343 }; /* interface IPerformanceMetric */
22344 
22451 interface IPerformanceCollector : $unknown
22452 {
22463  readonly attribute wstring[] metricNames;
22464 
22488  void getMetrics (
22489  in wstring[] metricNames,
22490  in $unknown[] objects,
22491  [retval] out IPerformanceMetric[] metrics
22492  );
22493 
22532  void setupMetrics (
22533  in wstring[] metricNames,
22534  in $unknown[] objects,
22535  in unsigned long period,
22536  in unsigned long count,
22537  [retval] out IPerformanceMetric[] affectedMetrics
22538  );
22539 
22568  void enableMetrics (
22569  in wstring[] metricNames,
22570  in $unknown[] objects,
22571  [retval] out IPerformanceMetric[] affectedMetrics
22572  );
22573 
22602  void disableMetrics (
22603  in wstring[] metricNames,
22604  in $unknown[] objects,
22605  [retval] out IPerformanceMetric[] affectedMetrics
22606  );
22607 
22697  void queryMetricsData (
22698  in wstring[] metricNames,
22699  in $unknown[] objects,
22700  out wstring[] returnMetricNames,
22701  out $unknown[] returnObjects,
22702  out wstring[] returnUnits,
22703  out unsigned long[] returnScales,
22704  out unsigned long[] returnSequenceNumbers,
22705  out unsigned long[] returnDataIndices,
22706  out unsigned long[] returnDataLengths,
22707  [retval] out long[] returnData
22708  );
22709 
22710 }; /* interface IPerformanceCollector */
22711 
22719 interface INATEngine : $unknown
22720 {
22725  attribute wstring network;
22726 
22733  attribute wstring hostIP;
22734 
22739  attribute wstring TFTPPrefix;
22740 
22745  attribute wstring TFTPBootFile;
22746 
22754  attribute wstring TFTPNextServer;
22755 
22759  attribute unsigned long aliasMode;
22760 
22764  attribute boolean DNSPassDomain;
22765 
22770  attribute boolean DNSProxy;
22771 
22776  attribute boolean DNSUseHostResolver;
22777 
22782  readonly attribute wstring[] redirects;
22783 
22799  void setNetworkSettings (
22800  in unsigned long mtu,
22801  in unsigned long sockSnd,
22802  in unsigned long sockRcv,
22803  in unsigned long TcpWndSnd,
22804  in unsigned long TcpWndRcv
22805  );
22806 
22811  void getNetworkSettings (
22812  out unsigned long mtu,
22813  out unsigned long sockSnd,
22814  out unsigned long sockRcv,
22815  out unsigned long TcpWndSnd,
22816  out unsigned long TcpWndRcv
22817  );
22818 
22838  void addRedirect (
22839  in wstring name,
22840  in NATProtocol proto,
22841  in wstring hostIP,
22842  in unsigned short hostPort,
22843  in wstring guestIP,
22844  in unsigned short guestPort
22845  );
22846 
22852  void removeRedirect (
22853  in wstring name
22854  );
22855 
22856 }; /* interface INATEngine */
22857 
22866 interface IExtPackPlugIn : $unknown
22867 {
22871  readonly attribute wstring name;
22872 
22876  readonly attribute wstring description;
22877 
22883  readonly attribute wstring frontend;
22884 
22888  readonly attribute wstring modulePath;
22889 
22890 }; /* interface IExtPackPlugIn */
22891 
22900 interface IExtPackBase : $unknown
22901 {
22905  readonly attribute wstring name;
22906 
22910  readonly attribute wstring description;
22911 
22923  readonly attribute wstring version;
22924 
22928  readonly attribute unsigned long revision;
22929 
22939  readonly attribute wstring edition;
22940 
22944  readonly attribute wstring VRDEModule;
22945 
22949  readonly attribute IExtPackPlugIn[] plugIns;
22950 
22960  readonly attribute boolean usable;
22961 
22968  readonly attribute wstring whyUnusable;
22969 
22973  readonly attribute boolean showLicense;
22974 
22983  readonly attribute wstring license;
22984 
23008  void queryLicense (
23009  in wstring preferredLocale,
23010  in wstring preferredLanguage,
23011  in wstring format,
23012  [retval] out wstring licenseText
23013  );
23014 
23015 }; /* interface IExtPackBase */
23016 
23026 {
23038  void queryObject (
23039  in wstring objUuid,
23040  [retval] out $unknown returnInterface
23041  );
23042 
23043 }; /* interface IExtPack */
23044 
23055 {
23061  readonly attribute wstring filePath;
23062 
23081  void install (
23082  in boolean replace,
23083  in wstring displayInfo,
23084  [retval] out IProgress progess
23085  );
23086 
23087 }; /* interface IExtPackFile */
23088 
23099 interface IExtPackManager : $unknown
23100 {
23106  readonly attribute IExtPack[] installedExtPacks;
23107 
23125  void find (
23126  in wstring name,
23127  [retval] out IExtPack returnData
23128  );
23129 
23141  void openExtPackFile (
23142  in wstring path,
23143  [retval] out IExtPackFile file
23144  );
23145 
23164  void uninstall (
23165  in wstring name,
23166  in boolean forcedRemoval,
23167  in wstring displayInfo,
23168  [retval] out IProgress progess
23169  );
23170 
23174  void cleanup();
23175 
23189  in wstring frontendName,
23190  [retval] out wstring[] plugInModules
23191  );
23192 
23200  void isExtPackUsable (
23201  in wstring name,
23202  [retval] out boolean usable
23203  );
23204 
23205 }; /* interface IExtPackManager */
23206 
23212 interface IBandwidthGroup : $unknown
23213 {
23217  readonly attribute wstring name;
23218 
23222  readonly attribute BandwidthGroupType type;
23223 
23227  readonly attribute unsigned long reference;
23228 
23233  attribute long long maxBytesPerSec;
23234 
23235 }; /* interface IBandwidthGroup */
23236 
23245 interface IBandwidthControl : $unknown
23246 {
23252  readonly attribute unsigned long numGroups;
23253 
23266  void createBandwidthGroup (
23267  in wstring name,
23268  in BandwidthGroupType type,
23269  in long long maxBytesPerSec
23270  );
23271 
23279  void deleteBandwidthGroup (
23280  in wstring name
23281  );
23282 
23292  void getBandwidthGroup (
23293  in wstring name,
23294  [retval] out IBandwidthGroup bandwidthGroup
23295  );
23296 
23304  void getAllBandwidthGroups (
23305  [retval] out IBandwidthGroup[] bandwidthGroups
23306  );
23307 
23308 }; /* interface IBandwidthControl */
23309 
23322 interface IVirtualBoxClient : $unknown
23323 {
23329  readonly attribute IVirtualBox virtualBox;
23330 
23336  readonly attribute ISession session;
23337 
23343  readonly attribute IEventSource eventSource;
23344 
23355  void checkMachineError (
23356  in IMachine machine
23357  );
23358 
23359 }; /* interface IVirtualBoxClient */
23360 
23374 interface IEventSource : $unknown
23375 {
23381  void createListener (
23382  [retval] out IEventListener listener
23383  );
23384 
23400  void createAggregator (
23401  in IEventSource[] subordinates,
23402  [retval] out IEventSource result
23403  );
23404 
23437  void registerListener (
23438  in IEventListener listener,
23439  in VBoxEventType[] interesting,
23440  in boolean active
23441  );
23442 
23451  void unregisterListener (
23452  in IEventListener listener
23453  );
23454 
23469  void fireEvent (
23470  in IEvent event,
23471  in long timeout,
23472  [retval] out boolean result
23473  );
23474 
23499  void getEvent (
23500  in IEventListener listener,
23501  in long timeout,
23502  [retval] out IEvent event
23503  );
23504 
23516  void eventProcessed (
23517  in IEventListener listener,
23518  in IEvent event
23519  );
23520 
23521 }; /* interface IEventSource */
23522 
23532 interface IEventListener : $unknown
23533 {
23546  void handleEvent (
23547  in IEvent event
23548  );
23549 
23550 }; /* interface IEventListener */
23551 
23628 interface IEvent : $unknown
23629 {
23635  readonly attribute VBoxEventType type;
23636 
23642  readonly attribute IEventSource source;
23643 
23654  readonly attribute boolean waitable;
23655 
23662  void setProcessed();
23663 
23677  void waitProcessed (
23678  in long timeout,
23679  [retval] out boolean result
23680  );
23681 
23682 }; /* interface IEvent */
23683 
23690 {
23694  readonly attribute unsigned long generation;
23695 
23702  void reuse();
23703 
23704 }; /* interface IReusableEvent */
23705 
23712 {
23716  readonly attribute wstringUUID machineId;
23717 
23718 }; /* interface IMachineEvent */
23719 
23726 {
23730  readonly attribute MachineState state;
23731 
23732 }; /* interface IMachineStateChangedEvent */
23733 
23742 {
23749  readonly attribute boolean temporary;
23750 
23751 }; /* interface IMachineDataChangedEvent */
23752 
23762 {
23766  readonly attribute wstringUUID mediumId;
23767 
23771  readonly attribute DeviceType mediumType;
23772 
23779  readonly attribute boolean registered;
23780 
23781 }; /* interface IMediumRegisteredEvent */
23782 
23792 {
23799  readonly attribute boolean registered;
23800 
23801 }; /* interface IMachineRegisteredEvent */
23802 
23813 {
23819  readonly attribute SessionState state;
23820 
23821 }; /* interface ISessionStateChangedEvent */
23822 
23831 {
23837  readonly attribute wstring name;
23838 
23844  readonly attribute wstring value;
23845 
23851  readonly attribute wstring flags;
23852 
23853 }; /* interface IGuestPropertyChangedEvent */
23854 
23861 {
23865  readonly attribute wstringUUID snapshotId;
23866 
23867 }; /* interface ISnapshotEvent */
23868 
23879 {
23880 }; /* interface ISnapshotTakenEvent */
23881 
23899 {
23900 }; /* interface ISnapshotDeletedEvent */
23901 
23912 {
23913 }; /* interface ISnapshotChangedEvent */
23914 
23924 {
23930  readonly attribute boolean visible;
23931 
23937  readonly attribute boolean alpha;
23938 
23944  readonly attribute unsigned long xhot;
23945 
23951  readonly attribute unsigned long yhot;
23952 
23958  readonly attribute unsigned long width;
23959 
23965  readonly attribute unsigned long height;
23966 
23999  readonly attribute octet[] shape;
24000 
24001 }; /* interface IMousePointerShapeChangedEvent */
24002 
24012 {
24018  readonly attribute boolean supportsAbsolute;
24019 
24025  readonly attribute boolean supportsRelative;
24026 
24032  readonly attribute boolean supportsMultiTouch;
24033 
24039  readonly attribute boolean needsHostCursor;
24040 
24041 }; /* interface IMouseCapabilityChangedEvent */
24042 
24052 {
24058  readonly attribute boolean numLock;
24059 
24065  readonly attribute boolean capsLock;
24066 
24072  readonly attribute boolean scrollLock;
24073 
24074 }; /* interface IKeyboardLedsChangedEvent */
24075 
24085 {
24091  readonly attribute MachineState state;
24092 
24093 }; /* interface IStateChangedEvent */
24094 
24105 {
24106 }; /* interface IAdditionsStateChangedEvent */
24107 
24119 {
24125  readonly attribute INetworkAdapter networkAdapter;
24126 
24127 }; /* interface INetworkAdapterChangedEvent */
24128 
24140 {
24146  readonly attribute ISerialPort serialPort;
24147 
24148 }; /* interface ISerialPortChangedEvent */
24149 
24161 {
24167  readonly attribute IParallelPort parallelPort;
24168 
24169 }; /* interface IParallelPortChangedEvent */
24170 
24181 {
24182 }; /* interface IStorageControllerChangedEvent */
24183 
24194 {
24201 
24202 }; /* interface IMediumChangedEvent */
24203 
24212 {
24218  readonly attribute ClipboardMode clipboardMode;
24219 
24220 }; /* interface IClipboardModeChangedEvent */
24221 
24230 {
24236  readonly attribute DragAndDropMode dragAndDropMode;
24237 
24238 }; /* interface IDragAndDropModeChangedEvent */
24239 
24248 {
24254  readonly attribute unsigned long CPU;
24255 
24261  readonly attribute boolean add;
24262 
24263 }; /* interface ICPUChangedEvent */
24264 
24273 {
24279  readonly attribute unsigned long executionCap;
24280 
24281 }; /* interface ICPUExecutionCapChangedEvent */
24282 
24291 {
24297  readonly attribute long[] scancodes;
24298 
24299 }; /* interface IGuestKeyboardEvent */
24300 
24309 {
24315  readonly attribute GuestMouseEventMode mode;
24316 
24322  readonly attribute long x;
24323 
24329  readonly attribute long y;
24330 
24336  readonly attribute long z;
24337 
24343  readonly attribute long w;
24344 
24350  readonly attribute long buttons;
24351 
24352 }; /* interface IGuestMouseEvent */
24353 
24362 {
24368  readonly attribute long contactCount;
24369 
24375  readonly attribute short[] xPositions;
24376 
24382  readonly attribute short[] yPositions;
24383 
24389  readonly attribute unsigned short[] contactIds;
24390 
24398  readonly attribute unsigned short[] contactFlags;
24399 
24405  readonly attribute unsigned long scanTime;
24406 
24407 }; /* interface IGuestMultiTouchEvent */
24408 
24415 {
24419  readonly attribute IGuestSession session;
24420 
24421 }; /* interface IGuestSessionEvent */
24422 
24431 {
24437  readonly attribute unsigned long id;
24438 
24444  readonly attribute GuestSessionStatus status;
24445 
24455  readonly attribute IVirtualBoxErrorInfo error;
24456 
24457 }; /* interface IGuestSessionStateChangedEvent */
24458 
24467 {
24474  readonly attribute boolean registered;
24475 
24476 }; /* interface IGuestSessionRegisteredEvent */
24477 
24484 {
24490  readonly attribute IGuestProcess process;
24491 
24497  readonly attribute unsigned long pid;
24498 
24499 }; /* interface IGuestProcessEvent */
24500 
24509 {
24516  readonly attribute boolean registered;
24517 
24518 }; /* interface IGuestProcessRegisteredEvent */
24519 
24528 {
24534  readonly attribute ProcessStatus status;
24535 
24545  readonly attribute IVirtualBoxErrorInfo error;
24546 
24547 }; /* interface IGuestProcessStateChangedEvent */
24548 
24557 {
24564  readonly attribute unsigned long handle;
24565 
24571  readonly attribute unsigned long processed;
24572 
24573 }; /* interface IGuestProcessIOEvent */
24574 
24585 {
24591  readonly attribute ProcessInputStatus status;
24592 
24593 }; /* interface IGuestProcessInputNotifyEvent */
24594 
24603 {
24609  readonly attribute octet[] data;
24610 
24611 }; /* interface IGuestProcessOutputEvent */
24612 
24619 {
24625  readonly attribute IGuestFile file;
24626 
24627 }; /* interface IGuestFileEvent */
24628 
24637 {
24644  readonly attribute boolean registered;
24645 
24646 }; /* interface IGuestFileRegisteredEvent */
24647 
24656 {
24662  readonly attribute FileStatus status;
24663 
24673  readonly attribute IVirtualBoxErrorInfo error;
24674 
24675 }; /* interface IGuestFileStateChangedEvent */
24676 
24685 {
24691  readonly attribute long long offset;
24692 
24698  readonly attribute unsigned long processed;
24699 
24700 }; /* interface IGuestFileIOEvent */
24701 
24710 {
24711 }; /* interface IGuestFileOffsetChangedEvent */
24712 
24721 {
24727  readonly attribute octet[] data;
24728 
24729 }; /* interface IGuestFileReadEvent */
24730 
24739 {
24740 }; /* interface IGuestFileWriteEvent */
24741 
24753 {
24754 }; /* interface IVRDEServerChangedEvent */
24755 
24766 {
24767 }; /* interface IVRDEServerInfoChangedEvent */
24768 
24777 {
24778 }; /* interface IVideoCaptureChangedEvent */
24779 
24791 {
24792 }; /* interface IUSBControllerChangedEvent */
24793 
24818 {
24824  readonly attribute IUSBDevice device;
24825 
24831  readonly attribute boolean attached;
24832 
24838  readonly attribute IVirtualBoxErrorInfo error;
24839 
24840 }; /* interface IUSBDeviceStateChangedEvent */
24841 
24858 {
24864  readonly attribute Scope scope;
24865 
24866 }; /* interface ISharedFolderChangedEvent */
24867 
24920 {
24926  readonly attribute boolean fatal;
24927 
24933  readonly attribute wstring id;
24934 
24940  readonly attribute wstring message;
24941 
24942 }; /* interface IRuntimeErrorEvent */
24943 
24952 {
24958  readonly attribute IEventListener listener;
24959 
24965  readonly attribute boolean add;
24966 
24967 }; /* interface IEventSourceChangedEvent */
24968 
24978 {
24985  readonly attribute wstringUUID machineId;
24986 
24992  readonly attribute wstring key;
24993 
24999  readonly attribute wstring value;
25000 
25001 }; /* interface IExtraDataChangedEvent */
25002 
25008 interface IVetoEvent : IEvent
25009 {
25019  void addVeto (
25020  in wstring reason
25021  );
25022 
25032  void isVetoed (
25033  [retval] out boolean result
25034  );
25035 
25045  void getVetos (
25046  [retval] out wstring[] result
25047  );
25048 
25049 }; /* interface IVetoEvent */
25050 
25061 {
25068  readonly attribute wstringUUID machineId;
25069 
25075  readonly attribute wstring key;
25076 
25082  readonly attribute wstring value;
25083 
25084 }; /* interface IExtraDataCanChangeEvent */
25085 
25102 {
25103 }; /* interface ICanShowWindowEvent */
25104 
25137 {
25146  attribute long long winId;
25147 
25148 }; /* interface IShowWindowEvent */
25149 
25158 {
25164  readonly attribute unsigned long slot;
25165 
25171  readonly attribute boolean remove;
25172 
25178  readonly attribute wstring name;
25179 
25185  readonly attribute NATProtocol proto;
25186 
25192  readonly attribute wstring hostIP;
25193 
25199  readonly attribute long hostPort;
25200 
25206  readonly attribute wstring guestIP;
25207 
25213  readonly attribute long guestPort;
25214 
25215 }; /* interface INATRedirectEvent */
25216 
25230 {
25236  readonly attribute boolean plugged;
25237 
25244  readonly attribute boolean success;
25245 
25251  readonly attribute IPCIDeviceAttachment attachment;
25252 
25258  readonly attribute wstring message;
25259 
25260 }; /* interface IHostPCIDevicePlugEvent */
25261 
25271 {
25277  readonly attribute boolean available;
25278 
25279 }; /* interface IVBoxSVCAvailabilityChangedEvent */
25280 
25289 {
25295  readonly attribute IBandwidthGroup bandwidthGroup;
25296 
25297 }; /* interface IBandwidthGroupChangedEvent */
25298 
25307 {
25314 
25320  readonly attribute unsigned long screenId;
25321 
25328  readonly attribute unsigned long originX;
25329 
25336  readonly attribute unsigned long originY;
25337 
25344  readonly attribute unsigned long width;
25345 
25352  readonly attribute unsigned long height;
25353 
25354 }; /* interface IGuestMonitorChangedEvent */
25355 
25364 {
25370  readonly attribute wstring name;
25371 
25378  readonly attribute wstring domain;
25379 
25386  readonly attribute GuestUserState state;
25387 
25393  readonly attribute wstring stateDetails;
25394 
25395 }; /* interface IGuestUserStateChangedEvent */
25396 
25407 {
25413  readonly attribute IMediumAttachment storageDevice;
25414 
25420  readonly attribute boolean removed;
25421 
25427  readonly attribute boolean silent;
25428 
25429 }; /* interface IStorageDeviceChangedEvent */
25430 
25432 {
25433  readonly attribute wstring networkName;
25434 
25435 }; /* interface INATNetworkChangedEvent */
25436 
25438 {
25444  readonly attribute boolean startEvent;
25445 
25446 }; /* interface INATNetworkStartStopEvent */
25447 
25449 {
25450 }; /* interface INATNetworkAlterEvent */
25451 
25453 {
25454  readonly attribute boolean creationEvent;
25455 
25456 }; /* interface INATNetworkCreationDeletionEvent */
25457 
25459 {
25460  readonly attribute boolean enabled;
25461 
25462  readonly attribute wstring network;
25463 
25464  readonly attribute wstring gateway;
25465 
25466  readonly attribute boolean advertiseDefaultIPv6RouteEnabled;
25467 
25468  readonly attribute boolean needDhcpServer;
25469 
25470 }; /* interface INATNetworkSettingEvent */
25471 
25473 {
25474  readonly attribute boolean create;
25475 
25476  readonly attribute boolean ipv6;
25477 
25478  readonly attribute wstring name;
25479 
25480  readonly attribute NATProtocol proto;
25481 
25482  readonly attribute wstring hostIp;
25483 
25484  readonly attribute long hostPort;
25485 
25486  readonly attribute wstring guestIp;
25487 
25488  readonly attribute long guestPort;
25489 
25490 }; /* interface INATNetworkPortForwardEvent */
25491 
25493 {
25494 }; /* interface IHostNameResolutionConfigurationChangeEvent */
25495 
25496