VirtualBox.xidl@ 45284

Last change on this file since 45284 was 45284, checked in by vboxsync, 12 years ago
Main: Introduce "StorageMgmt/SilentReconfigureWhilePaused" extradata flag to allow attachment reconfiguration while the VM is paused
Property svn:eol-style set to `native`
File size: 740.3 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2013 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109
110	The naming of methods and attributes is very clearly defined: they all start
111	with a lowercase letter (except if they start with an acronym), and are using
112	CamelCase style otherwise. This naming only applies to the IDL description,
113	and is modified by the various language bindings (some convert the first
114	character to upper case, some not). See the SDK reference for more details
115	about how to call a method or attribute from a specific programming language.
116	</desc>
117
118	<if target="midl">
119	<cpp line="enum {"/>
120	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
121	<cpp line=" kTypeLibraryMinorVersion = 0"/>
122	<cpp line="};"/>
123	</if>
124
125	<if target="xpidl">
126	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
127	<cpp>
128	/* currently, nsISupportsImpl.h lacks the below-like macros */
129
130	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
131	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
132	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
133	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
134
135
136	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
137	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
138	NS_IMPL_THREADSAFE_ADDREF(_class) \
139	NS_IMPL_THREADSAFE_RELEASE(_class) \
140	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
141	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
142	#endif
143
144	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
145	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
146	NS_IMPL_THREADSAFE_ADDREF(_class) \
147	NS_IMPL_THREADSAFE_RELEASE(_class) \
148	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
149	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
150	#endif
151
152	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
153	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
154	NS_IMPL_THREADSAFE_ADDREF(_class) \
155	NS_IMPL_THREADSAFE_RELEASE(_class) \
156	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
157	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
158	#endif
159
160	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
161	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
162	NS_IMPL_THREADSAFE_ADDREF(_class) \
163	NS_IMPL_THREADSAFE_RELEASE(_class) \
164	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
165	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
166	#endif
167
168	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
169	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
170	NS_INTERFACE_MAP_BEGIN(_class) \
171	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
172	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
173	NS_IMPL_QUERY_CLASSINFO(_class) \
174	NS_INTERFACE_MAP_END
175	#endif
176
177	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
178	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
179	_i2, _ic2) \
180	NS_INTERFACE_MAP_BEGIN(_class) \
181	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
182	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
183	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
184	NS_IMPL_QUERY_CLASSINFO(_class) \
185	NS_INTERFACE_MAP_END
186	#endif
187
188	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
189	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
190	_i2, _ic2, _i3, _ic3) \
191	NS_INTERFACE_MAP_BEGIN(_class) \
192	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
193	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
194	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
195	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
196	NS_IMPL_QUERY_CLASSINFO(_class) \
197	NS_INTERFACE_MAP_END
198	#endif
199
200	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
201	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
202	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
203
204	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
205	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
206	NS_IMPL_THREADSAFE_ADDREF(_class) \
207	NS_IMPL_THREADSAFE_RELEASE(_class) \
208	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
209	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
210	#endif
211
212	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
213	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
214	_i2, _ic2) \
215	NS_IMPL_THREADSAFE_ADDREF(_class) \
216	NS_IMPL_THREADSAFE_RELEASE(_class) \
217	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
218	_i2, _ic2) \
219	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
220	#endif
221
222	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
223	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
224	_i2, _ic2, _i3, _ic3) \
225	NS_IMPL_THREADSAFE_ADDREF(_class) \
226	NS_IMPL_THREADSAFE_RELEASE(_class) \
227	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
228	_i2, _ic2, _i3, _ic3) \
229	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
230	#endif
231
232	</cpp>
233	</if>
234
235	<library
236	name="VirtualBox"
237	uuid="d7569351-1750-46f0-936e-bd127d5bc264"
238	version="1.3"
239	desc="VirtualBox Type Library"
240	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
241	supportsErrorInfo="yes"
242	>
243
244
245	<!--
246	// COM result codes for VirtualBox
247	/////////////////////////////////////////////////////////////////////////
248	-->
249
250	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
251	<desc>
252	This section describes all VirtualBox-specific COM result codes that may
253	be returned by methods of VirtualBox COM interfaces in addition to
254	standard COM result codes.
255
256	Note that along with the result code, every VirtualBox method returns
257	extended error information through the IVirtualBoxErrorInfo interface on
258	failure. This interface is a preferred way to present the error to the end
259	user because it contains a human readable description of the error. Raw
260	result codes, both standard and described in this section, are intended to
261	be used by programs to analyze the reason of a failure and select an
262	appropriate course of action without involving the end user (for example,
263	retry the operation later or make a different call).
264
265	The standard COM result codes that may originate from our methods include:
266
267	<table>
268	<tr><td>E_INVALIDARG</td>
269	<td>
270	Returned when the value of the method's argument is not within the range
271	of valid values. This should not be confused with situations when the
272	value is within the range but simply doesn't suit the current object
273	state and there is a possibility that it will be accepted later (in such
274	cases VirtualBox-specific codes are returned, for example,
275	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
276	</td>
277	</tr>
278	<tr><td>E_POINTER</td>
279	<td>
280	Returned if a memory pointer for the output argument is invalid (for
281	example, @c null). When pointers representing input arguments (such
282	as strings) are invalid, E_INVALIDARG is returned.
283	</td>
284	</tr>
285	<tr><td>E_ACCESSDENIED</td>
286	<td>
287	Returned when the called object is not ready. Since the lifetime of a
288	public COM object cannot be fully controlled by the implementation,
289	VirtualBox maintains the readiness state for all objects it creates and
290	returns this code in response to any method call on the object that was
291	deactivated by VirtualBox and is not functioning any more.
292	</td>
293	</tr>
294	<tr><td>E_OUTOFMEMORY</td>
295	<td>
296	Returned when a memory allocation operation fails.
297	</td>
298	</tr>
299	</table>
300	</desc>
301	</descGroup>
302
303	<!--
304	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
305	everything in <result>/<desc> after (and including) the first dot, so express
306	the matter of the error code in the first sentence and keep it short.
307	-->
308
309	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
310	<desc>
311	Object corresponding to the supplied arguments does not exist.
312	</desc>
313	</result>
314
315	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
316	<desc>
317	Current virtual machine state prevents the operation.
318	</desc>
319	</result>
320
321	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
322	<desc>
323	Virtual machine error occurred attempting the operation.
324	</desc>
325	</result>
326
327	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
328	<desc>
329	File not accessible or erroneous file contents.
330	</desc>
331	</result>
332
333	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
334	<desc>
335	Runtime subsystem error.
336	</desc>
337	</result>
338
339	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
340	<desc>
341	Pluggable Device Manager error.
342	</desc>
343	</result>
344
345	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
346	<desc>
347	Current object state prohibits operation.
348	</desc>
349	</result>
350
351	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
352	<desc>
353	Host operating system related error.
354	</desc>
355	</result>
356
357	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
358	<desc>
359	Requested operation is not supported.
360	</desc>
361	</result>
362
363	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
364	<desc>
365	Invalid XML found.
366	</desc>
367	</result>
368
369	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
370	<desc>
371	Current session state prohibits operation.
372	</desc>
373	</result>
374
375	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
376	<desc>
377	Object being in use prohibits operation.
378	</desc>
379	</result>
380
381	<!--
382	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
383	everything in <result>/<desc> after (and including) the first dot, so express
384	the matter of the error code in the first sentence and keep it short.
385	-->
386
387	<descGroup/>
388
389	<!--
390	// all common enums
391	/////////////////////////////////////////////////////////////////////////
392	-->
393
394	<enum
395	name="SettingsVersion"
396	uuid="d5b15ca7-3de7-46b2-a63a-ddcce42bfa3f"
397	>
398	<desc>
399	Settings version of VirtualBox settings files. This is written to
400	the "version" attribute of the root "VirtualBox" element in the settings
401	file XML and indicates which VirtualBox version wrote the file.
402	</desc>
403
404	<const name="Null" value="0">
405	<desc>Null value, indicates invalid version.</desc>
406	</const>
407	<const name="v1_0" value="1">
408	<desc>Legacy settings version, not currently supported.</desc>
409	</const>
410	<const name="v1_1" value="2">
411	<desc>Legacy settings version, not currently supported.</desc>
412	</const>
413	<const name="v1_2" value="3">
414	<desc>Legacy settings version, not currently supported.</desc>
415	</const>
416	<const name="v1_3pre" value="4">
417	<desc>Legacy settings version, not currently supported.</desc>
418	</const>
419	<const name="v1_3" value="5">
420	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
421	<!--
422	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
423	-->
424	</const>
425	<const name="v1_4" value="6">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
429	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
430	-->
431	</const>
432	<const name="v1_5" value="7">
433	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
434	<!--
435	2008-09-04: 2.0.0 released
436	2008-11-20: settings version 1.5 introduced
437	2008-12-17: 2.1.0 released
438	Machine changes:
439	guest OS identifiers changed;
440	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
441	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
442	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
443	-->
444	</const>
445	<const name="v1_6" value="8">
446	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
447	<!--
448	2008-12-17: 2.1.0 released
449	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
450	2009-04-08: 2.2.0 released
451	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
452	-->
453	</const>
454	<const name="v1_7" value="9">
455	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
456	<!--
457	2008-12-17: 2.1.0 released
458	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
459	2009-04-08: 2.2.0 released
460	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
461	Machine changes: HardDiskAttachments is now StorageControllers (done)
462	-->
463	</const>
464	<const name="v1_8" value="10">
465	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
466	<!--
467	Machine additions: Display/@accelerate2DVideo (done)
468	-->
469	</const>
470	<const name="v1_9" value="11">
471	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
472	<!--
473	The big storage controller / DVD / Floppy rework (done)
474	-->
475	</const>
476	<const name="v1_10" value="12">
477	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
478	<!--
479	Machine changes: RTC localOrUTC (done)
480	CPU hot-plug support
481	-->
482	</const>
483	<const name="v1_11" value="13">
484	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
485	<!--
486	Machine changes: HD Audio controller, per-machine disk registries,
487	/@format attribute for DVD and floppy images.
488	-->
489	</const>
490	<const name="v1_12" value="14">
491	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
492	<!--
493	Machine changes: raw PCI device attachment;
494	NetworkAdapter changes: bandwidth group.
495	-->
496	</const>
497	<const name="v1_13" value="15">
498	<desc>Settings version "1.13", written by VirtualBox 4.2.x.</desc>
499	<!--
500	Machine changes: tracing config, groups, autostart;
501	NetworkAdapter changes: unit for bandwidth group limits.
502	-->
503	</const>
504	<const name="v1_14" value="16">
505	<desc>Settings version "1.14", written by VirtualBox 4.3.x.</desc>
506	<!--
507	Machine changes: default frontend.
508	-->
509	</const>
510
511	<const name="Future" value="99999">
512	<desc>Settings version greater than "1.13", written by a future VirtualBox version.</desc>
513	</const>
514	</enum>
515
516	<enum
517	name="AccessMode"
518	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
519	>
520	<desc>
521	Access mode for opening files.
522	</desc>
523
524	<const name="ReadOnly" value="1"/>
525	<const name="ReadWrite" value="2"/>
526	</enum>
527
528	<enum
529	name="MachineState"
530	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
531	>
532	<desc>
533	Virtual machine execution state.
534
535	This enumeration represents possible values of the <link
536	to="IMachine::state"/> attribute.
537
538	Below is the basic virtual machine state diagram. It shows how the state
539	changes during virtual machine execution. The text in square braces shows
540	a method of the IConsole interface that performs the given state
541	transition.
542
543	<pre>
544	+---------[powerDown()] <- Stuck <--[failure]-+
545	V \|
546	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
547	\| \| \| \| V \|
548	\| Aborted -----+ +--> Running --[pause()]--> Paused
549	\| \| ^ \| ^ \|
550	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
551	\| ^ \| \| \| \|
552	\| \| +-----------------------------------------+-\|-------------------+ +
553	\| \| \| \| \|
554	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
555	\| \| \| \|
556	\| +-------- Saving <--------[saveState()]<----------+---------------------+
557	\| \| \|
558	+-------------- Stopping -------[powerDown()]<----------+---------------------+
559	</pre>
560
561	Note that states to the right from PoweredOff, Aborted and Saved in the
562	above diagram are called <i>online VM states</i>. These states
563	represent the virtual machine which is being executed in a dedicated
564	process (usually with a GUI window attached to it where you can see the
565	activity of the virtual machine and interact with it). There are two
566	special pseudo-states, FirstOnline and LastOnline, that can be used in
567	relational expressions to detect if the given machine state is online or
568	not:
569
570	<pre>
571	if (machine.GetState() >= MachineState_FirstOnline &&
572	machine.GetState() <= MachineState_LastOnline)
573	{
574	...the machine is being executed...
575	}
576	</pre>
577
578	When the virtual machine is in one of the online VM states (that is, being
579	executed), only a few machine settings can be modified. Methods working
580	with such settings contain an explicit note about that. An attempt to
581	change any other setting or perform a modifying operation during this time
582	will result in the @c VBOX_E_INVALID_VM_STATE error.
583
584	All online states except Running, Paused and Stuck are transitional: they
585	represent temporary conditions of the virtual machine that will last as
586	long as the operation that initiated such a condition.
587
588	The Stuck state is a special case. It means that execution of the machine
589	has reached the "Guru Meditation" condition. This condition indicates an
590	internal VMM (virtual machine manager) failure which may happen as a
591	result of either an unhandled low-level virtual hardware exception or one
592	of the recompiler exceptions (such as the <i>too-many-traps</i>
593	condition).
594
595	Note also that any online VM state may transit to the Aborted state. This
596	happens if the process that is executing the virtual machine terminates
597	unexpectedly (for example, crashes). Other than that, the Aborted state is
598	equivalent to PoweredOff.
599
600	There are also a few additional state diagrams that do not deal with
601	virtual machine execution and therefore are shown separately. The states
602	shown on these diagrams are called <i>offline VM states</i> (this includes
603	PoweredOff, Aborted and Saved too).
604
605	The first diagram shows what happens when a lengthy setup operation is
606	being executed (such as <link to="IMachine::attachDevice"/>).
607
608	<pre>
609	+----------------------------------(same state as before the call)------+
610	\| \|
611	+-> PoweredOff --+ \|
612	\| \| \|
613	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
614	\| \|
615	+-> Saved -------+
616	</pre>
617
618	The next two diagrams demonstrate the process of taking a snapshot of a
619	powered off virtual machine, restoring the state to that as of a snapshot
620	or deleting a snapshot, respectively.
621
622	<pre>
623	+----------------------------------(same state as before the call)------+
624	\| \|
625	+-> PoweredOff --+ \|
626	\| +-->[takeSnapshot()] -------------------> Saving ------+
627	+-> Aborted -----+
628
629	+-> PoweredOff --+
630	\| \|
631	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
632	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
633	+-> Saved -------+ \|
634	\| \|
635	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
636	</pre>
637
638	Note that the Saving state is present in both the offline state group and
639	online state group. Currently, the only way to determine what group is
640	assumed in a particular case is to remember the previous machine state: if
641	it was Running or Paused, then Saving is an online state, otherwise it is
642	an offline state. This inconsistency may be removed in one of the future
643	versions of VirtualBox by adding a new state.
644
645	<note internal="yes">
646	For whoever decides to touch this enum: In order to keep the
647	comparisons involving FirstOnline and LastOnline pseudo-states valid,
648	the numeric values of these states must be correspondingly updated if
649	needed: for any online VM state, the condition
650	<tt>FirstOnline <= state <= LastOnline</tt> must be
651	@c true. The same relates to transient states for which
652	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
653	@c true.
654	</note>
655	</desc>
656
657	<const name="Null" value="0">
658	<desc>Null value (never used by the API).</desc>
659	</const>
660	<const name="PoweredOff" value="1">
661	<desc>
662	The machine is not running and has no saved execution state; it has
663	either never been started or been shut down successfully.
664	</desc>
665	</const>
666	<const name="Saved" value="2">
667	<desc>
668	The machine is not currently running, but the execution state of the machine
669	has been saved to an external file when it was running, from where
670	it can be resumed.
671	</desc>
672	</const>
673	<const name="Teleported" value="3">
674	<desc>
675	The machine was teleported to a different host (or process) and then
676	powered off. Take care when powering it on again may corrupt resources
677	it shares with the teleportation target (e.g. disk and network).
678	</desc>
679	</const>
680	<const name="Aborted" value="4">
681	<desc>
682	The process running the machine has terminated abnormally. This may
683	indicate a crash of the VM process in host execution context, or
684	the VM process has been terminated externally.
685	</desc>
686	</const>
687	<const name="Running" value="5">
688	<desc>
689	The machine is currently being executed.
690	<note internal="yes">
691	For whoever decides to touch this enum: In order to keep the
692	comparisons in the old source code valid, this state must immediately
693	precede the Paused state.
694	TODO: Lift this spectacularly wonderful restriction.
695	</note>
696	</desc>
697	</const>
698	<const name="Paused" value="6">
699	<desc>
700	Execution of the machine has been paused.
701	<note internal="yes">
702	For whoever decides to touch this enum: In order to keep the
703	comparisons in the old source code valid, this state must immediately
704	follow the Running state.
705	TODO: Lift this spectacularly wonderful restriction.
706	</note>
707	</desc>
708	</const>
709	<const name="Stuck" value="7">
710	<desc>
711	Execution of the machine has reached the "Guru Meditation"
712	condition. This indicates a severe error in the hypervisor itself.
713	<note internal="yes">
714	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
715	"Guru", perhaps? Or are there some other VMM states that are
716	intended to be lumped in here as well?
717	</note>
718	</desc>
719	</const>
720	<const name="Teleporting" value="8">
721	<desc>
722	The machine is about to be teleported to a different host or process.
723	It is possible to pause a machine in this state, but it will go to the
724	@c TeleportingPausedVM state and it will not be
725	possible to resume it again unless the teleportation fails.
726	</desc>
727	</const>
728	<const name="LiveSnapshotting" value="9">
729	<desc>
730	A live snapshot is being taken. The machine is running normally, but
731	some of the runtime configuration options are inaccessible. Also, if
732	paused while in this state it will transition to
733	@c Saving and it will not be resume the
734	execution until the snapshot operation has completed.
735	</desc>
736	</const>
737	<const name="Starting" value="10">
738	<desc>
739	Machine is being started after powering it on from a
740	zero execution state.
741	</desc>
742	</const>
743	<const name="Stopping" value="11">
744	<desc>
745	Machine is being normally stopped powering it off, or after the guest OS
746	has initiated a shutdown sequence.
747	</desc>
748	</const>
749	<const name="Saving" value="12">
750	<desc>
751	Machine is saving its execution state to a file, or an online
752	snapshot of the machine is being taken.
753	</desc>
754	</const>
755	<const name="Restoring" value="13">
756	<desc>
757	Execution state of the machine is being restored from a file
758	after powering it on from the saved execution state.
759	</desc>
760	</const>
761	<const name="TeleportingPausedVM" value="14">
762	<desc>
763	The machine is being teleported to another host or process, but it is
764	not running. This is the paused variant of the
765	@c state.
766	</desc>
767	</const>
768	<const name="TeleportingIn" value="15">
769	<desc>
770	Teleporting the machine state in from another host or process.
771	</desc>
772	</const>
773	<const name="FaultTolerantSyncing" value="16">
774	<desc>
775	The machine is being synced with a fault tolerant VM running elsewhere.
776	</desc>
777	</const>
778	<const name="DeletingSnapshotOnline" value="17">
779	<desc>
780	Like @c DeletingSnapshot, but the merging of media is ongoing in
781	the background while the machine is running.
782	</desc>
783	</const>
784	<const name="DeletingSnapshotPaused" value="18">
785	<desc>
786	Like @c DeletingSnapshotOnline, but the machine was paused when the
787	merging of differencing media was started.
788	</desc>
789	</const>
790	<const name="RestoringSnapshot" value="19">
791	<desc>
792	A machine snapshot is being restored; this typically does not take long.
793	</desc>
794	</const>
795	<const name="DeletingSnapshot" value="20">
796	<desc>
797	A machine snapshot is being deleted; this can take a long time since this
798	may require merging differencing media. This value indicates that the
799	machine is not running while the snapshot is being deleted.
800	</desc>
801	</const>
802	<const name="SettingUp" value="21">
803	<desc>
804	Lengthy setup operation is in progress.
805	</desc>
806	</const>
807
808	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
809	<desc>
810	Pseudo-state: first online state (for use in relational expressions).
811	</desc>
812	</const>
813	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
814	<desc>
815	Pseudo-state: last online state (for use in relational expressions).
816	</desc>
817	</const>
818
819	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
820	<desc>
821	Pseudo-state: first transient state (for use in relational expressions).
822	</desc>
823	</const>
824	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
825	<desc>
826	Pseudo-state: last transient state (for use in relational expressions).
827	</desc>
828	</const>
829
830	</enum>
831
832	<enum
833	name="SessionState"
834	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
835	>
836	<desc>
837	Session state. This enumeration represents possible values of
838	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
839	attributes.
840	</desc>
841
842	<const name="Null" value="0">
843	<desc>Null value (never used by the API).</desc>
844	</const>
845	<const name="Unlocked" value="1">
846	<desc>
847	In <link to="IMachine::sessionState"/>, this means that the machine
848	is not locked for any sessions.
849
850	In <link to="ISession::state"/>, this means that no machine is
851	currently locked for this session.
852	</desc>
853	</const>
854	<const name="Locked" value="2">
855	<desc>
856	In <link to="IMachine::sessionState"/>, this means that the machine
857	is currently locked for a session, whose process identifier can
858	then be found in the <link to="IMachine::sessionPID" /> attribute.
859
860	In <link to="ISession::state"/>, this means that a machine is
861	currently locked for this session, and the mutable machine object
862	can be found in the <link to="ISession::machine"/> attribute
863	(see <link to="IMachine::lockMachine" /> for details).
864	</desc>
865	</const>
866	<const name="Spawning" value="3">
867	<desc>
868	A new process is being spawned for the machine as a result of
869	<link to="IMachine::launchVMProcess"/> call. This state also occurs
870	as a short transient state during an <link to="IMachine::lockMachine"/>
871	call.
872	</desc>
873	</const>
874	<const name="Unlocking" value="4">
875	<desc>
876	The session is being unlocked.
877	</desc>
878	</const>
879	</enum>
880
881	<enum
882	name="CPUPropertyType"
883	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
884	>
885	<desc>
886	Virtual CPU property type. This enumeration represents possible values of the
887	IMachine get- and setCPUProperty methods.
888	</desc>
889	<const name="Null" value="0">
890	<desc>Null value (never used by the API).</desc>
891	</const>
892	<const name="PAE" value="1">
893	<desc>
894	This setting determines whether VirtualBox will expose the Physical Address
895	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
896	is not available, it will not be reported.
897	</desc>
898	</const>
899	<const name="Synthetic" value="2">
900	<desc>
901	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
902	teleporting between host systems that differ significantly.
903	</desc>
904	</const>
905	</enum>
906
907
908	<enum
909	name="HWVirtExPropertyType"
910	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
911	>
912	<desc>
913	Hardware virtualization property type. This enumeration represents possible values
914	for the <link to="IMachine::getHWVirtExProperty"/> and
915	<link to="IMachine::setHWVirtExProperty"/> methods.
916	</desc>
917	<const name="Null" value="0">
918	<desc>Null value (never used by the API).</desc>
919	</const>
920	<const name="Enabled" value="1">
921	<desc>
922	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
923	such extensions are not available, they will not be used.
924	</desc>
925	</const>
926	<const name="Exclusive" value="2">
927	<desc>
928	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
929	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
930	feature of the host. To share these with other hypervisors, you must disable this property.
931	</desc>
932	</const>
933	<const name="VPID" value="3">
934	<desc>
935	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
936	</desc>
937	</const>
938	<const name="NestedPaging" value="4">
939	<desc>
940	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
941	</desc>
942	</const>
943	<const name="LargePages" value="5">
944	<desc>
945	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
946	</desc>
947	</const>
948	<const name="Force" value="6">
949	<desc>
950	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
951	not set, there will be an automatic fallback to software virtualization.
952	</desc>
953	</const>
954	</enum>
955
956	<enum
957	name="FaultToleranceState"
958	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
959	>
960	<desc>
961	Used with <link to="IMachine::faultToleranceState" />.
962	</desc>
963	<const name="Inactive" value="1">
964	<desc>No fault tolerance enabled.</desc>
965	</const>
966	<const name="Master" value="2">
967	<desc>Fault tolerant master VM.</desc>
968	</const>
969	<const name="Standby" value="3">
970	<desc>Fault tolerant standby VM.</desc>
971	</const>
972	</enum>
973
974	<enum
975	name="LockType"
976	uuid="168a6a8e-12fd-4878-a1f9-38a750a56089"
977	>
978	<desc>
979	Used with <link to="IMachine::lockMachine" />.
980	</desc>
981	<const name="Write" value="2">
982	<desc>Lock the machine for writing.</desc>
983	</const>
984	<const name="Shared" value="1">
985	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
986	</const>
987	<const name="VM" value="3">
988	<desc>Lock the machine for writing, and create objects necessary for
989	running a VM in this process.</desc>
990	</const>
991	</enum>
992
993	<enum
994	name="SessionType"
995	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
996	>
997	<desc>
998	Session type. This enumeration represents possible values of the
999	<link to="ISession::type"/> attribute.
1000	</desc>
1001
1002	<const name="Null" value="0">
1003	<desc>Null value (never used by the API).</desc>
1004	</const>
1005	<const name="WriteLock" value="1">
1006	<desc>
1007	Session has acquired an exclusive write lock on a machine
1008	using <link to="IMachine::lockMachine"/>.
1009	</desc>
1010	</const>
1011	<const name="Remote" value="2">
1012	<desc>
1013	Session has launched a VM process using
1014	<link to="IMachine::launchVMProcess"/>
1015	</desc>
1016	</const>
1017	<const name="Shared" value="3">
1018	<desc>
1019	Session has obtained a link to another session using
1020	<link to="IMachine::lockMachine"/>
1021	</desc>
1022	</const>
1023	</enum>
1024
1025	<enum
1026	name="DeviceType"
1027	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1028	>
1029	<desc>
1030	Device type.
1031	</desc>
1032	<const name="Null" value="0">
1033	<desc>
1034	Null value, may also mean "no device" (not allowed for
1035	<link to="IConsole::getDeviceActivity"/>).
1036	</desc>
1037	</const>
1038	<const name="Floppy" value="1">
1039	<desc>Floppy device.</desc>
1040	</const>
1041	<const name="DVD" value="2">
1042	<desc>CD/DVD-ROM device.</desc>
1043	</const>
1044	<const name="HardDisk" value="3">
1045	<desc>Hard disk device.</desc>
1046	</const>
1047	<const name="Network" value="4">
1048	<desc>Network device.</desc>
1049	</const>
1050	<const name="USB" value="5">
1051	<desc>USB device.</desc>
1052	</const>
1053	<const name="SharedFolder" value="6">
1054	<desc>Shared folder device.</desc>
1055	</const>
1056	</enum>
1057
1058	<enum
1059	name="DeviceActivity"
1060	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1061	>
1062	<desc>
1063	Device activity for <link to="IConsole::getDeviceActivity"/>.
1064	</desc>
1065
1066	<const name="Null" value="0"/>
1067	<const name="Idle" value="1"/>
1068	<const name="Reading" value="2"/>
1069	<const name="Writing" value="3"/>
1070	</enum>
1071
1072	<enum
1073	name="ClipboardMode"
1074	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1075	>
1076	<desc>
1077	Host-Guest clipboard interchange mode.
1078	</desc>
1079
1080	<const name="Disabled" value="0"/>
1081	<const name="HostToGuest" value="1"/>
1082	<const name="GuestToHost" value="2"/>
1083	<const name="Bidirectional" value="3"/>
1084	</enum>
1085
1086	<enum
1087	name="DragAndDropMode"
1088	uuid="b618ea0e-b6fb-4f8d-97f7-5e237e49b547"
1089	>
1090	<desc>
1091	Drag'n'Drop interchange mode.
1092	</desc>
1093
1094	<const name="Disabled" value="0"/>
1095	<const name="HostToGuest" value="1"/>
1096	<const name="GuestToHost" value="2"/>
1097	<const name="Bidirectional" value="3"/>
1098	</enum>
1099
1100	<enum
1101	name="Scope"
1102	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1103	>
1104	<desc>
1105	Scope of the operation.
1106
1107	A generic enumeration used in various methods to define the action or
1108	argument scope.
1109	</desc>
1110
1111	<const name="Global" value="0"/>
1112	<const name="Machine" value="1"/>
1113	<const name="Session" value="2"/>
1114	</enum>
1115
1116	<enum
1117	name="BIOSBootMenuMode"
1118	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1119	>
1120	<desc>
1121	BIOS boot menu mode.
1122	</desc>
1123
1124	<const name="Disabled" value="0"/>
1125	<const name="MenuOnly" value="1"/>
1126	<const name="MessageAndMenu" value="2"/>
1127	</enum>
1128
1129	<enum
1130	name="ProcessorFeature"
1131	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1132	>
1133	<desc>
1134	CPU features.
1135	</desc>
1136
1137	<const name="HWVirtEx" value="0"/>
1138	<const name="PAE" value="1"/>
1139	<const name="LongMode" value="2"/>
1140	<const name="NestedPaging" value="3"/>
1141	</enum>
1142
1143	<enum
1144	name="FirmwareType"
1145	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1146	>
1147	<desc>
1148	Firmware type.
1149	</desc>
1150	<const name="BIOS" value="1">
1151	<desc>BIOS Firmware.</desc>
1152	</const>
1153	<const name="EFI" value="2">
1154	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1155	</const>
1156	<const name="EFI32" value="3">
1157	<desc>Efi firmware, 32-bit.</desc>
1158	</const>
1159	<const name="EFI64" value="4">
1160	<desc>Efi firmware, 64-bit.</desc>
1161	</const>
1162	<const name="EFIDUAL" value="5">
1163	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1164	</const>
1165	</enum>
1166
1167	<enum
1168	name="PointingHIDType"
1169	uuid="e44b2f7b-72ba-44fb-9e53-2186014f0d17"
1170	>
1171	<desc>
1172	Type of pointing device used in a virtual machine.
1173	</desc>
1174	<const name="None" value="1">
1175	<desc>No mouse.</desc>
1176	</const>
1177	<const name="PS2Mouse" value="2">
1178	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1179	</const>
1180	<const name="USBMouse" value="3">
1181	<desc>USB mouse (relative pointer).</desc>
1182	</const>
1183	<const name="USBTablet" value="4">
1184	<desc>USB tablet (absolute pointer).</desc>
1185	</const>
1186	<const name="ComboMouse" value="5">
1187	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1188	Using of such device can have negative performance implications. </desc>
1189	</const>
1190	</enum>
1191
1192	<enum
1193	name="KeyboardHIDType"
1194	uuid="383e43d7-5c7c-4ec8-9cb8-eda1bccd6699"
1195	>
1196	<desc>
1197	Type of keyboard device used in a virtual machine.
1198	</desc>
1199	<const name="None" value="1">
1200	<desc>No keyboard.</desc>
1201	</const>
1202	<const name="PS2Keyboard" value="2">
1203	<desc>PS/2 keyboard.</desc>
1204	</const>
1205	<const name="USBKeyboard" value="3">
1206	<desc>USB keyboard.</desc>
1207	</const>
1208	<const name="ComboKeyboard" value="4">
1209	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1210	Using of such device can have negative performance implications. </desc>
1211	</const>
1212	</enum>
1213
1214	<!--
1215	// IVirtualBoxErrorInfo
1216	/////////////////////////////////////////////////////////////////////////
1217	-->
1218
1219	<interface
1220	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1221	uuid="f91e6e91-49e1-4fd2-b21e-269003350d06"
1222	supportsErrorInfo="no"
1223	wsmap="managed"
1224	>
1225	<desc>
1226	The IVirtualBoxErrorInfo interface represents extended error information.
1227
1228	Extended error information can be set by VirtualBox components after
1229	unsuccessful or partially successful method invocation. This information
1230	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1231	and then shown to the client in addition to the plain 32-bit result code.
1232
1233	In MS COM, this interface extends the IErrorInfo interface,
1234	in XPCOM, it extends the nsIException interface. In both cases,
1235	it provides a set of common attributes to retrieve error
1236	information.
1237
1238	Sometimes invocation of some component's method may involve methods of
1239	other components that may also fail (independently of this method's
1240	failure), or a series of non-fatal errors may precede a fatal error that
1241	causes method failure. In cases like that, it may be desirable to preserve
1242	information about all errors happened during method invocation and deliver
1243	it to the caller. The <link to="#next"/> attribute is intended
1244	specifically for this purpose and allows to represent a chain of errors
1245	through a single IVirtualBoxErrorInfo object set after method invocation.
1246
1247	<note>errors are stored to a chain in the reverse order, i.e. the
1248	initial error object you query right after method invocation is the last
1249	error set by the callee, the object it points to in the @a next attribute
1250	is the previous error and so on, up to the first error (which is the last
1251	in the chain).</note>
1252	</desc>
1253
1254	<attribute name="resultCode" type="long" readonly="yes">
1255	<desc>
1256	Result code of the error.
1257	Usually, it will be the same as the result code returned
1258	by the method that provided this error information, but not
1259	always. For example, on Win32, CoCreateInstance() will most
1260	likely return E_NOINTERFACE upon unsuccessful component
1261	instantiation attempt, but not the value the component factory
1262	returned. Value is typed 'long', not 'result',
1263	to make interface usable from scripting languages.
1264	<note>
1265	In MS COM, there is no equivalent.
1266	In XPCOM, it is the same as nsIException::result.
1267	</note>
1268	</desc>
1269	</attribute>
1270
1271	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1272	<desc>
1273	UUID of the interface that defined the error.
1274	<note>
1275	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1276	data type.
1277	In XPCOM, there is no equivalent.
1278	</note>
1279	</desc>
1280	</attribute>
1281
1282	<attribute name="component" type="wstring" readonly="yes">
1283	<desc>
1284	Name of the component that generated the error.
1285	<note>
1286	In MS COM, it is the same as IErrorInfo::GetSource.
1287	In XPCOM, there is no equivalent.
1288	</note>
1289	</desc>
1290	</attribute>
1291
1292	<attribute name="text" type="wstring" readonly="yes">
1293	<desc>
1294	Text description of the error.
1295	<note>
1296	In MS COM, it is the same as IErrorInfo::GetDescription.
1297	In XPCOM, it is the same as nsIException::message.
1298	</note>
1299	</desc>
1300	</attribute>
1301
1302	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1303	<desc>
1304	Next error object if there is any, or @c null otherwise.
1305	<note>
1306	In MS COM, there is no equivalent.
1307	In XPCOM, it is the same as nsIException::inner.
1308	</note>
1309	</desc>
1310	</attribute>
1311
1312	</interface>
1313
1314	<!--
1315	// IVirtualBox
1316	/////////////////////////////////////////////////////////////////////////
1317	-->
1318	<!-- This is experimental interface to LWIP based NAT server -->
1319	<interface name="INATNetwork" extends="$unknown"
1320	uuid="03DFD6F7-1B78-48A3-8345-C785281E9523"
1321	wsmap="managed">
1322	<attribute name="NetworkName" type="wstring">
1323	<desc>
1324	TBD: the idea, technically we can start any number of the NAT networks,
1325	but we should expect that at some point we will get collisions because of
1326	port-forwanding rules. so perhaps we should support only single instance of NAT
1327	network.
1328	</desc>
1329	</attribute>
1330	<attribute name="enabled" type="boolean"/>
1331	<attribute name="network" type="wstring">
1332	<desc>
1333	This is CIDR IPv4 string. Specifiying it user defines IPv4 addresses
1334	of gateway (low address + 1) and dhcp server (= low address + 2).
1335	Note: if there're defined IPv4 port-forward rules update of network
1336	will be ignored (because new assignment could break existing rules).
1337	</desc>
1338	</attribute>
1339	<attribute name="gateway" type="wstring" readonly="yes">
1340	<desc>
1341	This attribute is read-only. It's recalculated on changing
1342	network attribute (low address of network + 1).
1343	</desc>
1344	</attribute>
1345	<attribute name="IPv6Enabled" type="boolean">
1346	<desc>
1347	This attribute define whether gateway will support IPv6 or not.
1348	</desc>
1349	</attribute>
1350	<attribute name="IPv6Prefix" type="wstring">
1351	<desc>
1352	This a CIDR IPv6 defining prefix for link-local addresses autoconfiguration within network. Note: ignored if attribute ipv6enabled is false.
1353	</desc>
1354	</attribute>
1355	<attribute name="advertiseDefaultIPv6RouteEnabled" type="boolean"/>
1356	<attribute name="needDhcpServer" type="boolean"/>
1357	<attribute name="eventSource" type="IEventSource" readonly="yes"/>
1358	<attribute name="portForwardRules4" type="wstring" readonly="yes" safearray="yes">
1359	<desc>Array of NAT port-forwarding rules in string representation,
1360	in the following format:
1361	"name:protocolid:[host ip]:host port:[guest ip]:guest port".
1362	</desc>
1363	</attribute>
1364	<attribute name="portForwardRules6" type="wstring" readonly="yes" safearray="yes">
1365	<desc>Array of NAT port-forwarding rules in string representation, in the
1366	following format: "name:protocolid:[host ip]:host port:[guest ip]:guest port".
1367	</desc>
1368	</attribute>
1369	<method name="addPortForwardRule">
1370	<param name="isIpv6" type="boolean" dir="in"/>
1371	<param name="ruleName" type="wstring" dir="in"/>
1372	<param name="proto" type="NATProtocol" dir="in">
1373	<desc>Protocol handled with the rule.</desc>
1374	</param>
1375	<param name="hostIP" type="wstring" dir="in">
1376	<desc>IP of the host interface to which the rule should apply.
1377	An empty ip address is acceptable, in which case the NAT engine
1378	binds the handling socket to any interface.
1379	</desc>
1380	</param>
1381	<param name="hostPort" type="unsigned short" dir="in">
1382	<desc>The port number to listen on.</desc>
1383	</param>
1384	<param name="guestIP" type="wstring" dir="in">
1385	<desc>The IP address of the guest which the NAT engine will forward
1386	matching packets to. An empty IP address is not acceptable.</desc>
1387	</param>
1388	<param name="guestPort" type="unsigned short" dir="in">
1389	<desc>The port number to forward.</desc>
1390	</param>
1391	</method>
1392	<method name="removePortForwardRule">
1393	<param name="iSipv6" type="boolean" dir="in"/>
1394	<param name="ruleName" type="wstring" dir="in"/>
1395	</method>
1396	<method name="start">
1397	<param name="trunkType" type="wstring" dir="in">
1398	<desc>
1399	Type of internal network trunk.
1400	</desc>
1401	</param>
1402	</method>
1403	<method name="stop"/>
1404	</interface>
1405
1406	<interface
1407	name="IDHCPServer" extends="$unknown"
1408	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1409	wsmap="managed"
1410	>
1411	<desc>
1412	The IDHCPServer interface represents the vbox DHCP server configuration.
1413
1414	To enumerate all the DHCP servers on the host, use the
1415	<link to="IVirtualBox::DHCPServers"/> attribute.
1416	</desc>
1417
1418	<attribute name="enabled" type="boolean">
1419	<desc>
1420	specifies if the DHCP server is enabled
1421	</desc>
1422	</attribute>
1423
1424	<attribute name="IPAddress" type="wstring" readonly="yes">
1425	<desc>
1426	specifies server IP
1427	</desc>
1428	</attribute>
1429
1430	<attribute name="networkMask" type="wstring" readonly="yes">
1431	<desc>
1432	specifies server network mask
1433	</desc>
1434	</attribute>
1435
1436	<attribute name="networkName" type="wstring" readonly="yes">
1437	<desc>
1438	specifies internal network name the server is used for
1439	</desc>
1440	</attribute>
1441
1442	<attribute name="lowerIP" type="wstring" readonly="yes">
1443	<desc>
1444	specifies from IP address in server address range
1445	</desc>
1446	</attribute>
1447
1448	<attribute name="upperIP" type="wstring" readonly="yes">
1449	<desc>
1450	specifies to IP address in server address range
1451	</desc>
1452	</attribute>
1453
1454	<method name="setConfiguration">
1455	<desc>
1456	configures the server
1457	<result name="E_INVALIDARG">
1458	invalid configuration supplied
1459	</result>
1460	</desc>
1461	<param name="IPAddress" type="wstring" dir="in">
1462	<desc>
1463	server IP address
1464	</desc>
1465	</param>
1466	<param name="networkMask" type="wstring" dir="in">
1467	<desc>
1468	server network mask
1469	</desc>
1470	</param>
1471	<param name="FromIPAddress" type="wstring" dir="in">
1472	<desc>
1473	server From IP address for address range
1474	</desc>
1475	</param>
1476	<param name="ToIPAddress" type="wstring" dir="in">
1477	<desc>
1478	server To IP address for address range
1479	</desc>
1480	</param>
1481	</method>
1482
1483	<method name="start">
1484	<desc>
1485	Starts DHCP server process.
1486	<result name="E_FAIL">
1487	Failed to start the process.
1488	</result>
1489	</desc>
1490	<param name="networkName" type="wstring" dir="in">
1491	<desc>
1492	Name of internal network DHCP server should attach to.
1493	</desc>
1494	</param>
1495	<param name="trunkName" type="wstring" dir="in">
1496	<desc>
1497	Name of internal network trunk.
1498	</desc>
1499	</param>
1500	<param name="trunkType" type="wstring" dir="in">
1501	<desc>
1502	Type of internal network trunk.
1503	</desc>
1504	</param>
1505	</method>
1506
1507	<method name="stop">
1508	<desc>
1509	Stops DHCP server process.
1510	<result name="E_FAIL">
1511	Failed to stop the process.
1512	</result>
1513	</desc>
1514	</method>
1515	</interface>
1516
1517	<interface
1518	name="IVirtualBox" extends="$unknown"
1519	uuid="fafa4e17-1ee2-4905-a10e-fe7c18bf5554"
1520	wsmap="managed"
1521	>
1522	<desc>
1523	The IVirtualBox interface represents the main interface exposed by the
1524	product that provides virtual machine management.
1525
1526	An instance of IVirtualBox is required for the product to do anything
1527	useful. Even though the interface does not expose this, internally,
1528	IVirtualBox is implemented as a singleton and actually lives in the
1529	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1530	IVirtualBox can track the state of all virtual machines on a particular
1531	host, regardless of which frontend started them.
1532
1533	To enumerate all the virtual machines on the host, use the
1534	<link to="IVirtualBox::machines"/> attribute.
1535	</desc>
1536
1537	<attribute name="version" type="wstring" readonly="yes">
1538	<desc>
1539	A string representing the version number of the product. The
1540	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1541	last number represents the build number and will frequently change.
1542
1543	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1544	in prerelease builds. Non-Oracle builds may (/shall) also have a
1545	publisher tag, at the end. The publisher tag starts with an underscore
1546	just like the prerelease build type tag.
1547	</desc>
1548	</attribute>
1549
1550	<attribute name="versionNormalized" type="wstring" readonly="yes">
1551	<desc>
1552	A string representing the version number of the product,
1553	without the publisher information (but still with other tags).
1554	See <link to="#version" />.
1555	</desc>
1556	</attribute>
1557
1558	<attribute name="revision" type="unsigned long" readonly="yes">
1559	<desc>
1560	The internal build revision number of the product.
1561	</desc>
1562	</attribute>
1563
1564	<attribute name="packageType" type="wstring" readonly="yes">
1565	<desc>
1566	A string representing the package type of this product. The
1567	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1568	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1569	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1570	this.
1571	</desc>
1572	</attribute>
1573
1574	<attribute name="APIVersion" type="wstring" readonly="yes">
1575	<desc>
1576	A string representing the VirtualBox API version number. The format is
1577	2 integer numbers divided by an underscore (e.g. 1_0). After the
1578	first public release of packages with a particular API version the
1579	API will not be changed in an incompatible way. Note that this
1580	guarantee does not apply to development builds, and also there is no
1581	guarantee that this version is identical to the first two integer
1582	numbers of the package version.
1583	</desc>
1584	</attribute>
1585
1586	<attribute name="homeFolder" type="wstring" readonly="yes">
1587	<desc>
1588	Full path to the directory where the global settings file,
1589	<tt>VirtualBox.xml</tt>, is stored.
1590
1591	In this version of VirtualBox, the value of this property is
1592	always <tt><user_dir>/.VirtualBox</tt> (where
1593	<tt><user_dir></tt> is the path to the user directory,
1594	as determined by the host OS), and cannot be changed.
1595
1596	This path is also used as the base to resolve relative paths in
1597	places where relative paths are allowed (unless otherwise
1598	expressly indicated).
1599	</desc>
1600	</attribute>
1601
1602	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1603	<desc>
1604	Full name of the global settings file.
1605	The value of this property corresponds to the value of
1606	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1607	</desc>
1608	</attribute>
1609
1610	<attribute name="host" type="IHost" readonly="yes">
1611	<desc>Associated host object.</desc>
1612	</attribute>
1613
1614	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1615	<desc>Associated system information object.</desc>
1616	</attribute>
1617
1618	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1619	<desc>
1620	Array of machine objects registered within this VirtualBox instance.
1621	</desc>
1622	</attribute>
1623
1624	<attribute name="machineGroups" type="wstring" readonly="yes" safearray="yes">
1625	<desc>
1626	Array of all machine group names which are used by the machines which
1627	are accessible. Each group is only listed once, however they are listed
1628	in no particular order and there is no guarantee that there are no gaps
1629	in the group hierarchy (i.e. <tt>"/"</tt>, <tt>"/group/subgroup"</tt>
1630	is a valid result).
1631	</desc>
1632	</attribute>
1633
1634	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1635	<desc>
1636	Array of medium objects known to this VirtualBox installation.
1637
1638	This array contains only base media. All differencing
1639	media of the given base medium can be enumerated using
1640	<link to="IMedium::children"/>.
1641	</desc>
1642	</attribute>
1643
1644	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1645	<desc>
1646	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1647	</desc>
1648	</attribute>
1649
1650	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1651	<desc>
1652	Array of floppy image objects currently in use by this VirtualBox instance.
1653	</desc>
1654	</attribute>
1655
1656	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1657
1658	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1659
1660	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1661	<desc>
1662	Collection of global shared folders. Global shared folders are
1663	available to all virtual machines.
1664
1665	New shared folders are added to the collection using
1666	<link to="#createSharedFolder"/>. Existing shared folders can be
1667	removed using <link to="#removeSharedFolder"/>.
1668
1669	<note>
1670	In the current version of the product, global shared folders are not
1671	implemented and therefore this collection is always empty.
1672	</note>
1673	</desc>
1674	</attribute>
1675
1676	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1677	<desc>
1678	Associated performance collector object.
1679	</desc>
1680	</attribute>
1681
1682	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1683	<desc>
1684	DHCP servers.
1685	</desc>
1686	</attribute>
1687	<!-- Array of NAT networks -->
1688	<attribute name="NATNetworks" type="INATNetwork" safearray="yes" readonly="yes"/>
1689
1690	<attribute name="eventSource" type="IEventSource" readonly="yes">
1691	<desc>
1692	Event source for VirtualBox events.
1693	</desc>
1694	</attribute>
1695
1696	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1697	<desc>
1698	The extension pack manager.
1699	</desc>
1700	</attribute>
1701
1702
1703	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1704	<desc>
1705	Names of all internal networks.
1706	</desc>
1707	</attribute>
1708
1709	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1710	<desc>
1711	Names of all generic network drivers.
1712	</desc>
1713	</attribute>
1714
1715	<method name="composeMachineFilename">
1716	<desc>
1717	Returns a recommended full path of the settings file name for a new virtual
1718	machine.
1719
1720	This API serves two purposes:
1721
1722	<ul>
1723	<li>It gets called by <link to="#createMachine" /> if @c null or
1724	empty string (which is recommended) is specified for the
1725	@a settingsFile argument there, which means that API should use
1726	a recommended default file name.</li>
1727
1728	<li>It can be called manually by a client software before creating a machine,
1729	e.g. if that client wants to pre-create the machine directory to create
1730	virtual hard disks in that directory together with the new machine
1731	settings file. In that case, the file name should be stripped from the
1732	full settings file path returned by this function to obtain the
1733	machine directory.</li>
1734	</ul>
1735
1736	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1737	details about the machine name.
1738
1739	@a groupName defines which additional subdirectory levels should be
1740	included. It must be either a valid group name or @c null or empty
1741	string which designates that the machine will not be related to a
1742	machine group.
1743
1744	If @a baseFolder is a @c null or empty string (which is recommended), the
1745	default machine settings folder
1746	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1747	a base folder for the created machine, resulting in a file name like
1748	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1749	will be used.
1750
1751	This method does not access the host disks. In particular, it does not check
1752	for whether a machine with this name already exists.
1753	</desc>
1754	<param name="name" type="wstring" dir="in">
1755	<desc>Suggested machine name.</desc>
1756	</param>
1757	<param name="group" type="wstring" dir="in">
1758	<desc>Machine group name for the new machine or machine group. It is
1759	used to determine the right subdirectory.</desc>
1760	</param>
1761	<param name="createFlags" type="wstring" dir="in">
1762	<desc>Machine creation flags, see <link to="#createMachine" /> (optional).</desc>
1763	</param>
1764	<param name="baseFolder" type="wstring" dir="in">
1765	<desc>Base machine folder (optional).</desc>
1766	</param>
1767	<param name="file" type="wstring" dir="return">
1768	<desc>Fully qualified path where the machine would be created.</desc>
1769	</param>
1770	</method>
1771
1772	<method name="createMachine">
1773	<desc>
1774	Creates a new virtual machine by creating a machine settings file at
1775	the given location.
1776
1777	VirtualBox machine settings files use a custom XML dialect. Starting
1778	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1779	and machine files can be created at arbitrary locations.
1780
1781	However, it is recommended that machines are created in the default
1782	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1783	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1784	@c null or empty string (which is recommended) for the @a settingsFile
1785	argument, <link to="#composeMachineFilename" /> is called automatically
1786	to have such a recommended name composed based on the machine name
1787	given in the @a name argument and the primary group.
1788
1789	If the resulting settings file already exists, this method will fail,
1790	unless the forceOverwrite flag is set.
1791
1792	The new machine is created unregistered, with the initial configuration
1793	set according to the specified guest OS type. A typical sequence of
1794	actions to create a new virtual machine is as follows:
1795
1796	<ol>
1797	<li>
1798	Call this method to have a new machine created. The returned machine
1799	object will be "mutable" allowing to change any machine property.
1800	</li>
1801
1802	<li>
1803	Configure the machine using the appropriate attributes and methods.
1804	</li>
1805
1806	<li>
1807	Call <link to="IMachine::saveSettings" /> to write the settings
1808	to the machine's XML settings file. The configuration of the newly
1809	created machine will not be saved to disk until this method is
1810	called.
1811	</li>
1812
1813	<li>
1814	Call <link to="#registerMachine" /> to add the machine to the list
1815	of machines known to VirtualBox.
1816	</li>
1817	</ol>
1818
1819	The specified guest OS type identifier must match an ID of one of known
1820	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1821	array.
1822
1823	<note>
1824	There is no way to change the name of the settings file or
1825	subfolder of the created machine directly.
1826	</note>
1827
1828	<result name="VBOX_E_OBJECT_NOT_FOUND">
1829	@a osTypeId is invalid.
1830	</result>
1831	<result name="VBOX_E_FILE_ERROR">
1832	Resulting settings file name is invalid or the settings file already
1833	exists or could not be created due to an I/O error.
1834	</result>
1835	<result name="E_INVALIDARG">
1836	@a name is empty or @c null.
1837	</result>
1838	</desc>
1839
1840	<param name="settingsFile" type="wstring" dir="in">
1841	<desc>Fully qualified path where the settings file should be created,
1842	empty string or @c null for a default folder and file based on the
1843	@a name argument and the primary group.
1844	(see <link to="#composeMachineFilename" />).</desc>
1845	</param>
1846	<param name="name" type="wstring" dir="in">
1847	<desc>Machine name.</desc>
1848	</param>
1849	<param name="groups" type="wstring" safearray="yes" dir="in">
1850	<desc>Array of group names. @c null or an empty array have the same
1851	meaning as an array with just the empty string or <tt>"/"</tt>, i.e.
1852	create a machine without group association.</desc>
1853	</param>
1854	<param name="osTypeId" type="wstring" dir="in">
1855	<desc>Guest OS Type ID.</desc>
1856	</param>
1857	<param name="flags" type="wstring" dir="in">
1858	<desc>
1859	Additional property parameters, passed as a comma-separated list of
1860	"name=value" type entries. The following ones are recognized:
1861	<tt>forceOverwrite=1</tt> to overwrite an existing machine settings
1862	file, <tt>UUID=<uuid></tt> to specify a machine UUID and
1863	<tt>directoryIncludesUUID=1</tt> to switch to a special VM directory
1864	naming scheme which should not be used unless necessary.
1865	</desc>
1866	</param>
1867	<param name="machine" type="IMachine" dir="return">
1868	<desc>Created machine object.</desc>
1869	</param>
1870	</method>
1871
1872	<method name="openMachine">
1873	<desc>
1874	Opens a virtual machine from the existing settings file.
1875	The opened machine remains unregistered until you call
1876	<link to="#registerMachine"/>.
1877
1878	The specified settings file name must be fully qualified.
1879	The file must exist and be a valid machine XML settings file
1880	whose contents will be used to construct the machine object.
1881
1882	<result name="VBOX_E_FILE_ERROR">
1883	Settings file name invalid, not found or sharing violation.
1884	</result>
1885	</desc>
1886	<param name="settingsFile" type="wstring" dir="in">
1887	<desc>
1888	Name of the machine settings file.
1889	</desc>
1890	</param>
1891	<param name="machine" type="IMachine" dir="return">
1892	<desc>Opened machine object.</desc>
1893	</param>
1894	<note>
1895	<link to="IMachine::settingsModified"/> will return
1896	@c false for the created machine, until any of machine settings
1897	are changed.
1898	</note>
1899	</method>
1900
1901	<method name="registerMachine">
1902	<desc>
1903
1904	Registers the machine previously created using
1905	<link to="#createMachine"/> or opened using
1906	<link to="#openMachine"/> within this VirtualBox installation. After
1907	successful method invocation, the
1908	<link to="IMachineRegisteredEvent"/> event is fired.
1909
1910	<note>
1911	This method implicitly calls <link to="IMachine::saveSettings"/>
1912	to save all current machine settings before registering it.
1913	</note>
1914
1915	<result name="VBOX_E_OBJECT_NOT_FOUND">
1916	No matching virtual machine found.
1917	</result>
1918	<result name="VBOX_E_INVALID_OBJECT_STATE">
1919	Virtual machine was not created within this VirtualBox instance.
1920	</result>
1921
1922	</desc>
1923	<param name="machine" type="IMachine" dir="in"/>
1924	</method>
1925
1926	<method name="findMachine">
1927	<desc>
1928	Attempts to find a virtual machine given its name or UUID.
1929
1930	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1931	cannot safely be determined.</note>
1932
1933	<result name="VBOX_E_OBJECT_NOT_FOUND">
1934	Could not find registered machine matching @a nameOrId.
1935	</result>
1936
1937	</desc>
1938	<param name="nameOrId" type="wstring" dir="in">
1939	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1940	</param>
1941	<param name="machine" type="IMachine" dir="return">
1942	<desc>Machine object, if found.</desc>
1943	</param>
1944	</method>
1945
1946	<method name="getMachinesByGroups">
1947	<desc>
1948	Gets all machine references which are in one of the specified groups.
1949	</desc>
1950	<param name="groups" type="wstring" dir="in" safearray="yes">
1951	<desc>What groups to match. The usual group list rules apply, i.e.
1952	passing an empty list will match VMs in the toplevel group, likewise
1953	the empty string.</desc>
1954	</param>
1955	<param name="machines" type="IMachine" dir="return" safearray="yes">
1956	<desc>All machines which matched.</desc>
1957	</param>
1958	</method>
1959
1960	<method name="getMachineStates">
1961	<desc>
1962	Gets the state of several machines in a single operation.
1963	</desc>
1964	<param name="machines" type="IMachine" dir="in" safearray="yes">
1965	<desc>Array with the machine references.</desc>
1966	</param>
1967	<param name="states" type="MachineState" dir="return" safearray="yes">
1968	<desc>Machine states, corresponding to the machines.</desc>
1969	</param>
1970	</method>
1971
1972	<method name="createAppliance">
1973	<desc>
1974	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1975	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1976	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1977	</desc>
1978	<param name="appliance" type="IAppliance" dir="return">
1979	<desc>New appliance.</desc>
1980	</param>
1981	</method>
1982
1983	<method name="createHardDisk">
1984	<desc>
1985	Creates a new base medium object that will use the given storage
1986	format and location for medium data.
1987
1988	The actual storage unit is not created by this method. In order to
1989	do it, and before you are able to attach the created medium to
1990	virtual machines, you must call one of the following methods to
1991	allocate a format-specific storage unit at the specified location:
1992	<ul>
1993	<li><link to="IMedium::createBaseStorage"/></li>
1994	<li><link to="IMedium::createDiffStorage"/></li>
1995	</ul>
1996
1997	Some medium attributes, such as <link to="IMedium::id"/>, may
1998	remain uninitialized until the medium storage unit is successfully
1999	created by one of the above methods.
2000
2001	After the storage unit is successfully created, it will be
2002	accessible through the <link to="#openMedium"/> method and can
2003	be found in the <link to="#hardDisks"/> array.
2004
2005	The list of all storage formats supported by this VirtualBox
2006	installation can be obtained using
2007	<link to="ISystemProperties::mediumFormats"/>. If the @a format
2008	attribute is empty or @c null then the default storage format
2009	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
2010	be used for creating a storage unit of the medium.
2011
2012	Note that the format of the location string is storage format specific.
2013	See <link to="IMedium::location"/> and IMedium for more details.
2014
2015	<result name="VBOX_E_OBJECT_NOT_FOUND">
2016	@a format identifier is invalid. See
2017	<link to="ISystemProperties::mediumFormats"/>.
2018	</result>
2019	<result name="VBOX_E_FILE_ERROR">
2020	@a location is a not valid file name (for file-based formats only).
2021	</result>
2022	</desc>
2023	<param name="format" type="wstring" dir="in">
2024	<desc>
2025	Identifier of the storage format to use for the new medium.
2026	</desc>
2027	</param>
2028	<param name="location" type="wstring" dir="in">
2029	<desc>
2030	Location of the storage unit for the new medium.
2031	</desc>
2032	</param>
2033	<param name="medium" type="IMedium" dir="return">
2034	<desc>Created medium object.</desc>
2035	</param>
2036	</method>
2037
2038	<method name="openMedium">
2039	<desc>
2040	Finds existing media or opens a medium from an existing storage location.
2041
2042	Once a medium has been opened, it can be passed to other VirtualBox
2043	methods, in particular to <link to="IMachine::attachDevice" />.
2044
2045	Depending on the given device type, the file at the storage location
2046	must be in one of the media formats understood by VirtualBox:
2047
2048	<ul>
2049	<li>With a "HardDisk" device type, the file must be a hard disk image
2050	in one of the formats supported by VirtualBox (see
2051	<link to="ISystemProperties::mediumFormats" />).
2052	After this method succeeds, if the medium is a base medium, it
2053	will be added to the <link to="#hardDisks"/> array attribute. </li>
2054	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
2055	After this method succeeds, the medium will be added to the
2056	<link to="#DVDImages"/> array attribute.</li>
2057	<li>With a "Floppy" device type, the file must be an RAW floppy image.
2058	After this method succeeds, the medium will be added to the
2059	<link to="#floppyImages"/> array attribute.</li>
2060	</ul>
2061
2062	After having been opened, the medium can be re-found by this method
2063	and can be attached to virtual machines. See <link to="IMedium" /> for
2064	more details.
2065
2066	The UUID of the newly opened medium will either be retrieved from the
2067	storage location, if the format supports it (e.g. for hard disk images),
2068	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
2069	If for some reason you need to change the medium's UUID, use
2070	<link to="IMedium::setIds" />.
2071
2072	If a differencing hard disk medium is to be opened by this method, the
2073	operation will succeed only if its parent medium and all ancestors,
2074	if any, are already known to this VirtualBox installation (for example,
2075	were opened by this method before).
2076
2077	This method attempts to guess the storage format of the specified medium
2078	by reading medium data at the specified location.
2079
2080	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
2081	the image is opened for read/write access and must have according permissions,
2082	as VirtualBox may actually write status information into the disk's metadata
2083	sections.
2084
2085	Note that write access is required for all typical hard disk usage in VirtualBox,
2086	since VirtualBox may need to write metadata such as a UUID into the image.
2087	The only exception is opening a source image temporarily for copying and
2088	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
2089	again soon.
2090
2091	The format of the location string is storage format specific. See
2092	<link to="IMedium::location"/> and IMedium for more details.
2093
2094	<result name="VBOX_E_FILE_ERROR">
2095	Invalid medium storage file location or could not find the medium
2096	at the specified location.
2097	</result>
2098	<result name="VBOX_E_IPRT_ERROR">
2099	Could not get medium storage format.
2100	</result>
2101	<result name="E_INVALIDARG">
2102	Invalid medium storage format.
2103	</result>
2104	<result name="VBOX_E_INVALID_OBJECT_STATE">
2105	Medium has already been added to a media registry.
2106	</result>
2107	</desc>
2108	<param name="location" type="wstring" dir="in">
2109	<desc>
2110	Location of the storage unit that contains medium data in one of
2111	the supported storage formats.
2112	</desc>
2113	</param>
2114	<param name="deviceType" type="DeviceType" dir="in">
2115	<desc>
2116	Must be one of "HardDisk", "DVD" or "Floppy".
2117	</desc>
2118	</param>
2119	<param name="accessMode" type="AccessMode" dir="in">
2120	<desc>Whether to open the image in read/write or read-only mode. For
2121	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
2122	</param>
2123	<param name="forceNewUuid" type="boolean" dir="in">
2124	<desc>Allows the caller to request a completely new medium UUID for
2125	the image which is to be opened. Useful if one intends to open an exact
2126	copy of a previously opened image, as this would normally fail due to
2127	the duplicate UUID.</desc>
2128	</param>
2129	<param name="medium" type="IMedium" dir="return">
2130	<desc>Opened medium object.</desc>
2131	</param>
2132	</method>
2133
2134	<method name="getGuestOSType">
2135	<desc>
2136	Returns an object describing the specified guest OS type.
2137
2138	The requested guest OS type is specified using a string which is a
2139	mnemonic identifier of the guest operating system, such as
2140	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2141	particular virtual machine can be read or set using the
2142	<link to="IMachine::OSTypeId"/> attribute.
2143
2144	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2145	available guest OS type objects. Each object has an
2146	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2147	the guest OS this object describes.
2148
2149	<result name="E_INVALIDARG">
2150	@a id is not a valid Guest OS type.
2151	</result>
2152
2153	</desc>
2154	<param name="id" type="uuid" mod="string" dir="in">
2155	<desc>Guest OS type ID string.</desc>
2156	</param>
2157	<param name="type" type="IGuestOSType" dir="return">
2158	<desc>Guest OS type object.</desc>
2159	</param>
2160	</method>
2161
2162	<method name="createSharedFolder">
2163	<desc>
2164	Creates a new global shared folder by associating the given logical
2165	name with the given host path, adds it to the collection of shared
2166	folders and starts sharing it. Refer to the description of
2167	<link to="ISharedFolder"/> to read more about logical names.
2168	<note>
2169	In the current implementation, this operation is not
2170	implemented.
2171	</note>
2172	</desc>
2173	<param name="name" type="wstring" dir="in">
2174	<desc>Unique logical name of the shared folder.</desc>
2175	</param>
2176	<param name="hostPath" type="wstring" dir="in">
2177	<desc>Full path to the shared folder in the host file system.</desc>
2178	</param>
2179	<param name="writable" type="boolean" dir="in">
2180	<desc>Whether the share is writable or readonly</desc>
2181	</param>
2182	<param name="automount" type="boolean" dir="in">
2183	<desc>Whether the share gets automatically mounted by the guest
2184	or not.</desc>
2185	</param>
2186	</method>
2187
2188	<method name="removeSharedFolder">
2189	<desc>
2190	Removes the global shared folder with the given name previously
2191	created by <link to="#createSharedFolder"/> from the collection of
2192	shared folders and stops sharing it.
2193	<note>
2194	In the current implementation, this operation is not
2195	implemented.
2196	</note>
2197	</desc>
2198	<param name="name" type="wstring" dir="in">
2199	<desc>Logical name of the shared folder to remove.</desc>
2200	</param>
2201	</method>
2202
2203	<method name="getExtraDataKeys">
2204	<desc>
2205	Returns an array representing the global extra data keys which currently
2206	have values defined.
2207	</desc>
2208	<param name="keys" type="wstring" dir="return" safearray="yes">
2209	<desc>Array of extra data keys.</desc>
2210	</param>
2211	</method>
2212
2213	<method name="getExtraData">
2214	<desc>
2215	Returns associated global extra data.
2216
2217	If the requested data @a key does not exist, this function will
2218	succeed and return an empty string in the @a value argument.
2219
2220	<result name="VBOX_E_FILE_ERROR">
2221	Settings file not accessible.
2222	</result>
2223	<result name="VBOX_E_XML_ERROR">
2224	Could not parse the settings file.
2225	</result>
2226
2227	</desc>
2228	<param name="key" type="wstring" dir="in">
2229	<desc>Name of the data key to get.</desc>
2230	</param>
2231	<param name="value" type="wstring" dir="return">
2232	<desc>Value of the requested data key.</desc>
2233	</param>
2234	</method>
2235
2236	<method name="setExtraData">
2237	<desc>
2238	Sets associated global extra data.
2239
2240	If you pass @c null or empty string as a key @a value, the given @a key
2241	will be deleted.
2242
2243	<note>
2244	Before performing the actual data change, this method will ask all
2245	registered event listener using the
2246	<link to="IExtraDataCanChangeEvent"/>
2247	notification for a permission. If one of the listeners refuses the
2248	new value, the change will not be performed.
2249	</note>
2250	<note>
2251	On success, the
2252	<link to="IExtraDataChangedEvent"/> notification
2253	is called to inform all registered listeners about a successful data
2254	change.
2255	</note>
2256
2257	<result name="VBOX_E_FILE_ERROR">
2258	Settings file not accessible.
2259	</result>
2260	<result name="VBOX_E_XML_ERROR">
2261	Could not parse the settings file.
2262	</result>
2263	<result name="E_ACCESSDENIED">
2264	Modification request refused.
2265	</result>
2266
2267	</desc>
2268	<param name="key" type="wstring" dir="in">
2269	<desc>Name of the data key to set.</desc>
2270	</param>
2271	<param name="value" type="wstring" dir="in">
2272	<desc>Value to assign to the key.</desc>
2273	</param>
2274	</method>
2275
2276	<method name="setSettingsSecret">
2277	<desc>
2278	Unlocks the secret data by passing the unlock password to the
2279	server. The server will cache the password for that machine.
2280
2281	<result name="VBOX_E_INVALID_VM_STATE">
2282	Virtual machine is not mutable.
2283	</result>
2284
2285	</desc>
2286	<param name="password" type="wstring" dir="in">
2287	<desc>
2288	The cipher key.
2289	</desc>
2290	</param>
2291	</method>
2292
2293	<!--method name="createDHCPServerForInterface">
2294	<desc>
2295	Creates a DHCP server settings to be used for the given interface
2296	<result name="E_INVALIDARG">
2297	Host network interface @a name already exists.
2298	</result>
2299	</desc>
2300	<param name="interface" type="IHostNetworkInterface" dir="in">
2301	<desc>Network Interface</desc>
2302	</param>
2303	<param name="server" type="IDHCPServer" dir="out">
2304	<desc>DHCP server settings</desc>
2305	</param>
2306	</method-->
2307
2308	<method name="createDHCPServer">
2309	<desc>
2310	Creates a DHCP server settings to be used for the given internal network name
2311	<result name="E_INVALIDARG">
2312	Host network interface @a name already exists.
2313	</result>
2314	</desc>
2315	<param name="name" type="wstring" dir="in">
2316	<desc>server name</desc>
2317	</param>
2318	<param name="server" type="IDHCPServer" dir="return">
2319	<desc>DHCP server settings</desc>
2320	</param>
2321	</method>
2322
2323	<method name="findDHCPServerByNetworkName">
2324	<desc>
2325	Searches a DHCP server settings to be used for the given internal network name
2326	<result name="E_INVALIDARG">
2327	Host network interface @a name already exists.
2328	</result>
2329
2330	</desc>
2331	<param name="name" type="wstring" dir="in">
2332	<desc>server name</desc>
2333	</param>
2334	<param name="server" type="IDHCPServer" dir="return">
2335	<desc>DHCP server settings</desc>
2336	</param>
2337	</method>
2338
2339	<!--method name="findDHCPServerForInterface">
2340	<desc>
2341	Searches a DHCP server settings to be used for the given interface
2342	<result name="E_INVALIDARG">
2343	Host network interface @a name already exists.
2344	</result>
2345	</desc>
2346	<param name="interface" type="IHostNetworkInterface" dir="in">
2347	<desc>Network Interface</desc>
2348	</param>
2349	<param name="server" type="IDHCPServer" dir="out">
2350	<desc>DHCP server settings</desc>
2351	</param>
2352	</method-->
2353
2354	<method name="removeDHCPServer">
2355	<desc>
2356	Removes the DHCP server settings
2357	<result name="E_INVALIDARG">
2358	Host network interface @a name already exists.
2359	</result>
2360	</desc>
2361	<param name="server" type="IDHCPServer" dir="in">
2362	<desc>DHCP server settings to be removed</desc>
2363	</param>
2364	</method>
2365
2366	<!-- bunch of metods to create NAT -->
2367	<method name="createNATNetwork">
2368	<!-- Here we create a record in NAT network array with name
2369	and gateway/network parameters this information should
2370	be enough for VBoxNet[Lwip]NAT and VBoxNetDHCP for
2371	servicing the guests.
2372	-->
2373	<param name="networkName" type="wstring" dir="in"/>
2374	<param name="network" type="INATNetwork" dir="return"/>
2375	</method>
2376
2377	<!--
2378	Returns the NATNetwork by name, e.g. for adding porforward rule or delition.
2379	-->
2380	<method name="findNATNetworkByName">
2381	<param name="networkName" type="wstring" dir="in"/>
2382	<param name="network" type="INATNetwork" dir="return"/>
2383	</method>
2384	<!--
2385	Deletes given NAT network.
2386	-->
2387	<method name="removeNATNetwork">
2388	<param name="network" type="INATNetwork" dir="in"/>
2389	</method>
2390
2391	<method name="checkFirmwarePresent">
2392	<desc>
2393	Check if this VirtualBox installation has a firmware
2394	of the given type available, either system-wide or per-user.
2395	Optionally, this may return a hint where this firmware can be
2396	downloaded from.
2397	</desc>
2398	<param name="firmwareType" type="FirmwareType" dir="in">
2399	<desc>
2400	Type of firmware to check.
2401	</desc>
2402	</param>
2403	<param name="version" type="wstring" dir="in">
2404	<desc>Expected version number, usually empty string (presently ignored).</desc>
2405	</param>
2406
2407	<param name="url" type="wstring" dir="out">
2408	<desc>
2409	Suggested URL to download this firmware from.
2410	</desc>
2411	</param>
2412
2413	<param name="file" type="wstring" dir="out">
2414	<desc>
2415	Filename of firmware, only valid if result == TRUE.
2416	</desc>
2417	</param>
2418
2419	<param name="result" type="boolean" dir="return">
2420	<desc>If firmware of this type and version is available.</desc>
2421	</param>
2422	</method>
2423
2424	</interface>
2425
2426	<!--
2427	// IVFSExplorer
2428	/////////////////////////////////////////////////////////////////////////
2429	-->
2430
2431	<enum
2432	name="VFSType"
2433	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2434	>
2435	<desc>
2436	Virtual file systems supported by VFSExplorer.
2437	</desc>
2438
2439	<const name="File" value="1" />
2440	<const name="Cloud" value="2" />
2441	<const name="S3" value="3" />
2442	<const name="WebDav" value="4" />
2443	</enum>
2444
2445	<enum
2446	name="VFSFileType"
2447	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2448	>
2449	<desc>
2450	File types known by VFSExplorer.
2451	</desc>
2452
2453	<const name="Unknown" value="1" />
2454	<const name="Fifo" value="2" />
2455	<const name="DevChar" value="3" />
2456	<const name="Directory" value="4" />
2457	<const name="DevBlock" value="5" />
2458	<const name="File" value="6" />
2459	<const name="SymLink" value="7" />
2460	<const name="Socket" value="8" />
2461	<const name="WhiteOut" value="9" />
2462	</enum>
2463
2464	<interface
2465	name="IVFSExplorer" extends="$unknown"
2466	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2467	wsmap="managed"
2468	>
2469	<desc>
2470	The VFSExplorer interface unifies access to different file system
2471	types. This includes local file systems as well remote file systems like
2472	S3. For a list of supported types see <link to="VFSType" />.
2473	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2474	</desc>
2475
2476	<attribute name="path" type="wstring" readonly="yes">
2477	<desc>Returns the current path in the virtual file system.</desc>
2478	</attribute>
2479
2480	<attribute name="type" type="VFSType" readonly="yes">
2481	<desc>Returns the file system type which is currently in use.</desc>
2482	</attribute>
2483
2484	<method name="update">
2485	<desc>Updates the internal list of files/directories from the
2486	current directory level. Use <link to="#entryList" /> to get the full list
2487	after a call to this method.</desc>
2488
2489	<param name="progress" type="IProgress" dir="return">
2490	<desc>Progress object to track the operation completion.</desc>
2491	</param>
2492	</method>
2493
2494	<method name="cd">
2495	<desc>Change the current directory level.</desc>
2496
2497	<param name="dir" type="wstring" dir="in">
2498	<desc>The name of the directory to go in.</desc>
2499	</param>
2500
2501	<param name="progress" type="IProgress" dir="return">
2502	<desc>Progress object to track the operation completion.</desc>
2503	</param>
2504	</method>
2505
2506	<method name="cdUp">
2507	<desc>Go one directory upwards from the current directory level.</desc>
2508
2509	<param name="progress" type="IProgress" dir="return">
2510	<desc>Progress object to track the operation completion.</desc>
2511	</param>
2512	</method>
2513
2514	<method name="entryList">
2515	<desc>Returns a list of files/directories after a call to <link
2516	to="#update" />. The user is responsible for keeping this internal
2517	list up do date.</desc>
2518
2519	<param name="names" type="wstring" safearray="yes" dir="out">
2520	<desc>The list of names for the entries.</desc>
2521	</param>
2522
2523	<param name="types" type="unsigned long" safearray="yes" dir="out">
2524	<desc>The list of types for the entries.</desc>
2525	</param>
2526
2527	<param name="sizes" type="unsigned long" safearray="yes" dir="out">
2528	<desc>The list of sizes (in bytes) for the entries.</desc>
2529	</param>
2530
2531	<param name="modes" type="unsigned long" safearray="yes" dir="out">
2532	<desc>The list of file modes (in octal form) for the entries.</desc>
2533	</param>
2534	</method>
2535
2536	<method name="exists">
2537	<desc>Checks if the given file list exists in the current directory
2538	level.</desc>
2539
2540	<param name="names" type="wstring" safearray="yes" dir="in">
2541	<desc>The names to check.</desc>
2542	</param>
2543
2544	<param name="exists" type="wstring" safearray="yes" dir="return">
2545	<desc>The names which exist.</desc>
2546	</param>
2547	</method>
2548
2549	<method name="remove">
2550	<desc>Deletes the given files in the current directory level.</desc>
2551
2552	<param name="names" type="wstring" safearray="yes" dir="in">
2553	<desc>The names to remove.</desc>
2554	</param>
2555
2556	<param name="progress" type="IProgress" dir="return">
2557	<desc>Progress object to track the operation completion.</desc>
2558	</param>
2559	</method>
2560
2561	</interface>
2562
2563	<enum
2564	name="ImportOptions" extends="$unknown"
2565	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2566	>
2567
2568	<desc>
2569	Import options, used with <link to="IAppliance::importMachines" />.
2570	</desc>
2571
2572	<const name="KeepAllMACs" value="1">
2573	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2574	</const>
2575	<const name="KeepNATMACs" value="2">
2576	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2577	</const>
2578
2579	</enum>
2580
2581
2582	<!--
2583	// IAppliance
2584	/////////////////////////////////////////////////////////////////////////
2585	-->
2586
2587	<interface
2588	name="IAppliance" extends="$unknown"
2589	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2590	wsmap="managed"
2591	>
2592	<desc>
2593	Represents a platform-independent appliance in OVF format. An instance of this is returned
2594	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2595	virtual machines within an appliance with VirtualBox.
2596
2597	The OVF standard suggests two different physical file formats:
2598
2599	<ol>
2600	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2601	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2602	this descriptor file references other files such as disk images, as OVF appliances typically
2603	do, those additional files must be in the same directory as the descriptor file.</li>
2604
2605	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2606	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2607	files and optionally other files.
2608
2609	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2610	be added with a later version.</li>
2611	</ol>
2612
2613	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2614	<link to="IMachine" /> involves the following sequence of API calls:
2615
2616	<ol>
2617	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2618	</li>
2619
2620	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2621	would like to import. So long as this file is syntactically valid, this will succeed
2622	and fill the appliance object with the parsed data from the OVF file.
2623	</li>
2624
2625	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2626	contents of the IAppliance attributes accordingly. These can be inspected by a
2627	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2628	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2629	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2630	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2631	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2632	The GUI can then give the user the option to confirm and/or change these suggestions.
2633	</li>
2634
2635	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2636	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2637	</li>
2638
2639	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2640	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2641	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2642	can be found in the <link to="#machines" /> array attribute.
2643	</li>
2644	</ol>
2645
2646	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2647
2648	<ol>
2649	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2650	an empty IAppliance object.
2651	</li>
2652
2653	<li>For each machine you would like to export, call <link to="IMachine::exportTo" />
2654	with the IAppliance object you just created. Each such call creates one instance of
2655	<link to="IVirtualSystemDescription" /> inside the appliance.
2656	</li>
2657
2658	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2659	virtual system (machine) to override the suggestions made by the <link to="IMachine::exportTo"/> routine.
2660	</li>
2661
2662	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2663	file written.</li>
2664	</ol>
2665
2666	</desc>
2667
2668	<attribute name="path" type="wstring" readonly="yes">
2669	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2670	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2671	<link to="#write" /> (for export).
2672	This attribute is empty until one of these methods has been called.
2673	</desc>
2674	</attribute>
2675
2676	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2677	<desc>
2678	Array of virtual disk definitions. One such description exists for each
2679	disk definition in the OVF; each string array item represents one such piece of
2680	disk information, with the information fields separated by tab (\\t) characters.
2681
2682	The caller should be prepared for additional fields being appended to
2683	this string in future versions of VirtualBox and therefore check for
2684	the number of tabs in the strings returned.
2685
2686	In the current version, the following eight fields are returned per string
2687	in the array:
2688
2689	<ol>
2690	<li>Disk ID (unique string identifier given to disk)</li>
2691
2692	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2693
2694	<li>Populated size (optional unsigned integer indicating the current size of the
2695	disk; can be approximate; -1 if unspecified)</li>
2696
2697	<li>Format (string identifying the disk format, typically
2698	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2699
2700	<li>Reference (where to find the disk image, typically a file name; if empty,
2701	then the disk should be created on import)</li>
2702
2703	<li>Image size (optional unsigned integer indicating the size of the image,
2704	which need not necessarily be the same as the values specified above, since
2705	the image may be compressed or sparse; -1 if not specified)</li>
2706
2707	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2708	presently unsupported and always -1)</li>
2709
2710	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2711	</ol>
2712	</desc>
2713	</attribute>
2714
2715	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2716	<desc> Array of virtual system descriptions. One such description is created
2717	for each virtual system (machine) found in the OVF.
2718	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::exportTo" />
2719	(for export) has been called.
2720	</desc>
2721	</attribute>
2722
2723	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2724	<desc>
2725	Contains the UUIDs of the machines created from the information in this appliances. This is only
2726	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2727	succeeded.
2728	</desc>
2729	</attribute>
2730
2731	<method name="read">
2732	<desc>
2733	Reads an OVF file into the appliance object.
2734
2735	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2736	mere fact that this method returns successfully does not mean that VirtualBox supports all
2737	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2738	</desc>
2739	<param name="file" type="wstring" dir="in">
2740	<desc>
2741	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2742	on whether the appliance is distributed as a set of files or as a single file, respectively).
2743	</desc>
2744	</param>
2745	<param name="progress" type="IProgress" dir="return">
2746	<desc>Progress object to track the operation completion.</desc>
2747	</param>
2748	</method>
2749
2750	<method name="interpret">
2751	<desc>
2752	Interprets the OVF data that was read when the appliance was constructed. After
2753	calling this method, one can inspect the
2754	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2755	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2756	the appliance.
2757
2758	Calling this method is the second step of importing an appliance into VirtualBox;
2759	see <link to="IAppliance" /> for an overview.
2760
2761	After calling this method, one should call <link to="#getWarnings" /> to find out
2762	if problems were encountered during the processing which might later lead to
2763	errors.
2764	</desc>
2765	</method>
2766
2767	<method name="importMachines">
2768	<desc>
2769	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2770	and other interfaces that match the information contained in the appliance as
2771	closely as possible, as represented by the import instructions in the
2772	<link to="#virtualSystemDescriptions" /> array.
2773
2774	Calling this method is the final step of importing an appliance into VirtualBox;
2775	see <link to="IAppliance" /> for an overview.
2776
2777	Since importing the appliance will most probably involve copying and converting
2778	disk images, which can take a long time, this method operates asynchronously and
2779	returns an IProgress object to allow the caller to monitor the progress.
2780
2781	After the import succeeded, the UUIDs of the IMachine instances created can be
2782	retrieved from the <link to="#machines" /> array attribute.
2783	</desc>
2784
2785	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2786	<desc>Options for the importing operation.</desc>
2787	</param>
2788
2789	<param name="progress" type="IProgress" dir="return">
2790	<desc>Progress object to track the operation completion.</desc>
2791	</param>
2792	</method>
2793
2794	<method name="createVFSExplorer">
2795	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2796
2797	<param name="URI" type="wstring" dir="in">
2798	<desc>The URI describing the file system to use.</desc>
2799	</param>
2800
2801	<param name="explorer" type="IVFSExplorer" dir="return">
2802	<desc></desc>
2803	</param>
2804	</method>
2805
2806	<method name="write">
2807	<desc>
2808	Writes the contents of the appliance exports into a new OVF file.
2809
2810	Calling this method is the final step of exporting an appliance from VirtualBox;
2811	see <link to="IAppliance" /> for an overview.
2812
2813	Since exporting the appliance will most probably involve copying and converting
2814	disk images, which can take a long time, this method operates asynchronously and
2815	returns an IProgress object to allow the caller to monitor the progress.
2816	</desc>
2817	<param name="format" type="wstring" dir="in">
2818	<desc>
2819	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2820	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2821	</desc>
2822	</param>
2823	<param name="manifest" type="boolean" dir="in">
2824	<desc>
2825	Indicate if the optional manifest file (.mf) should be written. The manifest file
2826	is used for integrity checks prior import.
2827	</desc>
2828	</param>
2829	<param name="path" type="wstring" dir="in">
2830	<desc>
2831	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2832	on whether the appliance is distributed as a set of files or as a single file, respectively).
2833	</desc>
2834	</param>
2835	<param name="progress" type="IProgress" dir="return">
2836	<desc>Progress object to track the operation completion.</desc>
2837	</param>
2838	</method>
2839
2840	<method name="getWarnings">
2841	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2842
2843	<param name="warnings" type="wstring" dir="return" safearray="yes">
2844	<desc></desc>
2845	</param>
2846	</method>
2847
2848	</interface>
2849
2850	<enum
2851	name="VirtualSystemDescriptionType"
2852	uuid="303c0900-a746-4612-8c67-79003e91f459"
2853	>
2854	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2855	a configuration value.</desc>
2856
2857	<const name="Ignore" value="1" />
2858	<const name="OS" value="2" />
2859	<const name="Name" value="3" />
2860	<const name="Product" value="4" />
2861	<const name="Vendor" value="5" />
2862	<const name="Version" value="6" />
2863	<const name="ProductUrl" value="7" />
2864	<const name="VendorUrl" value="8" />
2865	<const name="Description" value="9" />
2866	<const name="License" value="10" />
2867	<const name="Miscellaneous" value="11" />
2868	<const name="CPU" value="12" />
2869	<const name="Memory" value="13" />
2870	<const name="HardDiskControllerIDE" value="14" />
2871	<const name="HardDiskControllerSATA" value="15" />
2872	<const name="HardDiskControllerSCSI" value="16" />
2873	<const name="HardDiskControllerSAS" value="17" />
2874	<const name="HardDiskImage" value="18" />
2875	<const name="Floppy" value="19" />
2876	<const name="CDROM" value="20" />
2877	<const name="NetworkAdapter" value="21" />
2878	<const name="USBController" value="22" />
2879	<const name="SoundCard" value="23" />
2880	<const name="SettingsFile" value="24">
2881	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2882	</const>
2883	</enum>
2884
2885	<enum
2886	name="VirtualSystemDescriptionValueType"
2887	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2888	>
2889	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2890	type to fetch.</desc>
2891
2892	<const name="Reference" value="1" />
2893	<const name="Original" value="2" />
2894	<const name="Auto" value="3" />
2895	<const name="ExtraConfig" value="4" />
2896
2897	</enum>
2898
2899	<interface
2900	name="IVirtualSystemDescription" extends="$unknown"
2901	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2902	wsmap="managed"
2903	>
2904
2905	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2906	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2907	<link to="IAppliance::interpret" /> has been called, that array contains information
2908	about how the virtual systems described in the OVF should best be imported into
2909	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2910	import an OVF into VirtualBox.
2911	</desc>
2912
2913	<attribute name="count" type="unsigned long" readonly="yes">
2914	<desc>Return the number of virtual system description entries.</desc>
2915	</attribute>
2916
2917	<method name="getDescription">
2918	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2919	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2920
2921	The list below identifies the value sets that are possible depending on the
2922	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2923	the array item with the same index in @a OVFValues[] will contain the original value as contained
2924	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2925	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2926	the @a aExtraConfigValues[] array item may also be used.
2927
2928	<ul>
2929	<li>
2930	"OS": the guest operating system type. There must be exactly one such array item on import. The
2931	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2932	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2933	item in @a OVFValues[] will contain a numerical value that described the operating system in the OVF.
2934	</li>
2935	<li>
2936	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2937	if none is present on import, then an automatic name will be created from the operating system
2938	type. The corresponding item im @a OVFValues[] will contain the suggested virtual machine name
2939	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2940	<link to="IMachine" /> name that does not exist yet.
2941	</li>
2942	<li>
2943	"Description": an arbitrary description.
2944	</li>
2945	<li>
2946	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2947	code to display such a license for agreement; the Main API does not enforce any such policy.
2948	</li>
2949	<li>
2950	Miscellaneous: reserved for future use.
2951	</li>
2952	<li>
2953	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2954	</li>
2955	<li>
2956	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2957	is present on import, then VirtualBox will set a meaningful default based on the operating system
2958	type.
2959	</li>
2960	<li>
2961	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2962	An optional value in @a OVFValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2963	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2964	writes into the OVF.
2965	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2966	type can use to specify which hard disk controller a virtual disk should be connected to.
2967	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2968	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2969	its virtual machines supports four channels (primary master, primary slave, secondary master,
2970	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2971	</li>
2972	<li>
2973	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2974	has no value in @a OVFValues[] or @a aVBoxValues[].
2975	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2976	</li>
2977	<li>
2978	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2979	The items in @a OVFValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2980	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2981	whereas VirtualBox considers it a class of storage controllers of its own; see
2982	<link to="StorageControllerType" />).
2983	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2984	</li>
2985	<li>
2986	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2987	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2988
2989	The array item in @a OVFValues[] will contain the file specification from the OVF file (without
2990	a path since the image file should be in the same location as the OVF file itself), whereas the
2991	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2992	hard disk image. This means that on import the image will be copied and converted from the
2993	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2994
2995	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2996	format: "controller=<index>;channel=<c>"
2997	In this string, <index> must be an integer specifying the hard disk controller to connect
2998	the image to. That number must be the index of an array item with one of the hard disk controller
2999	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
3000	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3001	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
3002	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
3003	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
3004	</li>
3005	<li>
3006	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
3007	attachment information as with "HardDiskImage" items.
3008	</li>
3009	<li>
3010	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
3011	attachment information as with "HardDiskImage" items.
3012	</li>
3013	<li>
3014	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
3015	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
3016	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3017	</li>
3018	<li>
3019	"USBController": a USB controller. There can be at most one such item. If and only if such an
3020	item ispresent, USB support will be enabled for the new virtual machine.
3021	</li>
3022	<li>
3023	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3024	present, sound support will be enabled for the new virtual machine. Note that the virtual
3025	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3026	may be different from the virtual soundcard expected by the appliance.
3027	</li>
3028	</ul>
3029
3030	</desc>
3031
3032	<param name="types" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3033	<desc></desc>
3034	</param>
3035
3036	<param name="refs" type="wstring" dir="out" safearray="yes">
3037	<desc></desc>
3038	</param>
3039
3040	<param name="OVFValues" type="wstring" dir="out" safearray="yes">
3041	<desc></desc>
3042	</param>
3043
3044	<param name="VBoxValues" type="wstring" dir="out" safearray="yes">
3045	<desc></desc>
3046	</param>
3047
3048	<param name="extraConfigValues" type="wstring" dir="out" safearray="yes">
3049	<desc></desc>
3050	</param>
3051
3052	</method>
3053
3054	<method name="getDescriptionByType">
3055	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3056	should be returned.</desc>
3057
3058	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3059	<desc></desc>
3060	</param>
3061
3062	<param name="types" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3063	<desc></desc>
3064	</param>
3065
3066	<param name="refs" type="wstring" dir="out" safearray="yes">
3067	<desc></desc>
3068	</param>
3069
3070	<param name="OVFValues" type="wstring" dir="out" safearray="yes">
3071	<desc></desc>
3072	</param>
3073
3074	<param name="VBoxValues" type="wstring" dir="out" safearray="yes">
3075	<desc></desc>
3076	</param>
3077
3078	<param name="extraConfigValues" type="wstring" dir="out" safearray="yes">
3079	<desc></desc>
3080	</param>
3081
3082	</method>
3083
3084	<method name="getValuesByType">
3085	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3086	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3087	values.</desc>
3088
3089	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3090	<desc></desc>
3091	</param>
3092
3093	<param name="which" type="VirtualSystemDescriptionValueType" dir="in">
3094	<desc></desc>
3095	</param>
3096
3097	<param name="values" type="wstring" dir="return" safearray="yes">
3098	<desc></desc>
3099	</param>
3100
3101	</method>
3102
3103	<method name="setFinalValues">
3104	<desc>
3105	This method allows the appliance's user to change the configuration for the virtual
3106	system descriptions. For each array item returned from <link to="#getDescription" />,
3107	you must pass in one boolean value and one configuration value.
3108
3109	Each item in the boolean array determines whether the particular configuration item
3110	should be enabled.
3111	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3112	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3113	and SoundCard.
3114
3115	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3116	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
3117	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
3118	for valid configuration values for the individual array item types. If the
3119	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3120	</desc>
3121
3122	<param name="enabled" type="boolean" dir="in" safearray="yes">
3123	<desc></desc>
3124	</param>
3125
3126	<param name="VBoxValues" type="wstring" dir="in" safearray="yes">
3127	<desc></desc>
3128	</param>
3129
3130	<param name="extraConfigValues" type="wstring" dir="in" safearray="yes">
3131	<desc></desc>
3132	</param>
3133	</method>
3134
3135	<method name="addDescription">
3136	<desc>
3137	This method adds an additional description entry to the stack of already
3138	available descriptions for this virtual system. This is handy for writing
3139	values which aren't directly supported by VirtualBox. One example would
3140	be the License type of <link to="VirtualSystemDescriptionType" />.
3141	</desc>
3142
3143	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3144	<desc></desc>
3145	</param>
3146
3147	<param name="VBoxValue" type="wstring" dir="in">
3148	<desc></desc>
3149	</param>
3150
3151	<param name="extraConfigValue" type="wstring" dir="in">
3152	<desc></desc>
3153	</param>
3154	</method>
3155	</interface>
3156
3157
3158	<!--
3159	// IMachine
3160	/////////////////////////////////////////////////////////////////////////
3161	-->
3162
3163	<interface
3164	name="IInternalMachineControl" extends="$unknown"
3165	uuid="dca36a92-703c-4649-98a4-f40c1ef0c336"
3166	internal="yes"
3167	wsmap="suppress"
3168	>
3169	<method name="setRemoveSavedStateFile">
3170	<desc>
3171	Updates the flag whether the saved state file is removed on a
3172	machine state change from Saved to PoweredOff.
3173	</desc>
3174	<param name="remove" type="boolean" dir="in"/>
3175	</method>
3176
3177	<method name="updateState">
3178	<desc>
3179	Updates the VM state.
3180	<note>
3181	This operation will also update the settings file with the correct
3182	information about the saved state file and delete this file from disk
3183	when appropriate.
3184	</note>
3185	</desc>
3186	<param name="state" type="MachineState" dir="in"/>
3187	</method>
3188
3189	<method name="getIPCId">
3190	<param name="id" type="wstring" dir="return"/>
3191	</method>
3192
3193	<method name="beginPowerUp">
3194	<desc>
3195	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3196	gives it the progress object that should be part of any pending
3197	<link to="IMachine::launchVMProcess"/> operations. The progress
3198	object may be called back to reflect an early cancelation, so some care
3199	have to be taken with respect to any cancelation callbacks. The console
3200	object will call <link to="IInternalMachineControl::endPowerUp"/>
3201	to signal the completion of the progress object.
3202	</desc>
3203	<param name="progress" type="IProgress" dir="in" />
3204	</method>
3205
3206	<method name="endPowerUp">
3207	<desc>
3208	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3209	This method may query status information from the progress object it
3210	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3211	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3212	call in order to complete that progress object.
3213	</desc>
3214	<param name="result" type="long" dir="in"/>
3215	</method>
3216
3217	<method name="beginPoweringDown">
3218	<desc>
3219	Called by the VM process to inform the server it wants to
3220	stop the VM execution and power down.
3221	</desc>
3222	<param name="progress" type="IProgress" dir="out">
3223	<desc>
3224	Progress object created by VBoxSVC to wait until
3225	the VM is powered down.
3226	</desc>
3227	</param>
3228	</method>
3229
3230	<method name="endPoweringDown">
3231	<desc>
3232	Called by the VM process to inform the server that powering
3233	down previously requested by #beginPoweringDown is either
3234	successfully finished or there was a failure.
3235
3236	<result name="VBOX_E_FILE_ERROR">
3237	Settings file not accessible.
3238	</result>
3239	<result name="VBOX_E_XML_ERROR">
3240	Could not parse the settings file.
3241	</result>
3242
3243	</desc>
3244
3245	<param name="result" type="long" dir="in">
3246	<desc>@c S_OK to indicate success.
3247	</desc>
3248	</param>
3249	<param name="errMsg" type="wstring" dir="in">
3250	<desc>@c human readable error message in case of failure.
3251	</desc>
3252	</param>
3253	</method>
3254
3255	<method name="runUSBDeviceFilters">
3256	<desc>
3257	Asks the server to run USB devices filters of the associated
3258	machine against the given USB device and tell if there is
3259	a match.
3260	<note>
3261	Intended to be used only for remote USB devices. Local
3262	ones don't require to call this method (this is done
3263	implicitly by the Host and USBProxyService).
3264	</note>
3265	</desc>
3266	<param name="device" type="IUSBDevice" dir="in"/>
3267	<param name="matched" type="boolean" dir="out"/>
3268	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3269	</method>
3270
3271	<method name="captureUSBDevice">
3272	<desc>
3273	Requests a capture of the given host USB device.
3274	When the request is completed, the VM process will
3275	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3276	notification.
3277	</desc>
3278	<param name="id" type="uuid" mod="string" dir="in"/>
3279	</method>
3280
3281	<method name="detachUSBDevice">
3282	<desc>
3283	Notification that a VM is going to detach (@a done = @c false) or has
3284	already detached (@a done = @c true) the given USB device.
3285	When the @a done = @c true request is completed, the VM process will
3286	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3287	notification.
3288	<note>
3289	In the @a done = @c true case, the server must run its own filters
3290	and filters of all VMs but this one on the detached device
3291	as if it were just attached to the host computer.
3292	</note>
3293	</desc>
3294	<param name="id" type="uuid" mod="string" dir="in"/>
3295	<param name="done" type="boolean" dir="in"/>
3296	</method>
3297
3298	<method name="autoCaptureUSBDevices">
3299	<desc>
3300	Requests a capture all matching USB devices attached to the host.
3301	When the request is completed, the VM process will
3302	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3303	notification per every captured device.
3304	</desc>
3305	</method>
3306
3307	<method name="detachAllUSBDevices">
3308	<desc>
3309	Notification that a VM that is being powered down. The done
3310	parameter indicates whether which stage of the power down
3311	we're at. When @a done = @c false the VM is announcing its
3312	intentions, while when @a done = @c true the VM is reporting
3313	what it has done.
3314	<note>
3315	In the @a done = @c true case, the server must run its own filters
3316	and filters of all VMs but this one on all detach devices as
3317	if they were just attached to the host computer.
3318	</note>
3319	</desc>
3320	<param name="done" type="boolean" dir="in"/>
3321	</method>
3322
3323	<method name="onSessionEnd">
3324	<desc>
3325	Triggered by the given session object when the session is about
3326	to close normally.
3327	</desc>
3328	<param name="session" type="ISession" dir="in">
3329	<desc>Session that is being closed</desc>
3330	</param>
3331	<param name="progress" type="IProgress" dir="return">
3332	<desc>
3333	Used to wait until the corresponding machine is actually
3334	dissociated from the given session on the server.
3335	Returned only when this session is a direct one.
3336	</desc>
3337	</param>
3338	</method>
3339
3340	<method name="beginSavingState">
3341	<desc>
3342	Called by the VM process to inform the server it wants to
3343	save the current state and stop the VM execution.
3344	</desc>
3345	<param name="progress" type="IProgress" dir="out">
3346	<desc>
3347	Progress object created by VBoxSVC to wait until
3348	the state is saved.
3349	</desc>
3350	</param>
3351	<param name="stateFilePath" type="wstring" dir="out">
3352	<desc>
3353	File path the VM process must save the execution state to.
3354	</desc>
3355	</param>
3356	</method>
3357
3358	<method name="endSavingState">
3359	<desc>
3360	Called by the VM process to inform the server that saving
3361	the state previously requested by #beginSavingState is either
3362	successfully finished or there was a failure.
3363
3364	<result name="VBOX_E_FILE_ERROR">
3365	Settings file not accessible.
3366	</result>
3367	<result name="VBOX_E_XML_ERROR">
3368	Could not parse the settings file.
3369	</result>
3370
3371	</desc>
3372
3373	<param name="result" type="long" dir="in">
3374	<desc>@c S_OK to indicate success.
3375	</desc>
3376	</param>
3377	<param name="errMsg" type="wstring" dir="in">
3378	<desc>@c human readable error message in case of failure.
3379	</desc>
3380	</param>
3381	</method>
3382
3383	<method name="adoptSavedState">
3384	<desc>
3385	Gets called by <link to="IConsole::adoptSavedState"/>.
3386	<result name="VBOX_E_FILE_ERROR">
3387	Invalid saved state file path.
3388	</result>
3389	</desc>
3390	<param name="savedStateFile" type="wstring" dir="in">
3391	<desc>Path to the saved state file to adopt.</desc>
3392	</param>
3393	</method>
3394
3395	<method name="beginTakingSnapshot">
3396	<desc>
3397	Called from the VM process to request from the server to perform the
3398	server-side actions of creating a snapshot (creating differencing images
3399	and the snapshot object).
3400
3401	<result name="VBOX_E_FILE_ERROR">
3402	Settings file not accessible.
3403	</result>
3404	<result name="VBOX_E_XML_ERROR">
3405	Could not parse the settings file.
3406	</result>
3407	</desc>
3408	<param name="initiator" type="IConsole" dir="in">
3409	<desc>The console object that initiated this call.</desc>
3410	</param>
3411	<param name="name" type="wstring" dir="in">
3412	<desc>Snapshot name.</desc>
3413	</param>
3414	<param name="description" type="wstring" dir="in">
3415	<desc>Snapshot description.</desc>
3416	</param>
3417	<param name="consoleProgress" type="IProgress" dir="in">
3418	<desc>
3419	Progress object created by the VM process tracking the
3420	snapshot's progress. This has the following sub-operations:
3421	<ul>
3422	<li>setting up (weight 1);</li>
3423	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3424	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3425	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3426	<li>finishing up (weight 1)</li>
3427	</ul>
3428	</desc>
3429	</param>
3430	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3431	<desc>
3432	Whether this is an online snapshot (i.e. the machine is running).
3433	</desc>
3434	</param>
3435	<param name="stateFilePath" type="wstring" dir="out">
3436	<desc>
3437	File path the VM process must save the execution state to.
3438	</desc>
3439	</param>
3440	</method>
3441
3442	<method name="endTakingSnapshot">
3443	<desc>
3444	Called by the VM process to inform the server that the snapshot
3445	previously requested by #beginTakingSnapshot is either
3446	successfully taken or there was a failure.
3447	</desc>
3448
3449	<param name="success" type="boolean" dir="in">
3450	<desc>@c true to indicate success and @c false otherwise</desc>
3451	</param>
3452	</method>
3453
3454	<method name="deleteSnapshot">
3455	<desc>
3456	Gets called by <link to="IConsole::deleteSnapshot"/>,
3457	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3458	<link to="IConsole::deleteSnapshotRange"/>.
3459	<result name="VBOX_E_INVALID_OBJECT_STATE">
3460	Snapshot has more than one child snapshot. Only possible if the
3461	delete operation does not delete all children or the range does
3462	not meet the linearity condition.
3463	</result>
3464	</desc>
3465	<param name="initiator" type="IConsole" dir="in">
3466	<desc>The console object that initiated this call.</desc>
3467	</param>
3468	<param name="startId" type="uuid" mod="string" dir="in">
3469	<desc>UUID of the first snapshot to delete.</desc>
3470	</param>
3471	<param name="endId" type="uuid" mod="string" dir="in">
3472	<desc>UUID of the last snapshot to delete.</desc>
3473	</param>
3474	<param name="deleteAllChildren" type="boolean" dir="in">
3475	<desc>Whether all children should be deleted.</desc>
3476	</param>
3477	<param name="machineState" type="MachineState" dir="out">
3478	<desc>New machine state after this operation is started.</desc>
3479	</param>
3480	<param name="progress" type="IProgress" dir="return">
3481	<desc>Progress object to track the operation completion.</desc>
3482	</param>
3483	</method>
3484
3485	<method name="finishOnlineMergeMedium">
3486	<desc>
3487	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3488	</desc>
3489	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3490	<desc>The medium attachment which needs to be cleaned up.</desc>
3491	</param>
3492	<param name="source" type="IMedium" dir="in">
3493	<desc>Merge source medium.</desc>
3494	</param>
3495	<param name="target" type="IMedium" dir="in">
3496	<desc>Merge target medium.</desc>
3497	</param>
3498	<param name="mergeForward" type="boolean" dir="in">
3499	<desc>Merge direction.</desc>
3500	</param>
3501	<param name="parentForTarget" type="IMedium" dir="in">
3502	<desc>For forward merges: new parent for target medium.</desc>
3503	</param>
3504	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3505	<desc>For backward merges: list of media which need their parent UUID
3506	updated.</desc>
3507	</param>
3508	</method>
3509
3510	<method name="restoreSnapshot">
3511	<desc>
3512	Gets called by <link to="IConsole::restoreSnapshot"/>.
3513	</desc>
3514	<param name="initiator" type="IConsole" dir="in">
3515	<desc>The console object that initiated this call.</desc>
3516	</param>
3517	<param name="snapshot" type="ISnapshot" dir="in">
3518	<desc>The snapshot to restore the VM state from.</desc>
3519	</param>
3520	<param name="machineState" type="MachineState" dir="out">
3521	<desc>New machine state after this operation is started.</desc>
3522	</param>
3523	<param name="progress" type="IProgress" dir="return">
3524	<desc>Progress object to track the operation completion.</desc>
3525	</param>
3526	</method>
3527
3528	<method name="pullGuestProperties">
3529	<desc>
3530	Get the list of the guest properties matching a set of patterns along
3531	with their values, time stamps and flags and give responsibility for
3532	managing properties to the console.
3533	</desc>
3534	<param name="names" type="wstring" dir="out" safearray="yes">
3535	<desc>
3536	The names of the properties returned.
3537	</desc>
3538	</param>
3539	<param name="values" type="wstring" dir="out" safearray="yes">
3540	<desc>
3541	The values of the properties returned. The array entries match the
3542	corresponding entries in the @a name array.
3543	</desc>
3544	</param>
3545	<param name="timestamps" type="long long" dir="out" safearray="yes">
3546	<desc>
3547	The time stamps of the properties returned. The array entries match
3548	the corresponding entries in the @a name array.
3549	</desc>
3550	</param>
3551	<param name="flags" type="wstring" dir="out" safearray="yes">
3552	<desc>
3553	The flags of the properties returned. The array entries match the
3554	corresponding entries in the @a name array.
3555	</desc>
3556	</param>
3557	</method>
3558
3559	<method name="pushGuestProperty">
3560	<desc>
3561	Update a single guest property in IMachine.
3562	</desc>
3563	<param name="name" type="wstring" dir="in">
3564	<desc>
3565	The name of the property to be updated.
3566	</desc>
3567	</param>
3568	<param name="value" type="wstring" dir="in">
3569	<desc>
3570	The value of the property.
3571	</desc>
3572	</param>
3573	<param name="timestamp" type="long long" dir="in">
3574	<desc>
3575	The timestamp of the property.
3576	</desc>
3577	</param>
3578	<param name="flags" type="wstring" dir="in">
3579	<desc>
3580	The flags of the property.
3581	</desc>
3582	</param>
3583	</method>
3584
3585	<method name="lockMedia">
3586	<desc>
3587	Locks all media attached to the machine for writing and parents of
3588	attached differencing media (if any) for reading. This operation is
3589	atomic so that if it fails no media is actually locked.
3590
3591	This method is intended to be called when the machine is in Starting or
3592	Restoring state. The locked media will be automatically unlocked when
3593	the machine is powered off or crashed.
3594	</desc>
3595	</method>
3596	<method name="unlockMedia">
3597	<desc>
3598	Unlocks all media previously locked using
3599	<link to="IInternalMachineControl::lockMedia"/>.
3600
3601	This method is intended to be used with teleportation so that it is
3602	possible to teleport between processes on the same machine.
3603	</desc>
3604	</method>
3605
3606	<method name="ejectMedium">
3607	<desc>
3608	Tells VBoxSVC that the guest has ejected the medium associated with
3609	the medium attachment.
3610	</desc>
3611	<param name="attachment" type="IMediumAttachment" dir="in">
3612	<desc>
3613	The medium attachment where the eject happened.
3614	</desc>
3615	</param>
3616	<param name="newAttachment" type="IMediumAttachment" dir="return">
3617	<desc>
3618	A new reference to the medium attachment, as the config change can
3619	result in the creation of a new instance.
3620	</desc>
3621	</param>
3622	</method>
3623
3624	<method name="reportVmStatistics">
3625	<desc>
3626	Passes statistics collected by VM (including guest statistics) to VBoxSVC.
3627	</desc>
3628	<param name="validStats" type="unsigned long" dir="in">
3629	<desc>
3630	Mask defining which parameters are valid. For example: 0x11 means
3631	that cpuIdle and XXX are valid. Other parameters should be ignored.
3632	</desc>
3633	</param>
3634	<param name="cpuUser" type="unsigned long" dir="in">
3635	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3636	</param>
3637	<param name="cpuKernel" type="unsigned long" dir="in">
3638	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3639	</param>
3640	<param name="cpuIdle" type="unsigned long" dir="in">
3641	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3642	</param>
3643	<param name="memTotal" type="unsigned long" dir="in">
3644	<desc>Total amount of physical guest RAM.</desc>
3645	</param>
3646	<param name="memFree" type="unsigned long" dir="in">
3647	<desc>Free amount of physical guest RAM.</desc>
3648	</param>
3649	<param name="memBalloon" type="unsigned long" dir="in">
3650	<desc>Amount of ballooned physical guest RAM.</desc>
3651	</param>
3652	<param name="memShared" type="unsigned long" dir="in">
3653	<desc>Amount of shared physical guest RAM.</desc>
3654	</param>
3655	<param name="memCache" type="unsigned long" dir="in">
3656	<desc>Total amount of guest (disk) cache memory.</desc>
3657	</param>
3658	<param name="pagedTotal" type="unsigned long" dir="in">
3659	<desc>Total amount of space in the page file.</desc>
3660	</param>
3661	<param name="memAllocTotal" type="unsigned long" dir="in">
3662	<desc>Total amount of memory allocated by the hypervisor.</desc>
3663	</param>
3664	<param name="memFreeTotal" type="unsigned long" dir="in">
3665	<desc>Total amount of free memory available in the hypervisor.</desc>
3666	</param>
3667	<param name="memBalloonTotal" type="unsigned long" dir="in">
3668	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3669	</param>
3670	<param name="memSharedTotal" type="unsigned long" dir="in">
3671	<desc>Total amount of shared memory in the hypervisor.</desc>
3672	</param>
3673	<param name="vmNetRx" type="unsigned long" dir="in">
3674	<desc>Network receive rate for VM.</desc>
3675	</param>
3676	<param name="vmNetTx" type="unsigned long" dir="in">
3677	<desc>Network transmit rate for VM.</desc>
3678	</param>
3679	</method>
3680	</interface>
3681
3682	<interface
3683	name="IBIOSSettings" extends="$unknown"
3684	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3685	wsmap="managed"
3686	>
3687	<desc>
3688	The IBIOSSettings interface represents BIOS settings of the virtual
3689	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3690	</desc>
3691	<attribute name="logoFadeIn" type="boolean">
3692	<desc>Fade in flag for BIOS logo animation.</desc>
3693	</attribute>
3694
3695	<attribute name="logoFadeOut" type="boolean">
3696	<desc>Fade out flag for BIOS logo animation.</desc>
3697	</attribute>
3698
3699	<attribute name="logoDisplayTime" type="unsigned long">
3700	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3701	</attribute>
3702
3703	<attribute name="logoImagePath" type="wstring">
3704	<desc>
3705	Local file system path for external BIOS splash image. Empty string
3706	means the default image is shown on boot.
3707	</desc>
3708	</attribute>
3709
3710	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3711	<desc>Mode of the BIOS boot device menu.</desc>
3712	</attribute>
3713
3714	<attribute name="ACPIEnabled" type="boolean">
3715	<desc>ACPI support flag.</desc>
3716	</attribute>
3717
3718	<attribute name="IOAPICEnabled" type="boolean">
3719	<desc>
3720	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3721	and support IRQs above 15.
3722	</desc>
3723	</attribute>
3724
3725	<attribute name="timeOffset" type="long long">
3726	<desc>
3727	Offset in milliseconds from the host system time. This allows for
3728	guests running with a different system date/time than the host.
3729	It is equivalent to setting the system date/time in the BIOS except
3730	it is not an absolute value but a relative one. Guest Additions
3731	time synchronization honors this offset.
3732	</desc>
3733	</attribute>
3734
3735	<attribute name="PXEDebugEnabled" type="boolean">
3736	<desc>
3737	PXE debug logging flag. If set, VirtualBox will write extensive
3738	PXE trace information to the release log.
3739	</desc>
3740	</attribute>
3741	</interface>
3742
3743	<enum
3744	name="CleanupMode"
3745	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3746	>
3747	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3748	</desc>
3749	<const name="UnregisterOnly" value="1">
3750	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3751	</const>
3752	<const name="DetachAllReturnNone" value="2">
3753	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3754	</const>
3755	<const name="DetachAllReturnHardDisksOnly" value="3">
3756	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3757	</const>
3758	<const name="Full" value="4">
3759	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3760	</const>
3761	</enum>
3762
3763	<interface
3764	name="IPCIAddress" extends="$unknown"
3765	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3766	wsmap="struct"
3767	>
3768
3769	<desc>
3770	Address on the PCI bus.
3771	</desc>
3772
3773	<attribute name="bus" type="short">
3774	<desc>
3775	Bus number.
3776	</desc>
3777	</attribute>
3778
3779	<attribute name="device" type="short">
3780	<desc>
3781	Device number.
3782	</desc>
3783	</attribute>
3784
3785	<attribute name="devFunction" type="short">
3786	<desc>
3787	Device function number.
3788	</desc>
3789	</attribute>
3790
3791	<method name="asLong">
3792	<desc>
3793	Convert PCI address into long.
3794	</desc>
3795	<param name="result" type="long" dir="return" />
3796	</method>
3797
3798	<method name="fromLong">
3799	<desc>
3800	Make PCI address from long.
3801	</desc>
3802	<param name="number" type="long" dir="in" />
3803	</method>
3804	</interface>
3805
3806	<interface
3807	name="IPCIDeviceAttachment" extends="$unknown"
3808	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3809	wsmap="struct"
3810	>
3811
3812	<desc>
3813	Information about PCI attachments.
3814	</desc>
3815
3816	<attribute name="name" type="wstring" readonly="yes">
3817	<desc>
3818	Device name.
3819	</desc>
3820	</attribute>
3821
3822	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3823	<desc>
3824	If this is physical or virtual device.
3825	</desc>
3826	</attribute>
3827
3828	<attribute name="hostAddress" type="long" readonly="yes">
3829	<desc>
3830	Address of device on the host, applicable only to host devices.
3831	</desc>
3832	</attribute>
3833
3834	<attribute name="guestAddress" type="long" readonly="yes">
3835	<desc>
3836	Address of device on the guest.
3837	</desc>
3838	</attribute>
3839
3840	</interface>
3841
3842	<enum
3843	name="CloneMode" extends="$unknown"
3844	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3845	>
3846
3847	<desc>
3848	Clone mode, used with <link to="IMachine::cloneTo" />.
3849	</desc>
3850
3851	<const name="MachineState" value="1">
3852	<desc>Clone the state of the selected machine.</desc>
3853	</const>
3854	<const name="MachineAndChildStates" value="2">
3855	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3856	</const>
3857	<const name="AllStates" value="3">
3858	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3859	</const>
3860
3861	</enum>
3862
3863	<enum
3864	name="CloneOptions" extends="$unknown"
3865	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3866	>
3867
3868	<desc>
3869	Clone options, used with <link to="IMachine::cloneTo" />.
3870	</desc>
3871
3872	<const name="Link" value="1">
3873	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3874	</const>
3875	<const name="KeepAllMACs" value="2">
3876	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3877	</const>
3878	<const name="KeepNATMACs" value="3">
3879	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3880	</const>
3881	<const name="KeepDiskNames" value="4">
3882	<desc>Don't change the disk names.</desc>
3883	</const>
3884
3885	</enum>
3886
3887	<enum
3888	name="AutostopType" extends="$unknown"
3889	uuid="6bb96740-cf34-470d-aab2-2cd48ea2e10e"
3890	>
3891
3892	<desc>
3893	Autostop types, used with <link to="IMachine::autostopType" />.
3894	</desc>
3895
3896	<const name="Disabled" value="1">
3897	<desc>Stopping the VM during system shutdown is disabled.</desc>
3898	</const>
3899	<const name="SaveState" value="2">
3900	<desc>The state of the VM will be saved when the system shuts down.</desc>
3901	</const>
3902	<const name="PowerOff" value="3">
3903	<desc>The VM is powered off when the system shuts down.</desc>
3904	</const>
3905	<const name="AcpiShutdown" value="4">
3906	<desc>An ACPI shutdown event is generated.</desc>
3907	</const>
3908
3909	</enum>
3910
3911
3912	<interface
3913	name="IMachine" extends="$unknown"
3914	uuid="381e3f31-2b27-45b7-818a-30609ade86b3"
3915	wsmap="managed"
3916	>
3917	<desc>
3918	The IMachine interface represents a virtual machine, or guest, created
3919	in VirtualBox.
3920
3921	This interface is used in two contexts. First of all, a collection of
3922	objects implementing this interface is stored in the
3923	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3924	machines that are currently registered with this VirtualBox
3925	installation. Also, once a session has been opened for the given virtual
3926	machine (e.g. the virtual machine is running), the machine object
3927	associated with the open session can be queried from the session object;
3928	see <link to="ISession"/> for details.
3929
3930	The main role of this interface is to expose the settings of the virtual
3931	machine and provide methods to change various aspects of the virtual
3932	machine's configuration. For machine objects stored in the
3933	<link to="IVirtualBox::machines"/> collection, all attributes are
3934	read-only unless explicitly stated otherwise in individual attribute
3935	and method descriptions.
3936
3937	In order to change a machine setting, a session for this machine must be
3938	opened using one of the <link to="IMachine::lockMachine" /> or
3939	<link to="IMachine::launchVMProcess"/> methods. After the
3940	machine has been successfully locked for a session, a mutable machine object
3941	needs to be queried from the session object and then the desired settings
3942	changes can be applied to the returned object using IMachine attributes and
3943	methods. See the <link to="ISession"/> interface description for more
3944	information about sessions.
3945
3946	Note that IMachine does not provide methods to control virtual machine
3947	execution (such as start the machine, or power it down) -- these methods
3948	are grouped in a separate interface called <link to="IConsole" />.
3949
3950	<see><link to="ISession"/>, <link to="IConsole"/></see>
3951	</desc>
3952
3953	<attribute name="parent" type="IVirtualBox" readonly="yes">
3954	<desc>Associated parent object.</desc>
3955	</attribute>
3956
3957	<attribute name="accessible" type="boolean" readonly="yes">
3958	<desc>
3959	Whether this virtual machine is currently accessible or not.
3960
3961	A machine is always deemed accessible unless it is registered <i>and</i>
3962	its settings file cannot be read or parsed (either because the file itself
3963	is unavailable or has invalid XML contents).
3964
3965	Every time this property is read, the accessibility state of
3966	this machine is re-evaluated. If the returned value is @c false,
3967	the <link to="#accessError"/> property may be used to get the
3968	detailed error information describing the reason of
3969	inaccessibility, including XML error messages.
3970
3971	When the machine is inaccessible, only the following properties
3972	can be used on it:
3973	<ul>
3974	<li><link to="#parent"/></li>
3975	<li><link to="#id"/></li>
3976	<li><link to="#settingsFilePath"/></li>
3977	<li><link to="#accessible"/></li>
3978	<li><link to="#accessError"/></li>
3979	</ul>
3980
3981	An attempt to access any other property or method will return
3982	an error.
3983
3984	The only possible action you can perform on an inaccessible
3985	machine is to unregister it using the
3986	<link to="IMachine::unregister"/> call (or, to check
3987	for the accessibility state once more by querying this
3988	property).
3989
3990	<note>
3991	In the current implementation, once this property returns
3992	@c true, the machine will never become inaccessible
3993	later, even if its settings file cannot be successfully
3994	read/written any more (at least, until the VirtualBox
3995	server is restarted). This limitation may be removed in
3996	future releases.
3997	</note>
3998	</desc>
3999	</attribute>
4000
4001	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4002	<desc>
4003	Error information describing the reason of machine
4004	inaccessibility.
4005
4006	Reading this property is only valid after the last call to
4007	<link to="#accessible"/> returned @c false (i.e. the
4008	machine is currently inaccessible). Otherwise, a @c null
4009	IVirtualBoxErrorInfo object will be returned.
4010	</desc>
4011	</attribute>
4012
4013	<attribute name="name" type="wstring">
4014	<desc>
4015	Name of the virtual machine.
4016
4017	Besides being used for human-readable identification purposes
4018	everywhere in VirtualBox, the virtual machine name is also used
4019	as a name of the machine's settings file and as a name of the
4020	subdirectory this settings file resides in. Thus, every time you
4021	change the value of this property, the settings file will be
4022	renamed once you call <link to="#saveSettings"/> to confirm the
4023	change. The containing subdirectory will be also renamed, but
4024	only if it has exactly the same name as the settings file
4025	itself prior to changing this property (for backward compatibility
4026	with previous API releases). The above implies the following
4027	limitations:
4028	<ul>
4029	<li>The machine name cannot be empty.</li>
4030	<li>The machine name can contain only characters that are valid
4031	file name characters according to the rules of the file
4032	system used to store VirtualBox configuration.</li>
4033	<li>You cannot have two or more machines with the same name
4034	if they use the same subdirectory for storing the machine
4035	settings files.</li>
4036	<li>You cannot change the name of the machine if it is running,
4037	or if any file in the directory containing the settings file
4038	is being used by another running machine or by any other
4039	process in the host operating system at a time when
4040	<link to="#saveSettings"/> is called.
4041	</li>
4042	</ul>
4043	If any of the above limitations are hit, <link to="#saveSettings"/>
4044	will return an appropriate error message explaining the exact
4045	reason and the changes you made to this machine will not be saved.
4046
4047	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
4048	file is recommended, but not enforced. (Previous versions always
4049	used a generic ".xml" extension.)
4050	</desc>
4051	</attribute>
4052
4053	<attribute name="description" type="wstring">
4054	<desc>
4055	Description of the virtual machine.
4056
4057	The description attribute can contain any text and is
4058	typically used to describe the hardware and software
4059	configuration of the virtual machine in detail (i.e. network
4060	settings, versions of the installed software and so on).
4061	</desc>
4062	</attribute>
4063
4064	<attribute name="id" type="uuid" mod="string" readonly="yes">
4065	<desc>UUID of the virtual machine.</desc>
4066	</attribute>
4067
4068	<attribute name="groups" type="wstring" safearray="yes">
4069	<desc>
4070	Array of machine group names of which this machine is a member.
4071	<tt>""</tt> and <tt>"/"</tt> are synonyms for the toplevel group. Each
4072	group is only listed once, however they are listed in no particular
4073	order and there is no guarantee that there are no gaps in the group
4074	hierarchy (i.e. <tt>"/group"</tt>,
4075	<tt>"/group/subgroup/subsubgroup"</tt> is a valid result).
4076	</desc>
4077	</attribute>
4078
4079	<attribute name="OSTypeId" type="wstring">
4080	<desc>
4081	User-defined identifier of the Guest OS type.
4082	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4083	an IGuestOSType object representing details about the given
4084	Guest OS type.
4085	<note>
4086	This value may differ from the value returned by
4087	<link to="IGuest::OSTypeId"/> if Guest Additions are
4088	installed to the guest OS.
4089	</note>
4090	</desc>
4091	</attribute>
4092
4093	<attribute name="hardwareVersion" type="wstring">
4094	<desc>Hardware version identifier. Internal use only for now.</desc>
4095	</attribute>
4096
4097	<attribute name="hardwareUUID" type="uuid" mod="string">
4098	<desc>
4099	The UUID presented to the guest via memory tables, hardware and guest
4100	properties. For most VMs this is the same as the @a id, but for VMs
4101	which have been cloned or teleported it may be the same as the source
4102	VM. The latter is because the guest shouldn't notice that it was
4103	cloned or teleported.
4104	</desc>
4105	</attribute>
4106
4107	<attribute name="CPUCount" type="unsigned long">
4108	<desc>Number of virtual CPUs in the VM.</desc>
4109	</attribute>
4110
4111	<attribute name="CPUHotPlugEnabled" type="boolean">
4112	<desc>
4113	This setting determines whether VirtualBox allows CPU
4114	hotplugging for this machine.</desc>
4115	</attribute>
4116
4117	<attribute name="CPUExecutionCap" type="unsigned long">
4118	<desc>
4119	Means to limit the number of CPU cycles a guest can use. The unit
4120	is percentage of host CPU cycles per second. The valid range
4121	is 1 - 100. 100 (the default) implies no limit.
4122	</desc>
4123	</attribute>
4124
4125	<attribute name="memorySize" type="unsigned long">
4126	<desc>System memory size in megabytes.</desc>
4127	</attribute>
4128
4129	<attribute name="memoryBalloonSize" type="unsigned long">
4130	<desc>Memory balloon size in megabytes.</desc>
4131	</attribute>
4132
4133	<attribute name="pageFusionEnabled" type="boolean">
4134	<desc>
4135	This setting determines whether VirtualBox allows page
4136	fusion for this machine (64 bits host only).
4137	</desc>
4138	</attribute>
4139
4140	<attribute name="VRAMSize" type="unsigned long">
4141	<desc>Video memory size in megabytes.</desc>
4142	</attribute>
4143
4144	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4145	<desc>
4146	This setting determines whether VirtualBox allows this machine to make
4147	use of the 3D graphics support available on the host.</desc>
4148	</attribute>
4149
4150	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4151	<desc>
4152	This setting determines whether VirtualBox allows this machine to make
4153	use of the 2D video acceleration support available on the host.</desc>
4154	</attribute>
4155
4156	<attribute name="monitorCount" type="unsigned long">
4157	<desc>
4158	Number of virtual monitors.
4159	<note>
4160	Only effective on Windows XP and later guests with
4161	Guest Additions installed.
4162	</note>
4163	</desc>
4164	</attribute>
4165
4166	<attribute name="VideoCaptureEnabled" type="boolean" default="false">
4167	<desc>
4168	This setting determines whether VirtualBox uses video recording to
4169	record VM session.</desc>
4170	</attribute>
4171
4172	<attribute name="VideoCaptureFile" type="wstring" default="Test.webm">
4173	<desc>
4174	This setting determines what filename VirtualBox uses to save
4175	the recorded content.</desc>
4176	</attribute>
4177
4178	<attribute name="VideoCaptureWidth" type="unsigned long" default="640">
4179	<desc>
4180	This setting determines what should be the horizontal resolution of
4181	recorded video.</desc>
4182	</attribute>
4183
4184	<attribute name="VideoCaptureHeight" type="unsigned long" default="480">
4185	<desc>
4186	This setting determines what should be the vertical resolution
4187	of recorded video.</desc>
4188	</attribute>
4189
4190	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4191	<desc>Object containing all BIOS settings.</desc>
4192	</attribute>
4193
4194	<attribute name="firmwareType" type="FirmwareType">
4195	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4196	bootstrap in this VM.</desc>
4197	</attribute>
4198
4199	<attribute name="pointingHIDType" type="PointingHIDType">
4200	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4201	The default is typically "PS2Mouse" but can vary depending on the
4202	requirements of the guest operating system.</desc>
4203	</attribute>
4204
4205	<attribute name="keyboardHIDType" type="KeyboardHIDType">
4206	<desc>Type of keyboard HID used in this VM.
4207	The default is typically "PS2Keyboard" but can vary depending on the
4208	requirements of the guest operating system.</desc>
4209	</attribute>
4210
4211	<attribute name="HPETEnabled" type="boolean">
4212	<desc>This attribute controls if High Precision Event Timer (HPET) is
4213	enabled in this VM. Use this property if you want to provide guests
4214	with additional time source, or if guest requires HPET to function correctly.
4215	Default is false.</desc>
4216	</attribute>
4217
4218	<attribute name="chipsetType" type="ChipsetType">
4219	<desc>Chipset type used in this VM.</desc>
4220	</attribute>
4221
4222	<attribute name="snapshotFolder" type="wstring">
4223	<desc>
4224	Full path to the directory used to store snapshot data
4225	(differencing media and saved state files) of this machine.
4226
4227	The initial value of this property is
4228	<tt><</tt><link to="#settingsFilePath">
4229	path_to_settings_file</link><tt>>/<</tt>
4230	<link to="#id">machine_uuid</link>
4231	<tt>></tt>.
4232
4233	Currently, it is an error to try to change this property on
4234	a machine that has snapshots (because this would require to
4235	move possibly large files to a different location).
4236	A separate method will be available for this purpose later.
4237
4238	<note>
4239	Setting this property to @c null or to an empty string will restore
4240	the initial value.
4241	</note>
4242	<note>
4243	When setting this property, the specified path can be
4244	absolute (full path) or relative to the directory where the
4245	<link to="#settingsFilePath">machine settings file</link>
4246	is located. When reading this property, a full path is
4247	always returned.
4248	</note>
4249	<note>
4250	The specified path may not exist, it will be created
4251	when necessary.
4252	</note>
4253	</desc>
4254	</attribute>
4255
4256	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4257	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4258	</attribute>
4259
4260	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4261	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4262
4263	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4264	<desc>Array of media attached to this machine.</desc>
4265	</attribute>
4266
4267	<attribute name="USBController" type="IUSBController" readonly="yes">
4268	<desc>
4269	Associated USB controller object.
4270
4271	<note>
4272	If USB functionality is not available in the given edition of
4273	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4274	</note>
4275	</desc>
4276	</attribute>
4277
4278	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4279	<desc>Associated audio adapter, always present.</desc>
4280	</attribute>
4281
4282	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4283	<desc>Array of storage controllers attached to this machine.</desc>
4284	</attribute>
4285
4286	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4287	<desc>
4288	Full name of the file containing machine settings data.
4289	</desc>
4290	</attribute>
4291
4292	<attribute name="settingsModified" type="boolean" readonly="yes">
4293	<desc>
4294	Whether the settings of this machine have been modified
4295	(but neither yet saved nor discarded).
4296	<note>
4297	Reading this property is only valid on instances returned
4298	by <link to="ISession::machine"/> and on new machines
4299	created by <link to="IVirtualBox::createMachine"/> or opened
4300	by <link to="IVirtualBox::openMachine"/> but not
4301	yet registered, or on unregistered machines after calling
4302	<link to="IMachine::unregister"/>. For all other
4303	cases, the settings can never be modified.
4304	</note>
4305	<note>
4306	For newly created unregistered machines, the value of this
4307	property is always @c true until <link to="#saveSettings"/>
4308	is called (no matter if any machine settings have been
4309	changed after the creation or not). For opened machines
4310	the value is set to @c false (and then follows to normal rules).
4311	</note>
4312	</desc>
4313	</attribute>
4314
4315	<attribute name="sessionState" type="SessionState" readonly="yes">
4316	<desc>Current session state for this machine.</desc>
4317	</attribute>
4318
4319	<attribute name="sessionType" type="wstring" readonly="yes">
4320	<desc>
4321	Type of the session. If <link to="#sessionState"/> is
4322	Spawning or Locked, this attribute contains the
4323	same value as passed to the
4324	<link to="IMachine::launchVMProcess"/> method in the
4325	@a type parameter. If the session was used with
4326	<link to="IMachine::lockMachine" />, or if
4327	<link to="#sessionState"/> is SessionClosed, the value of this
4328	attribute is an empty string.
4329	</desc>
4330	</attribute>
4331
4332	<attribute name="sessionPID" type="unsigned long" readonly="yes">
4333	<desc>
4334	Identifier of the session process. This attribute contains the
4335	platform-dependent identifier of the process whose session was
4336	used with <link to="IMachine::lockMachine" /> call. The returned
4337	value is only valid if <link to="#sessionState"/> is Locked or
4338	Unlocking by the time this property is read.
4339	</desc>
4340	</attribute>
4341
4342	<attribute name="state" type="MachineState" readonly="yes">
4343	<desc>Current execution state of this machine.</desc>
4344	</attribute>
4345
4346	<attribute name="lastStateChange" type="long long" readonly="yes">
4347	<desc>
4348	Time stamp of the last execution state change,
4349	in milliseconds since 1970-01-01 UTC.
4350	</desc>
4351	</attribute>
4352
4353	<attribute name="stateFilePath" type="wstring" readonly="yes">
4354	<desc>
4355	Full path to the file that stores the execution state of
4356	the machine when it is in the <link to="MachineState_Saved"/> state.
4357	<note>
4358	When the machine is not in the Saved state, this attribute is
4359	an empty string.
4360	</note>
4361	</desc>
4362	</attribute>
4363
4364	<attribute name="logFolder" type="wstring" readonly="yes">
4365	<desc>
4366	Full path to the folder that stores a set of rotated log files
4367	recorded during machine execution. The most recent log file is
4368	named <tt>VBox.log</tt>, the previous log file is
4369	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4370	in the current version).
4371	</desc>
4372	</attribute>
4373
4374	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4375	<desc>
4376	Current snapshot of this machine. This is @c null if the machine
4377	currently has no snapshots. If it is not @c null, then it was
4378	set by one of <link to="IConsole::takeSnapshot" />,
4379	<link to="IConsole::deleteSnapshot" />
4380	or <link to="IConsole::restoreSnapshot" />, depending on which
4381	was called last. See <link to="ISnapshot"/> for details.
4382	</desc>
4383	</attribute>
4384
4385	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4386	<desc>
4387	Number of snapshots taken on this machine. Zero means the
4388	machine doesn't have any snapshots.
4389	</desc>
4390	</attribute>
4391
4392	<attribute name="currentStateModified" type="boolean" readonly="yes">
4393	<desc>
4394	Returns @c true if the current state of the machine is not
4395	identical to the state stored in the current snapshot.
4396
4397	The current state is identical to the current snapshot only
4398	directly after one of the following calls are made:
4399
4400	<ul>
4401	<li><link to="IConsole::restoreSnapshot"/>
4402	</li>
4403	<li><link to="IConsole::takeSnapshot"/> (issued on a
4404	"powered off" or "saved" machine, for which
4405	<link to="#settingsModified"/> returns @c false)
4406	</li>
4407	</ul>
4408
4409	The current state remains identical until one of the following
4410	happens:
4411	<ul>
4412	<li>settings of the machine are changed</li>
4413	<li>the saved state is deleted</li>
4414	<li>the current snapshot is deleted</li>
4415	<li>an attempt to execute the machine is made</li>
4416	</ul>
4417
4418	<note>
4419	For machines that don't have snapshots, this property is
4420	always @c false.
4421	</note>
4422	</desc>
4423	</attribute>
4424
4425	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4426	<desc>
4427	Collection of shared folders for this machine (permanent shared
4428	folders). These folders are shared automatically at machine startup
4429	and available only to the guest OS installed within this machine.
4430
4431	New shared folders are added to the collection using
4432	<link to="#createSharedFolder"/>. Existing shared folders can be
4433	removed using <link to="#removeSharedFolder"/>.
4434	</desc>
4435	</attribute>
4436
4437	<attribute name="clipboardMode" type="ClipboardMode">
4438	<desc>
4439	Synchronization mode between the host OS clipboard
4440	and the guest OS clipboard.
4441	</desc>
4442	</attribute>
4443
4444	<attribute name="dragAndDropMode" type="DragAndDropMode">
4445	<desc>
4446	Which mode is allowed for drag'n'drop.
4447	</desc>
4448	</attribute>
4449
4450	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4451	<desc>
4452	A comma-separated list of simple glob patterns. Changes to guest
4453	properties whose name matches one of the patterns will generate an
4454	<link to="IGuestPropertyChangedEvent"/> signal.
4455	</desc>
4456	</attribute>
4457
4458	<attribute name="teleporterEnabled" type="boolean">
4459	<desc>
4460	When set to @a true, the virtual machine becomes a target teleporter
4461	the next time it is powered on. This can only set to @a true when the
4462	VM is in the @a PoweredOff or @a Aborted state.
4463
4464	<!-- This property is automatically set to @a false when the VM is powered
4465	on. (bird: This doesn't work yet ) -->
4466	</desc>
4467	</attribute>
4468
4469	<attribute name="teleporterPort" type="unsigned long">
4470	<desc>
4471	The TCP port the target teleporter will listen for incoming
4472	teleportations on.
4473
4474	0 means the port is automatically selected upon power on. The actual
4475	value can be read from this property while the machine is waiting for
4476	incoming teleportations.
4477	</desc>
4478	</attribute>
4479
4480	<attribute name="teleporterAddress" type="wstring">
4481	<desc>
4482	The address the target teleporter will listen on. If set to an empty
4483	string, it will listen on all addresses.
4484	</desc>
4485	</attribute>
4486
4487	<attribute name="teleporterPassword" type="wstring">
4488	<desc>
4489	The password to check for on the target teleporter. This is just a
4490	very basic measure to prevent simple hacks and operators accidentally
4491	beaming a virtual machine to the wrong place.
4492
4493	Note that you SET a plain text password while reading back a HASHED
4494	password. Setting a hashed password is currently not supported.
4495	</desc>
4496	</attribute>
4497
4498	<attribute name="faultToleranceState" type="FaultToleranceState">
4499	<desc>
4500	Fault tolerance state; disabled, source or target.
4501	This property can be changed at any time. If you change it for a running
4502	VM, then the fault tolerance address and port must be set beforehand.
4503	</desc>
4504	</attribute>
4505
4506	<attribute name="faultTolerancePort" type="unsigned long">
4507	<desc>
4508	The TCP port the fault tolerance source or target will use for
4509	communication.
4510	</desc>
4511	</attribute>
4512
4513	<attribute name="faultToleranceAddress" type="wstring">
4514	<desc>
4515	The address the fault tolerance source or target.
4516	</desc>
4517	</attribute>
4518
4519	<attribute name="faultTolerancePassword" type="wstring">
4520	<desc>
4521	The password to check for on the standby VM. This is just a
4522	very basic measure to prevent simple hacks and operators accidentally
4523	choosing the wrong standby VM.
4524	</desc>
4525	</attribute>
4526
4527	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4528	<desc>
4529	The interval in ms used for syncing the state between source and target.
4530	</desc>
4531	</attribute>
4532
4533	<attribute name="RTCUseUTC" type="boolean">
4534	<desc>
4535	When set to @a true, the RTC device of the virtual machine will run
4536	in UTC time, otherwise in local time. Especially Unix guests prefer
4537	the time in UTC.
4538	</desc>
4539	</attribute>
4540
4541	<attribute name="IOCacheEnabled" type="boolean">
4542	<desc>
4543	When set to @a true, the builtin I/O cache of the virtual machine
4544	will be enabled.
4545	</desc>
4546	</attribute>
4547
4548	<attribute name="IOCacheSize" type="unsigned long">
4549	<desc>
4550	Maximum size of the I/O cache in MB.
4551	</desc>
4552	</attribute>
4553
4554	<attribute name="PCIDeviceAssignments" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
4555	<desc>Array of PCI devices assigned to this machine, to get list of all
4556	PCI devices attached to the machine use
4557	<link to="IConsole::attachedPCIDevices"/> attribute, as this attribute
4558	is intended to list only devices additional to what described in
4559	virtual hardware config. Usually, this list keeps host's physical
4560	devices assigned to the particular machine.
4561	</desc>
4562	</attribute>
4563
4564	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4565	<desc>
4566	Bandwidth control manager.
4567	</desc>
4568	</attribute>
4569
4570	<attribute name="tracingEnabled" type="boolean">
4571	<desc>
4572	Enables the tracing facility in the VMM (including PDM devices +
4573	drivers). The VMM will consume about 0.5MB of more memory when
4574	enabled and there may be some extra overhead from tracepoints that are
4575	always enabled.
4576	</desc>
4577	</attribute>
4578
4579	<attribute name="tracingConfig" type="wstring">
4580	<desc>
4581	Tracepoint configuration to apply at startup when
4582	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4583	a space separated of tracepoint group names to enable. The special
4584	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4585	more details on available tracepoint groups and such.
4586
4587	Note that on hosts supporting DTrace (or similar), a lot of the
4588	tracepoints may be implemented exclusivly as DTrace probes. So, the
4589	effect of the same config may differ between Solaris and Windows for
4590	example.
4591	</desc>
4592	</attribute>
4593
4594	<attribute name="allowTracingToAccessVM" type="boolean">
4595	<desc>
4596	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4597	structures when firing off trace points. This is especially useful
4598	with DTrace tracepoints, as it allows you to use the VMCPU or VM
4599	pointer to obtain useful information such as guest register state.
4600
4601	This is disabled by default because devices and drivers normally has no
4602	business accessing the VMCPU or VM structures, and are therefore unable
4603	to get any pointers to these.
4604	</desc>
4605	</attribute>
4606
4607	<attribute name="autostartEnabled" type="boolean">
4608	<desc>
4609	Enables autostart of the VM during system boot.
4610	</desc>
4611	</attribute>
4612
4613	<attribute name="autostartDelay" type="unsigned long">
4614	<desc>
4615	Number of seconds to wait until the VM should be started during system boot.
4616	</desc>
4617	</attribute>
4618
4619	<attribute name="autostopType" type="AutostopType">
4620	<desc>
4621	Action type to do when the system is shutting down.
4622	</desc>
4623	</attribute>
4624
4625	<attribute name="defaultFrontend" type="wstring">
4626	<desc>
4627	Selects which VM frontend should be used by default when launching
4628	this VM through the <link to="IMachine::launchVMProcess" /> method.
4629	Empty or @c null strings do not define a particular default, it is up
4630	to <link to="IMachine::launchVMProcess" /> to select one. See the
4631	description of <link to="IMachine::launchVMProcess" /> for the valid
4632	frontend types.
4633
4634	This per-VM setting overrides the default defined by
4635	<link to="ISystemProperties::defaultFrontend" /> attribute, and is
4636	overridden by a frontend type passed to
4637	<link to="IMachine::launchVMProcess" />.
4638	</desc>
4639	</attribute>
4640
4641	<method name="lockMachine">
4642	<desc>
4643	Locks the machine for the given session to enable the caller
4644	to make changes to the machine or start the VM or control
4645	VM execution.
4646
4647	There are two ways to lock a machine for such uses:
4648
4649	<ul>
4650	<li>If you want to make changes to the machine settings,
4651	you must obtain an exclusive write lock on the machine
4652	by setting @a lockType to @c Write.
4653
4654	This will only succeed if no other process has locked
4655	the machine to prevent conflicting changes. Only after
4656	an exclusive write lock has been obtained using this method, one
4657	can change all VM settings or execute the VM in the process
4658	space of the session object. (Note that the latter is only of
4659	interest if you actually want to write a new front-end for
4660	virtual machines; but this API gets called internally by
4661	the existing front-ends such as VBoxHeadless and the VirtualBox
4662	GUI to acquire a write lock on the machine that they are running.)
4663
4664	On success, write-locking the machine for a session creates
4665	a second copy of the IMachine object. It is this second object
4666	upon which changes can be made; in VirtualBox terminology, the
4667	second copy is "mutable". It is only this second, mutable machine
4668	object upon which you can call methods that change the
4669	machine state. After having called this method, you can
4670	obtain this second, mutable machine object using the
4671	<link to="ISession::machine" /> attribute.
4672	</li>
4673	<li>If you only want to check the machine state or control
4674	machine execution without actually changing machine
4675	settings (e.g. to get access to VM statistics or take
4676	a snapshot or save the machine state), then set the
4677	@a lockType argument to @c Shared.
4678
4679	If no other session has obtained a lock, you will obtain an
4680	exclusive write lock as described above. However, if another
4681	session has already obtained such a lock, then a link to that
4682	existing session will be established which allows you
4683	to control that existing session.
4684
4685	To find out which type of lock was obtained, you can
4686	inspect <link to="ISession::type" />, which will have been
4687	set to either @c WriteLock or @c Shared.
4688	</li>
4689	</ul>
4690
4691	In either case, you can get access to the <link to="IConsole" />
4692	object which controls VM execution.
4693
4694	Also in all of the above cases, one must always call
4695	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4696	the machine's state will eventually be set to "Aborted".
4697
4698	To change settings on a machine, the following sequence is typically
4699	performed:
4700
4701	<ol>
4702	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4703
4704	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4705
4706	<li>Change the settings of the machine by invoking IMachine methods.</li>
4707
4708	<li>Call <link to="IMachine::saveSettings" />.</li>
4709
4710	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4711	</ol>
4712
4713	<result name="E_UNEXPECTED">
4714	Virtual machine not registered.
4715	</result>
4716	<result name="E_ACCESSDENIED">
4717	Process not started by OpenRemoteSession.
4718	</result>
4719	<result name="VBOX_E_INVALID_OBJECT_STATE">
4720	Session already open or being opened.
4721	</result>
4722	<result name="VBOX_E_VM_ERROR">
4723	Failed to assign machine to session.
4724	</result>
4725	</desc>
4726	<param name="session" type="ISession" dir="in">
4727	<desc>
4728	Session object for which the machine will be locked.
4729	</desc>
4730	</param>
4731	<param name="lockType" type="LockType" dir="in">
4732	<desc>
4733	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4734	If set to @c Shared, then either acquire an exclusive write lock or establish
4735	a link to an existing session.
4736	</desc>
4737	</param>
4738	</method>
4739
4740	<method name="launchVMProcess">
4741	<desc>
4742	Spawns a new process that will execute the virtual machine and obtains a shared
4743	lock on the machine for the calling session.
4744
4745	If launching the VM succeeds, the new VM process will create its own session
4746	and write-lock the machine for it, preventing conflicting changes from other
4747	processes. If the machine is already locked (because it is already running or
4748	because another session has a write lock), launching the VM process will therefore
4749	fail. Reversely, future attempts to obtain a write lock will also fail while the
4750	machine is running.
4751
4752	The caller's session object remains separate from the session opened by the new
4753	VM process. It receives its own <link to="IConsole" /> object which can be used
4754	to control machine execution, but it cannot be used to change all VM settings
4755	which would be available after a <link to="#lockMachine" /> call.
4756
4757	The caller must eventually release the session's shared lock by calling
4758	<link to="ISession::unlockMachine" /> on the local session object once this call
4759	has returned. However, the session's state (see <link to="ISession::state" />)
4760	will not return to "Unlocked" until the remote session has also unlocked
4761	the machine (i.e. the machine has stopped running).
4762
4763	Launching a VM process can take some time (a new VM is started in a new process,
4764	for which memory and other resources need to be set up). Because of this,
4765	an <link to="IProgress" /> object is returned to allow the caller to wait
4766	for this asynchronous operation to be completed. Until then, the caller's
4767	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4768	and <link to="ISession::console" /> attributes cannot be accessed.
4769	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4770	similar calls to wait for completion. Completion is signalled when the VM
4771	is powered on. If launching the VM fails, error messages can be queried
4772	via the progress object, if available.
4773
4774	The progress object will have at least 2 sub-operations. The first
4775	operation covers the period up to the new VM process calls powerUp.
4776	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4777	progress object. Because <link to="IConsole::powerUp"/> may require
4778	some extra sub-operations, the <link to="IProgress::operationCount"/>
4779	may change at the completion of operation.
4780
4781	For details on the teleportation progress operation, see
4782	<link to="IConsole::powerUp"/>.
4783
4784	The @a environment argument is a string containing definitions of
4785	environment variables in the following format:
4786	<pre>
4787	NAME[=VALUE]\n
4788	NAME[=VALUE]\n
4789	...
4790	</pre>
4791	where <tt>\\n</tt> is the new line character. These environment
4792	variables will be appended to the environment of the VirtualBox server
4793	process. If an environment variable exists both in the server process
4794	and in this list, the value from this list takes precedence over the
4795	server's variable. If the value of the environment variable is
4796	omitted, this variable will be removed from the resulting environment.
4797	If the environment string is @c null or empty, the server environment
4798	is inherited by the started process as is.
4799
4800	<result name="E_UNEXPECTED">
4801	Virtual machine not registered.
4802	</result>
4803	<result name="E_INVALIDARG">
4804	Invalid session type @a type.
4805	</result>
4806	<result name="VBOX_E_OBJECT_NOT_FOUND">
4807	No machine matching @a machineId found.
4808	</result>
4809	<result name="VBOX_E_INVALID_OBJECT_STATE">
4810	Session already open or being opened.
4811	</result>
4812	<result name="VBOX_E_IPRT_ERROR">
4813	Launching process for machine failed.
4814	</result>
4815	<result name="VBOX_E_VM_ERROR">
4816	Failed to assign machine to session.
4817	</result>
4818	</desc>
4819	<param name="session" type="ISession" dir="in">
4820	<desc>
4821	Client session object to which the VM process will be connected (this
4822	must be in "Unlocked" state).
4823	</desc>
4824	</param>
4825	<param name="type" type="wstring" dir="in">
4826	<desc>
4827	Front-end to use for the new VM process. The following are currently supported:
4828	<ul>
4829	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4830	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4831	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4832	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4833	the currently running VM or session owner. In this case the
4834	@a session parameter may be @c null (if it is non-null it isn't
4835	used in any way), and the @a progress return value will be always
4836	@c null. The operation completes immediately.</li>
4837	<li><tt>""</tt>: use the per-VM default frontend if set, otherwise
4838	the global default defined in the system properties. If neither
4839	are set, the API will launch a <tt>"gui"</tt> session, which may
4840	fail if there is no windowing environment available. See
4841	<link to="IMachine::defaultFrontend"/> and
4842	<link to="ISystemProperties::defaultFrontend"/>.</li>
4843	</ul>
4844	</desc>
4845	</param>
4846	<param name="environment" type="wstring" dir="in">
4847	<desc>
4848	Environment to pass to the VM process.
4849	</desc>
4850	</param>
4851	<param name="progress" type="IProgress" dir="return">
4852	<desc>Progress object to track the operation completion.</desc>
4853	</param>
4854	</method>
4855
4856	<method name="setBootOrder">
4857	<desc>
4858	Puts the given device to the specified position in
4859	the boot order.
4860
4861	To indicate that no device is associated with the given position,
4862	<link to="DeviceType_Null"/> should be used.
4863
4864	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4865
4866	<result name="E_INVALIDARG">
4867	Boot @a position out of range.
4868	</result>
4869	<result name="E_NOTIMPL">
4870	Booting from USB @a device currently not supported.
4871	</result>
4872
4873	</desc>
4874	<param name="position" type="unsigned long" dir="in">
4875	<desc>
4876	Position in the boot order (@c 1 to the total number of
4877	devices the machine can boot from, as returned by
4878	<link to="ISystemProperties::maxBootPosition"/>).
4879	</desc>
4880	</param>
4881	<param name="device" type="DeviceType" dir="in">
4882	<desc>
4883	The type of the device used to boot at the given position.
4884	</desc>
4885	</param>
4886	</method>
4887
4888	<method name="getBootOrder" const="yes">
4889	<desc>
4890	Returns the device type that occupies the specified
4891	position in the boot order.
4892
4893	@todo [remove?]
4894	If the machine can have more than one device of the returned type
4895	(such as hard disks), then a separate method should be used to
4896	retrieve the individual device that occupies the given position.
4897
4898	If here are no devices at the given position, then
4899	<link to="DeviceType_Null"/> is returned.
4900
4901	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4902
4903	<result name="E_INVALIDARG">
4904	Boot @a position out of range.
4905	</result>
4906
4907	</desc>
4908	<param name="position" type="unsigned long" dir="in">
4909	<desc>
4910	Position in the boot order (@c 1 to the total number of
4911	devices the machine can boot from, as returned by
4912	<link to="ISystemProperties::maxBootPosition"/>).
4913	</desc>
4914	</param>
4915	<param name="device" type="DeviceType" dir="return">
4916	<desc>
4917	Device at the given position.
4918	</desc>
4919	</param>
4920	</method>
4921
4922	<method name="attachDevice">
4923	<desc>
4924	Attaches a device and optionally mounts a medium to the given storage
4925	controller (<link to="IStorageController" />, identified by @a name),
4926	at the indicated port and device.
4927
4928	This method is intended for managing storage devices in general while a
4929	machine is powered off. It can be used to attach and detach fixed
4930	and removable media. The following kind of media can be attached
4931	to a machine:
4932
4933	<ul>
4934	<li>For fixed and removable media, you can pass in a medium that was
4935	previously opened using <link to="IVirtualBox::openMedium" />.
4936	</li>
4937
4938	<li>Only for storage devices supporting removable media (such as
4939	DVDs and floppies), you can also specify a null pointer to
4940	indicate an empty drive or one of the medium objects listed
4941	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4942	arrays to indicate a host drive.
4943	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4944	to change the media while the machine is running.
4945	</li>
4946	</ul>
4947
4948	In a VM's default configuration of virtual machines, the secondary
4949	master of the IDE controller is used for a CD/DVD drive.
4950
4951	After calling this returns successfully, a new instance of
4952	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4953	attachments (see <link to="IMachine::mediumAttachments"/>).
4954
4955	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4956	information about attaching media.
4957
4958	The specified device slot must not have a device attached to it,
4959	or this method will fail.
4960
4961	<note>
4962	You cannot attach a device to a newly created machine until
4963	this machine's settings are saved to disk using
4964	<link to="#saveSettings"/>.
4965	</note>
4966	<note>
4967	If the medium is being attached indirectly, a new differencing medium
4968	will implicitly be created for it and attached instead. If the
4969	changes made to the machine settings (including this indirect
4970	attachment) are later cancelled using <link to="#discardSettings"/>,
4971	this implicitly created differencing medium will implicitly
4972	be deleted.
4973	</note>
4974
4975	<result name="E_INVALIDARG">
4976	SATA device, SATA port, IDE port or IDE slot out of range, or
4977	file or UUID not found.
4978	</result>
4979	<result name="VBOX_E_INVALID_OBJECT_STATE">
4980	Machine must be registered before media can be attached.
4981	</result>
4982	<result name="VBOX_E_INVALID_VM_STATE">
4983	Invalid machine state.
4984	</result>
4985	<result name="VBOX_E_OBJECT_IN_USE">
4986	A medium is already attached to this or another virtual machine.
4987	</result>
4988
4989	</desc>
4990	<param name="name" type="wstring" dir="in">
4991	<desc>Name of the storage controller to attach the device to.</desc>
4992	</param>
4993	<param name="controllerPort" type="long" dir="in">
4994	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4995	the primary controller and 1 specifies the secondary controller.
4996	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4997	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4998	</param>
4999	<param name="device" type="long" dir="in">
5000	<desc>Device slot in the given port to attach the device to. This is only
5001	relevant for IDE controllers, for which 0 specifies the master device and
5002	1 specifies the slave device. For all other controller types, this must
5003	be 0.</desc>
5004	</param>
5005	<param name="type" type="DeviceType" dir="in">
5006	<desc>Device type of the attached device. For media opened by
5007	<link to="IVirtualBox::openMedium" />, this must match the device type
5008	specified there.</desc>
5009	</param>
5010	<param name="medium" type="IMedium" dir="in">
5011	<desc>Medium to mount or @c null for an empty drive.</desc>
5012	</param>
5013	</method>
5014
5015	<method name="attachDeviceWithoutMedium">
5016	<desc>
5017	Attaches a device and optionally mounts a medium to the given storage
5018	controller (<link to="IStorageController" />, identified by @a name),
5019	at the indicated port and device.
5020
5021	This method is intended for managing storage devices in general while a
5022	machine is powered off. It can be used to attach and detach fixed
5023	and removable media. The following kind of media can be attached
5024	to a machine:
5025	<ul>
5026	<li>
5027	For fixed and removable media, you can pass in a medium that was
5028	previously opened using <link to="IVirtualBox::openMedium" />.
5029	</li>
5030
5031	<li>Only for storage devices supporting removable media (such as
5032	DVDs and floppies) with an empty drive or one of the medium objects listed
5033	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
5034	arrays to indicate a host drive.
5035	For removable devices, you can also use <link to="IMachine::mountMedium"/>
5036	to change the media while the machine is running.
5037	</li>
5038	</ul>
5039
5040	In a VM's default configuration of virtual machines, the secondary
5041	master of the IDE controller is used for a CD/DVD drive.
5042	<link to="IMediumAttachment"/> will appear in the machine's list of medium
5043	attachments (see <link to="IMachine::mediumAttachments"/>).
5044
5045	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
5046	information about attaching media.
5047
5048	The specified device slot must not have a device attached to it,
5049	or this method will fail.
5050	<note>
5051	You cannot attach a device to a newly created machine until
5052	this machine's settings are saved to disk using
5053	<link to="#saveSettings"/>.
5054	</note>
5055	<note>
5056	If the medium is being attached indirectly, a new differencing medium
5057	will implicitly be created for it and attached instead. If the
5058	changes made to the machine settings (including this indirect
5059	attachment) are later cancelled using <link to="#discardSettings"/>,
5060	this implicitly created differencing medium will implicitly
5061	be deleted.
5062	</note>
5063
5064	<result name="E_INVALIDARG">
5065	SATA device, SATA port, IDE port or IDE slot out of range, or
5066	file or UUID not found.
5067	</result>
5068	<result name="VBOX_E_INVALID_OBJECT_STATE">
5069	Machine must be registered before media can be attached.
5070	</result>
5071	<result name="VBOX_E_INVALID_VM_STATE">
5072	Invalid machine state.
5073	</result>
5074	<result name="VBOX_E_OBJECT_IN_USE">
5075	A medium is already attached to this or another virtual machine.
5076	</result>
5077	</desc>
5078	<param name="name" type="wstring" dir="in">
5079	<desc>Name of the storage controller to attach the device to.</desc>
5080	</param>
5081	<param name="controllerPort" type="long" dir="in">
5082	<desc>Port to attach the device to. For an IDE controller, 0 specifies
5083	the primary controller and 1 specifies the secondary controller.
5084	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
5085	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
5086	</param>
5087	<param name="device" type="long" dir="in">
5088	<desc>Device slot in the given port to attach the device to. This is only
5089	relevant for IDE controllers, for which 0 specifies the master device and
5090	1 specifies the slave device. For all other controller types, this must
5091	be 0.</desc>
5092	</param>
5093	<param name="type" type="DeviceType" dir="in">
5094	<desc>Device type of the attached device. For media opened by
5095	<link to="IVirtualBox::openMedium" />, this must match the device type
5096	specified there.</desc>
5097	</param>
5098	</method>
5099
5100	<method name="detachDevice">
5101	<desc>
5102	Detaches the device attached to a device slot of the specified bus.
5103
5104	Detaching the device from the virtual machine is deferred. This means
5105	that the medium remains associated with the machine when this method
5106	returns and gets actually de-associated only after a successful
5107	<link to="#saveSettings"/> call. See <link to="IMedium"/>
5108	for more detailed information about attaching media.
5109
5110	<note>
5111	You cannot detach a device from a running machine.
5112	</note>
5113	<note>
5114	Detaching differencing media implicitly created by <link
5115	to="#attachDevice"/> for the indirect attachment using this
5116	method will <b>not</b> implicitly delete them. The
5117	<link to="IMedium::deleteStorage"/> operation should be
5118	explicitly performed by the caller after the medium is successfully
5119	detached and the settings are saved with
5120	<link to="#saveSettings"/>, if it is the desired action.
5121	</note>
5122
5123	<result name="VBOX_E_INVALID_VM_STATE">
5124	Attempt to detach medium from a running virtual machine.
5125	</result>
5126	<result name="VBOX_E_OBJECT_NOT_FOUND">
5127	No medium attached to given slot/bus.
5128	</result>
5129	<result name="VBOX_E_NOT_SUPPORTED">
5130	Medium format does not support storage deletion (only for implicitly
5131	created differencing media, should not happen).
5132	</result>
5133
5134	</desc>
5135	<param name="name" type="wstring" dir="in">
5136	<desc>Name of the storage controller to detach the medium from.</desc>
5137	</param>
5138	<param name="controllerPort" type="long" dir="in">
5139	<desc>Port number to detach the medium from.</desc>
5140	</param>
5141	<param name="device" type="long" dir="in">
5142	<desc>Device slot number to detach the medium from.</desc>
5143	</param>
5144	</method>
5145
5146	<method name="passthroughDevice">
5147	<desc>
5148	Sets the passthrough mode of an existing DVD device. Changing the
5149	setting while the VM is running is forbidden. The setting is only used
5150	if at VM start the device is configured as a host DVD drive, in all
5151	other cases it is ignored. The device must already exist; see
5152	<link to="IMachine::attachDevice"/> for how to attach a new device.
5153
5154	The @a controllerPort and @a device parameters specify the device slot and
5155	have have the same meaning as with <link to="IMachine::attachDevice" />.
5156
5157	<result name="E_INVALIDARG">
5158	SATA device, SATA port, IDE port or IDE slot out of range.
5159	</result>
5160	<result name="VBOX_E_INVALID_OBJECT_STATE">
5161	Attempt to modify an unregistered virtual machine.
5162	</result>
5163	<result name="VBOX_E_INVALID_VM_STATE">
5164	Invalid machine state.
5165	</result>
5166
5167	</desc>
5168	<param name="name" type="wstring" dir="in">
5169	<desc>Name of the storage controller.</desc>
5170	</param>
5171	<param name="controllerPort" type="long" dir="in">
5172	<desc>Storage controller port.</desc>
5173	</param>
5174	<param name="device" type="long" dir="in">
5175	<desc>Device slot in the given port.</desc>
5176	</param>
5177	<param name="passthrough" type="boolean" dir="in">
5178	<desc>New value for the passthrough setting.</desc>
5179	</param>
5180	</method>
5181
5182	<method name="temporaryEjectDevice">
5183	<desc>
5184	Sets the behavior for guest-triggered medium eject. In some situations
5185	it is desirable that such ejects update the VM configuration, and in
5186	others the eject should keep the VM configuration. The device must
5187	already exist; see <link to="IMachine::attachDevice"/> for how to
5188	attach a new device.
5189
5190	The @a controllerPort and @a device parameters specify the device slot and
5191	have have the same meaning as with <link to="IMachine::attachDevice" />.
5192
5193	<result name="E_INVALIDARG">
5194	SATA device, SATA port, IDE port or IDE slot out of range.
5195	</result>
5196	<result name="VBOX_E_INVALID_OBJECT_STATE">
5197	Attempt to modify an unregistered virtual machine.
5198	</result>
5199	<result name="VBOX_E_INVALID_VM_STATE">
5200	Invalid machine state.
5201	</result>
5202
5203	</desc>
5204	<param name="name" type="wstring" dir="in">
5205	<desc>Name of the storage controller.</desc>
5206	</param>
5207	<param name="controllerPort" type="long" dir="in">
5208	<desc>Storage controller port.</desc>
5209	</param>
5210	<param name="device" type="long" dir="in">
5211	<desc>Device slot in the given port.</desc>
5212	</param>
5213	<param name="temporaryEject" type="boolean" dir="in">
5214	<desc>New value for the eject behavior.</desc>
5215	</param>
5216	</method>
5217
5218	<method name="nonRotationalDevice">
5219	<desc>
5220	Sets a flag in the device information which indicates that the medium
5221	is not based on rotational technology, i.e. that the access times are
5222	more or less independent of the position on the medium. This may or may
5223	not be supported by a particular drive, and is silently ignored in the
5224	latter case. At the moment only hard disks (which is a misnomer in this
5225	context) accept this setting. Changing the setting while the VM is
5226	running is forbidden. The device must already exist; see
5227	<link to="IMachine::attachDevice"/> for how to attach a new device.
5228
5229	The @a controllerPort and @a device parameters specify the device slot and
5230	have have the same meaning as with <link to="IMachine::attachDevice" />.
5231
5232	<result name="E_INVALIDARG">
5233	SATA device, SATA port, IDE port or IDE slot out of range.
5234	</result>
5235	<result name="VBOX_E_INVALID_OBJECT_STATE">
5236	Attempt to modify an unregistered virtual machine.
5237	</result>
5238	<result name="VBOX_E_INVALID_VM_STATE">
5239	Invalid machine state.
5240	</result>
5241
5242	</desc>
5243	<param name="name" type="wstring" dir="in">
5244	<desc>Name of the storage controller.</desc>
5245	</param>
5246	<param name="controllerPort" type="long" dir="in">
5247	<desc>Storage controller port.</desc>
5248	</param>
5249	<param name="device" type="long" dir="in">
5250	<desc>Device slot in the given port.</desc>
5251	</param>
5252	<param name="nonRotational" type="boolean" dir="in">
5253	<desc>New value for the non-rotational device flag.</desc>
5254	</param>
5255	</method>
5256
5257	<method name="setAutoDiscardForDevice">
5258	<desc>
5259	Sets a flag in the device information which indicates that the medium
5260	supports discarding unsused blocks (called trimming for SATA or unmap
5261	for SCSI devices) .This may or may not be supported by a particular drive,
5262	and is silently ignored in the latter case. At the moment only hard disks
5263	(which is a misnomer in this context) accept this setting. Changing the
5264	setting while the VM is running is forbidden. The device must already
5265	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
5266	device.
5267
5268	The @a controllerPort and @a device parameters specify the device slot and
5269	have have the same meaning as with <link to="IMachine::attachDevice" />.
5270
5271	<result name="E_INVALIDARG">
5272	SATA device, SATA port, SCSI port out of range.
5273	</result>
5274	<result name="VBOX_E_INVALID_OBJECT_STATE">
5275	Attempt to modify an unregistered virtual machine.
5276	</result>
5277	<result name="VBOX_E_INVALID_VM_STATE">
5278	Invalid machine state.
5279	</result>
5280
5281	</desc>
5282	<param name="name" type="wstring" dir="in">
5283	<desc>Name of the storage controller.</desc>
5284	</param>
5285	<param name="controllerPort" type="long" dir="in">
5286	<desc>Storage controller port.</desc>
5287	</param>
5288	<param name="device" type="long" dir="in">
5289	<desc>Device slot in the given port.</desc>
5290	</param>
5291	<param name="discard" type="boolean" dir="in">
5292	<desc>New value for the discard device flag.</desc>
5293	</param>
5294	</method>
5295
5296	<method name="setBandwidthGroupForDevice">
5297	<desc>
5298	Sets the bandwidth group of an existing storage device.
5299	The device must already exist; see <link to="IMachine::attachDevice"/>
5300	for how to attach a new device.
5301
5302	The @a controllerPort and @a device parameters specify the device slot and
5303	have have the same meaning as with <link to="IMachine::attachDevice" />.
5304
5305	<result name="E_INVALIDARG">
5306	SATA device, SATA port, IDE port or IDE slot out of range.
5307	</result>
5308	<result name="VBOX_E_INVALID_OBJECT_STATE">
5309	Attempt to modify an unregistered virtual machine.
5310	</result>
5311	<result name="VBOX_E_INVALID_VM_STATE">
5312	Invalid machine state.
5313	</result>
5314
5315	</desc>
5316	<param name="name" type="wstring" dir="in">
5317	<desc>Name of the storage controller.</desc>
5318	</param>
5319	<param name="controllerPort" type="long" dir="in">
5320	<desc>Storage controller port.</desc>
5321	</param>
5322	<param name="device" type="long" dir="in">
5323	<desc>Device slot in the given port.</desc>
5324	</param>
5325	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
5326	<desc>New value for the bandwidth group or @c null for no group.</desc>
5327	</param>
5328	</method>
5329
5330	<method name="setNoBandwidthGroupForDevice">
5331	<desc>
5332	Sets no bandwidth group for an existing storage device.
5333	The device must already exist; see <link to="IMachine::attachDevice"/>
5334	for how to attach a new device.
5335	The @a controllerPort and @a device parameters specify the device slot and
5336	have have the same meaning as with <link to="IMachine::attachDevice" />.
5337	<result name="E_INVALIDARG">
5338	SATA device, SATA port, IDE port or IDE slot out of range.
5339	</result>
5340	<result name="VBOX_E_INVALID_OBJECT_STATE">
5341	Attempt to modify an unregistered virtual machine.
5342	</result>
5343	<result name="VBOX_E_INVALID_VM_STATE">
5344	Invalid machine state.
5345	</result>
5346
5347	</desc>
5348	<param name="name" type="wstring" dir="in">
5349	<desc>Name of the storage controller.</desc>
5350	</param>
5351	<param name="controllerPort" type="long" dir="in">
5352	<desc>Storage controller port.</desc>
5353	</param>
5354	<param name="device" type="long" dir="in">
5355	<desc>Device slot in the given port.</desc>
5356	</param>
5357	</method>
5358
5359
5360	<method name="unmountMedium">
5361	<desc>
5362	Unmounts any currently mounted medium (<link to="IMedium" />,
5363	identified by the given UUID @a id) to the given storage controller
5364	(<link to="IStorageController" />, identified by @a name),
5365	at the indicated port and device. The device must already exist;
5366
5367	This method is intended only for managing removable media, where the
5368	device is fixed but media is changeable at runtime (such as DVDs
5369	and floppies). It cannot be used for fixed media such as hard disks.
5370
5371	The @a controllerPort and @a device parameters specify the device slot
5372	and have have the same meaning as with
5373	<link to="IMachine::attachDevice" />.
5374
5375	The specified device slot must have a medium mounted, which will be
5376	unmounted. If there is no mounted medium it will do nothing.
5377	See <link to="IMedium"/> for more detailed information about
5378	attaching/unmounting media.
5379
5380	<result name="E_INVALIDARG">
5381	SATA device, SATA port, IDE port or IDE slot out of range.
5382	</result>
5383	<result name="VBOX_E_INVALID_OBJECT_STATE">
5384	Attempt to unmount medium that is not removeable - not dvd or floppy.
5385	</result>
5386	<result name="VBOX_E_INVALID_VM_STATE">
5387	Invalid machine state.
5388	</result>
5389	<result name="VBOX_E_OBJECT_IN_USE">
5390	Medium already attached to this or another virtual machine.
5391	</result>
5392	<result name="VBOX_E_OBJECT_NOT_FOUND">
5393	Medium not attached to specified port, device, controller.
5394	</result>
5395
5396	</desc>
5397	<param name="name" type="wstring" dir="in">
5398	<desc>Name of the storage controller to unmount the medium from.</desc>
5399	</param>
5400	<param name="controllerPort" type="long" dir="in">
5401	<desc>Port to unmount the medium from.</desc>
5402	</param>
5403	<param name="device" type="long" dir="in">
5404	<desc>Device slot in the given port to unmount the medium from.</desc>
5405	</param>
5406	<param name="force" type="boolean" dir="in">
5407	<desc>Allows to force unmount of a medium which is locked by
5408	the device slot in the given port medium is attached to.</desc>
5409	</param>
5410	</method>
5411
5412	<method name="mountMedium">
5413	<desc>
5414	Mounts a medium (<link to="IMedium" />, identified
5415	by the given UUID @a id) to the given storage controller
5416	(<link to="IStorageController" />, identified by @a name),
5417	at the indicated port and device. The device must already exist;
5418	see <link to="IMachine::attachDevice"/> for how to attach a new device.
5419
5420	This method is intended only for managing removable media, where the
5421	device is fixed but media is changeable at runtime (such as DVDs
5422	and floppies). It cannot be used for fixed media such as hard disks.
5423
5424	The @a controllerPort and @a device parameters specify the device slot and
5425	have have the same meaning as with <link to="IMachine::attachDevice" />.
5426
5427	The specified device slot can have a medium mounted, which will be
5428	unmounted first. Specifying a zero UUID (or an empty string) for
5429	@a medium does just an unmount.
5430
5431	See <link to="IMedium"/> for more detailed information about
5432	attaching media.
5433
5434	<result name="E_INVALIDARG">
5435	SATA device, SATA port, IDE port or IDE slot out of range.
5436	</result>
5437	<result name="VBOX_E_INVALID_OBJECT_STATE">
5438	Attempt to attach medium to an unregistered virtual machine.
5439	</result>
5440	<result name="VBOX_E_INVALID_VM_STATE">
5441	Invalid machine state.
5442	</result>
5443	<result name="VBOX_E_OBJECT_IN_USE">
5444	Medium already attached to this or another virtual machine.
5445	</result>
5446
5447	</desc>
5448	<param name="name" type="wstring" dir="in">
5449	<desc>Name of the storage controller to attach the medium to.</desc>
5450	</param>
5451	<param name="controllerPort" type="long" dir="in">
5452	<desc>Port to attach the medium to.</desc>
5453	</param>
5454	<param name="device" type="long" dir="in">
5455	<desc>Device slot in the given port to attach the medium to.</desc>
5456	</param>
5457	<param name="medium" type="IMedium" dir="in">
5458	<desc>Medium to mount or @c null for an empty drive.</desc>
5459	</param>
5460	<param name="force" type="boolean" dir="in">
5461	<desc>Allows to force unmount/mount of a medium which is locked by
5462	the device slot in the given port to attach the medium to.</desc>
5463	</param>
5464	</method>
5465
5466	<method name="getMedium" const="yes">
5467	<desc>
5468	Returns the virtual medium attached to a device slot of the specified
5469	bus.
5470
5471	Note that if the medium was indirectly attached by
5472	<link to="#mountMedium"/> to the given device slot then this
5473	method will return not the same object as passed to the
5474	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5475	more detailed information about mounting a medium.
5476
5477	<result name="VBOX_E_OBJECT_NOT_FOUND">
5478	No medium attached to given slot/bus.
5479	</result>
5480
5481	</desc>
5482	<param name="name" type="wstring" dir="in">
5483	<desc>Name of the storage controller the medium is attached to.</desc>
5484	</param>
5485	<param name="controllerPort" type="long" dir="in">
5486	<desc>Port to query.</desc>
5487	</param>
5488	<param name="device" type="long" dir="in">
5489	<desc>Device slot in the given port to query.</desc>
5490	</param>
5491	<param name="medium" type="IMedium" dir="return">
5492	<desc>Attached medium object.</desc>
5493	</param>
5494	</method>
5495
5496	<method name="getMediumAttachmentsOfController" const="yes">
5497	<desc>
5498	Returns an array of medium attachments which are attached to the
5499	the controller with the given name.
5500
5501	<result name="VBOX_E_OBJECT_NOT_FOUND">
5502	A storage controller with given name doesn't exist.
5503	</result>
5504	</desc>
5505	<param name="name" type="wstring" dir="in"/>
5506	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5507	</method>
5508
5509	<method name="getMediumAttachment" const="yes">
5510	<desc>
5511	Returns a medium attachment which corresponds to the controller with
5512	the given name, on the given port and device slot.
5513
5514	<result name="VBOX_E_OBJECT_NOT_FOUND">
5515	No attachment exists for the given controller/port/device combination.
5516	</result>
5517	</desc>
5518	<param name="name" type="wstring" dir="in"/>
5519	<param name="controllerPort" type="long" dir="in"/>
5520	<param name="device" type="long" dir="in"/>
5521	<param name="attachment" type="IMediumAttachment" dir="return"/>
5522	</method>
5523
5524	<method name="attachHostPCIDevice">
5525	<desc>
5526	Attaches host PCI device with the given (host) PCI address to the
5527	PCI bus of the virtual machine. Please note, that this operation
5528	is two phase, as real attachment will happen when VM will start,
5529	and most information will be delivered as IHostPCIDevicePlugEvent
5530	on IVirtualBox event source.
5531
5532	<see><link to="IHostPCIDevicePlugEvent"/></see>
5533
5534	<result name="VBOX_E_INVALID_VM_STATE">
5535	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5536	</result>
5537	<result name="VBOX_E_PDM_ERROR">
5538	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5539	</result>
5540	<result name="VBOX_E_NOT_SUPPORTED">
5541	Hardware or host OS doesn't allow PCI device passthrought.
5542	</result>
5543	</desc>
5544	<param name="hostAddress" type="long" dir="in">
5545	<desc>Address of the host PCI device.</desc>
5546	</param>
5547	<param name="desiredGuestAddress" type="long" dir="in">
5548	<desc>Desired position of this device on guest PCI bus.</desc>
5549	</param>
5550	<param name="tryToUnbind" type="boolean" dir="in">
5551	<desc>If VMM shall try to unbind existing drivers from the
5552	device before attaching it to the guest.</desc>
5553	</param>
5554	</method>
5555
5556	<method name="detachHostPCIDevice">
5557	<desc>
5558	Detach host PCI device from the virtual machine.
5559	Also HostPCIDevicePlugEvent on IVirtualBox event source
5560	will be delivered. As currently we don't support hot device
5561	unplug, IHostPCIDevicePlugEvent event is delivered immediately.
5562
5563	<see><link to="IHostPCIDevicePlugEvent"/></see>
5564
5565	<result name="VBOX_E_INVALID_VM_STATE">
5566	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5567	</result>
5568	<result name="VBOX_E_OBJECT_NOT_FOUND">
5569	This host device is not attached to this machine.
5570	</result>
5571	<result name="VBOX_E_PDM_ERROR">
5572	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5573	</result>
5574	<result name="VBOX_E_NOT_SUPPORTED">
5575	Hardware or host OS doesn't allow PCI device passthrought.
5576	</result>
5577	</desc>
5578	<param name="hostAddress" type="long" dir="in">
5579	<desc>Address of the host PCI device.</desc>
5580	</param>
5581	</method>
5582
5583	<method name="getNetworkAdapter" const="yes">
5584	<desc>
5585	Returns the network adapter associated with the given slot.
5586	Slots are numbered sequentially, starting with zero. The total
5587	number of adapters per machine is defined by the
5588	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5589	so the maximum slot number is one less than that property's value.
5590
5591	<result name="E_INVALIDARG">
5592	Invalid @a slot number.
5593	</result>
5594
5595	</desc>
5596	<param name="slot" type="unsigned long" dir="in"/>
5597	<param name="adapter" type="INetworkAdapter" dir="return"/>
5598	</method>
5599
5600	<method name="addStorageController">
5601	<desc>
5602	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5603	machine and returns it as an instance of
5604	<link to="IStorageController" />.
5605
5606	@a name identifies the controller for subsequent calls such as
5607	<link to="#getStorageControllerByName" />,
5608	<link to="#getStorageControllerByInstance" />,
5609	<link to="#removeStorageController" />,
5610	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5611
5612	After the controller has been added, you can set its exact
5613	type by setting the <link to="IStorageController::controllerType" />.
5614
5615	<result name="VBOX_E_OBJECT_IN_USE">
5616	A storage controller with given name exists already.
5617	</result>
5618	<result name="E_INVALIDARG">
5619	Invalid @a controllerType.
5620	</result>
5621	</desc>
5622	<param name="name" type="wstring" dir="in"/>
5623	<param name="connectionType" type="StorageBus" dir="in"/>
5624	<param name="controller" type="IStorageController" dir="return"/>
5625	</method>
5626
5627	<method name="getStorageControllerByName" const="yes">
5628	<desc>
5629	Returns a storage controller with the given name.
5630
5631	<result name="VBOX_E_OBJECT_NOT_FOUND">
5632	A storage controller with given name doesn't exist.
5633	</result>
5634	</desc>
5635	<param name="name" type="wstring" dir="in"/>
5636	<param name="storageController" type="IStorageController" dir="return"/>
5637	</method>
5638
5639	<method name="getStorageControllerByInstance" const="yes">
5640	<desc>
5641	Returns a storage controller with the given instance number.
5642
5643	<result name="VBOX_E_OBJECT_NOT_FOUND">
5644	A storage controller with given instance number doesn't exist.
5645	</result>
5646	</desc>
5647	<param name="instance" type="unsigned long" dir="in"/>
5648	<param name="storageController" type="IStorageController" dir="return"/>
5649	</method>
5650
5651	<method name="removeStorageController">
5652	<desc>
5653	Removes a storage controller from the machine with all devices attached to it.
5654
5655	<result name="VBOX_E_OBJECT_NOT_FOUND">
5656	A storage controller with given name doesn't exist.
5657	</result>
5658	<result name="VBOX_E_NOT_SUPPORTED">
5659	Medium format does not support storage deletion (only for implicitly
5660	created differencing media, should not happen).
5661	</result>
5662	</desc>
5663	<param name="name" type="wstring" dir="in"/>
5664	</method>
5665
5666	<method name="setStorageControllerBootable">
5667	<desc>
5668	Sets the bootable flag of the storage controller with the given name.
5669
5670	<result name="VBOX_E_OBJECT_NOT_FOUND">
5671	A storage controller with given name doesn't exist.
5672	</result>
5673	<result name="VBOX_E_OBJECT_IN_USE">
5674	Another storage controller is marked as bootable already.
5675	</result>
5676	</desc>
5677	<param name="name" type="wstring" dir="in"/>
5678	<param name="bootable" type="boolean" dir="in"/>
5679	</method>
5680
5681	<method name="getSerialPort" const="yes">
5682	<desc>
5683	Returns the serial port associated with the given slot.
5684	Slots are numbered sequentially, starting with zero. The total
5685	number of serial ports per machine is defined by the
5686	<link to="ISystemProperties::serialPortCount"/> property,
5687	so the maximum slot number is one less than that property's value.
5688
5689	<result name="E_INVALIDARG">
5690	Invalid @a slot number.
5691	</result>
5692
5693	</desc>
5694	<param name="slot" type="unsigned long" dir="in"/>
5695	<param name="port" type="ISerialPort" dir="return"/>
5696	</method>
5697
5698	<method name="getParallelPort" const="yes">
5699	<desc>
5700	Returns the parallel port associated with the given slot.
5701	Slots are numbered sequentially, starting with zero. The total
5702	number of parallel ports per machine is defined by the
5703	<link to="ISystemProperties::parallelPortCount"/> property,
5704	so the maximum slot number is one less than that property's value.
5705
5706	<result name="E_INVALIDARG">
5707	Invalid @a slot number.
5708	</result>
5709
5710	</desc>
5711	<param name="slot" type="unsigned long" dir="in"/>
5712	<param name="port" type="IParallelPort" dir="return"/>
5713	</method>
5714
5715	<method name="getExtraDataKeys">
5716	<desc>
5717	Returns an array representing the machine-specific extra data keys
5718	which currently have values defined.
5719	</desc>
5720	<param name="keys" type="wstring" dir="return" safearray="yes">
5721	<desc>Array of extra data keys.</desc>
5722	</param>
5723	</method>
5724
5725	<method name="getExtraData">
5726	<desc>
5727	Returns associated machine-specific extra data.
5728
5729	If the requested data @a key does not exist, this function will
5730	succeed and return an empty string in the @a value argument.
5731
5732	<result name="VBOX_E_FILE_ERROR">
5733	Settings file not accessible.
5734	</result>
5735	<result name="VBOX_E_XML_ERROR">
5736	Could not parse the settings file.
5737	</result>
5738
5739	</desc>
5740	<param name="key" type="wstring" dir="in">
5741	<desc>Name of the data key to get.</desc>
5742	</param>
5743	<param name="value" type="wstring" dir="return">
5744	<desc>Value of the requested data key.</desc>
5745	</param>
5746	</method>
5747
5748	<method name="setExtraData">
5749	<desc>
5750	Sets associated machine-specific extra data.
5751
5752	If you pass @c null or an empty string as a key @a value, the given
5753	@a key will be deleted.
5754
5755	<note>
5756	Before performing the actual data change, this method will ask all
5757	registered listeners using the
5758	<link to="IExtraDataCanChangeEvent"/>
5759	notification for a permission. If one of the listeners refuses the
5760	new value, the change will not be performed.
5761	</note>
5762	<note>
5763	On success, the
5764	<link to="IExtraDataChangedEvent"/> notification
5765	is called to inform all registered listeners about a successful data
5766	change.
5767	</note>
5768	<note>
5769	This method can be called outside the machine session and therefore
5770	it's a caller's responsibility to handle possible race conditions
5771	when several clients change the same key at the same time.
5772	</note>
5773
5774	<result name="VBOX_E_FILE_ERROR">
5775	Settings file not accessible.
5776	</result>
5777	<result name="VBOX_E_XML_ERROR">
5778	Could not parse the settings file.
5779	</result>
5780
5781	</desc>
5782	<param name="key" type="wstring" dir="in">
5783	<desc>Name of the data key to set.</desc>
5784	</param>
5785	<param name="value" type="wstring" dir="in">
5786	<desc>Value to assign to the key.</desc>
5787	</param>
5788	</method>
5789
5790	<method name="getCPUProperty" const="yes">
5791	<desc>
5792	Returns the virtual CPU boolean value of the specified property.
5793
5794	<result name="E_INVALIDARG">
5795	Invalid property.
5796	</result>
5797
5798	</desc>
5799	<param name="property" type="CPUPropertyType" dir="in">
5800	<desc>
5801	Property type to query.
5802	</desc>
5803	</param>
5804	<param name="value" type="boolean" dir="return">
5805	<desc>
5806	Property value.
5807	</desc>
5808	</param>
5809	</method>
5810
5811	<method name="setCPUProperty">
5812	<desc>
5813	Sets the virtual CPU boolean value of the specified property.
5814
5815	<result name="E_INVALIDARG">
5816	Invalid property.
5817	</result>
5818
5819	</desc>
5820	<param name="property" type="CPUPropertyType" dir="in">
5821	<desc>
5822	Property type to query.
5823	</desc>
5824	</param>
5825	<param name="value" type="boolean" dir="in">
5826	<desc>
5827	Property value.
5828	</desc>
5829	</param>
5830	</method>
5831
5832	<method name="getCPUIDLeaf" const="yes">
5833	<desc>
5834	Returns the virtual CPU cpuid information for the specified leaf.
5835
5836	Currently supported index values for cpuid:
5837	Standard CPUID leafs: 0 - 0xA
5838	Extended CPUID leafs: 0x80000000 - 0x8000000A
5839
5840	See the Intel and AMD programmer's manuals for detailed information
5841	about the cpuid instruction and its leafs.
5842	<result name="E_INVALIDARG">
5843	Invalid id.
5844	</result>
5845
5846	</desc>
5847	<param name="id" type="unsigned long" dir="in">
5848	<desc>
5849	CPUID leaf index.
5850	</desc>
5851	</param>
5852	<param name="valEax" type="unsigned long" dir="out">
5853	<desc>
5854	CPUID leaf value for register eax.
5855	</desc>
5856	</param>
5857	<param name="valEbx" type="unsigned long" dir="out">
5858	<desc>
5859	CPUID leaf value for register ebx.
5860	</desc>
5861	</param>
5862	<param name="valEcx" type="unsigned long" dir="out">
5863	<desc>
5864	CPUID leaf value for register ecx.
5865	</desc>
5866	</param>
5867	<param name="valEdx" type="unsigned long" dir="out">
5868	<desc>
5869	CPUID leaf value for register edx.
5870	</desc>
5871	</param>
5872	</method>
5873
5874	<method name="setCPUIDLeaf">
5875	<desc>
5876	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5877	are not passed unmodified. VirtualBox clears features that it doesn't support.
5878
5879	Currently supported index values for cpuid:
5880	Standard CPUID leafs: 0 - 0xA
5881	Extended CPUID leafs: 0x80000000 - 0x8000000A
5882
5883	See the Intel and AMD programmer's manuals for detailed information
5884	about the cpuid instruction and its leafs.
5885
5886	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5887	random crashes inside VMs.
5888	<result name="E_INVALIDARG">
5889	Invalid id.
5890	</result>
5891
5892	</desc>
5893	<param name="id" type="unsigned long" dir="in">
5894	<desc>
5895	CPUID leaf index.
5896	</desc>
5897	</param>
5898	<param name="valEax" type="unsigned long" dir="in">
5899	<desc>
5900	CPUID leaf value for register eax.
5901	</desc>
5902	</param>
5903	<param name="valEbx" type="unsigned long" dir="in">
5904	<desc>
5905	CPUID leaf value for register ebx.
5906	</desc>
5907	</param>
5908	<param name="valEcx" type="unsigned long" dir="in">
5909	<desc>
5910	CPUID leaf value for register ecx.
5911	</desc>
5912	</param>
5913	<param name="valEdx" type="unsigned long" dir="in">
5914	<desc>
5915	CPUID leaf value for register edx.
5916	</desc>
5917	</param>
5918	</method>
5919
5920	<method name="removeCPUIDLeaf">
5921	<desc>
5922	Removes the virtual CPU cpuid leaf for the specified index
5923
5924	<result name="E_INVALIDARG">
5925	Invalid id.
5926	</result>
5927
5928	</desc>
5929	<param name="id" type="unsigned long" dir="in">
5930	<desc>
5931	CPUID leaf index.
5932	</desc>
5933	</param>
5934	</method>
5935
5936	<method name="removeAllCPUIDLeaves">
5937	<desc>
5938	Removes all the virtual CPU cpuid leaves
5939	</desc>
5940	</method>
5941
5942	<method name="getHWVirtExProperty" const="yes">
5943	<desc>
5944	Returns the value of the specified hardware virtualization boolean property.
5945
5946	<result name="E_INVALIDARG">
5947	Invalid property.
5948	</result>
5949
5950	</desc>
5951	<param name="property" type="HWVirtExPropertyType" dir="in">
5952	<desc>
5953	Property type to query.
5954	</desc>
5955	</param>
5956	<param name="value" type="boolean" dir="return">
5957	<desc>
5958	Property value.
5959	</desc>
5960	</param>
5961	</method>
5962
5963	<method name="setHWVirtExProperty">
5964	<desc>
5965	Sets a new value for the specified hardware virtualization boolean property.
5966
5967	<result name="E_INVALIDARG">
5968	Invalid property.
5969	</result>
5970
5971	</desc>
5972	<param name="property" type="HWVirtExPropertyType" dir="in">
5973	<desc>
5974	Property type to set.
5975	</desc>
5976	</param>
5977	<param name="value" type="boolean" dir="in">
5978	<desc>
5979	New property value.
5980	</desc>
5981	</param>
5982	</method>
5983
5984	<method name="saveSettings">
5985	<desc>
5986	Saves any changes to machine settings made since the session
5987	has been opened or a new machine has been created, or since the
5988	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5989	For registered machines, new settings become visible to all
5990	other VirtualBox clients after successful invocation of this
5991	method.
5992	<note>
5993	The method sends <link to="IMachineDataChangedEvent"/>
5994	notification event after the configuration has been successfully
5995	saved (only for registered machines).
5996	</note>
5997	<note>
5998	Calling this method is only valid on instances returned
5999	by <link to="ISession::machine"/> and on new machines
6000	created by <link to="IVirtualBox::createMachine"/> but not
6001	yet registered, or on unregistered machines after calling
6002	<link to="IMachine::unregister"/>.
6003	</note>
6004
6005	<result name="VBOX_E_FILE_ERROR">
6006	Settings file not accessible.
6007	</result>
6008	<result name="VBOX_E_XML_ERROR">
6009	Could not parse the settings file.
6010	</result>
6011	<result name="E_ACCESSDENIED">
6012	Modification request refused.
6013	</result>
6014
6015	</desc>
6016	</method>
6017
6018	<method name="discardSettings">
6019	<desc>
6020	Discards any changes to the machine settings made since the session
6021	has been opened or since the last call to <link to="#saveSettings"/>
6022	or <link to="#discardSettings"/>.
6023	<note>
6024	Calling this method is only valid on instances returned
6025	by <link to="ISession::machine"/> and on new machines
6026	created by <link to="IVirtualBox::createMachine"/> or
6027	opened by <link to="IVirtualBox::openMachine"/> but not
6028	yet registered, or on unregistered machines after calling
6029	<link to="IMachine::unregister"/>.
6030	</note>
6031
6032	<result name="VBOX_E_INVALID_VM_STATE">
6033	Virtual machine is not mutable.
6034	</result>
6035
6036	</desc>
6037	</method>
6038
6039	<method name="unregister">
6040	<desc>
6041	Unregisters a machine previously registered with
6042	<link to="IVirtualBox::registerMachine"/> and optionally do additional
6043	cleanup before the machine is unregistered.
6044
6045	This method does not delete any files. It only changes the machine configuration and
6046	the list of registered machines in the VirtualBox object. To delete the files which
6047	belonged to the machine, including the XML file of the machine itself, call
6048	<link to="#deleteConfig"/>, optionally with the array of IMedium objects which was returned
6049	from this method.
6050
6051	How thoroughly this method cleans up the machine configuration before unregistering
6052	the machine depends on the @a cleanupMode argument.
6053
6054	<ul>
6055	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
6056	cleanup will be performed. The call will fail if the machine is in "Saved" state
6057	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
6058	It is the responsibility of the caller to delete all such configuration in this mode.
6059	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
6060	which it replaces.</li>
6061	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
6062	state or if it has snapshots or media attached. All media attached to the current machine
6063	state or in snapshots will be detached. No medium objects will be returned;
6064	all of the machine's media will remain open.</li>
6065	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
6066	except that all the hard disk medium objects which were detached from the machine will
6067	be returned as an array. This allows for quickly passing them to the <link to="#deleteConfig" />
6068	API for closing and deletion.</li>
6069	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
6070	that all media will be returned in the array, including removable media like DVDs and
6071	floppies. This might be useful if the user wants to inspect in detail which media were
6072	attached to the machine. Be careful when passing the media array to <link to="#deleteConfig" />
6073	in that case because users will typically want to preserve ISO and RAW image files.</li>
6074	</ul>
6075
6076	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
6077	resulting IMedium array to <link to="#deleteConfig"/>. This way, the machine is completely
6078	deleted with all its saved states and hard disk images, but images for removable
6079	drives (such as ISO and RAW files) will remain on disk.
6080
6081	This API does not verify whether the media files returned in the array are still
6082	attached to other machines (i.e. shared between several machines). If such a shared
6083	image is passed to <link to="#deleteConfig" /> however, closing the image will fail there
6084	and the image will be silently skipped.
6085
6086	This API may, however, move media from this machine's media registry to other media
6087	registries (see <link to="IMedium" /> for details on media registries). For machines
6088	created with VirtualBox 4.0 or later, if media from this machine's media registry
6089	are also attached to another machine (shared attachments), each such medium will be
6090	moved to another machine's registry. This is because without this machine's media
6091	registry, the other machine cannot find its media any more and would become inaccessible.
6092
6093	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
6094	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
6095	if media are moved to other machines' media registries.
6096
6097	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
6098	is fired.
6099
6100	The call will fail if the machine is currently locked (see <link to="ISession" />).
6101
6102	<note>
6103	If the given machine is inaccessible (see <link to="#accessible"/>), it
6104	will be unregistered and fully uninitialized right afterwards. As a result,
6105	the returned machine object will be unusable and an attempt to call
6106	<b>any</b> method will return the "Object not ready" error.
6107	</note>
6108
6109	<result name="VBOX_E_INVALID_OBJECT_STATE">
6110	Machine is currently locked for a session.
6111	</result>
6112	</desc>
6113
6114	<param name="cleanupMode" type="CleanupMode" dir="in">
6115	<desc>How to clean up after the machine has been unregistered.</desc>
6116	</param>
6117	<param name="media" type="IMedium" safearray="yes" dir="return">
6118	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
6119	</param>
6120	</method>
6121
6122	<method name="deleteConfig">
6123	<desc>
6124	Deletes the files associated with this machine from disk. If medium objects are passed
6125	in with the @a aMedia argument, they are closed and, if closing was successful, their
6126	storage files are deleted as well. For convenience, this array of media files can be
6127	the same as the one returned from a previous <link to="#unregister" /> call.
6128
6129	This method must only be called on machines which are either write-locked (i.e. on instances
6130	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
6131	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
6132	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
6133
6134	The following files will be deleted by this method:
6135	<ul>
6136	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
6137	argument other than "UnregisterOnly", this will delete all saved state files that
6138	the machine had in use; possibly one if the machine was in "Saved" state and one
6139	for each online snapshot that the machine had.</li>
6140	<li>On each medium object passed in the @a aMedia array, this will call
6141	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
6142	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
6143	in use, e.g. because it is still attached to a second machine; in that case the
6144	storage will not be deleted.</li>
6145	<li>Finally, the machine's own XML file will be deleted.</li>
6146	</ul>
6147
6148	Since deleting large disk image files can be a time-consuming I/O operation, this
6149	method operates asynchronously and returns an IProgress object to allow the caller
6150	to monitor the progress. There will be one sub-operation for each file that is
6151	being deleted (saved state or medium storage file).
6152
6153	<note>
6154	<link to="#settingsModified"/> will return @c true after this
6155	method successfully returns.
6156	</note>
6157
6158	<result name="VBOX_E_INVALID_VM_STATE">
6159	Machine is registered but not write-locked.
6160	</result>
6161	<result name="VBOX_E_IPRT_ERROR">
6162	Could not delete the settings file.
6163	</result>
6164	</desc>
6165	<param name="media" type="IMedium" safearray="yes" dir="in">
6166	<desc>List of media to be closed and whose storage files will be deleted.</desc>
6167	</param>
6168	<param name="progress" type="IProgress" dir="return">
6169	<desc>Progress object to track the operation completion.</desc>
6170	</param>
6171	</method>
6172
6173	<method name="exportTo">
6174	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
6175	steps required to export VirtualBox machines to OVF.
6176	</desc>
6177
6178	<param name="appliance" type="IAppliance" dir="in">
6179	<desc>Appliance to export this machine to.</desc>
6180	</param>
6181	<param name="location" type="wstring" dir="in">
6182	<desc>The target location.</desc>
6183	</param>
6184	<param name="description" type="IVirtualSystemDescription" dir="return">
6185	<desc>VirtualSystemDescription object which is created for this machine.</desc>
6186	</param>
6187	</method >
6188
6189	<method name="findSnapshot">
6190	<desc>
6191	Returns a snapshot of this machine with the given name or UUID.
6192
6193	Returns a snapshot of this machine with the given UUID.
6194	A @c null argument can be used to obtain the first snapshot
6195	taken on this machine. To traverse the whole tree of snapshots
6196	starting from the root, inspect the root snapshot's
6197	<link to="ISnapshot::children" /> attribute and recurse over those children.
6198
6199	<result name="VBOX_E_OBJECT_NOT_FOUND">
6200	Virtual machine has no snapshots or snapshot not found.
6201	</result>
6202
6203	</desc>
6204	<param name="nameOrId" type="wstring" dir="in">
6205	<desc>What to search for. Name or UUID of the snapshot to find</desc>
6206	</param>
6207	<param name="snapshot" type="ISnapshot" dir="return">
6208	<desc>Snapshot object with the given name.</desc>
6209	</param>
6210	</method>
6211
6212	<method name="createSharedFolder">
6213	<desc>
6214	Creates a new permanent shared folder by associating the given logical
6215	name with the given host path, adds it to the collection of shared
6216	folders and starts sharing it. Refer to the description of
6217	<link to="ISharedFolder"/> to read more about logical names.
6218
6219	<result name="VBOX_E_OBJECT_IN_USE">
6220	Shared folder already exists.
6221	</result>
6222	<result name="VBOX_E_FILE_ERROR">
6223	Shared folder @a hostPath not accessible.
6224	</result>
6225
6226	</desc>
6227	<param name="name" type="wstring" dir="in">
6228	<desc>Unique logical name of the shared folder.</desc>
6229	</param>
6230	<param name="hostPath" type="wstring" dir="in">
6231	<desc>Full path to the shared folder in the host file system.</desc>
6232	</param>
6233	<param name="writable" type="boolean" dir="in">
6234	<desc>Whether the share is writable or readonly.</desc>
6235	</param>
6236	<param name="automount" type="boolean" dir="in">
6237	<desc>Whether the share gets automatically mounted by the guest
6238	or not.</desc>
6239	</param>
6240	</method>
6241
6242	<method name="removeSharedFolder">
6243	<desc>
6244	Removes the permanent shared folder with the given name previously
6245	created by <link to="#createSharedFolder"/> from the collection of
6246	shared folders and stops sharing it.
6247
6248	<result name="VBOX_E_INVALID_VM_STATE">
6249	Virtual machine is not mutable.
6250	</result>
6251	<result name="VBOX_E_OBJECT_NOT_FOUND">
6252	Shared folder @a name does not exist.
6253	</result>
6254
6255	</desc>
6256	<param name="name" type="wstring" dir="in">
6257	<desc>Logical name of the shared folder to remove.</desc>
6258	</param>
6259	</method>
6260
6261	<method name="canShowConsoleWindow">
6262	<desc>
6263	Returns @c true if the VM console process can activate the
6264	console window and bring it to foreground on the desktop of
6265	the host PC.
6266	<note>
6267	This method will fail if a session for this machine is not
6268	currently open.
6269	</note>
6270
6271	<result name="VBOX_E_INVALID_VM_STATE">
6272	Machine session is not open.
6273	</result>
6274
6275	</desc>
6276	<param name="canShow" type="boolean" dir="return">
6277	<desc>
6278	@c true if the console window can be shown and @c false otherwise.
6279	</desc>
6280	</param>
6281	</method>
6282
6283	<method name="showConsoleWindow">
6284	<desc>
6285	Activates the console window and brings it to foreground on
6286	the desktop of the host PC. Many modern window managers on
6287	many platforms implement some sort of focus stealing
6288	prevention logic, so that it may be impossible to activate
6289	a window without the help of the currently active
6290	application. In this case, this method will return a non-zero
6291	identifier that represents the top-level window of the VM
6292	console process. The caller, if it represents a currently
6293	active process, is responsible to use this identifier (in a
6294	platform-dependent manner) to perform actual window
6295	activation.
6296	<note>
6297	This method will fail if a session for this machine is not
6298	currently open.
6299	</note>
6300
6301	<result name="VBOX_E_INVALID_VM_STATE">
6302	Machine session is not open.
6303	</result>
6304
6305	</desc>
6306	<param name="winId" type="long long" dir="return">
6307	<desc>
6308	Platform-dependent identifier of the top-level VM console
6309	window, or zero if this method has performed all actions
6310	necessary to implement the <i>show window</i> semantics for
6311	the given platform and/or VirtualBox front-end.
6312	</desc>
6313	</param>
6314	</method>
6315
6316	<method name="getGuestProperty" const="yes">
6317	<desc>
6318	Reads an entry from the machine's guest property store.
6319
6320	<result name="VBOX_E_INVALID_VM_STATE">
6321	Machine session is not open.
6322	</result>
6323
6324	</desc>
6325	<param name="name" type="wstring" dir="in">
6326	<desc>
6327	The name of the property to read.
6328	</desc>
6329	</param>
6330	<param name="value" type="wstring" dir="out">
6331	<desc>
6332	The value of the property. If the property does not exist then this
6333	will be empty.
6334	</desc>
6335	</param>
6336	<param name="timestamp" type="long long" dir="out">
6337	<desc>
6338	The time at which the property was last modified, as seen by the
6339	server process.
6340	</desc>
6341	</param>
6342	<param name="flags" type="wstring" dir="out">
6343	<desc>
6344	Additional property parameters, passed as a comma-separated list of
6345	"name=value" type entries.
6346	</desc>
6347	</param>
6348	</method>
6349
6350	<method name="getGuestPropertyValue" const="yes">
6351	<desc>
6352	Reads a value from the machine's guest property store.
6353
6354	<result name="VBOX_E_INVALID_VM_STATE">
6355	Machine session is not open.
6356	</result>
6357
6358	</desc>
6359	<param name="property" type="wstring" dir="in">
6360	<desc>
6361	The name of the property to read.
6362	</desc>
6363	</param>
6364	<param name="value" type="wstring" dir="return">
6365	<desc>
6366	The value of the property. If the property does not exist then this
6367	will be empty.
6368	</desc>
6369	</param>
6370	</method>
6371
6372	<method name="getGuestPropertyTimestamp" const="yes">
6373	<desc>
6374	Reads a property timestamp from the machine's guest property store.
6375
6376	<result name="VBOX_E_INVALID_VM_STATE">
6377	Machine session is not open.
6378	</result>
6379
6380	</desc>
6381	<param name="property" type="wstring" dir="in">
6382	<desc>
6383	The name of the property to read.
6384	</desc>
6385	</param>
6386	<param name="value" type="long long" dir="return">
6387	<desc>
6388	The timestamp. If the property does not exist then this will be
6389	empty.
6390	</desc>
6391	</param>
6392	</method>
6393
6394	<method name="setGuestProperty">
6395	<desc>
6396	Sets, changes or deletes an entry in the machine's guest property
6397	store.
6398
6399	<result name="E_ACCESSDENIED">
6400	Property cannot be changed.
6401	</result>
6402	<result name="E_INVALIDARG">
6403	Invalid @a flags.
6404	</result>
6405	<result name="VBOX_E_INVALID_VM_STATE">
6406	Virtual machine is not mutable or session not open.
6407	</result>
6408	<result name="VBOX_E_INVALID_OBJECT_STATE">
6409	Cannot set transient property when machine not running.
6410	</result>
6411
6412	</desc>
6413	<param name="property" type="wstring" dir="in">
6414	<desc>
6415	The name of the property to set, change or delete.
6416	</desc>
6417	</param>
6418	<param name="value" type="wstring" dir="in">
6419	<desc>
6420	The new value of the property to set, change or delete. If the
6421	property does not yet exist and value is non-empty, it will be
6422	created. If the value is @c null or empty, the property will be
6423	deleted if it exists.
6424	</desc>
6425	</param>
6426	<param name="flags" type="wstring" dir="in">
6427	<desc>
6428	Additional property parameters, passed as a comma-separated list of
6429	"name=value" type entries.
6430	</desc>
6431	</param>
6432	</method>
6433
6434	<method name="setGuestPropertyValue">
6435	<desc>
6436	Sets or changes a value in the machine's guest property
6437	store. The flags field will be left unchanged or created empty for a
6438	new property.
6439
6440	<result name="E_ACCESSDENIED">
6441	Property cannot be changed.
6442	</result>
6443	<result name="VBOX_E_INVALID_VM_STATE">
6444	Virtual machine is not mutable or session not open.
6445	</result>
6446	<result name="VBOX_E_INVALID_OBJECT_STATE">
6447	Cannot set transient property when machine not running.
6448	</result>
6449	</desc>
6450
6451	<param name="property" type="wstring" dir="in">
6452	<desc>
6453	The name of the property to set or change.
6454	</desc>
6455	</param>
6456	<param name="value" type="wstring" dir="in">
6457	<desc>
6458	The new value of the property to set or change. If the
6459	property does not yet exist and value is non-empty, it will be
6460	created.
6461	</desc>
6462	</param>
6463	</method>
6464
6465	<method name="deleteGuestProperty" const="yes">
6466	<desc>
6467	Deletes an entry from the machine's guest property store.
6468
6469	<result name="VBOX_E_INVALID_VM_STATE">
6470	Machine session is not open.
6471	</result>
6472
6473	</desc>
6474	<param name="name" type="wstring" dir="in">
6475	<desc>
6476	The name of the property to delete.
6477	</desc>
6478	</param>
6479	</method>
6480
6481	<method name="enumerateGuestProperties" const="yes">
6482	<desc>
6483	Return a list of the guest properties matching a set of patterns along
6484	with their values, time stamps and flags.
6485	</desc>
6486	<param name="patterns" type="wstring" dir="in">
6487	<desc>
6488	The patterns to match the properties against, separated by '\|'
6489	characters. If this is empty or @c null, all properties will match.
6490	</desc>
6491	</param>
6492	<param name="names" type="wstring" dir="out" safearray="yes">
6493	<desc>
6494	The names of the properties returned.
6495	</desc>
6496	</param>
6497	<param name="values" type="wstring" dir="out" safearray="yes">
6498	<desc>
6499	The values of the properties returned. The array entries match the
6500	corresponding entries in the @a name array.
6501	</desc>
6502	</param>
6503	<param name="timestamps" type="long long" dir="out" safearray="yes">
6504	<desc>
6505	The time stamps of the properties returned. The array entries match
6506	the corresponding entries in the @a name array.
6507	</desc>
6508	</param>
6509	<param name="flags" type="wstring" dir="out" safearray="yes">
6510	<desc>
6511	The flags of the properties returned. The array entries match the
6512	corresponding entries in the @a name array.
6513	</desc>
6514	</param>
6515	</method>
6516
6517	<method name="querySavedGuestScreenInfo" const="yes">
6518	<desc>
6519	Returns the guest dimensions from the saved state.
6520	</desc>
6521	<param name="screenId" type="unsigned long" dir="in">
6522	<desc>
6523	Saved guest screen to query info from.
6524	</desc>
6525	</param>
6526	<param name="originX" type="unsigned long" dir="out">
6527	<desc>
6528	The X position of the guest monitor top left corner.
6529	</desc>
6530	</param>
6531	<param name="originY" type="unsigned long" dir="out">
6532	<desc>
6533	The Y position of the guest monitor top left corner.
6534	</desc>
6535	</param>
6536	<param name="width" type="unsigned long" dir="out">
6537	<desc>
6538	Guest width at the time of the saved state was taken.
6539	</desc>
6540	</param>
6541	<param name="height" type="unsigned long" dir="out">
6542	<desc>
6543	Guest height at the time of the saved state was taken.
6544	</desc>
6545	</param>
6546	<param name="enabled" type="boolean" dir="out">
6547	<desc>
6548	Whether the monitor is enabled in the guest.
6549	</desc>
6550	</param>
6551	</method>
6552
6553	<method name="querySavedThumbnailSize">
6554	<desc>
6555	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6556	</desc>
6557	<param name="screenId" type="unsigned long" dir="in">
6558	<desc>
6559	Saved guest screen to query info from.
6560	</desc>
6561	</param>
6562	<param name="size" type="unsigned long" dir="out">
6563	<desc>
6564	Size of buffer required to store the bitmap.
6565	</desc>
6566	</param>
6567	<param name="width" type="unsigned long" dir="out">
6568	<desc>
6569	Bitmap width.
6570	</desc>
6571	</param>
6572	<param name="height" type="unsigned long" dir="out">
6573	<desc>
6574	Bitmap height.
6575	</desc>
6576	</param>
6577	</method>
6578
6579	<method name="readSavedThumbnailToArray">
6580	<desc>
6581	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6582	</desc>
6583	<param name="screenId" type="unsigned long" dir="in">
6584	<desc>
6585	Saved guest screen to read from.
6586	</desc>
6587	</param>
6588	<param name="BGR" type="boolean" dir="in">
6589	<desc>
6590	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6591	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6592	</desc>
6593	</param>
6594	<param name="width" type="unsigned long" dir="out">
6595	<desc>
6596	Bitmap width.
6597	</desc>
6598	</param>
6599	<param name="height" type="unsigned long" dir="out">
6600	<desc>
6601	Bitmap height.
6602	</desc>
6603	</param>
6604	<param name="data" type="octet" safearray="yes" dir="return">
6605	<desc>
6606	Array with resulting bitmap data.
6607	</desc>
6608	</param>
6609	</method>
6610
6611	<method name="readSavedThumbnailPNGToArray">
6612	<desc>
6613	Thumbnail in PNG format is retrieved to an array of bytes.
6614	</desc>
6615	<param name="screenId" type="unsigned long" dir="in">
6616	<desc>
6617	Saved guest screen to read from.
6618	</desc>
6619	</param>
6620	<param name="width" type="unsigned long" dir="out">
6621	<desc>
6622	Image width.
6623	</desc>
6624	</param>
6625	<param name="height" type="unsigned long" dir="out">
6626	<desc>
6627	Image height.
6628	</desc>
6629	</param>
6630	<param name="data" type="octet" dir="return" safearray="yes">
6631	<desc>
6632	Array with resulting PNG data.
6633	</desc>
6634	</param>
6635	</method>
6636
6637	<method name="querySavedScreenshotPNGSize">
6638	<desc>
6639	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6640	</desc>
6641	<param name="screenId" type="unsigned long" dir="in">
6642	<desc>
6643	Saved guest screen to query info from.
6644	</desc>
6645	</param>
6646	<param name="size" type="unsigned long" dir="out">
6647	<desc>
6648	Size of buffer required to store the PNG binary data.
6649	</desc>
6650	</param>
6651	<param name="width" type="unsigned long" dir="out">
6652	<desc>
6653	Image width.
6654	</desc>
6655	</param>
6656	<param name="height" type="unsigned long" dir="out">
6657	<desc>
6658	Image height.
6659	</desc>
6660	</param>
6661	</method>
6662
6663	<method name="readSavedScreenshotPNGToArray">
6664	<desc>
6665	Screenshot in PNG format is retrieved to an array of bytes.
6666	</desc>
6667	<param name="screenId" type="unsigned long" dir="in">
6668	<desc>
6669	Saved guest screen to read from.
6670	</desc>
6671	</param>
6672	<param name="width" type="unsigned long" dir="out">
6673	<desc>
6674	Image width.
6675	</desc>
6676	</param>
6677	<param name="height" type="unsigned long" dir="out">
6678	<desc>
6679	Image height.
6680	</desc>
6681	</param>
6682	<param name="data" type="octet" dir="return" safearray="yes">
6683	<desc>
6684	Array with resulting PNG data.
6685	</desc>
6686	</param>
6687	</method>
6688
6689	<method name="hotPlugCPU">
6690	<desc>
6691	Plugs a CPU into the machine.
6692	</desc>
6693	<param name="cpu" type="unsigned long" dir="in">
6694	<desc>
6695	The CPU id to insert.
6696	</desc>
6697	</param>
6698	</method>
6699
6700	<method name="hotUnplugCPU">
6701	<desc>
6702	Removes a CPU from the machine.
6703	</desc>
6704	<param name="cpu" type="unsigned long" dir="in">
6705	<desc>
6706	The CPU id to remove.
6707	</desc>
6708	</param>
6709	</method>
6710
6711	<method name="getCPUStatus">
6712	<desc>
6713	Returns the current status of the given CPU.
6714	</desc>
6715	<param name="cpu" type="unsigned long" dir="in">
6716	<desc>
6717	The CPU id to check for.
6718	</desc>
6719	</param>
6720	<param name="attached" type="boolean" dir="return">
6721	<desc>
6722	Status of the CPU.
6723	</desc>
6724	</param>
6725	</method>
6726
6727	<method name="queryLogFilename">
6728	<desc>
6729	Queries for the VM log file name of an given index. Returns an empty
6730	string if a log file with that index doesn't exists.
6731	</desc>
6732	<param name="idx" type="unsigned long" dir="in">
6733	<desc>
6734	Which log file name to query. 0=current log file.
6735	</desc>
6736	</param>
6737	<param name="filename" type="wstring" dir="return">
6738	<desc>
6739	On return the full path to the log file or an empty string on error.
6740	</desc>
6741	</param>
6742	</method>
6743
6744	<method name="readLog">
6745	<desc>
6746	Reads the VM log file. The chunk size is limited, so even if you
6747	ask for a big piece there might be less data returned.
6748	</desc>
6749	<param name="idx" type="unsigned long" dir="in">
6750	<desc>
6751	Which log file to read. 0=current log file.
6752	</desc>
6753	</param>
6754	<param name="offset" type="long long" dir="in">
6755	<desc>
6756	Offset in the log file.
6757	</desc>
6758	</param>
6759	<param name="size" type="long long" dir="in">
6760	<desc>
6761	Chunk size to read in the log file.
6762	</desc>
6763	</param>
6764	<param name="data" type="octet" dir="return" safearray="yes">
6765	<desc>
6766	Data read from the log file. A data size of 0 means end of file
6767	if the requested chunk size was not 0. This is the unprocessed
6768	file data, i.e. the line ending style depends on the platform of
6769	the system the server is running on.
6770	</desc>
6771	</param>
6772	</method>
6773
6774	<method name="cloneTo">
6775	<desc>
6776	Creates a clone of this machine, either as a full clone (which means
6777	creating independent copies of the hard disk media, save states and so
6778	on), or as a linked clone (which uses its own differencing media,
6779	sharing the parent media with the source machine).
6780
6781	The target machine object must have been created previously with <link
6782	to="IVirtualBox::createMachine"/>, and all the settings will be
6783	transferred except the VM name and the hardware UUID. You can set the
6784	VM name and the new hardware UUID when creating the target machine. The
6785	network MAC addresses are newly created for all newtwork adapters. You
6786	can change that behaviour with the options parameter. The operation is
6787	performed asynchronously, so the machine object will be not be usable
6788	until the @a progress object signals completion.
6789
6790	<result name="E_INVALIDARG">
6791	@a target is @c null.
6792	</result>
6793	</desc>
6794
6795	<param name="target" type="IMachine" dir="in">
6796	<desc>Target machine object.</desc>
6797	</param>
6798	<param name="mode" type="CloneMode" dir="in">
6799	<desc>Which states should be cloned.</desc>
6800	</param>
6801	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6802	<desc>Options for the cloning operation.</desc>
6803	</param>
6804	<param name="progress" type="IProgress" dir="return">
6805	<desc>Progress object to track the operation completion.</desc>
6806	</param>
6807	</method>
6808
6809	</interface>
6810
6811	<!--
6812	// IConsole
6813	/////////////////////////////////////////////////////////////////////////
6814	-->
6815
6816	<interface
6817	name="IVRDEServerInfo" extends="$unknown"
6818	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6819	wsmap="struct"
6820	>
6821	<desc>
6822	Contains information about the remote desktop (VRDE) server capabilities and status.
6823	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6824	</desc>
6825
6826	<attribute name="active" type="boolean" readonly="yes">
6827	<desc>
6828	Whether the remote desktop connection is active.
6829	</desc>
6830	</attribute>
6831
6832	<attribute name="port" type="long" readonly="yes">
6833	<desc>
6834	VRDE server port number. If this property is equal to <tt>0</tt>, then
6835	the VRDE server failed to start, usually because there are no free IP
6836	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6837	server has not yet been started.
6838	</desc>
6839	</attribute>
6840
6841	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6842	<desc>
6843	How many times a client connected.
6844	</desc>
6845	</attribute>
6846
6847	<attribute name="beginTime" type="long long" readonly="yes">
6848	<desc>
6849	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6850	</desc>
6851	</attribute>
6852
6853	<attribute name="endTime" type="long long" readonly="yes">
6854	<desc>
6855	When the last connection was terminated or the current time, if
6856	connection is still active, in milliseconds since 1970-01-01 UTC.
6857	</desc>
6858	</attribute>
6859
6860	<attribute name="bytesSent" type="long long" readonly="yes">
6861	<desc>
6862	How many bytes were sent in last or current, if still active, connection.
6863	</desc>
6864	</attribute>
6865
6866	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6867	<desc>
6868	How many bytes were sent in all connections.
6869	</desc>
6870	</attribute>
6871
6872	<attribute name="bytesReceived" type="long long" readonly="yes">
6873	<desc>
6874	How many bytes were received in last or current, if still active, connection.
6875	</desc>
6876	</attribute>
6877
6878	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6879	<desc>
6880	How many bytes were received in all connections.
6881	</desc>
6882	</attribute>
6883
6884	<attribute name="user" type="wstring" readonly="yes">
6885	<desc>
6886	Login user name supplied by the client.
6887	</desc>
6888	</attribute>
6889
6890	<attribute name="domain" type="wstring" readonly="yes">
6891	<desc>
6892	Login domain name supplied by the client.
6893	</desc>
6894	</attribute>
6895
6896	<attribute name="clientName" type="wstring" readonly="yes">
6897	<desc>
6898	The client name supplied by the client.
6899	</desc>
6900	</attribute>
6901
6902	<attribute name="clientIP" type="wstring" readonly="yes">
6903	<desc>
6904	The IP address of the client.
6905	</desc>
6906	</attribute>
6907
6908	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6909	<desc>
6910	The client software version number.
6911	</desc>
6912	</attribute>
6913
6914	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6915	<desc>
6916	Public key exchange method used when connection was established.
6917	Values: 0 - RDP4 public key exchange scheme.
6918	1 - X509 certificates were sent to client.
6919	</desc>
6920	</attribute>
6921
6922	</interface>
6923
6924	<interface
6925	name="IConsole" extends="$unknown"
6926	uuid="db7ab4ca-2a3f-4183-9243-c1208da92392"
6927	wsmap="managed"
6928	>
6929	<desc>
6930	The IConsole interface represents an interface to control virtual
6931	machine execution.
6932
6933	A console object gets created when a machine has been locked for a
6934	particular session (client process) using <link to="IMachine::lockMachine" />
6935	or <link to="IMachine::launchVMProcess"/>. The console object can
6936	then be found in the session's <link to="ISession::console" /> attribute.
6937
6938	Methods of the IConsole interface allow the caller to query the current
6939	virtual machine execution state, pause the machine or power it down, save
6940	the machine state or take a snapshot, attach and detach removable media
6941	and so on.
6942
6943	<see><link to="ISession"/></see>
6944	</desc>
6945
6946	<attribute name="machine" type="IMachine" readonly="yes">
6947	<desc>
6948	Machine object for this console session.
6949	<note>
6950	This is a convenience property, it has the same value as
6951	<link to="ISession::machine"/> of the corresponding session
6952	object.
6953	</note>
6954	</desc>
6955	</attribute>
6956
6957	<attribute name="state" type="MachineState" readonly="yes">
6958	<desc>
6959	Current execution state of the machine.
6960	<note>
6961	This property always returns the same value as the corresponding
6962	property of the IMachine object for this console session.
6963	For the process that owns (executes) the VM, this is the
6964	preferable way of querying the VM state, because no IPC
6965	calls are made.
6966	</note>
6967	</desc>
6968	</attribute>
6969
6970	<attribute name="guest" type="IGuest" readonly="yes">
6971	<desc>Guest object.</desc>
6972	</attribute>
6973
6974	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6975	<desc>
6976	Virtual keyboard object.
6977	<note>
6978	If the machine is not running, any attempt to use
6979	the returned object will result in an error.
6980	</note>
6981	</desc>
6982	</attribute>
6983
6984	<attribute name="mouse" type="IMouse" readonly="yes">
6985	<desc>
6986	Virtual mouse object.
6987	<note>
6988	If the machine is not running, any attempt to use
6989	the returned object will result in an error.
6990	</note>
6991	</desc>
6992	</attribute>
6993
6994	<attribute name="display" type="IDisplay" readonly="yes">
6995	<desc>Virtual display object.
6996	<note>
6997	If the machine is not running, any attempt to use
6998	the returned object will result in an error.
6999	</note>
7000	</desc>
7001	</attribute>
7002
7003	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
7004	<desc>Debugging interface.</desc>
7005	</attribute>
7006
7007	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
7008	<desc>
7009	Collection of USB devices currently attached to the virtual
7010	USB controller.
7011	<note>
7012	The collection is empty if the machine is not running.
7013	</note>
7014	</desc>
7015	</attribute>
7016
7017	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7018	<desc>
7019	List of USB devices currently attached to the remote VRDE client.
7020	Once a new device is physically attached to the remote host computer,
7021	it appears in this list and remains there until detached.
7022	</desc>
7023	</attribute>
7024
7025	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
7026	<desc>
7027	Collection of shared folders for the current session. These folders
7028	are called transient shared folders because they are available to the
7029	guest OS running inside the associated virtual machine only for the
7030	duration of the session (as opposed to
7031	<link to="IMachine::sharedFolders"/> which represent permanent shared
7032	folders). When the session is closed (e.g. the machine is powered down),
7033	these folders are automatically discarded.
7034
7035	New shared folders are added to the collection using
7036	<link to="#createSharedFolder"/>. Existing shared folders can be
7037	removed using <link to="#removeSharedFolder"/>.
7038	</desc>
7039	</attribute>
7040
7041	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
7042	<desc>
7043	Interface that provides information on Remote Desktop Extension (VRDE) connection.
7044	</desc>
7045	</attribute>
7046
7047	<attribute name="eventSource" type="IEventSource" readonly="yes">
7048	<desc>
7049	Event source for console events.
7050	</desc>
7051	</attribute>
7052
7053	<attribute name="attachedPCIDevices" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
7054	<desc>Array of PCI devices attached to this machine.</desc>
7055	</attribute>
7056
7057	<attribute name="useHostClipboard" type="boolean">
7058	<desc>
7059	Whether the guest clipboard should be connected to the host one or
7060	whether it should only be allowed access to the VRDE clipboard. This
7061	setting may not affect existing guest clipboard connections which
7062	are already connected to the host clipboard.
7063	</desc>
7064	</attribute>
7065
7066	<method name="powerUp">
7067	<desc>
7068	Starts the virtual machine execution using the current machine
7069	state (that is, its current execution state, current settings and
7070	current storage devices).
7071
7072	<note>
7073	This method is only useful for front-ends that want to actually
7074	execute virtual machines in their own process (like the VirtualBox
7075	or VBoxSDL front-ends). Unless you are intending to write such a
7076	front-end, do not call this method. If you simply want to
7077	start virtual machine execution using one of the existing front-ends
7078	(for example the VirtualBox GUI or headless server), use
7079	<link to="IMachine::launchVMProcess"/> instead; these
7080	front-ends will power up the machine automatically for you.
7081	</note>
7082
7083	If the machine is powered off or aborted, the execution will
7084	start from the beginning (as if the real hardware were just
7085	powered on).
7086
7087	If the machine is in the <link to="MachineState_Saved"/> state,
7088	it will continue its execution the point where the state has
7089	been saved.
7090
7091	If the machine <link to="IMachine::teleporterEnabled"/> property is
7092	enabled on the machine being powered up, the machine will wait for an
7093	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
7094	state. The returned progress object will have at least three
7095	operations where the last three are defined as: (1) powering up and
7096	starting TCP server, (2) waiting for incoming teleportations, and
7097	(3) perform teleportation. These operations will be reflected as the
7098	last three operations of the progress objected returned by
7099	<link to="IMachine::launchVMProcess"/> as well.
7100
7101	<see><link to="#saveState"/></see>
7102
7103	<result name="VBOX_E_INVALID_VM_STATE">
7104	Virtual machine already running.
7105	</result>
7106	<result name="VBOX_E_HOST_ERROR">
7107	Host interface does not exist or name not set.
7108	</result>
7109	<result name="VBOX_E_FILE_ERROR">
7110	Invalid saved state file.
7111	</result>
7112	</desc>
7113	<param name="progress" type="IProgress" dir="return">
7114	<desc>Progress object to track the operation completion.</desc>
7115	</param>
7116	</method>
7117
7118	<method name="powerUpPaused">
7119	<desc>
7120	Identical to powerUp except that the VM will enter the
7121	<link to="MachineState_Paused"/> state, instead of
7122	<link to="MachineState_Running"/>.
7123
7124	<see><link to="#powerUp"/></see>
7125	<result name="VBOX_E_INVALID_VM_STATE">
7126	Virtual machine already running.
7127	</result>
7128	<result name="VBOX_E_HOST_ERROR">
7129	Host interface does not exist or name not set.
7130	</result>
7131	<result name="VBOX_E_FILE_ERROR">
7132	Invalid saved state file.
7133	</result>
7134	</desc>
7135	<param name="progress" type="IProgress" dir="return">
7136	<desc>Progress object to track the operation completion.</desc>
7137	</param>
7138	</method>
7139
7140	<method name="powerDown">
7141	<desc>
7142	Initiates the power down procedure to stop the virtual machine
7143	execution.
7144
7145	The completion of the power down procedure is tracked using the returned
7146	IProgress object. After the operation is complete, the machine will go
7147	to the PoweredOff state.
7148	<result name="VBOX_E_INVALID_VM_STATE">
7149	Virtual machine must be Running, Paused or Stuck to be powered down.
7150	</result>
7151	</desc>
7152	<param name="progress" type="IProgress" dir="return">
7153	<desc>Progress object to track the operation completion.</desc>
7154	</param>
7155	</method>
7156
7157	<method name="reset">
7158	<desc>Resets the virtual machine.
7159	<result name="VBOX_E_INVALID_VM_STATE">
7160	Virtual machine not in Running state.
7161	</result>
7162	<result name="VBOX_E_VM_ERROR">
7163	Virtual machine error in reset operation.
7164	</result>
7165	</desc>
7166	</method>
7167
7168	<method name="pause">
7169	<desc>Pauses the virtual machine execution.
7170	<result name="VBOX_E_INVALID_VM_STATE">
7171	Virtual machine not in Running state.
7172	</result>
7173	<result name="VBOX_E_VM_ERROR">
7174	Virtual machine error in suspend operation.
7175	</result>
7176	</desc>
7177	</method>
7178
7179	<method name="resume">
7180	<desc>Resumes the virtual machine execution.
7181	<result name="VBOX_E_INVALID_VM_STATE">
7182	Virtual machine not in Paused state.
7183	</result>
7184	<result name="VBOX_E_VM_ERROR">
7185	Virtual machine error in resume operation.
7186	</result>
7187	</desc>
7188	</method>
7189
7190	<method name="powerButton">
7191	<desc>Sends the ACPI power button event to the guest.
7192	<result name="VBOX_E_INVALID_VM_STATE">
7193	Virtual machine not in Running state.
7194	</result>
7195	<result name="VBOX_E_PDM_ERROR">
7196	Controlled power off failed.
7197	</result>
7198	</desc>
7199	</method>
7200
7201	<method name="sleepButton">
7202	<desc>Sends the ACPI sleep button event to the guest.
7203	<result name="VBOX_E_INVALID_VM_STATE">
7204	Virtual machine not in Running state.
7205	</result>
7206	<result name="VBOX_E_PDM_ERROR">
7207	Sending sleep button event failed.
7208	</result>
7209	</desc>
7210	</method>
7211
7212	<method name="getPowerButtonHandled">
7213	<desc>Checks if the last power button event was handled by guest.
7214	<result name="VBOX_E_PDM_ERROR">
7215	Checking if the event was handled by the guest OS failed.
7216	</result>
7217	</desc>
7218	<param name="handled" type="boolean" dir="return"/>
7219	</method>
7220
7221	<method name="getGuestEnteredACPIMode">
7222	<desc>Checks if the guest entered the ACPI mode G0 (working) or
7223	G1 (sleeping). If this method returns @c false, the guest will
7224	most likely not respond to external ACPI events.
7225	<result name="VBOX_E_INVALID_VM_STATE">
7226	Virtual machine not in Running state.
7227	</result>
7228	</desc>
7229	<param name="entered" type="boolean" dir="return"/>
7230	</method>
7231
7232	<method name="saveState">
7233	<desc>
7234	Saves the current execution state of a running virtual machine
7235	and stops its execution.
7236
7237	After this operation completes, the machine will go to the
7238	Saved state. Next time it is powered up, this state will
7239	be restored and the machine will continue its execution from
7240	the place where it was saved.
7241
7242	This operation differs from taking a snapshot to the effect
7243	that it doesn't create new differencing media. Also, once
7244	the machine is powered up from the state saved using this method,
7245	the saved state is deleted, so it will be impossible to return
7246	to this state later.
7247
7248	<note>
7249	On success, this method implicitly calls
7250	<link to="IMachine::saveSettings"/> to save all current machine
7251	settings (including runtime changes to the DVD medium, etc.).
7252	Together with the impossibility to change any VM settings when it is
7253	in the Saved state, this guarantees adequate hardware
7254	configuration of the machine when it is restored from the saved
7255	state file.
7256	</note>
7257
7258	<note>
7259	The machine must be in the Running or Paused state, otherwise
7260	the operation will fail.
7261	</note>
7262	<result name="VBOX_E_INVALID_VM_STATE">
7263	Virtual machine state neither Running nor Paused.
7264	</result>
7265	<result name="VBOX_E_FILE_ERROR">
7266	Failed to create directory for saved state file.
7267	</result>
7268
7269	<see><link to="#takeSnapshot"/></see>
7270	</desc>
7271	<param name="progress" type="IProgress" dir="return">
7272	<desc>Progress object to track the operation completion.</desc>
7273	</param>
7274	</method>
7275
7276	<method name="adoptSavedState">
7277	<desc>
7278	Associates the given saved state file to the virtual machine.
7279
7280	On success, the machine will go to the Saved state. Next time it is
7281	powered up, it will be restored from the adopted saved state and
7282	continue execution from the place where the saved state file was
7283	created.
7284
7285	The specified saved state file path may be absolute or relative to the
7286	folder the VM normally saves the state to (usually,
7287	<link to="IMachine::snapshotFolder"/>).
7288
7289	<note>
7290	It's a caller's responsibility to make sure the given saved state
7291	file is compatible with the settings of this virtual machine that
7292	represent its virtual hardware (memory size, storage disk configuration
7293	etc.). If there is a mismatch, the behavior of the virtual machine
7294	is undefined.
7295	</note>
7296	<result name="VBOX_E_INVALID_VM_STATE">
7297	Virtual machine state neither PoweredOff nor Aborted.
7298	</result>
7299	</desc>
7300	<param name="savedStateFile" type="wstring" dir="in">
7301	<desc>Path to the saved state file to adopt.</desc>
7302	</param>
7303	</method>
7304
7305	<method name="discardSavedState">
7306	<desc>
7307	Forcibly resets the machine to "Powered Off" state if it is
7308	currently in the "Saved" state (previously created by <link to="#saveState"/>).
7309	Next time the machine is powered up, a clean boot will occur.
7310	<note>
7311	This operation is equivalent to resetting or powering off
7312	the machine without doing a proper shutdown of the guest
7313	operating system; as with resetting a running phyiscal
7314	computer, it can can lead to data loss.
7315	</note>
7316	If @a fRemoveFile is @c true, the file in the machine directory
7317	into which the machine state was saved is also deleted. If
7318	this is @c false, then the state can be recovered and later
7319	re-inserted into a machine using <link to="#adoptSavedState" />.
7320	The location of the file can be found in the
7321	<link to="IMachine::stateFilePath" /> attribute.
7322	<result name="VBOX_E_INVALID_VM_STATE">
7323	Virtual machine not in state Saved.
7324	</result>
7325	</desc>
7326	<param name="fRemoveFile" type="boolean" dir="in" >
7327	<desc>Whether to also remove the saved state file.</desc>
7328	</param>
7329	</method>
7330
7331	<method name="getDeviceActivity">
7332	<desc>
7333	Gets the current activity type of a given device or device group.
7334	<result name="E_INVALIDARG">
7335	Invalid device type.
7336	</result>
7337	</desc>
7338	<param name="type" type="DeviceType" dir="in"/>
7339	<param name="activity" type="DeviceActivity" dir="return"/>
7340	</method>
7341
7342	<method name="attachUSBDevice">
7343	<desc>
7344	Attaches a host USB device with the given UUID to the
7345	USB controller of the virtual machine.
7346
7347	The device needs to be in one of the following states:
7348	<link to="USBDeviceState_Busy"/>,
7349	<link to="USBDeviceState_Available"/> or
7350	<link to="USBDeviceState_Held"/>,
7351	otherwise an error is immediately returned.
7352
7353	When the device state is
7354	<link to="USBDeviceState_Busy">Busy</link>, an error may also
7355	be returned if the host computer refuses to release it for some reason.
7356
7357	<see><link to="IUSBController::deviceFilters"/>,
7358	<link to="USBDeviceState"/></see>
7359	<result name="VBOX_E_INVALID_VM_STATE">
7360	Virtual machine state neither Running nor Paused.
7361	</result>
7362	<result name="VBOX_E_PDM_ERROR">
7363	Virtual machine does not have a USB controller.
7364	</result>
7365	</desc>
7366	<param name="id" type="uuid" mod="string" dir="in">
7367	<desc>UUID of the host USB device to attach.</desc>
7368	</param>
7369	</method>
7370
7371	<method name="detachUSBDevice">
7372	<desc>
7373	Detaches an USB device with the given UUID from the USB controller
7374	of the virtual machine.
7375
7376	After this method succeeds, the VirtualBox server re-initiates
7377	all USB filters as if the device were just physically attached
7378	to the host, but filters of this machine are ignored to avoid
7379	a possible automatic re-attachment.
7380
7381	<see><link to="IUSBController::deviceFilters"/>,
7382	<link to="USBDeviceState"/></see>
7383
7384	<result name="VBOX_E_PDM_ERROR">
7385	Virtual machine does not have a USB controller.
7386	</result>
7387	<result name="E_INVALIDARG">
7388	USB device not attached to this virtual machine.
7389	</result>
7390	</desc>
7391	<param name="id" type="uuid" mod="string" dir="in">
7392	<desc>UUID of the USB device to detach.</desc>
7393	</param>
7394	<param name="device" type="IUSBDevice" dir="return">
7395	<desc>Detached USB device.</desc>
7396	</param>
7397	</method>
7398
7399	<method name="findUSBDeviceByAddress">
7400	<desc>
7401	Searches for a USB device with the given host address.
7402
7403	<result name="VBOX_E_OBJECT_NOT_FOUND">
7404	Given @c name does not correspond to any USB device.
7405	</result>
7406
7407	<see><link to="IUSBDevice::address"/></see>
7408	</desc>
7409	<param name="name" type="wstring" dir="in">
7410	<desc>
7411	Address of the USB device (as assigned by the host) to
7412	search for.
7413	</desc>
7414	</param>
7415	<param name="device" type="IUSBDevice" dir="return">
7416	<desc>Found USB device object.</desc>
7417	</param>
7418	</method>
7419
7420	<method name="findUSBDeviceById">
7421	<desc>
7422	Searches for a USB device with the given UUID.
7423
7424	<result name="VBOX_E_OBJECT_NOT_FOUND">
7425	Given @c id does not correspond to any USB device.
7426	</result>
7427
7428	<see><link to="IUSBDevice::id"/></see>
7429	</desc>
7430	<param name="id" type="uuid" mod="string" dir="in">
7431	<desc>UUID of the USB device to search for.</desc>
7432	</param>
7433	<param name="device" type="IUSBDevice" dir="return">
7434	<desc>Found USB device object.</desc>
7435	</param>
7436	</method>
7437
7438	<method name="createSharedFolder">
7439	<desc>
7440	Creates a transient new shared folder by associating the given logical
7441	name with the given host path, adds it to the collection of shared
7442	folders and starts sharing it. Refer to the description of
7443	<link to="ISharedFolder"/> to read more about logical names.
7444
7445	<result name="VBOX_E_INVALID_VM_STATE">
7446	Virtual machine in Saved state or currently changing state.
7447	</result>
7448	<result name="VBOX_E_FILE_ERROR">
7449	Shared folder already exists or not accessible.
7450	</result>
7451	</desc>
7452	<param name="name" type="wstring" dir="in">
7453	<desc>Unique logical name of the shared folder.</desc>
7454	</param>
7455	<param name="hostPath" type="wstring" dir="in">
7456	<desc>Full path to the shared folder in the host file system.</desc>
7457	</param>
7458	<param name="writable" type="boolean" dir="in">
7459	<desc>Whether the share is writable or readonly</desc>
7460	</param>
7461	<param name="automount" type="boolean" dir="in">
7462	<desc>Whether the share gets automatically mounted by the guest
7463	or not.</desc>
7464	</param>
7465	</method>
7466
7467	<method name="removeSharedFolder">
7468	<desc>
7469	Removes a transient shared folder with the given name previously
7470	created by <link to="#createSharedFolder"/> from the collection of
7471	shared folders and stops sharing it.
7472	<result name="VBOX_E_INVALID_VM_STATE">
7473	Virtual machine in Saved state or currently changing state.
7474	</result>
7475	<result name="VBOX_E_FILE_ERROR">
7476	Shared folder does not exists.
7477	</result>
7478	</desc>
7479	<param name="name" type="wstring" dir="in">
7480	<desc>Logical name of the shared folder to remove.</desc>
7481	</param>
7482	</method>
7483
7484	<method name="takeSnapshot">
7485	<desc>
7486	Saves the current execution state
7487	and all settings of the machine and creates differencing images
7488	for all normal (non-independent) media.
7489	See <link to="ISnapshot" /> for an introduction to snapshots.
7490
7491	This method can be called for a PoweredOff, Saved (see
7492	<link to="#saveState"/>), Running or
7493	Paused virtual machine. When the machine is PoweredOff, an
7494	offline snapshot is created. When the machine is Running a live
7495	snapshot is created, and an online snapshot is created when Paused.
7496
7497	The taken snapshot is always based on the
7498	<link to="IMachine::currentSnapshot">current snapshot</link>
7499	of the associated virtual machine and becomes a new current snapshot.
7500
7501	<note>
7502	This method implicitly calls <link to="IMachine::saveSettings"/> to
7503	save all current machine settings before taking an offline snapshot.
7504	</note>
7505
7506	<result name="VBOX_E_INVALID_VM_STATE">
7507	Virtual machine currently changing state.
7508	</result>
7509	</desc>
7510	<param name="name" type="wstring" dir="in">
7511	<desc>Short name for the snapshot.</desc>
7512	</param>
7513	<param name="description" type="wstring" dir="in">
7514	<desc>Optional description of the snapshot.</desc>
7515	</param>
7516	<param name="progress" type="IProgress" dir="return">
7517	<desc>Progress object to track the operation completion.</desc>
7518	</param>
7519	</method>
7520
7521	<method name="deleteSnapshot">
7522	<desc>
7523	Starts deleting the specified snapshot asynchronously.
7524	See <link to="ISnapshot" /> for an introduction to snapshots.
7525
7526	The execution state and settings of the associated machine stored in
7527	the snapshot will be deleted. The contents of all differencing media of
7528	this snapshot will be merged with the contents of their dependent child
7529	media to keep the medium chain valid (in other words, all changes
7530	represented by media being deleted will be propagated to their child
7531	medium). After that, this snapshot's differencing medium will be
7532	deleted. The parent of this snapshot will become a new parent for all
7533	its child snapshots.
7534
7535	If the deleted snapshot is the current one, its parent snapshot will
7536	become a new current snapshot. The current machine state is not directly
7537	affected in this case, except that currently attached differencing
7538	media based on media of the deleted snapshot will be also merged as
7539	described above.
7540
7541	If the deleted snapshot is the first or current snapshot, then the
7542	respective IMachine attributes will be adjusted. Deleting the current
7543	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7544	to make all current machine settings permanent.
7545
7546	Deleting a snapshot has the following preconditions:
7547
7548	<ul>
7549	<li>Child media of all normal media of the deleted snapshot
7550	must be accessible (see <link to="IMedium::state"/>) for this
7551	operation to succeed. If only one running VM refers to all images
7552	which participates in merging the operation can be performed while
7553	the VM is running. Otherwise all virtual machines whose media are
7554	directly or indirectly based on the media of deleted snapshot must
7555	be powered off. In any case, online snapshot deleting usually is
7556	slower than the same operation without any running VM.</li>
7557
7558	<li>You cannot delete the snapshot if a medium attached to it has
7559	more than one child medium (differencing images) because otherwise
7560	merging would be impossible. This might be the case if there is
7561	more than one child snapshot or differencing images were created
7562	for other reason (e.g. implicitly because of multiple machine
7563	attachments).</li>
7564	</ul>
7565
7566	The virtual machine's <link to="IMachine::state">state</link> is
7567	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7568	"DeletingSnapshotPaused" while this operation is in progress.
7569
7570	<note>
7571	Merging medium contents can be very time and disk space
7572	consuming, if these media are big in size and have many
7573	children. However, if the snapshot being deleted is the last
7574	(head) snapshot on the branch, the operation will be rather
7575	quick.
7576	</note>
7577	<result name="VBOX_E_INVALID_VM_STATE">
7578	The running virtual machine prevents deleting this snapshot. This
7579	happens only in very specific situations, usually snapshots can be
7580	deleted without trouble while a VM is running. The error message
7581	text explains the reason for the failure.
7582	</result>
7583	</desc>
7584	<param name="id" type="uuid" mod="string" dir="in">
7585	<desc>UUID of the snapshot to delete.</desc>
7586	</param>
7587	<param name="progress" type="IProgress" dir="return">
7588	<desc>Progress object to track the operation completion.</desc>
7589	</param>
7590	</method>
7591
7592	<method name="deleteSnapshotAndAllChildren">
7593	<desc>
7594	Starts deleting the specified snapshot and all its children
7595	asynchronously. See <link to="ISnapshot" /> for an introduction to
7596	snapshots. The conditions and many details are the same as with
7597	<link to="#deleteSnapshot"/>.
7598
7599	This operation is very fast if the snapshot subtree does not include
7600	the current state. It is still significantly faster than deleting the
7601	snapshots one by one if the current state is in the subtree and there
7602	are more than one snapshots from current state to the snapshot which
7603	marks the subtree, since it eliminates the incremental image merging.
7604
7605	<note>This API method is right now not implemented!</note>
7606
7607	<result name="VBOX_E_INVALID_VM_STATE">
7608	The running virtual machine prevents deleting this snapshot. This
7609	happens only in very specific situations, usually snapshots can be
7610	deleted without trouble while a VM is running. The error message
7611	text explains the reason for the failure.
7612	</result>
7613	<result name="E_NOTIMPL">
7614	The method is not implemented yet.
7615	</result>
7616	</desc>
7617	<param name="id" type="uuid" mod="string" dir="in">
7618	<desc>UUID of the snapshot to delete, including all its children.</desc>
7619	</param>
7620	<param name="progress" type="IProgress" dir="return">
7621	<desc>Progress object to track the operation completion.</desc>
7622	</param>
7623	</method>
7624
7625	<method name="deleteSnapshotRange">
7626	<desc>
7627	Starts deleting the specified snapshot range. This is limited to
7628	linear snapshot lists, which means there may not be any other child
7629	snapshots other than the direct sequence between the start and end
7630	snapshot. If the start and end snapshot point to the same snapshot this
7631	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7632	<link to="ISnapshot" /> for an introduction to snapshots. The
7633	conditions and many details are the same as with
7634	<link to="#deleteSnapshot"/>.
7635
7636	This operation is generally faster than deleting snapshots one by one
7637	and often also needs less extra disk space before freeing up disk space
7638	by deleting the removed disk images corresponding to the snapshot.
7639
7640	<note>This API method is right now not implemented!</note>
7641
7642	<result name="VBOX_E_INVALID_VM_STATE">
7643	The running virtual machine prevents deleting this snapshot. This
7644	happens only in very specific situations, usually snapshots can be
7645	deleted without trouble while a VM is running. The error message
7646	text explains the reason for the failure.
7647	</result>
7648	<result name="E_NOTIMPL">
7649	The method is not implemented yet.
7650	</result>
7651	</desc>
7652	<param name="startId" type="uuid" mod="string" dir="in">
7653	<desc>UUID of the first snapshot to delete.</desc>
7654	</param>
7655	<param name="endId" type="uuid" mod="string" dir="in">
7656	<desc>UUID of the last snapshot to delete.</desc>
7657	</param>
7658	<param name="progress" type="IProgress" dir="return">
7659	<desc>Progress object to track the operation completion.</desc>
7660	</param>
7661	</method>
7662
7663	<method name="restoreSnapshot">
7664	<desc>
7665	Starts resetting the machine's current state to the state contained
7666	in the given snapshot, asynchronously. All current settings of the
7667	machine will be reset and changes stored in differencing media
7668	will be lost.
7669	See <link to="ISnapshot" /> for an introduction to snapshots.
7670
7671	After this operation is successfully completed, new empty differencing
7672	media are created for all normal media of the machine.
7673
7674	If the given snapshot is an online snapshot, the machine will go to
7675	the <link to="MachineState_Saved"> saved state</link>, so that the
7676	next time it is powered on, the execution state will be restored
7677	from the state of the snapshot.
7678
7679	<note>
7680	The machine must not be running, otherwise the operation will fail.
7681	</note>
7682
7683	<note>
7684	If the machine state is <link to="MachineState_Saved">Saved</link>
7685	prior to this operation, the saved state file will be implicitly
7686	deleted (as if <link to="IConsole::discardSavedState"/> were
7687	called).
7688	</note>
7689
7690	<result name="VBOX_E_INVALID_VM_STATE">
7691	Virtual machine is running.
7692	</result>
7693	</desc>
7694	<param name="snapshot" type="ISnapshot" dir="in">
7695	<desc>The snapshot to restore the VM state from.</desc>
7696	</param>
7697	<param name="progress" type="IProgress" dir="return">
7698	<desc>Progress object to track the operation completion.</desc>
7699	</param>
7700	</method>
7701
7702	<method name="teleport">
7703	<desc>
7704	Teleport the VM to a different host machine or process.
7705
7706	TODO explain the details.
7707
7708	<result name="VBOX_E_INVALID_VM_STATE">
7709	Virtual machine not running or paused.
7710	</result>
7711	</desc>
7712	<param name="hostname" type="wstring" dir="in">
7713	<desc>The name or IP of the host to teleport to.</desc>
7714	</param>
7715	<param name="tcpport" type="unsigned long" dir="in">
7716	<desc>The TCP port to connect to (1..65535).</desc>
7717	</param>
7718	<param name="password" type="wstring" dir="in">
7719	<desc>The password.</desc>
7720	</param>
7721	<param name="maxDowntime" type="unsigned long" dir="in">
7722	<desc>
7723	The maximum allowed downtime given as milliseconds. 0 is not a valid
7724	value. Recommended value: 250 ms.
7725
7726	The higher the value is, the greater the chance for a successful
7727	teleportation. A small value may easily result in the teleportation
7728	process taking hours and eventually fail.
7729
7730	<note>
7731	The current implementation treats this a guideline, not as an
7732	absolute rule.
7733	</note>
7734	</desc>
7735	</param>
7736	<param name="progress" type="IProgress" dir="return">
7737	<desc>Progress object to track the operation completion.</desc>
7738	</param>
7739	</method>
7740
7741	</interface>
7742
7743	<!--
7744	// IHost
7745	/////////////////////////////////////////////////////////////////////////
7746	-->
7747
7748	<enum
7749	name="HostNetworkInterfaceMediumType"
7750	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7751	>
7752	<desc>
7753	Type of encapsulation. Ethernet encapsulation includes both wired and
7754	wireless Ethernet connections.
7755	<see><link to="IHostNetworkInterface"/></see>
7756	</desc>
7757
7758	<const name="Unknown" value="0">
7759	<desc>
7760	The type of interface cannot be determined.
7761	</desc>
7762	</const>
7763	<const name="Ethernet" value="1">
7764	<desc>
7765	Ethernet frame encapsulation.
7766	</desc>
7767	</const>
7768	<const name="PPP" value="2">
7769	<desc>
7770	Point-to-point protocol encapsulation.
7771	</desc>
7772	</const>
7773	<const name="SLIP" value="3">
7774	<desc>
7775	Serial line IP encapsulation.
7776	</desc>
7777	</const>
7778	</enum>
7779
7780	<enum
7781	name="HostNetworkInterfaceStatus"
7782	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7783	>
7784	<desc>
7785	Current status of the interface.
7786	<see><link to="IHostNetworkInterface"/></see>
7787	</desc>
7788
7789	<const name="Unknown" value="0">
7790	<desc>
7791	The state of interface cannot be determined.
7792	</desc>
7793	</const>
7794	<const name="Up" value="1">
7795	<desc>
7796	The interface is fully operational.
7797	</desc>
7798	</const>
7799	<const name="Down" value="2">
7800	<desc>
7801	The interface is not functioning.
7802	</desc>
7803	</const>
7804	</enum>
7805
7806	<enum
7807	name="HostNetworkInterfaceType"
7808	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7809	>
7810	<desc>
7811	Network interface type.
7812	</desc>
7813	<const name="Bridged" value="1"/>
7814	<const name="HostOnly" value="2"/>
7815	</enum>
7816
7817	<interface
7818	name="IHostNetworkInterface" extends="$unknown"
7819	uuid="87a4153d-6889-4dd6-9654-2e9ff0ae8dec"
7820	wsmap="managed"
7821	>
7822	<desc>
7823	Represents one of host's network interfaces. IP V6 address and network
7824	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7825	separated by colons.
7826	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7827	</desc>
7828	<attribute name="name" type="wstring" readonly="yes">
7829	<desc>Returns the host network interface name.</desc>
7830	</attribute>
7831
7832	<attribute name="id" type="uuid" mod="string" readonly="yes">
7833	<desc>Returns the interface UUID.</desc>
7834	</attribute>
7835
7836	<attribute name="networkName" type="wstring" readonly="yes">
7837	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7838	</attribute>
7839
7840	<attribute name="DHCPEnabled" type="boolean" readonly="yes">
7841	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7842	</attribute>
7843
7844	<attribute name="IPAddress" type="wstring" readonly="yes">
7845	<desc>Returns the IP V4 address of the interface.</desc>
7846	</attribute>
7847
7848	<attribute name="networkMask" type="wstring" readonly="yes">
7849	<desc>Returns the network mask of the interface.</desc>
7850	</attribute>
7851
7852	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7853	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7854	</attribute>
7855
7856	<attribute name="IPV6Address" type="wstring" readonly="yes">
7857	<desc>Returns the IP V6 address of the interface.</desc>
7858	</attribute>
7859
7860	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7861	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7862	</attribute>
7863
7864	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7865	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7866	</attribute>
7867
7868	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7869	<desc>Type of protocol encapsulation used.</desc>
7870	</attribute>
7871
7872	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7873	<desc>Status of the interface.</desc>
7874	</attribute>
7875
7876	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7877	<desc>specifies the host interface type.</desc>
7878	</attribute>
7879
7880	<method name="enableStaticIPConfig">
7881	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7882	<param name="IPAddress" type="wstring" dir="in">
7883	<desc>
7884	IP address.
7885	</desc>
7886	</param>
7887	<param name="networkMask" type="wstring" dir="in">
7888	<desc>
7889	network mask.
7890	</desc>
7891	</param>
7892	</method>
7893
7894	<method name="enableStaticIPConfigV6">
7895	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7896	<param name="IPV6Address" type="wstring" dir="in">
7897	<desc>
7898	IP address.
7899	</desc>
7900	</param>
7901	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7902	<desc>
7903	network mask.
7904	</desc>
7905	</param>
7906	</method>
7907
7908	<method name="enableDynamicIPConfig">
7909	<desc>enables the dynamic IP configuration.</desc>
7910	</method>
7911
7912	<method name="DHCPRediscover">
7913	<desc>refreshes the IP configuration for DHCP-enabled interface.</desc>
7914	</method>
7915
7916	</interface>
7917
7918	<interface
7919	name="IHost" extends="$unknown"
7920	uuid="30678943-32df-4830-b413-931b25ac86a0"
7921	wsmap="managed"
7922	>
7923	<desc>
7924	The IHost interface represents the physical machine that this VirtualBox
7925	installation runs on.
7926
7927	An object implementing this interface is returned by the
7928	<link to="IVirtualBox::host" /> attribute. This interface contains
7929	read-only information about the host's physical hardware (such as what
7930	processors and disks are available, what the host operating system is,
7931	and so on) and also allows for manipulating some of the host's hardware,
7932	such as global USB device filters and host interface networking.
7933
7934	</desc>
7935	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7936	<desc>List of DVD drives available on the host.</desc>
7937	</attribute>
7938
7939	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7940	<desc>List of floppy drives available on the host.</desc>
7941	</attribute>
7942
7943	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7944	<desc>
7945	List of USB devices currently attached to the host.
7946	Once a new device is physically attached to the host computer,
7947	it appears in this list and remains there until detached.
7948
7949	<note>
7950	If USB functionality is not available in the given edition of
7951	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7952	</note>
7953	</desc>
7954	</attribute>
7955
7956	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7957	<desc>
7958	List of USB device filters in action.
7959	When a new device is physically attached to the host computer,
7960	filters from this list are applied to it (in order they are stored
7961	in the list). The first matched filter will determine the
7962	<link to="IHostUSBDeviceFilter::action">action</link>
7963	performed on the device.
7964
7965	Unless the device is ignored by these filters, filters of all
7966	currently running virtual machines
7967	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7968
7969	<note>
7970	If USB functionality is not available in the given edition of
7971	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7972	</note>
7973
7974	<see><link to="IHostUSBDeviceFilter"/>,
7975	<link to="USBDeviceState"/></see>
7976	</desc>
7977	</attribute>
7978
7979	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7980	<desc>List of host network interfaces currently defined on the host.</desc>
7981	</attribute>
7982
7983	<attribute name="processorCount" type="unsigned long" readonly="yes">
7984	<desc>Number of (logical) CPUs installed in the host system.</desc>
7985	</attribute>
7986
7987	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7988	<desc>Number of (logical) CPUs online in the host system.</desc>
7989	</attribute>
7990
7991	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7992	<desc>Number of physical processor cores installed in the host system.</desc>
7993	</attribute>
7994
7995	<method name="getProcessorSpeed">
7996	<desc>Query the (approximate) maximum speed of a specified host CPU in
7997	Megahertz.
7998	</desc>
7999	<param name="cpuId" type="unsigned long" dir="in">
8000	<desc>
8001	Identifier of the CPU.
8002	</desc>
8003	</param>
8004	<param name="speed" type="unsigned long" dir="return">
8005	<desc>
8006	Speed value. 0 is returned if value is not known or @a cpuId is
8007	invalid.
8008	</desc>
8009	</param>
8010	</method>
8011
8012	<method name="getProcessorFeature">
8013	<desc>Query whether a CPU feature is supported or not.</desc>
8014	<param name="feature" type="ProcessorFeature" dir="in">
8015	<desc>
8016	CPU Feature identifier.
8017	</desc>
8018	</param>
8019	<param name="supported" type="boolean" dir="return">
8020	<desc>
8021	Feature is supported or not.
8022	</desc>
8023	</param>
8024	</method>
8025
8026	<method name="getProcessorDescription">
8027	<desc>Query the model string of a specified host CPU.
8028	</desc>
8029	<param name="cpuId" type="unsigned long" dir="in">
8030	<desc>
8031	Identifier of the CPU.
8032	<note>
8033	The current implementation might not necessarily return the
8034	description for this exact CPU.
8035	</note>
8036	</desc>
8037	</param>
8038	<param name="description" type="wstring" dir="return">
8039	<desc>
8040	Model string. An empty string is returned if value is not known or
8041	@a cpuId is invalid.
8042	</desc>
8043	</param>
8044	</method>
8045
8046	<method name="getProcessorCPUIDLeaf">
8047	<desc>
8048	Returns the CPU cpuid information for the specified leaf.
8049	</desc>
8050	<param name="cpuId" type="unsigned long" dir="in">
8051	<desc>
8052	Identifier of the CPU. The CPU most be online.
8053	<note>
8054	The current implementation might not necessarily return the
8055	description for this exact CPU.
8056	</note>
8057	</desc>
8058	</param>
8059	<param name="leaf" type="unsigned long" dir="in">
8060	<desc>
8061	CPUID leaf index (eax).
8062	</desc>
8063	</param>
8064	<param name="subLeaf" type="unsigned long" dir="in">
8065	<desc>
8066	CPUID leaf sub index (ecx). This currently only applies to cache
8067	information on Intel CPUs. Use 0 if retrieving values for
8068	<link to="IMachine::setCPUIDLeaf"/>.
8069	</desc>
8070	</param>
8071	<param name="valEax" type="unsigned long" dir="out">
8072	<desc>
8073	CPUID leaf value for register eax.
8074	</desc>
8075	</param>
8076	<param name="valEbx" type="unsigned long" dir="out">
8077	<desc>
8078	CPUID leaf value for register ebx.
8079	</desc>
8080	</param>
8081	<param name="valEcx" type="unsigned long" dir="out">
8082	<desc>
8083	CPUID leaf value for register ecx.
8084	</desc>
8085	</param>
8086	<param name="valEdx" type="unsigned long" dir="out">
8087	<desc>
8088	CPUID leaf value for register edx.
8089	</desc>
8090	</param>
8091	</method>
8092
8093	<attribute name="memorySize" type="unsigned long" readonly="yes">
8094	<desc>Amount of system memory in megabytes installed in the host system.</desc>
8095	</attribute>
8096
8097	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
8098	<desc>Available system memory in the host system.</desc>
8099	</attribute>
8100
8101	<attribute name="operatingSystem" type="wstring" readonly="yes">
8102	<desc>Name of the host system's operating system.</desc>
8103	</attribute>
8104
8105	<attribute name="OSVersion" type="wstring" readonly="yes">
8106	<desc>Host operating system's version string.</desc>
8107	</attribute>
8108
8109	<attribute name="UTCTime" type="long long" readonly="yes">
8110	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
8111	</attribute>
8112
8113	<attribute name="acceleration3DAvailable" type="boolean" readonly="yes">
8114	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
8115	</attribute>
8116
8117	<method name="createHostOnlyNetworkInterface">
8118	<desc>
8119	Creates a new adapter for Host Only Networking.
8120	<result name="E_INVALIDARG">
8121	Host network interface @a name already exists.
8122	</result>
8123	</desc>
8124	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
8125	<desc>
8126	Created host interface object.
8127	</desc>
8128	</param>
8129	<param name="progress" type="IProgress" dir="return">
8130	<desc>
8131	Progress object to track the operation completion.
8132	</desc>
8133	</param>
8134	</method>
8135
8136	<method name="removeHostOnlyNetworkInterface">
8137	<desc>
8138	Removes the given Host Only Networking interface.
8139	<result name="VBOX_E_OBJECT_NOT_FOUND">
8140	No host network interface matching @a id found.
8141	</result>
8142	</desc>
8143	<param name="id" type="uuid" mod="string" dir="in">
8144	<desc>
8145	Adapter GUID.
8146	</desc>
8147	</param>
8148	<param name="progress" type="IProgress" dir="return">
8149	<desc>
8150	Progress object to track the operation completion.
8151	</desc>
8152	</param>
8153	</method>
8154
8155	<method name="createUSBDeviceFilter">
8156	<desc>
8157	Creates a new USB device filter. All attributes except
8158	the filter name are set to empty (any match),
8159	<i>active</i> is @c false (the filter is not active).
8160
8161	The created filter can be added to the list of filters using
8162	<link to="#insertUSBDeviceFilter"/>.
8163
8164	<see><link to="#USBDeviceFilters"/></see>
8165	</desc>
8166	<param name="name" type="wstring" dir="in">
8167	<desc>
8168	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
8169	</desc>
8170	</param>
8171	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
8172	<desc>Created filter object.</desc>
8173	</param>
8174	</method>
8175
8176	<method name="insertUSBDeviceFilter">
8177	<desc>
8178	Inserts the given USB device to the specified position
8179	in the list of filters.
8180
8181	Positions are numbered starting from @c 0. If the specified
8182	position is equal to or greater than the number of elements in
8183	the list, the filter is added at the end of the collection.
8184
8185	<note>
8186	Duplicates are not allowed, so an attempt to insert a
8187	filter already in the list is an error.
8188	</note>
8189	<note>
8190	If USB functionality is not available in the given edition of
8191	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8192	</note>
8193
8194	<see><link to="#USBDeviceFilters"/></see>
8195
8196	<result name="VBOX_E_INVALID_OBJECT_STATE">
8197	USB device filter is not created within this VirtualBox instance.
8198	</result>
8199	<result name="E_INVALIDARG">
8200	USB device filter already in list.
8201	</result>
8202
8203	</desc>
8204	<param name="position" type="unsigned long" dir="in">
8205	<desc>Position to insert the filter to.</desc>
8206	</param>
8207	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
8208	<desc>USB device filter to insert.</desc>
8209	</param>
8210	</method>
8211
8212	<method name="removeUSBDeviceFilter">
8213	<desc>
8214	Removes a USB device filter from the specified position in the
8215	list of filters.
8216
8217	Positions are numbered starting from @c 0. Specifying a
8218	position equal to or greater than the number of elements in
8219	the list will produce an error.
8220
8221	<note>
8222	If USB functionality is not available in the given edition of
8223	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8224	</note>
8225
8226	<see><link to="#USBDeviceFilters"/></see>
8227
8228	<result name="E_INVALIDARG">
8229	USB device filter list empty or invalid @a position.
8230	</result>
8231
8232	</desc>
8233	<param name="position" type="unsigned long" dir="in">
8234	<desc>Position to remove the filter from.</desc>
8235	</param>
8236	</method>
8237
8238	<method name="findHostDVDDrive">
8239	<desc>
8240	Searches for a host DVD drive with the given @c name.
8241
8242	<result name="VBOX_E_OBJECT_NOT_FOUND">
8243	Given @c name does not correspond to any host drive.
8244	</result>
8245
8246	</desc>
8247	<param name="name" type="wstring" dir="in">
8248	<desc>Name of the host drive to search for</desc>
8249	</param>
8250	<param name="drive" type="IMedium" dir="return">
8251	<desc>Found host drive object</desc>
8252	</param>
8253	</method>
8254
8255	<method name="findHostFloppyDrive">
8256	<desc>
8257	Searches for a host floppy drive with the given @c name.
8258
8259	<result name="VBOX_E_OBJECT_NOT_FOUND">
8260	Given @c name does not correspond to any host floppy drive.
8261	</result>
8262
8263	</desc>
8264	<param name="name" type="wstring" dir="in">
8265	<desc>Name of the host floppy drive to search for</desc>
8266	</param>
8267	<param name="drive" type="IMedium" dir="return">
8268	<desc>Found host floppy drive object</desc>
8269	</param>
8270	</method>
8271
8272	<method name="findHostNetworkInterfaceByName">
8273	<desc>
8274	Searches through all host network interfaces for an interface with
8275	the given @c name.
8276	<note>
8277	The method returns an error if the given @c name does not
8278	correspond to any host network interface.
8279	</note>
8280	</desc>
8281	<param name="name" type="wstring" dir="in">
8282	<desc>Name of the host network interface to search for.</desc>
8283	</param>
8284	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8285	<desc>Found host network interface object.</desc>
8286	</param>
8287	</method>
8288	<method name="findHostNetworkInterfaceById">
8289	<desc>
8290	Searches through all host network interfaces for an interface with
8291	the given GUID.
8292	<note>
8293	The method returns an error if the given GUID does not
8294	correspond to any host network interface.
8295	</note>
8296	</desc>
8297	<param name="id" type="uuid" mod="string" dir="in">
8298	<desc>GUID of the host network interface to search for.</desc>
8299	</param>
8300	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8301	<desc>Found host network interface object.</desc>
8302	</param>
8303	</method>
8304	<method name="findHostNetworkInterfacesOfType">
8305	<desc>
8306	Searches through all host network interfaces and returns a list of interfaces of the specified type
8307	</desc>
8308	<param name="type" type="HostNetworkInterfaceType" dir="in">
8309	<desc>type of the host network interfaces to search for.</desc>
8310	</param>
8311	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
8312	<desc>Found host network interface objects.</desc>
8313	</param>
8314	</method>
8315
8316	<method name="findUSBDeviceById">
8317	<desc>
8318	Searches for a USB device with the given UUID.
8319
8320	<result name="VBOX_E_OBJECT_NOT_FOUND">
8321	Given @c id does not correspond to any USB device.
8322	</result>
8323
8324	<see><link to="IUSBDevice::id"/></see>
8325	</desc>
8326	<param name="id" type="uuid" mod="string" dir="in">
8327	<desc>UUID of the USB device to search for.</desc>
8328	</param>
8329	<param name="device" type="IHostUSBDevice" dir="return">
8330	<desc>Found USB device object.</desc>
8331	</param>
8332	</method>
8333
8334	<method name="findUSBDeviceByAddress">
8335	<desc>
8336	Searches for a USB device with the given host address.
8337
8338	<result name="VBOX_E_OBJECT_NOT_FOUND">
8339	Given @c name does not correspond to any USB device.
8340	</result>
8341
8342	<see><link to="IUSBDevice::address"/></see>
8343	</desc>
8344	<param name="name" type="wstring" dir="in">
8345	<desc>
8346	Address of the USB device (as assigned by the host) to
8347	search for.
8348	</desc>
8349	</param>
8350	<param name="device" type="IHostUSBDevice" dir="return">
8351	<desc>Found USB device object.</desc>
8352	</param>
8353	</method>
8354
8355	<method name="generateMACAddress">
8356	<desc>
8357	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
8358	</desc>
8359	<param name="address" type="wstring" dir="return">
8360	<desc>New Ethernet MAC address.</desc>
8361	</param>
8362	</method>
8363
8364	</interface>
8365
8366	<!--
8367	// ISystemProperties
8368	/////////////////////////////////////////////////////////////////////////
8369	-->
8370
8371	<interface
8372	name="ISystemProperties"
8373	extends="$unknown"
8374	uuid="413ea94c-efd9-491e-81fc-5df0c4d864bb"
8375	wsmap="managed"
8376	>
8377	<desc>
8378	The ISystemProperties interface represents global properties of the given
8379	VirtualBox installation.
8380
8381	These properties define limits and default values for various attributes
8382	and parameters. Most of the properties are read-only, but some can be
8383	changed by a user.
8384	</desc>
8385
8386	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
8387	<desc>Minimum guest system memory in Megabytes.</desc>
8388	</attribute>
8389
8390	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
8391	<desc>Maximum guest system memory in Megabytes.</desc>
8392	</attribute>
8393
8394	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
8395	<desc>Minimum guest video memory in Megabytes.</desc>
8396	</attribute>
8397
8398	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
8399	<desc>Maximum guest video memory in Megabytes.</desc>
8400	</attribute>
8401
8402	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
8403	<desc>Minimum CPU count.</desc>
8404	</attribute>
8405
8406	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
8407	<desc>Maximum CPU count.</desc>
8408	</attribute>
8409
8410	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
8411	<desc>Maximum of monitors which could be connected.</desc>
8412	</attribute>
8413
8414	<attribute name="infoVDSize" type="long long" readonly="yes">
8415	<desc>Maximum size of a virtual disk image in bytes. Informational value,
8416	does not reflect the limits of any virtual disk image format.</desc>
8417	</attribute>
8418
8419	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
8420	<desc>
8421	Maximum number of serial ports associated with every
8422	<link to="IMachine"/> instance.
8423	</desc>
8424	</attribute>
8425
8426	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
8427	<desc>
8428	Maximum number of parallel ports associated with every
8429	<link to="IMachine"/> instance.
8430	</desc>
8431	</attribute>
8432
8433	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
8434	<desc>
8435	Maximum device position in the boot order. This value corresponds
8436	to the total number of devices a machine can boot from, to make it
8437	possible to include all possible devices to the boot list.
8438	<see><link to="IMachine::setBootOrder"/></see>
8439	</desc>
8440	</attribute>
8441
8442	<attribute name="defaultMachineFolder" type="wstring">
8443	<desc>
8444	Full path to the default directory used to create new or open
8445	existing machines when a machine settings file name contains no
8446	path.
8447
8448	Starting with VirtualBox 4.0, by default, this attribute contains
8449	the full path of folder named "VirtualBox VMs" in the user's
8450	home directory, which depends on the host platform.
8451
8452	When setting this attribute, a full path must be specified.
8453	Setting this property to @c null or an empty string or the
8454	special value "Machines" (for compatibility reasons) will restore
8455	that default value.
8456
8457	If the folder specified herein does not exist, it will be created
8458	automatically as needed.
8459
8460	<see>
8461	<link to="IVirtualBox::createMachine"/>,
8462	<link to="IVirtualBox::openMachine"/>
8463	</see>
8464	</desc>
8465	</attribute>
8466
8467	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8468	<desc>
8469	List of all medium storage formats supported by this VirtualBox
8470	installation.
8471
8472	Keep in mind that the medium format identifier
8473	(<link to="IMediumFormat::id"/>) used in other API calls like
8474	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8475	medium format is a case-insensitive string. This means that, for
8476	example, all of the following strings:
8477	<pre>
8478	"VDI"
8479	"vdi"
8480	"VdI"</pre>
8481	refer to the same medium format.
8482
8483	Note that the virtual medium framework is backend-based, therefore
8484	the list of supported formats depends on what backends are currently
8485	installed.
8486
8487	<see><link to="IMediumFormat"/></see>
8488	</desc>
8489	</attribute>
8490
8491	<attribute name="defaultHardDiskFormat" type="wstring">
8492	<desc>
8493	Identifier of the default medium format used by VirtualBox.
8494
8495	The medium format set by this attribute is used by VirtualBox
8496	when the medium format was not specified explicitly. One example is
8497	<link to="IVirtualBox::createHardDisk"/> with the empty
8498	format argument. A more complex example is implicit creation of
8499	differencing media when taking a snapshot of a virtual machine:
8500	this operation will try to use a format of the parent medium first
8501	and if this format does not support differencing media the default
8502	format specified by this argument will be used.
8503
8504	The list of supported medium formats may be obtained by the
8505	<link to="#mediumFormats"/> call. Note that the default medium
8506	format must have a capability to create differencing media;
8507	otherwise operations that create media implicitly may fail
8508	unexpectedly.
8509
8510	The initial value of this property is <tt>"VDI"</tt> in the current
8511	version of the VirtualBox product, but may change in the future.
8512
8513	<note>
8514	Setting this property to @c null or empty string will restore the
8515	initial value.
8516	</note>
8517
8518	<see>
8519	<link to="#mediumFormats"/>,
8520	<link to="IMediumFormat::id"/>,
8521	<link to="IVirtualBox::createHardDisk"/>
8522	</see>
8523	</desc>
8524	</attribute>
8525
8526	<attribute name="freeDiskSpaceWarning" type="long long">
8527	<desc>Issue a warning if the free disk space is below (or in some disk
8528	intensive operation is expected to go below) the given size in
8529	bytes.</desc>
8530	</attribute>
8531
8532	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8533	<desc>Issue a warning if the free disk space is below (or in some disk
8534	intensive operation is expected to go below) the given percentage.</desc>
8535	</attribute>
8536
8537	<attribute name="freeDiskSpaceError" type="long long">
8538	<desc>Issue an error if the free disk space is below (or in some disk
8539	intensive operation is expected to go below) the given size in
8540	bytes.</desc>
8541	</attribute>
8542
8543	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8544	<desc>Issue an error if the free disk space is below (or in some disk
8545	intensive operation is expected to go below) the given percentage.</desc>
8546	</attribute>
8547
8548	<attribute name="VRDEAuthLibrary" type="wstring">
8549	<desc>
8550	Library that provides authentication for Remote Desktop clients. The library
8551	is used if a virtual machine's authentication type is set to "external"
8552	in the VM RemoteDisplay configuration.
8553
8554	The system library extension (".DLL" or ".so") must be omitted.
8555	A full path can be specified; if not, then the library must reside on the
8556	system's default library path.
8557
8558	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8559	of that name in one of the default VirtualBox library directories.
8560
8561	For details about VirtualBox authentication libraries and how to implement
8562	them, please refer to the VirtualBox manual.
8563
8564	<note>
8565	Setting this property to @c null or empty string will restore the
8566	initial value.
8567	</note>
8568	</desc>
8569	</attribute>
8570
8571	<attribute name="webServiceAuthLibrary" type="wstring">
8572	<desc>
8573	Library that provides authentication for webservice clients. The library
8574	is used if a virtual machine's authentication type is set to "external"
8575	in the VM RemoteDisplay configuration and will be called from
8576	within the <link to="IWebsessionManager::logon" /> implementation.
8577
8578	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8579	there is no per-VM setting for this, as the webservice is a global
8580	resource (if it is running). Only for this setting (for the webservice),
8581	setting this value to a literal <tt>"null"</tt> string disables authentication,
8582	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8583	no matter what user name and password are supplied.
8584
8585	The initial value of this property is <tt>"VBoxAuth"</tt>,
8586	meaning that the webservice will use the same authentication
8587	library that is used by default for VRDE (again, see
8588	<link to="ISystemProperties::VRDEAuthLibrary" />).
8589	The format and calling convention of authentication libraries
8590	is the same for the webservice as it is for VRDE.
8591
8592	<note>
8593	Setting this property to @c null or empty string will restore the
8594	initial value.
8595	</note>
8596	</desc>
8597	</attribute>
8598
8599	<attribute name="defaultVRDEExtPack" type="wstring">
8600	<desc>
8601	The name of the extension pack providing the default VRDE.
8602
8603	This attribute is for choosing between multiple extension packs
8604	providing VRDE. If only one is installed, it will automatically be the
8605	default one. The attribute value can be empty if no VRDE extension
8606	pack is installed.
8607
8608	For details about VirtualBox Remote Desktop Extension and how to
8609	implement one, please refer to the VirtualBox SDK.
8610	</desc>
8611	</attribute>
8612
8613	<attribute name="logHistoryCount" type="unsigned long">
8614	<desc>
8615	This value specifies how many old release log files are kept.
8616	</desc>
8617	</attribute>
8618
8619	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8620	<desc>This value hold the default audio driver for the current
8621	system.</desc>
8622	</attribute>
8623
8624	<attribute name="autostartDatabasePath" type="wstring">
8625	<desc>
8626	The path to the autostart database. Depending on the host this might
8627	be a filesystem path or something else.
8628	</desc>
8629	</attribute>
8630
8631	<attribute name="defaultAdditionsISO" type="wstring">
8632	<desc>
8633	The path to the default Guest Additions ISO image. Can be empty if
8634	the location is not known in this installation.
8635	</desc>
8636	</attribute>
8637
8638	<attribute name="defaultFrontend" type="wstring">
8639	<desc>
8640	Selects which VM frontend should be used by default when launching
8641	a VM through the <link to="IMachine::launchVMProcess" /> method.
8642	Empty or @c null strings do not define a particular default, it is up
8643	to <link to="IMachine::launchVMProcess" /> to select one. See the
8644	description of <link to="IMachine::launchVMProcess" /> for the valid
8645	frontend types.
8646
8647	This global setting is overridden by the per-VM attribute
8648	<link to="IMachine::defaultFrontend" /> or a frontend type
8649	passed to <link to="IMachine::launchVMProcess" />.
8650	</desc>
8651	</attribute>
8652
8653	<method name="getMaxNetworkAdapters">
8654	<desc>
8655	Maximum total number of network adapters associated with every
8656	<link to="IMachine"/> instance.
8657	</desc>
8658
8659	<param name="chipset" type="ChipsetType" dir="in">
8660	<desc>The chipset type to get the value for.</desc>
8661	</param>
8662
8663
8664	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8665	<desc>The maximum total number of network adapters allowed.</desc>
8666	</param>
8667
8668	</method>
8669
8670	<method name="getMaxNetworkAdaptersOfType">
8671	<desc>
8672	Maximum number of network adapters of a given attachment type,
8673	associated with every <link to="IMachine"/> instance.
8674	</desc>
8675
8676	<param name="chipset" type="ChipsetType" dir="in">
8677	<desc>The chipset type to get the value for.</desc>
8678	</param>
8679
8680	<param name="type" type="NetworkAttachmentType" dir="in">
8681	<desc>Type of attachment.</desc>
8682	</param>
8683
8684	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8685	<desc>The maximum number of network adapters allowed for
8686	particular chipset and attachment type.</desc>
8687	</param>
8688
8689	</method>
8690
8691
8692	<method name="getMaxDevicesPerPortForStorageBus">
8693	<desc>Returns the maximum number of devices which can be attached to a port
8694	for the given storage bus.</desc>
8695
8696	<param name="bus" type="StorageBus" dir="in">
8697	<desc>The storage bus type to get the value for.</desc>
8698	</param>
8699
8700	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8701	<desc>The maximum number of devices which can be attached to the port for the given
8702	storage bus.</desc>
8703	</param>
8704	</method>
8705
8706	<method name="getMinPortCountForStorageBus">
8707	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8708
8709	<param name="bus" type="StorageBus" dir="in">
8710	<desc>The storage bus type to get the value for.</desc>
8711	</param>
8712
8713	<param name="minPortCount" type="unsigned long" dir="return">
8714	<desc>The minimum number of ports for the given storage bus.</desc>
8715	</param>
8716	</method>
8717
8718	<method name="getMaxPortCountForStorageBus">
8719	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8720
8721	<param name="bus" type="StorageBus" dir="in">
8722	<desc>The storage bus type to get the value for.</desc>
8723	</param>
8724
8725	<param name="maxPortCount" type="unsigned long" dir="return">
8726	<desc>The maximum number of ports for the given storage bus.</desc>
8727	</param>
8728	</method>
8729
8730	<method name="getMaxInstancesOfStorageBus">
8731	<desc>Returns the maximum number of storage bus instances which
8732	can be configured for each VM. This corresponds to the number of
8733	storage controllers one can have. Value may depend on chipset type
8734	used.</desc>
8735
8736	<param name="chipset" type="ChipsetType" dir="in">
8737	<desc>The chipset type to get the value for.</desc>
8738	</param>
8739
8740	<param name="bus" type="StorageBus" dir="in">
8741	<desc>The storage bus type to get the value for.</desc>
8742	</param>
8743
8744	<param name="maxInstances" type="unsigned long" dir="return">
8745	<desc>The maximum number of instances for the given storage bus.</desc>
8746	</param>
8747	</method>
8748
8749	<method name="getDeviceTypesForStorageBus">
8750	<desc>Returns list of all the supported device types
8751	(<link to="DeviceType"/>) for the given type of storage
8752	bus.</desc>
8753
8754	<param name="bus" type="StorageBus" dir="in">
8755	<desc>The storage bus type to get the value for.</desc>
8756	</param>
8757
8758	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8759	<desc>The list of all supported device types for the given storage bus.</desc>
8760	</param>
8761	</method>
8762
8763	<method name="getDefaultIoCacheSettingForStorageController">
8764	<desc>Returns the default I/O cache setting for the
8765	given storage controller</desc>
8766
8767	<param name="controllerType" type="StorageControllerType" dir="in">
8768	<desc>The storage controller to the setting for.</desc>
8769	</param>
8770
8771	<param name="enabled" type="boolean" dir="return">
8772	<desc>Returned flag indicating the default value</desc>
8773	</param>
8774	</method>
8775	</interface>
8776
8777	<!--
8778	// IGuest
8779	/////////////////////////////////////////////////////////////////////////
8780	-->
8781
8782	<interface
8783	name="IGuestOSType" extends="$unknown"
8784	uuid="6d968f9a-858b-4c50-bf17-241f069e94c2"
8785	wsmap="struct"
8786	>
8787	<desc>
8788	</desc>
8789
8790	<attribute name="familyId" type="wstring" readonly="yes">
8791	<desc>Guest OS family identifier string.</desc>
8792	</attribute>
8793
8794	<attribute name="familyDescription" type="wstring" readonly="yes">
8795	<desc>Human readable description of the guest OS family.</desc>
8796	</attribute>
8797
8798	<attribute name="id" type="wstring" readonly="yes">
8799	<desc>Guest OS identifier string.</desc>
8800	</attribute>
8801
8802	<attribute name="description" type="wstring" readonly="yes">
8803	<desc>Human readable description of the guest OS.</desc>
8804	</attribute>
8805
8806	<attribute name="is64Bit" type="boolean" readonly="yes">
8807	<desc>Returns @c true if the given OS is 64-bit</desc>
8808	</attribute>
8809
8810	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8811	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8812	</attribute>
8813
8814	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8815	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8816	</attribute>
8817
8818	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8819	<desc>Recommended RAM size in Megabytes.</desc>
8820	</attribute>
8821
8822	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8823	<desc>Recommended video RAM size in Megabytes.</desc>
8824	</attribute>
8825
8826	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8827	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8828	</attribute>
8829
8830	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8831	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8832	</attribute>
8833
8834	<attribute name="recommendedHDD" type="long long" readonly="yes">
8835	<desc>Recommended hard disk size in bytes.</desc>
8836	</attribute>
8837
8838	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8839	<desc>Returns recommended network adapter for this OS type.</desc>
8840	</attribute>
8841
8842	<attribute name="recommendedPAE" type="boolean" readonly="yes">
8843	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8844	</attribute>
8845
8846	<attribute name="recommendedDVDStorageController" type="StorageControllerType" readonly="yes">
8847	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8848	</attribute>
8849
8850	<attribute name="recommendedDVDStorageBus" type="StorageBus" readonly="yes">
8851	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8852	</attribute>
8853
8854	<attribute name="recommendedHDStorageController" type="StorageControllerType" readonly="yes">
8855	<desc>Recommended storage controller type for HD drives.</desc>
8856	</attribute>
8857
8858	<attribute name="recommendedHDStorageBus" type="StorageBus" readonly="yes">
8859	<desc>Recommended storage bus type for HD drives.</desc>
8860	</attribute>
8861
8862	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8863	<desc>Recommended firmware type.</desc>
8864	</attribute>
8865
8866	<attribute name="recommendedUSBHID" type="boolean" readonly="yes">
8867	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8868	</attribute>
8869
8870	<attribute name="recommendedHPET" type="boolean" readonly="yes">
8871	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8872	</attribute>
8873
8874	<attribute name="recommendedUSBTablet" type="boolean" readonly="yes">
8875	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8876	</attribute>
8877
8878	<attribute name="recommendedRTCUseUTC" type="boolean" readonly="yes">
8879	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8880	</attribute>
8881
8882	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8883	<desc>Recommended chipset type.</desc>
8884	</attribute>
8885
8886	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8887	<desc>Recommended audio type.</desc>
8888	</attribute>
8889
8890	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8891	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8892	</attribute>
8893
8894	<attribute name="recommendedUSB" type="boolean" readonly="yes">
8895	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8896	</attribute>
8897
8898	</interface>
8899
8900	<enum
8901	name="AdditionsFacilityType"
8902	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8903	>
8904	<desc>
8905	Guest Additions facility IDs.
8906	</desc>
8907
8908	<const name="None" value="0">
8909	<desc>No/invalid facility.</desc>
8910	</const>
8911	<const name="VBoxGuestDriver" value="20">
8912	<desc>VirtualBox base driver (VBoxGuest).</desc>
8913	</const>
8914	<const name="AutoLogon" value="90">
8915	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8916	</const>
8917	<const name="VBoxService" value="100">
8918	<desc>VirtualBox system service (VBoxService).</desc>
8919	</const>
8920	<const name="VBoxTrayClient" value="101">
8921	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8922	</const>
8923	<const name="Seamless" value="1000">
8924	<desc>Seamless guest desktop integration.</desc>
8925	</const>
8926	<const name="Graphics" value="1100">
8927	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8928	are not immediately acted on and guest display resizes are probably not initiated by
8929	the guest additions.
8930	</desc>
8931	</const>
8932	<const name="All" value="2147483646">
8933	<desc>All facilities selected.</desc>
8934	</const>
8935	</enum>
8936
8937	<enum
8938	name="AdditionsFacilityClass"
8939	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8940	>
8941	<desc>
8942	Guest Additions facility classes.
8943	</desc>
8944
8945	<const name="None" value="0">
8946	<desc>No/invalid class.</desc>
8947	</const>
8948	<const name="Driver" value="10">
8949	<desc>Driver.</desc>
8950	</const>
8951	<const name="Service" value="30">
8952	<desc>System service.</desc>
8953	</const>
8954	<const name="Program" value="50">
8955	<desc>Program.</desc>
8956	</const>
8957	<const name="Feature" value="100">
8958	<desc>Feature.</desc>
8959	</const>
8960	<const name="ThirdParty" value="999">
8961	<desc>Third party.</desc>
8962	</const>
8963	<const name="All" value="2147483646">
8964	<desc>All facility classes selected.</desc>
8965	</const>
8966	</enum>
8967
8968	<enum
8969	name="AdditionsFacilityStatus"
8970	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8971	>
8972	<desc>
8973	Guest Additions facility states.
8974	</desc>
8975
8976	<const name="Inactive" value="0">
8977	<desc>Facility is not active.</desc>
8978	</const>
8979	<const name="Paused" value="1">
8980	<desc>Facility has been paused.</desc>
8981	</const>
8982	<const name="PreInit" value="20">
8983	<desc>Facility is preparing to initialize.</desc>
8984	</const>
8985	<const name="Init" value="30">
8986	<desc>Facility is initializing.</desc>
8987	</const>
8988	<const name="Active" value="50">
8989	<desc>Facility is up and running.</desc>
8990	</const>
8991	<const name="Terminating" value="100">
8992	<desc>Facility is shutting down.</desc>
8993	</const>
8994	<const name="Terminated" value="101">
8995	<desc>Facility successfully shut down.</desc>
8996	</const>
8997	<const name="Failed" value="800">
8998	<desc>Facility failed to start.</desc>
8999	</const>
9000	<const name="Unknown" value="999">
9001	<desc>Facility status is unknown.</desc>
9002	</const>
9003	</enum>
9004
9005	<interface
9006	name="IAdditionsFacility" extends="$unknown"
9007	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
9008	wsmap="struct"
9009	>
9010	<desc>
9011	Structure representing a Guest Additions facility.
9012	</desc>
9013
9014	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
9015	<desc>The class this facility is part of.</desc>
9016	</attribute>
9017
9018	<attribute name="lastUpdated" type="long long" readonly="yes">
9019	<desc>
9020	Time stamp of the last status update,
9021	in milliseconds since 1970-01-01 UTC.
9022	</desc>
9023	</attribute>
9024
9025	<attribute name="name" type="wstring" readonly="yes">
9026	<desc>The facility's friendly name.</desc>
9027	</attribute>
9028
9029	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
9030	<desc>The current status.</desc>
9031	</attribute>
9032
9033	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
9034	<desc>The facility's type ID.</desc>
9035	</attribute>
9036	</interface>
9037
9038	<enum
9039	name="AdditionsRunLevelType"
9040	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
9041	>
9042	<desc>
9043	Guest Additions run level type.
9044	</desc>
9045
9046	<const name="None" value="0">
9047	<desc>Guest Additions are not loaded.</desc>
9048	</const>
9049	<const name="System" value="1">
9050	<desc>Guest drivers are loaded.</desc>
9051	</const>
9052	<const name="Userland" value="2">
9053	<desc>Common components (such as application services) are loaded.</desc>
9054	</const>
9055	<const name="Desktop" value="3">
9056	<desc>Per-user desktop components are loaded.</desc>
9057	</const>
9058	</enum>
9059
9060	<enum
9061	name="AdditionsUpdateFlag"
9062	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
9063	>
9064	<desc>
9065	Guest Additions update flags.
9066	</desc>
9067
9068	<const name="None" value="0">
9069	<desc>No flag set.</desc>
9070	</const>
9071	<const name="WaitForUpdateStartOnly" value="1">
9072	<desc>Starts the regular updating process and waits until the
9073	actual Guest Additions update inside the guest was started.
9074	This can be necessary due to needed interaction with the guest
9075	OS during the installation phase.</desc>
9076	</const>
9077	</enum>
9078
9079	<enum
9080	name="GuestSessionStatus"
9081	uuid="ac2669da-4624-44f2-85b5-0b0bfb8d8673"
9082	>
9083	<desc>
9084	Guest session status. This enumeration represents possible values of
9085	the <link to="IGuestSession::status"/> attribute.
9086	</desc>
9087	<const name="Undefined" value="0">
9088	<desc>Guest session is in an undefined state.</desc>
9089	</const>
9090	<const name="Starting" value="10">
9091	<desc>Guest session is being started.</desc>
9092	</const>
9093	<const name="Started" value="100">
9094	<desc>Guest session has been started.</desc>
9095	</const>
9096	<const name="Terminating" value="480">
9097	<desc>Guest session is being terminated.</desc>
9098	</const>
9099	<const name="Terminated" value="500">
9100	<desc>Guest session terminated normally.</desc>
9101	</const>
9102	<const name="TimedOutKilled" value="512">
9103	<desc>Guest session timed out and was killed.</desc>
9104	</const>
9105	<const name="TimedOutAbnormally" value="513">
9106	<desc>Guest session timed out and was not killed successfully.</desc>
9107	</const>
9108	<const name="Down" value="600">
9109	<desc>Service/OS is stopping, guest session was killed.</desc>
9110	</const>
9111	<const name="Error" value="800">
9112	<desc>Something went wrong.</desc>
9113	</const>
9114	</enum>
9115
9116	<enum
9117	name="GuestSessionWaitForFlag"
9118	uuid="bb7a372a-f635-4e11-a81a-e707f3a52ef5"
9119	>
9120	<desc>
9121	Guest session waiting flags. Multiple flags can be combined.
9122	</desc>
9123
9124	<const name="None" value="0">
9125	<desc>No waiting flags specified. Do not use this.</desc>
9126	</const>
9127	<const name="Start" value="1">
9128	<desc>Wait for the guest session being started.</desc>
9129	</const>
9130	<const name="Terminate" value="2">
9131	<desc>Wait for the guest session being terminated.</desc>
9132	</const>
9133	<const name="Status" value="4">
9134	<desc>Wait for the next guest session status change.</desc>
9135	</const>
9136	</enum>
9137
9138	<enum
9139	name="GuestSessionWaitResult"
9140	uuid="c0f6a8a5-fdb6-42bf-a582-56c6f82bcd2d"
9141	>
9142	<desc>
9143	Guest session waiting results. Depending on the session waiting flags (for
9144	more information see <link to="GuestSessionWaitForFlag"/>) the waiting result
9145	can vary based on the session's current status.
9146
9147	To wait for a guest session to terminate after it has been
9148	created by <link to="IGuest::createSession"/> one would specify
9149	GuestSessionWaitResult_Terminate.
9150	</desc>
9151
9152	<const name="None" value="0">
9153	<desc>No result was returned. Not being used.</desc>
9154	</const>
9155	<const name="Start" value="1">
9156	<desc>The guest session has been started.</desc>
9157	</const>
9158	<const name="Terminate" value="2">
9159	<desc>The guest session has been terminated.</desc>
9160	</const>
9161	<const name="Status" value="3">
9162	<desc>
9163	The guest session has changed its status. The status then can
9164	be retrieved via <link to="IGuestSession::status"/>.
9165	</desc>
9166	</const>
9167	<const name="Error" value="4">
9168	<desc>Error while executing the process.</desc>
9169	</const>
9170	<const name="Timeout" value="5">
9171	<desc>
9172	The waiting operation timed out. This also will happen
9173	when no event has been occured matching the
9174	current waiting flags in a <link to="IGuestSession::waitFor"/> call.
9175	</desc>
9176	</const>
9177	<const name="WaitFlagNotSupported" value="6">
9178	<desc>
9179	A waiting flag specified in the <link to="IGuestSession::waitFor"/> call
9180	is not supported by the guest.
9181	</desc>
9182	</const>
9183	</enum>
9184
9185	<enum
9186	name="FileSeekType"
9187	uuid="1b73f4f3-3515-4073-a506-76878d9e2541"
9188	>
9189	<desc>
9190	File seeking types.
9191	</desc>
9192
9193	<const name="Set" value="0">
9194	<desc>Seek from the start of the file.</desc>
9195	</const>
9196	<const name="Current" value="1">
9197	<desc>Seek from the current file position.</desc>
9198	</const>
9199	</enum>
9200
9201	<enum
9202	name="ProcessInputFlag"
9203	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
9204	>
9205	<desc>
9206	Guest process input flags.
9207	</desc>
9208	<const name="None" value="0">
9209	<desc>No flag set.</desc>
9210	</const>
9211	<const name="EndOfFile" value="1">
9212	<desc>End of file (input) reached.</desc>
9213	</const>
9214	</enum>
9215
9216	<enum
9217	name="ProcessOutputFlag"
9218	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
9219	>
9220	<desc>
9221	Guest process output flags for specifying which
9222	type of output to retrieve.
9223	</desc>
9224	<const name="None" value="0">
9225	<desc>No flags set. Get output from stdout.</desc>
9226	</const>
9227	<const name="StdErr" value="1">
9228	<desc>Get output from stderr.</desc>
9229	</const>
9230	</enum>
9231
9232	<enum
9233	name="ProcessWaitForFlag"
9234	uuid="23b550c7-78e1-437e-98f0-65fd9757bcd2"
9235	>
9236	<desc>
9237	Process waiting flags. Multiple flags can be combined.
9238	</desc>
9239
9240	<const name="None" value="0">
9241	<desc>No waiting flags specified. Do not use this.</desc>
9242	</const>
9243	<const name="Start" value="1">
9244	<desc>Wait for the process being started.</desc>
9245	</const>
9246	<const name="Terminate" value="2">
9247	<desc>Wait for the process being terminated.</desc>
9248	</const>
9249	<const name="StdIn" value="4">
9250	<desc>Wait for stdin becoming available.</desc>
9251	</const>
9252	<const name="StdOut" value="8">
9253	<desc>Wait for data becoming available on stdout.</desc>
9254	</const>
9255	<const name="StdErr" value="16">
9256	<desc>Wait for data becoming available on stderr.</desc>
9257	</const>
9258	</enum>
9259
9260	<enum
9261	name="ProcessWaitResult"
9262	uuid="40719cbe-f192-4fe9-a231-6697b3c8e2b4"
9263	>
9264	<desc>
9265	Process waiting results. Depending on the process waiting flags (for
9266	more information see <link to="ProcessWaitForFlag"/>) the waiting result
9267	can vary based on the processes' current status.
9268
9269	To wait for a guest process to terminate after it has been
9270	created by <link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>
9271	one would specify ProcessWaitResult_Terminate.
9272
9273	If a guest process has been started with ProcessCreateFlag_WaitForStdOut
9274	a client can wait with ProcessWaitResult_StdOut for new data to arrive on
9275	stdout; same applies for ProcessCreateFlag_WaitForStdErr and
9276	ProcessWaitResult_StdErr.
9277	</desc>
9278
9279	<const name="None" value="0">
9280	<desc>No result was returned. Not being used.</desc>
9281	</const>
9282	<const name="Start" value="1">
9283	<desc>The process has been started.</desc>
9284	</const>
9285	<const name="Terminate" value="2">
9286	<desc>The process has been terminated.</desc>
9287	</const>
9288	<const name="Status" value="3">
9289	<desc>
9290	The process has changed its status. The status then can
9291	be retrieved via <link to="IProcess::status"/>.
9292	</desc>
9293	</const>
9294	<const name="Error" value="4">
9295	<desc>Error while executing the process.</desc>
9296	</const>
9297	<const name="Timeout" value="5">
9298	<desc>
9299	The waiting operation timed out. This also will happen
9300	when no event has been occured matching the
9301	current waiting flags in a <link to="IProcess::waitFor"/> call.
9302	</desc>
9303	</const>
9304	<const name="StdIn" value="6">
9305	<desc>
9306	The process signalled that stdin became available for writing
9307	and that the process awaits input now.</desc>
9308	</const>
9309	<const name="StdOut" value="7">
9310	<desc>Data on stdout became available for reading.</desc>
9311	</const>
9312	<const name="StdErr" value="8">
9313	<desc>Data on stderr became available for reading.</desc>
9314	</const>
9315	<const name="WaitFlagNotSupported" value="9">
9316	<desc>
9317	A waiting flag specified in the <link to="IProcess::waitFor"/> call
9318	is not supported by the guest.
9319	</desc>
9320	</const>
9321	</enum>
9322
9323	<enum
9324	name="CopyFileFlag"
9325	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
9326	>
9327	<desc>
9328	File copying flags.
9329	</desc>
9330	<const name="None" value="0">
9331	<desc>No flag set.</desc>
9332	</const>
9333	<const name="Recursive" value="1">
9334	<desc>Copy directories recursively.</desc>
9335	</const>
9336	<const name="Update" value="2">
9337	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
9338	</const>
9339	<const name="FollowLinks" value="4">
9340	<desc>Follow symbolic links.</desc>
9341	</const>
9342	</enum>
9343
9344	<enum
9345	name="DirectoryCreateFlag"
9346	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
9347	>
9348	<desc>
9349	Directory creation flags.
9350	</desc>
9351	<const name="None" value="0">
9352	<desc>No flag set.</desc>
9353	</const>
9354	<const name="Parents" value="1">
9355	<desc>No error if existing, make parent directories as needed.</desc>
9356	</const>
9357	</enum>
9358
9359	<enum
9360	name="DirectoryRemoveRecFlag"
9361	uuid="455aabf0-7692-48f6-9061-f21579b65769"
9362	>
9363	<desc>
9364	Directory recursive removement flags.
9365	</desc>
9366
9367	<const name="None" value="0">
9368	<desc>No flag set.</desc>
9369	</const>
9370	<const name="ContentAndDir" value="1">
9371	<desc>Delete the content of the directory and the directory itself.</desc>
9372	</const>
9373	<const name="ContentOnly" value="2">
9374	<desc>Only delete the content of the directory, omit the directory it self.</desc>
9375	</const>
9376	</enum>
9377
9378	<enum
9379	name="PathRenameFlag"
9380	uuid="f3baa09f-c758-453d-b91c-c7787d76351d"
9381	>
9382	<desc>
9383	Path renaming flags.
9384	</desc>
9385
9386	<const name="None" value="0">
9387	<desc>No flag set.</desc>
9388	</const>
9389	<const name="NoReplace" value="1">
9390	<desc>Do not replace anything.</desc>
9391	</const>
9392	<const name="Replace" value="2">
9393	<desc>This will replace attempt any target which isn't a directory.</desc>
9394	</const>
9395	<const name="NoSymlinks" value="4">
9396	<desc>Don't allow symbolic links as part of the path.</desc>
9397	</const>
9398	</enum>
9399
9400	<enum
9401	name="ProcessCreateFlag"
9402	uuid="35192799-bfde-405d-9bea-c735ab9998e4"
9403	>
9404	<desc>
9405	Guest process execution flags.
9406	</desc>
9407
9408	<const name="None" value="0">
9409	<desc>No flag set.</desc>
9410	</const>
9411	<const name="WaitForProcessStartOnly" value="1">
9412	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
9413	process itself then uses an infinite timeout.</desc>
9414	</const>
9415	<const name="IgnoreOrphanedProcesses" value="2">
9416	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
9417	</const>
9418	<const name="Hidden" value="4">
9419	<desc>Do not show the started process according to the guest OS guidelines.</desc>
9420	</const>
9421	<const name="NoProfile" value="8">
9422	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
9423	</const>
9424	<const name="WaitForStdOut" value="16">
9425	<desc>The guest process waits until all data from stdout is read out.</desc>
9426	</const>
9427	<const name="WaitForStdErr" value="32">
9428	<desc>The guest process waits until all data from stderr is read out.</desc>
9429	</const>
9430	<const name="ExpandArguments" value="64">
9431	<desc>Expands environment variables in process arguments.</desc>
9432	</const>
9433	</enum>
9434
9435	<enum
9436	name="ProcessPriority"
9437	uuid="ee8cac50-e232-49fe-806b-d1214d9c2e49"
9438	>
9439	<desc>
9440	Process priorities.
9441	</desc>
9442
9443	<const name="Invalid" value="0">
9444	<desc>Invalid priority, do not use.</desc>
9445	</const>
9446	<const name="Default" value="1">
9447	<desc>Default process priority determined by the OS.</desc>
9448	</const>
9449	</enum>
9450
9451	<enum
9452	name="SymlinkType"
9453	uuid="37794668-f8f1-4714-98a5-6f8fa2ed0118"
9454	>
9455	<desc>
9456	Symbolic link types.
9457	</desc>
9458
9459	<const name="Unknown" value="0">
9460	<desc>It is not known what is being targeted.</desc>
9461	</const>
9462	<const name="Directory" value="1">
9463	<desc>The link targets a directory.</desc>
9464	</const>
9465	<const name="File" value="2">
9466	<desc>The link targets a file (or whatever else).</desc>
9467	</const>
9468	</enum>
9469
9470	<enum
9471	name="SymlinkReadFlag"
9472	uuid="b7fe2b9d-790e-4b25-8adf-1ca33026931f"
9473	>
9474	<desc>
9475	Symbolic link reading flags.
9476	</desc>
9477
9478	<const name="None" value="0">
9479	<desc>No flags set.</desc>
9480	</const>
9481	<const name="NoSymlinks" value="1">
9482	<desc>Don't allow symbolic links as part of the path.</desc>
9483	</const>
9484	</enum>
9485
9486	<enum
9487	name="ProcessStatus"
9488	uuid="4d52368f-5b48-4bfe-b486-acf89139b52f"
9489	>
9490	<desc>
9491	Process execution statuses.
9492	</desc>
9493	<const name="Undefined" value="0">
9494	<desc>Process is in an undefined state.</desc>
9495	</const>
9496	<const name="Starting" value="10">
9497	<desc>Process is being started.</desc>
9498	</const>
9499	<const name="Started" value="100">
9500	<desc>Process has been started.</desc>
9501	</const>
9502	<const name="Paused" value="110">
9503	<desc>Process has been paused.</desc>
9504	</const>
9505	<const name="Terminating" value="480">
9506	<desc>Process is being terminated.</desc>
9507	</const>
9508	<const name="TerminatedNormally" value="500">
9509	<desc>Process terminated normally.</desc>
9510	</const>
9511	<const name="TerminatedSignal" value="510">
9512	<desc>Process terminated via signal.</desc>
9513	</const>
9514	<const name="TerminatedAbnormally" value="511">
9515	<desc>Process terminated abnormally.</desc>
9516	</const>
9517	<const name="TimedOutKilled" value="512">
9518	<desc>Process timed out and was killed.</desc>
9519	</const>
9520	<const name="TimedOutAbnormally" value="513">
9521	<desc>Process timed out and was not killed successfully.</desc>
9522	</const>
9523	<const name="Down" value="600">
9524	<desc>Service/OS is stopping, process was killed.</desc>
9525	</const>
9526	<const name="Error" value="800">
9527	<desc>Something went wrong.</desc>
9528	</const>
9529	</enum>
9530
9531	<enum
9532	name="FsObjType"
9533	uuid="a1ed437c-b3c3-4ca2-b19c-4239d658d5e8"
9534	>
9535	<desc>
9536	File system object type.
9537	</desc>
9538
9539	<const name="Undefined" value="0">
9540	<desc>Type is undefined / unknown.</desc>
9541	</const>
9542	<const name="FIFO" value="1">
9543	<desc>Named pipe.</desc>
9544	</const>
9545	<const name="DevChar" value="10">
9546	<desc>Character device.</desc>
9547	</const>
9548	<const name="DevBlock" value="11">
9549	<desc>Block device.</desc>
9550	</const>
9551	<const name="Directory" value="50">
9552	<desc>Directory.</desc>
9553	</const>
9554	<const name="File" value="80">
9555	<desc>File.</desc>
9556	</const>
9557	<const name="Symlink" value="100">
9558	<desc>Symlink.</desc>
9559	</const>
9560	<const name="Socket" value="200">
9561	<desc>Socket.</desc>
9562	</const>
9563	<const name="Whiteout" value="400">
9564	<desc>Whiteout.</desc>
9565	</const>
9566	</enum>
9567
9568	<enum
9569	name="DragAndDropAction"
9570	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
9571	>
9572	<desc>
9573	Possible actions within an Drag and Drop operation.
9574	</desc>
9575
9576	<const name="Ignore" value="0">
9577	<desc>Do nothing.</desc>
9578	</const>
9579
9580	<const name="Copy" value="1">
9581	<desc>Copy the item to the target.</desc>
9582	</const>
9583
9584	<const name="Move" value="2">
9585	<desc>Move the item to the target.</desc>
9586	</const>
9587
9588	<const name="Link" value="3">
9589	<desc>Link the item from within the target.</desc>
9590	</const>
9591	</enum>
9592
9593	<enum
9594	name="DirectoryOpenFlag"
9595	uuid="5138837a-8fd2-4194-a1b0-08f7bc3949d0"
9596	>
9597	<desc>
9598	Directory open flags.
9599	</desc>
9600	<const name="None" value="0">
9601	<desc>No flag set.</desc>
9602	</const>
9603	<const name="NoSymlinks" value="1">
9604	<desc>Don't allow symbolic links as part of the path.</desc>
9605	</const>
9606	</enum>
9607
9608	<interface
9609	name="IGuestSession" extends="$unknown"
9610	uuid="56f551a2-f924-43ab-8a69-a954109db878"
9611	wsmap="managed"
9612	>
9613	<desc>
9614	A guest session represents one impersonated user account on the guest, so
9615	every operation will use the same credentials specified when creating
9616	the session object via <link to="IGuest::createSession"/>.
9617
9618	There can be a maximum of 32 sessions at once per VM. Each session keeps
9619	track of its started guest processes, opened guest files or guest directories.
9620	To work on guest files or directories a guest session offers methods to open
9621	or create such objects (see <link to="IGuestSession::fileOpen"/> or
9622	<link to="IGuestSession::directoryOpen"/> for example).
9623
9624	When done with either of these objects, including the guest session itself,
9625	use the appropriate close() method to let the object do its cleanup work.
9626
9627	Every guest session has its own environment variable block which gets
9628	automatically applied when starting a new guest process via
9629	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
9630	To override (or unset) certain environment variables already set by the
9631	guest session, one can specify a per-process environment block when using
9632	one of the both above mentioned process creation calls.
9633	</desc>
9634
9635	<attribute name="user" type="wstring" readonly="yes">
9636	<desc>Returns the user name used by this session to impersonate
9637	users on the guest.
9638	</desc>
9639	</attribute>
9640
9641	<attribute name="domain" type="wstring" readonly="yes">
9642	<desc>Returns the domain name used by this session to impersonate
9643	users on the guest.
9644	</desc>
9645	</attribute>
9646
9647	<attribute name="name" type="wstring" readonly="yes">
9648	<desc>Returns the session's friendly name.</desc>
9649	</attribute>
9650
9651	<attribute name="id" type="unsigned long" readonly="yes">
9652	<desc>Returns the internal session ID.</desc>
9653	</attribute>
9654
9655	<attribute name="timeout" type="unsigned long">
9656	<desc>
9657	Returns the session timeout (in ms).
9658	<result name="E_NOTIMPL">
9659	The method is not implemented yet.
9660	</result>
9661	</desc>
9662	</attribute>
9663
9664	<attribute name="status" type="GuestSessionStatus" readonly="yes">
9665	<desc>Returns the current session status.</desc>
9666	</attribute>
9667
9668	<attribute name="environment" type="wstring" safearray="yes">
9669	<desc>
9670	Returns the current session environment.
9671	</desc>
9672	</attribute>
9673
9674	<attribute name="processes" type="IGuestProcess" readonly="yes" safearray="yes">
9675	<desc>
9676	Returns all current guest processes.
9677	</desc>
9678	</attribute>
9679
9680	<attribute name="directories" type="IGuestDirectory" readonly="yes" safearray="yes">
9681	<desc>
9682	Returns all currently opened guest directories.
9683	</desc>
9684	</attribute>
9685
9686	<attribute name="files" type="IGuestFile" readonly="yes" safearray="yes">
9687	<desc>
9688	Returns all currently opened guest files.
9689	</desc>
9690	</attribute>
9691
9692	<method name="close">
9693	<desc>
9694	Closes this session. All opened guest directories, files and
9695	processes which are not referenced by clients anymore will be
9696	uninitialized.
9697	</desc>
9698	</method>
9699
9700	<method name="copyFrom">
9701	<desc>
9702	Copies a file from guest to the host.
9703
9704	<result name="VBOX_E_IPRT_ERROR">
9705	Error starting the copy operation.
9706	</result>
9707	</desc>
9708	<param name="source" type="wstring" dir="in">
9709	<desc>Source file on the guest to copy to the host.</desc>
9710	</param>
9711	<param name="dest" type="wstring" dir="in">
9712	<desc>Destination file name on the host.</desc>
9713	</param>
9714	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9715	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9716	</param>
9717	<param name="progress" type="IProgress" dir="return">
9718	<desc>Progress object to track the operation completion.</desc>
9719	</param>
9720	</method>
9721
9722	<method name="copyTo">
9723	<desc>
9724	Copies a file from host to the guest.
9725
9726	<result name="VBOX_E_IPRT_ERROR">
9727	Error starting the copy operation.
9728	</result>
9729	</desc>
9730	<param name="source" type="wstring" dir="in">
9731	<desc>Source file on the host to copy to the guest.</desc>
9732	</param>
9733	<param name="dest" type="wstring" dir="in">
9734	<desc>Destination file name on the guest.</desc>
9735	</param>
9736	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9737	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9738	</param>
9739	<param name="progress" type="IProgress" dir="return">
9740	<desc>Progress object to track the operation completion.</desc>
9741	</param>
9742	</method>
9743
9744	<method name="directoryCreate">
9745	<desc>
9746	Create a directory on the guest.
9747
9748	<result name="VBOX_E_IPRT_ERROR">
9749	Error while creating the directory.
9750	</result>
9751	</desc>
9752	<param name="path" type="wstring" dir="in">
9753	<desc>Full path of directory to create.</desc>
9754	</param>
9755	<param name="mode" type="unsigned long" dir="in">
9756	<desc>File creation mode.</desc>
9757	</param>
9758	<param name="flags" type="DirectoryCreateFlag" dir="in" safearray="yes">
9759	<desc>Creation flags; see <link to="DirectoryCreateFlag"/> for more information.</desc>
9760	</param>
9761	</method>
9762
9763	<method name="directoryCreateTemp">
9764	<desc>
9765	Create a temporary directory on the guest.
9766
9767	<result name="VBOX_E_NOT_SUPPORTED">
9768	The operation is not possible as requested on this particular
9769	guest type.
9770	</result>
9771	<result name="E_INVALIDARG">
9772	Invalid argument. This includes an incorrectly formatted template,
9773	or a non-absolute path.
9774	</result>
9775	<result name="VBOX_E_IPRT_ERROR">
9776	The temporary directory could not be created. Possible reasons
9777	include a non-existing path or an insecure path when the secure
9778	option was requested.
9779	</result>
9780	</desc>
9781	<param name="templateName" type="wstring" dir="in">
9782	<desc>Template for the name of the directory to create. This must
9783	contain at least one 'X' character. The first group of consecutive
9784	'X' characters in the template will be replaced by a random
9785	alphanumeric string to produce a unique name.</desc>
9786	</param>
9787	<param name="mode" type="unsigned long" dir="in">
9788	<desc>The mode of the directory to create. Use 0700 unless there are
9789	reasons not to. This parameter is ignored if "secure" is specified.
9790	</desc>
9791	</param>
9792	<param name="path" type="wstring" dir="in">
9793	<desc>The absolute path to create the temporary directory in.</desc>
9794	</param>
9795	<param name="secure" type="boolean" dir="in">
9796	<desc>Whether to fail if the directory can not be securely created.
9797	Currently this means that another unprivileged user cannot
9798	manipulate the path specified or remove the temporary directory
9799	after it has been created. Also causes the mode specified to be
9800	ignored. May not be supported on all guest types.</desc>
9801	</param>
9802	<param name="directory" type="wstring" dir="return">
9803	<desc>On success this will contain the name of the directory created
9804	with full path.</desc>
9805	</param>
9806	</method>
9807
9808	<method name="directoryExists">
9809	<desc>
9810	Checks whether a directory exists on the guest or not.
9811
9812	<result name="VBOX_E_IPRT_ERROR">
9813	Error while checking existence of the directory specified.
9814	</result>
9815	</desc>
9816	<param name="path" type="wstring" dir="in">
9817	<desc>Directory to check existence for.</desc>
9818	</param>
9819	<param name="exists" type="boolean" dir="return">
9820	<desc>Returns @c true if the directory exists, @c false if not.</desc>
9821	</param>
9822	</method>
9823
9824	<method name="directoryOpen">
9825	<desc>
9826	Opens a directory and creates a <link to="IGuestDirectory"/> object that
9827	can be used for further operations.
9828
9829	<result name="VBOX_E_OBJECT_NOT_FOUND">
9830	Directory to open was not found.
9831	</result>
9832	<result name="VBOX_E_IPRT_ERROR">
9833	Error while opening the directory.
9834	</result>
9835	</desc>
9836	<param name="path" type="wstring" dir="in">
9837	<desc>Full path to file to open.</desc>
9838	</param>
9839	<param name="filter" type="wstring" dir="in">
9840	<desc>Open filter to apply. This can include wildcards like ? and *.</desc>
9841	</param>
9842	<param name="flags" type="DirectoryOpenFlag" dir="in" safearray="yes">
9843	<desc>Open flags; see <link to="DirectoryOpenFlag"/> for more information.</desc>
9844	</param>
9845	<param name="directory" type="IGuestDirectory" dir="return">
9846	<desc><link to="IGuestDirectory"/> object containing the opened directory.</desc>
9847	</param>
9848	</method>
9849
9850	<method name="directoryQueryInfo">
9851	<desc>
9852	Queries information of a directory on the guest.
9853
9854	<result name="VBOX_E_OBJECT_NOT_FOUND">
9855	Directory to query information for was not found.
9856	</result>
9857	<result name="VBOX_E_IPRT_ERROR">
9858	Error querying information.
9859	</result>
9860	</desc>
9861	<param name="path" type="wstring" dir="in">
9862	<desc>Directory to query information for.</desc>
9863	</param>
9864	<param name="info" type="IGuestFsObjInfo" dir="return">
9865	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
9866	</param>
9867	</method>
9868
9869	<method name="directoryRemove">
9870	<desc>
9871	Removes a guest directory if not empty.
9872
9873	<result name="E_NOTIMPL">
9874	The method is not implemented yet.
9875	</result>
9876	</desc>
9877	<param name="path" type="wstring" dir="in">
9878	<desc>Full path of directory to remove.</desc>
9879	</param>
9880	</method>
9881
9882	<method name="directoryRemoveRecursive">
9883	<desc>
9884	Removes a guest directory recursively.
9885
9886	<result name="E_NOTIMPL">
9887	The method is not implemented yet.
9888	</result>
9889	</desc>
9890	<param name="path" type="wstring" dir="in">
9891	<desc>Full path of directory to remove recursively.</desc>
9892	</param>
9893	<param name="flags" type="DirectoryRemoveRecFlag" dir="in" safearray="yes">
9894	<desc>Remove flags; see <link to="DirectoryRemoveRecFlag"/> for more information.</desc>
9895	</param>
9896	<param name="progress" type="IProgress" dir="return">
9897	<desc>Progress object to track the operation completion.</desc>
9898	</param>
9899	</method>
9900
9901	<method name="directoryRename">
9902	<desc>
9903	Renames a directory on the guest.
9904
9905	<result name="E_NOTIMPL">
9906	The method is not implemented yet.
9907	</result>
9908	</desc>
9909	<param name="source" type="wstring" dir="in">
9910	<desc>Source directory to rename.</desc>
9911	</param>
9912	<param name="dest" type="wstring" dir="in">
9913	<desc>Destination directory to rename the source to.</desc>
9914	</param>
9915	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
9916	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
9917	</param>
9918	</method>
9919
9920	<method name="directorySetACL">
9921	<desc>
9922	Sets the ACL (Access Control List) of a guest directory.
9923
9924	<result name="E_NOTIMPL">
9925	The method is not implemented yet.
9926	</result>
9927	</desc>
9928	<param name="path" type="wstring" dir="in">
9929	<desc>Full path of directory to set the ACL for.</desc>
9930	</param>
9931	<param name="acl" type="wstring" dir="in">
9932	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
9933	</param>
9934	</method>
9935
9936	<method name="environmentClear">
9937	<desc>
9938	Clears (deletes) all session environment variables.
9939
9940	<result name="VBOX_E_IPRT_ERROR">
9941	Error while clearing the session environment variables.
9942	</result>
9943	</desc>
9944	</method>
9945
9946	<method name="environmentGet">
9947	<desc>
9948	Gets the value of a session environment variable.
9949
9950	<result name="VBOX_E_IPRT_ERROR">
9951	Error while getting the value of the session environment variable.
9952	</result>
9953	</desc>
9954	<param name="name" type="wstring" dir="in">
9955	<desc>Name of session environment variable to get the value for.</desc>
9956	</param>
9957	<param name="value" type="wstring" dir="return">
9958	<desc>
9959	Value of the session environment variable specified. If this variable
9960	does not exist and empty value will be returned.
9961	</desc>
9962	</param>
9963	</method>
9964
9965	<method name="environmentSet">
9966	<desc>
9967	Sets a session environment variable.
9968
9969	<result name="VBOX_E_IPRT_ERROR">
9970	Error while setting the session environment variable.
9971	</result>
9972	</desc>
9973	<param name="name" type="wstring" dir="in">
9974	<desc>Name of session environment variable to set.</desc>
9975	</param>
9976	<param name="value" type="wstring" dir="in">
9977	<desc>Value to set the session environment variable to.</desc>
9978	</param>
9979	</method>
9980
9981	<method name="environmentUnset">
9982	<desc>
9983	Unsets session environment variable.
9984
9985	<result name="VBOX_E_IPRT_ERROR">
9986	Error while unsetting the session environment variable.
9987	</result>
9988	</desc>
9989	<param name="name" type="wstring" dir="in">
9990	<desc>Name of session environment variable to unset (clear).</desc>
9991	</param>
9992	</method>
9993
9994	<method name="fileCreateTemp">
9995	<desc>
9996	Creates a temporary file on the guest.
9997
9998	<result name="VBOX_E_NOT_SUPPORTED">
9999	The operation is not possible as requested on this particular
10000	guest type.
10001	</result>
10002	<result name="E_INVALIDARG">
10003	Invalid argument. This includes an incorrectly formatted template,
10004	or a non-absolute path.
10005	</result>
10006	<result name="VBOX_E_IPRT_ERROR">
10007	The temporary file could not be created. Possible reasons include
10008	a non-existing path or an insecure path when the secure
10009	option was requested.
10010	</result>
10011	</desc>
10012	<param name="templateName" type="wstring" dir="in">
10013	<desc>Template for the name of the file to create. This must contain
10014	at least one 'X' character. The first group of consecutive 'X'
10015	characters in the template will be replaced by a random
10016	alphanumeric string to produce a unique name.
10017	</desc>
10018	</param>
10019	<param name="mode" type="unsigned long" dir="in">
10020	<desc>The mode of the file to create. Use 0700 unless there are
10021	reasons not to. This parameter is ignored if "secure" is specified.
10022	</desc>
10023	</param>
10024	<param name="path" type="wstring" dir="in">
10025	<desc>The absolute path to create the temporary file in.</desc>
10026	</param>
10027	<param name="secure" type="boolean" dir="in">
10028	<desc>Whether to fail if the file can not be securely created.
10029	Currently this means that another unprivileged user cannot
10030	manipulate the path specified or remove the temporary file after
10031	it has been created. Also causes the mode specified to be ignored.
10032	May not be supported on all guest types.</desc>
10033	</param>
10034	<param name="file" type="IGuestFile" dir="return">
10035	<desc>On success this will contain an open file object for the new
10036	temporary file.
10037	</desc>
10038	</param>
10039	</method>
10040
10041	<method name="fileExists">
10042	<desc>
10043	Checks whether a file exists on the guest or not.
10044
10045	<result name="VBOX_E_IPRT_ERROR">
10046	Error while checking existence of the file specified.
10047	</result>
10048	</desc>
10049	<param name="path" type="wstring" dir="in">
10050	<desc>File to check existence for.</desc>
10051	</param>
10052	<param name="exists" type="boolean" dir="return">
10053	<desc>Returns @c true if the file exists, @c false if not.</desc>
10054	</param>
10055	</method>
10056
10057	<method name="fileRemove">
10058	<desc>
10059	Removes a single file on the guest.
10060
10061	<result name="VBOX_E_OBJECT_NOT_FOUND">
10062	File to remove was not found.
10063	</result>
10064	<result name="VBOX_E_IPRT_ERROR">
10065	Error while removing the file.
10066	</result>
10067	</desc>
10068	<param name="path" type="wstring" dir="in">
10069	<desc>Path to the file to remove.</desc>
10070	</param>
10071	</method>
10072
10073	<method name="fileOpen">
10074	<desc>
10075	Opens a file and creates a <link to="IGuestFile"/> object that
10076	can be used for further operations.
10077
10078	<result name="VBOX_E_OBJECT_NOT_FOUND">
10079	File to open was not found.
10080	</result>
10081	<result name="VBOX_E_IPRT_ERROR">
10082	Error while opening the file.
10083	</result>
10084	</desc>
10085	<param name="path" type="wstring" dir="in">
10086	<desc>Full path to file to open.</desc>
10087	</param>
10088	<param name="openMode" type="wstring" dir="in">
10089	<desc>The file open mode.</desc>
10090	</param>
10091	<param name="disposition" type="wstring" dir="in">
10092	<desc>The file disposition.</desc>
10093	</param>
10094	<param name="creationMode" type="unsigned long" dir="in">
10095	<desc>The file creation mode.</desc>
10096	</param>
10097	<param name="offset" type="long long" dir="in">
10098	<desc>The initial read/write offset.</desc>
10099	</param>
10100	<param name="file" type="IGuestFile" dir="return">
10101	<desc><link to="IGuestFile"/> object representing the opened file.</desc>
10102	</param>
10103	</method>
10104
10105	<method name="fileQueryInfo">
10106	<desc>
10107	Queries information of a file on the guest.
10108
10109	<result name="VBOX_E_OBJECT_NOT_FOUND">
10110	File to query information for was not found.
10111	</result>
10112	<result name="VBOX_E_IPRT_ERROR">
10113	Error querying information.
10114	</result>
10115	</desc>
10116	<param name="path" type="wstring" dir="in">
10117	<desc>File to query information for.</desc>
10118	</param>
10119	<param name="info" type="IGuestFsObjInfo" dir="return">
10120	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
10121	</param>
10122	</method>
10123
10124	<method name="fileQuerySize">
10125	<desc>
10126	Queries the size of a file on the guest.
10127
10128	<result name="VBOX_E_OBJECT_NOT_FOUND">
10129	File to rename was not found.
10130	</result>
10131	<result name="VBOX_E_IPRT_ERROR">
10132	Error querying file size.
10133	</result>
10134	</desc>
10135	<param name="path" type="wstring" dir="in">
10136	<desc>File to query the size for.</desc>
10137	</param>
10138	<param name="size" type="long long" dir="return">
10139	<desc>Queried file size.</desc>
10140	</param>
10141	</method>
10142
10143	<method name="fileRename">
10144	<desc>
10145	Renames a file on the guest.
10146
10147	<result name="E_NOTIMPL">
10148	The method is not implemented yet.
10149	</result>
10150	</desc>
10151	<param name="source" type="wstring" dir="in">
10152	<desc>Source file to rename.</desc>
10153	</param>
10154	<param name="dest" type="wstring" dir="in">
10155	<desc>Destination file to rename the source to.</desc>
10156	</param>
10157	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
10158	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
10159	</param>
10160	</method>
10161
10162	<method name="fileSetACL">
10163	<desc>
10164	Sets the ACL (Access Control List) of a file on the guest.
10165
10166	<result name="E_NOTIMPL">
10167	The method is not implemented yet.
10168	</result>
10169	</desc>
10170	<param name="file" type="wstring" dir="in">
10171	<desc>Full path of file to set the ACL for.</desc>
10172	</param>
10173	<param name="acl" type="wstring" dir="in">
10174	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
10175	</param>
10176	</method>
10177
10178	<method name="processCreate">
10179	<desc>
10180	Executes an existing program inside the guest VM.
10181
10182	<note>
10183	Starting at VirtualBox 4.2 guest process execution by default is limited
10184	to serve up to 255 guest processes at a time. If all 255 guest processes
10185	are still active and running, starting a new guest process will result in an
10186	appropriate error message.
10187
10188	If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
10189	is / are set, the guest process will not exit until all data from the specified
10190	stream(s) is / are read out.
10191
10192	To raise or lower the guest process execution limit, either the guest property
10193	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
10194	command line by specifying "--control-procs-max-kept" needs to be modified.
10195	A restart of the guest OS is required afterwards. To serve unlimited guest
10196	processes, a value of "0" needs to be set (not recommended).
10197	</note>
10198
10199	<result name="VBOX_E_IPRT_ERROR">
10200	Could not create process.
10201	</result>
10202	</desc>
10203	<param name="command" type="wstring" dir="in">
10204	<desc>
10205	Full path name of the command to execute on the guest; the
10206	commands has to exists in the guest VM in order to be executed.
10207	</desc>
10208	</param>
10209	<param name="arguments" type="wstring" dir="in" safearray="yes">
10210	<desc>Array of arguments passed to the execution command.</desc>
10211	</param>
10212	<param name="environment" type="wstring" dir="in" safearray="yes">
10213	<desc>
10214	Environment variables that can be set while the command is being
10215	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10216	variable just set its name ("NAME") without a value.
10217
10218	This parameter can be used to override environment variables set by
10219	the guest session, which will be applied to the newly started process
10220	in any case.
10221	</desc>
10222	</param>
10223	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10224	<desc>
10225	Process creation flags;
10226	see <link to="ProcessCreateFlag"/> for more information.
10227	</desc>
10228	</param>
10229	<param name="timeoutMS" type="unsigned long" dir="in">
10230	<desc>
10231	Timeout (in ms) to wait for the operation to complete.
10232	Pass 0 for an infinite timeout.
10233	</desc>
10234	</param>
10235	<param name="guestProcess" type="IGuestProcess" dir="return">
10236	<desc>Guest process object of the newly created process.</desc>
10237	</param>
10238	</method>
10239
10240	<method name="processCreateEx">
10241	<desc>
10242	Executes an existing program inside the guest VM. Extended version for
10243	also setting the process priority and affinity.
10244
10245	<note>
10246	Starting at VirtualBox 4.2 guest process execution by default is limited
10247	to serve up to 255 guest processes at a time. If all 255 guest processes
10248	are still active and running, starting a new guest process will result in an
10249	appropriate error message.
10250
10251	If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
10252	is / are set, the guest process will not exit until all data from the specified
10253	stream(s) is / are read out.
10254
10255	To raise or lower the guest process execution limit, either the guest property
10256	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
10257	command line by specifying "--control-procs-max-kept" needs to be modified.
10258	A restart of the guest OS is required afterwards. To serve unlimited guest
10259	processes, a value of "0" needs to be set (not recommended).
10260	</note>
10261
10262	<result name="VBOX_E_IPRT_ERROR">
10263	Could not create process.
10264	</result>
10265	</desc>
10266	<param name="command" type="wstring" dir="in">
10267	<desc>
10268	Full path name of the command to execute on the guest; the
10269	commands has to exists in the guest VM in order to be executed.
10270	</desc>
10271	</param>
10272	<param name="arguments" type="wstring" dir="in" safearray="yes">
10273	<desc>Array of arguments passed to the execution command.</desc>
10274	</param>
10275	<param name="environment" type="wstring" dir="in" safearray="yes">
10276	<desc>
10277	Environment variables that can be set while the command is being
10278	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10279	variable just set its name ("NAME") without a value.
10280
10281	This parameter can be used to override environment variables set by
10282	the guest session, which will be applied to the newly started process
10283	in any case.
10284	</desc>
10285	</param>
10286	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10287	<desc>
10288	Process creation flags;
10289	see <link to="ProcessCreateFlag"/> for more information.
10290	</desc>
10291	</param>
10292	<param name="timeoutMS" type="unsigned long" dir="in">
10293	<desc>
10294	Timeout (in ms) to wait for the operation to complete.
10295	Pass 0 for an infinite timeout.
10296	</desc>
10297	</param>
10298	<param name="priority" type="ProcessPriority" dir="in">
10299	<desc>
10300	Process priority to use for execution;
10301	see see <link to="ProcessPriority"/> for more information.</desc>
10302	</param>
10303	<param name="affinity" type="long" dir="in" safearray="yes">
10304	<desc>
10305	Process affinity to use for execution. This parameter
10306	is not implemented yet.
10307	</desc>
10308	</param>
10309	<param name="guestProcess" type="IGuestProcess" dir="return">
10310	<desc>Guest process object of the newly created process.</desc>
10311	</param>
10312	</method>
10313
10314	<method name="processGet">
10315	<desc>
10316	Gets a certain guest process by its process ID (PID).
10317	</desc>
10318	<param name="pid" type="unsigned long" dir="in">
10319	<desc>Process ID (PID) to get guest process for.</desc>
10320	</param>
10321	<param name="guestProcess" type="IGuestProcess" dir="return">
10322	<desc>Guest process of specified process ID (PID).</desc>
10323	</param>
10324	</method>
10325
10326	<method name="symlinkCreate">
10327	<desc>
10328	Creates a symbolic link on the guest.
10329
10330	<result name="E_NOTIMPL">
10331	The method is not implemented yet.
10332	</result>
10333	</desc>
10334	<param name="source" type="wstring" dir="in">
10335	<desc>The name of the symbolic link.</desc>
10336	</param>
10337	<param name="target" type="wstring" dir="in">
10338	<desc>The path to the symbolic link target.</desc>
10339	</param>
10340	<param name="type" type="SymlinkType" dir="in">
10341	<desc>
10342	The symbolic link type;
10343	see <link to="SymlinkReadFlag"/> for more information.
10344	</desc>
10345	</param>
10346	</method>
10347
10348	<method name="symlinkExists">
10349	<desc>
10350	Checks whether a symbolic link exists on the guest or not.
10351
10352	<result name="E_NOTIMPL">
10353	The method is not implemented yet.
10354	</result>
10355	</desc>
10356	<param name="symlink" type="wstring" dir="in">
10357	<desc>Symbolic link to check existence for.</desc>
10358	</param>
10359	<param name="exists" type="boolean" dir="return">
10360	<desc>Returns @c true if the symbolic link exists, @c false if not.</desc>
10361	</param>
10362	</method>
10363
10364	<method name="symlinkRead">
10365	<desc>
10366	Reads a symbolic link on the guest.
10367
10368	<result name="E_NOTIMPL">
10369	The method is not implemented yet.
10370	</result>
10371	</desc>
10372	<param name="symlink" type="wstring" dir="in">
10373	<desc>Full path to symbolic link to read.</desc>
10374	</param>
10375	<param name="flags" type="SymlinkReadFlag" dir="in" safearray="yes">
10376	<desc>
10377	Read flags; see <link to="SymlinkReadFlag"/> for more information.
10378	</desc>
10379	</param>
10380	<param name="target" type="wstring" dir="return">
10381	<desc>
10382	Target of the symbolic link pointing to, if found.
10383	</desc>
10384	</param>
10385	</method>
10386
10387	<method name="symlinkRemoveDirectory">
10388	<desc>
10389	Removes a symbolic link on the guest if it's a directory.
10390
10391	<result name="E_NOTIMPL">
10392	The method is not implemented yet.
10393	</result>
10394	</desc>
10395	<param name="path" type="wstring" dir="in">
10396	<desc>Symbolic link to remove.</desc>
10397	</param>
10398	</method>
10399
10400	<method name="symlinkRemoveFile">
10401	<desc>
10402	Removes a symbolic link on the guest if it's a file.
10403
10404	<result name="E_NOTIMPL">
10405	The method is not implemented yet.
10406	</result>
10407	</desc>
10408	<param name="file" type="wstring" dir="in">
10409	<desc>Symbolic link to remove.</desc>
10410	</param>
10411	</method>
10412
10413	<method name="waitFor">
10414	<desc>
10415	Waits for one more events to happen.
10416	</desc>
10417	<param name="waitFor" type="unsigned long" dir="in">
10418	<desc>
10419	Specifies what to wait for;
10420	see <link to="GuestSessionWaitForFlag"/> for more information.
10421	</desc>
10422	</param>
10423	<param name="timeoutMS" type="unsigned long" dir="in">
10424	<desc>
10425	Timeout (in ms) to wait for the operation to complete.
10426	Pass 0 for an infinite timeout.
10427	</desc>
10428	</param>
10429	<param name="reason" type="GuestSessionWaitResult" dir="return">
10430	<desc>
10431	The overall wait result;
10432	see <link to="GuestSessionWaitResult"/> for more information.
10433	</desc>
10434	</param>
10435	</method>
10436
10437	<method name="waitForArray">
10438	<desc>
10439	Waits for one more events to happen.
10440	Scriptable version of <link to="#waitFor" />.
10441	</desc>
10442	<param name="waitFor" type="GuestSessionWaitForFlag" dir="in" safearray="yes">
10443	<desc>
10444	Specifies what to wait for;
10445	see <link to="GuestSessionWaitForFlag"/> for more information.
10446	</desc>
10447	</param>
10448	<param name="timeoutMS" type="unsigned long" dir="in">
10449	<desc>
10450	Timeout (in ms) to wait for the operation to complete.
10451	Pass 0 for an infinite timeout.
10452	</desc>
10453	</param>
10454	<param name="reason" type="GuestSessionWaitResult" dir="return">
10455	<desc>
10456	The overall wait result;
10457	see <link to="GuestSessionWaitResult"/> for more information.
10458	</desc>
10459	</param>
10460	</method>
10461
10462	</interface>
10463
10464	<interface
10465	name="IProcess" extends="$unknown"
10466	uuid="08864d56-96ab-418b-adbc-5a679532aeb0"
10467	wsmap="managed"
10468	>
10469	<desc>
10470	Abstract parent interface for processes handled by VirtualBox.
10471	</desc>
10472	<attribute name="PID" type="unsigned long" readonly="yes">
10473	<desc>
10474	The process ID (PID).
10475	</desc>
10476	</attribute>
10477	<attribute name="status" type="ProcessStatus" readonly="yes">
10478	<desc>
10479	The current process status; see <link to="ProcessStatus"/>
10480	for more information.
10481	</desc>
10482	</attribute>
10483	<attribute name="exitCode" type="long" readonly="yes">
10484	<desc>
10485	The exit code. Only available when the process has been
10486	terminated normally.
10487	</desc>
10488	</attribute>
10489	<attribute name="environment" type="wstring" readonly="yes" safearray="yes">
10490	<desc>
10491	The environment block this process is using during execution.
10492	</desc>
10493	</attribute>
10494	<attribute name="arguments" type="wstring" readonly="yes" safearray="yes">
10495	<desc>
10496	The arguments this process is using for execution.
10497	</desc>
10498	</attribute>
10499	<attribute name="executablePath" type="wstring" readonly="yes">
10500	<desc>Full path of the actual executable image.</desc>
10501	</attribute>
10502	<attribute name="name" type="wstring" readonly="yes">
10503	<desc>The friendly name of this process.</desc>
10504	</attribute>
10505
10506	<method name="waitFor">
10507	<desc>
10508	Waits for one more events to happen.
10509	</desc>
10510	<param name="waitFor" type="unsigned long" dir="in">
10511	<desc>
10512	Specifies what to wait for;
10513	see <link to="ProcessWaitForFlag"/> for more information.
10514	</desc>
10515	</param>
10516	<param name="timeoutMS" type="unsigned long" dir="in">
10517	<desc>
10518	Timeout (in ms) to wait for the operation to complete.
10519	Pass 0 for an infinite timeout.
10520	</desc>
10521	</param>
10522	<param name="reason" type="ProcessWaitResult" dir="return">
10523	<desc>
10524	The overall wait result;
10525	see <link to="ProcessWaitResult"/> for more information.
10526	</desc>
10527	</param>
10528	</method>
10529
10530	<method name="waitForArray">
10531	<desc>
10532	Waits for one more events to happen.
10533	Scriptable version of <link to="#waitFor" />.
10534	</desc>
10535	<param name="waitFor" type="ProcessWaitForFlag" dir="in" safearray="yes">
10536	<desc>
10537	Specifies what to wait for;
10538	see <link to="ProcessWaitForFlag"/> for more information.
10539	</desc>
10540	</param>
10541	<param name="timeoutMS" type="unsigned long" dir="in">
10542	<desc>
10543	Timeout (in ms) to wait for the operation to complete.
10544	Pass 0 for an infinite timeout.
10545	</desc>
10546	</param>
10547	<param name="reason" type="ProcessWaitResult" dir="return">
10548	<desc>
10549	The overall wait result;
10550	see <link to="ProcessWaitResult"/> for more information.
10551	</desc>
10552	</param>
10553	</method>
10554
10555	<method name="read">
10556	<desc>
10557	Reads data from a running process.
10558	</desc>
10559	<param name="handle" type="unsigned long" dir="in">
10560	<desc>Handle to read from. Usually 0 is stdin.</desc>
10561	</param>
10562	<param name="toRead" type="unsigned long" dir="in">
10563	<desc>Number of bytes to read.</desc>
10564	</param>
10565	<param name="timeoutMS" type="unsigned long" dir="in">
10566	<desc>
10567	Timeout (in ms) to wait for the operation to complete.
10568	Pass 0 for an infinite timeout.
10569	</desc>
10570	</param>
10571	<param name="data" type="octet" dir="return" safearray="yes">
10572	<desc>Array of data read.</desc>
10573	</param>
10574	</method>
10575
10576	<method name="write">
10577	<desc>
10578	Writes data to a running process.
10579	</desc>
10580	<param name="handle" type="unsigned long" dir="in">
10581	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10582	</param>
10583	<param name="flags" type="unsigned long" dir="in">
10584	<desc>
10585	A combination of <link to="ProcessInputFlag"/> flags.
10586	</desc>
10587	</param>
10588	<param name="data" type="octet" dir="in" safearray="yes">
10589	<desc>
10590	Array of bytes to write. The size of the array also specifies
10591	how much to write.
10592	</desc>
10593	</param>
10594	<param name="timeoutMS" type="unsigned long" dir="in">
10595	<desc>
10596	Timeout (in ms) to wait for the operation to complete.
10597	Pass 0 for an infinite timeout.
10598	</desc>
10599	</param>
10600	<param name="written" type="unsigned long" dir="return">
10601	<desc>How much bytes were written.</desc>
10602	</param>
10603	</method>
10604
10605	<method name="writeArray">
10606	<desc>
10607	Writes data to a running process.
10608	Scriptable version of <link to="#write" />.
10609	</desc>
10610	<param name="handle" type="unsigned long" dir="in">
10611	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10612	</param>
10613	<param name="flags" type="ProcessInputFlag" dir="in" safearray="yes">
10614	<desc>
10615	A combination of <link to="ProcessInputFlag"/> flags.
10616	</desc>
10617	</param>
10618	<param name="data" type="octet" dir="in" safearray="yes">
10619	<desc>
10620	Array of bytes to write. The size of the array also specifies
10621	how much to write.
10622	</desc>
10623	</param>
10624	<param name="timeoutMS" type="unsigned long" dir="in">
10625	<desc>
10626	Timeout (in ms) to wait for the operation to complete.
10627	Pass 0 for an infinite timeout.
10628	</desc>
10629	</param>
10630	<param name="written" type="unsigned long" dir="return">
10631	<desc>How much bytes were written.</desc>
10632	</param>
10633	</method>
10634
10635	<method name="terminate">
10636	<desc>
10637	Terminates (kills) a running process.
10638	</desc>
10639	</method>
10640	</interface>
10641
10642	<interface
10643	name="IGuestProcess" extends="IProcess"
10644	uuid="dfa39a36-5d43-4840-a025-67ea956b3111"
10645	wsmap="managed"
10646	>
10647	<desc>
10648	Implementation of the <link to="IProcess" /> object
10649	for processes on the guest.
10650	</desc>
10651	</interface>
10652
10653	<interface
10654	name="IDirectory" extends="$unknown"
10655	uuid="1b70dd03-26d7-483a-8877-89bbb0f87b70"
10656	wsmap="managed"
10657	>
10658	<desc>
10659	Abstract parent interface for directories handled by VirtualBox.
10660	</desc>
10661
10662	<attribute name="directoryName" type="wstring" readonly="yes">
10663	<desc>
10664	Full path of directory.
10665	</desc>
10666	</attribute>
10667
10668	<attribute name="filter" type="wstring" readonly="yes">
10669	<desc>
10670	The open filter.
10671	</desc>
10672	</attribute>
10673
10674	<method name="close">
10675	<desc>
10676	Closes this directory. After closing operations like reading the next
10677	directory entry will not be possible anymore.
10678	</desc>
10679	</method>
10680
10681	<method name="read">
10682	<desc>
10683	Reads the next directory entry of this directory.
10684	<result name="VBOX_E_OBJECT_NOT_FOUND">
10685	No more directory entries to read.
10686	</result>
10687	</desc>
10688	<param name="objInfo" type="IFsObjInfo" dir="return">
10689	<desc>Object information of the current directory entry read. Also see
10690	<link to="IFsObjInfo"/>.</desc>
10691	</param>
10692	</method>
10693	</interface>
10694
10695	<interface
10696	name="IGuestDirectory" extends="IDirectory"
10697	uuid="af4a8ce0-0725-42b7-8826-46e3c7ba7357"
10698	wsmap="managed"
10699	>
10700	<desc>
10701	Implementation of the <link to="IDirectory" /> object
10702	for directories on the guest.
10703	</desc>
10704	</interface>
10705
10706	<interface
10707	name="IFile" extends="$unknown"
10708	uuid="b702a560-6139-4a8e-a892-bbf14b97bf97"
10709	wsmap="managed"
10710	>
10711	<desc>
10712	Abstract parent interface for files handled by VirtualBox.
10713	</desc>
10714	<attribute name="creationMode" type="unsigned long" readonly="yes">
10715	<desc>
10716	The creation mode.
10717	</desc>
10718	</attribute>
10719	<attribute name="disposition" type="unsigned long" readonly="yes">
10720	<desc>
10721	The disposition mode.
10722	</desc>
10723	</attribute>
10724	<attribute name="fileName" type="wstring" readonly="yes">
10725	<desc>
10726	Full path of the actual file name of this file.
10727	</desc>
10728	</attribute>
10729	<attribute name="initialSize" type="long long" readonly="yes">
10730	<desc>
10731	The initial size in bytes when opened.
10732	</desc>
10733	</attribute>
10734	<attribute name="openMode" type="unsigned long" readonly="yes">
10735	<desc>
10736	The open mode.
10737	</desc>
10738	</attribute>
10739	<attribute name="offset" type="long long" readonly="yes">
10740	<desc>
10741	Current read/write offset in bytes.
10742	</desc>
10743	</attribute>
10744
10745	<method name="close">
10746	<desc>
10747	Closes this file. After closing operations like reading data,
10748	writing data or querying information will not be possible anymore.
10749	</desc>
10750	</method>
10751
10752	<method name="queryInfo">
10753	<desc>
10754	Queries information about this file.
10755
10756	<result name="E_NOTIMPL">
10757	The method is not implemented yet.
10758	</result>
10759	</desc>
10760	<param name="objInfo" type="IFsObjInfo" dir="return">
10761	<desc>Object information of this file. Also see
10762	<link to="IFsObjInfo"/>.</desc>
10763	</param>
10764	</method>
10765
10766	<method name="read">
10767	<desc>
10768	Reads data from this file.
10769
10770	<result name="E_NOTIMPL">
10771	The method is not implemented yet.
10772	</result>
10773	</desc>
10774	<param name="toRead" type="unsigned long" dir="in">
10775	<desc>Number of bytes to read.</desc>
10776	</param>
10777	<param name="timeoutMS" type="unsigned long" dir="in">
10778	<desc>
10779	Timeout (in ms) to wait for the operation to complete.
10780	Pass 0 for an infinite timeout.
10781	</desc>
10782	</param>
10783	<param name="data" type="octet" dir="return" safearray="yes">
10784	<desc>Array of data read.</desc>
10785	</param>
10786	</method>
10787
10788	<method name="readAt">
10789	<desc>
10790	Reads data from an offset of this file.
10791
10792	<result name="E_NOTIMPL">
10793	The method is not implemented yet.
10794	</result>
10795	</desc>
10796	<param name="offset" type="long long" dir="in">
10797	<desc>Offset in bytes to start reading.</desc>
10798	</param>
10799	<param name="toRead" type="unsigned long" dir="in">
10800	<desc>Number of bytes to read.</desc>
10801	</param>
10802	<param name="timeoutMS" type="unsigned long" dir="in">
10803	<desc>
10804	Timeout (in ms) to wait for the operation to complete.
10805	Pass 0 for an infinite timeout.
10806	</desc>
10807	</param>
10808	<param name="data" type="octet" dir="return" safearray="yes">
10809	<desc>Array of data read.</desc>
10810	</param>
10811	</method>
10812
10813	<method name="seek">
10814	<desc>
10815	Changes the read and write position of this file.
10816
10817	<result name="E_NOTIMPL">
10818	The method is not implemented yet.
10819	</result>
10820	</desc>
10821	<param name="offset" type="long long" dir="in">
10822	<desc>Offset to seek.</desc>
10823	</param>
10824	<param name="whence" type="FileSeekType" dir="in">
10825	<desc>
10826	Seek mode; see <link to="FileSeekType"/> for more information.
10827	</desc>
10828	</param>
10829	</method>
10830
10831	<method name="setACL">
10832	<desc>
10833	Sets the ACL of this file.
10834
10835	<result name="E_NOTIMPL">
10836	The method is not implemented yet.
10837	</result>
10838	</desc>
10839	<param name="acl" type="wstring" dir="in">
10840	<desc>ACL string to set.</desc>
10841	</param>
10842	</method>
10843
10844	<method name="write">
10845	<desc>
10846	Writes bytes to this file.
10847	</desc>
10848	<param name="data" type="octet" dir="in" safearray="yes">
10849	<desc>
10850	Array of bytes to write. The size of the array also specifies
10851	how much to write.
10852	</desc>
10853	</param>
10854	<param name="timeoutMS" type="unsigned long" dir="in">
10855	<desc>
10856	Timeout (in ms) to wait for the operation to complete.
10857	Pass 0 for an infinite timeout.
10858	</desc>
10859	</param>
10860	<param name="written" type="unsigned long" dir="return">
10861	<desc>How much bytes were written.</desc>
10862	</param>
10863	</method>
10864
10865	<method name="writeAt">
10866	<desc>
10867	Writes bytes at a certain offset to this file.
10868
10869	<result name="E_NOTIMPL">
10870	The method is not implemented yet.
10871	</result>
10872	</desc>
10873	<param name="offset" type="long long" dir="in">
10874	<desc>Offset in bytes to start writing.</desc>
10875	</param>
10876	<param name="data" type="octet" dir="in" safearray="yes">
10877	<desc>
10878	Array of bytes to write. The size of the array also specifies
10879	how much to write.
10880	</desc>
10881	</param>
10882	<param name="timeoutMS" type="unsigned long" dir="in">
10883	<desc>
10884	Timeout (in ms) to wait for the operation to complete.
10885	Pass 0 for an infinite timeout.
10886	</desc>
10887	</param>
10888	<param name="written" type="unsigned long" dir="return">
10889	<desc>How much bytes were written.</desc>
10890	</param>
10891	</method>
10892
10893	</interface>
10894
10895	<interface
10896	name="IGuestFile" extends="IFile"
10897	uuid="60661aec-145f-4d11-b80e-8ea151598093"
10898	wsmap="managed"
10899	>
10900	<desc>
10901	Implementation of the <link to="IFile" /> object
10902	for files on the guest.
10903	</desc>
10904	</interface>
10905
10906	<interface
10907	name="IFsObjInfo" extends="$unknown"
10908	uuid="4047ba30-7006-4966-ae86-94164e5e20eb"
10909	wsmap="managed"
10910	>
10911	<desc>
10912	Abstract parent interface for VirtualBox file system object information.
10913	This can be information about a file or a directory, for example.
10914	</desc>
10915
10916	<attribute name="accessTime" type="long long" readonly="yes">
10917	<desc>
10918	Time of last access (st_atime).
10919	</desc>
10920	</attribute>
10921	<attribute name="allocatedSize" type="long long" readonly="yes">
10922	<desc>
10923	Disk allocation size (st_blocks * DEV_BSIZE).
10924	</desc>
10925	</attribute>
10926	<attribute name="birthTime" type="long long" readonly="yes">
10927	<desc>
10928	Time of file birth (st_birthtime).
10929	</desc>
10930	</attribute>
10931	<attribute name="changeTime" type="long long" readonly="yes">
10932	<desc>
10933	Time of last status change (st_ctime).
10934	</desc>
10935	</attribute>
10936	<attribute name="deviceNumber" type="unsigned long" readonly="yes">
10937	<desc>
10938	The device number of a character or block device type object (st_rdev).
10939	</desc>
10940	</attribute>
10941	<attribute name="fileAttributes" type="wstring" readonly="yes">
10942	<desc>
10943	File attributes. Not implemented yet.
10944	</desc>
10945	</attribute>
10946	<attribute name="generationId" type="unsigned long" readonly="yes">
10947	<desc>
10948	The current generation number (st_gen).
10949	</desc>
10950	</attribute>
10951	<attribute name="GID" type="unsigned long" readonly="yes">
10952	<desc>
10953	The group the filesystem object is assigned (st_gid).
10954	</desc>
10955	</attribute>
10956	<attribute name="groupName" type="wstring" readonly="yes">
10957	<desc>
10958	The group name.
10959	</desc>
10960	</attribute>
10961	<attribute name="hardLinks" type="unsigned long" readonly="yes">
10962	<desc>
10963	Number of hard links to this filesystem object (st_nlink).
10964	</desc>
10965	</attribute>
10966	<attribute name="modificationTime" type="long long" readonly="yes">
10967	<desc>
10968	Time of last data modification (st_mtime).
10969	</desc>
10970	</attribute>
10971	<attribute name="name" type="wstring" readonly="yes">
10972	<desc>
10973	The object's name.
10974	</desc>
10975	</attribute>
10976	<attribute name="nodeId" type="long long" readonly="yes">
10977	<desc>
10978	The unique identifier (within the filesystem) of this filesystem object (st_ino).
10979	</desc>
10980	</attribute>
10981	<attribute name="nodeIdDevice" type="unsigned long" readonly="yes">
10982	<desc>
10983	The device number of the device which this filesystem object resides on (st_dev).
10984	</desc>
10985	</attribute>
10986	<attribute name="objectSize" type="long long" readonly="yes">
10987	<desc>
10988	The logical size (st_size). For normal files this is the size of the file.
10989	For symbolic links, this is the length of the path name contained in the
10990	symbolic link. For other objects this fields needs to be specified.
10991	</desc>
10992	</attribute>
10993	<attribute name="type" type="FsObjType" readonly="yes">
10994	<desc>
10995	The object type. See <link to="FsObjType" /> for more.
10996	</desc>
10997	</attribute>
10998	<attribute name="UID" type="unsigned long" readonly="yes">
10999	<desc>
11000	The user owning the filesystem object (st_uid).
11001	</desc>
11002	</attribute>
11003	<attribute name="userFlags" type="unsigned long" readonly="yes">
11004	<desc>
11005	User flags (st_flags).
11006	</desc>
11007	</attribute>
11008	<attribute name="userName" type="wstring" readonly="yes">
11009	<desc>
11010	The user name.
11011	</desc>
11012	</attribute>
11013
11014	</interface>
11015
11016	<interface
11017	name="IGuestFsObjInfo" extends="IFsObjInfo"
11018	uuid="d5cf678e-3484-4e4a-ac55-329e15462e18"
11019	wsmap="managed"
11020	>
11021	<desc>
11022	Represents the guest implementation of the
11023	<link to="IFsObjInfo" /> object.
11024	</desc>
11025	</interface>
11026
11027	<interface
11028	name="IGuest" extends="$unknown"
11029	uuid="19c32350-0618-4ede-b0c3-2b4311bf0d9b"
11030	wsmap="managed"
11031	>
11032	<desc>
11033	The IGuest interface represents information about the operating system
11034	running inside the virtual machine. Used in
11035	<link to="IConsole::guest"/>.
11036
11037	IGuest provides information about the guest operating system, whether
11038	Guest Additions are installed and other OS-specific virtual machine
11039	properties.
11040	</desc>
11041
11042	<attribute name="OSTypeId" type="wstring" readonly="yes">
11043	<desc>
11044	Identifier of the Guest OS type as reported by the Guest
11045	Additions.
11046	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
11047	an IGuestOSType object representing details about the given
11048	Guest OS type.
11049	<note>
11050	If Guest Additions are not installed, this value will be
11051	the same as <link to="IMachine::OSTypeId"/>.
11052	</note>
11053	</desc>
11054	</attribute>
11055
11056	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
11057	<desc>
11058	Current run level of the Guest Additions.
11059	</desc>
11060	</attribute>
11061
11062	<attribute name="additionsVersion" type="wstring" readonly="yes">
11063	<desc>
11064	Version of the Guest Additions in the same format as
11065	<link to="IVirtualBox::version"/>.
11066	</desc>
11067	</attribute>
11068
11069	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
11070	<desc>
11071	The internal build revision number of the additions.
11072
11073	See also <link to="IVirtualBox::revision"/>.
11074	</desc>
11075	</attribute>
11076
11077	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
11078	<desc>
11079	Array of current known facilities. Only returns facilities where a status is known,
11080	e.g. facilities with an unknown status will not be returned.
11081	</desc>
11082	</attribute>
11083
11084	<attribute name="sessions" type="IGuestSession" readonly="yes" safearray="yes">
11085	<desc>Returns a collection of all opened guest sessions.</desc>
11086	</attribute>
11087
11088	<attribute name="memoryBalloonSize" type="unsigned long">
11089	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
11090	</attribute>
11091
11092	<attribute name="statisticsUpdateInterval" type="unsigned long">
11093	<desc>Interval to update guest statistics in seconds.</desc>
11094	</attribute>
11095
11096	<method name="internalGetStatistics">
11097	<desc>
11098	Internal method; do not use as it might change at any time.
11099	</desc>
11100	<param name="cpuUser" type="unsigned long" dir="out">
11101	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
11102	</param>
11103	<param name="cpuKernel" type="unsigned long" dir="out">
11104	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
11105	</param>
11106	<param name="cpuIdle" type="unsigned long" dir="out">
11107	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
11108	</param>
11109	<param name="memTotal" type="unsigned long" dir="out">
11110	<desc>Total amount of physical guest RAM.</desc>
11111	</param>
11112	<param name="memFree" type="unsigned long" dir="out">
11113	<desc>Free amount of physical guest RAM.</desc>
11114	</param>
11115	<param name="memBalloon" type="unsigned long" dir="out">
11116	<desc>Amount of ballooned physical guest RAM.</desc>
11117	</param>
11118	<param name="memShared" type="unsigned long" dir="out">
11119	<desc>Amount of shared physical guest RAM.</desc>
11120	</param>
11121	<param name="memCache" type="unsigned long" dir="out">
11122	<desc>Total amount of guest (disk) cache memory.</desc>
11123	</param>
11124	<param name="pagedTotal" type="unsigned long" dir="out">
11125	<desc>Total amount of space in the page file.</desc>
11126	</param>
11127	<param name="memAllocTotal" type="unsigned long" dir="out">
11128	<desc>Total amount of memory allocated by the hypervisor.</desc>
11129	</param>
11130	<param name="memFreeTotal" type="unsigned long" dir="out">
11131	<desc>Total amount of free memory available in the hypervisor.</desc>
11132	</param>
11133	<param name="memBalloonTotal" type="unsigned long" dir="out">
11134	<desc>Total amount of memory ballooned by the hypervisor.</desc>
11135	</param>
11136	<param name="memSharedTotal" type="unsigned long" dir="out">
11137	<desc>Total amount of shared memory in the hypervisor.</desc>
11138	</param>
11139	</method>
11140
11141	<method name="getFacilityStatus">
11142	<desc>
11143	Get the current status of a Guest Additions facility.
11144	</desc>
11145	<param name="facility" type="AdditionsFacilityType" dir="in">
11146	<desc>Facility to check status for.</desc>
11147	</param>
11148	<param name="timestamp" type="long long" dir="out">
11149	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
11150	</param>
11151	<param name="status" type="AdditionsFacilityStatus" dir="return">
11152	<desc>The current (latest) facility status.</desc>
11153	</param>
11154	</method>
11155
11156	<method name="getAdditionsStatus">
11157	<desc>
11158	Retrieve the current status of a certain Guest Additions run level.
11159
11160	<result name="VBOX_E_NOT_SUPPORTED">
11161	Wrong status level specified.
11162	</result>
11163
11164	</desc>
11165	<param name="level" type="AdditionsRunLevelType" dir="in">
11166	<desc>Status level to check</desc>
11167	</param>
11168	<param name="active" type="boolean" dir="return">
11169	<desc>Flag whether the status level has been reached or not</desc>
11170	</param>
11171	</method>
11172
11173	<method name="setCredentials">
11174	<desc>
11175	Store login credentials that can be queried by guest operating
11176	systems with Additions installed. The credentials are transient
11177	to the session and the guest may also choose to erase them. Note
11178	that the caller cannot determine whether the guest operating system
11179	has queried or made use of the credentials.
11180
11181	<result name="VBOX_E_VM_ERROR">
11182	VMM device is not available.
11183	</result>
11184
11185	</desc>
11186	<param name="userName" type="wstring" dir="in">
11187	<desc>User name string, can be empty</desc>
11188	</param>
11189	<param name="password" type="wstring" dir="in">
11190	<desc>Password string, can be empty</desc>
11191	</param>
11192	<param name="domain" type="wstring" dir="in">
11193	<desc>Domain name (guest logon scheme specific), can be empty</desc>
11194	</param>
11195	<param name="allowInteractiveLogon" type="boolean" dir="in">
11196	<desc>
11197	Flag whether the guest should alternatively allow the user to
11198	interactively specify different credentials. This flag might
11199	not be supported by all versions of the Additions.
11200	</desc>
11201	</param>
11202	</method>
11203
11204	<method name="dragHGEnter">
11205	<desc>
11206	Informs the guest about a Drag and Drop enter event.
11207
11208	This is used in Host - Guest direction.
11209
11210	<result name="VBOX_E_VM_ERROR">
11211	VMM device is not available.
11212	</result>
11213
11214	</desc>
11215	<param name="screenId" type="unsigned long" dir="in">
11216	<desc>The screen id where the Drag and Drop event occured.</desc>
11217	</param>
11218	<param name="y" type="unsigned long" dir="in">
11219	<desc>y-position of the event.</desc>
11220	</param>
11221	<param name="x" type="unsigned long" dir="in">
11222	<desc>x-position of the event.</desc>
11223	</param>
11224	<param name="defaultAction" type="DragAndDropAction" dir="in">
11225	<desc>The default action to use.</desc>
11226	</param>
11227	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11228	<desc>The actions which are allowed.</desc>
11229	</param>
11230	<param name="formats" type="wstring" dir="in" safearray="yes">
11231	<desc>The supported mime types.</desc>
11232	</param>
11233	<param name="resultAction" type="DragAndDropAction" dir="return">
11234	<desc>The resulting action of this event.</desc>
11235	</param>
11236	</method>
11237
11238	<method name="dragHGMove">
11239	<desc>
11240	Informs the guest about a Drag and Drop move event.
11241
11242	This is used in Host - Guest direction.
11243
11244	<result name="VBOX_E_VM_ERROR">
11245	VMM device is not available.
11246	</result>
11247
11248	</desc>
11249	<param name="screenId" type="unsigned long" dir="in">
11250	<desc>The screen id where the Drag and Drop event occured.</desc>
11251	</param>
11252	<param name="x" type="unsigned long" dir="in">
11253	<desc>x-position of the event.</desc>
11254	</param>
11255	<param name="y" type="unsigned long" dir="in">
11256	<desc>y-position of the event.</desc>
11257	</param>
11258	<param name="defaultAction" type="DragAndDropAction" dir="in">
11259	<desc>The default action to use.</desc>
11260	</param>
11261	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11262	<desc>The actions which are allowed.</desc>
11263	</param>
11264	<param name="formats" type="wstring" dir="in" safearray="yes">
11265	<desc>The supported mime types.</desc>
11266	</param>
11267	<param name="resultAction" type="DragAndDropAction" dir="return">
11268	<desc>The resulting action of this event.</desc>
11269	</param>
11270	</method>
11271
11272	<method name="dragHGLeave">
11273	<desc>
11274	Informs the guest about a Drag and Drop leave event.
11275
11276	This is used in Host - Guest direction.
11277
11278	<result name="VBOX_E_VM_ERROR">
11279	VMM device is not available.
11280	</result>
11281
11282	</desc>
11283	<param name="screenId" type="unsigned long" dir="in">
11284	<desc>The screen id where the Drag and Drop event occured.</desc>
11285	</param>
11286	</method>
11287
11288	<method name="dragHGDrop">
11289	<desc>
11290	Informs the guest about a drop event.
11291
11292	This is used in Host - Guest direction.
11293
11294	<result name="VBOX_E_VM_ERROR">
11295	VMM device is not available.
11296	</result>
11297
11298	</desc>
11299	<param name="screenId" type="unsigned long" dir="in">
11300	<desc>The screen id where the Drag and Drop event occured.</desc>
11301	</param>
11302	<param name="x" type="unsigned long" dir="in">
11303	<desc>x-position of the event.</desc>
11304	</param>
11305	<param name="y" type="unsigned long" dir="in">
11306	<desc>y-position of the event.</desc>
11307	</param>
11308	<param name="defaultAction" type="DragAndDropAction" dir="in">
11309	<desc>The default action to use.</desc>
11310	</param>
11311	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11312	<desc>The actions which are allowed.</desc>
11313	</param>
11314	<param name="formats" type="wstring" dir="in" safearray="yes">
11315	<desc>The supported mime types.</desc>
11316	</param>
11317	<param name="format" type="wstring" dir="out">
11318	<desc>The resulting format of this event.</desc>
11319	</param>
11320	<param name="resultAction" type="DragAndDropAction" dir="return">
11321	<desc>The resulting action of this event.</desc>
11322	</param>
11323	</method>
11324
11325	<method name="dragHGPutData">
11326	<desc>
11327	Informs the guest about a drop data event.
11328
11329	This is used in Host - Guest direction.
11330
11331	<result name="VBOX_E_VM_ERROR">
11332	VMM device is not available.
11333	</result>
11334
11335	</desc>
11336	<param name="screenId" type="unsigned long" dir="in">
11337	<desc>The screen id where the Drag and Drop event occured.</desc>
11338	</param>
11339	<param name="format" type="wstring" dir="in">
11340	<desc>The mime type the data is in.</desc>
11341	</param>
11342	<param name="data" type="octet" dir="in" safearray="yes">
11343	<desc>The actual data.</desc>
11344	</param>
11345	<param name="progress" type="IProgress" dir="return">
11346	<desc>Progress object to track the operation completion.</desc>
11347	</param>
11348	</method>
11349
11350	<method name="dragGHPending">
11351	<desc>
11352	Ask the guest if there is any Drag and Drop operation pending in the guest.
11353
11354	If no Drag and Drop operation is pending currently, Ignore is returned.
11355
11356	This is used in Guest - Host direction.
11357
11358	<result name="VBOX_E_VM_ERROR">
11359	VMM device is not available.
11360	</result>
11361
11362	</desc>
11363	<param name="screenId" type="unsigned long" dir="in">
11364	<desc>The screen id where the Drag and Drop event occured.</desc>
11365	</param>
11366	<param name="formats" type="wstring" dir="out" safearray="yes">
11367	<desc>On return the supported mime types.</desc>
11368	</param>
11369	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
11370	<desc>On return the actions which are allowed.</desc>
11371	</param>
11372	<param name="defaultAction" type="DragAndDropAction" dir="return">
11373	<desc>On return the default action to use.</desc>
11374	</param>
11375	</method>
11376
11377	<method name="dragGHDropped">
11378	<desc>
11379	Informs the guest that a drop event occured for a pending Drag and Drop event.
11380
11381	This is used in Guest - Host direction.
11382
11383	<result name="VBOX_E_VM_ERROR">
11384	VMM device is not available.
11385	</result>
11386
11387	</desc>
11388
11389	<param name="format" type="wstring" dir="in">
11390	<desc>The mime type the data must be in.</desc>
11391	</param>
11392	<param name="action" type="DragAndDropAction" dir="in">
11393	<desc>The action to use.</desc>
11394	</param>
11395	<param name="progress" type="IProgress" dir="return">
11396	<desc>Progress object to track the operation completion.</desc>
11397	</param>
11398	</method>
11399
11400	<method name="dragGHGetData">
11401	<desc>
11402	Fetch the data of a previously Drag and Drop event from the guest.
11403
11404	This is used in Guest - Host direction.
11405
11406	<result name="VBOX_E_VM_ERROR">
11407	VMM device is not available.
11408	</result>
11409
11410	</desc>
11411
11412	<param name="data" type="octet" safearray="yes" dir="return">
11413	<desc>The actual data.</desc>
11414	</param>
11415	</method>
11416
11417	<method name="createSession">
11418	<desc>
11419	Creates a new guest session for controlling the guest.
11420
11421	A guest session represents one impersonated user account on the guest, so
11422	every operation will use the same credentials specified when creating
11423	the session object via <link to="IGuest::createSession"/>. Anonymous
11424	sessions, that is, sessions without specifying a valid
11425	user account on the guest are not allowed due to security reasons.
11426
11427	There can be a maximum of 32 sessions at once per VM. Each session keeps
11428	track of its started guest processes, opened guest files or guest directories.
11429	To work on guest files or directories a guest session offers methods to open
11430	or create such objects (see <link to="IGuestSession::fileOpen"/> or
11431	<link to="IGuestSession::directoryOpen"/> for example).
11432
11433	When done with either of these objects, including the guest session itself,
11434	use the appropriate close() method to let the object do its cleanup work.
11435
11436	Every guest session has its own environment variable block which gets
11437	automatically applied when starting a new guest process via
11438	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
11439	To override (or unset) certain environment variables already set by the
11440	guest session, one can specify a per-process environment block when using
11441	one of the both above mentioned process creation calls.
11442
11443	Closing a session via <link to="IGuestSession::close" /> will try to close
11444	all the mentioned objects above unless these objects are still used by
11445	a client.
11446	</desc>
11447	<param name="user" type="wstring" dir="in">
11448	<desc>
11449	User name this session will be using to control the guest; has to exist
11450	and have the appropriate rights to execute programs in the VM. Must not
11451	be empty.
11452	</desc>
11453	</param>
11454	<param name="password" type="wstring" dir="in">
11455	<desc>
11456	Password of the user account to be used. Empty passwords are allowed.
11457	</desc>
11458	</param>
11459	<param name="domain" type="wstring" dir="in">
11460	<desc>
11461	Domain name of the user account to be used if the guest is part of
11462	a domain. Optional. This feature is not implemented yet.
11463	</desc>
11464	</param>
11465	<param name="sessionName" type="wstring" dir="in">
11466	<desc>
11467	The session's friendly name. Optional, can be empty.
11468	</desc>
11469	</param>
11470	<param name="guestSession" type="IGuestSession" dir="return">
11471	<desc>
11472	The newly created session object.
11473	</desc>
11474	</param>
11475	</method>
11476
11477	<method name="findSession">
11478	<desc>
11479	Finds guest sessions by their friendly name and returns an interface
11480	array with all found guest sessions.
11481	</desc>
11482	<param name="sessionName" type="wstring" dir="in">
11483	<desc>
11484	The session's friendly name to find. Wildcards like ? and * are allowed.
11485	</desc>
11486	</param>
11487	<param name="sessions" type="IGuestSession" safearray="yes" dir="return">
11488	<desc>
11489	Array with all guest sessions found matching the name specified.
11490	</desc>
11491	</param>
11492	</method>
11493
11494	<method name="updateGuestAdditions">
11495	<desc>
11496	Automatically updates already installed Guest Additions in a VM.
11497
11498	At the moment only Windows guests are supported.
11499
11500	Because the VirtualBox Guest Additions drivers are not WHQL-certified
11501	yet there might be warning dialogs during the actual Guest Additions
11502	update. These need to be confirmed manually in order to continue the
11503	installation process. This applies to Windows 2000 and Windows XP guests
11504	and therefore these guests can't be updated in a fully automated fashion
11505	without user interaction. However, to start a Guest Additions update for
11506	the mentioned Windows versions anyway, the flag
11507	AdditionsUpdateFlag_WaitForUpdateStartOnly can be specified. See
11508	<link to="AdditionsUpdateFlag"/> for more information.
11509
11510	<result name="VBOX_E_NOT_SUPPORTED">
11511	Guest OS is not supported for automated Guest Additions updates or the
11512	already installed Guest Additions are not ready yet.
11513	</result>
11514
11515	<result name="VBOX_E_IPRT_ERROR">
11516	Error while updating.
11517	</result>
11518
11519	</desc>
11520	<param name="source" type="wstring" dir="in">
11521	<desc>
11522	Path to the Guest Additions .ISO file to use for the upate.
11523	</desc>
11524	</param>
11525	<param name="flags" type="AdditionsUpdateFlag" dir="in" safearray="yes">
11526	<desc>
11527	<link to="AdditionsUpdateFlag"/> flags.
11528	</desc>
11529	</param>
11530	<param name="progress" type="IProgress" dir="return">
11531	<desc>Progress object to track the operation completion.</desc>
11532	</param>
11533	</method>
11534
11535	</interface>
11536
11537
11538	<!--
11539	// IProgress
11540	/////////////////////////////////////////////////////////////////////////
11541	-->
11542
11543	<interface
11544	name="IProgress" extends="$unknown"
11545	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
11546	wsmap="managed"
11547	>
11548	<desc>
11549	The IProgress interface is used to track and control
11550	asynchronous tasks within VirtualBox.
11551
11552	An instance of this is returned every time VirtualBox starts
11553	an asynchronous task (in other words, a separate thread) which
11554	continues to run after a method call returns. For example,
11555	<link to="IConsole::saveState" />, which saves the state of
11556	a running virtual machine, can take a long time to complete.
11557	To be able to display a progress bar, a user interface such as
11558	the VirtualBox graphical user interface can use the IProgress
11559	object returned by that method.
11560
11561	Note that IProgress is a "read-only" interface in the sense
11562	that only the VirtualBox internals behind the Main API can
11563	create and manipulate progress objects, whereas client code
11564	can only use the IProgress object to monitor a task's
11565	progress and, if <link to="#cancelable" /> is @c true,
11566	cancel the task by calling <link to="#cancel" />.
11567
11568	A task represented by IProgress consists of either one or
11569	several sub-operations that run sequentially, one by one (see
11570	<link to="#operation" /> and <link to="#operationCount" />).
11571	Every operation is identified by a number (starting from 0)
11572	and has a separate description.
11573
11574	You can find the individual percentage of completion of the current
11575	operation in <link to="#operationPercent" /> and the
11576	percentage of completion of the task as a whole
11577	in <link to="#percent" />.
11578
11579	Similarly, you can wait for the completion of a particular
11580	operation via <link to="#waitForOperationCompletion" /> or
11581	for the completion of the whole task via
11582	<link to="#waitForCompletion" />.
11583	</desc>
11584
11585	<attribute name="id" type="uuid" mod="string" readonly="yes">
11586	<desc>ID of the task.</desc>
11587	</attribute>
11588
11589	<attribute name="description" type="wstring" readonly="yes">
11590	<desc>Description of the task.</desc>
11591	</attribute>
11592
11593	<attribute name="initiator" type="$unknown" readonly="yes">
11594	<desc>Initiator of the task.</desc>
11595	</attribute>
11596
11597	<attribute name="cancelable" type="boolean" readonly="yes">
11598	<desc>Whether the task can be interrupted.</desc>
11599	</attribute>
11600
11601	<attribute name="percent" type="unsigned long" readonly="yes">
11602	<desc>
11603	Current progress value of the task as a whole, in percent.
11604	This value depends on how many operations are already complete.
11605	Returns 100 if <link to="#completed" /> is @c true.
11606	</desc>
11607	</attribute>
11608
11609	<attribute name="timeRemaining" type="long" readonly="yes">
11610	<desc>
11611	Estimated remaining time until the task completes, in
11612	seconds. Returns 0 once the task has completed; returns -1
11613	if the remaining time cannot be computed, in particular if
11614	the current progress is 0.
11615
11616	Even if a value is returned, the estimate will be unreliable
11617	for low progress values. It will become more reliable as the
11618	task progresses; it is not recommended to display an ETA
11619	before at least 20% of a task have completed.
11620	</desc>
11621	</attribute>
11622
11623	<attribute name="completed" type="boolean" readonly="yes">
11624	<desc>Whether the task has been completed.</desc>
11625	</attribute>
11626
11627	<attribute name="canceled" type="boolean" readonly="yes">
11628	<desc>Whether the task has been canceled.</desc>
11629	</attribute>
11630
11631	<attribute name="resultCode" type="long" readonly="yes">
11632	<desc>
11633	Result code of the progress task.
11634	Valid only if <link to="#completed"/> is @c true.
11635	</desc>
11636	</attribute>
11637
11638	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
11639	<desc>
11640	Extended information about the unsuccessful result of the
11641	progress operation. May be @c null if no extended information
11642	is available.
11643	Valid only if <link to="#completed"/> is @c true and
11644	<link to="#resultCode"/> indicates a failure.
11645	</desc>
11646	</attribute>
11647
11648	<attribute name="operationCount" type="unsigned long" readonly="yes">
11649	<desc>
11650	Number of sub-operations this task is divided into.
11651	Every task consists of at least one suboperation.
11652	</desc>
11653	</attribute>
11654
11655	<attribute name="operation" type="unsigned long" readonly="yes">
11656	<desc>Number of the sub-operation being currently executed.</desc>
11657	</attribute>
11658
11659	<attribute name="operationDescription" type="wstring" readonly="yes">
11660	<desc>
11661	Description of the sub-operation being currently executed.
11662	</desc>
11663	</attribute>
11664
11665	<attribute name="operationPercent" type="unsigned long" readonly="yes">
11666	<desc>Progress value of the current sub-operation only, in percent.</desc>
11667	</attribute>
11668
11669	<attribute name="operationWeight" type="unsigned long" readonly="yes">
11670	<desc>Weight value of the current sub-operation only.</desc>
11671	</attribute>
11672
11673	<attribute name="timeout" type="unsigned long">
11674	<desc>
11675	When non-zero, this specifies the number of milliseconds after which
11676	the operation will automatically be canceled. This can only be set on
11677	cancelable objects.
11678	</desc>
11679	</attribute>
11680
11681	<method name="setCurrentOperationProgress">
11682	<desc>Internal method, not to be called externally.</desc>
11683	<param name="percent" type="unsigned long" dir="in" />
11684	</method>
11685	<method name="setNextOperation">
11686	<desc>Internal method, not to be called externally.</desc>
11687	<param name="nextOperationDescription" type="wstring" dir="in" />
11688	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
11689	</method>
11690
11691	<method name="waitForCompletion">
11692	<desc>
11693	Waits until the task is done (including all sub-operations)
11694	with a given timeout in milliseconds; specify -1 for an indefinite wait.
11695
11696	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
11697	thread are not processed while waiting. Neglecting event queues may
11698	have dire consequences (degrade performance, resource hogs,
11699	deadlocks, etc.), this is specially so for the main thread on
11700	platforms using XPCOM. Callers are adviced wait for short periods
11701	and service their event queues between calls, or to create a worker
11702	thread to do the waiting.
11703
11704	<result name="VBOX_E_IPRT_ERROR">
11705	Failed to wait for task completion.
11706	</result>
11707	</desc>
11708
11709	<param name="timeout" type="long" dir="in">
11710	<desc>
11711	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11712	</desc>
11713	</param>
11714	</method>
11715
11716	<method name="waitForOperationCompletion">
11717	<desc>
11718	Waits until the given operation is done with a given timeout in
11719	milliseconds; specify -1 for an indefinite wait.
11720
11721	See <link to="#waitForCompletion"> for event queue considerations.</link>
11722
11723	<result name="VBOX_E_IPRT_ERROR">
11724	Failed to wait for operation completion.
11725	</result>
11726
11727	</desc>
11728	<param name="operation" type="unsigned long" dir="in">
11729	<desc>
11730	Number of the operation to wait for.
11731	Must be less than <link to="#operationCount"/>.
11732	</desc>
11733	</param>
11734	<param name="timeout" type="long" dir="in">
11735	<desc>
11736	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11737	</desc>
11738	</param>
11739	</method>
11740
11741	<method name="waitForAsyncProgressCompletion">
11742	<desc>
11743	Waits until the other task is completed (including all
11744	sub-operations) and forward all changes from the other progress to
11745	this progress. This means sub-operation number, description, percent
11746	and so on.
11747
11748	You have to take care on setting up at least the same count on
11749	sub-operations in this progress object like there are in the other
11750	progress object.
11751
11752	If the other progress object supports cancel and this object gets any
11753	cancel request (when here enabled as well), it will be forwarded to
11754	the other progress object.
11755
11756	If there is an error in the other progress, this error isn't
11757	automatically transfered to this progress object. So you have to
11758	check any operation error within the other progress object, after
11759	this method returns.
11760	</desc>
11761
11762	<param name="pProgressAsync" type="IProgress" dir="in">
11763	<desc>
11764	The progress object of the asynchrony process.
11765	</desc>
11766	</param>
11767	</method>
11768
11769	<method name="cancel">
11770	<desc>
11771	Cancels the task.
11772	<note>
11773	If <link to="#cancelable"/> is @c false, then this method will fail.
11774	</note>
11775
11776	<result name="VBOX_E_INVALID_OBJECT_STATE">
11777	Operation cannot be canceled.
11778	</result>
11779
11780	</desc>
11781	</method>
11782
11783	</interface>
11784
11785	<!--
11786	// ISnapshot
11787	/////////////////////////////////////////////////////////////////////////
11788	-->
11789
11790	<interface
11791	name="ISnapshot" extends="$unknown"
11792	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
11793	wsmap="managed"
11794	>
11795	<desc>
11796	The ISnapshot interface represents a snapshot of the virtual
11797	machine.
11798
11799	Together with the differencing media that are created
11800	when a snapshot is taken, a machine can be brought back to
11801	the exact state it was in when the snapshot was taken.
11802
11803	The ISnapshot interface has no methods, only attributes; snapshots
11804	are controlled through methods of the <link to="IConsole" /> interface
11805	which also manage the media associated with the snapshot.
11806	The following operations exist:
11807
11808	<ul>
11809	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
11810	by creating new, empty differencing images for the machine's
11811	media and saving the VM settings and (if the VM is running)
11812	the current VM state in the snapshot.
11813
11814	The differencing images will then receive all data written to
11815	the machine's media, while their parent (base) images
11816	remain unmodified after the snapshot has been taken (see
11817	<link to="IMedium" /> for details about differencing images).
11818	This simplifies restoring a machine to the state of a snapshot:
11819	only the differencing images need to be deleted.
11820
11821	The current machine state is not changed by taking a snapshot
11822	except that <link to="IMachine::currentSnapshot" /> is set to
11823	the newly created snapshot, which is also added to the machine's
11824	snapshots tree.
11825	</li>
11826
11827	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
11828	the state of a previous snapshot by deleting the differencing
11829	image of each of the machine's media and setting the machine's
11830	settings and state to the state that was saved in the snapshot (if any).
11831
11832	This destroys the machine's current state. After calling this,
11833	<link to="IMachine::currentSnapshot" /> points to the snapshot
11834	that was restored.
11835	</li>
11836
11837	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
11838	without affecting the current machine state.
11839
11840	This does not change the current machine state, but instead frees the
11841	resources allocated when the snapshot was taken: the settings and machine
11842	state file are deleted (if any), and the snapshot's differencing image for
11843	each of the machine's media gets merged with its parent image.
11844
11845	Neither the current machine state nor other snapshots are affected
11846	by this operation, except that parent media will be modified
11847	to contain the disk data associated with the snapshot being deleted.
11848
11849	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
11850	attribute is set to the current snapshot's parent or @c null if it
11851	has no parent. Otherwise the attribute is unchanged.
11852	</li>
11853	</ul>
11854
11855	Each snapshot contains a copy of virtual machine's settings (hardware
11856	configuration etc.). This copy is contained in an immutable (read-only)
11857	instance of <link to="IMachine" /> which is available from the snapshot's
11858	<link to="#machine" /> attribute. When restoring the snapshot, these
11859	settings are copied back to the original machine.
11860
11861	In addition, if the machine was running when the
11862	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
11863	the current VM state is saved in the snapshot (similarly to what happens
11864	when a VM's state is saved). The snapshot is then said to be <i>online</i>
11865	because when restoring it, the VM will be running.
11866
11867	If the machine was in <link to="MachineState_Saved">saved</link> saved,
11868	the snapshot receives a copy of the execution state file
11869	(<link to="IMachine::stateFilePath"/>).
11870
11871	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
11872	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
11873	it then contains a so-called "zero execution state", representing a
11874	machine that is powered off.
11875	</desc>
11876
11877	<attribute name="id" type="uuid" mod="string" readonly="yes">
11878	<desc>UUID of the snapshot.</desc>
11879	</attribute>
11880
11881	<attribute name="name" type="wstring">
11882	<desc>Short name of the snapshot.
11883	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
11884	be called implicitly.</note>
11885	</desc>
11886	</attribute>
11887
11888	<attribute name="description" type="wstring">
11889	<desc>Optional description of the snapshot.
11890	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
11891	be called implicitly.</note>
11892	</desc>
11893	</attribute>
11894
11895	<attribute name="timeStamp" type="long long" readonly="yes">
11896	<desc>
11897	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
11898	</desc>
11899	</attribute>
11900
11901	<attribute name="online" type="boolean" readonly="yes">
11902	<desc>
11903	@c true if this snapshot is an online snapshot and @c false otherwise.
11904
11905	When this attribute is @c true, the
11906	<link to="IMachine::stateFilePath"/> attribute of the
11907	<link to="#machine"/> object associated with this snapshot
11908	will point to the saved state file. Otherwise, it will be
11909	an empty string.
11910	</desc>
11911	</attribute>
11912
11913	<attribute name="machine" type="IMachine" readonly="yes">
11914	<desc>
11915	Virtual machine this snapshot is taken on. This object
11916	stores all settings the machine had when taking this snapshot.
11917	<note>
11918	The returned machine object is immutable, i.e. no
11919	any settings can be changed.
11920	</note>
11921	</desc>
11922	</attribute>
11923
11924	<attribute name="parent" type="ISnapshot" readonly="yes">
11925	<desc>
11926	Parent snapshot (a snapshot this one is based on), or
11927	@c null if the snapshot has no parent (i.e. is the first snapshot).
11928	</desc>
11929	</attribute>
11930
11931	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
11932	<desc>
11933	Child snapshots (all snapshots having this one as a parent).
11934	By inspecting this attribute starting with a machine's root snapshot
11935	(which can be obtained by calling <link to="IMachine::findSnapshot" />
11936	with a @c null UUID), a machine's snapshots tree can be iterated over.
11937	</desc>
11938	</attribute>
11939
11940	<method name="getChildrenCount" const="yes">
11941	<desc>
11942	Returns the number of direct childrens of this snapshot.
11943	</desc>
11944	<param name="childrenCount" type="unsigned long" dir="return">
11945	<desc>
11946	</desc>
11947	</param>
11948	</method>
11949
11950	</interface>
11951
11952
11953	<!--
11954	// IMedium
11955	/////////////////////////////////////////////////////////////////////////
11956	-->
11957
11958	<enum
11959	name="MediumState"
11960	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
11961	>
11962	<desc>
11963	Virtual medium state.
11964	<see><link to="IMedium"/></see>
11965	</desc>
11966
11967	<const name="NotCreated" value="0">
11968	<desc>
11969	Associated medium storage does not exist (either was not created yet or
11970	was deleted).
11971	</desc>
11972	</const>
11973	<const name="Created" value="1">
11974	<desc>
11975	Associated storage exists and accessible; this gets set if the
11976	accessibility check performed by <link to="IMedium::refreshState" />
11977	was successful.
11978	</desc>
11979	</const>
11980	<const name="LockedRead" value="2">
11981	<desc>
11982	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
11983	no data modification is possible.
11984	</desc>
11985	</const>
11986	<const name="LockedWrite" value="3">
11987	<desc>
11988	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
11989	no concurrent data reading or modification is possible.
11990	</desc>
11991	</const>
11992	<const name="Inaccessible" value="4">
11993	<desc>
11994	Medium accessibility check (see <link to="IMedium::refreshState" />) has
11995	not yet been performed, or else, associated medium storage is not
11996	accessible. In the first case, <link to="IMedium::lastAccessError"/>
11997	is empty, in the second case, it describes the error that occurred.
11998	</desc>
11999	</const>
12000	<const name="Creating" value="5">
12001	<desc>
12002	Associated medium storage is being created.
12003	</desc>
12004	</const>
12005	<const name="Deleting" value="6">
12006	<desc>
12007	Associated medium storage is being deleted.
12008	</desc>
12009	</const>
12010	</enum>
12011
12012	<enum
12013	name="MediumType"
12014	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
12015	>
12016	<desc>
12017	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
12018	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
12019	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
12020	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
12021	</desc>
12022
12023	<const name="Normal" value="0">
12024	<desc>
12025	Normal medium (attached directly or indirectly, preserved
12026	when taking snapshots).
12027	</desc>
12028	</const>
12029	<const name="Immutable" value="1">
12030	<desc>
12031	Immutable medium (attached indirectly, changes are wiped out
12032	the next time the virtual machine is started).
12033	</desc>
12034	</const>
12035	<const name="Writethrough" value="2">
12036	<desc>
12037	Write through medium (attached directly, ignored when
12038	taking snapshots).
12039	</desc>
12040	</const>
12041	<const name="Shareable" value="3">
12042	<desc>
12043	Allow using this medium concurrently by several machines.
12044	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
12045	</desc>
12046	</const>
12047	<const name="Readonly" value="4">
12048	<desc>
12049	A readonly medium, which can of course be used by several machines.
12050	<note>Present and accepted since VirtualBox 4.0.</note>
12051	</desc>
12052	</const>
12053	<const name="MultiAttach" value="5">
12054	<desc>
12055	A medium which is indirectly attached, so that one base medium can
12056	be used for several VMs which have their own differencing medium to
12057	store their modifications. In some sense a variant of Immutable
12058	with unset AutoReset flag in each differencing medium.
12059	<note>Present and accepted since VirtualBox 4.0.</note>
12060	</desc>
12061	</const>
12062	</enum>
12063
12064	<enum
12065	name="MediumVariant"
12066	uuid="80685b6b-e42f-497d-8271-e77bf3c61ada"
12067	>
12068	<desc>
12069	Virtual medium image variant. More than one flag may be set.
12070	<see><link to="IMedium"/></see>
12071	</desc>
12072
12073	<const name="Standard" value="0">
12074	<desc>
12075	No particular variant requested, results in using the backend default.
12076	</desc>
12077	</const>
12078	<const name="VmdkSplit2G" value="0x01">
12079	<desc>
12080	VMDK image split in chunks of less than 2GByte.
12081	</desc>
12082	</const>
12083	<const name="VmdkRawDisk" value="0x02">
12084	<desc>
12085	VMDK image representing a raw disk.
12086	</desc>
12087	</const>
12088	<const name="VmdkStreamOptimized" value="0x04">
12089	<desc>
12090	VMDK streamOptimized image. Special import/export format which is
12091	read-only/append-only.
12092	</desc>
12093	</const>
12094	<const name="VmdkESX" value="0x08">
12095	<desc>
12096	VMDK format variant used on ESX products.
12097	</desc>
12098	</const>
12099	<const name="Fixed" value="0x10000">
12100	<desc>
12101	Fixed image. Only allowed for base images.
12102	</desc>
12103	</const>
12104	<const name="Diff" value="0x20000">
12105	<desc>
12106	Differencing image. Only allowed for child images.
12107	</desc>
12108	</const>
12109	<const name="NoCreateDir" value="0x40000000">
12110	<desc>
12111	Special flag which suppresses automatic creation of the subdirectory.
12112	Only used when passing the medium variant as an input parameter.
12113	</desc>
12114	</const>
12115	</enum>
12116
12117	<interface
12118	name="IMediumAttachment" extends="$unknown"
12119	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
12120	wsmap="struct"
12121	>
12122	<desc>
12123	The IMediumAttachment interface links storage media to virtual machines.
12124	For each medium (<link to="IMedium"/>) which has been attached to a
12125	storage controller (<link to="IStorageController"/>) of a machine
12126	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
12127	method, one instance of IMediumAttachment is added to the machine's
12128	<link to="IMachine::mediumAttachments"/> array attribute.
12129
12130	Each medium attachment specifies the storage controller as well as a
12131	port and device number and the IMedium instance representing a virtual
12132	hard disk or floppy or DVD image.
12133
12134	For removable media (DVDs or floppies), there are two additional
12135	options. For one, the IMedium instance can be @c null to represent
12136	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
12137	secondly, the medium can be one of the pseudo-media for host drives
12138	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
12139
12140	<h3>Attaching Hard Disks</h3>
12141
12142	Hard disks are attached to virtual machines using the
12143	<link to="IMachine::attachDevice"/> method and detached using the
12144	<link to="IMachine::detachDevice"/> method. Depending on a medium's
12145	type (see <link to="IMedium::type" />), hard disks are attached either
12146	<i>directly</i> or <i>indirectly</i>.
12147
12148	When a hard disk is being attached directly, it is associated with the
12149	virtual machine and used for hard disk operations when the machine is
12150	running. When a hard disk is being attached indirectly, a new differencing
12151	hard disk linked to it is implicitly created and this differencing hard
12152	disk is associated with the machine and used for hard disk operations.
12153	This also means that if <link to="IMachine::attachDevice"/> performs
12154	a direct attachment then the same hard disk will be returned in response
12155	to the subsequent <link to="IMachine::getMedium"/> call; however if
12156	an indirect attachment is performed then
12157	<link to="IMachine::getMedium"/> will return the implicitly created
12158	differencing hard disk, not the original one passed to <link
12159	to="IMachine::attachDevice"/>. In detail:
12160
12161	<ul>
12162	<li><b>Normal base</b> hard disks that do not have children (i.e.
12163	differencing hard disks linked to them) and that are not already
12164	attached to virtual machines in snapshots are attached <b>directly</b>.
12165	Otherwise, they are attached <b>indirectly</b> because having
12166	dependent children or being part of the snapshot makes it impossible
12167	to modify hard disk contents without breaking the integrity of the
12168	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
12169	quickly determine the kind of the attachment for the given hard
12170	disk. Note that if a normal base hard disk is to be indirectly
12171	attached to a virtual machine with snapshots then a special
12172	procedure called <i>smart attachment</i> is performed (see below).</li>
12173	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
12174	they are attached <b>directly</b> if they do not have children and are
12175	not attached to virtual machines in snapshots, and <b>indirectly</b>
12176	otherwise. Note that the smart attachment procedure is never performed
12177	for differencing hard disks.</li>
12178	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
12179	they are designed to be non-writable. If an immutable hard disk is
12180	attached to a virtual machine with snapshots then a special
12181	procedure called smart attachment is performed (see below).</li>
12182	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
12183	also as designed. This also means that writethrough hard disks cannot
12184	have other hard disks linked to them at all.</li>
12185	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
12186	also as designed. This also means that shareable hard disks cannot
12187	have other hard disks linked to them at all. They behave almost
12188	like writethrough hard disks, except that shareable hard disks can
12189	be attached to several virtual machines which are running, allowing
12190	concurrent accesses. You need special cluster software running in
12191	the virtual machines to make use of such disks.</li>
12192	</ul>
12193
12194	Note that the same hard disk, regardless of its type, may be attached to
12195	more than one virtual machine at a time. In this case, the machine that is
12196	started first gains exclusive access to the hard disk and attempts to
12197	start other machines having this hard disk attached will fail until the
12198	first machine is powered down.
12199
12200	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
12201	that the given hard disk remains associated with the given machine after a
12202	successful <link to="IMachine::detachDevice"/> call until
12203	<link to="IMachine::saveSettings"/> is called to save all changes to
12204	machine settings to disk. This deferring is necessary to guarantee that
12205	the hard disk configuration may be restored at any time by a call to
12206	<link to="IMachine::discardSettings"/> before the settings
12207	are saved (committed).
12208
12209	Note that if <link to="IMachine::discardSettings"/> is called after
12210	indirectly attaching some hard disks to the machine but before a call to
12211	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
12212	all differencing hard disks implicitly created by
12213	<link to="IMachine::attachDevice"/> for these indirect attachments.
12214	Such implicitly created hard disks will also be immediately deleted when
12215	detached explicitly using the <link to="IMachine::detachDevice"/>
12216	call if it is made before <link to="IMachine::saveSettings"/>. This
12217	implicit deletion is safe because newly created differencing hard
12218	disks do not contain any user data.
12219
12220	However, keep in mind that detaching differencing hard disks that were
12221	implicitly created by <link to="IMachine::attachDevice"/>
12222	before the last <link to="IMachine::saveSettings"/> call will
12223	<b>not</b> implicitly delete them as they may already contain some data
12224	(for example, as a result of virtual machine execution). If these hard
12225	disks are no more necessary, the caller can always delete them explicitly
12226	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
12227	from this machine by the <link to="IMachine::saveSettings"/> call.
12228
12229	<h3>Smart Attachment</h3>
12230
12231	When normal base or immutable hard disks are indirectly attached to a
12232	virtual machine then some additional steps are performed to make sure the
12233	virtual machine will have the most recent "view" of the hard disk being
12234	attached. These steps include walking through the machine's snapshots
12235	starting from the current one and going through ancestors up to the first
12236	snapshot. Hard disks attached to the virtual machine in all
12237	of the encountered snapshots are checked whether they are descendants of
12238	the given normal base or immutable hard disk. The first found child (which
12239	is the differencing hard disk) will be used instead of the normal base or
12240	immutable hard disk as a parent for creating a new differencing hard disk
12241	that will be actually attached to the machine. And only if no descendants
12242	are found or if the virtual machine does not have any snapshots then the
12243	normal base or immutable hard disk will be used itself as a parent for
12244	this differencing hard disk.
12245
12246	It is easier to explain what smart attachment does using the
12247	following example:
12248	<pre>
12249	BEFORE attaching B.vdi: AFTER attaching B.vdi:
12250
12251	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
12252	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
12253	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
12254	Snapshot 4 (none) Snapshot 4 (none)
12255	CurState (none) CurState (D3->D2.vdi)
12256
12257	NOT
12258	...
12259	CurState (D3->B.vdi)
12260	</pre>
12261	The first column is the virtual machine configuration before the base hard
12262	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
12263	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
12264	mean that the hard disk that is actually attached to the machine is a
12265	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
12266	another hard disk, <tt>B.vdi</tt>.
12267
12268	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
12269	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
12270	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
12271	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
12272	it cannot be attached directly and needs an indirect attachment (i.e.
12273	implicit creation of a new differencing hard disk). Due to the smart
12274	attachment procedure, the new differencing hard disk
12275	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
12276	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
12277	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
12278	machine.
12279
12280	Note that if there is more than one descendant hard disk of the given base
12281	hard disk found in a snapshot, and there is an exact device, channel and
12282	bus match, then this exact match will be used. Otherwise, the youngest
12283	descendant will be picked up.
12284
12285	There is one more important aspect of the smart attachment procedure which
12286	is not related to snapshots at all. Before walking through the snapshots
12287	as described above, the backup copy of the current list of hard disk
12288	attachment is searched for descendants. This backup copy is created when
12289	the hard disk configuration is changed for the first time after the last
12290	<link to="IMachine::saveSettings"/> call and used by
12291	<link to="IMachine::discardSettings"/> to undo the recent hard disk
12292	changes. When such a descendant is found in this backup copy, it will be
12293	simply re-attached back, without creating a new differencing hard disk for
12294	it. This optimization is necessary to make it possible to re-attach the
12295	base or immutable hard disk to a different bus, channel or device slot
12296	without losing the contents of the differencing hard disk actually
12297	attached to the machine in place of it.
12298
12299	</desc>
12300
12301	<attribute name="medium" type="IMedium" readonly="yes">
12302	<desc>Medium object associated with this attachment; it
12303	can be @c null for removable devices.</desc>
12304	</attribute>
12305
12306	<attribute name="controller" type="wstring" readonly="yes">
12307	<desc>Name of the storage controller of this attachment; this
12308	refers to one of the controllers in <link to="IMachine::storageControllers" />
12309	by name.</desc>
12310	</attribute>
12311
12312	<attribute name="port" type="long" readonly="yes">
12313	<desc>Port number of this attachment.
12314	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12315	</desc>
12316	</attribute>
12317
12318	<attribute name="device" type="long" readonly="yes">
12319	<desc>Device slot number of this attachment.
12320	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12321	</desc>
12322	</attribute>
12323
12324	<attribute name="type" type="DeviceType" readonly="yes">
12325	<desc>Device type of this attachment.</desc>
12326	</attribute>
12327
12328	<attribute name="passthrough" type="boolean" readonly="yes">
12329	<desc>Pass I/O requests through to a device on the host.</desc>
12330	</attribute>
12331
12332	<attribute name="temporaryEject" type="boolean" readonly="yes">
12333	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
12334	</attribute>
12335
12336	<attribute name="isEjected" type="boolean" readonly="yes">
12337	<desc>Signals that the removable medium has been ejected. This is not
12338	necessarily equivalent to having a @c null medium association.</desc>
12339	</attribute>
12340
12341	<attribute name="nonRotational" type="boolean" readonly="yes">
12342	<desc>Whether the associated medium is non-rotational.</desc>
12343	</attribute>
12344
12345	<attribute name="discard" type="boolean" readonly="yes">
12346	<desc>Whether the associated medium supports discarding unused blocks.</desc>
12347	</attribute>
12348
12349	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
12350	<desc>The bandwidth group this medium attachment is assigned to.</desc>
12351	</attribute>
12352
12353	</interface>
12354
12355	<interface
12356	name="IMedium" extends="$unknown"
12357	uuid="86fd6208-4c8c-40c2-a4e3-f6b47ac6ef07"
12358	wsmap="managed"
12359	>
12360	<desc>
12361	The IMedium interface represents virtual storage for a machine's
12362	hard disks, CD/DVD or floppy drives. It will typically represent
12363	a disk image on the host, for example a VDI or VMDK file representing
12364	a virtual hard disk, or an ISO or RAW file representing virtual
12365	removable media, but can also point to a network location (e.g.
12366	for iSCSI targets).
12367
12368	Instances of IMedium are connected to virtual machines by way of medium
12369	attachments, which link the storage medium to a particular device slot
12370	of a storage controller of the virtual machine.
12371	In the VirtualBox API, virtual storage is therefore always represented
12372	by the following chain of object links:
12373
12374	<ul>
12375	<li><link to="IMachine::storageControllers"/> contains an array of
12376	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
12377	these are instances of <link to="IStorageController"/>).</li>
12378	<li><link to="IMachine::mediumAttachments"/> contains an array of
12379	medium attachments (instances of <link to="IMediumAttachment"/>
12380	created by <link to="IMachine::attachDevice" />),
12381	each containing a storage controller from the above array, a
12382	port/device specification, and an instance of IMedium representing
12383	the medium storage (image file).
12384
12385	For removable media, the storage medium is optional; a medium
12386	attachment with no medium represents a CD/DVD or floppy drive
12387	with no medium inserted. By contrast, hard disk attachments
12388	will always have an IMedium object attached.</li>
12389	<li>Each IMedium in turn points to a storage unit (such as a file
12390	on the host computer or a network resource) that holds actual
12391	data. This location is represented by the <link to="#location"/>
12392	attribute.</li>
12393	</ul>
12394
12395	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
12396	new hard disk media can be created with the VirtualBox API using the
12397	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
12398	disks (see below) are usually implicitly created by VirtualBox as
12399	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
12400	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
12401	should be created with external tools and then opened from within VirtualBox.
12402
12403	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
12404	drive. In that case the <link to="#id" /> attribute contains the UUID of
12405	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
12406
12407	<h3>Media registries</h3>
12408
12409	When a medium has been opened or created using one of the aforementioned
12410	APIs, it becomes "known" to VirtualBox. Known media can be attached
12411	to virtual machines and re-found through <link to="IVirtualBox::openMedium"/>.
12412	They also appear in the global
12413	<link to="IVirtualBox::hardDisks" />,
12414	<link to="IVirtualBox::DVDImages" /> and
12415	<link to="IVirtualBox::floppyImages" /> arrays.
12416
12417	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
12418	in the VirtualBox.xml file, which was shared between all machines and made
12419	transporting machines and their media from one host to another difficult.
12420
12421	Starting with VirtualBox 4.0, media are only added to a registry when they are
12422	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
12423	backwards compatibility, which registry a medium is added to depends on which
12424	VirtualBox version created a machine:
12425
12426	<ul>
12427	<li>If the medium has first been attached to a machine which was created by
12428	VirtualBox 4.0 or later, it is added to that machine's media registry in
12429	the machine XML settings file. This way all information about a machine's
12430	media attachments is contained in a single file and can be transported
12431	easily.</li>
12432	<li>For older media attachments (i.e. if the medium was first attached to a
12433	machine which was created with a VirtualBox version before 4.0), media
12434	continue to be registered in the global VirtualBox settings file, for
12435	backwards compatibility.</li>
12436	</ul>
12437
12438	See <link to="IVirtualBox::openMedium" /> for more information.
12439
12440	Media are removed from media registries by the <link to="IMedium::close"/>,
12441	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
12442
12443	<h3>Accessibility checks</h3>
12444
12445	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
12446	method is called explicitly on a medium. This is done to make the VirtualBox object
12447	ready for serving requests as fast as possible and let the end-user
12448	application decide if it needs to check media accessibility right away or not.
12449
12450	As a result, when VirtualBox starts up (e.g. the VirtualBox
12451	object gets created for the first time), all known media are in the
12452	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
12453	attribute is an empty string because no actual accessibility check has
12454	been made yet.
12455
12456	After calling <link to="#refreshState" />, a medium is considered
12457	<i>accessible</i> if its storage unit can be read. In that case, the
12458	<link to="#state"/> attribute has a value of "Created". If the storage
12459	unit cannot be read (for example, because it is located on a disconnected
12460	network resource, or was accidentally deleted outside VirtualBox),
12461	the medium is considered <i>inaccessible</i>, which is indicated by the
12462	"Inaccessible" state. The exact reason why the medium is inaccessible can be
12463	obtained by reading the <link to="#lastAccessError"/> attribute.
12464
12465	<h3>Medium types</h3>
12466
12467	There are five types of medium behavior which are stored in the
12468	<link to="#type"/> attribute (see <link to="MediumType" />) and
12469	which define the medium's behavior with attachments and snapshots.
12470
12471	All media can be also divided in two groups: <i>base</i> media and
12472	<i>differencing</i> media. A base medium contains all sectors of the
12473	medium data in its own storage and therefore can be used independently.
12474	In contrast, a differencing medium is a "delta" to some other medium and
12475	contains only those sectors which differ from that other medium, which is
12476	then called a <i>parent</i>. The differencing medium is said to be
12477	<i>linked to</i> that parent. The parent may be itself a differencing
12478	medium, thus forming a chain of linked media. The last element in that
12479	chain must always be a base medium. Note that several differencing
12480	media may be linked to the same parent medium.
12481
12482	Differencing media can be distinguished from base media by querying the
12483	<link to="#parent"/> attribute: base media do not have parents they would
12484	depend on, so the value of this attribute is always @c null for them.
12485	Using this attribute, it is possible to walk up the medium tree (from the
12486	child medium to its parent). It is also possible to walk down the tree
12487	using the <link to="#children"/> attribute.
12488
12489	Note that the type of all differencing media is "normal"; all other
12490	values are meaningless for them. Base media may be of any type.
12491
12492	<h3>Automatic composition of the file name part</h3>
12493
12494	Another extension to the <link to="IMedium::location"/> attribute is that
12495	there is a possibility to cause VirtualBox to compose a unique value for
12496	the file name part of the location using the UUID of the hard disk. This
12497	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
12498	e.g. before the storage unit is created, and works as follows. You set the
12499	value of the <link to="IMedium::location"/> attribute to a location
12500	specification which only contains the path specification but not the file
12501	name part and ends with either a forward slash or a backslash character.
12502	In response, VirtualBox will generate a new UUID for the hard disk and
12503	compose the file name using the following pattern:
12504	<pre>
12505	<path>/{<uuid>}.<ext>
12506	</pre>
12507	where <tt><path></tt> is the supplied path specification,
12508	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
12509	is the default extension for the storage format of this hard disk. After
12510	that, you may call any of the methods that create a new hard disk storage
12511	unit and they will use the generated UUID and file name.
12512	</desc>
12513
12514	<attribute name="id" type="uuid" mod="string" readonly="yes">
12515	<desc>
12516	UUID of the medium. For a newly created medium, this value is a randomly
12517	generated UUID.
12518
12519	<note>
12520	For media in one of MediumState_NotCreated, MediumState_Creating or
12521	MediumState_Deleting states, the value of this property is undefined
12522	and will most likely be an empty UUID.
12523	</note>
12524	</desc>
12525	</attribute>
12526
12527	<attribute name="description" type="wstring">
12528	<desc>
12529	Optional description of the medium. For a newly created medium the value
12530	of this attribute is an empty string.
12531
12532	Medium types that don't support this attribute will return E_NOTIMPL in
12533	attempt to get or set this attribute's value.
12534
12535	<note>
12536	For some storage types, reading this attribute may return an outdated
12537	(last known) value when <link to="#state"/> is <link
12538	to="MediumState_Inaccessible"/> or <link
12539	to="MediumState_LockedWrite"/> because the value of this attribute is
12540	stored within the storage unit itself. Also note that changing the
12541	attribute value is not possible in such case, as well as when the
12542	medium is the <link to="MediumState_LockedRead"/> state.
12543	</note>
12544	</desc>
12545	</attribute>
12546
12547	<attribute name="state" type="MediumState" readonly="yes">
12548	<desc>
12549	Returns the current medium state, which is the last state set by
12550	the accessibility check performed by <link to="#refreshState"/>.
12551	If that method has not yet been called on the medium, the state
12552	is "Inaccessible"; as opposed to truly inaccessible media, the
12553	value of <link to="#lastAccessError"/> will be an empty string in
12554	that case.
12555
12556	<note>As of version 3.1, this no longer performs an accessibility check
12557	automatically; call <link to="#refreshState"/> for that.
12558	</note>
12559	</desc>
12560	</attribute>
12561
12562	<attribute name="variant" type="MediumVariant" safearray="yes" readonly="yes">
12563	<desc>
12564	Returns the storage format variant information for this medium
12565	as an aaray of the flags described at <link to="MediumVariant" />.
12566	Before <link to="#refreshState"/> is called this method returns
12567	an undefined value.
12568	</desc>
12569	</attribute>
12570
12571	<attribute name="location" type="wstring">
12572	<desc>
12573	Location of the storage unit holding medium data.
12574
12575	The format of the location string is medium type specific. For medium
12576	types using regular files in a host's file system, the location
12577	string is the full file name.
12578
12579	Some medium types may support changing the storage unit location by
12580	simply changing the value of this property. If this operation is not
12581	supported, the implementation will return E_NOTIMPL in attempt to set
12582	this attribute's value.
12583
12584	When setting a value of the location attribute which is a regular file
12585	in the host's file system, the given file name may be either relative to
12586	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
12587	absolute. Note that if the given location specification does not contain
12588	the file extension part then a proper default extension will be
12589	automatically appended by the implementation depending on the medium type.
12590	</desc>
12591	</attribute>
12592
12593	<attribute name="name" type="wstring" readonly="yes">
12594	<desc>
12595	Name of the storage unit holding medium data.
12596
12597	The returned string is a short version of the <link to="#location"/>
12598	attribute that is suitable for representing the medium in situations
12599	where the full location specification is too long (such as lists
12600	and comboboxes in GUI frontends). This string is also used by frontends
12601	to sort the media list alphabetically when needed.
12602
12603	For example, for locations that are regular files in the host's file
12604	system, the value of this attribute is just the file name (+ extension),
12605	without the path specification.
12606
12607	Note that as opposed to the <link to="#location"/> attribute, the name
12608	attribute will not necessary be unique for a list of media of the
12609	given type and format.
12610	</desc>
12611	</attribute>
12612
12613	<attribute name="deviceType" type="DeviceType" readonly="yes">
12614	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
12615	medium.</desc>
12616	</attribute>
12617
12618	<attribute name="hostDrive" type="boolean" readonly="yes">
12619	<desc>True if this corresponds to a drive on the host.</desc>
12620	</attribute>
12621
12622	<attribute name="size" type="long long" readonly="yes">
12623	<desc>
12624	Physical size of the storage unit used to hold medium data (in bytes).
12625
12626	<note>
12627	For media whose <link to="#state"/> is <link
12628	to="MediumState_Inaccessible"/>, the value of this property is the
12629	last known size. For <link to="MediumState_NotCreated"/> media,
12630	the returned value is zero.
12631	</note>
12632	</desc>
12633	</attribute>
12634
12635	<attribute name="format" type="wstring" readonly="yes">
12636	<desc>
12637	Storage format of this medium.
12638
12639	The value of this attribute is a string that specifies a backend used
12640	to store medium data. The storage format is defined when you create a
12641	new medium or automatically detected when you open an existing medium,
12642	and cannot be changed later.
12643
12644	The list of all storage formats supported by this VirtualBox
12645	installation can be obtained using
12646	<link to="ISystemProperties::mediumFormats"/>.
12647	</desc>
12648	</attribute>
12649
12650	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
12651	<desc>
12652	Storage medium format object corresponding to this medium.
12653
12654	The value of this attribute is a reference to the medium format object
12655	that specifies the backend properties used to store medium data. The
12656	storage format is defined when you create a new medium or automatically
12657	detected when you open an existing medium, and cannot be changed later.
12658
12659	<note>@c null is returned if there is no associated medium format
12660	object. This can e.g. happen for medium objects representing host
12661	drives and other special medium objects.</note>
12662	</desc>
12663	</attribute>
12664
12665	<attribute name="type" type="MediumType">
12666	<desc>
12667	Type (role) of this medium.
12668
12669	The following constraints apply when changing the value of this
12670	attribute:
12671	<ul>
12672	<li>If a medium is attached to a virtual machine (either in the
12673	current state or in one of the snapshots), its type cannot be
12674	changed.
12675	</li>
12676	<li>As long as the medium has children, its type cannot be set
12677	to <link to="MediumType_Writethrough"/>.
12678	</li>
12679	<li>The type of all differencing media is
12680	<link to="MediumType_Normal"/> and cannot be changed.
12681	</li>
12682	</ul>
12683
12684	The type of a newly created or opened medium is set to
12685	<link to="MediumType_Normal"/>, except for DVD and floppy media,
12686	which have a type of <link to="MediumType_Writethrough"/>.
12687	</desc>
12688	</attribute>
12689
12690	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
12691	<desc>
12692	Returns which medium types can selected for this medium.
12693
12694	<result name="E_NOTIMPL">
12695	This attribute is not implemented at the moment.
12696	</result>
12697	</desc>
12698	</attribute>
12699
12700	<attribute name="parent" type="IMedium" readonly="yes">
12701	<desc>
12702	Parent of this medium (the medium this medium is directly based
12703	on).
12704
12705	Only differencing media have parents. For base (non-differencing)
12706	media, @c null is returned.
12707	</desc>
12708	</attribute>
12709
12710	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
12711	<desc>
12712	Children of this medium (all differencing media directly based
12713	on this medium). A @c null array is returned if this medium
12714	does not have any children.
12715	</desc>
12716	</attribute>
12717
12718	<attribute name="base" type="IMedium" readonly="yes">
12719	<desc>
12720	Base medium of this medium.
12721
12722	If this is a differencing medium, its base medium is the medium
12723	the given medium branch starts from. For all other types of media, this
12724	property returns the medium object itself (i.e. the same object this
12725	property is read on).
12726	</desc>
12727	</attribute>
12728
12729	<attribute name="readOnly" type="boolean" readonly="yes">
12730	<desc>
12731	Returns @c true if this medium is read-only and @c false otherwise.
12732
12733	A medium is considered to be read-only when its contents cannot be
12734	modified without breaking the integrity of other parties that depend on
12735	this medium such as its child media or snapshots of virtual machines
12736	where this medium is attached to these machines. If there are no
12737	children and no such snapshots then there is no dependency and the
12738	medium is not read-only.
12739
12740	The value of this attribute can be used to determine the kind of the
12741	attachment that will take place when attaching this medium to a
12742	virtual machine. If the value is @c false then the medium will
12743	be attached directly. If the value is @c true then the medium
12744	will be attached indirectly by creating a new differencing child
12745	medium for that. See the interface description for more information.
12746
12747	Note that all <link to="MediumType_Immutable">Immutable</link> media
12748	are always read-only while all
12749	<link to="MediumType_Writethrough">Writethrough</link> media are
12750	always not.
12751
12752	<note>
12753	The read-only condition represented by this attribute is related to
12754	the medium type and usage, not to the current
12755	<link to="IMedium::state">medium state</link> and not to the read-only
12756	state of the storage unit.
12757	</note>
12758	</desc>
12759	</attribute>
12760
12761	<attribute name="logicalSize" type="long long" readonly="yes">
12762	<desc>
12763	Logical size of this medium (in bytes), as reported to the
12764	guest OS running inside the virtual machine this medium is
12765	attached to. The logical size is defined when the medium is created
12766	and cannot be changed later.
12767
12768	<note>
12769	For media whose state is <link to="#state"/> is <link
12770	to="MediumState_Inaccessible"/>, the value of this property is the
12771	last known logical size. For <link to="MediumState_NotCreated"/>
12772	media, the returned value is zero.
12773	</note>
12774	</desc>
12775	</attribute>
12776
12777	<attribute name="autoReset" type="boolean">
12778	<desc>
12779	Whether this differencing medium will be automatically reset each
12780	time a virtual machine it is attached to is powered up. This
12781	attribute is automatically set to @c true for the last
12782	differencing image of an "immutable" medium (see
12783	<link to="MediumType" />).
12784
12785	See <link to="#reset"/> for more information about resetting
12786	differencing media.
12787
12788	<note>
12789	Reading this property on a base (non-differencing) medium will
12790	always @c false. Changing the value of this property in this
12791	case is not supported.
12792	</note>
12793
12794	<result name="VBOX_E_NOT_SUPPORTED">
12795	This is not a differencing medium (when changing the attribute
12796	value).
12797	</result>
12798	</desc>
12799	</attribute>
12800
12801	<attribute name="lastAccessError" type="wstring" readonly="yes">
12802	<desc>
12803	Text message that represents the result of the last accessibility
12804	check performed by <link to="#refreshState"/>.
12805
12806	An empty string is returned if the last accessibility check
12807	was successful or has not yet been called. As a result, if
12808	<link to="#state" /> is "Inaccessible" and this attribute is empty,
12809	then <link to="#refreshState"/> has yet to be called; this is the
12810	default value of media after VirtualBox initialization.
12811	A non-empty string indicates a failure and should normally describe
12812	a reason of the failure (for example, a file read error).
12813	</desc>
12814	</attribute>
12815
12816	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
12817	<desc>
12818	Array of UUIDs of all machines this medium is attached to.
12819
12820	A @c null array is returned if this medium is not attached to any
12821	machine or to any machine's snapshot.
12822
12823	<note>
12824	The returned array will include a machine even if this medium is not
12825	attached to that machine in the current state but attached to it in
12826	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
12827	details.
12828	</note>
12829	</desc>
12830	</attribute>
12831
12832	<method name="setIds">
12833	<desc>
12834	Changes the UUID and parent UUID for a hard disk medium.
12835	</desc>
12836	<param name="setImageId" type="boolean" dir="in">
12837	<desc>
12838	Select whether a new image UUID is set or not.
12839	</desc>
12840	</param>
12841	<param name="imageId" type="uuid" mod="string" dir="in">
12842	<desc>
12843	New UUID for the image. If an empty string is passed, then a new
12844	UUID is automatically created, provided that @a setImageId is @c true.
12845	Specifying a zero UUID is not allowed.
12846	</desc>
12847	</param>
12848	<param name="setParentId" type="boolean" dir="in">
12849	<desc>
12850	Select whether a new parent UUID is set or not.
12851	</desc>
12852	</param>
12853	<param name="parentId" type="uuid" mod="string" dir="in">
12854	<desc>
12855	New parent UUID for the image. If an empty string is passed, then a
12856	new UUID is automatically created, provided @a setParentId is
12857	@c true. A zero UUID is valid.
12858	</desc>
12859	</param>
12860	<result name="E_INVALIDARG">
12861	Invalid parameter combination.
12862	</result>
12863	<result name="VBOX_E_NOT_SUPPORTED">
12864	Medium is not a hard disk medium.
12865	</result>
12866	</method>
12867
12868	<method name="refreshState">
12869	<desc>
12870	If the current medium state (see <link to="MediumState"/>) is one of
12871	"Created", "Inaccessible" or "LockedRead", then this performs an
12872	accessibility check on the medium and sets the value of the <link to="#state"/>
12873	attribute accordingly; that value is also returned for convenience.
12874
12875	For all other state values, this does not perform a refresh but returns
12876	the state only.
12877
12878	The refresh, if performed, may take a long time (several seconds or even
12879	minutes, depending on the storage unit location and format) because it performs an
12880	accessibility check of the storage unit. This check may cause a significant
12881	delay if the storage unit of the given medium is, for example, a file located
12882	on a network share which is not currently accessible due to connectivity
12883	problems. In that case, the call will not return until a timeout
12884	interval defined by the host OS for this operation expires. For this reason,
12885	it is recommended to never read this attribute on the main UI thread to avoid
12886	making the UI unresponsive.
12887
12888	If the last known state of the medium is "Created" and the accessibility
12889	check fails, then the state would be set to "Inaccessible", and
12890	<link to="#lastAccessError"/> may be used to get more details about the
12891	failure. If the state of the medium is "LockedRead", then it remains the
12892	same, and a non-empty value of <link to="#lastAccessError"/> will
12893	indicate a failed accessibility check in this case.
12894
12895	Note that not all medium states are applicable to all medium types.
12896	</desc>
12897	<param name="state" type="MediumState" dir="return">
12898	<desc>
12899	New medium state.
12900	</desc>
12901	</param>
12902	</method>
12903
12904	<method name="getSnapshotIds">
12905	<desc>
12906	Returns an array of UUIDs of all snapshots of the given machine where
12907	this medium is attached to.
12908
12909	If the medium is attached to the machine in the current state, then the
12910	first element in the array will always be the ID of the queried machine
12911	(i.e. the value equal to the @c machineId argument), followed by
12912	snapshot IDs (if any).
12913
12914	If the medium is not attached to the machine in the current state, then
12915	the array will contain only snapshot IDs.
12916
12917	The returned array may be @c null if this medium is not attached
12918	to the given machine at all, neither in the current state nor in one of
12919	the snapshots.
12920	</desc>
12921	<param name="machineId" type="uuid" mod="string" dir="in">
12922	<desc>
12923	UUID of the machine to query.
12924	</desc>
12925	</param>
12926	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
12927	<desc>
12928	Array of snapshot UUIDs of the given machine using this medium.
12929	</desc>
12930	</param>
12931	</method>
12932
12933	<method name="lockRead">
12934	<desc>
12935	Locks this medium for reading.
12936
12937	A read lock is shared: many clients can simultaneously lock the
12938	same medium for reading unless it is already locked for writing (see
12939	<link to="#lockWrite"/>) in which case an error is returned.
12940
12941	When the medium is locked for reading, it cannot be modified
12942	from within VirtualBox. This means that any method that changes
12943	the properties of this medium or contents of the storage unit
12944	will return an error (unless explicitly stated otherwise). That
12945	includes an attempt to start a virtual machine that wants to
12946	write to the the medium.
12947
12948	When the virtual machine is started up, it locks for reading all
12949	media it uses in read-only mode. If some medium cannot be locked
12950	for reading, the startup procedure will fail.
12951	A medium is typically locked for reading while it is used by a running
12952	virtual machine but has a depending differencing image that receives
12953	the actual write operations. This way one base medium can have
12954	multiple child differencing images which can be written to
12955	simultaneously. Read-only media such as DVD and floppy images are
12956	also locked for reading only (so they can be in use by multiple
12957	machines simultaneously).
12958
12959	A medium is also locked for reading when it is the source of a
12960	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
12961
12962	The medium locked for reading must be unlocked using the <link
12963	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
12964	can be nested and must be followed by the same number of paired
12965	<link to="#unlockRead"/> calls.
12966
12967	This method sets the medium state (see <link to="#state"/>) to
12968	"LockedRead" on success. The medium's previous state must be
12969	one of "Created", "Inaccessible" or "LockedRead".
12970
12971	Locking an inaccessible medium is not an error; this method performs
12972	a logical lock that prevents modifications of this medium through
12973	the VirtualBox API, not a physical file-system lock of the underlying
12974	storage unit.
12975
12976	This method returns the current state of the medium
12977	<i>before</i> the operation.
12978
12979	<result name="VBOX_E_INVALID_OBJECT_STATE">
12980	Invalid medium state (e.g. not created, locked, inaccessible,
12981	creating, deleting).
12982	</result>
12983
12984	</desc>
12985	<param name="state" type="MediumState" dir="return">
12986	<desc>
12987	State of the medium after the operation.
12988	</desc>
12989	</param>
12990	</method>
12991
12992	<method name="unlockRead">
12993	<desc>
12994	Cancels the read lock previously set by <link to="#lockRead"/>.
12995
12996	For both success and failure, this method returns the current state
12997	of the medium <i>after</i> the operation.
12998
12999	See <link to="#lockRead"/> for more details.
13000
13001	<result name="VBOX_E_INVALID_OBJECT_STATE">
13002	Medium not locked for reading.
13003	</result>
13004
13005	</desc>
13006	<param name="state" type="MediumState" dir="return">
13007	<desc>
13008	State of the medium after the operation.
13009	</desc>
13010	</param>
13011	</method>
13012
13013	<method name="lockWrite">
13014	<desc>
13015	Locks this medium for writing.
13016
13017	A write lock, as opposed to <link to="#lockRead"/>, is
13018	exclusive: there may be only one client holding a write lock,
13019	and there may be no read locks while the write lock is held.
13020	As a result, read-locking fails if a write lock is held, and
13021	write-locking fails if either a read or another write lock is held.
13022
13023	When a medium is locked for writing, it cannot be modified
13024	from within VirtualBox, and it is not guaranteed that the values
13025	of its properties are up-to-date. Any method that changes the
13026	properties of this medium or contents of the storage unit will
13027	return an error (unless explicitly stated otherwise).
13028
13029	When a virtual machine is started up, it locks for writing all
13030	media it uses to write data to. If any medium could not be locked
13031	for writing, the startup procedure will fail. If a medium has
13032	differencing images, then while the machine is running, only
13033	the last ("leaf") differencing image is locked for writing,
13034	whereas its parents are locked for reading only.
13035
13036	A medium is also locked for writing when it is the target of a
13037	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
13038
13039	The medium locked for writing must be unlocked using the <link
13040	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
13041
13042	This method sets the medium state (see <link to="#state"/>) to
13043	"LockedWrite" on success. The medium's previous state must be
13044	either "Created" or "Inaccessible".
13045
13046	Locking an inaccessible medium is not an error; this method performs
13047	a logical lock that prevents modifications of this medium through
13048	the VirtualBox API, not a physical file-system lock of the underlying
13049	storage unit.
13050
13051	For both, success and failure, this method returns the current
13052	state of the medium <i>before</i> the operation.
13053
13054	<result name="VBOX_E_INVALID_OBJECT_STATE">
13055	Invalid medium state (e.g. not created, locked, inaccessible,
13056	creating, deleting).
13057	</result>
13058
13059	</desc>
13060	<param name="state" type="MediumState" dir="return">
13061	<desc>
13062	State of the medium after the operation.
13063	</desc>
13064	</param>
13065	</method>
13066
13067	<method name="unlockWrite">
13068	<desc>
13069	Cancels the write lock previously set by <link to="#lockWrite"/>.
13070
13071	For both success and failure, this method returns the current
13072	state of the medium <i>after</i> the operation.
13073
13074	See <link to="#lockWrite"/> for more details.
13075
13076	<result name="VBOX_E_INVALID_OBJECT_STATE">
13077	Medium not locked for writing.
13078	</result>
13079
13080	</desc>
13081	<param name="state" type="MediumState" dir="return">
13082	<desc>
13083	State of the medium after the operation.
13084	</desc>
13085	</param>
13086	</method>
13087
13088	<method name="close">
13089	<desc>
13090	Closes this medium.
13091
13092	The medium must not be attached to any known virtual machine
13093	and must not have any known child media, otherwise the
13094	operation will fail.
13095
13096	When the medium is successfully closed, it is removed from
13097	the list of registered media, but its storage unit is not
13098	deleted. In particular, this means that this medium can
13099	later be opened again using the <link to="IVirtualBox::openMedium"/>
13100	call.
13101
13102	Note that after this method successfully returns, the given medium
13103	object becomes uninitialized. This means that any attempt
13104	to call any of its methods or attributes will fail with the
13105	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
13106
13107	<result name="VBOX_E_INVALID_OBJECT_STATE">
13108	Invalid medium state (other than not created, created or
13109	inaccessible).
13110	</result>
13111	<result name="VBOX_E_OBJECT_IN_USE">
13112	Medium attached to virtual machine.
13113	</result>
13114	<result name="VBOX_E_FILE_ERROR">
13115	Settings file not accessible.
13116	</result>
13117	<result name="VBOX_E_XML_ERROR">
13118	Could not parse the settings file.
13119	</result>
13120
13121	</desc>
13122	</method>
13123
13124	<!-- property methods -->
13125
13126	<method name="getProperty" const="yes">
13127	<desc>
13128	Returns the value of the custom medium property with the given name.
13129
13130	The list of all properties supported by the given medium format can
13131	be obtained with <link to="IMediumFormat::describeProperties"/>.
13132
13133	<note>If this method returns an empty string in @a value, the requested
13134	property is supported but currently not assigned any value.</note>
13135
13136	<result name="VBOX_E_OBJECT_NOT_FOUND">
13137	Requested property does not exist (not supported by the format).
13138	</result>
13139	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13140	</desc>
13141	<param name="name" type="wstring" dir="in">
13142	<desc>Name of the property to get.</desc>
13143	</param>
13144	<param name="value" type="wstring" dir="return">
13145	<desc>Current property value.</desc>
13146	</param>
13147	</method>
13148
13149	<method name="setProperty">
13150	<desc>
13151	Sets the value of the custom medium property with the given name.
13152
13153	The list of all properties supported by the given medium format can
13154	be obtained with <link to="IMediumFormat::describeProperties"/>.
13155
13156	<note>Setting the property value to @c null or an empty string is
13157	equivalent to deleting the existing value. A default value (if it is
13158	defined for this property) will be used by the format backend in this
13159	case.</note>
13160
13161	<result name="VBOX_E_OBJECT_NOT_FOUND">
13162	Requested property does not exist (not supported by the format).
13163	</result>
13164	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13165	</desc>
13166	<param name="name" type="wstring" dir="in">
13167	<desc>Name of the property to set.</desc>
13168	</param>
13169	<param name="value" type="wstring" dir="in">
13170	<desc>Property value to set.</desc>
13171	</param>
13172	</method>
13173
13174	<method name="getProperties" const="yes">
13175	<desc>
13176	Returns values for a group of properties in one call.
13177
13178	The names of the properties to get are specified using the @a names
13179	argument which is a list of comma-separated property names or
13180	an empty string if all properties are to be returned.
13181	<note>Currently the value of this argument is ignored and the method
13182	always returns all existing properties.</note>
13183
13184	The list of all properties supported by the given medium format can
13185	be obtained with <link to="IMediumFormat::describeProperties"/>.
13186
13187	The method returns two arrays, the array of property names corresponding
13188	to the @a names argument and the current values of these properties.
13189	Both arrays have the same number of elements with each element at the
13190	given index in the first array corresponds to an element at the same
13191	index in the second array.
13192
13193	For properties that do not have assigned values, an empty string is
13194	returned at the appropriate index in the @a returnValues array.
13195
13196	</desc>
13197	<param name="names" type="wstring" dir="in">
13198	<desc>
13199	Names of properties to get.
13200	</desc>
13201	</param>
13202	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13203	<desc>Names of returned properties.</desc>
13204	</param>
13205	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13206	<desc>Values of returned properties.</desc>
13207	</param>
13208	</method>
13209
13210	<method name="setProperties">
13211	<desc>
13212	Sets values for a group of properties in one call.
13213
13214	The names of the properties to set are passed in the @a names
13215	array along with the new values for them in the @a values array. Both
13216	arrays have the same number of elements with each element at the given
13217	index in the first array corresponding to an element at the same index
13218	in the second array.
13219
13220	If there is at least one property name in @a names that is not valid,
13221	the method will fail before changing the values of any other properties
13222	from the @a names array.
13223
13224	Using this method over <link to="#setProperty"/> is preferred if you
13225	need to set several properties at once since it is more efficient.
13226
13227	The list of all properties supported by the given medium format can
13228	be obtained with <link to="IMediumFormat::describeProperties"/>.
13229
13230	Setting the property value to @c null or an empty string is equivalent
13231	to deleting the existing value. A default value (if it is defined for
13232	this property) will be used by the format backend in this case.
13233	</desc>
13234	<param name="names" type="wstring" safearray="yes" dir="in">
13235	<desc>Names of properties to set.</desc>
13236	</param>
13237	<param name="values" type="wstring" safearray="yes" dir="in">
13238	<desc>Values of properties to set.</desc>
13239	</param>
13240	</method>
13241
13242	<!-- storage methods -->
13243
13244	<method name="createBaseStorage">
13245	<desc>
13246	Starts creating a hard disk storage unit (fixed/dynamic, according
13247	to the variant flags) in in the background. The previous storage unit
13248	created for this object, if any, must first be deleted using
13249	<link to="#deleteStorage"/>, otherwise the operation will fail.
13250
13251	Before the operation starts, the medium is placed in
13252	<link to="MediumState_Creating"/> state. If the create operation
13253	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
13254	state.
13255
13256	After the returned progress object reports that the operation has
13257	successfully completed, the medium state will be set to <link
13258	to="MediumState_Created"/>, the medium will be remembered by this
13259	VirtualBox installation and may be attached to virtual machines.
13260
13261	<result name="VBOX_E_NOT_SUPPORTED">
13262	The variant of storage creation operation is not supported. See <link
13263	to="IMediumFormat::capabilities"/>.
13264	</result>
13265	</desc>
13266	<param name="logicalSize" type="long long" dir="in">
13267	<desc>Maximum logical size of the medium in bytes.</desc>
13268	</param>
13269	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13270	<desc>Exact image variant which should be created (as a combination of
13271	<link to="MediumVariant" /> flags).</desc>
13272	</param>
13273	<param name="progress" type="IProgress" dir="return">
13274	<desc>Progress object to track the operation completion.</desc>
13275	</param>
13276	</method>
13277
13278	<method name="deleteStorage">
13279	<desc>
13280	Starts deleting the storage unit of this medium.
13281
13282	The medium must not be attached to any known virtual machine and must
13283	not have any known child media, otherwise the operation will fail.
13284	It will also fail if there is no storage unit to delete or if deletion
13285	is already in progress, or if the medium is being in use (locked for
13286	read or for write) or inaccessible. Therefore, the only valid state for
13287	this operation to succeed is <link to="MediumState_Created"/>.
13288
13289	Before the operation starts, the medium is placed in
13290	<link to="MediumState_Deleting"/> state and gets removed from the list
13291	of remembered hard disks (media registry). If the delete operation
13292	fails, the medium will be remembered again and placed back to
13293	<link to="MediumState_Created"/> state.
13294
13295	After the returned progress object reports that the operation is
13296	complete, the medium state will be set to
13297	<link to="MediumState_NotCreated"/> and you will be able to use one of
13298	the storage creation methods to create it again.
13299
13300	<see><link to="#close"/></see>
13301
13302	<result name="VBOX_E_OBJECT_IN_USE">
13303	Medium is attached to a virtual machine.
13304	</result>
13305	<result name="VBOX_E_NOT_SUPPORTED">
13306	Storage deletion is not allowed because neither of storage creation
13307	operations are supported. See
13308	<link to="IMediumFormat::capabilities"/>.
13309	</result>
13310
13311	<note>
13312	If the deletion operation fails, it is not guaranteed that the storage
13313	unit still exists. You may check the <link to="IMedium::state"/> value
13314	to answer this question.
13315	</note>
13316	</desc>
13317	<param name="progress" type="IProgress" dir="return">
13318	<desc>Progress object to track the operation completion.</desc>
13319	</param>
13320	</method>
13321
13322	<!-- diff methods -->
13323
13324	<method name="createDiffStorage">
13325	<desc>
13326	Starts creating an empty differencing storage unit based on this
13327	medium in the format and at the location defined by the @a target
13328	argument.
13329
13330	The target medium must be in <link to="MediumState_NotCreated"/>
13331	state (i.e. must not have an existing storage unit). Upon successful
13332	completion, this operation will set the type of the target medium to
13333	<link to="MediumType_Normal"/> and create a storage unit necessary to
13334	represent the differencing medium data in the given format (according
13335	to the storage format of the target object).
13336
13337	After the returned progress object reports that the operation is
13338	successfully complete, the target medium gets remembered by this
13339	VirtualBox installation and may be attached to virtual machines.
13340
13341	<note>
13342	The medium will be set to <link to="MediumState_LockedRead"/>
13343	state for the duration of this operation.
13344	</note>
13345	<result name="VBOX_E_OBJECT_IN_USE">
13346	Medium not in @c NotCreated state.
13347	</result>
13348	</desc>
13349	<param name="target" type="IMedium" dir="in">
13350	<desc>Target medium.</desc>
13351	</param>
13352	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13353	<desc>Exact image variant which should be created (as a combination of
13354	<link to="MediumVariant" /> flags).</desc>
13355	</param>
13356	<param name="progress" type="IProgress" dir="return">
13357	<desc>Progress object to track the operation completion.</desc>
13358	</param>
13359	</method>
13360
13361	<method name="mergeTo">
13362	<desc>
13363	Starts merging the contents of this medium and all intermediate
13364	differencing media in the chain to the given target medium.
13365
13366	The target medium must be either a descendant of this medium or
13367	its ancestor (otherwise this method will immediately return a failure).
13368	It follows that there are two logical directions of the merge operation:
13369	from ancestor to descendant (<i>forward merge</i>) and from descendant to
13370	ancestor (<i>backward merge</i>). Let us consider the following medium
13371	chain:
13372
13373	<pre>Base <- Diff_1 <- Diff_2</pre>
13374
13375	Here, calling this method on the <tt>Base</tt> medium object with
13376	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
13377	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
13378	merge. Note that in both cases the contents of the resulting medium
13379	will be the same, the only difference is the medium object that takes
13380	the result of the merge operation. In case of the forward merge in the
13381	above example, the result will be written to <tt>Diff_2</tt>; in case of
13382	the backward merge, the result will be written to <tt>Base</tt>. In
13383	other words, the result of the operation is always stored in the target
13384	medium.
13385
13386	Upon successful operation completion, the storage units of all media in
13387	the chain between this (source) medium and the target medium, including
13388	the source medium itself, will be automatically deleted and the
13389	relevant medium objects (including this medium) will become
13390	uninitialized. This means that any attempt to call any of
13391	their methods or attributes will fail with the
13392	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
13393	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
13394	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
13395	Note that <tt>Diff_2</tt> in this case will become a base medium
13396	itself since it will no longer be based on any other medium.
13397
13398	Considering the above, all of the following conditions must be met in
13399	order for the merge operation to succeed:
13400	<ul>
13401	<li>
13402	Neither this (source) medium nor any intermediate
13403	differencing medium in the chain between it and the target
13404	medium is attached to any virtual machine.
13405	</li>
13406	<li>
13407	Neither the source medium nor the target medium is an
13408	<link to="MediumType_Immutable"/> medium.
13409	</li>
13410	<li>
13411	The part of the medium tree from the source medium to the
13412	target medium is a linear chain, i.e. all medium in this
13413	chain have exactly one child which is the next medium in this
13414	chain. The only exception from this rule is the target medium in
13415	the forward merge operation; it is allowed to have any number of
13416	child media because the merge operation will not change its
13417	logical contents (as it is seen by the guest OS or by children).
13418	</li>
13419	<li>
13420	None of the involved media are in
13421	<link to="MediumState_LockedRead"/> or
13422	<link to="MediumState_LockedWrite"/> state.
13423	</li>
13424	</ul>
13425
13426	<note>
13427	This (source) medium and all intermediates will be placed to <link
13428	to="MediumState_Deleting"/> state and the target medium will be
13429	placed to <link to="MediumState_LockedWrite"/> state and for the
13430	duration of this operation.
13431	</note>
13432	</desc>
13433	<param name="target" type="IMedium" dir="in">
13434	<desc>Target medium.</desc>
13435	</param>
13436	<param name="progress" type="IProgress" dir="return">
13437	<desc>Progress object to track the operation completion.</desc>
13438	</param>
13439	</method>
13440
13441	<!-- clone method -->
13442
13443	<method name="cloneTo">
13444	<desc>
13445	Starts creating a clone of this medium in the format and at the
13446	location defined by the @a target argument.
13447
13448	The target medium must be either in <link to="MediumState_NotCreated"/>
13449	state (i.e. must not have an existing storage unit) or in
13450	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13451	big enough to hold the data or else the copy will be partial). Upon
13452	successful completion, the cloned medium will contain exactly the
13453	same sector data as the medium being cloned, except that in the
13454	first case a new UUID for the clone will be randomly generated, and in
13455	the second case the UUID will remain unchanged.
13456
13457	The @a parent argument defines which medium will be the parent
13458	of the clone. Passing a @c null reference indicates that the clone will
13459	be a base image, i.e. completely independent. It is possible to specify
13460	an arbitrary medium for this parameter, including the parent of the
13461	medium which is being cloned. Even cloning to a child of the source
13462	medium is possible. Note that when cloning to an existing image, the
13463	@a parent argument is ignored.
13464
13465	After the returned progress object reports that the operation is
13466	successfully complete, the target medium gets remembered by this
13467	VirtualBox installation and may be attached to virtual machines.
13468
13469	<note>
13470	This medium will be placed to <link to="MediumState_LockedRead"/>
13471	state for the duration of this operation.
13472	</note>
13473	<result name="E_NOTIMPL">
13474	The specified cloning variant is not supported at the moment.
13475	</result>
13476	</desc>
13477	<param name="target" type="IMedium" dir="in">
13478	<desc>Target medium.</desc>
13479	</param>
13480	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13481	<desc>Exact image variant which should be created (as a combination of
13482	<link to="MediumVariant" /> flags).</desc>
13483	</param>
13484	<param name="parent" type="IMedium" dir="in">
13485	<desc>Parent of the cloned medium.</desc>
13486	</param>
13487	<param name="progress" type="IProgress" dir="return">
13488	<desc>Progress object to track the operation completion.</desc>
13489	</param>
13490	</method>
13491
13492	<method name="cloneToBase">
13493	<desc>
13494	Starts creating a clone of this medium in the format and at the
13495	location defined by the @a target argument.
13496
13497	The target medium must be either in <link to="MediumState_NotCreated"/>
13498	state (i.e. must not have an existing storage unit) or in
13499	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13500	big enough to hold the data or else the copy will be partial). Upon
13501	successful completion, the cloned medium will contain exactly the
13502	same sector data as the medium being cloned, except that in the
13503	first case a new UUID for the clone will be randomly generated, and in
13504	the second case the UUID will remain unchanged.
13505
13506	The @a parent argument defines which medium will be the parent
13507	of the clone. In this case the clone will be a base image, i.e.
13508	completely independent. It is possible to specify an arbitrary
13509	medium for this parameter, including the parent of the
13510	medium which is being cloned. Even cloning to a child of the source
13511	medium is possible. Note that when cloning to an existing image, the
13512	@a parent argument is ignored.
13513
13514	After the returned progress object reports that the operation is
13515	successfully complete, the target medium gets remembered by this
13516	VirtualBox installation and may be attached to virtual machines.
13517
13518	<note>
13519	This medium will be placed to <link to="MediumState_LockedRead"/>
13520	state for the duration of this operation.
13521	</note>
13522	<result name="E_NOTIMPL">
13523	The specified cloning variant is not supported at the moment.
13524	</result>
13525	</desc>
13526	<param name="target" type="IMedium" dir="in">
13527	<desc>Target medium.</desc>
13528	</param>
13529	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13530	<desc><link to="MediumVariant" /> flags).</desc>
13531	</param>
13532	<param name="progress" type="IProgress" dir="return">
13533	<desc>Progress object to track the operation completion.</desc>
13534	</param>
13535	</method>
13536
13537	<!-- other methods -->
13538
13539	<method name="compact">
13540	<desc>
13541	Starts compacting of this medium. This means that the medium is
13542	transformed into a possibly more compact storage representation.
13543	This potentially creates temporary images, which can require a
13544	substantial amount of additional disk space.
13545
13546	This medium will be placed to <link to="MediumState_LockedWrite"/>
13547	state and all its parent media (if any) will be placed to
13548	<link to="MediumState_LockedRead"/> state for the duration of this
13549	operation.
13550
13551	Please note that the results can be either returned straight away,
13552	or later as the result of the background operation via the object
13553	returned via the @a progress parameter.
13554
13555	<result name="VBOX_E_NOT_SUPPORTED">
13556	Medium format does not support compacting (but potentially
13557	needs it).
13558	</result>
13559	</desc>
13560	<param name="progress" type="IProgress" dir="return">
13561	<desc>Progress object to track the operation completion.</desc>
13562	</param>
13563	</method>
13564
13565	<method name="resize">
13566	<desc>
13567	Starts resizing this medium. This means that the nominal size of the
13568	medium is set to the new value. Both increasing and decreasing the
13569	size is possible, and there are no safety checks, since VirtualBox
13570	does not make any assumptions about the medium contents.
13571
13572	Resizing usually needs additional disk space, and possibly also
13573	some temporary disk space. Note that resize does not create a full
13574	temporary copy of the medium, so the additional disk space requirement
13575	is usually much lower than using the clone operation.
13576
13577	This medium will be placed to <link to="MediumState_LockedWrite"/>
13578	state for the duration of this operation.
13579
13580	Please note that the results can be either returned straight away,
13581	or later as the result of the background operation via the object
13582	returned via the @a progress parameter.
13583
13584	<result name="VBOX_E_NOT_SUPPORTED">
13585	Medium format does not support resizing.
13586	</result>
13587	</desc>
13588	<param name="logicalSize" type="long long" dir="in">
13589	<desc>New nominal capacity of the medium in bytes.</desc>
13590	</param>
13591	<param name="progress" type="IProgress" dir="return">
13592	<desc>Progress object to track the operation completion.</desc>
13593	</param>
13594	</method>
13595
13596	<method name="reset">
13597	<desc>
13598	Starts erasing the contents of this differencing medium.
13599
13600	This operation will reset the differencing medium to its initial
13601	state when it does not contain any sector data and any read operation is
13602	redirected to its parent medium. This automatically gets called
13603	during VM power-up for every medium whose <link to="#autoReset" />
13604	attribute is @c true.
13605
13606	The medium will be write-locked for the duration of this operation (see
13607	<link to="#lockWrite" />).
13608
13609	<result name="VBOX_E_NOT_SUPPORTED">
13610	This is not a differencing medium.
13611	</result>
13612	<result name="VBOX_E_INVALID_OBJECT_STATE">
13613	Medium is not in <link to="MediumState_Created"/> or
13614	<link to="MediumState_Inaccessible"/> state.
13615	</result>
13616	</desc>
13617	<param name="progress" type="IProgress" dir="return">
13618	<desc>Progress object to track the operation completion.</desc>
13619	</param>
13620	</method>
13621
13622	</interface>
13623
13624
13625	<!--
13626	// IMediumFormat
13627	/////////////////////////////////////////////////////////////////////////
13628	-->
13629
13630	<enum
13631	name="DataType"
13632	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
13633	>
13634	<const name="Int32" value="0"/>
13635	<const name="Int8" value="1"/>
13636	<const name="String" value="2"/>
13637	</enum>
13638
13639	<enum
13640	name="DataFlags"
13641	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
13642	>
13643	<const name="None" value="0x00"/>
13644	<const name="Mandatory" value="0x01"/>
13645	<const name="Expert" value="0x02"/>
13646	<const name="Array" value="0x04"/>
13647	<const name="FlagMask" value="0x07"/>
13648	</enum>
13649
13650	<enum
13651	name="MediumFormatCapabilities"
13652	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
13653	>
13654	<desc>
13655	Medium format capability flags.
13656	</desc>
13657
13658	<const name="Uuid" value="0x01">
13659	<desc>
13660	Supports UUIDs as expected by VirtualBox code.
13661	</desc>
13662	</const>
13663
13664	<const name="CreateFixed" value="0x02">
13665	<desc>
13666	Supports creating fixed size images, allocating all space instantly.
13667	</desc>
13668	</const>
13669
13670	<const name="CreateDynamic" value="0x04">
13671	<desc>
13672	Supports creating dynamically growing images, allocating space on
13673	demand.
13674	</desc>
13675	</const>
13676
13677	<const name="CreateSplit2G" value="0x08">
13678	<desc>
13679	Supports creating images split in chunks of a bit less than 2 GBytes.
13680	</desc>
13681	</const>
13682
13683	<const name="Differencing" value="0x10">
13684	<desc>
13685	Supports being used as a format for differencing media (see <link
13686	to="IMedium::createDiffStorage"/>).
13687	</desc>
13688	</const>
13689
13690	<const name="Asynchronous" value="0x20">
13691	<desc>
13692	Supports asynchronous I/O operations for at least some configurations.
13693	</desc>
13694	</const>
13695
13696	<const name="File" value="0x40">
13697	<desc>
13698	The format backend operates on files (the <link to="IMedium::location"/>
13699	attribute of the medium specifies a file used to store medium
13700	data; for a list of supported file extensions see
13701	<link to="IMediumFormat::describeFileExtensions"/>).
13702	</desc>
13703	</const>
13704
13705	<const name="Properties" value="0x80">
13706	<desc>
13707	The format backend uses the property interface to configure the storage
13708	location and properties (the <link to="IMediumFormat::describeProperties"/>
13709	method is used to get access to properties supported by the given medium format).
13710	</desc>
13711	</const>
13712
13713	<const name="TcpNetworking" value="0x100">
13714	<desc>
13715	The format backend uses the TCP networking interface for network access.
13716	</desc>
13717	</const>
13718
13719	<const name="VFS" value="0x200">
13720	<desc>
13721	The format backend supports virtual filesystem functionality.
13722	</desc>
13723	</const>
13724
13725	<const name="CapabilityMask" value="0x3FF"/>
13726	</enum>
13727
13728	<interface
13729	name="IMediumFormat" extends="$unknown"
13730	uuid="6238e1cf-a17d-4ec1-8172-418bfb22b93a"
13731	wsmap="managed"
13732	>
13733	<desc>
13734	The IMediumFormat interface represents a medium format.
13735
13736	Each medium format has an associated backend which is used to handle
13737	media stored in this format. This interface provides information
13738	about the properties of the associated backend.
13739
13740	Each medium format is identified by a string represented by the
13741	<link to="#id"/> attribute. This string is used in calls like
13742	<link to="IVirtualBox::createHardDisk"/> to specify the desired
13743	format.
13744
13745	The list of all supported medium formats can be obtained using
13746	<link to="ISystemProperties::mediumFormats"/>.
13747
13748	<see><link to="IMedium"/></see>
13749	</desc>
13750
13751	<attribute name="id" type="wstring" readonly="yes">
13752	<desc>
13753	Identifier of this format.
13754
13755	The format identifier is a non-@c null non-empty ASCII string. Note that
13756	this string is case-insensitive. This means that, for example, all of
13757	the following strings:
13758	<pre>
13759	"VDI"
13760	"vdi"
13761	"VdI"</pre>
13762	refer to the same medium format.
13763
13764	This string is used in methods of other interfaces where it is necessary
13765	to specify a medium format, such as
13766	<link to="IVirtualBox::createHardDisk"/>.
13767	</desc>
13768	</attribute>
13769
13770	<attribute name="name" type="wstring" readonly="yes">
13771	<desc>
13772	Human readable description of this format.
13773
13774	Mainly for use in file open dialogs.
13775	</desc>
13776	</attribute>
13777
13778	<attribute name="capabilities" type="MediumFormatCapabilities" safearray="yes" readonly="yes">
13779	<desc>
13780	Capabilities of the format as an array of the flags.
13781
13782	For the meaning of individual capability flags see
13783	<link to="MediumFormatCapabilities"/>.
13784	</desc>
13785	</attribute>
13786
13787	<method name="describeFileExtensions">
13788	<desc>
13789	Returns two arrays describing the supported file extensions.
13790
13791	The first array contains the supported extensions and the seconds one
13792	the type each extension supports. Both have the same size.
13793
13794	Note that some backends do not work on files, so this array may be
13795	empty.
13796
13797	<see><link to="IMediumFormat::capabilities"/></see>
13798	</desc>
13799	<param name="extensions" type="wstring" safearray="yes" dir="out">
13800	<desc>The array of supported extensions.</desc>
13801	</param>
13802	<param name="types" type="DeviceType" safearray="yes" dir="out">
13803	<desc>The array which indicates the device type for every given extension.</desc>
13804	</param>
13805	</method>
13806
13807	<method name="describeProperties" const="yes">
13808	<desc>
13809	Returns several arrays describing the properties supported by this
13810	format.
13811
13812	An element with the given index in each array describes one
13813	property. Thus, the number of elements in each returned array is the
13814	same and corresponds to the number of supported properties.
13815
13816	The returned arrays are filled in only if the
13817	<link to="MediumFormatCapabilities_Properties"/> flag is set.
13818	All arguments must be non-@c null.
13819
13820	<see><link to="DataType"/>, <link to="DataFlags"/></see>
13821	</desc>
13822
13823	<param name="names" type="wstring" safearray="yes" dir="out">
13824	<desc>Array of property names.</desc>
13825	</param>
13826	<param name="descriptions" type="wstring" safearray="yes" dir="out">
13827	<desc>Array of property descriptions.</desc>
13828	</param>
13829	<param name="types" type="DataType" safearray="yes" dir="out">
13830	<desc>Array of property types.</desc>
13831	</param>
13832	<param name="flags" type="unsigned long" safearray="yes" dir="out">
13833	<desc>Array of property flags.</desc>
13834	</param>
13835	<param name="defaults" type="wstring" safearray="yes" dir="out">
13836	<desc>Array of default property values.</desc>
13837	</param>
13838	</method>
13839
13840	</interface>
13841
13842
13843	<!--
13844	// IKeyboard
13845	/////////////////////////////////////////////////////////////////////////
13846	-->
13847
13848	<interface
13849	name="IKeyboard" extends="$unknown"
13850	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
13851	wsmap="managed"
13852	>
13853	<desc>
13854	The IKeyboard interface represents the virtual machine's keyboard. Used
13855	in <link to="IConsole::keyboard"/>.
13856
13857	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
13858	to the virtual machine.
13859
13860	</desc>
13861	<method name="putScancode">
13862	<desc>Sends a scancode to the keyboard.
13863
13864	<result name="VBOX_E_IPRT_ERROR">
13865	Could not send scan code to virtual keyboard.
13866	</result>
13867
13868	</desc>
13869	<param name="scancode" type="long" dir="in"/>
13870	</method>
13871
13872	<method name="putScancodes">
13873	<desc>Sends an array of scancodes to the keyboard.
13874
13875	<result name="VBOX_E_IPRT_ERROR">
13876	Could not send all scan codes to virtual keyboard.
13877	</result>
13878
13879	</desc>
13880	<param name="scancodes" type="long" dir="in" safearray="yes"/>
13881	<param name="codesStored" type="unsigned long" dir="return"/>
13882	</method>
13883
13884	<method name="putCAD">
13885	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
13886	function is nothing special, it is just a convenience function
13887	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
13888
13889	<result name="VBOX_E_IPRT_ERROR">
13890	Could not send all scan codes to virtual keyboard.
13891	</result>
13892
13893	</desc>
13894	</method>
13895
13896	<attribute name="eventSource" type="IEventSource" readonly="yes">
13897	<desc>
13898	Event source for keyboard events.
13899	</desc>
13900	</attribute>
13901
13902	</interface>
13903
13904
13905	<!--
13906	// IMouse
13907	/////////////////////////////////////////////////////////////////////////
13908	-->
13909
13910	<enum
13911	name="MouseButtonState"
13912	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
13913	>
13914	<desc>
13915	Mouse button state.
13916	</desc>
13917
13918	<const name="LeftButton" value="0x01"/>
13919	<const name="RightButton" value="0x02"/>
13920	<const name="MiddleButton" value="0x04"/>
13921	<const name="WheelUp" value="0x08"/>
13922	<const name="WheelDown" value="0x10"/>
13923	<const name="XButton1" value="0x20"/>
13924	<const name="XButton2" value="0x40"/>
13925	<const name="MouseStateMask" value="0x7F"/>
13926	</enum>
13927
13928	<interface
13929	name="IMouse" extends="$unknown"
13930	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
13931	wsmap="managed"
13932	>
13933	<desc>
13934	The IMouse interface represents the virtual machine's mouse. Used in
13935	<link to="IConsole::mouse"/>.
13936
13937	Through this interface, the virtual machine's virtual mouse can be
13938	controlled.
13939	</desc>
13940
13941	<attribute name="absoluteSupported" type="boolean" readonly="yes">
13942	<desc>
13943	Whether the guest OS supports absolute mouse pointer positioning
13944	or not.
13945	<note>
13946	You can use the <link to="IMouseCapabilityChangedEvent"/>
13947	event to be instantly informed about changes of this attribute
13948	during virtual machine execution.
13949	</note>
13950	<see><link to="#putMouseEventAbsolute"/></see>
13951	</desc>
13952	</attribute>
13953
13954	<attribute name="relativeSupported" type="boolean" readonly="yes">
13955	<desc>
13956	Whether the guest OS supports relative mouse pointer positioning
13957	or not.
13958	<note>
13959	You can use the <link to="IMouseCapabilityChangedEvent"/>
13960	event to be instantly informed about changes of this attribute
13961	during virtual machine execution.
13962	</note>
13963	<see><link to="#putMouseEvent"/></see>
13964	</desc>
13965	</attribute>
13966
13967	<attribute name="needsHostCursor" type="boolean" readonly="yes">
13968	<desc>
13969	Whether the guest OS can currently switch to drawing it's own mouse
13970	cursor on demand.
13971	<note>
13972	You can use the <link to="IMouseCapabilityChangedEvent"/>
13973	event to be instantly informed about changes of this attribute
13974	during virtual machine execution.
13975	</note>
13976	<see><link to="#putMouseEvent"/></see>
13977	</desc>
13978	</attribute>
13979
13980	<method name="putMouseEvent">
13981	<desc>
13982	Initiates a mouse event using relative pointer movements
13983	along x and y axis.
13984
13985	<result name="E_ACCESSDENIED">
13986	Console not powered up.
13987	</result>
13988	<result name="VBOX_E_IPRT_ERROR">
13989	Could not send mouse event to virtual mouse.
13990	</result>
13991
13992	</desc>
13993
13994	<param name="dx" type="long" dir="in">
13995	<desc>
13996	Amount of pixels the mouse should move to the right.
13997	Negative values move the mouse to the left.
13998	</desc>
13999	</param>
14000	<param name="dy" type="long" dir="in">
14001	<desc>
14002	Amount of pixels the mouse should move downwards.
14003	Negative values move the mouse upwards.
14004	</desc>
14005	</param>
14006	<param name="dz" type="long" dir="in">
14007	<desc>
14008	Amount of mouse wheel moves.
14009	Positive values describe clockwise wheel rotations,
14010	negative values describe counterclockwise rotations.
14011	</desc>
14012	</param>
14013	<param name="dw" type="long" dir="in">
14014	<desc>
14015	Amount of horizontal mouse wheel moves.
14016	Positive values describe a movement to the left,
14017	negative values describe a movement to the right.
14018	</desc>
14019	</param>
14020	<param name="buttonState" type="long" dir="in">
14021	<desc>
14022	The current state of mouse buttons. Every bit represents
14023	a mouse button as follows:
14024	<table>
14025	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14026	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14027	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14028	</table>
14029	A value of <tt>1</tt> means the corresponding button is pressed.
14030	otherwise it is released.
14031	</desc>
14032	</param>
14033	</method>
14034
14035	<method name="putMouseEventAbsolute">
14036	<desc>
14037	Positions the mouse pointer using absolute x and y coordinates.
14038	These coordinates are expressed in pixels and
14039	start from <tt>[1,1]</tt> which corresponds to the top left
14040	corner of the virtual display.
14041
14042	<result name="E_ACCESSDENIED">
14043	Console not powered up.
14044	</result>
14045	<result name="VBOX_E_IPRT_ERROR">
14046	Could not send mouse event to virtual mouse.
14047	</result>
14048
14049	<note>
14050	This method will have effect only if absolute mouse
14051	positioning is supported by the guest OS.
14052	</note>
14053
14054	<see><link to="#absoluteSupported"/></see>
14055	</desc>
14056
14057	<param name="x" type="long" dir="in">
14058	<desc>
14059	X coordinate of the pointer in pixels, starting from @c 1.
14060	</desc>
14061	</param>
14062	<param name="y" type="long" dir="in">
14063	<desc>
14064	Y coordinate of the pointer in pixels, starting from @c 1.
14065	</desc>
14066	</param>
14067	<param name="dz" type="long" dir="in">
14068	<desc>
14069	Amount of mouse wheel moves.
14070	Positive values describe clockwise wheel rotations,
14071	negative values describe counterclockwise rotations.
14072	</desc>
14073	</param>
14074	<param name="dw" type="long" dir="in">
14075	<desc>
14076	Amount of horizontal mouse wheel moves.
14077	Positive values describe a movement to the left,
14078	negative values describe a movement to the right.
14079	</desc>
14080	</param>
14081	<param name="buttonState" type="long" dir="in">
14082	<desc>
14083	The current state of mouse buttons. Every bit represents
14084	a mouse button as follows:
14085	<table>
14086	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14087	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14088	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14089	</table>
14090	A value of @c 1 means the corresponding button is pressed.
14091	otherwise it is released.
14092	</desc>
14093	</param>
14094	</method>
14095
14096	<attribute name="eventSource" type="IEventSource" readonly="yes">
14097	<desc>
14098	Event source for mouse events.
14099	</desc>
14100	</attribute>
14101
14102	</interface>
14103
14104	<!--
14105	// IDisplay
14106	/////////////////////////////////////////////////////////////////////////
14107	-->
14108
14109	<enum
14110	name="FramebufferPixelFormat"
14111	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
14112	>
14113	<desc>
14114	Format of the video memory buffer. Constants represented by this enum can
14115	be used to test for particular values of <link
14116	to="IFramebuffer::pixelFormat"/>. See also <link
14117	to="IFramebuffer::requestResize"/>.
14118
14119	See also www.fourcc.org for more information about FOURCC pixel formats.
14120	</desc>
14121
14122	<const name="Opaque" value="0">
14123	<desc>
14124	Unknown buffer format (the user may not assume any particular format of
14125	the buffer).
14126	</desc>
14127	</const>
14128	<const name="FOURCC_RGB" value="0x32424752">
14129	<desc>
14130	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
14131	bit layout).
14132	</desc>
14133	</const>
14134	</enum>
14135
14136	<interface
14137	name="IFramebuffer" extends="$unknown"
14138	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
14139	wsmap="suppress"
14140	>
14141	<attribute name="address" type="octet" mod="ptr" readonly="yes">
14142	<desc>Address of the start byte of the frame buffer.</desc>
14143	</attribute>
14144
14145	<attribute name="width" type="unsigned long" readonly="yes">
14146	<desc>Frame buffer width, in pixels.</desc>
14147	</attribute>
14148
14149	<attribute name="height" type="unsigned long" readonly="yes">
14150	<desc>Frame buffer height, in pixels.</desc>
14151	</attribute>
14152
14153	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
14154	<desc>
14155	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
14156	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
14157	are: 8, 15, 16, 24 and 32.
14158	</desc>
14159	</attribute>
14160
14161	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
14162	<desc>
14163	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
14164	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
14165	size of the scan line must be aligned to 32 bits.
14166	</desc>
14167	</attribute>
14168
14169	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
14170	<desc>
14171	Frame buffer pixel format. It's either one of the values defined by <link
14172	to="FramebufferPixelFormat"/> or a raw FOURCC code.
14173	<note>
14174	This attribute must never return <link
14175	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
14176	<link to="#address"/> points to must be always known.
14177	</note>
14178	</desc>
14179	</attribute>
14180
14181	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
14182	<desc>
14183	Defines whether this frame buffer uses the virtual video card's memory
14184	buffer (guest VRAM) directly or not. See <link
14185	to="IFramebuffer::requestResize"/> for more information.
14186	</desc>
14187	</attribute>
14188
14189	<attribute name="heightReduction" type="unsigned long" readonly="yes">
14190	<desc>
14191	Hint from the frame buffer about how much of the standard
14192	screen height it wants to use for itself. This information is
14193	exposed to the guest through the VESA BIOS and VMMDev interface
14194	so that it can use it for determining its video mode table. It
14195	is not guaranteed that the guest respects the value.
14196	</desc>
14197	</attribute>
14198
14199	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
14200	<desc>
14201	An alpha-blended overlay which is superposed over the frame buffer.
14202	The initial purpose is to allow the display of icons providing
14203	information about the VM state, including disk activity, in front
14204	ends which do not have other means of doing that. The overlay is
14205	designed to controlled exclusively by IDisplay. It has no locking
14206	of its own, and any changes made to it are not guaranteed to be
14207	visible until the affected portion of IFramebuffer is updated. The
14208	overlay can be created lazily the first time it is requested. This
14209	attribute can also return @c null to signal that the overlay is not
14210	implemented.
14211	</desc>
14212	</attribute>
14213
14214	<attribute name="winId" type="long long" readonly="yes">
14215	<desc>
14216	Platform-dependent identifier of the window where context of this
14217	frame buffer is drawn, or zero if there's no such window.
14218	</desc>
14219	</attribute>
14220
14221	<method name="lock">
14222	<desc>
14223	Locks the frame buffer.
14224	Gets called by the IDisplay object where this frame buffer is
14225	bound to.
14226	</desc>
14227	</method>
14228
14229	<method name="unlock">
14230	<desc>
14231	Unlocks the frame buffer.
14232	Gets called by the IDisplay object where this frame buffer is
14233	bound to.
14234	</desc>
14235	</method>
14236
14237	<method name="notifyUpdate">
14238	<desc>
14239	Informs about an update.
14240	Gets called by the display object where this buffer is
14241	registered.
14242	</desc>
14243	<param name="x" type="unsigned long" dir="in"/>
14244	<param name="y" type="unsigned long" dir="in"/>
14245	<param name="width" type="unsigned long" dir="in"/>
14246	<param name="height" type="unsigned long" dir="in"/>
14247	</method>
14248
14249	<method name="requestResize">
14250	<desc>
14251	Requests a size and pixel format change.
14252
14253	There are two modes of working with the video buffer of the virtual
14254	machine. The <i>indirect</i> mode implies that the IFramebuffer
14255	implementation allocates a memory buffer for the requested display mode
14256	and provides it to the virtual machine. In <i>direct</i> mode, the
14257	IFramebuffer implementation uses the memory buffer allocated and owned
14258	by the virtual machine. This buffer represents the video memory of the
14259	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
14260	usually faster because the implementation gets a raw pointer to the
14261	guest VRAM buffer which it can directly use for visualizing the contents
14262	of the virtual display, as opposed to the indirect mode where the
14263	contents of guest VRAM are copied to the memory buffer provided by
14264	the implementation every time a display update occurs.
14265
14266	It is important to note that the direct mode is really fast only when
14267	the implementation uses the given guest VRAM buffer directly, for
14268	example, by blitting it to the window representing the virtual machine's
14269	display, which saves at least one copy operation comparing to the
14270	indirect mode. However, using the guest VRAM buffer directly is not
14271	always possible: the format and the color depth of this buffer may be
14272	not supported by the target window, or it may be unknown (opaque) as in
14273	case of text or non-linear multi-plane VGA video modes. In this case,
14274	the indirect mode (that is always available) should be used as a
14275	fallback: when the guest VRAM contents are copied to the
14276	implementation-provided memory buffer, color and format conversion is
14277	done automatically by the underlying code.
14278
14279	The @a pixelFormat parameter defines whether the direct mode is
14280	available or not. If @a pixelFormat is <link
14281	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
14282	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
14283	@a bytesPerLine parameters must be ignored and the implementation must use
14284	the indirect mode (where it provides its own buffer in one of the
14285	supported formats). In all other cases, @a pixelFormat together with
14286	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
14287	buffer pointed to by the @a VRAM parameter and the implementation is
14288	free to choose which mode to use. To indicate that this frame buffer uses
14289	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
14290	attribute must return @c true and <link to="#address"/> must
14291	return exactly the same address that is passed in the @a VRAM parameter
14292	of this method; otherwise it is assumed that the indirect strategy is
14293	chosen.
14294
14295	The @a width and @a height parameters represent the size of the
14296	requested display mode in both modes. In case of indirect mode, the
14297	provided memory buffer should be big enough to store data of the given
14298	display mode. In case of direct mode, it is guaranteed that the given
14299	@a VRAM buffer contains enough space to represent the display mode of the
14300	given size. Note that this frame buffer's <link to="#width"/> and <link
14301	to="#height"/> attributes must return exactly the same values as
14302	passed to this method after the resize is completed (see below).
14303
14304	The @a finished output parameter determines if the implementation has
14305	finished resizing the frame buffer or not. If, for some reason, the
14306	resize cannot be finished immediately during this call, @a finished
14307	must be set to @c false, and the implementation must call
14308	<link to="IDisplay::resizeCompleted"/> after it has returned from
14309	this method as soon as possible. If @a finished is @c false, the
14310	machine will not call any frame buffer methods until
14311	<link to="IDisplay::resizeCompleted"/> is called.
14312
14313	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
14314	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
14315	this frame buffer must return exactly the same values as specified in the
14316	parameters of this method, after the resize is completed. If the
14317	indirect mode is chosen, these attributes must return values describing
14318	the format of the implementation's own memory buffer <link
14319	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
14320	value must always correlate with <link to="#pixelFormat"/>. Note that
14321	the <link to="#pixelFormat"/> attribute must never return <link
14322	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
14323
14324	<note>
14325	This method is called by the IDisplay object under the
14326	<link to="#lock"/> provided by this IFramebuffer
14327	implementation. If this method returns @c false in @a finished, then
14328	this lock is not released until
14329	<link to="IDisplay::resizeCompleted"/> is called.
14330	</note>
14331	</desc>
14332	<param name="screenId" type="unsigned long" dir="in">
14333	<desc>
14334	Logical screen number. Must be used in the corresponding call to
14335	<link to="IDisplay::resizeCompleted"/> if this call is made.
14336	</desc>
14337	</param>
14338	<param name="pixelFormat" type="unsigned long" dir="in">
14339	<desc>
14340	Pixel format of the memory buffer pointed to by @a VRAM.
14341	See also <link to="FramebufferPixelFormat"/>.
14342	</desc>
14343	</param>
14344	<param name="VRAM" type="octet" mod="ptr" dir="in">
14345	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
14346	</param>
14347	<param name="bitsPerPixel" type="unsigned long" dir="in">
14348	<desc>Color depth, bits per pixel.</desc>
14349	</param>
14350	<param name="bytesPerLine" type="unsigned long" dir="in">
14351	<desc>Size of one scan line, in bytes.</desc>
14352	</param>
14353	<param name="width" type="unsigned long" dir="in">
14354	<desc>Width of the guest display, in pixels.</desc>
14355	</param>
14356	<param name="height" type="unsigned long" dir="in">
14357	<desc>Height of the guest display, in pixels.</desc>
14358	</param>
14359	<param name="finished" type="boolean" dir="return">
14360	<desc>
14361	Can the VM start using the new frame buffer immediately
14362	after this method returns or it should wait for
14363	<link to="IDisplay::resizeCompleted"/>.
14364	</desc>
14365	</param>
14366	</method>
14367
14368	<method name="videoModeSupported">
14369	<desc>
14370	Returns whether the frame buffer implementation is willing to
14371	support a given video mode. In case it is not able to render
14372	the video mode (or for some reason not willing), it should
14373	return @c false. Usually this method is called when the guest
14374	asks the VMM device whether a given video mode is supported
14375	so the information returned is directly exposed to the guest.
14376	It is important that this method returns very quickly.
14377	</desc>
14378	<param name="width" type="unsigned long" dir="in"/>
14379	<param name="height" type="unsigned long" dir="in"/>
14380	<param name="bpp" type="unsigned long" dir="in"/>
14381	<param name="supported" type="boolean" dir="return"/>
14382	</method>
14383
14384	<method name="getVisibleRegion">
14385	<desc>
14386	Returns the visible region of this frame buffer.
14387
14388	If the @a rectangles parameter is @c null then the value of the
14389	@a count parameter is ignored and the number of elements necessary to
14390	describe the current visible region is returned in @a countCopied.
14391
14392	If @a rectangles is not @c null but @a count is less
14393	than the required number of elements to store region data, the method
14394	will report a failure. If @a count is equal or greater than the
14395	required number of elements, then the actual number of elements copied
14396	to the provided array will be returned in @a countCopied.
14397
14398	<note>
14399	The address of the provided array must be in the process space of
14400	this IFramebuffer object.
14401	</note>
14402	<note>
14403	Method not yet implemented.
14404	</note>
14405	</desc>
14406	<param name="rectangles" type="octet" mod="ptr" dir="in">
14407	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
14408	</param>
14409	<param name="count" type="unsigned long" dir="in">
14410	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14411	</param>
14412	<param name="countCopied" type="unsigned long" dir="return">
14413	<desc>Number of elements copied to the @a rectangles array.</desc>
14414	</param>
14415	</method>
14416
14417	<method name="setVisibleRegion">
14418	<desc>
14419	Suggests a new visible region to this frame buffer. This region
14420	represents the area of the VM display which is a union of regions of
14421	all top-level windows of the guest operating system running inside the
14422	VM (if the Guest Additions for this system support this
14423	functionality). This information may be used by the frontends to
14424	implement the seamless desktop integration feature.
14425
14426	<note>
14427	The address of the provided array must be in the process space of
14428	this IFramebuffer object.
14429	</note>
14430	<note>
14431	The IFramebuffer implementation must make a copy of the provided
14432	array of rectangles.
14433	</note>
14434	<note>
14435	Method not yet implemented.
14436	</note>
14437	</desc>
14438	<param name="rectangles" type="octet" mod="ptr" dir="in">
14439	<desc>Pointer to the @c RTRECT array.</desc>
14440	</param>
14441	<param name="count" type="unsigned long" dir="in">
14442	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14443	</param>
14444	</method>
14445
14446	<method name="processVHWACommand">
14447	<desc>
14448	Posts a Video HW Acceleration Command to the frame buffer for processing.
14449	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
14450	are posted from quest to the host to be processed by the host hardware.
14451
14452	<note>
14453	The address of the provided command must be in the process space of
14454	this IFramebuffer object.
14455	</note>
14456	</desc>
14457
14458	<param name="command" type="octet" mod="ptr" dir="in">
14459	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
14460	</param>
14461	</method>
14462
14463	</interface>
14464
14465	<interface
14466	name="IFramebufferOverlay" extends="IFramebuffer"
14467	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
14468	wsmap="suppress"
14469	>
14470	<desc>
14471	The IFramebufferOverlay interface represents an alpha blended overlay
14472	for displaying status icons above an IFramebuffer. It is always created
14473	not visible, so that it must be explicitly shown. It only covers a
14474	portion of the IFramebuffer, determined by its width, height and
14475	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
14476	that order) format, and may be written to directly. Do re-read the
14477	width though, after setting it, as it may be adjusted (increased) to
14478	make it more suitable for the front end.
14479	</desc>
14480	<attribute name="x" type="unsigned long" readonly="yes">
14481	<desc>X position of the overlay, relative to the frame buffer.</desc>
14482	</attribute>
14483
14484	<attribute name="y" type="unsigned long" readonly="yes">
14485	<desc>Y position of the overlay, relative to the frame buffer.</desc>
14486	</attribute>
14487
14488	<attribute name="visible" type="boolean">
14489	<desc>
14490	Whether the overlay is currently visible.
14491	</desc>
14492	</attribute>
14493
14494	<attribute name="alpha" type="unsigned long">
14495	<desc>
14496	The global alpha value for the overlay. This may or may not be
14497	supported by a given front end.
14498	</desc>
14499	</attribute>
14500
14501	<method name="move">
14502	<desc>
14503	Changes the overlay's position relative to the IFramebuffer.
14504	</desc>
14505	<param name="x" type="unsigned long" dir="in"/>
14506	<param name="y" type="unsigned long" dir="in"/>
14507	</method>
14508
14509	</interface>
14510
14511	<interface
14512	name="IDisplay" extends="$unknown"
14513	uuid="b83ee395-8679-40ca-8d60-1a0cbe724930"
14514	wsmap="managed"
14515	>
14516	<desc>
14517	The IDisplay interface represents the virtual machine's display.
14518
14519	The object implementing this interface is contained in each
14520	<link to="IConsole::display"/> attribute and represents the visual
14521	output of the virtual machine.
14522
14523	The virtual display supports pluggable output targets represented by the
14524	IFramebuffer interface. Examples of the output target are a window on
14525	the host computer or an RDP session's display on a remote computer.
14526	</desc>
14527	<method name="getScreenResolution">
14528	<desc>Queries display width, height and color depth for given screen.</desc>
14529	<param name="screenId" type="unsigned long" dir="in"/>
14530	<param name="width" type="unsigned long" dir="out"/>
14531	<param name="height" type="unsigned long" dir="out"/>
14532	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
14533	</method>
14534
14535	<method name="setFramebuffer">
14536	<desc>
14537	Sets the framebuffer for given screen.
14538	</desc>
14539	<param name="screenId" type="unsigned long" dir="in"/>
14540	<param name="framebuffer" type="IFramebuffer" dir="in"/>
14541	</method>
14542
14543	<method name="getFramebuffer">
14544	<desc>
14545	Queries the framebuffer for given screen.
14546	</desc>
14547	<param name="screenId" type="unsigned long" dir="in"/>
14548	<param name="framebuffer" type="IFramebuffer" dir="out"/>
14549	<param name="xOrigin" type="long" dir="out"/>
14550	<param name="yOrigin" type="long" dir="out"/>
14551	</method>
14552
14553	<method name="setVideoModeHint">
14554	<desc>
14555	Asks VirtualBox to request the given video mode from
14556	the guest. This is just a hint and it cannot be guaranteed
14557	that the requested resolution will be used. Guest Additions
14558	are required for the request to be seen by guests. The caller
14559	should issue the request and wait for a resolution change and
14560	after a timeout retry.
14561
14562	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
14563	parameters means that the corresponding values should be taken from the
14564	current video mode (i.e. left unchanged).
14565
14566	If the guest OS supports multi-monitor configuration then the @a display
14567	parameter specifies the number of the guest display to send the hint to:
14568	@c 0 is the primary display, @c 1 is the first secondary and
14569	so on. If the multi-monitor configuration is not supported, @a display
14570	must be @c 0.
14571
14572	<result name="E_INVALIDARG">
14573	The @a display is not associated with any monitor.
14574	</result>
14575
14576	</desc>
14577	<param name="display" type="unsigned long" dir="in">
14578	<desc>
14579	The number of the guest display to send the hint to.
14580	</desc>
14581	</param>
14582	<param name="enabled" type="boolean" dir="in">
14583	<desc>
14584	@c True, if this guest screen is enabled,
14585	@c False otherwise.
14586	</desc>
14587	</param>
14588	<param name="changeOrigin" type="boolean" dir="in">
14589	<desc>
14590	@c True, if the origin of the guest screen should be changed,
14591	@c False otherwise.
14592	</desc>
14593	</param>
14594	<param name="originX" type="long" dir="in">
14595	<desc>
14596	The X origin of the guest screen.
14597	</desc>
14598	</param>
14599	<param name="originY" type="long" dir="in">
14600	<desc>
14601	The Y origin of the guest screen.
14602	</desc>
14603	</param>
14604	<param name="width" type="unsigned long" dir="in"/>
14605	<param name="height" type="unsigned long" dir="in"/>
14606	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
14607	</method>
14608
14609	<method name="setSeamlessMode">
14610	<desc>
14611	Enables or disables seamless guest display rendering (seamless desktop
14612	integration) mode.
14613	<note>
14614	Calling this method has no effect if <link
14615	to="IGuest::getFacilityStatus"/> with facility @c Seamless
14616	does not return @c Active.
14617	</note>
14618	</desc>
14619	<param name="enabled" type="boolean" dir="in"/>
14620	</method>
14621
14622	<method name="takeScreenShot">
14623	<desc>
14624	Takes a screen shot of the requested size and copies it to the
14625	32-bpp buffer allocated by the caller and pointed to by @a address.
14626	A pixel consists of 4 bytes in order: B, G, R, 0.
14627
14628	<note>This API can be used only locally by a VM process through the
14629	COM/XPCOM C++ API as it requires pointer support. It is not
14630	available for scripting langages, Java or any webservice clients.
14631	Unless you are writing a new VM frontend use
14632	<link to="#takeScreenShotToArray" />.
14633	</note>
14634
14635	<result name="E_NOTIMPL">
14636	Feature not implemented.
14637	</result>
14638	<result name="VBOX_E_IPRT_ERROR">
14639	Could not take a screenshot.
14640	</result>
14641
14642	</desc>
14643	<param name="screenId" type="unsigned long" dir="in"/>
14644	<param name="address" type="octet" mod="ptr" dir="in"/>
14645	<param name="width" type="unsigned long" dir="in"/>
14646	<param name="height" type="unsigned long" dir="in"/>
14647	</method>
14648
14649	<method name="takeScreenShotToArray">
14650	<desc>
14651	Takes a guest screen shot of the requested size and returns it as
14652	an array of bytes in uncompressed 32-bit RGBA format.
14653	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
14654
14655	This API is slow, but could be the only option to get guest screenshot
14656	for scriptable languages not allowed to manipulate with addresses
14657	directly.
14658
14659	<result name="E_NOTIMPL">
14660	Feature not implemented.
14661	</result>
14662	<result name="VBOX_E_IPRT_ERROR">
14663	Could not take a screenshot.
14664	</result>
14665	</desc>
14666	<param name="screenId" type="unsigned long" dir="in">
14667	<desc>
14668	Monitor to take screenshot from.
14669	</desc>
14670	</param>
14671	<param name="width" type="unsigned long" dir="in">
14672	<desc>
14673	Desired image width.
14674	</desc>
14675	</param>
14676	<param name="height" type="unsigned long" dir="in">
14677	<desc>
14678	Desired image height.
14679	</desc>
14680	</param>
14681	<param name="screenData" type="octet" dir="return" safearray="yes">
14682	<desc>
14683	Array with resulting screen data.
14684	</desc>
14685	</param>
14686	</method>
14687
14688	<method name="takeScreenShotPNGToArray">
14689	<desc>
14690	Takes a guest screen shot of the requested size and returns it as
14691	PNG image in array.
14692
14693	<result name="E_NOTIMPL">
14694	Feature not implemented.
14695	</result>
14696	<result name="VBOX_E_IPRT_ERROR">
14697	Could not take a screenshot.
14698	</result>
14699	</desc>
14700	<param name="screenId" type="unsigned long" dir="in">
14701	<desc>
14702	Monitor to take the screenshot from.
14703	</desc>
14704	</param>
14705	<param name="width" type="unsigned long" dir="in">
14706	<desc>
14707	Desired image width.
14708	</desc>
14709	</param>
14710	<param name="height" type="unsigned long" dir="in">
14711	<desc>
14712	Desired image height.
14713	</desc>
14714	</param>
14715	<param name="screenData" type="octet" dir="return" safearray="yes">
14716	<desc>
14717	Array with resulting screen data.
14718	</desc>
14719	</param>
14720	</method>
14721
14722	<method name="drawToScreen">
14723	<desc>
14724	Draws a 32-bpp image of the specified size from the given buffer
14725	to the given point on the VM display.
14726
14727	<result name="E_NOTIMPL">
14728	Feature not implemented.
14729	</result>
14730	<result name="VBOX_E_IPRT_ERROR">
14731	Could not draw to screen.
14732	</result>
14733
14734	</desc>
14735	<param name="screenId" type="unsigned long" dir="in">
14736	<desc>
14737	Monitor to take the screenshot from.
14738	</desc>
14739	</param>
14740	<param name="address" type="octet" mod="ptr" dir="in">
14741	<desc>
14742	Address to store the screenshot to
14743	</desc>
14744	</param>
14745	<param name="x" type="unsigned long" dir="in">
14746	<desc>
14747	Relative to the screen top left corner.
14748	</desc>
14749	</param>
14750	<param name="y" type="unsigned long" dir="in">
14751	<desc>
14752	Relative to the screen top left corner.
14753	</desc>
14754	</param>
14755	<param name="width" type="unsigned long" dir="in">
14756	<desc>
14757	Desired image width.
14758	</desc>
14759	</param>
14760	<param name="height" type="unsigned long" dir="in">
14761	<desc>
14762	Desired image height.
14763	</desc>
14764	</param>
14765	</method>
14766
14767	<method name="invalidateAndUpdate">
14768	<desc>
14769	Does a full invalidation of the VM display and instructs the VM
14770	to update it.
14771
14772	<result name="VBOX_E_IPRT_ERROR">
14773	Could not invalidate and update screen.
14774	</result>
14775
14776	</desc>
14777	</method>
14778
14779	<method name="resizeCompleted">
14780	<desc>
14781	Signals that a framebuffer has completed the resize operation.
14782
14783	<result name="VBOX_E_NOT_SUPPORTED">
14784	Operation only valid for external frame buffers.
14785	</result>
14786
14787	</desc>
14788	<param name="screenId" type="unsigned long" dir="in"/>
14789	</method>
14790
14791	<method name="completeVHWACommand">
14792	<desc>
14793	Signals that the Video HW Acceleration command has completed.
14794	</desc>
14795
14796	<param name="command" type="octet" mod="ptr" dir="in">
14797	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
14798	</param>
14799	</method>
14800
14801	<method name="viewportChanged">
14802	<desc>
14803	Signals that framebuffer window viewport has changed.
14804
14805	<result name="E_INVALIDARG">
14806	The specified viewport data is invalid.
14807	</result>
14808
14809	</desc>
14810
14811	<param name="screenId" type="unsigned long" dir="in">
14812	<desc>
14813	Monitor to take the screenshot from.
14814	</desc>
14815	</param>
14816	<param name="x" type="unsigned long" dir="in">
14817	<desc>
14818	Framebuffer x offset.
14819	</desc>
14820	</param>
14821	<param name="y" type="unsigned long" dir="in">
14822	<desc>
14823	Framebuffer y offset.
14824	</desc>
14825	</param>
14826	<param name="width" type="unsigned long" dir="in">
14827	<desc>
14828	Viewport width.
14829	</desc>
14830	</param>
14831	<param name="height" type="unsigned long" dir="in">
14832	<desc>
14833	Viewport height.
14834	</desc>
14835	</param>
14836	</method>
14837	</interface>
14838
14839	<!--
14840	// INetworkAdapter
14841	/////////////////////////////////////////////////////////////////////////
14842	-->
14843
14844	<enum
14845	name="NetworkAttachmentType"
14846	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
14847	>
14848	<desc>
14849	Network attachment type.
14850	</desc>
14851
14852	<const name="Null" value="0">
14853	<desc>Null value, also means "not attached".</desc>
14854	</const>
14855	<const name="NAT" value="1"/>
14856	<const name="Bridged" value="2"/>
14857	<const name="Internal" value="3"/>
14858	<const name="HostOnly" value="4"/>
14859	<const name="Generic" value="5"/>
14860	</enum>
14861
14862	<enum
14863	name="NetworkAdapterType"
14864	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
14865	>
14866	<desc>
14867	Network adapter type.
14868	</desc>
14869
14870	<const name="Null" value="0">
14871	<desc>Null value (never used by the API).</desc>
14872	</const>
14873	<const name="Am79C970A" value="1">
14874	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
14875	</const>
14876	<const name="Am79C973" value="2">
14877	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
14878	</const>
14879	<const name="I82540EM" value="3">
14880	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
14881	</const>
14882	<const name="I82543GC" value="4">
14883	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
14884	</const>
14885	<const name="I82545EM" value="5">
14886	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
14887	</const>
14888	<const name="Virtio" value="6">
14889	<desc>Virtio network device.</desc>
14890	</const>
14891	</enum>
14892
14893	<enum
14894	name="NetworkAdapterPromiscModePolicy"
14895	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
14896	>
14897	<desc>
14898	The promiscuous mode policy of an interface.
14899	</desc>
14900
14901	<const name="Deny" value="1">
14902	<desc>Deny promiscuous mode requests.</desc>
14903	</const>
14904	<const name="AllowNetwork" value="2">
14905	<desc>
14906	Allow promicuous mode, but restrict the scope it to the internal
14907	network so that it only applies to other VMs.
14908	</desc>
14909	</const>
14910	<const name="AllowAll" value="3">
14911	<desc>
14912	Allow promicuous mode, include unrelated traffic going over the wire
14913	and internally on the host.
14914	</desc>
14915	</const>
14916	</enum>
14917
14918	<interface
14919	name="INetworkAdapter" extends="$unknown"
14920	uuid="efa0f965-63c7-4c60-afdf-b1cc9943b9c0"
14921	wsmap="managed"
14922	>
14923	<desc>
14924	Represents a virtual network adapter that is attached to a virtual machine.
14925	Each virtual machine has a fixed number of network adapter slots with one
14926	instance of this attached to each of them. Call
14927	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
14928	is attached to a given slot in a given machine.
14929
14930	Each network adapter can be in one of five attachment modes, which are
14931	represented by the <link to="NetworkAttachmentType" /> enumeration;
14932	see the <link to="#attachmentType" /> attribute.
14933	</desc>
14934
14935	<attribute name="adapterType" type="NetworkAdapterType">
14936	<desc>
14937	Type of the virtual network adapter. Depending on this value,
14938	VirtualBox will provide a different virtual network hardware
14939	to the guest.
14940	</desc>
14941	</attribute>
14942
14943	<attribute name="slot" type="unsigned long" readonly="yes">
14944	<desc>
14945	Slot number this adapter is plugged into. Corresponds to
14946	the value you pass to <link to="IMachine::getNetworkAdapter"/>
14947	to obtain this instance.
14948	</desc>
14949	</attribute>
14950
14951	<attribute name="enabled" type="boolean">
14952	<desc>
14953	Flag whether the network adapter is present in the
14954	guest system. If disabled, the virtual guest hardware will
14955	not contain this network adapter. Can only be changed when
14956	the VM is not running.
14957	</desc>
14958	</attribute>
14959
14960	<attribute name="MACAddress" type="wstring">
14961	<desc>
14962	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
14963	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
14964	</desc>
14965	</attribute>
14966
14967	<attribute name="attachmentType" type="NetworkAttachmentType">
14968	<desc>
14969	Sets/Gets network attachment type of this network adapter.
14970	</desc>
14971	</attribute>
14972
14973	<attribute name="bridgedInterface" type="wstring">
14974	<desc>
14975	Name of the network interface the VM should be bridged to.
14976	</desc>
14977	</attribute>
14978
14979	<attribute name="hostOnlyInterface" type="wstring">
14980	<desc>
14981	Name of the host only network interface the VM is attached to.
14982	</desc>
14983	</attribute>
14984
14985	<attribute name="internalNetwork" type="wstring">
14986	<desc>
14987	Name of the internal network the VM is attached to.
14988	</desc>
14989	</attribute>
14990
14991	<attribute name="NATNetwork" type="wstring">
14992	<desc>
14993	Name of the NAT network the VM is attached to.
14994	</desc>
14995	</attribute>
14996
14997	<attribute name="genericDriver" type="wstring">
14998	<desc>
14999	Name of the driver to use for the "Generic" network attachment type.
15000	</desc>
15001	</attribute>
15002
15003	<attribute name="cableConnected" type="boolean">
15004	<desc>
15005	Flag whether the adapter reports the cable as connected or not.
15006	It can be used to report offline situations to a VM.
15007	</desc>
15008	</attribute>
15009
15010	<attribute name="lineSpeed" type="unsigned long">
15011	<desc>
15012	Line speed reported by custom drivers, in units of 1 kbps.
15013	</desc>
15014	</attribute>
15015
15016	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
15017	<desc>
15018	The promiscuous mode policy of the network adapter when attached to an
15019	internal network, host only network or a bridge.
15020	</desc>
15021	</attribute>
15022
15023	<attribute name="traceEnabled" type="boolean">
15024	<desc>
15025	Flag whether network traffic from/to the network card should be traced.
15026	Can only be toggled when the VM is turned off.
15027	</desc>
15028	</attribute>
15029
15030	<attribute name="traceFile" type="wstring">
15031	<desc>
15032	Filename where a network trace will be stored. If not set, VBox-pid.pcap
15033	will be used.
15034	</desc>
15035	</attribute>
15036
15037	<attribute name="NATEngine" type="INATEngine" readonly="yes">
15038	<desc>
15039	Points to the NAT engine which handles the network address translation
15040	for this interface. This is active only when the interface actually uses
15041	NAT.
15042	</desc>
15043	</attribute>
15044
15045	<attribute name="bootPriority" type="unsigned long">
15046	<desc>
15047	Network boot priority of the adapter. Priority 1 is highest. If not set,
15048	the priority is considered to be at the lowest possible setting.
15049	</desc>
15050	</attribute>
15051
15052	<attribute name="bandwidthGroup" type="IBandwidthGroup">
15053	<desc>The bandwidth group this network adapter is assigned to.</desc>
15054	</attribute>
15055
15056	<!-- property methods -->
15057
15058	<method name="getProperty" const="yes">
15059	<desc>
15060	Returns the value of the network attachment property with the given name.
15061
15062	If the requested data @a key does not exist, this function will
15063	succeed and return an empty string in the @a value argument.
15064
15065	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
15066	</desc>
15067	<param name="key" type="wstring" dir="in">
15068	<desc>Name of the property to get.</desc>
15069	</param>
15070	<param name="value" type="wstring" dir="return">
15071	<desc>Current property value.</desc>
15072	</param>
15073	</method>
15074
15075	<method name="setProperty">
15076	<desc>
15077	Sets the value of the network attachment property with the given name.
15078
15079	Setting the property value to @c null or an empty string is equivalent
15080	to deleting the existing value.
15081
15082	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
15083	</desc>
15084	<param name="key" type="wstring" dir="in">
15085	<desc>Name of the property to set.</desc>
15086	</param>
15087	<param name="value" type="wstring" dir="in">
15088	<desc>Property value to set.</desc>
15089	</param>
15090	</method>
15091
15092	<method name="getProperties" const="yes">
15093	<desc>
15094	Returns values for a group of properties in one call.
15095
15096	The names of the properties to get are specified using the @a names
15097	argument which is a list of comma-separated property names or
15098	an empty string if all properties are to be returned.
15099	<note>Currently the value of this argument is ignored and the method
15100	always returns all existing properties.</note>
15101
15102	The method returns two arrays, the array of property names corresponding
15103	to the @a names argument and the current values of these properties.
15104	Both arrays have the same number of elements with each element at the
15105	given index in the first array corresponds to an element at the same
15106	index in the second array.
15107	</desc>
15108	<param name="names" type="wstring" dir="in">
15109	<desc>
15110	Names of properties to get.
15111	</desc>
15112	</param>
15113	<param name="returnNames" type="wstring" safearray="yes" dir="out">
15114	<desc>Names of returned properties.</desc>
15115	</param>
15116	<param name="returnValues" type="wstring" safearray="yes" dir="return">
15117	<desc>Values of returned properties.</desc>
15118	</param>
15119	</method>
15120
15121	</interface>
15122
15123
15124	<!--
15125	// ISerialPort
15126	/////////////////////////////////////////////////////////////////////////
15127	-->
15128
15129	<enum
15130	name="PortMode"
15131	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
15132	>
15133	<desc>
15134	The PortMode enumeration represents possible communication modes for
15135	the virtual serial port device.
15136	</desc>
15137
15138	<const name="Disconnected" value="0">
15139	<desc>Virtual device is not attached to any real host device.</desc>
15140	</const>
15141	<const name="HostPipe" value="1">
15142	<desc>Virtual device is attached to a host pipe.</desc>
15143	</const>
15144	<const name="HostDevice" value="2">
15145	<desc>Virtual device is attached to a host device.</desc>
15146	</const>
15147	<const name="RawFile" value="3">
15148	<desc>Virtual device is attached to a raw file.</desc>
15149	</const>
15150	</enum>
15151
15152	<interface
15153	name="ISerialPort" extends="$unknown"
15154	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
15155	wsmap="managed"
15156	>
15157
15158	<desc>
15159	The ISerialPort interface represents the virtual serial port device.
15160
15161	The virtual serial port device acts like an ordinary serial port
15162	inside the virtual machine. This device communicates to the real
15163	serial port hardware in one of two modes: host pipe or host device.
15164
15165	In host pipe mode, the #path attribute specifies the path to the pipe on
15166	the host computer that represents a serial port. The #server attribute
15167	determines if this pipe is created by the virtual machine process at
15168	machine startup or it must already exist before starting machine
15169	execution.
15170
15171	In host device mode, the #path attribute specifies the name of the
15172	serial port device on the host computer.
15173
15174	There is also a third communication mode: the disconnected mode. In this
15175	mode, the guest OS running inside the virtual machine will be able to
15176	detect the serial port, but all port write operations will be discarded
15177	and all port read operations will return no data.
15178
15179	<see><link to="IMachine::getSerialPort"/></see>
15180	</desc>
15181
15182	<attribute name="slot" type="unsigned long" readonly="yes">
15183	<desc>
15184	Slot number this serial port is plugged into. Corresponds to
15185	the value you pass to <link to="IMachine::getSerialPort"/>
15186	to obtain this instance.
15187	</desc>
15188	</attribute>
15189
15190	<attribute name="enabled" type="boolean">
15191	<desc>
15192	Flag whether the serial port is enabled. If disabled,
15193	the serial port will not be reported to the guest OS.
15194	</desc>
15195	</attribute>
15196
15197	<attribute name="IOBase" type="unsigned long">
15198	<desc>Base I/O address of the serial port.</desc>
15199	</attribute>
15200
15201	<attribute name="IRQ" type="unsigned long">
15202	<desc>IRQ number of the serial port.</desc>
15203	</attribute>
15204
15205	<attribute name="hostMode" type="PortMode">
15206	<desc>
15207	How is this port connected to the host.
15208	<note>
15209	Changing this attribute may fail if the conditions for
15210	<link to="#path"/> are not met.
15211	</note>
15212	</desc>
15213	</attribute>
15214
15215	<attribute name="server" type="boolean">
15216	<desc>
15217	Flag whether this serial port acts as a server (creates a new pipe on
15218	the host) or as a client (uses the existing pipe). This attribute is
15219	used only when <link to="#hostMode"/> is PortMode_HostPipe.
15220	</desc>
15221	</attribute>
15222
15223	<attribute name="path" type="wstring">
15224	<desc>
15225	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
15226	PortMode_HostPipe, or the host serial device name when
15227	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
15228	cases, setting a @c null or empty string as the attribute's value
15229	is an error. Otherwise, the value of this property is ignored.
15230	</desc>
15231	</attribute>
15232
15233	</interface>
15234
15235	<!--
15236	// IParallelPort
15237	/////////////////////////////////////////////////////////////////////////
15238	-->
15239
15240	<interface
15241	name="IParallelPort" extends="$unknown"
15242	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
15243	wsmap="managed"
15244	>
15245
15246	<desc>
15247	The IParallelPort interface represents the virtual parallel port device.
15248
15249	The virtual parallel port device acts like an ordinary parallel port
15250	inside the virtual machine. This device communicates to the real
15251	parallel port hardware using the name of the parallel device on the host
15252	computer specified in the #path attribute.
15253
15254	Each virtual parallel port device is assigned a base I/O address and an
15255	IRQ number that will be reported to the guest operating system and used
15256	to operate the given parallel port from within the virtual machine.
15257
15258	<see><link to="IMachine::getParallelPort"/></see>
15259	</desc>
15260
15261	<attribute name="slot" type="unsigned long" readonly="yes">
15262	<desc>
15263	Slot number this parallel port is plugged into. Corresponds to
15264	the value you pass to <link to="IMachine::getParallelPort"/>
15265	to obtain this instance.
15266	</desc>
15267	</attribute>
15268
15269	<attribute name="enabled" type="boolean">
15270	<desc>
15271	Flag whether the parallel port is enabled. If disabled,
15272	the parallel port will not be reported to the guest OS.
15273	</desc>
15274	</attribute>
15275
15276	<attribute name="IOBase" type="unsigned long">
15277	<desc>Base I/O address of the parallel port.</desc>
15278	</attribute>
15279
15280	<attribute name="IRQ" type="unsigned long">
15281	<desc>IRQ number of the parallel port.</desc>
15282	</attribute>
15283
15284	<attribute name="path" type="wstring">
15285	<desc>
15286	Host parallel device name. If this parallel port is enabled, setting a
15287	@c null or an empty string as this attribute's value will result in
15288	an error.
15289	</desc>
15290	</attribute>
15291
15292	</interface>
15293
15294
15295	<!--
15296	// IMachineDebugger
15297	/////////////////////////////////////////////////////////////////////////
15298	-->
15299
15300	<interface
15301	name="IMachineDebugger" extends="$unknown"
15302	uuid="a80bb82c-37c5-4155-a524-9c1d0a1689ba"
15303	wsmap="managed"
15304	>
15305	<method name="dumpGuestCore">
15306	<desc>
15307	Takes a core dump of the guest.
15308
15309	See include/VBox/dbgfcorefmt.h for details on the file format.
15310	</desc>
15311	<param name="filename" type="wstring" dir="in">
15312	<desc>
15313	The name of the output file. The file must not exist.
15314	</desc>
15315	</param>
15316	<param name="compression" type="wstring" dir="in">
15317	<desc>
15318	Reserved for future compression method indicator.
15319	</desc>
15320	</param>
15321	</method>
15322
15323	<method name="dumpHostProcessCore">
15324	<desc>
15325	Takes a core dump of the VM process on the host.
15326
15327	This feature is not implemented in the 4.0.0 release but it may show up
15328	in a dot release.
15329	</desc>
15330	<param name="filename" type="wstring" dir="in">
15331	<desc>
15332	The name of the output file. The file must not exist.
15333	</desc>
15334	</param>
15335	<param name="compression" type="wstring" dir="in">
15336	<desc>
15337	Reserved for future compression method indicator.
15338	</desc>
15339	</param>
15340	</method>
15341
15342	<method name="info">
15343	<desc>
15344	Interfaces with the info dumpers (DBGFInfo).
15345
15346	This feature is not implemented in the 4.0.0 release but it may show up
15347	in a dot release.
15348	</desc>
15349	<param name="name" type="wstring" dir="in">
15350	<desc>
15351	The name of the info item.
15352	</desc>
15353	</param>
15354	<param name="args" type="wstring" dir="in">
15355	<desc>
15356	Arguments to the info dumper.
15357	</desc>
15358	</param>
15359	<param name="info" type="wstring" dir="return">
15360	<desc>
15361	The into string.
15362	</desc>
15363	</param>
15364	</method>
15365
15366	<method name="injectNMI">
15367	<desc>
15368	Inject an NMI into a running VT-x/AMD-V VM.
15369	</desc>
15370	</method>
15371
15372	<method name="modifyLogGroups">
15373	<desc>
15374	Modifies the group settings of the debug or release logger.
15375	</desc>
15376	<param name="settings" type="wstring" dir="in">
15377	<desc>
15378	The group settings string. See iprt/log.h for details. To target the
15379	release logger, prefix the string with "release:".
15380	</desc>
15381	</param>
15382	</method>
15383
15384	<method name="modifyLogFlags">
15385	<desc>
15386	Modifies the debug or release logger flags.
15387	</desc>
15388	<param name="settings" type="wstring" dir="in">
15389	<desc>
15390	The flags settings string. See iprt/log.h for details. To target the
15391	release logger, prefix the string with "release:".
15392	</desc>
15393	</param>
15394	</method>
15395
15396	<method name="modifyLogDestinations">
15397	<desc>
15398	Modifies the debug or release logger destinations.
15399	</desc>
15400	<param name="settings" type="wstring" dir="in">
15401	<desc>
15402	The destination settings string. See iprt/log.h for details. To target the
15403	release logger, prefix the string with "release:".
15404	</desc>
15405	</param>
15406	</method>
15407
15408	<method name="readPhysicalMemory">
15409	<desc>
15410	Reads guest physical memory, no side effects (MMIO++).
15411
15412	This feature is not implemented in the 4.0.0 release but may show up
15413	in a dot release.
15414	</desc>
15415	<param name="address" type="long long" dir="in">
15416	<desc>The guest physical address.</desc>
15417	</param>
15418	<param name="size" type="unsigned long" dir="in">
15419	<desc>The number of bytes to read.</desc>
15420	</param>
15421	<param name="bytes" type="octet" safearray="yes" dir="return">
15422	<desc>The bytes read.</desc>
15423	</param>
15424	</method>
15425
15426	<method name="writePhysicalMemory">
15427	<desc>
15428	Writes guest physical memory, access handles (MMIO++) are ignored.
15429
15430	This feature is not implemented in the 4.0.0 release but may show up
15431	in a dot release.
15432	</desc>
15433	<param name="address" type="long long" dir="in">
15434	<desc>The guest physical address.</desc>
15435	</param>
15436	<param name="size" type="unsigned long" dir="in">
15437	<desc>The number of bytes to read.</desc>
15438	</param>
15439	<param name="bytes" type="octet" safearray="yes" dir="in">
15440	<desc>The bytes to write.</desc>
15441	</param>
15442	</method>
15443
15444	<method name="readVirtualMemory">
15445	<desc>
15446	Reads guest virtual memory, no side effects (MMIO++).
15447
15448	This feature is not implemented in the 4.0.0 release but may show up
15449	in a dot release.
15450	</desc>
15451	<param name="cpuId" type="unsigned long" dir="in">
15452	<desc>The identifier of the Virtual CPU.</desc>
15453	</param>
15454	<param name="address" type="long long" dir="in">
15455	<desc>The guest virtual address.</desc>
15456	</param>
15457	<param name="size" type="unsigned long" dir="in">
15458	<desc>The number of bytes to read.</desc>
15459	</param>
15460	<param name="bytes" type="octet" safearray="yes" dir="return">
15461	<desc>The bytes read.</desc>
15462	</param>
15463	</method>
15464
15465	<method name="writeVirtualMemory">
15466	<desc>
15467	Writes guest virtual memory, access handles (MMIO++) are ignored.
15468
15469	This feature is not implemented in the 4.0.0 release but may show up
15470	in a dot release.
15471	</desc>
15472	<param name="cpuId" type="unsigned long" dir="in">
15473	<desc>The identifier of the Virtual CPU.</desc>
15474	</param>
15475	<param name="address" type="long long" dir="in">
15476	<desc>The guest virtual address.</desc>
15477	</param>
15478	<param name="size" type="unsigned long" dir="in">
15479	<desc>The number of bytes to read.</desc>
15480	</param>
15481	<param name="bytes" type="octet" safearray="yes" dir="in">
15482	<desc>The bytes to write.</desc>
15483	</param>
15484	</method>
15485
15486	<method name="detectOS">
15487	<desc>
15488	Tries to (re-)detect the guest OS kernel.
15489
15490	This feature is not implemented in the 4.0.0 release but may show up
15491	in a dot release.
15492	</desc>
15493	<param name="os" type="wstring" dir="return">
15494	<desc>
15495	The detected OS kernel on success.
15496	</desc>
15497	</param>
15498	</method>
15499
15500	<method name="getRegister">
15501	<desc>
15502	Gets one register.
15503
15504	This feature is not implemented in the 4.0.0 release but may show up
15505	in a dot release.
15506	</desc>
15507	<param name="cpuId" type="unsigned long" dir="in">
15508	<desc>The identifier of the Virtual CPU.</desc>
15509	</param>
15510	<param name="name" type="wstring" dir="in">
15511	<desc>The register name, case is ignored.</desc>
15512	</param>
15513	<param name="value" type="wstring" dir="return">
15514	<desc>
15515	The register value. This is usually a hex value (always 0x prefixed)
15516	but other format may be used for floating point registers (TBD).
15517	</desc>
15518	</param>
15519	</method>
15520
15521	<method name="getRegisters">
15522	<desc>
15523	Gets all the registers for the given CPU.
15524
15525	This feature is not implemented in the 4.0.0 release but may show up
15526	in a dot release.
15527	</desc>
15528	<param name="cpuId" type="unsigned long" dir="in">
15529	<desc>The identifier of the Virtual CPU.</desc>
15530	</param>
15531	<param name="names" type="wstring" dir="out" safearray="yes">
15532	<desc>Array containing the lowercase register names.</desc>
15533	</param>
15534	<param name="values" type="wstring" dir="out" safearray="yes">
15535	<desc>
15536	Array paralell to the names holding the register values as if the
15537	register was returned by <link to="IMachineDebugger::getRegister"/>.
15538	</desc>
15539	</param>
15540	</method>
15541
15542	<method name="setRegister">
15543	<desc>
15544	Gets one register.
15545
15546	This feature is not implemented in the 4.0.0 release but may show up
15547	in a dot release.
15548	</desc>
15549	<param name="cpuId" type="unsigned long" dir="in">
15550	<desc>The identifier of the Virtual CPU.</desc>
15551	</param>
15552	<param name="name" type="wstring" dir="in">
15553	<desc>The register name, case is ignored.</desc>
15554	</param>
15555	<param name="value" type="wstring" dir="in">
15556	<desc>
15557	The new register value. Hexadecimal, decimal and octal formattings
15558	are supported in addition to any special formattings returned by
15559	the getters.
15560	</desc>
15561	</param>
15562	</method>
15563
15564	<method name="setRegisters">
15565	<desc>
15566	Sets zero or more registers atomically.
15567
15568	This feature is not implemented in the 4.0.0 release but may show up
15569	in a dot release.
15570	</desc>
15571	<param name="cpuId" type="unsigned long" dir="in">
15572	<desc>The identifier of the Virtual CPU.</desc>
15573	</param>
15574	<param name="names" type="wstring" dir="in" safearray="yes">
15575	<desc>Array containing the register names, case ignored.</desc>
15576	</param>
15577	<param name="values" type="wstring" dir="in" safearray="yes">
15578	<desc>
15579	Array paralell to the names holding the register values. See
15580	<link to="IMachineDebugger::setRegister"/> for formatting
15581	guidelines.
15582	</desc>
15583	</param>
15584	</method>
15585
15586	<method name="dumpGuestStack">
15587	<desc>
15588	Produce a simple stack dump using the current guest state.
15589
15590	This feature is not implemented in the 4.0.0 release but may show up
15591	in a dot release.
15592	</desc>
15593	<param name="cpuId" type="unsigned long" dir="in">
15594	<desc>The identifier of the Virtual CPU.</desc>
15595	</param>
15596	<param name="stack" type="wstring" dir="return">
15597	<desc>String containing the formatted stack dump.</desc>
15598	</param>
15599	</method>
15600
15601	<method name="resetStats">
15602	<desc>
15603	Reset VM statistics.
15604	</desc>
15605	<param name="pattern" type="wstring" dir="in">
15606	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15607	</param>
15608	</method>
15609
15610	<method name="dumpStats">
15611	<desc>
15612	Dumps VM statistics.
15613	</desc>
15614	<param name="pattern" type="wstring" dir="in">
15615	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15616	</param>
15617	</method>
15618
15619	<method name="getStats">
15620	<desc>
15621	Get the VM statistics in a XMLish format.
15622	</desc>
15623	<param name="pattern" type="wstring" dir="in">
15624	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15625	</param>
15626	<param name="withDescriptions" type="boolean" dir="in">
15627	<desc>Whether to include the descriptions.</desc>
15628	</param>
15629	<param name="stats" type="wstring" dir="return">
15630	<desc>The XML document containing the statistics.</desc>
15631	</param>
15632	</method>
15633
15634	<attribute name="singleStep" type="boolean">
15635	<desc>Switch for enabling single-stepping.</desc>
15636	</attribute>
15637
15638	<attribute name="recompileUser" type="boolean">
15639	<desc>Switch for forcing code recompilation for user mode code.</desc>
15640	</attribute>
15641
15642	<attribute name="recompileSupervisor" type="boolean">
15643	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
15644	</attribute>
15645
15646	<attribute name="PATMEnabled" type="boolean">
15647	<desc>Switch for enabling and disabling the PATM component.</desc>
15648	</attribute>
15649
15650	<attribute name="CSAMEnabled" type="boolean">
15651	<desc>Switch for enabling and disabling the CSAM component.</desc>
15652	</attribute>
15653
15654	<attribute name="logEnabled" type="boolean">
15655	<desc>Switch for enabling and disabling the debug logger.</desc>
15656	</attribute>
15657
15658	<attribute name="logDbgFlags" type="wstring" readonly="yes">
15659	<desc>The debug logger flags.</desc>
15660	</attribute>
15661
15662	<attribute name="logDbgGroups" type="wstring" readonly="yes">
15663	<desc>The debug logger's group settings.</desc>
15664	</attribute>
15665
15666	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
15667	<desc>The debug logger's destination settings.</desc>
15668	</attribute>
15669
15670	<attribute name="logRelFlags" type="wstring" readonly="yes">
15671	<desc>The release logger flags.</desc>
15672	</attribute>
15673
15674	<attribute name="logRelGroups" type="wstring" readonly="yes">
15675	<desc>The release logger's group settings.</desc>
15676	</attribute>
15677
15678	<attribute name="logRelDestinations" type="wstring" readonly="yes">
15679	<desc>The relase logger's destination settings.</desc>
15680	</attribute>
15681
15682	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
15683	<desc>
15684	Flag indicating whether the VM is currently making use of CPU hardware
15685	virtualization extensions.
15686	</desc>
15687	</attribute>
15688
15689	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
15690	<desc>
15691	Flag indicating whether the VM is currently making use of the nested paging
15692	CPU hardware virtualization extension.
15693	</desc>
15694	</attribute>
15695
15696	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
15697	<desc>
15698	Flag indicating whether the VM is currently making use of the VPID
15699	VT-x extension.
15700	</desc>
15701	</attribute>
15702
15703	<attribute name="OSName" type="wstring" readonly="yes">
15704	<desc>
15705	Query the guest OS kernel name as detected by the DBGF.
15706
15707	This feature is not implemented in the 4.0.0 release but may show up
15708	in a dot release.
15709	</desc>
15710	</attribute>
15711
15712	<attribute name="OSVersion" type="wstring" readonly="yes">
15713	<desc>
15714	Query the guest OS kernel version string as detected by the DBGF.
15715
15716	This feature is not implemented in the 4.0.0 release but may show up
15717	in a dot release.
15718	</desc>
15719	</attribute>
15720
15721	<attribute name="PAEEnabled" type="boolean" readonly="yes">
15722	<desc>
15723	Flag indicating whether the VM is currently making use of the Physical
15724	Address Extension CPU feature.
15725	</desc>
15726	</attribute>
15727
15728	<attribute name="virtualTimeRate" type="unsigned long">
15729	<desc>
15730	The rate at which the virtual time runs expressed as a percentage.
15731	The accepted range is 2% to 20000%.
15732	</desc>
15733	</attribute>
15734
15735	<attribute name="VM" type="long long" readonly="yes" wsmap="suppress">
15736	<desc>
15737	Gets the user-mode VM handle, with a reference. Must be passed to
15738	VMR3ReleaseUVM when done. This is only for internal use while we carve
15739	the details of this interface.
15740	</desc>
15741	</attribute>
15742
15743	</interface>
15744
15745	<!--
15746	// IUSBController
15747	/////////////////////////////////////////////////////////////////////////
15748	-->
15749
15750	<interface
15751	name="IUSBController" extends="$unknown"
15752	uuid="01e6f13a-0580-452f-a40f-74e32a5e4921"
15753	wsmap="managed"
15754	>
15755	<attribute name="enabled" type="boolean">
15756	<desc>
15757	Flag whether the USB controller is present in the
15758	guest system. If disabled, the virtual guest hardware will
15759	not contain any USB controller. Can only be changed when
15760	the VM is powered off.
15761	</desc>
15762	</attribute>
15763
15764	<attribute name="enabledEHCI" type="boolean">
15765	<desc>
15766	Flag whether the USB EHCI controller is present in the
15767	guest system. If disabled, the virtual guest hardware will
15768	not contain a USB EHCI controller. Can only be changed when
15769	the VM is powered off.
15770	</desc>
15771	</attribute>
15772
15773	<attribute name="proxyAvailable" type="boolean" readonly="yes">
15774	<desc>
15775	Flag whether there is an USB proxy available.
15776	</desc>
15777	</attribute>
15778
15779	<attribute name="USBStandard" type="unsigned short" readonly="yes">
15780	<desc>
15781	USB standard version which the controller implements.
15782	This is a BCD which means that the major version is in the
15783	high byte and minor version is in the low byte.
15784	</desc>
15785	</attribute>
15786
15787	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
15788	<desc>
15789	List of USB device filters associated with the machine.
15790
15791	If the machine is currently running, these filters are activated
15792	every time a new (supported) USB device is attached to the host
15793	computer that was not ignored by global filters
15794	(<link to="IHost::USBDeviceFilters"/>).
15795
15796	These filters are also activated when the machine is powered up.
15797	They are run against a list of all currently available USB
15798	devices (in states
15799	<link to="USBDeviceState_Available"/>,
15800	<link to="USBDeviceState_Busy"/>,
15801	<link to="USBDeviceState_Held"/>) that were not previously
15802	ignored by global filters.
15803
15804	If at least one filter matches the USB device in question, this
15805	device is automatically captured (attached to) the virtual USB
15806	controller of this machine.
15807
15808	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
15809	</desc>
15810	</attribute>
15811
15812	<method name="createDeviceFilter">
15813	<desc>
15814	Creates a new USB device filter. All attributes except
15815	the filter name are set to empty (any match),
15816	<i>active</i> is @c false (the filter is not active).
15817
15818	The created filter can then be added to the list of filters using
15819	<link to="#insertDeviceFilter"/>.
15820
15821	<result name="VBOX_E_INVALID_VM_STATE">
15822	The virtual machine is not mutable.
15823	</result>
15824
15825	<see><link to="#deviceFilters"/></see>
15826	</desc>
15827	<param name="name" type="wstring" dir="in">
15828	<desc>
15829	Filter name. See <link to="IUSBDeviceFilter::name"/>
15830	for more info.
15831	</desc>
15832	</param>
15833	<param name="filter" type="IUSBDeviceFilter" dir="return">
15834	<desc>Created filter object.</desc>
15835	</param>
15836	</method>
15837
15838	<method name="insertDeviceFilter">
15839	<desc>
15840	Inserts the given USB device to the specified position
15841	in the list of filters.
15842
15843	Positions are numbered starting from <tt>0</tt>. If the specified
15844	position is equal to or greater than the number of elements in
15845	the list, the filter is added to the end of the collection.
15846
15847	<note>
15848	Duplicates are not allowed, so an attempt to insert a
15849	filter that is already in the collection, will return an
15850	error.
15851	</note>
15852
15853	<result name="VBOX_E_INVALID_VM_STATE">
15854	Virtual machine is not mutable.
15855	</result>
15856	<result name="E_INVALIDARG">
15857	USB device filter not created within this VirtualBox instance.
15858	</result>
15859	<result name="VBOX_E_INVALID_OBJECT_STATE">
15860	USB device filter already in list.
15861	</result>
15862
15863	<see><link to="#deviceFilters"/></see>
15864	</desc>
15865	<param name="position" type="unsigned long" dir="in">
15866	<desc>Position to insert the filter to.</desc>
15867	</param>
15868	<param name="filter" type="IUSBDeviceFilter" dir="in">
15869	<desc>USB device filter to insert.</desc>
15870	</param>
15871	</method>
15872
15873	<method name="removeDeviceFilter">
15874	<desc>
15875	Removes a USB device filter from the specified position in the
15876	list of filters.
15877
15878	Positions are numbered starting from <tt>0</tt>. Specifying a
15879	position equal to or greater than the number of elements in
15880	the list will produce an error.
15881
15882	<see><link to="#deviceFilters"/></see>
15883
15884	<result name="VBOX_E_INVALID_VM_STATE">
15885	Virtual machine is not mutable.
15886	</result>
15887	<result name="E_INVALIDARG">
15888	USB device filter list empty or invalid @a position.
15889	</result>
15890
15891	</desc>
15892	<param name="position" type="unsigned long" dir="in">
15893	<desc>Position to remove the filter from.</desc>
15894	</param>
15895	<param name="filter" type="IUSBDeviceFilter" dir="return">
15896	<desc>Removed USB device filter.</desc>
15897	</param>
15898	</method>
15899
15900	</interface>
15901
15902
15903	<!--
15904	// IUSBDevice
15905	/////////////////////////////////////////////////////////////////////////
15906	-->
15907
15908	<interface
15909	name="IUSBDevice" extends="$unknown"
15910	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
15911	wsmap="managed"
15912	>
15913	<desc>
15914	The IUSBDevice interface represents a virtual USB device attached to the
15915	virtual machine.
15916
15917	A collection of objects implementing this interface is stored in the
15918	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
15919	attached to a running virtual machine's USB controller.
15920	</desc>
15921
15922	<attribute name="id" type="uuid" mod="string" readonly="yes">
15923	<desc>
15924	Unique USB device ID. This ID is built from #vendorId,
15925	#productId, #revision and #serialNumber.
15926	</desc>
15927	</attribute>
15928
15929	<attribute name="vendorId" type="unsigned short" readonly="yes">
15930	<desc>Vendor ID.</desc>
15931	</attribute>
15932
15933	<attribute name="productId" type="unsigned short" readonly="yes">
15934	<desc>Product ID.</desc>
15935	</attribute>
15936
15937	<attribute name="revision" type="unsigned short" readonly="yes">
15938	<desc>
15939	Product revision number. This is a packed BCD represented as
15940	unsigned short. The high byte is the integer part and the low
15941	byte is the decimal.
15942	</desc>
15943	</attribute>
15944
15945	<attribute name="manufacturer" type="wstring" readonly="yes">
15946	<desc>Manufacturer string.</desc>
15947	</attribute>
15948
15949	<attribute name="product" type="wstring" readonly="yes">
15950	<desc>Product string.</desc>
15951	</attribute>
15952
15953	<attribute name="serialNumber" type="wstring" readonly="yes">
15954	<desc>Serial number string.</desc>
15955	</attribute>
15956
15957	<attribute name="address" type="wstring" readonly="yes">
15958	<desc>Host specific address of the device.</desc>
15959	</attribute>
15960
15961	<attribute name="port" type="unsigned short" readonly="yes">
15962	<desc>
15963	Host USB port number the device is physically
15964	connected to.
15965	</desc>
15966	</attribute>
15967
15968	<attribute name="version" type="unsigned short" readonly="yes">
15969	<desc>
15970	The major USB version of the device - 1 or 2.
15971	</desc>
15972	</attribute>
15973
15974	<attribute name="portVersion" type="unsigned short" readonly="yes">
15975	<desc>
15976	The major USB version of the host USB port the device is
15977	physically connected to - 1 or 2. For devices not connected to
15978	anything this will have the same value as the version attribute.
15979	</desc>
15980	</attribute>
15981
15982	<attribute name="remote" type="boolean" readonly="yes">
15983	<desc>
15984	Whether the device is physically connected to a remote VRDE
15985	client or to a local host machine.
15986	</desc>
15987	</attribute>
15988
15989	</interface>
15990
15991
15992	<!--
15993	// IUSBDeviceFilter
15994	/////////////////////////////////////////////////////////////////////////
15995	-->
15996
15997	<interface
15998	name="IUSBDeviceFilter" extends="$unknown"
15999	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
16000	wsmap="managed"
16001	>
16002	<desc>
16003	The IUSBDeviceFilter interface represents an USB device filter used
16004	to perform actions on a group of USB devices.
16005
16006	This type of filters is used by running virtual machines to
16007	automatically capture selected USB devices once they are physically
16008	attached to the host computer.
16009
16010	A USB device is matched to the given device filter if and only if all
16011	attributes of the device match the corresponding attributes of the
16012	filter (that is, attributes are joined together using the logical AND
16013	operation). On the other hand, all together, filters in the list of
16014	filters carry the semantics of the logical OR operation. So if it is
16015	desirable to create a match like "this vendor id OR this product id",
16016	one needs to create two filters and specify "any match" (see below)
16017	for unused attributes.
16018
16019	All filter attributes used for matching are strings. Each string
16020	is an expression representing a set of values of the corresponding
16021	device attribute, that will match the given filter. Currently, the
16022	following filtering expressions are supported:
16023
16024	<ul>
16025	<li><i>Interval filters</i>. Used to specify valid intervals for
16026	integer device attributes (Vendor ID, Product ID and Revision).
16027	The format of the string is:
16028
16029	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
16030
16031	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
16032	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
16033	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
16034	is omitted before a dash (<tt>-</tt>), the minimum possible integer
16035	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
16036	possible integer is assumed.
16037	</li>
16038	<li><i>Boolean filters</i>. Used to specify acceptable values for
16039	boolean device attributes. The format of the string is:
16040
16041	<tt>true\|false\|yes\|no\|0\|1</tt>
16042
16043	</li>
16044	<li><i>Exact match</i>. Used to specify a single value for the given
16045	device attribute. Any string that doesn't start with <tt>int:</tt>
16046	represents the exact match. String device attributes are compared to
16047	this string including case of symbols. Integer attributes are first
16048	converted to a string (see individual filter attributes) and then
16049	compared ignoring case.
16050
16051	</li>
16052	<li><i>Any match</i>. Any value of the corresponding device attribute
16053	will match the given filter. An empty or @c null string is
16054	used to construct this type of filtering expressions.
16055
16056	</li>
16057	</ul>
16058
16059	<note>
16060	On the Windows host platform, interval filters are not currently
16061	available. Also all string filter attributes
16062	(<link to="#manufacturer"/>, <link to="#product"/>,
16063	<link to="#serialNumber"/>) are ignored, so they behave as
16064	<i>any match</i> no matter what string expression is specified.
16065	</note>
16066
16067	<see><link to="IUSBController::deviceFilters"/>,
16068	<link to="IHostUSBDeviceFilter"/></see>
16069	</desc>
16070
16071	<attribute name="name" type="wstring">
16072	<desc>
16073	Visible name for this filter.
16074	This name is used to visually distinguish one filter from another,
16075	so it can neither be @c null nor an empty string.
16076	</desc>
16077	</attribute>
16078
16079	<attribute name="active" type="boolean">
16080	<desc>Whether this filter active or has been temporarily disabled.</desc>
16081	</attribute>
16082
16083	<attribute name="vendorId" type="wstring">
16084	<desc>
16085	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
16086	The string representation for the <i>exact matching</i>
16087	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16088	(including leading zeroes).
16089	</desc>
16090	</attribute>
16091
16092	<attribute name="productId" type="wstring">
16093	<desc>
16094	<link to="IUSBDevice::productId">Product ID</link> filter.
16095	The string representation for the <i>exact matching</i>
16096	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16097	(including leading zeroes).
16098	</desc>
16099	</attribute>
16100
16101	<attribute name="revision" type="wstring">
16102	<desc>
16103	<link to="IUSBDevice::productId">Product revision number</link>
16104	filter. The string representation for the <i>exact matching</i>
16105	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
16106	of the integer part of the revision, and <tt>F</tt> is the
16107	decimal digit of its fractional part (including leading and
16108	trailing zeros).
16109	Note that for interval filters, it's best to use the hexadecimal
16110	form, because the revision is stored as a 16 bit packed BCD value;
16111	so the expression <tt>int:0x0100-0x0199</tt> will match any
16112	revision from <tt>1.0</tt> to <tt>1.99</tt>.
16113	</desc>
16114	</attribute>
16115
16116	<attribute name="manufacturer" type="wstring">
16117	<desc>
16118	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
16119	</desc>
16120	</attribute>
16121
16122	<attribute name="product" type="wstring">
16123	<desc>
16124	<link to="IUSBDevice::product">Product</link> filter.
16125	</desc>
16126	</attribute>
16127
16128	<attribute name="serialNumber" type="wstring">
16129	<desc>
16130	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
16131	</desc>
16132	</attribute>
16133
16134	<attribute name="port" type="wstring">
16135	<desc>
16136	<link to="IUSBDevice::port">Host USB port</link> filter.
16137	</desc>
16138	</attribute>
16139
16140	<attribute name="remote" type="wstring">
16141	<desc>
16142	<link to="IUSBDevice::remote">Remote state</link> filter.
16143	<note>
16144	This filter makes sense only for machine USB filters,
16145	i.e. it is ignored by IHostUSBDeviceFilter objects.
16146	</note>
16147	</desc>
16148	</attribute>
16149
16150	<attribute name="maskedInterfaces" type="unsigned long">
16151	<desc>
16152	This is an advanced option for hiding one or more USB interfaces
16153	from the guest. The value is a bit mask where the bits that are set
16154	means the corresponding USB interface should be hidden, masked off
16155	if you like.
16156	This feature only works on Linux hosts.
16157	</desc>
16158	</attribute>
16159
16160	</interface>
16161
16162
16163	<!--
16164	// IHostUSBDevice
16165	/////////////////////////////////////////////////////////////////////////
16166	-->
16167
16168	<enum
16169	name="USBDeviceState"
16170	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
16171	>
16172	<desc>
16173	USB device state. This enumeration represents all possible states
16174	of the USB device physically attached to the host computer regarding
16175	its state on the host computer and availability to guest computers
16176	(all currently running virtual machines).
16177
16178	Once a supported USB device is attached to the host, global USB
16179	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
16180	either ignore the device, or put it to USBDeviceState_Held state, or do
16181	nothing. Unless the device is ignored by global filters, filters of all
16182	currently running guests (<link to="IUSBController::deviceFilters"/>) are
16183	activated that can put it to USBDeviceState_Captured state.
16184
16185	If the device was ignored by global filters, or didn't match
16186	any filters at all (including guest ones), it is handled by the host
16187	in a normal way. In this case, the device state is determined by
16188	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
16189	or USBDeviceState_Available, depending on the current device usage.
16190
16191	Besides auto-capturing based on filters, the device can be manually
16192	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
16193	state is USBDeviceState_Busy, USBDeviceState_Available or
16194	USBDeviceState_Held.
16195
16196	<note>
16197	Due to differences in USB stack implementations in Linux and Win32,
16198	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
16199	only to the Linux version of the product. This also means that (<link
16200	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
16201	device state is USBDeviceState_Held.
16202	</note>
16203
16204	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
16205	</desc>
16206
16207	<const name="NotSupported" value="0">
16208	<desc>
16209	Not supported by the VirtualBox server, not available to guests.
16210	</desc>
16211	</const>
16212	<const name="Unavailable" value="1">
16213	<desc>
16214	Being used by the host computer exclusively,
16215	not available to guests.
16216	</desc>
16217	</const>
16218	<const name="Busy" value="2">
16219	<desc>
16220	Being used by the host computer, potentially available to guests.
16221	</desc>
16222	</const>
16223	<const name="Available" value="3">
16224	<desc>
16225	Not used by the host computer, available to guests (the host computer
16226	can also start using the device at any time).
16227	</desc>
16228	</const>
16229	<const name="Held" value="4">
16230	<desc>
16231	Held by the VirtualBox server (ignored by the host computer),
16232	available to guests.
16233	</desc>
16234	</const>
16235	<const name="Captured" value="5">
16236	<desc>
16237	Captured by one of the guest computers, not available
16238	to anybody else.
16239	</desc>
16240	</const>
16241	</enum>
16242
16243	<interface
16244	name="IHostUSBDevice" extends="IUSBDevice"
16245	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
16246	wsmap="managed"
16247	>
16248	<desc>
16249	The IHostUSBDevice interface represents a physical USB device attached
16250	to the host computer.
16251
16252	Besides properties inherited from IUSBDevice, this interface adds the
16253	<link to="#state"/> property that holds the current state of the USB
16254	device.
16255
16256	<see><link to="IHost::USBDevices"/>,
16257	<link to="IHost::USBDeviceFilters"/></see>
16258	</desc>
16259
16260	<attribute name="state" type="USBDeviceState" readonly="yes">
16261	<desc>
16262	Current state of the device.
16263	</desc>
16264	</attribute>
16265
16266	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
16267
16268	</interface>
16269
16270
16271	<!--
16272	// IHostUSBDeviceFilter
16273	/////////////////////////////////////////////////////////////////////////
16274	-->
16275
16276	<enum
16277	name="USBDeviceFilterAction"
16278	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
16279	>
16280	<desc>
16281	Actions for host USB device filters.
16282	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
16283	</desc>
16284
16285	<const name="Null" value="0">
16286	<desc>Null value (never used by the API).</desc>
16287	</const>
16288	<const name="Ignore" value="1">
16289	<desc>Ignore the matched USB device.</desc>
16290	</const>
16291	<const name="Hold" value="2">
16292	<desc>Hold the matched USB device.</desc>
16293	</const>
16294	</enum>
16295
16296	<interface
16297	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
16298	uuid="4cc70246-d74a-400f-8222-3900489c0374"
16299	wsmap="managed"
16300	>
16301	<desc>
16302	The IHostUSBDeviceFilter interface represents a global filter for a
16303	physical USB device used by the host computer. Used indirectly in
16304	<link to="IHost::USBDeviceFilters"/>.
16305
16306	Using filters of this type, the host computer determines the initial
16307	state of the USB device after it is physically attached to the
16308	host's USB controller.
16309
16310	<note>
16311	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
16312	filters, because it makes sense only for
16313	<link to="IUSBController::deviceFilters">machine USB filters</link>.
16314	</note>
16315
16316	<see><link to="IHost::USBDeviceFilters"/></see>
16317	</desc>
16318
16319	<attribute name="action" type="USBDeviceFilterAction">
16320	<desc>
16321	Action performed by the host when an attached USB device
16322	matches this filter.
16323	</desc>
16324	</attribute>
16325
16326	</interface>
16327
16328	<!--
16329	// IAudioAdapter
16330	/////////////////////////////////////////////////////////////////////////
16331	-->
16332
16333	<enum
16334	name="AudioDriverType"
16335	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
16336	>
16337	<desc>
16338	Host audio driver type.
16339	</desc>
16340
16341	<const name="Null" value="0">
16342	<desc>Null value, also means "dummy audio driver".</desc>
16343	</const>
16344	<const name="WinMM" value="1">
16345	<desc>Windows multimedia (Windows hosts only).</desc>
16346	</const>
16347	<const name="OSS" value="2">
16348	<desc>Open Sound System (Linux hosts only).</desc>
16349	</const>
16350	<const name="ALSA" value="3">
16351	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
16352	</const>
16353	<const name="DirectSound" value="4">
16354	<desc>DirectSound (Windows hosts only).</desc>
16355	</const>
16356	<const name="CoreAudio" value="5">
16357	<desc>CoreAudio (Mac hosts only).</desc>
16358	</const>
16359	<const name="MMPM" value="6">
16360	<desc>Reserved for historical reasons.</desc>
16361	</const>
16362	<const name="Pulse" value="7">
16363	<desc>PulseAudio (Linux hosts only).</desc>
16364	</const>
16365	<const name="SolAudio" value="8">
16366	<desc>Solaris audio (Solaris hosts only).</desc>
16367	</const>
16368	</enum>
16369
16370	<enum
16371	name="AudioControllerType"
16372	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
16373	>
16374	<desc>
16375	Virtual audio controller type.
16376	</desc>
16377
16378	<const name="AC97" value="0"/>
16379	<const name="SB16" value="1"/>
16380	<const name="HDA" value="2"/>
16381	</enum>
16382
16383	<interface
16384	name="IAudioAdapter" extends="$unknown"
16385	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
16386	wsmap="managed"
16387	>
16388	<desc>
16389	The IAudioAdapter interface represents the virtual audio adapter of
16390	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
16391	</desc>
16392	<attribute name="enabled" type="boolean">
16393	<desc>
16394	Flag whether the audio adapter is present in the
16395	guest system. If disabled, the virtual guest hardware will
16396	not contain any audio adapter. Can only be changed when
16397	the VM is not running.
16398	</desc>
16399	</attribute>
16400	<attribute name="audioController" type="AudioControllerType">
16401	<desc>
16402	The audio hardware we emulate.
16403	</desc>
16404	</attribute>
16405	<attribute name="audioDriver" type="AudioDriverType">
16406	<desc>
16407	Audio driver the adapter is connected to. This setting
16408	can only be changed when the VM is not running.
16409	</desc>
16410	</attribute>
16411	</interface>
16412
16413	<enum
16414	name="AuthType"
16415	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
16416	>
16417	<desc>
16418	VirtualBox authentication type.
16419	</desc>
16420
16421	<const name="Null" value="0">
16422	<desc>Null value, also means "no authentication".</desc>
16423	</const>
16424	<const name="External" value="1"/>
16425	<const name="Guest" value="2"/>
16426	</enum>
16427
16428	<!--
16429	// IVRDEServer
16430	/////////////////////////////////////////////////////////////////////////
16431	-->
16432
16433	<interface
16434	name="IVRDEServer" extends="$unknown"
16435	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
16436	wsmap="managed"
16437	>
16438	<attribute name="enabled" type="boolean">
16439	<desc>VRDE server status.</desc>
16440	</attribute>
16441
16442	<attribute name="authType" type="AuthType">
16443	<desc>VRDE authentication method.</desc>
16444	</attribute>
16445
16446	<attribute name="authTimeout" type="unsigned long">
16447	<desc>Timeout for guest authentication. Milliseconds.</desc>
16448	</attribute>
16449
16450	<attribute name="allowMultiConnection" type="boolean">
16451	<desc>
16452	Flag whether multiple simultaneous connections to the VM are permitted.
16453	Note that this will be replaced by a more powerful mechanism in the future.
16454	</desc>
16455	</attribute>
16456
16457	<attribute name="reuseSingleConnection" type="boolean">
16458	<desc>
16459	Flag whether the existing connection must be dropped and a new connection
16460	must be established by the VRDE server, when a new client connects in single
16461	connection mode.
16462	</desc>
16463	</attribute>
16464
16465	<attribute name="VRDEExtPack" type="wstring">
16466	<desc>
16467	The name of Extension Pack providing VRDE for this VM. Overrides
16468	<link to="ISystemProperties::defaultVRDEExtPack"/>.
16469	</desc>
16470	</attribute>
16471
16472	<attribute name="authLibrary" type="wstring">
16473	<desc>
16474	Library used for authentication of RDP clients by this VM. Overrides
16475	<link to="ISystemProperties::VRDEAuthLibrary"/>.
16476	</desc>
16477	</attribute>
16478
16479	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
16480	<desc>
16481	Array of names of properties, which are supported by this VRDE server.
16482	</desc>
16483	</attribute>
16484
16485	<method name="setVRDEProperty">
16486	<desc>
16487	Sets a VRDE specific property string.
16488
16489	If you pass @c null or empty string as a key @a value, the given @a key
16490	will be deleted.
16491
16492	</desc>
16493	<param name="key" type="wstring" dir="in">
16494	<desc>Name of the key to set.</desc>
16495	</param>
16496	<param name="value" type="wstring" dir="in">
16497	<desc>Value to assign to the key.</desc>
16498	</param>
16499	</method>
16500
16501	<method name="getVRDEProperty" const="yes">
16502	<desc>
16503	Returns a VRDE specific property string.
16504
16505	If the requested data @a key does not exist, this function will
16506	succeed and return an empty string in the @a value argument.
16507
16508	</desc>
16509	<param name="key" type="wstring" dir="in">
16510	<desc>Name of the key to get.</desc>
16511	</param>
16512	<param name="value" type="wstring" dir="return">
16513	<desc>Value of the requested key.</desc>
16514	</param>
16515	</method>
16516
16517	</interface>
16518
16519
16520	<!--
16521	// ISharedFolder
16522	/////////////////////////////////////////////////////////////////////////
16523	-->
16524
16525	<interface
16526	name="ISharedFolder" extends="$unknown"
16527	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
16528	wsmap="struct"
16529	>
16530	<desc>
16531	The ISharedFolder interface represents a folder in the host computer's
16532	file system accessible from the guest OS running inside a virtual
16533	machine using an associated logical name.
16534
16535	There are three types of shared folders:
16536	<ul>
16537	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
16538	folders available to all virtual machines.</li>
16539	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
16540	VM-specific shared folders available to the given virtual machine at
16541	startup.</li>
16542	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
16543	VM-specific shared folders created in the session context (for
16544	example, when the virtual machine is running) and automatically
16545	discarded when the session is closed (the VM is powered off).</li>
16546	</ul>
16547
16548	Logical names of shared folders must be unique within the given scope
16549	(global, permanent or transient). However, they do not need to be unique
16550	across scopes. In this case, the definition of the shared folder in a
16551	more specific scope takes precedence over definitions in all other
16552	scopes. The order of precedence is (more specific to more general):
16553	<ol>
16554	<li>Transient definitions</li>
16555	<li>Permanent definitions</li>
16556	<li>Global definitions</li>
16557	</ol>
16558
16559	For example, if MyMachine has a shared folder named
16560	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
16561	transient shared folder named <tt>C_DRIVE</tt> (that points
16562	to <tt>C:\\\\WINDOWS</tt>) will change the definition
16563	of <tt>C_DRIVE</tt> in the guest OS so
16564	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
16565	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
16566	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
16567	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
16568	to <tt>C:\\</tt> if it still exists.
16569
16570	Note that permanent and transient shared folders of different machines
16571	are in different name spaces, so they don't overlap and don't need to
16572	have unique logical names.
16573
16574	<note>
16575	Global shared folders are not implemented in the current version of the
16576	product.
16577	</note>
16578	</desc>
16579
16580	<attribute name="name" type="wstring" readonly="yes">
16581	<desc>Logical name of the shared folder.</desc>
16582	</attribute>
16583
16584	<attribute name="hostPath" type="wstring" readonly="yes">
16585	<desc>Full path to the shared folder in the host file system.</desc>
16586	</attribute>
16587
16588	<attribute name="accessible" type="boolean" readonly="yes">
16589	<desc>
16590	Whether the folder defined by the host path is currently
16591	accessible or not.
16592	For example, the folder can be inaccessible if it is placed
16593	on the network share that is not available by the time
16594	this property is read.
16595	</desc>
16596	</attribute>
16597
16598	<attribute name="writable" type="boolean" readonly="yes">
16599	<desc>
16600	Whether the folder defined by the host path is writable or
16601	not.
16602	</desc>
16603	</attribute>
16604
16605	<attribute name="autoMount" type="boolean" readonly="yes">
16606	<desc>
16607	Whether the folder gets automatically mounted by the guest or not.
16608	</desc>
16609	</attribute>
16610
16611	<attribute name="lastAccessError" type="wstring" readonly="yes">
16612	<desc>
16613	Text message that represents the result of the last accessibility
16614	check.
16615
16616	Accessibility checks are performed each time the <link to="#accessible"/>
16617	attribute is read. An empty string is returned if the last
16618	accessibility check was successful. A non-empty string indicates a
16619	failure and should normally describe a reason of the failure (for
16620	example, a file read error).
16621	</desc>
16622	</attribute>
16623
16624	</interface>
16625
16626	<!--
16627	// ISession
16628	/////////////////////////////////////////////////////////////////////////
16629	-->
16630
16631	<interface
16632	name="IInternalSessionControl" extends="$unknown"
16633	uuid="3e83963a-1c3b-400d-8c5f-f2d077b0a597"
16634	internal="yes"
16635	wsmap="suppress"
16636	>
16637	<method name="getPID">
16638	<desc>PID of the process that has created this Session object.
16639	</desc>
16640	<param name="pid" type="unsigned long" dir="return"/>
16641	</method>
16642
16643	<method name="getRemoteConsole">
16644	<desc>
16645	Returns the console object suitable for remote control.
16646
16647	<result name="VBOX_E_INVALID_VM_STATE">
16648	Session state prevents operation.
16649	</result>
16650	<result name="VBOX_E_INVALID_OBJECT_STATE">
16651	Session type prevents operation.
16652	</result>
16653
16654	</desc>
16655	<param name="console" type="IConsole" dir="return"/>
16656	</method>
16657
16658	<method name="assignMachine">
16659	<desc>
16660	Assigns the machine object associated with this direct-type
16661	session or informs the session that it will be a remote one
16662	(if @a machine == @c null).
16663
16664	<result name="VBOX_E_INVALID_VM_STATE">
16665	Session state prevents operation.
16666	</result>
16667	<result name="VBOX_E_INVALID_OBJECT_STATE">
16668	Session type prevents operation.
16669	</result>
16670
16671	</desc>
16672	<param name="machine" type="IMachine" dir="in"/>
16673	<param name="lockType" type="LockType" dir="in"/>
16674	</method>
16675
16676	<method name="assignRemoteMachine">
16677	<desc>
16678	Assigns the machine and the (remote) console object associated with
16679	this remote-type session.
16680
16681	<result name="VBOX_E_INVALID_VM_STATE">
16682	Session state prevents operation.
16683	</result>
16684
16685	</desc>
16686	<param name="machine" type="IMachine" dir="in"/>
16687	<param name="console" type="IConsole" dir="in"/>
16688	</method>
16689
16690	<method name="updateMachineState">
16691	<desc>
16692	Updates the machine state in the VM process.
16693	Must be called only in certain cases
16694	(see the method implementation).
16695
16696	<result name="VBOX_E_INVALID_VM_STATE">
16697	Session state prevents operation.
16698	</result>
16699	<result name="VBOX_E_INVALID_OBJECT_STATE">
16700	Session type prevents operation.
16701	</result>
16702
16703	</desc>
16704	<param name="machineState" type="MachineState" dir="in"/>
16705	</method>
16706
16707	<method name="uninitialize">
16708	<desc>
16709	Uninitializes (closes) this session. Used by VirtualBox to close
16710	the corresponding remote session when the direct session dies
16711	or gets closed.
16712
16713	<result name="VBOX_E_INVALID_VM_STATE">
16714	Session state prevents operation.
16715	</result>
16716
16717	</desc>
16718	</method>
16719
16720	<method name="onNetworkAdapterChange">
16721	<desc>
16722	Triggered when settings of a network adapter of the
16723	associated virtual machine have changed.
16724
16725	<result name="VBOX_E_INVALID_VM_STATE">
16726	Session state prevents operation.
16727	</result>
16728	<result name="VBOX_E_INVALID_OBJECT_STATE">
16729	Session type prevents operation.
16730	</result>
16731
16732	</desc>
16733	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
16734	<param name="changeAdapter" type="boolean" dir="in"/>
16735	</method>
16736
16737	<method name="onSerialPortChange">
16738	<desc>
16739	Triggered when settings of a serial port of the
16740	associated virtual machine have changed.
16741
16742	<result name="VBOX_E_INVALID_VM_STATE">
16743	Session state prevents operation.
16744	</result>
16745	<result name="VBOX_E_INVALID_OBJECT_STATE">
16746	Session type prevents operation.
16747	</result>
16748
16749	</desc>
16750	<param name="serialPort" type="ISerialPort" dir="in"/>
16751	</method>
16752
16753	<method name="onParallelPortChange">
16754	<desc>
16755	Triggered when settings of a parallel port of the
16756	associated virtual machine have changed.
16757
16758	<result name="VBOX_E_INVALID_VM_STATE">
16759	Session state prevents operation.
16760	</result>
16761	<result name="VBOX_E_INVALID_OBJECT_STATE">
16762	Session type prevents operation.
16763	</result>
16764
16765	</desc>
16766	<param name="parallelPort" type="IParallelPort" dir="in"/>
16767	</method>
16768
16769	<method name="onStorageControllerChange">
16770	<desc>
16771	Triggered when settings of a storage controller of the
16772	associated virtual machine have changed.
16773
16774	<result name="VBOX_E_INVALID_VM_STATE">
16775	Session state prevents operation.
16776	</result>
16777	<result name="VBOX_E_INVALID_OBJECT_STATE">
16778	Session type prevents operation.
16779	</result>
16780
16781	</desc>
16782	</method>
16783
16784	<method name="onMediumChange">
16785	<desc>
16786	Triggered when attached media of the
16787	associated virtual machine have changed.
16788
16789	<result name="VBOX_E_INVALID_VM_STATE">
16790	Session state prevents operation.
16791	</result>
16792	<result name="VBOX_E_INVALID_OBJECT_STATE">
16793	Session type prevents operation.
16794	</result>
16795
16796	</desc>
16797
16798	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16799	<desc>The medium attachment which changed.</desc>
16800	</param>
16801	<param name="force" type="boolean" dir="in">
16802	<desc>If the medium change was forced.</desc>
16803	</param>
16804	</method>
16805
16806	<method name="onStorageDeviceChange">
16807	<desc>
16808	Triggered when attached storage devices of the
16809	associated virtual machine have changed.
16810
16811	<result name="VBOX_E_INVALID_VM_STATE">
16812	Session state prevents operation.
16813	</result>
16814	<result name="VBOX_E_INVALID_OBJECT_STATE">
16815	Session type prevents operation.
16816	</result>
16817
16818	</desc>
16819
16820	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16821	<desc>The medium attachment which changed.</desc>
16822	</param>
16823	<param name="remove" type="boolean" dir="in">
16824	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
16825	</param>
16826	<param name="silent" type="boolean" dir="in">
16827	<desc>TRUE if the device is is silently reconfigured without
16828	notifying the guest about it.</desc>
16829	</param>
16830	</method>
16831
16832	<method name="onClipboardModeChange">
16833	<desc>
16834	Notification when the shared clipboard mode changes.
16835	</desc>
16836	<param name="clipboardMode" type="ClipboardMode" dir="in">
16837	<desc>The new shared clipboard mode.</desc>
16838	</param>
16839	</method>
16840
16841	<method name="onDragAndDropModeChange">
16842	<desc>
16843	Notification when the drag'n'drop mode changes.
16844	</desc>
16845	<param name="dragAndDropMode" type="DragAndDropMode" dir="in">
16846	<desc>The new mode for drag'n'drop.</desc>
16847	</param>
16848	</method>
16849
16850	<method name="onCPUChange">
16851	<desc>
16852	Notification when a CPU changes.
16853	</desc>
16854	<param name="cpu" type="unsigned long" dir="in">
16855	<desc>The CPU which changed</desc>
16856	</param>
16857	<param name="add" type="boolean" dir="in">
16858	<desc>Flag whether the CPU was added or removed</desc>
16859	</param>
16860	</method>
16861
16862	<method name="onCPUExecutionCapChange">
16863	<desc>
16864	Notification when the CPU execution cap changes.
16865	</desc>
16866	<param name="executionCap" type="unsigned long" dir="in">
16867	<desc>The new CPU execution cap value. (1-100)</desc>
16868	</param>
16869	</method>
16870
16871	<method name="onVRDEServerChange">
16872	<desc>
16873	Triggered when settings of the VRDE server object of the
16874	associated virtual machine have changed.
16875
16876	<result name="VBOX_E_INVALID_VM_STATE">
16877	Session state prevents operation.
16878	</result>
16879	<result name="VBOX_E_INVALID_OBJECT_STATE">
16880	Session type prevents operation.
16881	</result>
16882
16883	</desc>
16884	<param name="restart" type="boolean" dir="in">
16885	<desc>Flag whether the server must be restarted</desc>
16886	</param>
16887	</method>
16888
16889	<method name="onUSBControllerChange">
16890	<desc>
16891	Triggered when settings of the USB controller object of the
16892	associated virtual machine have changed.
16893
16894	<result name="VBOX_E_INVALID_VM_STATE">
16895	Session state prevents operation.
16896	</result>
16897	<result name="VBOX_E_INVALID_OBJECT_STATE">
16898	Session type prevents operation.
16899	</result>
16900
16901	</desc>
16902	</method>
16903
16904	<method name="onSharedFolderChange">
16905	<desc>
16906	Triggered when a permanent (global or machine) shared folder has been
16907	created or removed.
16908	<note>
16909	We don't pass shared folder parameters in this notification because
16910	the order in which parallel notifications are delivered is not defined,
16911	therefore it could happen that these parameters were outdated by the
16912	time of processing this notification.
16913	</note>
16914
16915	<result name="VBOX_E_INVALID_VM_STATE">
16916	Session state prevents operation.
16917	</result>
16918	<result name="VBOX_E_INVALID_OBJECT_STATE">
16919	Session type prevents operation.
16920	</result>
16921
16922	</desc>
16923	<param name="global" type="boolean" dir="in"/>
16924	</method>
16925
16926	<method name="onUSBDeviceAttach">
16927	<desc>
16928	Triggered when a request to capture a USB device (as a result
16929	of matched USB filters or direct call to
16930	<link to="IConsole::attachUSBDevice"/>) has completed.
16931	A @c null @a error object means success, otherwise it
16932	describes a failure.
16933
16934	<result name="VBOX_E_INVALID_VM_STATE">
16935	Session state prevents operation.
16936	</result>
16937	<result name="VBOX_E_INVALID_OBJECT_STATE">
16938	Session type prevents operation.
16939	</result>
16940
16941	</desc>
16942	<param name="device" type="IUSBDevice" dir="in"/>
16943	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
16944	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
16945	</method>
16946
16947	<method name="onUSBDeviceDetach">
16948	<desc>
16949	Triggered when a request to release the USB device (as a result
16950	of machine termination or direct call to
16951	<link to="IConsole::detachUSBDevice"/>) has completed.
16952	A @c null @a error object means success, otherwise it
16953	describes a failure.
16954
16955	<result name="VBOX_E_INVALID_VM_STATE">
16956	Session state prevents operation.
16957	</result>
16958	<result name="VBOX_E_INVALID_OBJECT_STATE">
16959	Session type prevents operation.
16960	</result>
16961
16962	</desc>
16963	<param name="id" type="uuid" mod="string" dir="in"/>
16964	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
16965	</method>
16966
16967	<method name="onShowWindow">
16968	<desc>
16969	Called by <link to="IMachine::canShowConsoleWindow"/> and by
16970	<link to="IMachine::showConsoleWindow"/> in order to notify
16971	console listeners
16972	<link to="ICanShowWindowEvent"/>
16973	and <link to="IShowWindowEvent"/>.
16974
16975	<result name="VBOX_E_INVALID_OBJECT_STATE">
16976	Session type prevents operation.
16977	</result>
16978
16979	</desc>
16980	<param name="check" type="boolean" dir="in"/>
16981	<param name="canShow" type="boolean" dir="out"/>
16982	<param name="winId" type="long long" dir="out"/>
16983	</method>
16984
16985	<method name="onBandwidthGroupChange">
16986	<desc>
16987	Notification when one of the bandwidth groups change.
16988	</desc>
16989	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
16990	<desc>The bandwidth group which changed.</desc>
16991	</param>
16992	</method>
16993
16994	<method name="accessGuestProperty">
16995	<desc>
16996	Called by <link to="IMachine::getGuestProperty"/> and by
16997	<link to="IMachine::setGuestProperty"/> in order to read and
16998	modify guest properties.
16999
17000	<result name="VBOX_E_INVALID_VM_STATE">
17001	Machine session is not open.
17002	</result>
17003	<result name="VBOX_E_INVALID_OBJECT_STATE">
17004	Session type is not direct.
17005	</result>
17006
17007	</desc>
17008	<param name="name" type="wstring" dir="in"/>
17009	<param name="value" type="wstring" dir="in"/>
17010	<param name="flags" type="wstring" dir="in"/>
17011	<param name="isSetter" type="boolean" dir="in"/>
17012	<param name="retValue" type="wstring" dir="out"/>
17013	<param name="retTimestamp" type="long long" dir="out"/>
17014	<param name="retFlags" type="wstring" dir="out"/>
17015	</method>
17016
17017	<method name="enumerateGuestProperties" const="yes">
17018	<desc>
17019	Return a list of the guest properties matching a set of patterns along
17020	with their values, time stamps and flags.
17021
17022	<result name="VBOX_E_INVALID_VM_STATE">
17023	Machine session is not open.
17024	</result>
17025	<result name="VBOX_E_INVALID_OBJECT_STATE">
17026	Session type is not direct.
17027	</result>
17028
17029	</desc>
17030	<param name="patterns" type="wstring" dir="in">
17031	<desc>
17032	The patterns to match the properties against as a comma-separated
17033	string. If this is empty, all properties currently set will be
17034	returned.
17035	</desc>
17036	</param>
17037	<param name="keys" type="wstring" dir="out" safearray="yes">
17038	<desc>
17039	The key names of the properties returned.
17040	</desc>
17041	</param>
17042	<param name="values" type="wstring" dir="out" safearray="yes">
17043	<desc>
17044	The values of the properties returned. The array entries match the
17045	corresponding entries in the @a key array.
17046	</desc>
17047	</param>
17048	<param name="timestamps" type="long long" dir="out" safearray="yes">
17049	<desc>
17050	The time stamps of the properties returned. The array entries match
17051	the corresponding entries in the @a key array.
17052	</desc>
17053	</param>
17054	<param name="flags" type="wstring" dir="out" safearray="yes">
17055	<desc>
17056	The flags of the properties returned. The array entries match the
17057	corresponding entries in the @a key array.
17058	</desc>
17059	</param>
17060	</method>
17061
17062	<method name="onlineMergeMedium">
17063	<desc>
17064	Triggers online merging of a hard disk. Used internally when deleting
17065	a snapshot while a VM referring to the same hard disk chain is running.
17066
17067	<result name="VBOX_E_INVALID_VM_STATE">
17068	Machine session is not open.
17069	</result>
17070	<result name="VBOX_E_INVALID_OBJECT_STATE">
17071	Session type is not direct.
17072	</result>
17073
17074	</desc>
17075	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
17076	<desc>The medium attachment to identify the medium chain.</desc>
17077	</param>
17078	<param name="sourceIdx" type="unsigned long" dir="in">
17079	<desc>The index of the source image in the chain.
17080	Redundant, but drastically reduces IPC.</desc>
17081	</param>
17082	<param name="targetIdx" type="unsigned long" dir="in">
17083	<desc>The index of the target image in the chain.
17084	Redundant, but drastically reduces IPC.</desc>
17085	</param>
17086	<param name="source" type="IMedium" dir="in">
17087	<desc>Merge source medium.</desc>
17088	</param>
17089	<param name="target" type="IMedium" dir="in">
17090	<desc>Merge target medium.</desc>
17091	</param>
17092	<param name="mergeForward" type="boolean" dir="in">
17093	<desc>Merge direction.</desc>
17094	</param>
17095	<param name="parentForTarget" type="IMedium" dir="in">
17096	<desc>For forward merges: new parent for target medium.</desc>
17097	</param>
17098	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
17099	<desc>For backward merges: list of media which need their parent UUID
17100	updated.</desc>
17101	</param>
17102	<param name="progress" type="IProgress" dir="in">
17103	<desc>
17104	Progress object for this operation.
17105	</desc>
17106	</param>
17107	</method>
17108
17109	<method name="enableVMMStatistics">
17110	<desc>
17111	Enables or disables collection of VMM RAM statistics.
17112
17113	<result name="VBOX_E_INVALID_VM_STATE">
17114	Machine session is not open.
17115	</result>
17116	<result name="VBOX_E_INVALID_OBJECT_STATE">
17117	Session type is not direct.
17118	</result>
17119
17120	</desc>
17121	<param name="enable" type="boolean" dir="in">
17122	<desc>True enables statistics collection.</desc>
17123	</param>
17124	</method>
17125
17126	</interface>
17127
17128	<interface
17129	name="ISession" extends="$unknown"
17130	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
17131	wsmap="managed"
17132	>
17133	<desc>
17134	The ISession interface represents a client process and allows for locking
17135	virtual machines (represented by IMachine objects) to prevent conflicting
17136	changes to the machine.
17137
17138	Any caller wishing to manipulate a virtual machine needs to create a session
17139	object first, which lives in its own process space. Such session objects are
17140	then associated with <link to="IMachine" /> objects living in the VirtualBox
17141	server process to coordinate such changes.
17142
17143	There are two typical scenarios in which sessions are used:
17144
17145	<ul>
17146	<li>To alter machine settings or control a running virtual machine, one
17147	needs to lock a machine for a given session (client process) by calling
17148	<link to="IMachine::lockMachine"/>.
17149
17150	Whereas multiple sessions may control a running virtual machine, only
17151	one process can obtain a write lock on the machine to prevent conflicting
17152	changes. A write lock is also needed if a process wants to actually run a
17153	virtual machine in its own context, such as the VirtualBox GUI or
17154	VBoxHeadless front-ends. They must also lock a machine for their own
17155	sessions before they are allowed to power up the virtual machine.
17156
17157	As a result, no machine settings can be altered while another process is
17158	already using it, either because that process is modifying machine settings
17159	or because the machine is running.
17160	</li>
17161	<li>
17162	To start a VM using one of the existing VirtualBox front-ends (e.g. the
17163	VirtualBox GUI or VBoxHeadless), one would use
17164	<link to="IMachine::launchVMProcess"/>, which also takes a session object
17165	as its first parameter. This session then identifies the caller and lets the
17166	caller control the started machine (for example, pause machine execution or
17167	power it down) as well as be notified about machine execution state changes.
17168	</li>
17169	</ul>
17170
17171	How sessions objects are created in a client process depends on whether you use
17172	the Main API via COM or via the webservice:
17173
17174	<ul>
17175	<li>When using the COM API directly, an object of the Session class from the
17176	VirtualBox type library needs to be created. In regular COM C++ client code,
17177	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
17178	This object will then act as a local session object in further calls to open
17179	a session.
17180	</li>
17181
17182	<li>In the webservice, the session manager (IWebsessionManager) instead creates
17183	a session object automatically whenever <link to="IWebsessionManager::logon" />
17184	is called. A managed object reference to that session object can be retrieved by
17185	calling <link to="IWebsessionManager::getSessionObject" />.
17186	</li>
17187	</ul>
17188	</desc>
17189
17190	<attribute name="state" type="SessionState" readonly="yes">
17191	<desc>Current state of this session.</desc>
17192	</attribute>
17193
17194	<attribute name="type" type="SessionType" readonly="yes">
17195	<desc>
17196	Type of this session. The value of this attribute is valid only
17197	if the session currently has a machine locked (i.e. its
17198	<link to="#state" /> is Locked), otherwise an error will be returned.
17199	</desc>
17200	</attribute>
17201
17202	<attribute name="machine" type="IMachine" readonly="yes">
17203	<desc>Machine object associated with this session.</desc>
17204	</attribute>
17205
17206	<attribute name="console" type="IConsole" readonly="yes">
17207	<desc>Console object associated with this session.</desc>
17208	</attribute>
17209
17210	<method name="unlockMachine">
17211	<desc>
17212	Unlocks a machine that was previously locked for the current session.
17213
17214	Calling this method is required every time a machine has been locked
17215	for a particular session using the <link to="IMachine::launchVMProcess" />
17216	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
17217	the machine will be set to <link to="MachineState_Aborted" /> on the
17218	server, and changes made to the machine settings will be lost.
17219
17220	Generally, it is recommended to unlock all machines explicitly
17221	before terminating the application (regardless of the reason for
17222	the termination).
17223
17224	<note>
17225	Do not expect the session state (<link to="ISession::state" />
17226	to return to "Unlocked" immediately after you invoke this method,
17227	particularly if you have started a new VM process. The session
17228	state will automatically return to "Unlocked" once the VM is no
17229	longer executing, which can of course take a very long time.
17230	</note>
17231
17232	<result name="E_UNEXPECTED">
17233	Session is not locked.
17234	</result>
17235
17236	</desc>
17237	</method>
17238
17239	</interface>
17240
17241	<!--
17242	// IStorageController
17243	/////////////////////////////////////////////////////////////////////////
17244	-->
17245
17246	<enum
17247	name="StorageBus"
17248	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
17249	>
17250	<desc>
17251	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
17252	see <link to="IStorageController::bus" />.
17253	</desc>
17254	<const name="Null" value="0">
17255	<desc>@c null value. Never used by the API.</desc>
17256	</const>
17257	<const name="IDE" value="1"/>
17258	<const name="SATA" value="2"/>
17259	<const name="SCSI" value="3"/>
17260	<const name="Floppy" value="4"/>
17261	<const name="SAS" value="5"/>
17262	</enum>
17263
17264	<enum
17265	name="StorageControllerType"
17266	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
17267	>
17268	<desc>
17269	The exact variant of storage controller hardware presented
17270	to the guest; see <link to="IStorageController::controllerType" />.
17271	</desc>
17272
17273	<const name="Null" value="0">
17274	<desc>@c null value. Never used by the API.</desc>
17275	</const>
17276	<const name="LsiLogic" value="1">
17277	<desc>A SCSI controller of the LsiLogic variant.</desc>
17278	</const>
17279	<const name="BusLogic" value="2">
17280	<desc>A SCSI controller of the BusLogic variant.</desc>
17281	</const>
17282	<const name="IntelAhci" value="3">
17283	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
17284	</const>
17285	<const name="PIIX3" value="4">
17286	<desc>An IDE controller of the PIIX3 variant.</desc>
17287	</const>
17288	<const name="PIIX4" value="5">
17289	<desc>An IDE controller of the PIIX4 variant.</desc>
17290	</const>
17291	<const name="ICH6" value="6">
17292	<desc>An IDE controller of the ICH6 variant.</desc>
17293	</const>
17294	<const name="I82078" value="7">
17295	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
17296	</const>
17297	<const name="LsiLogicSas" value="8">
17298	<desc>A variant of the LsiLogic controller using SAS.</desc>
17299	</const>
17300	</enum>
17301
17302	<enum
17303	name="ChipsetType"
17304	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
17305	>
17306	<desc>
17307	Type of emulated chipset (mostly southbridge).
17308	</desc>
17309
17310	<const name="Null" value="0">
17311	<desc>@c null value. Never used by the API.</desc>
17312	</const>
17313	<const name="PIIX3" value="1">
17314	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
17315	</const>
17316	<const name="ICH9" value="2">
17317	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
17318	</const>
17319	</enum>
17320
17321	<interface
17322	name="IStorageController" extends="$unknown"
17323	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
17324	wsmap="managed"
17325	>
17326	<desc>
17327	Represents a storage controller that is attached to a virtual machine
17328	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
17329	attached to storage controllers in a real computer, virtual drives
17330	(represented by <link to="IMediumAttachment" />) are attached to virtual
17331	storage controllers, represented by this interface.
17332
17333	As opposed to physical hardware, VirtualBox has a very generic concept
17334	of a storage controller, and for purposes of the Main API, all virtual
17335	storage is attached to virtual machines via instances of this interface.
17336	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
17337	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
17338	is used, certain sub-types may be available and can be selected in
17339	<link to="#controllerType" />.
17340
17341	Depending on these settings, the guest operating system might see
17342	significantly different virtual hardware.
17343	</desc>
17344
17345	<attribute name="name" type="wstring" readonly="yes">
17346	<desc>
17347	Name of the storage controller, as originally specified with
17348	<link to="IMachine::addStorageController" />. This then uniquely
17349	identifies this controller with other method calls such as
17350	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
17351	</desc>
17352	</attribute>
17353
17354	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
17355	<desc>
17356	Maximum number of devices which can be attached to one port.
17357	</desc>
17358	</attribute>
17359
17360	<attribute name="minPortCount" type="unsigned long" readonly="yes">
17361	<desc>
17362	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
17363	</desc>
17364	</attribute>
17365
17366	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
17367	<desc>
17368	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
17369	</desc>
17370	</attribute>
17371
17372	<attribute name="instance" type="unsigned long">
17373	<desc>
17374	The instance number of the device in the running VM.
17375	</desc>
17376	</attribute>
17377
17378	<attribute name="portCount" type="unsigned long">
17379	<desc>
17380	The number of currently usable ports on the controller.
17381	The minimum and maximum number of ports for one controller are
17382	stored in <link to="IStorageController::minPortCount"/>
17383	and <link to="IStorageController::maxPortCount"/>.
17384	</desc>
17385	</attribute>
17386
17387	<attribute name="bus" type="StorageBus" readonly="yes">
17388	<desc>
17389	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
17390	</desc>
17391	</attribute>
17392
17393	<attribute name="controllerType" type="StorageControllerType">
17394	<desc>
17395	The exact variant of storage controller hardware presented
17396	to the guest.
17397	Depending on this value, VirtualBox will provide a different
17398	virtual storage controller hardware to the guest.
17399	For SATA, SAS and floppy controllers, only one variant is
17400	available, but for IDE and SCSI, there are several.
17401
17402	For SCSI controllers, the default type is LsiLogic.
17403	</desc>
17404	</attribute>
17405
17406	<attribute name="useHostIOCache" type="boolean">
17407	<desc>
17408	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
17409	caches and use synchronous file APIs on the host. This was the only option in the API before
17410	VirtualBox 3.2 and is still the default for IDE controllers.
17411
17412	If false, the host I/O cache will be disabled for image files attached to this storage controller.
17413	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
17414	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
17415	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
17416	virtual machines are running at the same time to prevent I/O cache related hangs.
17417	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
17418	</desc>
17419	</attribute>
17420
17421	<attribute name="bootable" type="boolean" readonly="yes">
17422	<desc>
17423	Returns whether it is possible to boot from disks attached to this controller.
17424	</desc>
17425	</attribute>
17426	</interface>
17427
17428	<if target="wsdl">
17429
17430	<!--
17431	// IManagedObjectRef
17432	/////////////////////////////////////////////////////////////////////////
17433	-->
17434
17435	<interface
17436	name="IManagedObjectRef" extends="$unknown"
17437	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
17438	internal="yes"
17439	wsmap="managed"
17440	wscpp="hardcoded"
17441	>
17442	<desc>
17443	Managed object reference.
17444
17445	Only within the webservice, a managed object reference (which is really
17446	an opaque number) allows a webservice client to address an object
17447	that lives in the address space of the webservice server.
17448
17449	Behind each managed object reference, there is a COM object that lives
17450	in the webservice server's address space. The COM object is not freed
17451	until the managed object reference is released, either by an explicit
17452	call to <link to="IManagedObjectRef::release" /> or by logging off from
17453	the webservice (<link to="IWebsessionManager::logoff" />), which releases
17454	all objects created during the webservice session.
17455
17456	Whenever a method call of the VirtualBox API returns a COM object, the
17457	webservice representation of that method will instead return a
17458	managed object reference, which can then be used to invoke methods
17459	on that object.
17460	</desc>
17461
17462	<method name="getInterfaceName">
17463	<desc>
17464	Returns the name of the interface that this managed object represents,
17465	for example, "IMachine", as a string.
17466	</desc>
17467	<param name="return" type="wstring" dir="return"/>
17468	</method>
17469
17470	<method name="release">
17471	<desc>
17472	Releases this managed object reference and frees the resources that
17473	were allocated for it in the webservice server process. After calling
17474	this method, the identifier of the reference can no longer be used.
17475	</desc>
17476	</method>
17477
17478	</interface>
17479
17480	<!--
17481	// IWebsessionManager
17482	/////////////////////////////////////////////////////////////////////////
17483	-->
17484
17485	<interface
17486	name="IWebsessionManager" extends="$unknown"
17487	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
17488	internal="yes"
17489	wsmap="global"
17490	wscpp="hardcoded"
17491	>
17492	<desc>
17493	Websession manager. This provides essential services
17494	to webservice clients.
17495	</desc>
17496	<method name="logon">
17497	<desc>
17498	Logs a new client onto the webservice and returns a managed object reference to
17499	the IVirtualBox instance, which the client can then use as a basis to further
17500	queries, since all calls to the VirtualBox API are based on the IVirtualBox
17501	interface, in one way or the other.
17502	</desc>
17503	<param name="username" type="wstring" dir="in"/>
17504	<param name="password" type="wstring" dir="in"/>
17505	<param name="return" type="IVirtualBox" dir="return"/>
17506	</method>
17507
17508	<method name="getSessionObject">
17509	<desc>
17510	Returns a managed object reference to the internal ISession object that was created
17511	for this web service session when the client logged on.
17512
17513	<see><link to="ISession"/></see>
17514	</desc>
17515	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17516	<param name="return" type="ISession" dir="return"/>
17517	</method>
17518
17519	<method name="logoff">
17520	<desc>
17521	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
17522	and destroys all resources associated with the session (most importantly, all
17523	managed objects created in the server while the session was active).
17524	</desc>
17525	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17526	</method>
17527
17528	</interface>
17529
17530	</if>
17531
17532	<!--
17533	// IPerformanceCollector & friends
17534	/////////////////////////////////////////////////////////////////////////
17535	-->
17536
17537	<interface
17538	name="IPerformanceMetric" extends="$unknown"
17539	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
17540	>
17541	<desc>
17542	The IPerformanceMetric interface represents parameters of the given
17543	performance metric.
17544	</desc>
17545
17546	<attribute name="metricName" type="wstring" readonly="yes">
17547	<desc>
17548	Name of the metric.
17549	</desc>
17550	</attribute>
17551
17552	<attribute name="object" type="$unknown" readonly="yes">
17553	<desc>
17554	Object this metric belongs to.
17555	</desc>
17556	</attribute>
17557
17558	<attribute name="description" type="wstring" readonly="yes">
17559	<desc>
17560	Textual description of the metric.
17561	</desc>
17562	</attribute>
17563
17564	<attribute name="period" type="unsigned long" readonly="yes">
17565	<desc>
17566	Time interval between samples, measured in seconds.
17567	</desc>
17568	</attribute>
17569
17570	<attribute name="count" type="unsigned long" readonly="yes">
17571	<desc>
17572	Number of recent samples retained by the performance collector for this
17573	metric.
17574
17575	When the collected sample count exceeds this number, older samples
17576	are discarded.
17577	</desc>
17578	</attribute>
17579
17580	<attribute name="unit" type="wstring" readonly="yes">
17581	<desc>
17582	Unit of measurement.
17583	</desc>
17584	</attribute>
17585
17586	<attribute name="minimumValue" type="long" readonly="yes">
17587	<desc>
17588	Minimum possible value of this metric.
17589	</desc>
17590	</attribute>
17591
17592	<attribute name="maximumValue" type="long" readonly="yes">
17593	<desc>
17594	Maximum possible value of this metric.
17595	</desc>
17596	</attribute>
17597	</interface>
17598
17599	<interface
17600	name="IPerformanceCollector" extends="$unknown"
17601	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
17602	wsmap="managed"
17603	>
17604	<desc>
17605	The IPerformanceCollector interface represents a service that collects
17606	and stores performance metrics data.
17607
17608	Performance metrics are associated with objects of interfaces like IHost
17609	and IMachine. Each object has a distinct set of performance metrics. The
17610	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
17611
17612	Metric data is collected at the specified intervals and is retained
17613	internally. The interval and the number of retained samples can be set
17614	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
17615	and collection settings are not persistent, they are discarded as soon as
17616	VBoxSVC process terminates. Moreover, metric settings and data associated
17617	with a particular VM only exist while VM is running. They disappear as
17618	soon as VM shuts down. It is not possible to set up metrics for machines
17619	that are powered off. One needs to start VM first, then set up metric
17620	collection parameters.
17621
17622	Metrics are organized hierarchically, with each level separated by a
17623	slash (/) character. Generally, the scheme for metric names is like this:
17624
17625	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
17626
17627	"Category/Metric" together form the base metric name. A base metric is
17628	the smallest unit for which a sampling interval and the number of
17629	retained samples can be set. Only base metrics can be enabled and
17630	disabled. All sub-metrics are collected when their base metric is
17631	collected. Collected values for any set of sub-metrics can be queried
17632	with <link to="IPerformanceCollector::queryMetricsData" />.
17633
17634	For example "CPU/Load/User:avg" metric name stands for the "CPU"
17635	category, "Load" metric, "User" submetric, "average" aggregate. An
17636	aggregate function is computed over all retained data. Valid aggregate
17637	functions are:
17638
17639	<ul>
17640	<li>avg -- average</li>
17641	<li>min -- minimum</li>
17642	<li>max -- maximum</li>
17643	</ul>
17644
17645	When setting up metric parameters, querying metric data, enabling or
17646	disabling metrics wildcards can be used in metric names to specify a
17647	subset of metrics. For example, to select all CPU-related metrics
17648	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
17649	so on. To query metric values without aggregates <tt>*:</tt> can be used.
17650
17651	The valid names for base metrics are:
17652
17653	<ul>
17654	<li>CPU/Load</li>
17655	<li>CPU/MHz</li>
17656	<li>RAM/Usage</li>
17657	<li>RAM/VMM</li>
17658	</ul>
17659
17660	The general sequence for collecting and retrieving the metrics is:
17661	<ul>
17662	<li>
17663	Obtain an instance of IPerformanceCollector with
17664	<link to="IVirtualBox::performanceCollector" />
17665	</li>
17666	<li>
17667	Allocate and populate an array with references to objects the metrics
17668	will be collected for. Use references to IHost and IMachine objects.
17669	</li>
17670	<li>
17671	Allocate and populate an array with base metric names the data will
17672	be collected for.
17673	</li>
17674	<li>
17675	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
17676	the metric data will be collected and stored.
17677	</li>
17678	<li>
17679	Wait for the data to get collected.
17680	</li>
17681	<li>
17682	Allocate and populate an array with references to objects the metric
17683	values will be queried for. You can re-use the object array used for
17684	setting base metrics.
17685	</li>
17686	<li>
17687	Allocate and populate an array with metric names the data will be
17688	collected for. Note that metric names differ from base metric names.
17689	</li>
17690	<li>
17691	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
17692	that have been collected so far are returned. Note that the values
17693	are still retained internally and data collection continues.
17694	</li>
17695	</ul>
17696
17697	For an example of usage refer to the following files in VirtualBox SDK:
17698	<ul>
17699	<li>
17700	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
17701	</li>
17702	<li>
17703	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
17704	</li>
17705	</ul>
17706	</desc>
17707
17708	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
17709	<desc>
17710	Array of unique names of metrics.
17711
17712	This array represents all metrics supported by the performance
17713	collector. Individual objects do not necessarily support all of them.
17714	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
17715	list of supported metrics for a particular object.
17716	</desc>
17717	</attribute>
17718
17719	<method name="getMetrics">
17720	<desc>
17721	Returns parameters of specified metrics for a set of objects.
17722	<note>
17723	@c Null metrics array means all metrics. @c Null object array means
17724	all existing objects.
17725	</note>
17726	</desc>
17727	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17728	<desc>
17729	Metric name filter. Currently, only a comma-separated list of metrics
17730	is supported.
17731	</desc>
17732	</param>
17733	<param name="objects" type="$unknown" dir="in" safearray="yes">
17734	<desc>
17735	Set of objects to return metric parameters for.
17736	</desc>
17737	</param>
17738	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
17739	<desc>
17740	Array of returned metric parameters.
17741	</desc>
17742	</param>
17743	</method>
17744
17745	<method name="setupMetrics">
17746	<desc>
17747	Sets parameters of specified base metrics for a set of objects. Returns
17748	an array of <link to="IPerformanceMetric" /> describing the metrics
17749	have been affected.
17750	<note>
17751	@c Null or empty metric name array means all metrics. @c Null or
17752	empty object array means all existing objects. If metric name array
17753	contains a single element and object array contains many, the single
17754	metric name array element is applied to each object array element to
17755	form metric/object pairs.
17756	</note>
17757	</desc>
17758	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17759	<desc>
17760	Metric name filter. Comma-separated list of metrics with wildcard
17761	support.
17762	</desc>
17763	</param>
17764	<param name="objects" type="$unknown" dir="in" safearray="yes">
17765	<desc>
17766	Set of objects to setup metric parameters for.
17767	</desc>
17768	</param>
17769	<param name="period" type="unsigned long" dir="in">
17770	<desc>
17771	Time interval in seconds between two consecutive samples of
17772	performance data.
17773	</desc>
17774	</param>
17775	<param name="count" type="unsigned long" dir="in">
17776	<desc>
17777	Number of samples to retain in performance data history. Older
17778	samples get discarded.
17779	</desc>
17780	</param>
17781	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17782	<desc>
17783	Array of metrics that have been modified by the call to this method.
17784	</desc>
17785	</param>
17786	</method>
17787
17788	<method name="enableMetrics">
17789	<desc>
17790	Turns on collecting specified base metrics. Returns an array of
17791	<link to="IPerformanceMetric" /> describing the metrics have been
17792	affected.
17793	<note>
17794	@c Null or empty metric name array means all metrics. @c Null or
17795	empty object array means all existing objects. If metric name array
17796	contains a single element and object array contains many, the single
17797	metric name array element is applied to each object array element to
17798	form metric/object pairs.
17799	</note>
17800	</desc>
17801	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17802	<desc>
17803	Metric name filter. Comma-separated list of metrics with wildcard
17804	support.
17805	</desc>
17806	</param>
17807	<param name="objects" type="$unknown" dir="in" safearray="yes">
17808	<desc>
17809	Set of objects to enable metrics for.
17810	</desc>
17811	</param>
17812	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17813	<desc>
17814	Array of metrics that have been modified by the call to this method.
17815	</desc>
17816	</param>
17817	</method>
17818
17819	<method name="disableMetrics">
17820	<desc>
17821	Turns off collecting specified base metrics. Returns an array of
17822	<link to="IPerformanceMetric" /> describing the metrics have been
17823	affected.
17824	<note>
17825	@c Null or empty metric name array means all metrics. @c Null or
17826	empty object array means all existing objects. If metric name array
17827	contains a single element and object array contains many, the single
17828	metric name array element is applied to each object array element to
17829	form metric/object pairs.
17830	</note>
17831	</desc>
17832	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17833	<desc>
17834	Metric name filter. Comma-separated list of metrics with wildcard
17835	support.
17836	</desc>
17837	</param>
17838	<param name="objects" type="$unknown" dir="in" safearray="yes">
17839	<desc>
17840	Set of objects to disable metrics for.
17841	</desc>
17842	</param>
17843	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17844	<desc>
17845	Array of metrics that have been modified by the call to this method.
17846	</desc>
17847	</param>
17848	</method>
17849
17850	<method name="queryMetricsData">
17851	<desc>
17852	Queries collected metrics data for a set of objects.
17853
17854	The data itself and related metric information are returned in seven
17855	parallel and one flattened array of arrays. Elements of
17856	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
17857	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
17858	the same index describe one set of values corresponding to a single
17859	metric.
17860
17861	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
17862	start and length of a sub-array is indicated by
17863	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
17864	value for metric <tt>metricNames[i]</tt> is at
17865	<tt>returnData[returnIndices[i]]</tt>.
17866
17867	<note>
17868	@c Null or empty metric name array means all metrics. @c Null or
17869	empty object array means all existing objects. If metric name array
17870	contains a single element and object array contains many, the single
17871	metric name array element is applied to each object array element to
17872	form metric/object pairs.
17873	</note>
17874	<note>
17875	Data collection continues behind the scenes after call to @c
17876	queryMetricsData. The return data can be seen as the snapshot of the
17877	current state at the time of @c queryMetricsData call. The internally
17878	kept metric values are not cleared by the call. This makes possible
17879	querying different subsets of metrics or aggregates with subsequent
17880	calls. If periodic querying is needed it is highly suggested to query
17881	the values with @c interval*count period to avoid confusion. This way
17882	a completely new set of data values will be provided by each query.
17883	</note>
17884	</desc>
17885	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17886	<desc>
17887	Metric name filter. Comma-separated list of metrics with wildcard
17888	support.
17889	</desc>
17890	</param>
17891	<param name="objects" type="$unknown" dir="in" safearray="yes">
17892	<desc>
17893	Set of objects to query metrics for.
17894	</desc>
17895	</param>
17896	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
17897	<desc>
17898	Names of metrics returned in @c returnData.
17899	</desc>
17900	</param>
17901	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
17902	<desc>
17903	Objects associated with metrics returned in @c returnData.
17904	</desc>
17905	</param>
17906	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
17907	<desc>
17908	Units of measurement for each returned metric.
17909	</desc>
17910	</param>
17911	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
17912	<desc>
17913	Divisor that should be applied to return values in order to get
17914	floating point values. For example:
17915	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
17916	will retrieve the floating point value of i-th sample of the first
17917	metric.
17918	</desc>
17919	</param>
17920	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
17921	<desc>
17922	Sequence numbers of the first elements of value sequences of
17923	particular metrics returned in @c returnData. For aggregate metrics
17924	it is the sequence number of the sample the aggregate started
17925	calculation from.
17926	</desc>
17927	</param>
17928	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
17929	<desc>
17930	Indices of the first elements of value sequences of particular
17931	metrics returned in @c returnData.
17932	</desc>
17933	</param>
17934	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
17935	<desc>
17936	Lengths of value sequences of particular metrics.
17937	</desc>
17938	</param>
17939	<param name="returnData" type="long" dir="return" safearray="yes">
17940	<desc>
17941	Flattened array of all metric data containing sequences of values for
17942	each metric.
17943	</desc>
17944	</param>
17945	</method>
17946
17947	</interface>
17948
17949	<enum
17950	name="NATAliasMode"
17951	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
17952	>
17953	<desc></desc>
17954	<const name="AliasLog" value="0x1">
17955	<desc></desc>
17956	</const>
17957	<const name="AliasProxyOnly" value="0x02">
17958	<desc></desc>
17959	</const>
17960	<const name="AliasUseSamePorts" value="0x04">
17961	<desc></desc>
17962	</const>
17963	</enum>
17964
17965	<enum
17966	name="NATProtocol"
17967	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
17968	>
17969	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
17970	<const name="UDP" value="0">
17971	<desc>Port-forwarding uses UDP protocol.</desc>
17972	</const>
17973	<const name="TCP" value="1">
17974	<desc>Port-forwarding uses TCP protocol.</desc>
17975	</const>
17976	</enum>
17977
17978	<interface
17979	name="INATEngine" extends="$unknown"
17980	uuid="26451b99-3b2d-4dcb-8e4b-d63654218175"
17981	wsmap="managed"
17982	>
17983	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
17984	allows for changing NAT behavior such as port-forwarding rules. This interface is
17985	used in the <link to="INetworkAdapter::NATEngine" /> attribute.</desc>
17986	<attribute name="network" type="wstring">
17987	<desc>The network attribute of the NAT engine (the same value is used with built-in
17988	DHCP server to fill corresponding fields of DHCP leases).</desc>
17989	</attribute>
17990	<attribute name="hostIP" type="wstring">
17991	<desc>IP of host interface to bind all opened sockets to.
17992	<note>Changing this does not change binding of port forwarding.</note>
17993	</desc>
17994	</attribute>
17995	<attribute name="TFTPPrefix" type="wstring">
17996	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
17997	the corresponding fields of DHCP leases.</desc>
17998	</attribute>
17999	<attribute name="TFTPBootFile" type="wstring">
18000	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
18001	the corresponding fields of DHCP leases.</desc>
18002	</attribute>
18003	<attribute name="TFTPNextServer" type="wstring">
18004	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
18005	the corresponding fields of DHCP leases.
18006	<note>The preferred form is IPv4 addresses.</note>
18007	</desc>
18008	</attribute>
18009	<attribute name="aliasMode" type="unsigned long">
18010	<desc></desc>
18011	</attribute>
18012	<attribute name="DNSPassDomain" type="boolean">
18013	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
18014	</attribute>
18015	<attribute name="DNSProxy" type="boolean">
18016	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18017	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
18018	</attribute>
18019	<attribute name="DNSUseHostResolver" type="boolean">
18020	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18021	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
18022	</attribute>
18023	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
18024	<desc>Array of NAT port-forwarding rules in string representation, in the following
18025	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
18026	</attribute>
18027	<method name="setNetworkSettings">
18028	<desc>Sets network configuration of the NAT engine.</desc>
18029	<param name="mtu" type="unsigned long" dir="in">
18030	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
18031	</param>
18032	<param name="sockSnd" type="unsigned long" dir="in">
18033	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
18034	</param>
18035	<param name="sockRcv" type="unsigned long" dir="in">
18036	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
18037	</param>
18038	<param name="TcpWndSnd" type="unsigned long" dir="in">
18039	<desc>Initial size of the NAT engine's sending TCP window in bytes when
18040	establishing a new TCP connection.</desc>
18041	</param>
18042	<param name="TcpWndRcv" type="unsigned long" dir="in">
18043	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
18044	establishing a new TCP connection.</desc>
18045	</param>
18046	</method>
18047	<method name="getNetworkSettings">
18048	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
18049	for parameter descriptions.</desc>
18050	<param name="mtu" type="unsigned long" dir="out" />
18051	<param name="sockSnd" type="unsigned long" dir="out" />
18052	<param name="sockRcv" type="unsigned long" dir="out" />
18053	<param name="TcpWndSnd" type="unsigned long" dir="out" />
18054	<param name="TcpWndRcv" type="unsigned long" dir="out" />
18055	</method>
18056	<method name="addRedirect">
18057	<desc>Adds a new NAT port-forwarding rule.</desc>
18058	<param name="name" type="wstring" dir="in">
18059	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
18060	auto-generates one using the other parameters.</desc>
18061	</param>
18062	<param name="proto" type="NATProtocol" dir="in">
18063	<desc>Protocol handled with the rule.</desc>
18064	</param>
18065	<param name="hostIP" type="wstring" dir="in">
18066	<desc>IP of the host interface to which the rule should apply. An empty ip address is
18067	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
18068	</param>
18069	<param name="hostPort" type="unsigned short" dir="in">
18070	<desc>The port number to listen on.</desc>
18071	</param>
18072	<param name="guestIP" type="wstring" dir="in">
18073	<desc>The IP address of the guest which the NAT engine will forward matching packets
18074	to. An empty IP address is acceptable, in which case the NAT engine will forward
18075	packets to the first DHCP lease (x.x.x.15).</desc>
18076	</param>
18077	<param name="guestPort" type="unsigned short" dir="in">
18078	<desc>The port number to forward.</desc>
18079	</param>
18080	</method>
18081	<method name="removeRedirect">
18082	<desc>Removes a port-forwarding rule that was previously registered.</desc>
18083	<param name="name" type="wstring" dir="in">
18084	<desc>The name of the rule to delete.</desc>
18085	</param>
18086	</method>
18087	</interface>
18088
18089	<!--
18090	// IExtPackManager
18091	/////////////////////////////////////////////////////////////////////////
18092	-->
18093
18094	<interface
18095	name="IExtPackPlugIn" extends="$unknown"
18096	uuid="58000040-e718-4746-bbce-4b86d96da461"
18097	wsmap="suppress"
18098	>
18099	<desc>
18100	Interface for keeping information about a plug-in that ships with an
18101	extension pack.
18102	</desc>
18103	<attribute name="name" type="wstring" readonly="yes">
18104	<desc>The plug-in name.</desc>
18105	</attribute>
18106	<attribute name="description" type="wstring" readonly="yes">
18107	<desc>The plug-in description.</desc>
18108	</attribute>
18109	<attribute name="frontend" type="wstring" readonly="yes">
18110	<desc>
18111	The name of the frontend or component name this plug-in plugs into.
18112	</desc>
18113	</attribute>
18114	<attribute name="modulePath" type="wstring" readonly="yes">
18115	<desc> The module path. </desc>
18116	</attribute>
18117	</interface>
18118
18119	<interface
18120	name="IExtPackBase" extends="$unknown"
18121	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
18122	wsmap="suppress"
18123	>
18124	<desc>
18125	Interface for querying information about an extension pack as well as
18126	accessing COM objects within it.
18127	</desc>
18128	<attribute name="name" type="wstring" readonly="yes">
18129	<desc>The extension pack name. This is unique.</desc>
18130	</attribute>
18131	<attribute name="description" type="wstring" readonly="yes">
18132	<desc>The extension pack description.</desc>
18133	</attribute>
18134	<attribute name="version" type="wstring" readonly="yes">
18135	<desc>
18136	The extension pack version string. This is restricted to the dotted
18137	version number and optionally a build indicator. No tree revision or
18138	tag will be included in the string as those things are available as
18139	separate properties. An optional publisher tag may be present like for
18140	<link to="IVirtualBox::version"/>.
18141
18142	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
18143	</desc>
18144	</attribute>
18145	<attribute name="revision" type="unsigned long" readonly="yes">
18146	<desc>The extension pack internal revision number.</desc>
18147	</attribute>
18148	<attribute name="edition" type="wstring" readonly="yes">
18149	<desc>
18150	Edition indicator. This is usually empty.
18151
18152	Can for instance be used to help distinguishing between two editions
18153	of the same extension pack where only the license, service contract or
18154	something differs.
18155	</desc>
18156	</attribute>
18157	<attribute name="VRDEModule" type="wstring" readonly="yes">
18158	<desc>The name of the VRDE module if the extension pack sports one.</desc>
18159	</attribute>
18160	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
18161	<desc>Plug-ins provided by this extension pack.</desc>
18162	</attribute>
18163	<attribute name="usable" type="boolean" readonly="yes">
18164	<desc>
18165	Indicates whether the extension pack is usable or not.
18166
18167	There are a number of reasons why an extension pack might be unusable,
18168	typical examples would be broken installation/file or that it is
18169	incompatible with the current VirtualBox version.
18170	</desc>
18171	</attribute>
18172	<attribute name="whyUnusable" type="wstring" readonly="yes">
18173	<desc>
18174	String indicating why the extension pack is not usable. This is an
18175	empty string if usable and always a non-empty string if not usable.
18176	</desc>
18177	</attribute>
18178	<attribute name="showLicense" type="boolean" readonly="yes">
18179	<desc>Whether to show the license before installation</desc>
18180	</attribute>
18181	<attribute name="license" type="wstring" readonly="yes">
18182	<desc>
18183	The default HTML license text for the extension pack. Same as
18184	calling <link to="#queryLicense">queryLicense</link> with
18185	preferredLocale and preferredLanguage as empty strings and format set
18186	to html.
18187	</desc>
18188	</attribute>
18189
18190	<method name="queryLicense">
18191	<desc>
18192	Full feature version of the license attribute.
18193	</desc>
18194	<param name="preferredLocale" type="wstring" dir="in">
18195	<desc>
18196	The preferred license locale. Pass an empty string to get the default
18197	license.
18198	</desc>
18199	</param>
18200	<param name="preferredLanguage" type="wstring" dir="in">
18201	<desc>
18202	The preferred license language. Pass an empty string to get the
18203	default language for the locale.
18204	</desc>
18205	</param>
18206	<param name="format" type="wstring" dir="in">
18207	<desc>
18208	The license format: html, rtf or txt. If a license is present there
18209	will always be an HTML of it, the rich text format (RTF) and plain
18210	text (txt) versions are optional. If
18211	</desc>
18212	</param>
18213	<param name="licenseText" type="wstring" dir="return">
18214	<desc>The license text.</desc>
18215	</param>
18216	</method>
18217
18218	</interface>
18219
18220	<interface
18221	name="IExtPack" extends="IExtPackBase"
18222	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
18223	wsmap="suppress"
18224	>
18225	<desc>
18226	Interface for querying information about an extension pack as well as
18227	accessing COM objects within it.
18228	</desc>
18229	<method name="queryObject">
18230	<desc>
18231	Queries the IUnknown interface to an object in the extension pack
18232	main module. This allows plug-ins and others to talk directly to an
18233	extension pack.
18234	</desc>
18235	<param name="objUuid" type="wstring" dir="in">
18236	<desc>The object ID. What exactly this is </desc>
18237	</param>
18238	<param name="returnInterface" type="$unknown" dir="return">
18239	<desc>The queried interface.</desc>
18240	</param>
18241	</method>
18242	</interface>
18243
18244	<interface
18245	name="IExtPackFile" extends="IExtPackBase"
18246	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
18247	wsmap="suppress"
18248	>
18249	<desc>
18250	Extension pack file (aka tarball, .vbox-extpack) representation returned
18251	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
18252	extension pack information with the addition of the file name.
18253	</desc>
18254	<attribute name="filePath" type="wstring" readonly="yes">
18255	<desc>
18256	The path to the extension pack file.
18257	</desc>
18258	</attribute>
18259
18260	<method name="install">
18261	<desc>
18262	Install the extension pack.
18263	</desc>
18264	<param name="replace" type="boolean" dir="in">
18265	<desc>
18266	Set this to automatically uninstall any existing extension pack with
18267	the same name as the one being installed.
18268	</desc>
18269	</param>
18270	<param name="displayInfo" type="wstring" dir="in">
18271	<desc>
18272	Platform specific display information. Reserved for future hacks.
18273	</desc>
18274	</param>
18275	<param name="progess" type="IProgress" dir="return">
18276	<desc>
18277	Progress object for the operation.
18278	</desc>
18279	</param>
18280	</method>
18281	</interface>
18282
18283	<interface
18284	name="IExtPackManager" extends="$unknown"
18285	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
18286	wsmap="suppress"
18287	>
18288	<desc>
18289	Interface for managing VirtualBox Extension Packs.
18290
18291	TODO: Describe extension packs, how they are managed and how to create
18292	one.
18293	</desc>
18294
18295	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
18296	<desc>
18297	List of the installed extension packs.
18298	</desc>
18299	</attribute>
18300
18301	<method name="find">
18302	<desc>
18303	Returns the extension pack with the specified name if found.
18304
18305	<result name="VBOX_E_OBJECT_NOT_FOUND">
18306	No extension pack matching @a name was found.
18307	</result>
18308	</desc>
18309	<param name="name" type="wstring" dir="in">
18310	<desc>The name of the extension pack to locate.</desc>
18311	</param>
18312	<param name="returnData" type="IExtPack" dir="return">
18313	<desc>The extension pack if found.</desc>
18314	</param>
18315	</method>
18316
18317	<method name="openExtPackFile">
18318	<desc>
18319	Attempts to open an extension pack file in preparation for
18320	installation.
18321	</desc>
18322	<param name="path" type="wstring" dir="in">
18323	<desc>The path of the extension pack tarball. This can optionally be
18324	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
18325	</param>
18326	<param name="file" type="IExtPackFile" dir="return">
18327	<desc>The interface of the extension pack file object.</desc>
18328	</param>
18329	</method>
18330
18331	<method name="uninstall">
18332	<desc>Uninstalls an extension pack, removing all related files.</desc>
18333	<param name="name" type="wstring" dir="in">
18334	<desc>The name of the extension pack to uninstall.</desc>
18335	</param>
18336	<param name="forcedRemoval" type="boolean" dir="in">
18337	<desc>
18338	Forced removal of the extension pack. This means that the uninstall
18339	hook will not be called.
18340	</desc>
18341	</param>
18342	<param name="displayInfo" type="wstring" dir="in">
18343	<desc>
18344	Platform specific display information. Reserved for future hacks.
18345	</desc>
18346	</param>
18347	<param name="progess" type="IProgress" dir="return">
18348	<desc>
18349	Progress object for the operation.
18350	</desc>
18351	</param>
18352	</method>
18353
18354	<method name="cleanup">
18355	<desc>Cleans up failed installs and uninstalls</desc>
18356	</method>
18357
18358	<method name="queryAllPlugInsForFrontend">
18359	<desc>
18360	Gets the path to all the plug-in modules for a given frontend.
18361
18362	This is a convenience method that is intended to simplify the plug-in
18363	loading process for a frontend.
18364	</desc>
18365	<param name="frontendName" type="wstring" dir="in">
18366	<desc>The name of the frontend or component.</desc>
18367	</param>
18368	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
18369	<desc>Array containing the plug-in modules (full paths).</desc>
18370	</param>
18371	</method>
18372
18373	<method name="isExtPackUsable">
18374	<desc>Check if the given extension pack is loaded and usable.</desc>
18375	<param name="name" type="wstring" dir="in">
18376	<desc>The name of the extension pack to check for.</desc>
18377	</param>
18378	<param name="usable" type="boolean" dir="return">
18379	<desc>Is the given extension pack loaded and usable.</desc>
18380	</param>
18381	</method>
18382
18383	</interface>
18384
18385	<!--
18386	// BandwidthGroupType
18387	/////////////////////////////////////////////////////////////////////////
18388	-->
18389	<enum
18390	name="BandwidthGroupType"
18391	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
18392
18393	<desc>
18394	Type of a bandwidth control group.
18395	</desc>
18396
18397	<const name="Null" value="0">
18398	<desc>
18399	Null type, must be first.
18400	</desc>
18401	</const>
18402
18403	<const name="Disk" value="1">
18404	<desc>
18405	The bandwidth group controls disk I/O.
18406	</desc>
18407	</const>
18408
18409	<const name="Network" value="2">
18410	<desc>
18411	The bandwidth group controls network I/O.
18412	</desc>
18413	</const>
18414
18415	</enum>
18416
18417	<!--
18418	// IBandwidthGroup
18419	/////////////////////////////////////////////////////////////////////////
18420	-->
18421	<interface
18422	name="IBandwidthGroup" extends="$unknown"
18423	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
18424	wsmap="managed"
18425	>
18426	<desc>Represents one bandwidth group.</desc>
18427
18428	<attribute name="name" type="wstring" readonly="yes">
18429	<desc>Name of the group.</desc>
18430	</attribute>
18431
18432	<attribute name="type" type="BandwidthGroupType" readonly="yes">
18433	<desc>Type of the group.</desc>
18434	</attribute>
18435
18436	<attribute name="reference" type="unsigned long" readonly="yes">
18437	<desc>How many devices/medium attachements use this group.</desc>
18438	</attribute>
18439
18440	<attribute name="maxBytesPerSec" type="long long">
18441	<desc>The maximum number of bytes which can be transfered by all
18442	entities attached to this group during one second.</desc>
18443	</attribute>
18444
18445	</interface>
18446
18447	<!--
18448	// IBandwidthControl
18449	/////////////////////////////////////////////////////////////////////////
18450	-->
18451	<interface
18452	name="IBandwidthControl" extends="$unknown"
18453	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
18454	wsmap="managed"
18455	>
18456	<desc>
18457	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
18458	This includes network and disk I/O.
18459	</desc>
18460
18461	<attribute name="numGroups" type="unsigned long" readonly="yes">
18462	<desc>
18463	The current number of existing bandwidth groups managed.
18464	</desc>
18465	</attribute>
18466
18467	<method name="createBandwidthGroup">
18468	<desc>
18469	Creates a new bandwidth group.
18470	</desc>
18471
18472	<param name="name" type="wstring" dir="in">
18473	<desc>Name of the bandwidth group.</desc>
18474	</param>
18475	<param name="type" type="BandwidthGroupType" dir="in">
18476	<desc>The type of the bandwidth group (network or disk).</desc>
18477	</param>
18478	<param name="maxBytesPerSec" type="long long" dir="in">
18479	<desc>The maximum number of bytes which can be transfered by all
18480	entities attached to this group during one second.</desc>
18481	</param>
18482	</method>
18483
18484	<method name="deleteBandwidthGroup">
18485	<desc>
18486	Deletes a new bandwidth group.
18487	</desc>
18488
18489	<param name="name" type="wstring" dir="in">
18490	<desc>Name of the bandwidth group to delete.</desc>
18491	</param>
18492	</method>
18493
18494	<method name="getBandwidthGroup" const="yes">
18495	<desc>
18496	Get a bandwidth group by name.
18497	</desc>
18498
18499	<param name="name" type="wstring" dir="in">
18500	<desc>Name of the bandwidth group to get.</desc>
18501	</param>
18502	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
18503	<desc>Where to store the bandwidth group on success.</desc>
18504	</param>
18505	</method>
18506
18507	<method name="getAllBandwidthGroups" const="yes">
18508	<desc>
18509	Get all managed bandwidth groups.
18510	</desc>
18511
18512	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
18513	<desc>The array of managed bandwidth groups.</desc>
18514	</param>
18515	</method>
18516	</interface>
18517
18518	<!--
18519	// IVirtualBoxClient
18520	/////////////////////////////////////////////////////////////////////////
18521	-->
18522
18523	<interface
18524	name="IVirtualBoxClient" extends="$unknown"
18525	uuid="d191281f-b0cb-4d83-a8fa-0d9fd6ba234c"
18526	wsmap="suppress"
18527	>
18528	<desc>
18529	Convenience interface for client applications. Treat this as a
18530	singleton, i.e. never create more than one instance of this interface.
18531
18532	At the moment only available for clients of the local API (not usable
18533	via the webservice). Once the session logic is redesigned this might
18534	change.
18535	</desc>
18536
18537	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
18538	<desc>
18539	Reference to the server-side API root object.
18540	</desc>
18541	</attribute>
18542
18543	<attribute name="session" type="ISession" readonly="yes">
18544	<desc>
18545	Create a new session object and return the reference to it.
18546	</desc>
18547	</attribute>
18548
18549	<attribute name="eventSource" type="IEventSource" readonly="yes">
18550	<desc>
18551	Event source for VirtualBoxClient events.
18552	</desc>
18553	</attribute>
18554
18555	<method name="checkMachineError">
18556	<desc>
18557	Perform error checking before using an <link to="IMachine"/> object.
18558	Generally useful before starting a VM and all other uses. If anything
18559	is not as it should be then this method will return an appropriate
18560	error.
18561	</desc>
18562
18563	<param name="machine" type="IMachine" dir="in">
18564	<desc>The machine object to check.</desc>
18565	</param>
18566	</method>
18567	</interface>
18568
18569	<!--
18570	// Events
18571	/////////////////////////////////////////////////////////////////////////
18572	-->
18573	<enum
18574	name="VBoxEventType"
18575	uuid="0d67e79e-b7b1-4919-aab3-b36866075515"
18576	>
18577
18578	<desc>
18579	Type of an event.
18580	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18581	</desc>
18582
18583	<const name="Invalid" value="0">
18584	<desc>
18585	Invalid event, must be first.
18586	</desc>
18587	</const>
18588
18589	<const name="Any" value="1">
18590	<desc>
18591	Wildcard for all events.
18592	Events of this type are never delivered, and only used in
18593	<link to="IEventSource::registerListener"/> call to simplify registration.
18594	</desc>
18595	</const>
18596
18597	<const name="Vetoable" value="2">
18598	<desc>
18599	Wildcard for all vetoable events. Events of this type are never delivered, and only
18600	used in <link to="IEventSource::registerListener"/> call to simplify registration.
18601	</desc>
18602	</const>
18603
18604	<const name="MachineEvent" value="3">
18605	<desc>
18606	Wildcard for all machine events. Events of this type are never delivered, and only used in
18607	<link to="IEventSource::registerListener"/> call to simplify registration.
18608	</desc>
18609	</const>
18610
18611	<const name="SnapshotEvent" value="4">
18612	<desc>
18613	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
18614	<link to="IEventSource::registerListener"/> call to simplify registration.
18615	</desc>
18616	</const>
18617
18618	<const name="InputEvent" value="5">
18619	<desc>
18620	Wildcard for all input device (keyboard, mouse) events.
18621	Events of this type are never delivered, and only used in
18622	<link to="IEventSource::registerListener"/> call to simplify registration.
18623	</desc>
18624	</const>
18625
18626	<const name="LastWildcard" value="31">
18627	<desc>
18628	Last wildcard.
18629	</desc>
18630	</const>
18631
18632	<const name="OnMachineStateChanged" value="32">
18633	<desc>
18634	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
18635	</desc>
18636	</const>
18637	<const name="OnMachineDataChanged" value="33">
18638	<desc>
18639	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
18640	</desc>
18641	</const>
18642	<const name="OnExtraDataChanged" value="34">
18643	<desc>
18644	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
18645	</desc>
18646	</const>
18647	<const name="OnExtraDataCanChange" value="35">
18648	<desc>
18649	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
18650	</desc>
18651	</const>
18652	<const name="OnMediumRegistered" value="36">
18653	<desc>
18654	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
18655	</desc>
18656	</const>
18657	<const name="OnMachineRegistered" value="37">
18658	<desc>
18659	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
18660	</desc>
18661	</const>
18662	<const name="OnSessionStateChanged" value="38">
18663	<desc>
18664	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
18665	</desc>
18666	</const>
18667	<const name="OnSnapshotTaken" value="39">
18668	<desc>
18669	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
18670	</desc>
18671	</const>
18672	<const name="OnSnapshotDeleted" value="40">
18673	<desc>
18674	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
18675	</desc>
18676	</const>
18677	<const name="OnSnapshotChanged" value="41">
18678	<desc>
18679	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
18680	</desc>
18681	</const>
18682	<const name="OnGuestPropertyChanged" value="42">
18683	<desc>
18684	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
18685	</desc>
18686	</const>
18687	<!-- Console events -->
18688	<const name="OnMousePointerShapeChanged" value="43">
18689	<desc>
18690	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
18691	</desc>
18692	</const>
18693	<const name="OnMouseCapabilityChanged" value="44">
18694	<desc>
18695	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
18696	</desc>
18697	</const>
18698	<const name="OnKeyboardLedsChanged" value="45">
18699	<desc>
18700	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
18701	</desc>
18702	</const>
18703	<const name="OnStateChanged" value="46">
18704	<desc>
18705	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
18706	</desc>
18707	</const>
18708	<const name="OnAdditionsStateChanged" value="47">
18709	<desc>
18710	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
18711	</desc>
18712	</const>
18713	<const name="OnNetworkAdapterChanged" value="48">
18714	<desc>
18715	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
18716	</desc>
18717	</const>
18718	<const name="OnSerialPortChanged" value="49">
18719	<desc>
18720	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
18721	</desc>
18722	</const>
18723	<const name="OnParallelPortChanged" value="50">
18724	<desc>
18725	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
18726	</desc>
18727	</const>
18728	<const name="OnStorageControllerChanged" value="51">
18729	<desc>
18730	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
18731	</desc>
18732	</const>
18733	<const name="OnMediumChanged" value="52">
18734	<desc>
18735	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
18736	</desc>
18737	</const>
18738	<const name="OnVRDEServerChanged" value="53">
18739	<desc>
18740	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
18741	</desc>
18742	</const>
18743	<const name="OnUSBControllerChanged" value="54">
18744	<desc>
18745	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
18746	</desc>
18747	</const>
18748	<const name="OnUSBDeviceStateChanged" value="55">
18749	<desc>
18750	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
18751	</desc>
18752	</const>
18753	<const name="OnSharedFolderChanged" value="56">
18754	<desc>
18755	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
18756	</desc>
18757	</const>
18758	<const name="OnRuntimeError" value="57">
18759	<desc>
18760	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
18761	</desc>
18762	</const>
18763	<const name="OnCanShowWindow" value="58">
18764	<desc>
18765	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
18766	</desc>
18767	</const>
18768	<const name="OnShowWindow" value="59">
18769	<desc>
18770	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
18771	</desc>
18772	</const>
18773	<const name="OnCPUChanged" value="60">
18774	<desc>
18775	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
18776	</desc>
18777	</const>
18778	<const name="OnVRDEServerInfoChanged" value="61">
18779	<desc>
18780	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
18781	</desc>
18782	</const>
18783	<const name="OnEventSourceChanged" value="62">
18784	<desc>
18785	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
18786	</desc>
18787	</const>
18788	<const name="OnCPUExecutionCapChanged" value="63">
18789	<desc>
18790	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
18791	</desc>
18792	</const>
18793	<const name="OnGuestKeyboard" value="64">
18794	<desc>
18795	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
18796	</desc>
18797	</const>
18798	<const name="OnGuestMouse" value="65">
18799	<desc>
18800	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
18801	</desc>
18802	</const>
18803	<const name="OnNATRedirect" value="66">
18804	<desc>
18805	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
18806	</desc>
18807	</const>
18808	<const name="OnHostPCIDevicePlug" value="67">
18809	<desc>
18810	See <link to="IHostPCIDevicePlugEvent">IHostPCIDevicePlugEvent</link>.
18811	</desc>
18812	</const>
18813	<const name="OnVBoxSVCAvailabilityChanged" value="68">
18814	<desc>
18815	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
18816	</desc>
18817	</const>
18818	<const name="OnBandwidthGroupChanged" value="69">
18819	<desc>
18820	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
18821	</desc>
18822	</const>
18823	<const name="OnGuestMonitorChanged" value="70">
18824	<desc>
18825	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
18826	</desc>
18827	</const>
18828	<const name="OnStorageDeviceChanged" value="71">
18829	<desc>
18830	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
18831	</desc>
18832	</const>
18833	<const name="OnClipboardModeChanged" value="72">
18834	<desc>
18835	See <link to="IClipboardModeChangedEvent">IClipboardModeChangedEvent</link>.
18836	</desc>
18837	</const>
18838	<const name="OnDragAndDropModeChanged" value="73">
18839	<desc>
18840	See <link to="IDragAndDropModeChangedEvent">IDragAndDropModeChangedEvent</link>.
18841	</desc>
18842	</const>
18843	<const name="OnNATNetworkChanged" value="74">
18844	<desc>
18845	See <link to="INATNetworkChangedEvent">INATNetworkChangedEvent</link>.
18846	</desc>
18847	</const>
18848	<const name="OnNATNetworkStartStop" value="75">
18849	<desc>
18850	See <link to="INATNetworkStartStopEvent">INATNetworkStartStopEvent</link>.
18851	</desc>
18852	</const>
18853	<const name="OnNATNetworkAlter" value="76">
18854	<desc>
18855	See <link to="INATNetworkAlterEvent">INATNetworkAlterEvent</link>.
18856	</desc>
18857	</const>
18858	<const name="OnNATNetworkCreationDeletion" value="77">
18859	<desc>
18860	See <link to="INATNetworkCreationDeletionEvent">INATNetworkCreationDeletionEvent</link>.
18861	</desc>
18862	</const>
18863	<const name="OnNATNetworkSetting" value="78">
18864	<desc>
18865	See <link to="INATNetworkSettingEvent">INATNetworkSettingEvent</link>.
18866	</desc>
18867	</const>
18868	<const name="OnNATNetworkPortForward" value="79">
18869	<desc>
18870	See <link to="INATNetworkPortForwardEvent">INATNetworkPortForwardEvent</link>.
18871	</desc>
18872	</const>
18873
18874	<!-- Last event marker -->
18875	<const name="Last" value="80">
18876	<desc>
18877	Must be last event, used for iterations and structures relying on numerical event values.
18878	</desc>
18879	</const>
18880
18881	</enum>
18882
18883	<interface
18884	name="IEventSource" extends="$unknown"
18885	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
18886	wsmap="managed"
18887	>
18888	<desc>
18889	Event source. Generally, any object which could generate events can be an event source,
18890	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
18891	an event source can work with listeners in either active or passive mode. In active mode it is up to
18892	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
18893	event source keeps track of pending events for each listener and returns available events on demand.
18894
18895	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18896	</desc>
18897
18898	<method name="createListener">
18899	<desc>
18900	Creates a new listener object, useful for passive mode.
18901	</desc>
18902	<param name="listener" type="IEventListener" dir="return"/>
18903	</method>
18904
18905	<method name="createAggregator">
18906	<desc>
18907	Creates an aggregator event source, collecting events from multiple sources.
18908	This way a single listener can listen for events coming from multiple sources,
18909	using a single blocking <link to="#getEvent"/> on the returned aggregator.
18910	</desc>
18911	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
18912	<desc>
18913	Subordinate event source this one aggregatres.
18914	</desc>
18915	</param>
18916	<param name="result" type="IEventSource" dir="return">
18917	<desc>
18918	Event source aggregating passed sources.
18919	</desc>
18920	</param>
18921	</method>
18922
18923	<method name="registerListener">
18924	<desc>
18925	Register an event listener.
18926
18927	<note>
18928	To avoid system overload, the VirtualBox server process checks if passive event
18929	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
18930	current implementation, if more than 500 pending events are detected for a passive
18931	event listener, it is forcefully unregistered by the system, and further
18932	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
18933	</note>
18934	</desc>
18935	<param name="listener" type="IEventListener" dir="in">
18936	<desc>Listener to register.</desc>
18937	</param>
18938	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
18939	<desc>
18940	Event types listener is interested in. One can use wildcards like -
18941	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
18942	than one event.
18943	</desc>
18944	</param>
18945	<param name="active" type="boolean" dir="in">
18946	<desc>
18947	Which mode this listener is operating in.
18948	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
18949	In passive mode, an internal event queue is created for this this IEventListener.
18950	For each event coming in, it is added to queues for all interested registered passive
18951	listeners. It is then up to the external code to call the listener's
18952	<link to="IEventListener::handleEvent" /> method. When done with an event, the
18953	external code must call <link to="#eventProcessed" />.
18954	</desc>
18955	</param>
18956	</method>
18957
18958	<method name="unregisterListener">
18959	<desc>
18960	Unregister an event listener. If listener is passive, and some waitable events are still
18961	in queue they are marked as processed automatically.
18962	</desc>
18963	<param name="listener" type="IEventListener" dir="in">
18964	<desc>Listener to unregister.</desc>
18965	</param>
18966	</method>
18967
18968	<method name="fireEvent">
18969	<desc>
18970	Fire an event for this source.
18971	</desc>
18972	<param name="event" type="IEvent" dir="in">
18973	<desc>Event to deliver.</desc>
18974	</param>
18975	<param name="timeout" type="long" dir="in">
18976	<desc>
18977	Maximum time to wait for event processing (if event is waitable), in ms;
18978	0 = no wait, -1 = indefinite wait.
18979	</desc>
18980	</param>
18981	<param name="result" type="boolean" dir="return">
18982	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
18983	</param>
18984	</method>
18985
18986	<method name="getEvent">
18987	<desc>
18988	Get events from this peer's event queue (for passive mode). Calling this method
18989	regularly is required for passive event listeners to avoid system overload;
18990	see <link to="IEventSource::registerListener" /> for details.
18991
18992	<result name="VBOX_E_OBJECT_NOT_FOUND">
18993	Listener is not registered, or autounregistered.
18994	</result>
18995	</desc>
18996	<param name="listener" type="IEventListener" dir="in">
18997	<desc>Which listener to get data for.</desc>
18998	</param>
18999	<param name="timeout" type="long" dir="in">
19000	<desc>
19001	Maximum time to wait for events, in ms;
19002	0 = no wait, -1 = indefinite wait.
19003	</desc>
19004	</param>
19005	<param name="event" type="IEvent" dir="return">
19006	<desc>Event retrieved, or null if none available.</desc>
19007	</param>
19008	</method>
19009
19010	<method name="eventProcessed">
19011	<desc>
19012	Must be called for waitable events after a particular listener finished its
19013	event processing. When all listeners of a particular event have called this
19014	method, the system will then call <link to="IEvent::setProcessed" />.
19015	</desc>
19016	<param name="listener" type="IEventListener" dir="in">
19017	<desc>Which listener processed event.</desc>
19018	</param>
19019	<param name="event" type="IEvent" dir="in">
19020	<desc>Which event.</desc>
19021	</param>
19022	</method>
19023
19024	</interface>
19025
19026	<interface
19027	name="IEventListener" extends="$unknown"
19028	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
19029	wsmap="managed"
19030	>
19031	<desc>
19032	Event listener. An event listener can work in either active or passive mode, depending on the way
19033	it was registered.
19034	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
19035	</desc>
19036
19037	<method name="handleEvent">
19038	<desc>
19039	Handle event callback for active listeners. It is not called for
19040	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
19041	and having received acknowledgement from all passive listeners via
19042	<link to="IEventSource::eventProcessed"/>, the event is marked as
19043	processed and <link to="IEvent::waitProcessed"/> will return
19044	immediately.
19045	</desc>
19046	<param name="event" type="IEvent" dir="in">
19047	<desc>Event available.</desc>
19048	</param>
19049	</method>
19050
19051	</interface>
19052
19053	<interface
19054	name="IEvent" extends="$unknown"
19055	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
19056	wsmap="managed"
19057	>
19058	<desc>
19059	Abstract parent interface for VirtualBox events. Actual events will typically implement
19060	a more specific interface which derives from this (see below).
19061
19062	<b>Introduction to VirtualBox events</b>
19063
19064	Generally speaking, an event (represented by this interface) signals that something
19065	happened, while an event listener (see <link to="IEventListener" />) represents an
19066	entity that is interested in certain events. In order for this to work with
19067	unidirectional protocols (i.e. web services), the concepts of passive and active
19068	listener are used.
19069
19070	Event consumers can register themselves as listeners, providing an array of
19071	events they are interested in (see <link to="IEventSource::registerListener" />).
19072	When an event triggers, the listener is notified about the event. The exact
19073	mechanism of the notification depends on whether the listener was registered as
19074	an active or passive listener:
19075
19076	<ul>
19077	<li>An active listener is very similar to a callback: it is a function invoked
19078	by the API. As opposed to the callbacks that were used in the API before
19079	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
19080	</li>
19081
19082	<li>Passive listeners are somewhat trickier to implement, but do not require
19083	a client function to be callable, which is not an option with scripting
19084	languages or web service clients. Internally the <link to="IEventSource" />
19085	implementation maintains an event queue for each passive listener, and
19086	newly arrived events are put in this queue. When the listener calls
19087	<link to="IEventSource::getEvent"/>, first element from its internal event
19088	queue is returned. When the client completes processing of an event,
19089	the <link to="IEventSource::eventProcessed" /> function must be called,
19090	acknowledging that the event was processed. It supports implementing
19091	waitable events. On passive listener unregistration, all events from its
19092	queue are auto-acknowledged.
19093	</li>
19094	</ul>
19095
19096	Waitable events are useful in situations where the event generator wants to track
19097	delivery or a party wants to wait until all listeners have completed the event. A
19098	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
19099	listeners might veto a certain action, and thus the event producer has to make
19100	sure that all listeners have processed the event and not vetoed before taking
19101	the action.
19102
19103	A given event may have both passive and active listeners at the same time.
19104
19105	<b>Using events</b>
19106
19107	Any VirtualBox object capable of producing externally visible events provides an
19108	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
19109	This event source object is notified by VirtualBox once something has happened, so
19110	consumers may register event listeners with this event source. To register a listener,
19111	an object implementing the <link to="IEventListener" /> interface must be provided.
19112	For active listeners, such an object is typically created by the consumer, while for
19113	passive listeners <link to="IEventSource::createListener" /> should be used. Please
19114	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
19115
19116	Once created, the listener must be registered to listen for the desired events
19117	(see <link to="IEventSource::registerListener" />), providing an array of
19118	<link to="VBoxEventType" /> enums. Those elements can either be the individual
19119	event IDs or wildcards matching multiple event IDs.
19120
19121	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
19122	called automatically when the event is triggered, while passive listeners have to call
19123	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
19124	an event processing loop.
19125
19126	The IEvent interface is an abstract parent interface for all such VirtualBox events
19127	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
19128	or the event processing loop is to check the <link to="#type" /> attribute of the event and
19129	then cast to the appropriate specific interface using @c QueryInterface().
19130	</desc>
19131
19132	<attribute name="type" readonly="yes" type="VBoxEventType">
19133	<desc>
19134	Event type.
19135	</desc>
19136	</attribute>
19137
19138	<attribute name="source" readonly="yes" type="IEventSource">
19139	<desc>
19140	Source of this event.
19141	</desc>
19142	</attribute>
19143
19144	<attribute name="waitable" readonly="yes" type="boolean">
19145	<desc>
19146	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
19147	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
19148	as no additional overhead associated with waitability imposed.
19149	Waitable events are needed when one need to be able to wait for particular event processed,
19150	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
19151	until all consumers confirmed events.
19152	</desc>
19153	</attribute>
19154
19155	<method name="setProcessed">
19156	<desc>
19157	Internal method called by the system when all listeners of a particular event have called
19158	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
19159	</desc>
19160	</method>
19161
19162	<method name="waitProcessed">
19163	<desc>
19164	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
19165	described semantics, for non-waitable returns true immediately.
19166	</desc>
19167	<param name="timeout" type="long" dir="in">
19168	<desc>
19169	Maximum time to wait for event processeing, in ms;
19170	0 = no wait, -1 = indefinite wait.
19171	</desc>
19172	</param>
19173	<param name="result" type="boolean" dir="return">
19174	<desc>If this event was processed before timeout.</desc>
19175	</param>
19176	</method>
19177	</interface>
19178
19179
19180	<interface
19181	name="IReusableEvent" extends="IEvent"
19182	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
19183	wsmap="managed"
19184	>
19185	<desc>Base abstract interface for all reusable events.</desc>
19186
19187	<attribute name="generation" readonly="yes" type="unsigned long">
19188	<desc>Current generation of event, incremented on reuse.</desc>
19189	</attribute>
19190
19191	<method name="reuse">
19192	<desc>
19193	Marks an event as reused, increments 'generation', fields shall no
19194	longer be considered valid.
19195	</desc>
19196	</method>
19197	</interface>
19198
19199	<interface
19200	name="IMachineEvent" extends="IEvent"
19201	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
19202	wsmap="managed" id="MachineEvent"
19203	>
19204	<desc>Base abstract interface for all machine events.</desc>
19205
19206	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
19207	<desc>ID of the machine this event relates to.</desc>
19208	</attribute>
19209
19210	</interface>
19211
19212	<interface
19213	name="IMachineStateChangedEvent" extends="IMachineEvent"
19214	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
19215	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
19216	>
19217	<desc>Machine state change event.</desc>
19218
19219	<attribute name="state" readonly="yes" type="MachineState">
19220	<desc>New execution state.</desc>
19221	</attribute>
19222	</interface>
19223
19224	<interface
19225	name="IMachineDataChangedEvent" extends="IMachineEvent"
19226	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
19227	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
19228	>
19229	<desc>
19230	Any of the settings of the given machine has changed.
19231	</desc>
19232
19233	<attribute name="temporary" readonly="yes" type="boolean">
19234	<desc>@c true if the settings change is temporary. All permanent
19235	settings changes will trigger an event, and only temporary settings
19236	changes for running VMs will trigger an event. Note: sending events
19237	for temporary changes is NOT IMPLEMENTED.</desc>
19238	</attribute>
19239	</interface>
19240
19241	<interface
19242	name="IMediumRegisteredEvent" extends="IEvent"
19243	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
19244	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
19245	>
19246	<desc>
19247	The given medium was registered or unregistered
19248	within this VirtualBox installation.
19249	</desc>
19250
19251	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
19252	<desc>ID of the medium this event relates to.</desc>
19253	</attribute>
19254
19255	<attribute name="mediumType" readonly="yes" type="DeviceType">
19256	<desc>Type of the medium this event relates to.</desc>
19257	</attribute>
19258
19259	<attribute name="registered" type="boolean" readonly="yes">
19260	<desc>
19261	If @c true, the medium was registered, otherwise it was
19262	unregistered.
19263	</desc>
19264	</attribute>
19265	</interface>
19266
19267	<interface
19268	name="IMachineRegisteredEvent" extends="IMachineEvent"
19269	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
19270	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
19271	>
19272	<desc>
19273	The given machine was registered or unregistered
19274	within this VirtualBox installation.
19275	</desc>
19276
19277	<attribute name="registered" type="boolean" readonly="yes">
19278	<desc>
19279	If @c true, the machine was registered, otherwise it was
19280	unregistered.
19281	</desc>
19282	</attribute>
19283	</interface>
19284
19285	<interface
19286	name="ISessionStateChangedEvent" extends="IMachineEvent"
19287	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
19288	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
19289	>
19290	<desc>
19291	The state of the session for the given machine was changed.
19292	<see><link to="IMachine::sessionState"/></see>
19293	</desc>
19294
19295	<attribute name="state" type="SessionState" readonly="yes">
19296	<desc>
19297	New session state.
19298	</desc>
19299	</attribute>
19300	</interface>
19301
19302	<interface
19303	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
19304	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
19305	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
19306	>
19307	<desc>
19308	Notification when a guest property has changed.
19309	</desc>
19310
19311	<attribute name="name" readonly="yes" type="wstring">
19312	<desc>
19313	The name of the property that has changed.
19314	</desc>
19315	</attribute>
19316
19317	<attribute name="value" readonly="yes" type="wstring">
19318	<desc>
19319	The new property value.
19320	</desc>
19321	</attribute>
19322
19323	<attribute name="flags" readonly="yes" type="wstring">
19324	<desc>
19325	The new property flags.
19326	</desc>
19327	</attribute>
19328
19329	</interface>
19330
19331	<interface
19332	name="ISnapshotEvent" extends="IMachineEvent"
19333	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
19334	wsmap="managed" id="SnapshotEvent"
19335	>
19336	<desc>Base interface for all snapshot events.</desc>
19337
19338	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
19339	<desc>ID of the snapshot this event relates to.</desc>
19340	</attribute>
19341
19342	</interface>
19343
19344	<interface
19345	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
19346	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
19347	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
19348	>
19349	<desc>
19350	A new snapshot of the machine has been taken.
19351	<see><link to="ISnapshot"/></see>
19352	</desc>
19353	</interface>
19354
19355	<interface
19356	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
19357	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
19358	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
19359	>
19360	<desc>
19361	Snapshot of the given machine has been deleted.
19362
19363	<note>
19364	This notification is delivered <b>after</b> the snapshot
19365	object has been uninitialized on the server (so that any
19366	attempt to call its methods will return an error).
19367	</note>
19368
19369	<see><link to="ISnapshot"/></see>
19370	</desc>
19371	</interface>
19372
19373	<interface
19374	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
19375	uuid="07541941-8079-447a-a33e-47a69c7980db"
19376	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
19377	>
19378	<desc>
19379	Snapshot properties (name and/or description) have been changed.
19380	<see><link to="ISnapshot"/></see>
19381	</desc>
19382	</interface>
19383
19384	<interface
19385	name="IMousePointerShapeChangedEvent" extends="IEvent"
19386	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
19387	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
19388	>
19389	<desc>
19390	Notification when the guest mouse pointer shape has
19391	changed. The new shape data is given.
19392	</desc>
19393
19394	<attribute name="visible" type="boolean" readonly="yes">
19395	<desc>
19396	Flag whether the pointer is visible.
19397	</desc>
19398	</attribute>
19399	<attribute name="alpha" type="boolean" readonly="yes">
19400	<desc>
19401	Flag whether the pointer has an alpha channel.
19402	</desc>
19403	</attribute>
19404	<attribute name="xhot" type="unsigned long" readonly="yes">
19405	<desc>
19406	The pointer hot spot X coordinate.
19407	</desc>
19408	</attribute>
19409	<attribute name="yhot" type="unsigned long" readonly="yes">
19410	<desc>
19411	The pointer hot spot Y coordinate.
19412	</desc>
19413	</attribute>
19414	<attribute name="width" type="unsigned long" readonly="yes">
19415	<desc>
19416	Width of the pointer shape in pixels.
19417	</desc>
19418	</attribute>
19419	<attribute name="height" type="unsigned long" readonly="yes">
19420	<desc>
19421	Height of the pointer shape in pixels.
19422	</desc>
19423	</attribute>
19424	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
19425	<desc>
19426	Shape buffer arrays.
19427
19428	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
19429	followed by a 32-bpp XOR (color) mask.
19430
19431	For pointers without alpha channel the XOR mask pixels are 32
19432	bit values: (lsb)BGR0(msb). For pointers with alpha channel
19433	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
19434
19435	An AND mask is used for pointers with alpha channel, so if the
19436	callback does not support alpha, the pointer could be
19437	displayed as a normal color pointer.
19438
19439	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
19440	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
19441	height</tt>. The padding bits at the end of each scanline are
19442	undefined.
19443
19444	The XOR mask follows the AND mask on the next 4-byte aligned
19445	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
19446	Bytes in the gap between the AND and the XOR mask are undefined.
19447	The XOR mask scanlines have no gap between them and the size of
19448	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
19449
19450	<note>
19451	If @a shape is 0, only the pointer visibility is changed.
19452	</note>
19453	</desc>
19454	</attribute>
19455	</interface>
19456
19457	<interface
19458	name="IMouseCapabilityChangedEvent" extends="IEvent"
19459	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
19460	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
19461	>
19462	<desc>
19463	Notification when the mouse capabilities reported by the
19464	guest have changed. The new capabilities are passed.
19465	</desc>
19466	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
19467	<desc>
19468	Supports absolute coordinates.
19469	</desc>
19470	</attribute>
19471	<attribute name="supportsRelative" type="boolean" readonly="yes">
19472	<desc>
19473	Supports relative coordinates.
19474	</desc>
19475	</attribute>
19476	<attribute name="needsHostCursor" type="boolean" readonly="yes">
19477	<desc>
19478	If host cursor is needed.
19479	</desc>
19480	</attribute>
19481	</interface>
19482
19483	<interface
19484	name="IKeyboardLedsChangedEvent" extends="IEvent"
19485	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
19486	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
19487	>
19488	<desc>
19489	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
19490	to alter the state of the keyboard LEDs.
19491	</desc>
19492	<attribute name="numLock" type="boolean" readonly="yes">
19493	<desc>
19494	NumLock status.
19495	</desc>
19496	</attribute>
19497	<attribute name="capsLock" type="boolean" readonly="yes">
19498	<desc>
19499	CapsLock status.
19500	</desc>
19501	</attribute>
19502	<attribute name="scrollLock" type="boolean" readonly="yes">
19503	<desc>
19504	ScrollLock status.
19505	</desc>
19506	</attribute>
19507	</interface>
19508
19509	<interface
19510	name="IStateChangedEvent" extends="IEvent"
19511	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
19512	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
19513	>
19514	<desc>
19515	Notification when the execution state of the machine has changed.
19516	The new state is given.
19517	</desc>
19518	<attribute name="state" type="MachineState" readonly="yes">
19519	<desc>
19520	New machine state.
19521	</desc>
19522	</attribute>
19523	</interface>
19524
19525	<interface
19526	name="IAdditionsStateChangedEvent" extends="IEvent"
19527	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
19528	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
19529	>
19530	<desc>
19531	Notification when a Guest Additions property changes.
19532	Interested callees should query IGuest attributes to
19533	find out what has changed.
19534	</desc>
19535	</interface>
19536
19537	<interface
19538	name="INetworkAdapterChangedEvent" extends="IEvent"
19539	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
19540	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
19541	>
19542	<desc>
19543	Notification when a property of one of the
19544	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
19545	changes. Interested callees should use INetworkAdapter methods and
19546	attributes to find out what has changed.
19547	</desc>
19548	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
19549	<desc>
19550	Network adapter that is subject to change.
19551	</desc>
19552	</attribute>
19553	</interface>
19554
19555	<interface
19556	name="ISerialPortChangedEvent" extends="IEvent"
19557	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
19558	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
19559	>
19560	<desc>
19561	Notification when a property of one of the
19562	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
19563	Interested callees should use ISerialPort methods and attributes
19564	to find out what has changed.
19565	</desc>
19566	<attribute name="serialPort" type="ISerialPort" readonly="yes">
19567	<desc>
19568	Serial port that is subject to change.
19569	</desc>
19570	</attribute>
19571	</interface>
19572
19573	<interface
19574	name="IParallelPortChangedEvent" extends="IEvent"
19575	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
19576	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
19577	>
19578	<desc>
19579	Notification when a property of one of the
19580	virtual <link to="IMachine::getParallelPort">parallel ports</link>
19581	changes. Interested callees should use ISerialPort methods and
19582	attributes to find out what has changed.
19583	</desc>
19584	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
19585	<desc>
19586	Parallel port that is subject to change.
19587	</desc>
19588	</attribute>
19589	</interface>
19590
19591	<interface
19592	name="IStorageControllerChangedEvent" extends="IEvent"
19593	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
19594	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
19595	>
19596	<desc>
19597	Notification when a
19598	<link to="IMachine::mediumAttachments">medium attachment</link>
19599	changes.
19600	</desc>
19601	</interface>
19602
19603	<interface
19604	name="IMediumChangedEvent" extends="IEvent"
19605	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
19606	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
19607	>
19608	<desc>
19609	Notification when a
19610	<link to="IMachine::mediumAttachments">medium attachment</link>
19611	changes.
19612	</desc>
19613	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
19614	<desc>
19615	Medium attachment that is subject to change.
19616	</desc>
19617	</attribute>
19618	</interface>
19619
19620	<interface
19621	name="IClipboardModeChangedEvent" extends="IEvent"
19622	uuid="cac21692-7997-4595-a731-3a509db604e5"
19623	wsmap="managed" autogen="VBoxEvent" id="OnClipboardModeChanged"
19624	>
19625	<desc>
19626	Notification when the shared clipboard mode changes.
19627	</desc>
19628	<attribute name="clipboardMode" type="ClipboardMode" readonly="yes">
19629	<desc>
19630	The new clipboard mode.
19631	</desc>
19632	</attribute>
19633	</interface>
19634
19635	<interface
19636	name="IDragAndDropModeChangedEvent" extends="IEvent"
19637	uuid="e90b8850-ac8e-4dff-8059-4100ae2c3c3d"
19638	wsmap="managed" autogen="VBoxEvent" id="OnDragAndDropModeChanged"
19639	>
19640	<desc>
19641	Notification when the drag'n'drop mode changes.
19642	</desc>
19643	<attribute name="dragAndDropMode" type="DragAndDropMode" readonly="yes">
19644	<desc>
19645	The new drag'n'drop mode.
19646	</desc>
19647	</attribute>
19648	</interface>
19649
19650	<interface
19651	name="ICPUChangedEvent" extends="IEvent"
19652	uuid="4da2dec7-71b2-4817-9a64-4ed12c17388e"
19653	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
19654	>
19655	<desc>
19656	Notification when a CPU changes.
19657	</desc>
19658	<attribute name="CPU" type="unsigned long" readonly="yes">
19659	<desc>
19660	The CPU which changed.
19661	</desc>
19662	</attribute>
19663	<attribute name="add" type="boolean" readonly="yes">
19664	<desc>
19665	Flag whether the CPU was added or removed.
19666	</desc>
19667	</attribute>
19668	</interface>
19669
19670	<interface
19671	name="ICPUExecutionCapChangedEvent" extends="IEvent"
19672	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
19673	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
19674	>
19675	<desc>
19676	Notification when the CPU execution cap changes.
19677	</desc>
19678	<attribute name="executionCap" type="unsigned long" readonly="yes">
19679	<desc>
19680	The new CPU execution cap value. (1-100)
19681	</desc>
19682	</attribute>
19683	</interface>
19684
19685	<interface
19686	name="IGuestKeyboardEvent" extends="IEvent"
19687	uuid="88394258-7006-40d4-b339-472ee3801844"
19688	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
19689	>
19690	<desc>
19691	Notification when guest keyboard event happens.
19692	</desc>
19693	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
19694	<desc>
19695	Array of scancodes.
19696	</desc>
19697	</attribute>
19698	</interface>
19699
19700	<interface
19701	name="IGuestMouseEvent" extends="IReusableEvent"
19702	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
19703	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
19704	>
19705	<desc>
19706	Notification when guest mouse event happens.
19707	</desc>
19708
19709	<attribute name="absolute" type="boolean" readonly="yes">
19710	<desc>
19711	If this event is relative or absolute.
19712	</desc>
19713	</attribute>
19714
19715	<attribute name="x" type="long" readonly="yes">
19716	<desc>
19717	New X position, or X delta.
19718	</desc>
19719	</attribute>
19720
19721	<attribute name="y" type="long" readonly="yes">
19722	<desc>
19723	New Y position, or Y delta.
19724	</desc>
19725	</attribute>
19726
19727	<attribute name="z" type="long" readonly="yes">
19728	<desc>
19729	Z delta.
19730	</desc>
19731	</attribute>
19732
19733	<attribute name="w" type="long" readonly="yes">
19734	<desc>
19735	W delta.
19736	</desc>
19737	</attribute>
19738
19739	<attribute name="buttons" type="long" readonly="yes">
19740	<desc>
19741	Button state bitmask.
19742	</desc>
19743	</attribute>
19744
19745	</interface>
19746
19747
19748	<interface
19749	name="IVRDEServerChangedEvent" extends="IEvent"
19750	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
19751	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
19752	>
19753	<desc>
19754	Notification when a property of the
19755	<link to="IMachine::VRDEServer">VRDE server</link> changes.
19756	Interested callees should use IVRDEServer methods and attributes to
19757	find out what has changed.
19758	</desc>
19759	</interface>
19760
19761	<interface
19762	name="IVRDEServerInfoChangedEvent" extends="IEvent"
19763	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
19764	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
19765	>
19766	<desc>
19767	Notification when the status of the VRDE server changes. Interested callees
19768	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
19769	attributes to find out what is the current status.
19770	</desc>
19771	</interface>
19772
19773	<interface
19774	name="IUSBControllerChangedEvent" extends="IEvent"
19775	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
19776	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
19777	>
19778	<desc>
19779	Notification when a property of the virtual
19780	<link to="IMachine::USBController">USB controller</link> changes.
19781	Interested callees should use IUSBController methods and attributes to
19782	find out what has changed.
19783	</desc>
19784	</interface>
19785
19786	<interface
19787	name="IUSBDeviceStateChangedEvent" extends="IEvent"
19788	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
19789	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
19790	>
19791	<desc>
19792	Notification when a USB device is attached to or detached from
19793	the virtual USB controller.
19794
19795	This notification is sent as a result of the indirect
19796	request to attach the device because it matches one of the
19797	machine USB filters, or as a result of the direct request
19798	issued by <link to="IConsole::attachUSBDevice"/> or
19799	<link to="IConsole::detachUSBDevice"/>.
19800
19801	This notification is sent in case of both a succeeded and a
19802	failed request completion. When the request succeeds, the
19803	@a error parameter is @c null, and the given device has been
19804	already added to (when @a attached is @c true) or removed from
19805	(when @a attached is @c false) the collection represented by
19806	<link to="IConsole::USBDevices"/>. On failure, the collection
19807	doesn't change and the @a error parameter represents the error
19808	message describing the failure.
19809	</desc>
19810	<attribute name="device" type="IUSBDevice" readonly="yes">
19811	<desc>
19812	Device that is subject to state change.
19813	</desc>
19814	</attribute>
19815	<attribute name="attached" type="boolean" readonly="yes">
19816	<desc>
19817	@c true if the device was attached and @c false otherwise.
19818	</desc>
19819	</attribute>
19820	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
19821	<desc>
19822	@c null on success or an error message object on failure.
19823	</desc>
19824	</attribute>
19825	</interface>
19826
19827	<interface
19828	name="ISharedFolderChangedEvent" extends="IEvent"
19829	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
19830	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
19831	>
19832	<desc>
19833	Notification when a shared folder is added or removed.
19834	The @a scope argument defines one of three scopes:
19835	<link to="IVirtualBox::sharedFolders">global shared folders</link>
19836	(<link to="Scope_Global">Global</link>),
19837	<link to="IMachine::sharedFolders">permanent shared folders</link> of
19838	the machine (<link to="Scope_Machine">Machine</link>) or <link
19839	to="IConsole::sharedFolders">transient shared folders</link> of the
19840	machine (<link to="Scope_Session">Session</link>). Interested callees
19841	should use query the corresponding collections to find out what has
19842	changed.
19843	</desc>
19844	<attribute name="scope" type="Scope" readonly="yes">
19845	<desc>
19846	Scope of the notification.
19847	</desc>
19848	</attribute>
19849	</interface>
19850
19851	<interface
19852	name="IRuntimeErrorEvent" extends="IEvent"
19853	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
19854	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
19855	>
19856	<desc>
19857	Notification when an error happens during the virtual
19858	machine execution.
19859
19860	There are three kinds of runtime errors:
19861	<ul>
19862	<li><i>fatal</i></li>
19863	<li><i>non-fatal with retry</i></li>
19864	<li><i>non-fatal warnings</i></li>
19865	</ul>
19866
19867	<b>Fatal</b> errors are indicated by the @a fatal parameter set
19868	to @c true. In case of fatal errors, the virtual machine
19869	execution is always paused before calling this notification, and
19870	the notification handler is supposed either to immediately save
19871	the virtual machine state using <link to="IConsole::saveState"/>
19872	or power it off using <link to="IConsole::powerDown"/>.
19873	Resuming the execution can lead to unpredictable results.
19874
19875	<b>Non-fatal</b> errors and warnings are indicated by the
19876	@a fatal parameter set to @c false. If the virtual machine
19877	is in the Paused state by the time the error notification is
19878	received, it means that the user can <i>try to resume</i> the machine
19879	execution after attempting to solve the problem that caused the
19880	error. In this case, the notification handler is supposed
19881	to show an appropriate message to the user (depending on the
19882	value of the @a id parameter) that offers several actions such
19883	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
19884	wants to retry, the notification handler should continue
19885	the machine execution using the <link to="IConsole::resume"/>
19886	call. If the machine execution is not Paused during this
19887	notification, then it means this notification is a <i>warning</i>
19888	(for example, about a fatal condition that can happen very soon);
19889	no immediate action is required from the user, the machine
19890	continues its normal execution.
19891
19892	Note that in either case the notification handler
19893	<b>must not</b> perform any action directly on a thread
19894	where this notification is called. Everything it is allowed to
19895	do is to post a message to another thread that will then talk
19896	to the user and take the corresponding action.
19897
19898	Currently, the following error identifiers are known:
19899	<ul>
19900	<li><tt>"HostMemoryLow"</tt></li>
19901	<li><tt>"HostAudioNotResponding"</tt></li>
19902	<li><tt>"VDIStorageFull"</tt></li>
19903	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
19904	</ul>
19905	</desc>
19906	<attribute name="fatal" type="boolean" readonly="yes">
19907	<desc>
19908	Whether the error is fatal or not.
19909	</desc>
19910	</attribute>
19911	<attribute name="id" type="wstring" readonly="yes">
19912	<desc>
19913	Error identifier.
19914	</desc>
19915	</attribute>
19916	<attribute name="message" type="wstring" readonly="yes">
19917	<desc>
19918	Optional error message.
19919	</desc>
19920	</attribute>
19921	</interface>
19922
19923
19924	<interface
19925	name="IEventSourceChangedEvent" extends="IEvent"
19926	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
19927	waitable="yes"
19928	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
19929	>
19930	<desc>
19931	Notification when an event source state changes (listener added or removed).
19932	</desc>
19933
19934	<attribute name="listener" type="IEventListener" readonly="yes">
19935	<desc>
19936	Event listener which has changed.
19937	</desc>
19938	</attribute>
19939
19940	<attribute name="add" type="boolean" readonly="yes">
19941	<desc>
19942	Flag whether listener was added or removed.
19943	</desc>
19944	</attribute>
19945	</interface>
19946
19947	<interface
19948	name="IExtraDataChangedEvent" extends="IEvent"
19949	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
19950	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
19951	>
19952	<desc>
19953	Notification when machine specific or global extra data
19954	has changed.
19955	</desc>
19956	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
19957	<desc>
19958	ID of the machine this event relates to.
19959	Null for global extra data changes.
19960	</desc>
19961	</attribute>
19962	<attribute name="key" type="wstring" readonly="yes">
19963	<desc>
19964	Extra data key that has changed.
19965	</desc>
19966	</attribute>
19967	<attribute name="value" type="wstring" readonly="yes">
19968	<desc>
19969	Extra data value for the given key.
19970	</desc>
19971	</attribute>
19972	</interface>
19973
19974	<interface
19975	name="IVetoEvent" extends="IEvent"
19976	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
19977	wsmap="managed"
19978	>
19979	<desc>Base abstract interface for veto events.</desc>
19980
19981	<method name="addVeto">
19982	<desc>
19983	Adds a veto on this event.
19984	</desc>
19985	<param name="reason" type="wstring" dir="in">
19986	<desc>
19987	Reason for veto, could be null or empty string.
19988	</desc>
19989	</param>
19990	</method>
19991
19992	<method name="isVetoed">
19993	<desc>
19994	If this event was vetoed.
19995	</desc>
19996	<param name="result" type="boolean" dir="return">
19997	<desc>
19998	Reason for veto.
19999	</desc>
20000	</param>
20001	</method>
20002
20003	<method name="getVetos">
20004	<desc>
20005	Current veto reason list, if size is 0 - no veto.
20006	</desc>
20007	<param name="result" type="wstring" dir="return" safearray="yes">
20008	<desc>
20009	Array of reasons for veto provided by different event handlers.
20010	</desc>
20011	</param>
20012	</method>
20013
20014	</interface>
20015
20016	<interface
20017	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
20018	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
20019	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
20020	waitable="true"
20021	>
20022	<desc>
20023	Notification when someone tries to change extra data for
20024	either the given machine or (if @c null) global extra data.
20025	This gives the chance to veto against changes.
20026	</desc>
20027	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
20028	<desc>
20029	ID of the machine this event relates to.
20030	Null for global extra data changes.
20031	</desc>
20032	</attribute>
20033	<attribute name="key" type="wstring" readonly="yes">
20034	<desc>
20035	Extra data key that has changed.
20036	</desc>
20037	</attribute>
20038	<attribute name="value" type="wstring" readonly="yes">
20039	<desc>
20040	Extra data value for the given key.
20041	</desc>
20042	</attribute>
20043	</interface>
20044
20045	<interface
20046	name="ICanShowWindowEvent" extends="IVetoEvent"
20047	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
20048	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
20049	waitable="true"
20050	>
20051	<desc>
20052	Notification when a call to
20053	<link to="IMachine::canShowConsoleWindow"/> is made by a
20054	front-end to check if a subsequent call to
20055	<link to="IMachine::showConsoleWindow"/> can succeed.
20056
20057	The callee should give an answer appropriate to the current
20058	machine state using event veto. This answer must
20059	remain valid at least until the next
20060	<link to="IConsole::state">machine state</link> change.
20061	</desc>
20062	</interface>
20063
20064	<interface
20065	name="IShowWindowEvent" extends="IEvent"
20066	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
20067	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
20068	waitable="true"
20069	>
20070	<desc>
20071	Notification when a call to
20072	<link to="IMachine::showConsoleWindow"/>
20073	requests the console window to be activated and brought to
20074	foreground on the desktop of the host PC.
20075
20076	This notification should cause the VM console process to
20077	perform the requested action as described above. If it is
20078	impossible to do it at a time of this notification, this
20079	method should return a failure.
20080
20081	Note that many modern window managers on many platforms
20082	implement some sort of focus stealing prevention logic, so
20083	that it may be impossible to activate a window without the
20084	help of the currently active application (which is supposedly
20085	an initiator of this notification). In this case, this method
20086	must return a non-zero identifier that represents the
20087	top-level window of the VM console process. The caller, if it
20088	represents a currently active process, is responsible to use
20089	this identifier (in a platform-dependent manner) to perform
20090	actual window activation.
20091
20092	This method must set @a winId to zero if it has performed all
20093	actions necessary to complete the request and the console
20094	window is now active and in foreground, to indicate that no
20095	further action is required on the caller's side.
20096	</desc>
20097	<attribute name="winId" type="long long">
20098	<desc>
20099	Platform-dependent identifier of the top-level VM console
20100	window, or zero if this method has performed all actions
20101	necessary to implement the <i>show window</i> semantics for
20102	the given platform and/or this VirtualBox front-end.
20103	</desc>
20104	</attribute>
20105	</interface>
20106
20107	<interface
20108	name="INATRedirectEvent" extends="IMachineEvent"
20109	uuid="24eef068-c380-4510-bc7c-19314a7352f1"
20110	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
20111	>
20112	<desc>
20113	Notification when NAT redirect rule added or removed.
20114	</desc>
20115	<attribute name="slot" type="unsigned long" readonly="yes">
20116	<desc>
20117	Adapter which NAT attached to.
20118	</desc>
20119	</attribute>
20120	<attribute name="remove" type="boolean" readonly="yes">
20121	<desc>
20122	Whether rule remove or add.
20123	</desc>
20124	</attribute>
20125	<attribute name="name" type="wstring" readonly="yes">
20126	<desc>
20127	Name of the rule.
20128	</desc>
20129	</attribute>
20130	<attribute name="proto" type="NATProtocol" readonly="yes">
20131	<desc>
20132	Protocol (TCP or UDP) of the redirect rule.
20133	</desc>
20134	</attribute>
20135	<attribute name="hostIP" type="wstring" readonly="yes">
20136	<desc>
20137	Host ip address to bind socket on.
20138	</desc>
20139	</attribute>
20140	<attribute name="hostPort" type="long" readonly="yes">
20141	<desc>
20142	Host port to bind socket on.
20143	</desc>
20144	</attribute>
20145	<attribute name="guestIP" type="wstring" readonly="yes">
20146	<desc>
20147	Guest ip address to redirect to.
20148	</desc>
20149	</attribute>
20150	<attribute name="guestPort" type="long" readonly="yes">
20151	<desc>
20152	Guest port to redirect to.
20153	</desc>
20154	</attribute>
20155	</interface>
20156
20157	<interface
20158	name="IHostPCIDevicePlugEvent" extends="IMachineEvent"
20159	waitable="yes"
20160	uuid="a0bad6df-d612-47d3-89d4-db3992533948"
20161	wsmap="managed" autogen="VBoxEvent" id="OnHostPCIDevicePlug"
20162	>
20163	<desc>
20164	Notification when host PCI device is plugged/unplugged. Plugging
20165	usually takes place on VM startup, unplug - when
20166	<link to="IMachine::detachHostPCIDevice"/> is called.
20167
20168	<see><link to="IMachine::detachHostPCIDevice"/></see>
20169
20170	</desc>
20171
20172	<attribute name="plugged" type="boolean" readonly="yes">
20173	<desc>
20174	If device successfully plugged or unplugged.
20175	</desc>
20176	</attribute>
20177
20178	<attribute name="success" type="boolean" readonly="yes">
20179	<desc>
20180	If operation was successful, if false - 'message' attribute
20181	may be of interest.
20182	</desc>
20183	</attribute>
20184
20185	<attribute name="attachment" type="IPCIDeviceAttachment" readonly="yes">
20186	<desc>
20187	Attachment info for this device.
20188	</desc>
20189	</attribute>
20190
20191	<attribute name="message" type="wstring" readonly="yes">
20192	<desc>
20193	Optional error message.
20194	</desc>
20195	</attribute>
20196
20197	</interface>
20198
20199	<interface
20200	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
20201	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
20202	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
20203	>
20204	<desc>
20205	Notification when VBoxSVC becomes unavailable (due to a crash or similar
20206	unexpected circumstances) or available again.
20207	</desc>
20208
20209	<attribute name="available" type="boolean" readonly="yes">
20210	<desc>
20211	Whether VBoxSVC is available now.
20212	</desc>
20213	</attribute>
20214	</interface>
20215
20216	<interface
20217	name="IBandwidthGroupChangedEvent" extends="IEvent"
20218	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
20219	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
20220	>
20221	<desc>
20222	Notification when one of the bandwidth groups changed
20223	</desc>
20224	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
20225	<desc>
20226	The changed bandwidth group.
20227	</desc>
20228	</attribute>
20229	</interface>
20230
20231	<enum
20232	name="GuestMonitorChangedEventType"
20233	uuid="ef172985-7e36-4297-95be-e46396968d66"
20234	>
20235
20236	<desc>
20237	How the guest monitor has been changed.
20238	</desc>
20239
20240	<const name="Enabled" value="0">
20241	<desc>
20242	The guest monitor has been enabled by the guest.
20243	</desc>
20244	</const>
20245
20246	<const name="Disabled" value="1">
20247	<desc>
20248	The guest monitor has been disabled by the guest.
20249	</desc>
20250	</const>
20251
20252	<const name="NewOrigin" value="2">
20253	<desc>
20254	The guest monitor origin has changed in the guest.
20255	</desc>
20256	</const>
20257	</enum>
20258
20259	<interface
20260	name="IGuestMonitorChangedEvent" extends="IEvent"
20261	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
20262	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
20263	>
20264	<desc>
20265	Notification when the guest enables one of its monitors.
20266	</desc>
20267
20268	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
20269	<desc>
20270	What was changed for this guest monitor.
20271	</desc>
20272	</attribute>
20273
20274	<attribute name="screenId" type="unsigned long" readonly="yes">
20275	<desc>
20276	The monitor which was changed.
20277	</desc>
20278	</attribute>
20279
20280	<attribute name="originX" type="unsigned long" readonly="yes">
20281	<desc>
20282	Physical X origin relative to the primary screen.
20283	Valid for Enabled and NewOrigin.
20284	</desc>
20285	</attribute>
20286
20287	<attribute name="originY" type="unsigned long" readonly="yes">
20288	<desc>
20289	Physical Y origin relative to the primary screen.
20290	Valid for Enabled and NewOrigin.
20291	</desc>
20292	</attribute>
20293
20294	<attribute name="width" type="unsigned long" readonly="yes">
20295	<desc>
20296	Width of the screen.
20297	Valid for Enabled.
20298	</desc>
20299	</attribute>
20300
20301	<attribute name="height" type="unsigned long" readonly="yes">
20302	<desc>
20303	Height of the screen.
20304	Valid for Enabled.
20305	</desc>
20306	</attribute>
20307
20308	</interface>
20309
20310	<interface
20311	name="IStorageDeviceChangedEvent" extends="IEvent"
20312	uuid="232e9151-ae84-4b8e-b0f3-5c20c35caac9"
20313	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
20314	>
20315	<desc>
20316	Notification when a
20317	<link to="IMachine::mediumAttachments">storage device</link>
20318	is attached or removed.
20319	</desc>
20320	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
20321	<desc>
20322	Storage device that is subject to change.
20323	</desc>
20324	</attribute>
20325	<attribute name="removed" type="boolean" readonly="yes">
20326	<desc>
20327	Flag whether the device was removed or added to the VM.
20328	</desc>
20329	</attribute>
20330	<attribute name="silent" type="boolean" readonly="yes">
20331	<desc>
20332	Flag whether the guest should be notified about the change.
20333	</desc>
20334	</attribute>
20335	</interface>
20336	<interface
20337	name="INATNetworkChangedEvent" extends="IEvent"
20338	uuid="101ae042-1a29-4a19-92cf-02285773f3b5"
20339	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkChanged"
20340	>
20341	<!-- network name is common setting for all event types -->
20342	<attribute name="NetworkName" type="wstring" readonly="yes"/>
20343	</interface>
20344	<!-- base class for start/stop events -->
20345	<interface name="INATNetworkStartStopEvent" extends="INATNetworkChangedEvent"
20346	uuid="269d8f6b-fa1e-4cee-91c7-6d8496bea3c1"
20347	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkStartStop">
20348	<attribute name="startEvent" type="boolean" readonly="yes">
20349	<desc>
20350	IsStartEvent is true when NAT network is started and false on stopping.
20351	</desc>
20352	</attribute>
20353	</interface>
20354
20355	<!-- base class for modification events -->
20356	<interface name="INATNetworkAlterEvent" extends="INATNetworkChangedEvent"
20357	uuid="3f5a0822-163a-43b1-ad16-8d58b0ef6e75"
20358	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkAlter"/>
20359
20360	<interface name="INATNetworkCreationDeletionEvent" extends="INATNetworkAlterEvent"
20361	uuid="8d984a7e-b855-40b8-ab0c-44d3515b4528"
20362	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkCreationDeletion">
20363	<attribute name="creationEvent" type="boolean" readonly="yes"/>
20364	</interface>
20365	<interface name="INATNetworkSettingEvent" extends="INATNetworkAlterEvent"
20366	uuid="9db3a9e6-7f29-4aae-a627-5a282c83092c"
20367	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkSetting">
20368	<attribute name="enabled" type="boolean" readonly="yes"/>
20369	<attribute name="network" type="wstring" readonly="yes"/>
20370	<attribute name="gateway" type="wstring" readonly="yes"/>
20371	<attribute name="advertiseDefaultIPv6RouteEnabled" type="boolean" readonly="yes"/>
20372	<attribute name="needDhcpServer" type="boolean" readonly="yes"/>
20373	</interface>
20374	<interface name="INATNetworkPortForwardEvent" extends="INATNetworkAlterEvent"
20375	uuid="2514881b-23d0-430a-a7ff-7ed7f05534bc"
20376	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkPortForward">
20377	<attribute name="create" type="boolean" readonly="yes"/>
20378	<attribute name="ipv6" type="boolean" readonly="yes"/>
20379	<attribute name="name" type="wstring" readonly="yes"/>
20380	<attribute name="proto" type="NATProtocol" readonly="yes"/>
20381	<attribute name="hostIp" type="wstring" readonly="yes"/>
20382	<attribute name="hostPort" type="long" readonly="yes"/>
20383	<attribute name="guestIp" type="wstring" readonly="yes"/>
20384	<attribute name="guestPort" type="long" readonly="yes"/>
20385	</interface>
20386
20387	<module name="VBoxSVC" context="LocalServer">
20388	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
20389	namespace="virtualbox.org">
20390	<interface name="IVirtualBox" default="yes"/>
20391	</class>
20392	</module>
20393
20394	<module name="VBoxC" context="InprocServer" threadingModel="Free">
20395	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
20396	namespace="virtualbox.org">
20397	<interface name="IVirtualBoxClient" default="yes"/>
20398	</class>
20399
20400	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
20401	namespace="virtualbox.org">
20402	<interface name="ISession" default="yes"/>
20403	</class>
20404	</module>
20405
20406	</library>
20407
20408	</idl>
20409
20410	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

Original Format