VirtualBox.xidl@ 42782

Last change on this file since 42782 was 42754, checked in by vboxsync, 13 years ago
Main: adjusted and documented IGuestSession::(File\|Directory)CreateTemp APIs.
Property svn:eol-style set to `native`
File size: 723.5 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2012 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="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
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="52bd6f5f-1adb-4493-975d-581a9c4b803f"
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
505	<const name="Future" value="99999">
506	<desc>Settings version greater than "1.13", written by a future VirtualBox version.</desc>
507	</const>
508	</enum>
509
510	<enum
511	name="AccessMode"
512	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
513	>
514	<desc>
515	Access mode for opening files.
516	</desc>
517
518	<const name="ReadOnly" value="1"/>
519	<const name="ReadWrite" value="2"/>
520	</enum>
521
522	<enum
523	name="MachineState"
524	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
525	>
526	<desc>
527	Virtual machine execution state.
528
529	This enumeration represents possible values of the <link
530	to="IMachine::state"/> attribute.
531
532	Below is the basic virtual machine state diagram. It shows how the state
533	changes during virtual machine execution. The text in square braces shows
534	a method of the IConsole interface that performs the given state
535	transition.
536
537	<pre>
538	+---------[powerDown()] <- Stuck <--[failure]-+
539	V \|
540	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
541	\| \| \| \| V \|
542	\| Aborted -----+ +--> Running --[pause()]--> Paused
543	\| \| ^ \| ^ \|
544	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
545	\| ^ \| \| \| \|
546	\| \| +-----------------------------------------+-\|-------------------+ +
547	\| \| \| \| \|
548	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
549	\| \| \| \|
550	\| +-------- Saving <--------[saveState()]<----------+---------------------+
551	\| \| \|
552	+-------------- Stopping -------[powerDown()]<----------+---------------------+
553	</pre>
554
555	Note that states to the right from PoweredOff, Aborted and Saved in the
556	above diagram are called <i>online VM states</i>. These states
557	represent the virtual machine which is being executed in a dedicated
558	process (usually with a GUI window attached to it where you can see the
559	activity of the virtual machine and interact with it). There are two
560	special pseudo-states, FirstOnline and LastOnline, that can be used in
561	relational expressions to detect if the given machine state is online or
562	not:
563
564	<pre>
565	if (machine.GetState() >= MachineState_FirstOnline &&
566	machine.GetState() <= MachineState_LastOnline)
567	{
568	...the machine is being executed...
569	}
570	</pre>
571
572	When the virtual machine is in one of the online VM states (that is, being
573	executed), only a few machine settings can be modified. Methods working
574	with such settings contain an explicit note about that. An attempt to
575	change any other setting or perform a modifying operation during this time
576	will result in the @c VBOX_E_INVALID_VM_STATE error.
577
578	All online states except Running, Paused and Stuck are transitional: they
579	represent temporary conditions of the virtual machine that will last as
580	long as the operation that initiated such a condition.
581
582	The Stuck state is a special case. It means that execution of the machine
583	has reached the "Guru Meditation" condition. This condition indicates an
584	internal VMM (virtual machine manager) failure which may happen as a
585	result of either an unhandled low-level virtual hardware exception or one
586	of the recompiler exceptions (such as the <i>too-many-traps</i>
587	condition).
588
589	Note also that any online VM state may transit to the Aborted state. This
590	happens if the process that is executing the virtual machine terminates
591	unexpectedly (for example, crashes). Other than that, the Aborted state is
592	equivalent to PoweredOff.
593
594	There are also a few additional state diagrams that do not deal with
595	virtual machine execution and therefore are shown separately. The states
596	shown on these diagrams are called <i>offline VM states</i> (this includes
597	PoweredOff, Aborted and Saved too).
598
599	The first diagram shows what happens when a lengthy setup operation is
600	being executed (such as <link to="IMachine::attachDevice"/>).
601
602	<pre>
603	+----------------------------------(same state as before the call)------+
604	\| \|
605	+-> PoweredOff --+ \|
606	\| \| \|
607	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
608	\| \|
609	+-> Saved -------+
610	</pre>
611
612	The next two diagrams demonstrate the process of taking a snapshot of a
613	powered off virtual machine, restoring the state to that as of a snapshot
614	or deleting a snapshot, respectively.
615
616	<pre>
617	+----------------------------------(same state as before the call)------+
618	\| \|
619	+-> PoweredOff --+ \|
620	\| +-->[takeSnapshot()] -------------------> Saving ------+
621	+-> Aborted -----+
622
623	+-> PoweredOff --+
624	\| \|
625	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
626	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
627	+-> Saved -------+ \|
628	\| \|
629	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
630	</pre>
631
632	Note that the Saving state is present in both the offline state group and
633	online state group. Currently, the only way to determine what group is
634	assumed in a particular case is to remember the previous machine state: if
635	it was Running or Paused, then Saving is an online state, otherwise it is
636	an offline state. This inconsistency may be removed in one of the future
637	versions of VirtualBox by adding a new state.
638
639	<note internal="yes">
640	For whoever decides to touch this enum: In order to keep the
641	comparisons involving FirstOnline and LastOnline pseudo-states valid,
642	the numeric values of these states must be correspondingly updated if
643	needed: for any online VM state, the condition
644	<tt>FirstOnline <= state <= LastOnline</tt> must be
645	@c true. The same relates to transient states for which
646	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
647	@c true.
648	</note>
649	</desc>
650
651	<const name="Null" value="0">
652	<desc>Null value (never used by the API).</desc>
653	</const>
654	<const name="PoweredOff" value="1">
655	<desc>
656	The machine is not running and has no saved execution state; it has
657	either never been started or been shut down successfully.
658	</desc>
659	</const>
660	<const name="Saved" value="2">
661	<desc>
662	The machine is not currently running, but the execution state of the machine
663	has been saved to an external file when it was running, from where
664	it can be resumed.
665	</desc>
666	</const>
667	<const name="Teleported" value="3">
668	<desc>
669	The machine was teleported to a different host (or process) and then
670	powered off. Take care when powering it on again may corrupt resources
671	it shares with the teleportation target (e.g. disk and network).
672	</desc>
673	</const>
674	<const name="Aborted" value="4">
675	<desc>
676	The process running the machine has terminated abnormally. This may
677	indicate a crash of the VM process in host execution context, or
678	the VM process has been terminated externally.
679	</desc>
680	</const>
681	<const name="Running" value="5">
682	<desc>
683	The machine is currently being executed.
684	<note internal="yes">
685	For whoever decides to touch this enum: In order to keep the
686	comparisons in the old source code valid, this state must immediately
687	precede the Paused state.
688	TODO: Lift this spectacularly wonderful restriction.
689	</note>
690	</desc>
691	</const>
692	<const name="Paused" value="6">
693	<desc>
694	Execution of the machine has been paused.
695	<note internal="yes">
696	For whoever decides to touch this enum: In order to keep the
697	comparisons in the old source code valid, this state must immediately
698	follow the Running state.
699	TODO: Lift this spectacularly wonderful restriction.
700	</note>
701	</desc>
702	</const>
703	<const name="Stuck" value="7">
704	<desc>
705	Execution of the machine has reached the "Guru Meditation"
706	condition. This indicates a severe error in the hypervisor itself.
707	<note internal="yes">
708	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
709	"Guru", perhaps? Or are there some other VMM states that are
710	intended to be lumped in here as well?
711	</note>
712	</desc>
713	</const>
714	<const name="Teleporting" value="8">
715	<desc>
716	The machine is about to be teleported to a different host or process.
717	It is possible to pause a machine in this state, but it will go to the
718	@c TeleportingPausedVM state and it will not be
719	possible to resume it again unless the teleportation fails.
720	</desc>
721	</const>
722	<const name="LiveSnapshotting" value="9">
723	<desc>
724	A live snapshot is being taken. The machine is running normally, but
725	some of the runtime configuration options are inaccessible. Also, if
726	paused while in this state it will transition to
727	@c Saving and it will not be resume the
728	execution until the snapshot operation has completed.
729	</desc>
730	</const>
731	<const name="Starting" value="10">
732	<desc>
733	Machine is being started after powering it on from a
734	zero execution state.
735	</desc>
736	</const>
737	<const name="Stopping" value="11">
738	<desc>
739	Machine is being normally stopped powering it off, or after the guest OS
740	has initiated a shutdown sequence.
741	</desc>
742	</const>
743	<const name="Saving" value="12">
744	<desc>
745	Machine is saving its execution state to a file, or an online
746	snapshot of the machine is being taken.
747	</desc>
748	</const>
749	<const name="Restoring" value="13">
750	<desc>
751	Execution state of the machine is being restored from a file
752	after powering it on from the saved execution state.
753	</desc>
754	</const>
755	<const name="TeleportingPausedVM" value="14">
756	<desc>
757	The machine is being teleported to another host or process, but it is
758	not running. This is the paused variant of the
759	@c state.
760	</desc>
761	</const>
762	<const name="TeleportingIn" value="15">
763	<desc>
764	Teleporting the machine state in from another host or process.
765	</desc>
766	</const>
767	<const name="FaultTolerantSyncing" value="16">
768	<desc>
769	The machine is being synced with a fault tolerant VM running elsewhere.
770	</desc>
771	</const>
772	<const name="DeletingSnapshotOnline" value="17">
773	<desc>
774	Like @c DeletingSnapshot, but the merging of media is ongoing in
775	the background while the machine is running.
776	</desc>
777	</const>
778	<const name="DeletingSnapshotPaused" value="18">
779	<desc>
780	Like @c DeletingSnapshotOnline, but the machine was paused when the
781	merging of differencing media was started.
782	</desc>
783	</const>
784	<const name="RestoringSnapshot" value="19">
785	<desc>
786	A machine snapshot is being restored; this typically does not take long.
787	</desc>
788	</const>
789	<const name="DeletingSnapshot" value="20">
790	<desc>
791	A machine snapshot is being deleted; this can take a long time since this
792	may require merging differencing media. This value indicates that the
793	machine is not running while the snapshot is being deleted.
794	</desc>
795	</const>
796	<const name="SettingUp" value="21">
797	<desc>
798	Lengthy setup operation is in progress.
799	</desc>
800	</const>
801
802	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
803	<desc>
804	Pseudo-state: first online state (for use in relational expressions).
805	</desc>
806	</const>
807	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
808	<desc>
809	Pseudo-state: last online state (for use in relational expressions).
810	</desc>
811	</const>
812
813	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
814	<desc>
815	Pseudo-state: first transient state (for use in relational expressions).
816	</desc>
817	</const>
818	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
819	<desc>
820	Pseudo-state: last transient state (for use in relational expressions).
821	</desc>
822	</const>
823
824	</enum>
825
826	<enum
827	name="SessionState"
828	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
829	>
830	<desc>
831	Session state. This enumeration represents possible values of
832	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
833	attributes.
834	</desc>
835
836	<const name="Null" value="0">
837	<desc>Null value (never used by the API).</desc>
838	</const>
839	<const name="Unlocked" value="1">
840	<desc>
841	In <link to="IMachine::sessionState"/>, this means that the machine
842	is not locked for any sessions.
843
844	In <link to="ISession::state"/>, this means that no machine is
845	currently locked for this session.
846	</desc>
847	</const>
848	<const name="Locked" value="2">
849	<desc>
850	In <link to="IMachine::sessionState"/>, this means that the machine
851	is currently locked for a session, whose process identifier can
852	then be found in the <link to="IMachine::sessionPID" /> attribute.
853
854	In <link to="ISession::state"/>, this means that a machine is
855	currently locked for this session, and the mutable machine object
856	can be found in the <link to="ISession::machine"/> attribute
857	(see <link to="IMachine::lockMachine" /> for details).
858	</desc>
859	</const>
860	<const name="Spawning" value="3">
861	<desc>
862	A new process is being spawned for the machine as a result of
863	<link to="IMachine::launchVMProcess"/> call. This state also occurs
864	as a short transient state during an <link to="IMachine::lockMachine"/>
865	call.
866	</desc>
867	</const>
868	<const name="Unlocking" value="4">
869	<desc>
870	The session is being unlocked.
871	</desc>
872	</const>
873	</enum>
874
875	<enum
876	name="CPUPropertyType"
877	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
878	>
879	<desc>
880	Virtual CPU property type. This enumeration represents possible values of the
881	IMachine get- and setCPUProperty methods.
882	</desc>
883	<const name="Null" value="0">
884	<desc>Null value (never used by the API).</desc>
885	</const>
886	<const name="PAE" value="1">
887	<desc>
888	This setting determines whether VirtualBox will expose the Physical Address
889	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
890	is not available, it will not be reported.
891	</desc>
892	</const>
893	<const name="Synthetic" value="2">
894	<desc>
895	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
896	teleporting between host systems that differ significantly.
897	</desc>
898	</const>
899	</enum>
900
901
902	<enum
903	name="HWVirtExPropertyType"
904	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
905	>
906	<desc>
907	Hardware virtualization property type. This enumeration represents possible values
908	for the <link to="IMachine::getHWVirtExProperty"/> and
909	<link to="IMachine::setHWVirtExProperty"/> methods.
910	</desc>
911	<const name="Null" value="0">
912	<desc>Null value (never used by the API).</desc>
913	</const>
914	<const name="Enabled" value="1">
915	<desc>
916	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
917	such extensions are not available, they will not be used.
918	</desc>
919	</const>
920	<const name="Exclusive" value="2">
921	<desc>
922	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
923	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
924	feature of the host. To share these with other hypervisors, you must disable this property.
925	</desc>
926	</const>
927	<const name="VPID" value="3">
928	<desc>
929	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
930	</desc>
931	</const>
932	<const name="NestedPaging" value="4">
933	<desc>
934	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
935	</desc>
936	</const>
937	<const name="LargePages" value="5">
938	<desc>
939	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
940	</desc>
941	</const>
942	<const name="Force" value="6">
943	<desc>
944	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
945	not set, there will be an automatic fallback to software virtualization.
946	</desc>
947	</const>
948	</enum>
949
950	<enum
951	name="FaultToleranceState"
952	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
953	>
954	<desc>
955	Used with <link to="IMachine::faultToleranceState" />.
956	</desc>
957	<const name="Inactive" value="1">
958	<desc>No fault tolerance enabled.</desc>
959	</const>
960	<const name="Master" value="2">
961	<desc>Fault tolerant master VM.</desc>
962	</const>
963	<const name="Standby" value="3">
964	<desc>Fault tolerant standby VM.</desc>
965	</const>
966	</enum>
967
968	<enum
969	name="LockType"
970	uuid="168a6a8e-12fd-4878-a1f9-38a750a56089"
971	>
972	<desc>
973	Used with <link to="IMachine::lockMachine" />.
974	</desc>
975	<const name="Write" value="2">
976	<desc>Lock the machine for writing.</desc>
977	</const>
978	<const name="Shared" value="1">
979	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
980	</const>
981	<const name="VM" value="3">
982	<desc>Lock the machine for writing, and create objects necessary for
983	running a VM in this process.</desc>
984	</const>
985	</enum>
986
987	<enum
988	name="SessionType"
989	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
990	>
991	<desc>
992	Session type. This enumeration represents possible values of the
993	<link to="ISession::type"/> attribute.
994	</desc>
995
996	<const name="Null" value="0">
997	<desc>Null value (never used by the API).</desc>
998	</const>
999	<const name="WriteLock" value="1">
1000	<desc>
1001	Session has acquired an exclusive write lock on a machine
1002	using <link to="IMachine::lockMachine"/>.
1003	</desc>
1004	</const>
1005	<const name="Remote" value="2">
1006	<desc>
1007	Session has launched a VM process using
1008	<link to="IMachine::launchVMProcess"/>
1009	</desc>
1010	</const>
1011	<const name="Shared" value="3">
1012	<desc>
1013	Session has obtained a link to another session using
1014	<link to="IMachine::lockMachine"/>
1015	</desc>
1016	</const>
1017	</enum>
1018
1019	<enum
1020	name="DeviceType"
1021	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1022	>
1023	<desc>
1024	Device type.
1025	</desc>
1026	<const name="Null" value="0">
1027	<desc>
1028	Null value, may also mean "no device" (not allowed for
1029	<link to="IConsole::getDeviceActivity"/>).
1030	</desc>
1031	</const>
1032	<const name="Floppy" value="1">
1033	<desc>Floppy device.</desc>
1034	</const>
1035	<const name="DVD" value="2">
1036	<desc>CD/DVD-ROM device.</desc>
1037	</const>
1038	<const name="HardDisk" value="3">
1039	<desc>Hard disk device.</desc>
1040	</const>
1041	<const name="Network" value="4">
1042	<desc>Network device.</desc>
1043	</const>
1044	<const name="USB" value="5">
1045	<desc>USB device.</desc>
1046	</const>
1047	<const name="SharedFolder" value="6">
1048	<desc>Shared folder device.</desc>
1049	</const>
1050	</enum>
1051
1052	<enum
1053	name="DeviceActivity"
1054	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1055	>
1056	<desc>
1057	Device activity for <link to="IConsole::getDeviceActivity"/>.
1058	</desc>
1059
1060	<const name="Null" value="0"/>
1061	<const name="Idle" value="1"/>
1062	<const name="Reading" value="2"/>
1063	<const name="Writing" value="3"/>
1064	</enum>
1065
1066	<enum
1067	name="ClipboardMode"
1068	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1069	>
1070	<desc>
1071	Host-Guest clipboard interchange mode.
1072	</desc>
1073
1074	<const name="Disabled" value="0"/>
1075	<const name="HostToGuest" value="1"/>
1076	<const name="GuestToHost" value="2"/>
1077	<const name="Bidirectional" value="3"/>
1078	</enum>
1079
1080	<enum
1081	name="DragAndDropMode"
1082	uuid="b618ea0e-b6fb-4f8d-97f7-5e237e49b547"
1083	>
1084	<desc>
1085	Drag'n'Drop interchange mode.
1086	</desc>
1087
1088	<const name="Disabled" value="0"/>
1089	<const name="HostToGuest" value="1"/>
1090	<const name="GuestToHost" value="2"/>
1091	<const name="Bidirectional" value="3"/>
1092	</enum>
1093
1094	<enum
1095	name="Scope"
1096	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1097	>
1098	<desc>
1099	Scope of the operation.
1100
1101	A generic enumeration used in various methods to define the action or
1102	argument scope.
1103	</desc>
1104
1105	<const name="Global" value="0"/>
1106	<const name="Machine" value="1"/>
1107	<const name="Session" value="2"/>
1108	</enum>
1109
1110	<enum
1111	name="BIOSBootMenuMode"
1112	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1113	>
1114	<desc>
1115	BIOS boot menu mode.
1116	</desc>
1117
1118	<const name="Disabled" value="0"/>
1119	<const name="MenuOnly" value="1"/>
1120	<const name="MessageAndMenu" value="2"/>
1121	</enum>
1122
1123	<enum
1124	name="ProcessorFeature"
1125	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1126	>
1127	<desc>
1128	CPU features.
1129	</desc>
1130
1131	<const name="HWVirtEx" value="0"/>
1132	<const name="PAE" value="1"/>
1133	<const name="LongMode" value="2"/>
1134	<const name="NestedPaging" value="3"/>
1135	</enum>
1136
1137	<enum
1138	name="FirmwareType"
1139	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1140	>
1141	<desc>
1142	Firmware type.
1143	</desc>
1144	<const name="BIOS" value="1">
1145	<desc>BIOS Firmware.</desc>
1146	</const>
1147	<const name="EFI" value="2">
1148	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1149	</const>
1150	<const name="EFI32" value="3">
1151	<desc>Efi firmware, 32-bit.</desc>
1152	</const>
1153	<const name="EFI64" value="4">
1154	<desc>Efi firmware, 64-bit.</desc>
1155	</const>
1156	<const name="EFIDUAL" value="5">
1157	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1158	</const>
1159	</enum>
1160
1161	<enum
1162	name="PointingHIDType"
1163	uuid="e44b2f7b-72ba-44fb-9e53-2186014f0d17"
1164	>
1165	<desc>
1166	Type of pointing device used in a virtual machine.
1167	</desc>
1168	<const name="None" value="1">
1169	<desc>No mouse.</desc>
1170	</const>
1171	<const name="PS2Mouse" value="2">
1172	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1173	</const>
1174	<const name="USBMouse" value="3">
1175	<desc>USB mouse (relative pointer).</desc>
1176	</const>
1177	<const name="USBTablet" value="4">
1178	<desc>USB tablet (absolute pointer).</desc>
1179	</const>
1180	<const name="ComboMouse" value="5">
1181	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1182	Using of such device can have negative performance implications. </desc>
1183	</const>
1184	</enum>
1185
1186	<enum
1187	name="KeyboardHIDType"
1188	uuid="383e43d7-5c7c-4ec8-9cb8-eda1bccd6699"
1189	>
1190	<desc>
1191	Type of keyboard device used in a virtual machine.
1192	</desc>
1193	<const name="None" value="1">
1194	<desc>No keyboard.</desc>
1195	</const>
1196	<const name="PS2Keyboard" value="2">
1197	<desc>PS/2 keyboard.</desc>
1198	</const>
1199	<const name="USBKeyboard" value="3">
1200	<desc>USB keyboard.</desc>
1201	</const>
1202	<const name="ComboKeyboard" value="4">
1203	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1204	Using of such device can have negative performance implications. </desc>
1205	</const>
1206	</enum>
1207
1208	<!--
1209	// IVirtualBoxErrorInfo
1210	/////////////////////////////////////////////////////////////////////////
1211	-->
1212
1213	<interface
1214	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1215	uuid="f91e6e91-49e1-4fd2-b21e-269003350d06"
1216	supportsErrorInfo="no"
1217	wsmap="managed"
1218	>
1219	<desc>
1220	The IVirtualBoxErrorInfo interface represents extended error information.
1221
1222	Extended error information can be set by VirtualBox components after
1223	unsuccessful or partially successful method invocation. This information
1224	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1225	and then shown to the client in addition to the plain 32-bit result code.
1226
1227	In MS COM, this interface extends the IErrorInfo interface,
1228	in XPCOM, it extends the nsIException interface. In both cases,
1229	it provides a set of common attributes to retrieve error
1230	information.
1231
1232	Sometimes invocation of some component's method may involve methods of
1233	other components that may also fail (independently of this method's
1234	failure), or a series of non-fatal errors may precede a fatal error that
1235	causes method failure. In cases like that, it may be desirable to preserve
1236	information about all errors happened during method invocation and deliver
1237	it to the caller. The <link to="#next"/> attribute is intended
1238	specifically for this purpose and allows to represent a chain of errors
1239	through a single IVirtualBoxErrorInfo object set after method invocation.
1240
1241	<note>errors are stored to a chain in the reverse order, i.e. the
1242	initial error object you query right after method invocation is the last
1243	error set by the callee, the object it points to in the @a next attribute
1244	is the previous error and so on, up to the first error (which is the last
1245	in the chain).</note>
1246	</desc>
1247
1248	<attribute name="resultCode" type="long" readonly="yes">
1249	<desc>
1250	Result code of the error.
1251	Usually, it will be the same as the result code returned
1252	by the method that provided this error information, but not
1253	always. For example, on Win32, CoCreateInstance() will most
1254	likely return E_NOINTERFACE upon unsuccessful component
1255	instantiation attempt, but not the value the component factory
1256	returned. Value is typed 'long', not 'result',
1257	to make interface usable from scripting languages.
1258	<note>
1259	In MS COM, there is no equivalent.
1260	In XPCOM, it is the same as nsIException::result.
1261	</note>
1262	</desc>
1263	</attribute>
1264
1265	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1266	<desc>
1267	UUID of the interface that defined the error.
1268	<note>
1269	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1270	data type.
1271	In XPCOM, there is no equivalent.
1272	</note>
1273	</desc>
1274	</attribute>
1275
1276	<attribute name="component" type="wstring" readonly="yes">
1277	<desc>
1278	Name of the component that generated the error.
1279	<note>
1280	In MS COM, it is the same as IErrorInfo::GetSource.
1281	In XPCOM, there is no equivalent.
1282	</note>
1283	</desc>
1284	</attribute>
1285
1286	<attribute name="text" type="wstring" readonly="yes">
1287	<desc>
1288	Text description of the error.
1289	<note>
1290	In MS COM, it is the same as IErrorInfo::GetDescription.
1291	In XPCOM, it is the same as nsIException::message.
1292	</note>
1293	</desc>
1294	</attribute>
1295
1296	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1297	<desc>
1298	Next error object if there is any, or @c null otherwise.
1299	<note>
1300	In MS COM, there is no equivalent.
1301	In XPCOM, it is the same as nsIException::inner.
1302	</note>
1303	</desc>
1304	</attribute>
1305
1306	</interface>
1307
1308	<!--
1309	// IVirtualBox
1310	/////////////////////////////////////////////////////////////////////////
1311	-->
1312
1313	<interface
1314	name="IDHCPServer" extends="$unknown"
1315	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1316	wsmap="managed"
1317	>
1318	<desc>
1319	The IDHCPServer interface represents the vbox DHCP server configuration.
1320
1321	To enumerate all the DHCP servers on the host, use the
1322	<link to="IVirtualBox::DHCPServers"/> attribute.
1323	</desc>
1324
1325	<attribute name="enabled" type="boolean">
1326	<desc>
1327	specifies if the DHCP server is enabled
1328	</desc>
1329	</attribute>
1330
1331	<attribute name="IPAddress" type="wstring" readonly="yes">
1332	<desc>
1333	specifies server IP
1334	</desc>
1335	</attribute>
1336
1337	<attribute name="networkMask" type="wstring" readonly="yes">
1338	<desc>
1339	specifies server network mask
1340	</desc>
1341	</attribute>
1342
1343	<attribute name="networkName" type="wstring" readonly="yes">
1344	<desc>
1345	specifies internal network name the server is used for
1346	</desc>
1347	</attribute>
1348
1349	<attribute name="lowerIP" type="wstring" readonly="yes">
1350	<desc>
1351	specifies from IP address in server address range
1352	</desc>
1353	</attribute>
1354
1355	<attribute name="upperIP" type="wstring" readonly="yes">
1356	<desc>
1357	specifies to IP address in server address range
1358	</desc>
1359	</attribute>
1360
1361	<method name="setConfiguration">
1362	<desc>
1363	configures the server
1364	<result name="E_INVALIDARG">
1365	invalid configuration supplied
1366	</result>
1367	</desc>
1368	<param name="IPAddress" type="wstring" dir="in">
1369	<desc>
1370	server IP address
1371	</desc>
1372	</param>
1373	<param name="networkMask" type="wstring" dir="in">
1374	<desc>
1375	server network mask
1376	</desc>
1377	</param>
1378	<param name="FromIPAddress" type="wstring" dir="in">
1379	<desc>
1380	server From IP address for address range
1381	</desc>
1382	</param>
1383	<param name="ToIPAddress" type="wstring" dir="in">
1384	<desc>
1385	server To IP address for address range
1386	</desc>
1387	</param>
1388	</method>
1389
1390	<method name="start">
1391	<desc>
1392	Starts DHCP server process.
1393	<result name="E_FAIL">
1394	Failed to start the process.
1395	</result>
1396	</desc>
1397	<param name="networkName" type="wstring" dir="in">
1398	<desc>
1399	Name of internal network DHCP server should attach to.
1400	</desc>
1401	</param>
1402	<param name="trunkName" type="wstring" dir="in">
1403	<desc>
1404	Name of internal network trunk.
1405	</desc>
1406	</param>
1407	<param name="trunkType" type="wstring" dir="in">
1408	<desc>
1409	Type of internal network trunk.
1410	</desc>
1411	</param>
1412	</method>
1413
1414	<method name="stop">
1415	<desc>
1416	Stops DHCP server process.
1417	<result name="E_FAIL">
1418	Failed to stop the process.
1419	</result>
1420	</desc>
1421	</method>
1422	</interface>
1423
1424	<interface
1425	name="IVirtualBox" extends="$unknown"
1426	uuid="5c8814a1-2a35-402d-8680-68e5cb4e72aa"
1427	wsmap="managed"
1428	>
1429	<desc>
1430	The IVirtualBox interface represents the main interface exposed by the
1431	product that provides virtual machine management.
1432
1433	An instance of IVirtualBox is required for the product to do anything
1434	useful. Even though the interface does not expose this, internally,
1435	IVirtualBox is implemented as a singleton and actually lives in the
1436	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1437	IVirtualBox can track the state of all virtual machines on a particular
1438	host, regardless of which frontend started them.
1439
1440	To enumerate all the virtual machines on the host, use the
1441	<link to="IVirtualBox::machines"/> attribute.
1442	</desc>
1443
1444	<attribute name="version" type="wstring" readonly="yes">
1445	<desc>
1446	A string representing the version number of the product. The
1447	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1448	last number represents the build number and will frequently change.
1449
1450	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1451	in prerelease builds. Non-Oracle builds may (/shall) also have a
1452	publisher tag, at the end. The publisher tag starts with an underscore
1453	just like the prerelease build type tag.
1454	</desc>
1455	</attribute>
1456
1457	<attribute name="versionNormalized" type="wstring" readonly="yes">
1458	<desc>
1459	A string representing the version number of the product,
1460	without the publisher information (but still with other tags).
1461	See <link to="#version" />.
1462	</desc>
1463	</attribute>
1464
1465	<attribute name="revision" type="unsigned long" readonly="yes">
1466	<desc>
1467	The internal build revision number of the product.
1468	</desc>
1469	</attribute>
1470
1471	<attribute name="packageType" type="wstring" readonly="yes">
1472	<desc>
1473	A string representing the package type of this product. The
1474	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1475	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1476	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1477	this.
1478	</desc>
1479	</attribute>
1480
1481	<attribute name="APIVersion" type="wstring" readonly="yes">
1482	<desc>
1483	A string representing the VirtualBox API version number. The format is
1484	2 integer numbers divided by an underscore (e.g. 1_0). After the
1485	first public release of packages with a particular API version the
1486	API will not be changed in an incompatible way. Note that this
1487	guarantee does not apply to development builds, and also there is no
1488	guarantee that this version is identical to the first two integer
1489	numbers of the package version.
1490	</desc>
1491	</attribute>
1492
1493	<attribute name="homeFolder" type="wstring" readonly="yes">
1494	<desc>
1495	Full path to the directory where the global settings file,
1496	<tt>VirtualBox.xml</tt>, is stored.
1497
1498	In this version of VirtualBox, the value of this property is
1499	always <tt><user_dir>/.VirtualBox</tt> (where
1500	<tt><user_dir></tt> is the path to the user directory,
1501	as determined by the host OS), and cannot be changed.
1502
1503	This path is also used as the base to resolve relative paths in
1504	places where relative paths are allowed (unless otherwise
1505	expressly indicated).
1506	</desc>
1507	</attribute>
1508
1509	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1510	<desc>
1511	Full name of the global settings file.
1512	The value of this property corresponds to the value of
1513	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1514	</desc>
1515	</attribute>
1516
1517	<attribute name="host" type="IHost" readonly="yes">
1518	<desc>Associated host object.</desc>
1519	</attribute>
1520
1521	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1522	<desc>Associated system information object.</desc>
1523	</attribute>
1524
1525	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1526	<desc>
1527	Array of machine objects registered within this VirtualBox instance.
1528	</desc>
1529	</attribute>
1530
1531	<attribute name="machineGroups" type="wstring" readonly="yes" safearray="yes">
1532	<desc>
1533	Array of all machine group names which are used by the machines which
1534	are accessible. Each group is only listed once, however they are listed
1535	in no particular order and there is no guarantee that there are no gaps
1536	in the group hierarchy (i.e. <tt>"/"</tt>, <tt>"/group/subgroup"</tt>
1537	is a valid result).
1538	</desc>
1539	</attribute>
1540
1541	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1542	<desc>
1543	Array of medium objects known to this VirtualBox installation.
1544
1545	This array contains only base media. All differencing
1546	media of the given base medium can be enumerated using
1547	<link to="IMedium::children"/>.
1548	</desc>
1549	</attribute>
1550
1551	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1552	<desc>
1553	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1554	</desc>
1555	</attribute>
1556
1557	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1558	<desc>
1559	Array of floppy image objects currently in use by this VirtualBox instance.
1560	</desc>
1561	</attribute>
1562
1563	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1564
1565	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1566
1567	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1568	<desc>
1569	Collection of global shared folders. Global shared folders are
1570	available to all virtual machines.
1571
1572	New shared folders are added to the collection using
1573	<link to="#createSharedFolder"/>. Existing shared folders can be
1574	removed using <link to="#removeSharedFolder"/>.
1575
1576	<note>
1577	In the current version of the product, global shared folders are not
1578	implemented and therefore this collection is always empty.
1579	</note>
1580	</desc>
1581	</attribute>
1582
1583	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1584	<desc>
1585	Associated performance collector object.
1586	</desc>
1587	</attribute>
1588
1589	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1590	<desc>
1591	DHCP servers.
1592	</desc>
1593	</attribute>
1594
1595	<attribute name="eventSource" type="IEventSource" readonly="yes">
1596	<desc>
1597	Event source for VirtualBox events.
1598	</desc>
1599	</attribute>
1600
1601	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1602	<desc>
1603	The extension pack manager.
1604	</desc>
1605	</attribute>
1606
1607
1608	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1609	<desc>
1610	Names of all internal networks.
1611	</desc>
1612	</attribute>
1613
1614	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1615	<desc>
1616	Names of all generic network drivers.
1617	</desc>
1618	</attribute>
1619
1620	<method name="composeMachineFilename">
1621	<desc>
1622	Returns a recommended full path of the settings file name for a new virtual
1623	machine.
1624
1625	This API serves two purposes:
1626
1627	<ul>
1628	<li>It gets called by <link to="#createMachine" /> if @c null or
1629	empty string (which is recommended) is specified for the
1630	@a settingsFile argument there, which means that API should use
1631	a recommended default file name.</li>
1632
1633	<li>It can be called manually by a client software before creating a machine,
1634	e.g. if that client wants to pre-create the machine directory to create
1635	virtual hard disks in that directory together with the new machine
1636	settings file. In that case, the file name should be stripped from the
1637	full settings file path returned by this function to obtain the
1638	machine directory.</li>
1639	</ul>
1640
1641	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1642	details about the machine name.
1643
1644	@a groupName defines which additional subdirectory levels should be
1645	included. It must be either a valid group name or @c null or empty
1646	string which designates that the machine will not be related to a
1647	machine group.
1648
1649	If @a baseFolder is a @c null or empty string (which is recommended), the
1650	default machine settings folder
1651	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1652	a base folder for the created machine, resulting in a file name like
1653	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1654	will be used.
1655
1656	This method does not access the host disks. In particular, it does not check
1657	for whether a machine with this name already exists.
1658	</desc>
1659	<param name="name" type="wstring" dir="in">
1660	<desc>Suggested machine name.</desc>
1661	</param>
1662	<param name="group" type="wstring" dir="in">
1663	<desc>Machine group name for the new machine or machine group. It is
1664	used to determine the right subdirectory.</desc>
1665	</param>
1666	<param name="baseFolder" type="wstring" dir="in">
1667	<desc>Base machine folder (optional).</desc>
1668	</param>
1669	<param name="file" type="wstring" dir="return">
1670	<desc>Fully qualified path where the machine would be created.</desc>
1671	</param>
1672	</method>
1673
1674	<method name="createMachine">
1675	<desc>
1676	Creates a new virtual machine by creating a machine settings file at
1677	the given location.
1678
1679	VirtualBox machine settings files use a custom XML dialect. Starting
1680	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1681	and machine files can be created at arbitrary locations.
1682
1683	However, it is recommended that machines are created in the default
1684	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1685	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1686	@c null or empty string (which is recommended) for the @a settingsFile
1687	argument, <link to="#composeMachineFilename" /> is called automatically
1688	to have such a recommended name composed based on the machine name
1689	given in the @a name argument and the primary group.
1690
1691	If the resulting settings file already exists, this method will fail,
1692	unless @a forceOverwrite is set.
1693
1694	The new machine is created unregistered, with the initial configuration
1695	set according to the specified guest OS type. A typical sequence of
1696	actions to create a new virtual machine is as follows:
1697
1698	<ol>
1699	<li>
1700	Call this method to have a new machine created. The returned machine
1701	object will be "mutable" allowing to change any machine property.
1702	</li>
1703
1704	<li>
1705	Configure the machine using the appropriate attributes and methods.
1706	</li>
1707
1708	<li>
1709	Call <link to="IMachine::saveSettings" /> to write the settings
1710	to the machine's XML settings file. The configuration of the newly
1711	created machine will not be saved to disk until this method is
1712	called.
1713	</li>
1714
1715	<li>
1716	Call <link to="#registerMachine" /> to add the machine to the list
1717	of machines known to VirtualBox.
1718	</li>
1719	</ol>
1720
1721	The specified guest OS type identifier must match an ID of one of known
1722	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1723	array.
1724
1725	Optionally, you may specify an UUID of to assign to the created machine.
1726	However, this is not recommended and you should normally pass an empty
1727	(@c null) UUID to this method so that a new UUID will be automatically
1728	generated for every created machine. You can use UUID
1729	00000000-0000-0000-0000-000000000000 as @c null value.
1730
1731	<note>
1732	There is no way to change the name of the settings file or
1733	subfolder of the created machine directly.
1734	</note>
1735
1736	<result name="VBOX_E_OBJECT_NOT_FOUND">
1737	@a osTypeId is invalid.
1738	</result>
1739	<result name="VBOX_E_FILE_ERROR">
1740	Resulting settings file name is invalid or the settings file already
1741	exists or could not be created due to an I/O error.
1742	</result>
1743	<result name="E_INVALIDARG">
1744	@a name is empty or @c null.
1745	</result>
1746	</desc>
1747
1748	<param name="settingsFile" type="wstring" dir="in">
1749	<desc>Fully qualified path where the settings file should be created,
1750	empty string or @c null for a default folder and file based on the
1751	@a name argument and the primary group.
1752	(see <link to="#composeMachineFilename" />).</desc>
1753	</param>
1754	<param name="name" type="wstring" dir="in">
1755	<desc>Machine name.</desc>
1756	</param>
1757	<param name="groups" type="wstring" safearray="yes" dir="in">
1758	<desc>Array of group names. @c null or an empty array have the same
1759	meaning as an array with just the empty string or <tt>"/"</tt>, i.e.
1760	create a machine without group association.</desc>
1761	</param>
1762	<param name="osTypeId" type="wstring" dir="in">
1763	<desc>Guest OS Type ID.</desc>
1764	</param>
1765	<param name="id" type="uuid" mod="string" dir="in">
1766	<desc>Machine UUID (optional).</desc>
1767	</param>
1768	<param name="forceOverwrite" type="boolean" dir="in">
1769	<desc>If true, an existing machine settings file will be overwritten.</desc>
1770	</param>
1771	<param name="machine" type="IMachine" dir="return">
1772	<desc>Created machine object.</desc>
1773	</param>
1774	</method>
1775
1776	<method name="openMachine">
1777	<desc>
1778	Opens a virtual machine from the existing settings file.
1779	The opened machine remains unregistered until you call
1780	<link to="#registerMachine"/>.
1781
1782	The specified settings file name must be fully qualified.
1783	The file must exist and be a valid machine XML settings file
1784	whose contents will be used to construct the machine object.
1785
1786	<result name="VBOX_E_FILE_ERROR">
1787	Settings file name invalid, not found or sharing violation.
1788	</result>
1789	</desc>
1790	<param name="settingsFile" type="wstring" dir="in">
1791	<desc>
1792	Name of the machine settings file.
1793	</desc>
1794	</param>
1795	<param name="machine" type="IMachine" dir="return">
1796	<desc>Opened machine object.</desc>
1797	</param>
1798	<note>
1799	<link to="IMachine::settingsModified"/> will return
1800	@c false for the created machine, until any of machine settings
1801	are changed.
1802	</note>
1803	</method>
1804
1805	<method name="registerMachine">
1806	<desc>
1807
1808	Registers the machine previously created using
1809	<link to="#createMachine"/> or opened using
1810	<link to="#openMachine"/> within this VirtualBox installation. After
1811	successful method invocation, the
1812	<link to="IMachineRegisteredEvent"/> event is fired.
1813
1814	<note>
1815	This method implicitly calls <link to="IMachine::saveSettings"/>
1816	to save all current machine settings before registering it.
1817	</note>
1818
1819	<result name="VBOX_E_OBJECT_NOT_FOUND">
1820	No matching virtual machine found.
1821	</result>
1822	<result name="VBOX_E_INVALID_OBJECT_STATE">
1823	Virtual machine was not created within this VirtualBox instance.
1824	</result>
1825
1826	</desc>
1827	<param name="machine" type="IMachine" dir="in"/>
1828	</method>
1829
1830	<method name="findMachine">
1831	<desc>
1832	Attempts to find a virtual machine given its name or UUID.
1833
1834	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1835	cannot safely be determined.</note>
1836
1837	<result name="VBOX_E_OBJECT_NOT_FOUND">
1838	Could not find registered machine matching @a nameOrId.
1839	</result>
1840
1841	</desc>
1842	<param name="nameOrId" type="wstring" dir="in">
1843	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1844	</param>
1845	<param name="machine" type="IMachine" dir="return">
1846	<desc>Machine object, if found.</desc>
1847	</param>
1848	</method>
1849
1850	<method name="getMachinesByGroups">
1851	<desc>
1852	Gets all machine references which are in one of the specified groups.
1853	</desc>
1854	<param name="groups" type="wstring" dir="in" safearray="yes">
1855	<desc>What groups to match. The usual group list rules apply, i.e.
1856	passing an empty list will match VMs in the toplevel group, likewise
1857	the empty string.</desc>
1858	</param>
1859	<param name="machines" type="IMachine" dir="return" safearray="yes">
1860	<desc>All machines which matched.</desc>
1861	</param>
1862	</method>
1863
1864	<method name="getMachineStates">
1865	<desc>
1866	Gets the state of several machines in a single operation.
1867	</desc>
1868	<param name="machines" type="IMachine" dir="in" safearray="yes">
1869	<desc>Array with the machine references.</desc>
1870	</param>
1871	<param name="states" type="MachineState" dir="return" safearray="yes">
1872	<desc>Machine states, corresponding to the machines.</desc>
1873	</param>
1874	</method>
1875
1876	<method name="createAppliance">
1877	<desc>
1878	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1879	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1880	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1881	</desc>
1882	<param name="appliance" type="IAppliance" dir="return">
1883	<desc>New appliance.</desc>
1884	</param>
1885	</method>
1886
1887	<method name="createHardDisk">
1888	<desc>
1889	Creates a new base medium object that will use the given storage
1890	format and location for medium data.
1891
1892	The actual storage unit is not created by this method. In order to
1893	do it, and before you are able to attach the created medium to
1894	virtual machines, you must call one of the following methods to
1895	allocate a format-specific storage unit at the specified location:
1896	<ul>
1897	<li><link to="IMedium::createBaseStorage"/></li>
1898	<li><link to="IMedium::createDiffStorage"/></li>
1899	</ul>
1900
1901	Some medium attributes, such as <link to="IMedium::id"/>, may
1902	remain uninitialized until the medium storage unit is successfully
1903	created by one of the above methods.
1904
1905	After the storage unit is successfully created, it will be
1906	accessible through the <link to="#openMedium"/> method and can
1907	be found in the <link to="#hardDisks"/> array.
1908
1909	The list of all storage formats supported by this VirtualBox
1910	installation can be obtained using
1911	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1912	attribute is empty or @c null then the default storage format
1913	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1914	be used for creating a storage unit of the medium.
1915
1916	Note that the format of the location string is storage format specific.
1917	See <link to="IMedium::location"/> and IMedium for more details.
1918
1919	<result name="VBOX_E_OBJECT_NOT_FOUND">
1920	@a format identifier is invalid. See
1921	<link to="ISystemProperties::mediumFormats"/>.
1922	</result>
1923	<result name="VBOX_E_FILE_ERROR">
1924	@a location is a not valid file name (for file-based formats only).
1925	</result>
1926	</desc>
1927	<param name="format" type="wstring" dir="in">
1928	<desc>
1929	Identifier of the storage format to use for the new medium.
1930	</desc>
1931	</param>
1932	<param name="location" type="wstring" dir="in">
1933	<desc>
1934	Location of the storage unit for the new medium.
1935	</desc>
1936	</param>
1937	<param name="medium" type="IMedium" dir="return">
1938	<desc>Created medium object.</desc>
1939	</param>
1940	</method>
1941
1942	<method name="openMedium">
1943	<desc>
1944	Finds existing media or opens a medium from an existing storage location.
1945
1946	Once a medium has been opened, it can be passed to other VirtualBox
1947	methods, in particular to <link to="IMachine::attachDevice" />.
1948
1949	Depending on the given device type, the file at the storage location
1950	must be in one of the media formats understood by VirtualBox:
1951
1952	<ul>
1953	<li>With a "HardDisk" device type, the file must be a hard disk image
1954	in one of the formats supported by VirtualBox (see
1955	<link to="ISystemProperties::mediumFormats" />).
1956	After this method succeeds, if the medium is a base medium, it
1957	will be added to the <link to="#hardDisks"/> array attribute. </li>
1958	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1959	After this method succeeds, the medium will be added to the
1960	<link to="#DVDImages"/> array attribute.</li>
1961	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1962	After this method succeeds, the medium will be added to the
1963	<link to="#floppyImages"/> array attribute.</li>
1964	</ul>
1965
1966	After having been opened, the medium can be re-found by this method
1967	and can be attached to virtual machines. See <link to="IMedium" /> for
1968	more details.
1969
1970	The UUID of the newly opened medium will either be retrieved from the
1971	storage location, if the format supports it (e.g. for hard disk images),
1972	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1973	If for some reason you need to change the medium's UUID, use
1974	<link to="IMedium::setIds" />.
1975
1976	If a differencing hard disk medium is to be opened by this method, the
1977	operation will succeed only if its parent medium and all ancestors,
1978	if any, are already known to this VirtualBox installation (for example,
1979	were opened by this method before).
1980
1981	This method attempts to guess the storage format of the specified medium
1982	by reading medium data at the specified location.
1983
1984	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1985	the image is opened for read/write access and must have according permissions,
1986	as VirtualBox may actually write status information into the disk's metadata
1987	sections.
1988
1989	Note that write access is required for all typical hard disk usage in VirtualBox,
1990	since VirtualBox may need to write metadata such as a UUID into the image.
1991	The only exception is opening a source image temporarily for copying and
1992	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1993	again soon.
1994
1995	The format of the location string is storage format specific. See
1996	<link to="IMedium::location"/> and IMedium for more details.
1997
1998	<result name="VBOX_E_FILE_ERROR">
1999	Invalid medium storage file location or could not find the medium
2000	at the specified location.
2001	</result>
2002	<result name="VBOX_E_IPRT_ERROR">
2003	Could not get medium storage format.
2004	</result>
2005	<result name="E_INVALIDARG">
2006	Invalid medium storage format.
2007	</result>
2008	<result name="VBOX_E_INVALID_OBJECT_STATE">
2009	Medium has already been added to a media registry.
2010	</result>
2011	</desc>
2012	<param name="location" type="wstring" dir="in">
2013	<desc>
2014	Location of the storage unit that contains medium data in one of
2015	the supported storage formats.
2016	</desc>
2017	</param>
2018	<param name="deviceType" type="DeviceType" dir="in">
2019	<desc>
2020	Must be one of "HardDisk", "DVD" or "Floppy".
2021	</desc>
2022	</param>
2023	<param name="accessMode" type="AccessMode" dir="in">
2024	<desc>Whether to open the image in read/write or read-only mode. For
2025	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
2026	</param>
2027	<param name="forceNewUuid" type="boolean" dir="in">
2028	<desc>Allows the caller to request a completely new medium UUID for
2029	the image which is to be opened. Useful if one intends to open an exact
2030	copy of a previously opened image, as this would normally fail due to
2031	the duplicate UUID.</desc>
2032	</param>
2033	<param name="medium" type="IMedium" dir="return">
2034	<desc>Opened medium object.</desc>
2035	</param>
2036	</method>
2037
2038	<method name="getGuestOSType">
2039	<desc>
2040	Returns an object describing the specified guest OS type.
2041
2042	The requested guest OS type is specified using a string which is a
2043	mnemonic identifier of the guest operating system, such as
2044	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2045	particular virtual machine can be read or set using the
2046	<link to="IMachine::OSTypeId"/> attribute.
2047
2048	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2049	available guest OS type objects. Each object has an
2050	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2051	the guest OS this object describes.
2052
2053	<result name="E_INVALIDARG">
2054	@a id is not a valid Guest OS type.
2055	</result>
2056
2057	</desc>
2058	<param name="id" type="uuid" mod="string" dir="in">
2059	<desc>Guest OS type ID string.</desc>
2060	</param>
2061	<param name="type" type="IGuestOSType" dir="return">
2062	<desc>Guest OS type object.</desc>
2063	</param>
2064	</method>
2065
2066	<method name="createSharedFolder">
2067	<desc>
2068	Creates a new global shared folder by associating the given logical
2069	name with the given host path, adds it to the collection of shared
2070	folders and starts sharing it. Refer to the description of
2071	<link to="ISharedFolder"/> to read more about logical names.
2072	<note>
2073	In the current implementation, this operation is not
2074	implemented.
2075	</note>
2076	</desc>
2077	<param name="name" type="wstring" dir="in">
2078	<desc>Unique logical name of the shared folder.</desc>
2079	</param>
2080	<param name="hostPath" type="wstring" dir="in">
2081	<desc>Full path to the shared folder in the host file system.</desc>
2082	</param>
2083	<param name="writable" type="boolean" dir="in">
2084	<desc>Whether the share is writable or readonly</desc>
2085	</param>
2086	<param name="automount" type="boolean" dir="in">
2087	<desc>Whether the share gets automatically mounted by the guest
2088	or not.</desc>
2089	</param>
2090	</method>
2091
2092	<method name="removeSharedFolder">
2093	<desc>
2094	Removes the global shared folder with the given name previously
2095	created by <link to="#createSharedFolder"/> from the collection of
2096	shared folders and stops sharing it.
2097	<note>
2098	In the current implementation, this operation is not
2099	implemented.
2100	</note>
2101	</desc>
2102	<param name="name" type="wstring" dir="in">
2103	<desc>Logical name of the shared folder to remove.</desc>
2104	</param>
2105	</method>
2106
2107	<method name="getExtraDataKeys">
2108	<desc>
2109	Returns an array representing the global extra data keys which currently
2110	have values defined.
2111	</desc>
2112	<param name="value" type="wstring" dir="return" safearray="yes">
2113	<desc>Array of extra data keys.</desc>
2114	</param>
2115	</method>
2116
2117	<method name="getExtraData">
2118	<desc>
2119	Returns associated global extra data.
2120
2121	If the requested data @a key does not exist, this function will
2122	succeed and return an empty string in the @a value argument.
2123
2124	<result name="VBOX_E_FILE_ERROR">
2125	Settings file not accessible.
2126	</result>
2127	<result name="VBOX_E_XML_ERROR">
2128	Could not parse the settings file.
2129	</result>
2130
2131	</desc>
2132	<param name="key" type="wstring" dir="in">
2133	<desc>Name of the data key to get.</desc>
2134	</param>
2135	<param name="value" type="wstring" dir="return">
2136	<desc>Value of the requested data key.</desc>
2137	</param>
2138	</method>
2139
2140	<method name="setExtraData">
2141	<desc>
2142	Sets associated global extra data.
2143
2144	If you pass @c null or empty string as a key @a value, the given @a key
2145	will be deleted.
2146
2147	<note>
2148	Before performing the actual data change, this method will ask all
2149	registered event listener using the
2150	<link to="IExtraDataCanChangeEvent"/>
2151	notification for a permission. If one of the listeners refuses the
2152	new value, the change will not be performed.
2153	</note>
2154	<note>
2155	On success, the
2156	<link to="IExtraDataChangedEvent"/> notification
2157	is called to inform all registered listeners about a successful data
2158	change.
2159	</note>
2160
2161	<result name="VBOX_E_FILE_ERROR">
2162	Settings file not accessible.
2163	</result>
2164	<result name="VBOX_E_XML_ERROR">
2165	Could not parse the settings file.
2166	</result>
2167	<result name="E_ACCESSDENIED">
2168	Modification request refused.
2169	</result>
2170
2171	</desc>
2172	<param name="key" type="wstring" dir="in">
2173	<desc>Name of the data key to set.</desc>
2174	</param>
2175	<param name="value" type="wstring" dir="in">
2176	<desc>Value to assign to the key.</desc>
2177	</param>
2178	</method>
2179
2180	<method name="setSettingsSecret">
2181	<desc>
2182	Unlocks the secret data by passing the unlock password to the
2183	server. The server will cache the password for that machine.
2184
2185	<result name="VBOX_E_INVALID_VM_STATE">
2186	Virtual machine is not mutable.
2187	</result>
2188
2189	</desc>
2190	<param name="password" type="wstring" dir="in">
2191	<desc>
2192	The cipher key.
2193	</desc>
2194	</param>
2195	</method>
2196
2197	<!--method name="createDHCPServerForInterface">
2198	<desc>
2199	Creates a DHCP server settings to be used for the given interface
2200	<result name="E_INVALIDARG">
2201	Host network interface @a name already exists.
2202	</result>
2203	</desc>
2204	<param name="interface" type="IHostNetworkInterface" dir="in">
2205	<desc>Network Interface</desc>
2206	</param>
2207	<param name="server" type="IDHCPServer" dir="out">
2208	<desc>DHCP server settings</desc>
2209	</param>
2210	</method-->
2211
2212	<method name="createDHCPServer">
2213	<desc>
2214	Creates a DHCP server settings to be used for the given internal network name
2215	<result name="E_INVALIDARG">
2216	Host network interface @a name already exists.
2217	</result>
2218	</desc>
2219	<param name="name" type="wstring" dir="in">
2220	<desc>server name</desc>
2221	</param>
2222	<param name="server" type="IDHCPServer" dir="return">
2223	<desc>DHCP server settings</desc>
2224	</param>
2225	</method>
2226
2227	<method name="findDHCPServerByNetworkName">
2228	<desc>
2229	Searches a DHCP server settings to be used for the given internal network name
2230	<result name="E_INVALIDARG">
2231	Host network interface @a name already exists.
2232	</result>
2233
2234	</desc>
2235	<param name="name" type="wstring" dir="in">
2236	<desc>server name</desc>
2237	</param>
2238	<param name="server" type="IDHCPServer" dir="return">
2239	<desc>DHCP server settings</desc>
2240	</param>
2241	</method>
2242
2243	<!--method name="findDHCPServerForInterface">
2244	<desc>
2245	Searches a DHCP server settings to be used for the given interface
2246	<result name="E_INVALIDARG">
2247	Host network interface @a name already exists.
2248	</result>
2249	</desc>
2250	<param name="interface" type="IHostNetworkInterface" dir="in">
2251	<desc>Network Interface</desc>
2252	</param>
2253	<param name="server" type="IDHCPServer" dir="out">
2254	<desc>DHCP server settings</desc>
2255	</param>
2256	</method-->
2257
2258	<method name="removeDHCPServer">
2259	<desc>
2260	Removes the DHCP server settings
2261	<result name="E_INVALIDARG">
2262	Host network interface @a name already exists.
2263	</result>
2264	</desc>
2265	<param name="server" type="IDHCPServer" dir="in">
2266	<desc>DHCP server settings to be removed</desc>
2267	</param>
2268	</method>
2269
2270
2271	<method name="checkFirmwarePresent">
2272	<desc>
2273	Check if this VirtualBox installation has a firmware
2274	of the given type available, either system-wide or per-user.
2275	Optionally, this may return a hint where this firmware can be
2276	downloaded from.
2277	</desc>
2278	<param name="firmwareType" type="FirmwareType" dir="in">
2279	<desc>
2280	Type of firmware to check.
2281	</desc>
2282	</param>
2283	<param name="version" type="wstring" dir="in">
2284	<desc>Expected version number, usually empty string (presently ignored).</desc>
2285	</param>
2286
2287	<param name="url" type="wstring" dir="out">
2288	<desc>
2289	Suggested URL to download this firmware from.
2290	</desc>
2291	</param>
2292
2293	<param name="file" type="wstring" dir="out">
2294	<desc>
2295	Filename of firmware, only valid if result == TRUE.
2296	</desc>
2297	</param>
2298
2299	<param name="result" type="boolean" dir="return">
2300	<desc>If firmware of this type and version is available.</desc>
2301	</param>
2302	</method>
2303
2304	</interface>
2305
2306	<!--
2307	// IVFSExplorer
2308	/////////////////////////////////////////////////////////////////////////
2309	-->
2310
2311	<enum
2312	name="VFSType"
2313	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2314	>
2315	<desc>
2316	Virtual file systems supported by VFSExplorer.
2317	</desc>
2318
2319	<const name="File" value="1" />
2320	<const name="Cloud" value="2" />
2321	<const name="S3" value="3" />
2322	<const name="WebDav" value="4" />
2323	</enum>
2324
2325	<enum
2326	name="VFSFileType"
2327	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2328	>
2329	<desc>
2330	File types known by VFSExplorer.
2331	</desc>
2332
2333	<const name="Unknown" value="1" />
2334	<const name="Fifo" value="2" />
2335	<const name="DevChar" value="3" />
2336	<const name="Directory" value="4" />
2337	<const name="DevBlock" value="5" />
2338	<const name="File" value="6" />
2339	<const name="SymLink" value="7" />
2340	<const name="Socket" value="8" />
2341	<const name="WhiteOut" value="9" />
2342	</enum>
2343
2344	<interface
2345	name="IVFSExplorer" extends="$unknown"
2346	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2347	wsmap="managed"
2348	>
2349	<desc>
2350	The VFSExplorer interface unifies access to different file system
2351	types. This includes local file systems as well remote file systems like
2352	S3. For a list of supported types see <link to="VFSType" />.
2353	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2354	</desc>
2355
2356	<attribute name="path" type="wstring" readonly="yes">
2357	<desc>Returns the current path in the virtual file system.</desc>
2358	</attribute>
2359
2360	<attribute name="type" type="VFSType" readonly="yes">
2361	<desc>Returns the file system type which is currently in use.</desc>
2362	</attribute>
2363
2364	<method name="update">
2365	<desc>Updates the internal list of files/directories from the
2366	current directory level. Use <link to="#entryList" /> to get the full list
2367	after a call to this method.</desc>
2368
2369	<param name="aProgress" type="IProgress" dir="return">
2370	<desc>Progress object to track the operation completion.</desc>
2371	</param>
2372	</method>
2373
2374	<method name="cd">
2375	<desc>Change the current directory level.</desc>
2376
2377	<param name="aDir" type="wstring" dir="in">
2378	<desc>The name of the directory to go in.</desc>
2379	</param>
2380
2381	<param name="aProgress" type="IProgress" dir="return">
2382	<desc>Progress object to track the operation completion.</desc>
2383	</param>
2384	</method>
2385
2386	<method name="cdUp">
2387	<desc>Go one directory upwards from the current directory level.</desc>
2388
2389	<param name="aProgress" type="IProgress" dir="return">
2390	<desc>Progress object to track the operation completion.</desc>
2391	</param>
2392	</method>
2393
2394	<method name="entryList">
2395	<desc>Returns a list of files/directories after a call to <link
2396	to="#update" />. The user is responsible for keeping this internal
2397	list up do date.</desc>
2398
2399	<param name="aNames" type="wstring" safearray="yes" dir="out">
2400	<desc>The list of names for the entries.</desc>
2401	</param>
2402
2403	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2404	<desc>The list of types for the entries.</desc>
2405	</param>
2406
2407	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2408	<desc>The list of sizes (in bytes) for the entries.</desc>
2409	</param>
2410
2411	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2412	<desc>The list of file modes (in octal form) for the entries.</desc>
2413	</param>
2414	</method>
2415
2416	<method name="exists">
2417	<desc>Checks if the given file list exists in the current directory
2418	level.</desc>
2419
2420	<param name="aNames" type="wstring" safearray="yes" dir="in">
2421	<desc>The names to check.</desc>
2422	</param>
2423
2424	<param name="aExists" type="wstring" safearray="yes" dir="return">
2425	<desc>The names which exist.</desc>
2426	</param>
2427	</method>
2428
2429	<method name="remove">
2430	<desc>Deletes the given files in the current directory level.</desc>
2431
2432	<param name="aNames" type="wstring" safearray="yes" dir="in">
2433	<desc>The names to remove.</desc>
2434	</param>
2435
2436	<param name="aProgress" type="IProgress" dir="return">
2437	<desc>Progress object to track the operation completion.</desc>
2438	</param>
2439	</method>
2440
2441	</interface>
2442
2443	<enum
2444	name="ImportOptions" extends="$unknown"
2445	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2446	>
2447
2448	<desc>
2449	Import options, used with <link to="IAppliance::importMachines" />.
2450	</desc>
2451
2452	<const name="KeepAllMACs" value="1">
2453	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2454	</const>
2455	<const name="KeepNATMACs" value="2">
2456	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2457	</const>
2458
2459	</enum>
2460
2461
2462	<!--
2463	// IAppliance
2464	/////////////////////////////////////////////////////////////////////////
2465	-->
2466
2467	<interface
2468	name="IAppliance" extends="$unknown"
2469	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2470	wsmap="managed"
2471	>
2472	<desc>
2473	Represents a platform-independent appliance in OVF format. An instance of this is returned
2474	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2475	virtual machines within an appliance with VirtualBox.
2476
2477	The OVF standard suggests two different physical file formats:
2478
2479	<ol>
2480	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2481	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2482	this descriptor file references other files such as disk images, as OVF appliances typically
2483	do, those additional files must be in the same directory as the descriptor file.</li>
2484
2485	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2486	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2487	files and optionally other files.
2488
2489	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2490	be added with a later version.</li>
2491	</ol>
2492
2493	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2494	<link to="IMachine" /> involves the following sequence of API calls:
2495
2496	<ol>
2497	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2498	</li>
2499
2500	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2501	would like to import. So long as this file is syntactically valid, this will succeed
2502	and fill the appliance object with the parsed data from the OVF file.
2503	</li>
2504
2505	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2506	contents of the IAppliance attributes accordingly. These can be inspected by a
2507	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2508	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2509	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2510	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2511	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2512	The GUI can then give the user the option to confirm and/or change these suggestions.
2513	</li>
2514
2515	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2516	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2517	</li>
2518
2519	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2520	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2521	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2522	can be found in the <link to="#machines" /> array attribute.
2523	</li>
2524	</ol>
2525
2526	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2527
2528	<ol>
2529	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2530	an empty IAppliance object.
2531	</li>
2532
2533	<li>For each machine you would like to export, call <link to="IMachine::export" />
2534	with the IAppliance object you just created. Each such call creates one instance of
2535	<link to="IVirtualSystemDescription" /> inside the appliance.
2536	</li>
2537
2538	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2539	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2540	</li>
2541
2542	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2543	file written.</li>
2544	</ol>
2545
2546	</desc>
2547
2548	<attribute name="path" type="wstring" readonly="yes">
2549	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2550	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2551	<link to="#write" /> (for export).
2552	This attribute is empty until one of these methods has been called.
2553	</desc>
2554	</attribute>
2555
2556	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2557	<desc>
2558	Array of virtual disk definitions. One such description exists for each
2559	disk definition in the OVF; each string array item represents one such piece of
2560	disk information, with the information fields separated by tab (\\t) characters.
2561
2562	The caller should be prepared for additional fields being appended to
2563	this string in future versions of VirtualBox and therefore check for
2564	the number of tabs in the strings returned.
2565
2566	In the current version, the following eight fields are returned per string
2567	in the array:
2568
2569	<ol>
2570	<li>Disk ID (unique string identifier given to disk)</li>
2571
2572	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2573
2574	<li>Populated size (optional unsigned integer indicating the current size of the
2575	disk; can be approximate; -1 if unspecified)</li>
2576
2577	<li>Format (string identifying the disk format, typically
2578	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2579
2580	<li>Reference (where to find the disk image, typically a file name; if empty,
2581	then the disk should be created on import)</li>
2582
2583	<li>Image size (optional unsigned integer indicating the size of the image,
2584	which need not necessarily be the same as the values specified above, since
2585	the image may be compressed or sparse; -1 if not specified)</li>
2586
2587	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2588	presently unsupported and always -1)</li>
2589
2590	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2591	</ol>
2592	</desc>
2593	</attribute>
2594
2595	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2596	<desc> Array of virtual system descriptions. One such description is created
2597	for each virtual system (machine) found in the OVF.
2598	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2599	(for export) has been called.
2600	</desc>
2601	</attribute>
2602
2603	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2604	<desc>
2605	Contains the UUIDs of the machines created from the information in this appliances. This is only
2606	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2607	succeeded.
2608	</desc>
2609	</attribute>
2610
2611	<method name="read">
2612	<desc>
2613	Reads an OVF file into the appliance object.
2614
2615	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2616	mere fact that this method returns successfully does not mean that VirtualBox supports all
2617	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2618	</desc>
2619	<param name="file" type="wstring" dir="in">
2620	<desc>
2621	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2622	on whether the appliance is distributed as a set of files or as a single file, respectively).
2623	</desc>
2624	</param>
2625	<param name="aProgress" type="IProgress" dir="return">
2626	<desc>Progress object to track the operation completion.</desc>
2627	</param>
2628	</method>
2629
2630	<method name="interpret">
2631	<desc>
2632	Interprets the OVF data that was read when the appliance was constructed. After
2633	calling this method, one can inspect the
2634	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2635	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2636	the appliance.
2637
2638	Calling this method is the second step of importing an appliance into VirtualBox;
2639	see <link to="IAppliance" /> for an overview.
2640
2641	After calling this method, one should call <link to="#getWarnings" /> to find out
2642	if problems were encountered during the processing which might later lead to
2643	errors.
2644	</desc>
2645	</method>
2646
2647	<method name="importMachines">
2648	<desc>
2649	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2650	and other interfaces that match the information contained in the appliance as
2651	closely as possible, as represented by the import instructions in the
2652	<link to="#virtualSystemDescriptions" /> array.
2653
2654	Calling this method is the final step of importing an appliance into VirtualBox;
2655	see <link to="IAppliance" /> for an overview.
2656
2657	Since importing the appliance will most probably involve copying and converting
2658	disk images, which can take a long time, this method operates asynchronously and
2659	returns an IProgress object to allow the caller to monitor the progress.
2660
2661	After the import succeeded, the UUIDs of the IMachine instances created can be
2662	retrieved from the <link to="#machines" /> array attribute.
2663	</desc>
2664
2665	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2666	<desc>Options for the importing operation.</desc>
2667	</param>
2668
2669	<param name="aProgress" type="IProgress" dir="return">
2670	<desc>Progress object to track the operation completion.</desc>
2671	</param>
2672	</method>
2673
2674	<method name="createVFSExplorer">
2675	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2676
2677	<param name="aUri" type="wstring" dir="in">
2678	<desc>The URI describing the file system to use.</desc>
2679	</param>
2680
2681	<param name="aExplorer" type="IVFSExplorer" dir="return">
2682	<desc></desc>
2683	</param>
2684	</method>
2685
2686	<method name="write">
2687	<desc>
2688	Writes the contents of the appliance exports into a new OVF file.
2689
2690	Calling this method is the final step of exporting an appliance from VirtualBox;
2691	see <link to="IAppliance" /> for an overview.
2692
2693	Since exporting the appliance will most probably involve copying and converting
2694	disk images, which can take a long time, this method operates asynchronously and
2695	returns an IProgress object to allow the caller to monitor the progress.
2696	</desc>
2697	<param name="format" type="wstring" dir="in">
2698	<desc>
2699	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2700	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2701	</desc>
2702	</param>
2703	<param name="manifest" type="boolean" dir="in">
2704	<desc>
2705	Indicate if the optional manifest file (.mf) should be written. The manifest file
2706	is used for integrity checks prior import.
2707	</desc>
2708	</param>
2709	<param name="path" type="wstring" dir="in">
2710	<desc>
2711	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2712	on whether the appliance is distributed as a set of files or as a single file, respectively).
2713	</desc>
2714	</param>
2715	<param name="progress" type="IProgress" dir="return">
2716	<desc>Progress object to track the operation completion.</desc>
2717	</param>
2718	</method>
2719
2720	<method name="getWarnings">
2721	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2722
2723	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2724	<desc></desc>
2725	</param>
2726	</method>
2727
2728	</interface>
2729
2730	<enum
2731	name="VirtualSystemDescriptionType"
2732	uuid="303c0900-a746-4612-8c67-79003e91f459"
2733	>
2734	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2735	a configuration value.</desc>
2736
2737	<const name="Ignore" value="1" />
2738	<const name="OS" value="2" />
2739	<const name="Name" value="3" />
2740	<const name="Product" value="4" />
2741	<const name="Vendor" value="5" />
2742	<const name="Version" value="6" />
2743	<const name="ProductUrl" value="7" />
2744	<const name="VendorUrl" value="8" />
2745	<const name="Description" value="9" />
2746	<const name="License" value="10" />
2747	<const name="Miscellaneous" value="11" />
2748	<const name="CPU" value="12" />
2749	<const name="Memory" value="13" />
2750	<const name="HardDiskControllerIDE" value="14" />
2751	<const name="HardDiskControllerSATA" value="15" />
2752	<const name="HardDiskControllerSCSI" value="16" />
2753	<const name="HardDiskControllerSAS" value="17" />
2754	<const name="HardDiskImage" value="18" />
2755	<const name="Floppy" value="19" />
2756	<const name="CDROM" value="20" />
2757	<const name="NetworkAdapter" value="21" />
2758	<const name="USBController" value="22" />
2759	<const name="SoundCard" value="23" />
2760	<const name="SettingsFile" value="24">
2761	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2762	</const>
2763	</enum>
2764
2765	<enum
2766	name="VirtualSystemDescriptionValueType"
2767	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2768	>
2769	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2770	type to fetch.</desc>
2771
2772	<const name="Reference" value="1" />
2773	<const name="Original" value="2" />
2774	<const name="Auto" value="3" />
2775	<const name="ExtraConfig" value="4" />
2776
2777	</enum>
2778
2779	<interface
2780	name="IVirtualSystemDescription" extends="$unknown"
2781	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2782	wsmap="managed"
2783	>
2784
2785	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2786	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2787	<link to="IAppliance::interpret" /> has been called, that array contains information
2788	about how the virtual systems described in the OVF should best be imported into
2789	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2790	import an OVF into VirtualBox.
2791	</desc>
2792
2793	<attribute name="count" type="unsigned long" readonly="yes">
2794	<desc>Return the number of virtual system description entries.</desc>
2795	</attribute>
2796
2797	<method name="getDescription">
2798	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2799	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2800
2801	The list below identifies the value sets that are possible depending on the
2802	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2803	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2804	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2805	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2806	the @a aExtraConfigValues[] array item may also be used.
2807
2808	<ul>
2809	<li>
2810	"OS": the guest operating system type. There must be exactly one such array item on import. The
2811	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2812	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2813	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2814	</li>
2815	<li>
2816	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2817	if none is present on import, then an automatic name will be created from the operating system
2818	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2819	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2820	<link to="IMachine" /> name that does not exist yet.
2821	</li>
2822	<li>
2823	"Description": an arbitrary description.
2824	</li>
2825	<li>
2826	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2827	code to display such a license for agreement; the Main API does not enforce any such policy.
2828	</li>
2829	<li>
2830	Miscellaneous: reserved for future use.
2831	</li>
2832	<li>
2833	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2834	</li>
2835	<li>
2836	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2837	is present on import, then VirtualBox will set a meaningful default based on the operating system
2838	type.
2839	</li>
2840	<li>
2841	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2842	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2843	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2844	writes into the OVF.
2845	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2846	type can use to specify which hard disk controller a virtual disk should be connected to.
2847	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2848	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2849	its virtual machines supports four channels (primary master, primary slave, secondary master,
2850	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2851	</li>
2852	<li>
2853	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2854	has no value in @a aOvfValues[] or @a aVBoxValues[].
2855	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2856	</li>
2857	<li>
2858	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2859	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2860	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2861	whereas VirtualBox considers it a class of storage controllers of its own; see
2862	<link to="StorageControllerType" />).
2863	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2864	</li>
2865	<li>
2866	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2867	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2868
2869	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2870	a path since the image file should be in the same location as the OVF file itself), whereas the
2871	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2872	hard disk image. This means that on import the image will be copied and converted from the
2873	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2874
2875	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2876	format: "controller=<index>;channel=<c>"
2877	In this string, <index> must be an integer specifying the hard disk controller to connect
2878	the image to. That number must be the index of an array item with one of the hard disk controller
2879	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2880	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2881	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2882	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2883	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2884	</li>
2885	<li>
2886	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2887	attachment information as with "HardDiskImage" items.
2888	</li>
2889	<li>
2890	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2891	attachment information as with "HardDiskImage" items.
2892	</li>
2893	<li>
2894	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2895	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2896	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2897	</li>
2898	<li>
2899	"USBController": a USB controller. There can be at most one such item. If and only if such an
2900	item ispresent, USB support will be enabled for the new virtual machine.
2901	</li>
2902	<li>
2903	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2904	present, sound support will be enabled for the new virtual machine. Note that the virtual
2905	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2906	may be different from the virtual soundcard expected by the appliance.
2907	</li>
2908	</ul>
2909
2910	</desc>
2911
2912	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2913	<desc></desc>
2914	</param>
2915
2916	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2917	<desc></desc>
2918	</param>
2919
2920	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2921	<desc></desc>
2922	</param>
2923
2924	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2925	<desc></desc>
2926	</param>
2927
2928	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2929	<desc></desc>
2930	</param>
2931
2932	</method>
2933
2934	<method name="getDescriptionByType">
2935	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2936	should be returned.</desc>
2937
2938	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2939	<desc></desc>
2940	</param>
2941
2942	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2943	<desc></desc>
2944	</param>
2945
2946	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2947	<desc></desc>
2948	</param>
2949
2950	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2951	<desc></desc>
2952	</param>
2953
2954	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2955	<desc></desc>
2956	</param>
2957
2958	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2959	<desc></desc>
2960	</param>
2961
2962	</method>
2963
2964	<method name="getValuesByType">
2965	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2966	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2967	values.</desc>
2968
2969	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2970	<desc></desc>
2971	</param>
2972
2973	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2974	<desc></desc>
2975	</param>
2976
2977	<param name="aValues" type="wstring" dir="return" safearray="yes">
2978	<desc></desc>
2979	</param>
2980
2981	</method>
2982
2983	<method name="setFinalValues">
2984	<desc>
2985	This method allows the appliance's user to change the configuration for the virtual
2986	system descriptions. For each array item returned from <link to="#getDescription" />,
2987	you must pass in one boolean value and one configuration value.
2988
2989	Each item in the boolean array determines whether the particular configuration item
2990	should be enabled.
2991	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2992	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2993	and SoundCard.
2994
2995	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2996	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2997	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2998	for valid configuration values for the individual array item types. If the
2999	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3000	</desc>
3001
3002	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3003	<desc></desc>
3004	</param>
3005
3006	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3007	<desc></desc>
3008	</param>
3009
3010	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3011	<desc></desc>
3012	</param>
3013	</method>
3014
3015	<method name="addDescription">
3016	<desc>
3017	This method adds an additional description entry to the stack of already
3018	available descriptions for this virtual system. This is handy for writing
3019	values which aren't directly supported by VirtualBox. One example would
3020	be the License type of <link to="VirtualSystemDescriptionType" />.
3021	</desc>
3022
3023	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3024	<desc></desc>
3025	</param>
3026
3027	<param name="aVBoxValue" type="wstring" dir="in">
3028	<desc></desc>
3029	</param>
3030
3031	<param name="aExtraConfigValue" type="wstring" dir="in">
3032	<desc></desc>
3033	</param>
3034	</method>
3035	</interface>
3036
3037
3038	<!--
3039	// IMachine
3040	/////////////////////////////////////////////////////////////////////////
3041	-->
3042
3043	<interface
3044	name="IInternalMachineControl" extends="$unknown"
3045	uuid="ec824977-e43f-479c-81c9-ac6cae1423a5"
3046	internal="yes"
3047	wsmap="suppress"
3048	>
3049	<method name="setRemoveSavedStateFile">
3050	<desc>
3051	Updates the flag whether the saved state file is removed on a
3052	machine state change from Saved to PoweredOff.
3053	</desc>
3054	<param name="aRemove" type="boolean" dir="in"/>
3055	</method>
3056
3057	<method name="updateState">
3058	<desc>
3059	Updates the VM state.
3060	<note>
3061	This operation will also update the settings file with the correct
3062	information about the saved state file and delete this file from disk
3063	when appropriate.
3064	</note>
3065	</desc>
3066	<param name="state" type="MachineState" dir="in"/>
3067	</method>
3068
3069	<method name="getIPCId">
3070	<param name="id" type="wstring" dir="return"/>
3071	</method>
3072
3073	<method name="beginPowerUp">
3074	<desc>
3075	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3076	gives it the progress object that should be part of any pending
3077	<link to="IMachine::launchVMProcess"/> operations. The progress
3078	object may be called back to reflect an early cancelation, so some care
3079	have to be taken with respect to any cancelation callbacks. The console
3080	object will call <link to="IInternalMachineControl::endPowerUp"/>
3081	to signal the completion of the progress object.
3082	</desc>
3083	<param name="aProgress" type="IProgress" dir="in" />
3084	</method>
3085
3086	<method name="endPowerUp">
3087	<desc>
3088	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3089	This method may query status information from the progress object it
3090	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3091	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3092	call in order to complete that progress object.
3093	</desc>
3094	<param name="result" type="long" dir="in"/>
3095	</method>
3096
3097	<method name="beginPoweringDown">
3098	<desc>
3099	Called by the VM process to inform the server it wants to
3100	stop the VM execution and power down.
3101	</desc>
3102	<param name="progress" type="IProgress" dir="out">
3103	<desc>
3104	Progress object created by VBoxSVC to wait until
3105	the VM is powered down.
3106	</desc>
3107	</param>
3108	</method>
3109
3110	<method name="endPoweringDown">
3111	<desc>
3112	Called by the VM process to inform the server that powering
3113	down previously requested by #beginPoweringDown is either
3114	successfully finished or there was a failure.
3115
3116	<result name="VBOX_E_FILE_ERROR">
3117	Settings file not accessible.
3118	</result>
3119	<result name="VBOX_E_XML_ERROR">
3120	Could not parse the settings file.
3121	</result>
3122
3123	</desc>
3124
3125	<param name="result" type="long" dir="in">
3126	<desc>@c S_OK to indicate success.
3127	</desc>
3128	</param>
3129	<param name="errMsg" type="wstring" dir="in">
3130	<desc>@c human readable error message in case of failure.
3131	</desc>
3132	</param>
3133	</method>
3134
3135	<method name="runUSBDeviceFilters">
3136	<desc>
3137	Asks the server to run USB devices filters of the associated
3138	machine against the given USB device and tell if there is
3139	a match.
3140	<note>
3141	Intended to be used only for remote USB devices. Local
3142	ones don't require to call this method (this is done
3143	implicitly by the Host and USBProxyService).
3144	</note>
3145	</desc>
3146	<param name="device" type="IUSBDevice" dir="in"/>
3147	<param name="matched" type="boolean" dir="out"/>
3148	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3149	</method>
3150
3151	<method name="captureUSBDevice">
3152	<desc>
3153	Requests a capture of the given host USB device.
3154	When the request is completed, the VM process will
3155	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3156	notification.
3157	</desc>
3158	<param name="id" type="uuid" mod="string" dir="in"/>
3159	</method>
3160
3161	<method name="detachUSBDevice">
3162	<desc>
3163	Notification that a VM is going to detach (@a done = @c false) or has
3164	already detached (@a done = @c true) the given USB device.
3165	When the @a done = @c true request is completed, the VM process will
3166	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3167	notification.
3168	<note>
3169	In the @a done = @c true case, the server must run its own filters
3170	and filters of all VMs but this one on the detached device
3171	as if it were just attached to the host computer.
3172	</note>
3173	</desc>
3174	<param name="id" type="uuid" mod="string" dir="in"/>
3175	<param name="done" type="boolean" dir="in"/>
3176	</method>
3177
3178	<method name="autoCaptureUSBDevices">
3179	<desc>
3180	Requests a capture all matching USB devices attached to the host.
3181	When the request is completed, the VM process will
3182	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3183	notification per every captured device.
3184	</desc>
3185	</method>
3186
3187	<method name="detachAllUSBDevices">
3188	<desc>
3189	Notification that a VM that is being powered down. The done
3190	parameter indicates whether which stage of the power down
3191	we're at. When @a done = @c false the VM is announcing its
3192	intentions, while when @a done = @c true the VM is reporting
3193	what it has done.
3194	<note>
3195	In the @a done = @c true case, the server must run its own filters
3196	and filters of all VMs but this one on all detach devices as
3197	if they were just attached to the host computer.
3198	</note>
3199	</desc>
3200	<param name="done" type="boolean" dir="in"/>
3201	</method>
3202
3203	<method name="onSessionEnd">
3204	<desc>
3205	Triggered by the given session object when the session is about
3206	to close normally.
3207	</desc>
3208	<param name="session" type="ISession" dir="in">
3209	<desc>Session that is being closed</desc>
3210	</param>
3211	<param name="progress" type="IProgress" dir="return">
3212	<desc>
3213	Used to wait until the corresponding machine is actually
3214	dissociated from the given session on the server.
3215	Returned only when this session is a direct one.
3216	</desc>
3217	</param>
3218	</method>
3219
3220	<method name="beginSavingState">
3221	<desc>
3222	Called by the VM process to inform the server it wants to
3223	save the current state and stop the VM execution.
3224	</desc>
3225	<param name="progress" type="IProgress" dir="out">
3226	<desc>
3227	Progress object created by VBoxSVC to wait until
3228	the state is saved.
3229	</desc>
3230	</param>
3231	<param name="stateFilePath" type="wstring" dir="out">
3232	<desc>
3233	File path the VM process must save the execution state to.
3234	</desc>
3235	</param>
3236	</method>
3237
3238	<method name="endSavingState">
3239	<desc>
3240	Called by the VM process to inform the server that saving
3241	the state previously requested by #beginSavingState is either
3242	successfully finished or there was a failure.
3243
3244	<result name="VBOX_E_FILE_ERROR">
3245	Settings file not accessible.
3246	</result>
3247	<result name="VBOX_E_XML_ERROR">
3248	Could not parse the settings file.
3249	</result>
3250
3251	</desc>
3252
3253	<param name="result" type="long" dir="in">
3254	<desc>@c S_OK to indicate success.
3255	</desc>
3256	</param>
3257	<param name="errMsg" type="wstring" dir="in">
3258	<desc>@c human readable error message in case of failure.
3259	</desc>
3260	</param>
3261	</method>
3262
3263	<method name="adoptSavedState">
3264	<desc>
3265	Gets called by <link to="IConsole::adoptSavedState"/>.
3266	<result name="VBOX_E_FILE_ERROR">
3267	Invalid saved state file path.
3268	</result>
3269	</desc>
3270	<param name="savedStateFile" type="wstring" dir="in">
3271	<desc>Path to the saved state file to adopt.</desc>
3272	</param>
3273	</method>
3274
3275	<method name="beginTakingSnapshot">
3276	<desc>
3277	Called from the VM process to request from the server to perform the
3278	server-side actions of creating a snapshot (creating differencing images
3279	and the snapshot object).
3280
3281	<result name="VBOX_E_FILE_ERROR">
3282	Settings file not accessible.
3283	</result>
3284	<result name="VBOX_E_XML_ERROR">
3285	Could not parse the settings file.
3286	</result>
3287	</desc>
3288	<param name="initiator" type="IConsole" dir="in">
3289	<desc>The console object that initiated this call.</desc>
3290	</param>
3291	<param name="name" type="wstring" dir="in">
3292	<desc>Snapshot name.</desc>
3293	</param>
3294	<param name="description" type="wstring" dir="in">
3295	<desc>Snapshot description.</desc>
3296	</param>
3297	<param name="consoleProgress" type="IProgress" dir="in">
3298	<desc>
3299	Progress object created by the VM process tracking the
3300	snapshot's progress. This has the following sub-operations:
3301	<ul>
3302	<li>setting up (weight 1);</li>
3303	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3304	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3305	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3306	<li>finishing up (weight 1)</li>
3307	</ul>
3308	</desc>
3309	</param>
3310	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3311	<desc>
3312	Whether this is an online snapshot (i.e. the machine is running).
3313	</desc>
3314	</param>
3315	<param name="stateFilePath" type="wstring" dir="out">
3316	<desc>
3317	File path the VM process must save the execution state to.
3318	</desc>
3319	</param>
3320	</method>
3321
3322	<method name="endTakingSnapshot">
3323	<desc>
3324	Called by the VM process to inform the server that the snapshot
3325	previously requested by #beginTakingSnapshot is either
3326	successfully taken or there was a failure.
3327	</desc>
3328
3329	<param name="success" type="boolean" dir="in">
3330	<desc>@c true to indicate success and @c false otherwise</desc>
3331	</param>
3332	</method>
3333
3334	<method name="deleteSnapshot">
3335	<desc>
3336	Gets called by <link to="IConsole::deleteSnapshot"/>,
3337	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3338	<link to="IConsole::deleteSnapshotRange"/>.
3339	<result name="VBOX_E_INVALID_OBJECT_STATE">
3340	Snapshot has more than one child snapshot. Only possible if the
3341	delete operation does not delete all children or the range does
3342	not meet the linearity condition.
3343	</result>
3344	</desc>
3345	<param name="initiator" type="IConsole" dir="in">
3346	<desc>The console object that initiated this call.</desc>
3347	</param>
3348	<param name="startId" type="uuid" mod="string" dir="in">
3349	<desc>UUID of the first snapshot to delete.</desc>
3350	</param>
3351	<param name="endId" type="uuid" mod="string" dir="in">
3352	<desc>UUID of the last snapshot to delete.</desc>
3353	</param>
3354	<param name="deleteAllChildren" type="boolean" dir="in">
3355	<desc>Whether all children should be deleted.</desc>
3356	</param>
3357	<param name="machineState" type="MachineState" dir="out">
3358	<desc>New machine state after this operation is started.</desc>
3359	</param>
3360	<param name="progress" type="IProgress" dir="return">
3361	<desc>Progress object to track the operation completion.</desc>
3362	</param>
3363	</method>
3364
3365	<method name="finishOnlineMergeMedium">
3366	<desc>
3367	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3368	</desc>
3369	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3370	<desc>The medium attachment which needs to be cleaned up.</desc>
3371	</param>
3372	<param name="source" type="IMedium" dir="in">
3373	<desc>Merge source medium.</desc>
3374	</param>
3375	<param name="target" type="IMedium" dir="in">
3376	<desc>Merge target medium.</desc>
3377	</param>
3378	<param name="mergeForward" type="boolean" dir="in">
3379	<desc>Merge direction.</desc>
3380	</param>
3381	<param name="parentForTarget" type="IMedium" dir="in">
3382	<desc>For forward merges: new parent for target medium.</desc>
3383	</param>
3384	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3385	<desc>For backward merges: list of media which need their parent UUID
3386	updated.</desc>
3387	</param>
3388	</method>
3389
3390	<method name="restoreSnapshot">
3391	<desc>
3392	Gets called by <link to="IConsole::restoreSnapshot"/>.
3393	</desc>
3394	<param name="initiator" type="IConsole" dir="in">
3395	<desc>The console object that initiated this call.</desc>
3396	</param>
3397	<param name="snapshot" type="ISnapshot" dir="in">
3398	<desc>The snapshot to restore the VM state from.</desc>
3399	</param>
3400	<param name="machineState" type="MachineState" dir="out">
3401	<desc>New machine state after this operation is started.</desc>
3402	</param>
3403	<param name="progress" type="IProgress" dir="return">
3404	<desc>Progress object to track the operation completion.</desc>
3405	</param>
3406	</method>
3407
3408	<method name="pullGuestProperties">
3409	<desc>
3410	Get the list of the guest properties matching a set of patterns along
3411	with their values, time stamps and flags and give responsibility for
3412	managing properties to the console.
3413	</desc>
3414	<param name="name" type="wstring" dir="out" safearray="yes">
3415	<desc>
3416	The names of the properties returned.
3417	</desc>
3418	</param>
3419	<param name="value" type="wstring" dir="out" safearray="yes">
3420	<desc>
3421	The values of the properties returned. The array entries match the
3422	corresponding entries in the @a name array.
3423	</desc>
3424	</param>
3425	<param name="timestamp" type="long long" dir="out" safearray="yes">
3426	<desc>
3427	The time stamps of the properties returned. The array entries match
3428	the corresponding entries in the @a name array.
3429	</desc>
3430	</param>
3431	<param name="flags" type="wstring" dir="out" safearray="yes">
3432	<desc>
3433	The flags of the properties returned. The array entries match the
3434	corresponding entries in the @a name array.
3435	</desc>
3436	</param>
3437	</method>
3438
3439	<method name="pushGuestProperty">
3440	<desc>
3441	Update a single guest property in IMachine.
3442	</desc>
3443	<param name="name" type="wstring" dir="in">
3444	<desc>
3445	The name of the property to be updated.
3446	</desc>
3447	</param>
3448	<param name="value" type="wstring" dir="in">
3449	<desc>
3450	The value of the property.
3451	</desc>
3452	</param>
3453	<param name="timestamp" type="long long" dir="in">
3454	<desc>
3455	The timestamp of the property.
3456	</desc>
3457	</param>
3458	<param name="flags" type="wstring" dir="in">
3459	<desc>
3460	The flags of the property.
3461	</desc>
3462	</param>
3463	</method>
3464
3465	<method name="lockMedia">
3466	<desc>
3467	Locks all media attached to the machine for writing and parents of
3468	attached differencing media (if any) for reading. This operation is
3469	atomic so that if it fails no media is actually locked.
3470
3471	This method is intended to be called when the machine is in Starting or
3472	Restoring state. The locked media will be automatically unlocked when
3473	the machine is powered off or crashed.
3474	</desc>
3475	</method>
3476	<method name="unlockMedia">
3477	<desc>
3478	Unlocks all media previously locked using
3479	<link to="IInternalMachineControl::lockMedia"/>.
3480
3481	This method is intended to be used with teleportation so that it is
3482	possible to teleport between processes on the same machine.
3483	</desc>
3484	</method>
3485
3486	<method name="ejectMedium">
3487	<desc>
3488	Tells VBoxSVC that the guest has ejected the medium associated with
3489	the medium attachment.
3490	</desc>
3491	<param name="attachment" type="IMediumAttachment" dir="in">
3492	<desc>
3493	The medium attachment where the eject happened.
3494	</desc>
3495	</param>
3496	<param name="newAttachment" type="IMediumAttachment" dir="return">
3497	<desc>
3498	A new reference to the medium attachment, as the config change can
3499	result in the creation of a new instance.
3500	</desc>
3501	</param>
3502	</method>
3503
3504	<method name="reportGuestStatistics">
3505	<desc>
3506	Passes collected guest statistics to VBoxSVC.
3507	</desc>
3508	<param name="validStats" type="unsigned long" dir="in">
3509	<desc>
3510	Mask defining which parameters are valid. For example: 0x11 means
3511	that cpuIdle and XXX are valid. Other parameters should be ignored.
3512	</desc>
3513	</param>
3514	<param name="cpuUser" type="unsigned long" dir="in">
3515	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3516	</param>
3517	<param name="cpuKernel" type="unsigned long" dir="in">
3518	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3519	</param>
3520	<param name="cpuIdle" type="unsigned long" dir="in">
3521	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3522	</param>
3523	<param name="memTotal" type="unsigned long" dir="in">
3524	<desc>Total amount of physical guest RAM.</desc>
3525	</param>
3526	<param name="memFree" type="unsigned long" dir="in">
3527	<desc>Free amount of physical guest RAM.</desc>
3528	</param>
3529	<param name="memBalloon" type="unsigned long" dir="in">
3530	<desc>Amount of ballooned physical guest RAM.</desc>
3531	</param>
3532	<param name="memShared" type="unsigned long" dir="in">
3533	<desc>Amount of shared physical guest RAM.</desc>
3534	</param>
3535	<param name="memCache" type="unsigned long" dir="in">
3536	<desc>Total amount of guest (disk) cache memory.</desc>
3537	</param>
3538	<param name="pagedTotal" type="unsigned long" dir="in">
3539	<desc>Total amount of space in the page file.</desc>
3540	</param>
3541	<param name="memAllocTotal" type="unsigned long" dir="in">
3542	<desc>Total amount of memory allocated by the hypervisor.</desc>
3543	</param>
3544	<param name="memFreeTotal" type="unsigned long" dir="in">
3545	<desc>Total amount of free memory available in the hypervisor.</desc>
3546	</param>
3547	<param name="memBalloonTotal" type="unsigned long" dir="in">
3548	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3549	</param>
3550	<param name="memSharedTotal" type="unsigned long" dir="in">
3551	<desc>Total amount of shared memory in the hypervisor.</desc>
3552	</param>
3553	</method>
3554	</interface>
3555
3556	<interface
3557	name="IBIOSSettings" extends="$unknown"
3558	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3559	wsmap="managed"
3560	>
3561	<desc>
3562	The IBIOSSettings interface represents BIOS settings of the virtual
3563	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3564	</desc>
3565	<attribute name="logoFadeIn" type="boolean">
3566	<desc>Fade in flag for BIOS logo animation.</desc>
3567	</attribute>
3568
3569	<attribute name="logoFadeOut" type="boolean">
3570	<desc>Fade out flag for BIOS logo animation.</desc>
3571	</attribute>
3572
3573	<attribute name="logoDisplayTime" type="unsigned long">
3574	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3575	</attribute>
3576
3577	<attribute name="logoImagePath" type="wstring">
3578	<desc>
3579	Local file system path for external BIOS splash image. Empty string
3580	means the default image is shown on boot.
3581	</desc>
3582	</attribute>
3583
3584	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3585	<desc>Mode of the BIOS boot device menu.</desc>
3586	</attribute>
3587
3588	<attribute name="ACPIEnabled" type="boolean">
3589	<desc>ACPI support flag.</desc>
3590	</attribute>
3591
3592	<attribute name="IOAPICEnabled" type="boolean">
3593	<desc>
3594	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3595	and support IRQs above 15.
3596	</desc>
3597	</attribute>
3598
3599	<attribute name="timeOffset" type="long long">
3600	<desc>
3601	Offset in milliseconds from the host system time. This allows for
3602	guests running with a different system date/time than the host.
3603	It is equivalent to setting the system date/time in the BIOS except
3604	it is not an absolute value but a relative one. Guest Additions
3605	time synchronization honors this offset.
3606	</desc>
3607	</attribute>
3608
3609	<attribute name="PXEDebugEnabled" type="boolean">
3610	<desc>
3611	PXE debug logging flag. If set, VirtualBox will write extensive
3612	PXE trace information to the release log.
3613	</desc>
3614	</attribute>
3615	</interface>
3616
3617	<enum
3618	name="CleanupMode"
3619	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3620	>
3621	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3622	</desc>
3623	<const name="UnregisterOnly" value="1">
3624	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3625	</const>
3626	<const name="DetachAllReturnNone" value="2">
3627	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3628	</const>
3629	<const name="DetachAllReturnHardDisksOnly" value="3">
3630	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3631	</const>
3632	<const name="Full" value="4">
3633	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3634	</const>
3635	</enum>
3636
3637	<interface
3638	name="IPCIAddress" extends="$unknown"
3639	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3640	wsmap="struct"
3641	>
3642
3643	<desc>
3644	Address on the PCI bus.
3645	</desc>
3646
3647	<attribute name="bus" type="short">
3648	<desc>
3649	Bus number.
3650	</desc>
3651	</attribute>
3652
3653	<attribute name="device" type="short">
3654	<desc>
3655	Device number.
3656	</desc>
3657	</attribute>
3658
3659	<attribute name="devFunction" type="short">
3660	<desc>
3661	Device function number.
3662	</desc>
3663	</attribute>
3664
3665	<method name="asLong">
3666	<desc>
3667	Convert PCI address into long.
3668	</desc>
3669	<param name="result" type="long" dir="return" />
3670	</method>
3671
3672	<method name="fromLong">
3673	<desc>
3674	Make PCI address from long.
3675	</desc>
3676	<param name="number" type="long" dir="in" />
3677	</method>
3678	</interface>
3679
3680	<interface
3681	name="IPCIDeviceAttachment" extends="$unknown"
3682	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3683	wsmap="struct"
3684	>
3685
3686	<desc>
3687	Information about PCI attachments.
3688	</desc>
3689
3690	<attribute name="name" type="wstring" readonly="yes">
3691	<desc>
3692	Device name.
3693	</desc>
3694	</attribute>
3695
3696	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3697	<desc>
3698	If this is physical or virtual device.
3699	</desc>
3700	</attribute>
3701
3702	<attribute name="hostAddress" type="long" readonly="yes">
3703	<desc>
3704	Address of device on the host, applicable only to host devices.
3705	</desc>
3706	</attribute>
3707
3708	<attribute name="guestAddress" type="long" readonly="yes">
3709	<desc>
3710	Address of device on the guest.
3711	</desc>
3712	</attribute>
3713
3714	</interface>
3715
3716	<enum
3717	name="CloneMode" extends="$unknown"
3718	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3719	>
3720
3721	<desc>
3722	Clone mode, used with <link to="IMachine::cloneTo" />.
3723	</desc>
3724
3725	<const name="MachineState" value="1">
3726	<desc>Clone the state of the selected machine.</desc>
3727	</const>
3728	<const name="MachineAndChildStates" value="2">
3729	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3730	</const>
3731	<const name="AllStates" value="3">
3732	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3733	</const>
3734
3735	</enum>
3736
3737	<enum
3738	name="CloneOptions" extends="$unknown"
3739	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3740	>
3741
3742	<desc>
3743	Clone options, used with <link to="IMachine::cloneTo" />.
3744	</desc>
3745
3746	<const name="Link" value="1">
3747	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3748	</const>
3749	<const name="KeepAllMACs" value="2">
3750	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3751	</const>
3752	<const name="KeepNATMACs" value="3">
3753	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3754	</const>
3755	<const name="KeepDiskNames" value="4">
3756	<desc>Don't change the disk names.</desc>
3757	</const>
3758
3759	</enum>
3760
3761	<enum
3762	name="AutostopType" extends="$unknown"
3763	uuid="6bb96740-cf34-470d-aab2-2cd48ea2e10e"
3764	>
3765
3766	<desc>
3767	Autostop types, used with <link to="IMachine::autostopType" />.
3768	</desc>
3769
3770	<const name="Disabled" value="1">
3771	<desc>Stopping the VM during system shutdown is disabled.</desc>
3772	</const>
3773	<const name="SaveState" value="2">
3774	<desc>The state of the VM will be saved when the system shuts down.</desc>
3775	</const>
3776	<const name="PowerOff" value="3">
3777	<desc>The VM is powered off when the system shuts down.</desc>
3778	</const>
3779	<const name="AcpiShutdown" value="4">
3780	<desc>An ACPI shutdown event is generated.</desc>
3781	</const>
3782
3783	</enum>
3784
3785
3786	<interface
3787	name="IMachine" extends="$unknown"
3788	uuid="22781af3-1c96-4126-9edf-67a020e0e858"
3789	wsmap="managed"
3790	>
3791	<desc>
3792	The IMachine interface represents a virtual machine, or guest, created
3793	in VirtualBox.
3794
3795	This interface is used in two contexts. First of all, a collection of
3796	objects implementing this interface is stored in the
3797	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3798	machines that are currently registered with this VirtualBox
3799	installation. Also, once a session has been opened for the given virtual
3800	machine (e.g. the virtual machine is running), the machine object
3801	associated with the open session can be queried from the session object;
3802	see <link to="ISession"/> for details.
3803
3804	The main role of this interface is to expose the settings of the virtual
3805	machine and provide methods to change various aspects of the virtual
3806	machine's configuration. For machine objects stored in the
3807	<link to="IVirtualBox::machines"/> collection, all attributes are
3808	read-only unless explicitly stated otherwise in individual attribute
3809	and method descriptions.
3810
3811	In order to change a machine setting, a session for this machine must be
3812	opened using one of the <link to="IMachine::lockMachine" /> or
3813	<link to="IMachine::launchVMProcess"/> methods. After the
3814	machine has been successfully locked for a session, a mutable machine object
3815	needs to be queried from the session object and then the desired settings
3816	changes can be applied to the returned object using IMachine attributes and
3817	methods. See the <link to="ISession"/> interface description for more
3818	information about sessions.
3819
3820	Note that IMachine does not provide methods to control virtual machine
3821	execution (such as start the machine, or power it down) -- these methods
3822	are grouped in a separate interface called <link to="IConsole" />.
3823
3824	<see><link to="ISession"/>, <link to="IConsole"/></see>
3825	</desc>
3826
3827	<attribute name="parent" type="IVirtualBox" readonly="yes">
3828	<desc>Associated parent object.</desc>
3829	</attribute>
3830
3831	<attribute name="accessible" type="boolean" readonly="yes">
3832	<desc>
3833	Whether this virtual machine is currently accessible or not.
3834
3835	A machine is always deemed accessible unless it is registered <i>and</i>
3836	its settings file cannot be read or parsed (either because the file itself
3837	is unavailable or has invalid XML contents).
3838
3839	Every time this property is read, the accessibility state of
3840	this machine is re-evaluated. If the returned value is @c false,
3841	the <link to="#accessError"/> property may be used to get the
3842	detailed error information describing the reason of
3843	inaccessibility, including XML error messages.
3844
3845	When the machine is inaccessible, only the following properties
3846	can be used on it:
3847	<ul>
3848	<li><link to="#parent"/></li>
3849	<li><link to="#id"/></li>
3850	<li><link to="#settingsFilePath"/></li>
3851	<li><link to="#accessible"/></li>
3852	<li><link to="#accessError"/></li>
3853	</ul>
3854
3855	An attempt to access any other property or method will return
3856	an error.
3857
3858	The only possible action you can perform on an inaccessible
3859	machine is to unregister it using the
3860	<link to="IMachine::unregister"/> call (or, to check
3861	for the accessibility state once more by querying this
3862	property).
3863
3864	<note>
3865	In the current implementation, once this property returns
3866	@c true, the machine will never become inaccessible
3867	later, even if its settings file cannot be successfully
3868	read/written any more (at least, until the VirtualBox
3869	server is restarted). This limitation may be removed in
3870	future releases.
3871	</note>
3872	</desc>
3873	</attribute>
3874
3875	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3876	<desc>
3877	Error information describing the reason of machine
3878	inaccessibility.
3879
3880	Reading this property is only valid after the last call to
3881	<link to="#accessible"/> returned @c false (i.e. the
3882	machine is currently inaccessible). Otherwise, a @c null
3883	IVirtualBoxErrorInfo object will be returned.
3884	</desc>
3885	</attribute>
3886
3887	<attribute name="name" type="wstring">
3888	<desc>
3889	Name of the virtual machine.
3890
3891	Besides being used for human-readable identification purposes
3892	everywhere in VirtualBox, the virtual machine name is also used
3893	as a name of the machine's settings file and as a name of the
3894	subdirectory this settings file resides in. Thus, every time you
3895	change the value of this property, the settings file will be
3896	renamed once you call <link to="#saveSettings"/> to confirm the
3897	change. The containing subdirectory will be also renamed, but
3898	only if it has exactly the same name as the settings file
3899	itself prior to changing this property (for backward compatibility
3900	with previous API releases). The above implies the following
3901	limitations:
3902	<ul>
3903	<li>The machine name cannot be empty.</li>
3904	<li>The machine name can contain only characters that are valid
3905	file name characters according to the rules of the file
3906	system used to store VirtualBox configuration.</li>
3907	<li>You cannot have two or more machines with the same name
3908	if they use the same subdirectory for storing the machine
3909	settings files.</li>
3910	<li>You cannot change the name of the machine if it is running,
3911	or if any file in the directory containing the settings file
3912	is being used by another running machine or by any other
3913	process in the host operating system at a time when
3914	<link to="#saveSettings"/> is called.
3915	</li>
3916	</ul>
3917	If any of the above limitations are hit, <link to="#saveSettings"/>
3918	will return an appropriate error message explaining the exact
3919	reason and the changes you made to this machine will not be saved.
3920
3921	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3922	file is recommended, but not enforced. (Previous versions always
3923	used a generic ".xml" extension.)
3924	</desc>
3925	</attribute>
3926
3927	<attribute name="description" type="wstring">
3928	<desc>
3929	Description of the virtual machine.
3930
3931	The description attribute can contain any text and is
3932	typically used to describe the hardware and software
3933	configuration of the virtual machine in detail (i.e. network
3934	settings, versions of the installed software and so on).
3935	</desc>
3936	</attribute>
3937
3938	<attribute name="id" type="uuid" mod="string" readonly="yes">
3939	<desc>UUID of the virtual machine.</desc>
3940	</attribute>
3941
3942	<attribute name="groups" type="wstring" safearray="yes">
3943	<desc>
3944	Array of machine group names of which this machine is a member.
3945	<tt>""</tt> and <tt>"/"</tt> are synonyms for the toplevel group. Each
3946	group is only listed once, however they are listed in no particular
3947	order and there is no guarantee that there are no gaps in the group
3948	hierarchy (i.e. <tt>"/group"</tt>,
3949	<tt>"/group/subgroup/subsubgroup"</tt> is a valid result).
3950	</desc>
3951	</attribute>
3952
3953	<attribute name="OSTypeId" type="wstring">
3954	<desc>
3955	User-defined identifier of the Guest OS type.
3956	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3957	an IGuestOSType object representing details about the given
3958	Guest OS type.
3959	<note>
3960	This value may differ from the value returned by
3961	<link to="IGuest::OSTypeId"/> if Guest Additions are
3962	installed to the guest OS.
3963	</note>
3964	</desc>
3965	</attribute>
3966
3967	<attribute name="hardwareVersion" type="wstring">
3968	<desc>Hardware version identifier. Internal use only for now.</desc>
3969	</attribute>
3970
3971	<attribute name="hardwareUUID" type="uuid" mod="string">
3972	<desc>
3973	The UUID presented to the guest via memory tables, hardware and guest
3974	properties. For most VMs this is the same as the @a id, but for VMs
3975	which have been cloned or teleported it may be the same as the source
3976	VM. The latter is because the guest shouldn't notice that it was
3977	cloned or teleported.
3978	</desc>
3979	</attribute>
3980
3981	<attribute name="CPUCount" type="unsigned long">
3982	<desc>Number of virtual CPUs in the VM.</desc>
3983	</attribute>
3984
3985	<attribute name="CPUHotPlugEnabled" type="boolean">
3986	<desc>
3987	This setting determines whether VirtualBox allows CPU
3988	hotplugging for this machine.</desc>
3989	</attribute>
3990
3991	<attribute name="CPUExecutionCap" type="unsigned long">
3992	<desc>
3993	Means to limit the number of CPU cycles a guest can use. The unit
3994	is percentage of host CPU cycles per second. The valid range
3995	is 1 - 100. 100 (the default) implies no limit.
3996	</desc>
3997	</attribute>
3998
3999	<attribute name="memorySize" type="unsigned long">
4000	<desc>System memory size in megabytes.</desc>
4001	</attribute>
4002
4003	<attribute name="memoryBalloonSize" type="unsigned long">
4004	<desc>Memory balloon size in megabytes.</desc>
4005	</attribute>
4006
4007	<attribute name="pageFusionEnabled" type="boolean">
4008	<desc>
4009	This setting determines whether VirtualBox allows page
4010	fusion for this machine (64 bits host only).
4011	</desc>
4012	</attribute>
4013
4014	<attribute name="VRAMSize" type="unsigned long">
4015	<desc>Video memory size in megabytes.</desc>
4016	</attribute>
4017
4018	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4019	<desc>
4020	This setting determines whether VirtualBox allows this machine to make
4021	use of the 3D graphics support available on the host.</desc>
4022	</attribute>
4023
4024	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4025	<desc>
4026	This setting determines whether VirtualBox allows this machine to make
4027	use of the 2D video acceleration support available on the host.</desc>
4028	</attribute>
4029
4030	<attribute name="monitorCount" type="unsigned long">
4031	<desc>
4032	Number of virtual monitors.
4033	<note>
4034	Only effective on Windows XP and later guests with
4035	Guest Additions installed.
4036	</note>
4037	</desc>
4038	</attribute>
4039
4040	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4041	<desc>Object containing all BIOS settings.</desc>
4042	</attribute>
4043
4044	<attribute name="firmwareType" type="FirmwareType">
4045	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4046	bootstrap in this VM.</desc>
4047	</attribute>
4048
4049	<attribute name="pointingHIDType" type="PointingHIDType">
4050	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4051	The default is typically "PS2Mouse" but can vary depending on the
4052	requirements of the guest operating system.</desc>
4053	</attribute>
4054
4055	<attribute name="keyboardHIDType" type="KeyboardHIDType">
4056	<desc>Type of keyboard HID used in this VM.
4057	The default is typically "PS2Keyboard" but can vary depending on the
4058	requirements of the guest operating system.</desc>
4059	</attribute>
4060
4061	<attribute name="HPETEnabled" type="boolean">
4062	<desc>This attribute controls if High Precision Event Timer (HPET) is
4063	enabled in this VM. Use this property if you want to provide guests
4064	with additional time source, or if guest requires HPET to function correctly.
4065	Default is false.</desc>
4066	</attribute>
4067
4068	<attribute name="chipsetType" type="ChipsetType">
4069	<desc>Chipset type used in this VM.</desc>
4070	</attribute>
4071
4072	<attribute name="snapshotFolder" type="wstring">
4073	<desc>
4074	Full path to the directory used to store snapshot data
4075	(differencing media and saved state files) of this machine.
4076
4077	The initial value of this property is
4078	<tt><</tt><link to="#settingsFilePath">
4079	path_to_settings_file</link><tt>>/<</tt>
4080	<link to="#id">machine_uuid</link>
4081	<tt>></tt>.
4082
4083	Currently, it is an error to try to change this property on
4084	a machine that has snapshots (because this would require to
4085	move possibly large files to a different location).
4086	A separate method will be available for this purpose later.
4087
4088	<note>
4089	Setting this property to @c null or to an empty string will restore
4090	the initial value.
4091	</note>
4092	<note>
4093	When setting this property, the specified path can be
4094	absolute (full path) or relative to the directory where the
4095	<link to="#settingsFilePath">machine settings file</link>
4096	is located. When reading this property, a full path is
4097	always returned.
4098	</note>
4099	<note>
4100	The specified path may not exist, it will be created
4101	when necessary.
4102	</note>
4103	</desc>
4104	</attribute>
4105
4106	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4107	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4108	</attribute>
4109
4110	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4111	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4112
4113	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4114	<desc>Array of media attached to this machine.</desc>
4115	</attribute>
4116
4117	<attribute name="USBController" type="IUSBController" readonly="yes">
4118	<desc>
4119	Associated USB controller object.
4120
4121	<note>
4122	If USB functionality is not available in the given edition of
4123	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4124	</note>
4125	</desc>
4126	</attribute>
4127
4128	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4129	<desc>Associated audio adapter, always present.</desc>
4130	</attribute>
4131
4132	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4133	<desc>Array of storage controllers attached to this machine.</desc>
4134	</attribute>
4135
4136	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4137	<desc>
4138	Full name of the file containing machine settings data.
4139	</desc>
4140	</attribute>
4141
4142	<attribute name="settingsModified" type="boolean" readonly="yes">
4143	<desc>
4144	Whether the settings of this machine have been modified
4145	(but neither yet saved nor discarded).
4146	<note>
4147	Reading this property is only valid on instances returned
4148	by <link to="ISession::machine"/> and on new machines
4149	created by <link to="IVirtualBox::createMachine"/> or opened
4150	by <link to="IVirtualBox::openMachine"/> but not
4151	yet registered, or on unregistered machines after calling
4152	<link to="IMachine::unregister"/>. For all other
4153	cases, the settings can never be modified.
4154	</note>
4155	<note>
4156	For newly created unregistered machines, the value of this
4157	property is always @c true until <link to="#saveSettings"/>
4158	is called (no matter if any machine settings have been
4159	changed after the creation or not). For opened machines
4160	the value is set to @c false (and then follows to normal rules).
4161	</note>
4162	</desc>
4163	</attribute>
4164
4165	<attribute name="sessionState" type="SessionState" readonly="yes">
4166	<desc>Current session state for this machine.</desc>
4167	</attribute>
4168
4169	<attribute name="sessionType" type="wstring" readonly="yes">
4170	<desc>
4171	Type of the session. If <link to="#sessionState"/> is
4172	Spawning or Locked, this attribute contains the
4173	same value as passed to the
4174	<link to="IMachine::launchVMProcess"/> method in the
4175	@a type parameter. If the session was used with
4176	<link to="IMachine::lockMachine" />, or if
4177	<link to="#sessionState"/> is SessionClosed, the value of this
4178	attribute is an empty string.
4179	</desc>
4180	</attribute>
4181
4182	<attribute name="sessionPID" type="unsigned long" readonly="yes">
4183	<desc>
4184	Identifier of the session process. This attribute contains the
4185	platform-dependent identifier of the process whose session was
4186	used with <link to="IMachine::lockMachine" /> call. The returned
4187	value is only valid if <link to="#sessionState"/> is Locked or
4188	Unlocking by the time this property is read.
4189	</desc>
4190	</attribute>
4191
4192	<attribute name="state" type="MachineState" readonly="yes">
4193	<desc>Current execution state of this machine.</desc>
4194	</attribute>
4195
4196	<attribute name="lastStateChange" type="long long" readonly="yes">
4197	<desc>
4198	Time stamp of the last execution state change,
4199	in milliseconds since 1970-01-01 UTC.
4200	</desc>
4201	</attribute>
4202
4203	<attribute name="stateFilePath" type="wstring" readonly="yes">
4204	<desc>
4205	Full path to the file that stores the execution state of
4206	the machine when it is in the <link to="MachineState_Saved"/> state.
4207	<note>
4208	When the machine is not in the Saved state, this attribute is
4209	an empty string.
4210	</note>
4211	</desc>
4212	</attribute>
4213
4214	<attribute name="logFolder" type="wstring" readonly="yes">
4215	<desc>
4216	Full path to the folder that stores a set of rotated log files
4217	recorded during machine execution. The most recent log file is
4218	named <tt>VBox.log</tt>, the previous log file is
4219	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4220	in the current version).
4221	</desc>
4222	</attribute>
4223
4224	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4225	<desc>
4226	Current snapshot of this machine. This is @c null if the machine
4227	currently has no snapshots. If it is not @c null, then it was
4228	set by one of <link to="IConsole::takeSnapshot" />,
4229	<link to="IConsole::deleteSnapshot" />
4230	or <link to="IConsole::restoreSnapshot" />, depending on which
4231	was called last. See <link to="ISnapshot"/> for details.
4232	</desc>
4233	</attribute>
4234
4235	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4236	<desc>
4237	Number of snapshots taken on this machine. Zero means the
4238	machine doesn't have any snapshots.
4239	</desc>
4240	</attribute>
4241
4242	<attribute name="currentStateModified" type="boolean" readonly="yes">
4243	<desc>
4244	Returns @c true if the current state of the machine is not
4245	identical to the state stored in the current snapshot.
4246
4247	The current state is identical to the current snapshot only
4248	directly after one of the following calls are made:
4249
4250	<ul>
4251	<li><link to="IConsole::restoreSnapshot"/>
4252	</li>
4253	<li><link to="IConsole::takeSnapshot"/> (issued on a
4254	"powered off" or "saved" machine, for which
4255	<link to="#settingsModified"/> returns @c false)
4256	</li>
4257	</ul>
4258
4259	The current state remains identical until one of the following
4260	happens:
4261	<ul>
4262	<li>settings of the machine are changed</li>
4263	<li>the saved state is deleted</li>
4264	<li>the current snapshot is deleted</li>
4265	<li>an attempt to execute the machine is made</li>
4266	</ul>
4267
4268	<note>
4269	For machines that don't have snapshots, this property is
4270	always @c false.
4271	</note>
4272	</desc>
4273	</attribute>
4274
4275	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4276	<desc>
4277	Collection of shared folders for this machine (permanent shared
4278	folders). These folders are shared automatically at machine startup
4279	and available only to the guest OS installed within this machine.
4280
4281	New shared folders are added to the collection using
4282	<link to="#createSharedFolder"/>. Existing shared folders can be
4283	removed using <link to="#removeSharedFolder"/>.
4284	</desc>
4285	</attribute>
4286
4287	<attribute name="clipboardMode" type="ClipboardMode">
4288	<desc>
4289	Synchronization mode between the host OS clipboard
4290	and the guest OS clipboard.
4291	</desc>
4292	</attribute>
4293
4294	<attribute name="dragAndDropMode" type="DragAndDropMode">
4295	<desc>
4296	Which mode is allowed for drag'n'drop.
4297	</desc>
4298	</attribute>
4299
4300	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4301	<desc>
4302	A comma-separated list of simple glob patterns. Changes to guest
4303	properties whose name matches one of the patterns will generate an
4304	<link to="IGuestPropertyChangedEvent"/> signal.
4305	</desc>
4306	</attribute>
4307
4308	<attribute name="teleporterEnabled" type="boolean">
4309	<desc>
4310	When set to @a true, the virtual machine becomes a target teleporter
4311	the next time it is powered on. This can only set to @a true when the
4312	VM is in the @a PoweredOff or @a Aborted state.
4313
4314	<!-- This property is automatically set to @a false when the VM is powered
4315	on. (bird: This doesn't work yet ) -->
4316	</desc>
4317	</attribute>
4318
4319	<attribute name="teleporterPort" type="unsigned long">
4320	<desc>
4321	The TCP port the target teleporter will listen for incoming
4322	teleportations on.
4323
4324	0 means the port is automatically selected upon power on. The actual
4325	value can be read from this property while the machine is waiting for
4326	incoming teleportations.
4327	</desc>
4328	</attribute>
4329
4330	<attribute name="teleporterAddress" type="wstring">
4331	<desc>
4332	The address the target teleporter will listen on. If set to an empty
4333	string, it will listen on all addresses.
4334	</desc>
4335	</attribute>
4336
4337	<attribute name="teleporterPassword" type="wstring">
4338	<desc>
4339	The password to check for on the target teleporter. This is just a
4340	very basic measure to prevent simple hacks and operators accidentally
4341	beaming a virtual machine to the wrong place.
4342
4343	Note that you SET a plain text password while reading back a HASHED
4344	password. Setting a hashed password is currently not supported.
4345	</desc>
4346	</attribute>
4347
4348	<attribute name="faultToleranceState" type="FaultToleranceState">
4349	<desc>
4350	Fault tolerance state; disabled, source or target.
4351	This property can be changed at any time. If you change it for a running
4352	VM, then the fault tolerance address and port must be set beforehand.
4353	</desc>
4354	</attribute>
4355
4356	<attribute name="faultTolerancePort" type="unsigned long">
4357	<desc>
4358	The TCP port the fault tolerance source or target will use for
4359	communication.
4360	</desc>
4361	</attribute>
4362
4363	<attribute name="faultToleranceAddress" type="wstring">
4364	<desc>
4365	The address the fault tolerance source or target.
4366	</desc>
4367	</attribute>
4368
4369	<attribute name="faultTolerancePassword" type="wstring">
4370	<desc>
4371	The password to check for on the standby VM. This is just a
4372	very basic measure to prevent simple hacks and operators accidentally
4373	choosing the wrong standby VM.
4374	</desc>
4375	</attribute>
4376
4377	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4378	<desc>
4379	The interval in ms used for syncing the state between source and target.
4380	</desc>
4381	</attribute>
4382
4383	<attribute name="RTCUseUTC" type="boolean">
4384	<desc>
4385	When set to @a true, the RTC device of the virtual machine will run
4386	in UTC time, otherwise in local time. Especially Unix guests prefer
4387	the time in UTC.
4388	</desc>
4389	</attribute>
4390
4391	<attribute name="IOCacheEnabled" type="boolean">
4392	<desc>
4393	When set to @a true, the builtin I/O cache of the virtual machine
4394	will be enabled.
4395	</desc>
4396	</attribute>
4397
4398	<attribute name="IOCacheSize" type="unsigned long">
4399	<desc>
4400	Maximum size of the I/O cache in MB.
4401	</desc>
4402	</attribute>
4403
4404	<attribute name="PCIDeviceAssignments" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
4405	<desc>Array of PCI devices assigned to this machine, to get list of all
4406	PCI devices attached to the machine use
4407	<link to="IConsole::attachedPCIDevices"/> attribute, as this attribute
4408	is intended to list only devices additional to what described in
4409	virtual hardware config. Usually, this list keeps host's physical
4410	devices assigned to the particular machine.
4411	</desc>
4412	</attribute>
4413
4414	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4415	<desc>
4416	Bandwidth control manager.
4417	</desc>
4418	</attribute>
4419
4420	<attribute name="tracingEnabled" type="boolean">
4421	<desc>
4422	Enables the tracing facility in the VMM (including PDM devices +
4423	drivers). The VMM will consume about 0.5MB of more memory when
4424	enabled and there may be some extra overhead from tracepoints that are
4425	always enabled.
4426	</desc>
4427	</attribute>
4428
4429	<attribute name="tracingConfig" type="wstring">
4430	<desc>
4431	Tracepoint configuration to apply at startup when
4432	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4433	a space separated of tracepoint group names to enable. The special
4434	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4435	more details on available tracepoint groups and such.
4436
4437	Note that on hosts supporting DTrace (or similar), a lot of the
4438	tracepoints may be implemented exclusivly as DTrace probes. So, the
4439	effect of the same config may differ between Solaris and Windows for
4440	example.
4441	</desc>
4442	</attribute>
4443
4444	<attribute name="allowTracingToAccessVM" type="boolean">
4445	<desc>
4446	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4447	structures when firing off trace points. This is especially useful
4448	with DTrace tracepoints, as it allows you to use the VMCPU or VM
4449	pointer to obtain useful information such as guest register state.
4450
4451	This is disabled by default because devices and drivers normally has no
4452	business accessing the VMCPU or VM structures, and are therefore unable
4453	to get any pointers to these.
4454	</desc>
4455	</attribute>
4456
4457	<attribute name="autostartEnabled" type="boolean">
4458	<desc>
4459	Enables autostart of the VM during system boot.
4460	</desc>
4461	</attribute>
4462
4463	<attribute name="autostartDelay" type="unsigned long">
4464	<desc>
4465	Number of seconds to wait until the VM should be started during system boot.
4466	</desc>
4467	</attribute>
4468
4469	<attribute name="autostopType" type="AutostopType">
4470	<desc>
4471	Action type to do when the system is shutting down.
4472	</desc>
4473	</attribute>
4474
4475	<method name="lockMachine">
4476	<desc>
4477	Locks the machine for the given session to enable the caller
4478	to make changes to the machine or start the VM or control
4479	VM execution.
4480
4481	There are two ways to lock a machine for such uses:
4482
4483	<ul>
4484	<li>If you want to make changes to the machine settings,
4485	you must obtain an exclusive write lock on the machine
4486	by setting @a lockType to @c Write.
4487
4488	This will only succeed if no other process has locked
4489	the machine to prevent conflicting changes. Only after
4490	an exclusive write lock has been obtained using this method, one
4491	can change all VM settings or execute the VM in the process
4492	space of the session object. (Note that the latter is only of
4493	interest if you actually want to write a new front-end for
4494	virtual machines; but this API gets called internally by
4495	the existing front-ends such as VBoxHeadless and the VirtualBox
4496	GUI to acquire a write lock on the machine that they are running.)
4497
4498	On success, write-locking the machine for a session creates
4499	a second copy of the IMachine object. It is this second object
4500	upon which changes can be made; in VirtualBox terminology, the
4501	second copy is "mutable". It is only this second, mutable machine
4502	object upon which you can call methods that change the
4503	machine state. After having called this method, you can
4504	obtain this second, mutable machine object using the
4505	<link to="ISession::machine" /> attribute.
4506	</li>
4507	<li>If you only want to check the machine state or control
4508	machine execution without actually changing machine
4509	settings (e.g. to get access to VM statistics or take
4510	a snapshot or save the machine state), then set the
4511	@a lockType argument to @c Shared.
4512
4513	If no other session has obtained a lock, you will obtain an
4514	exclusive write lock as described above. However, if another
4515	session has already obtained such a lock, then a link to that
4516	existing session will be established which allows you
4517	to control that existing session.
4518
4519	To find out which type of lock was obtained, you can
4520	inspect <link to="ISession::type" />, which will have been
4521	set to either @c WriteLock or @c Shared.
4522	</li>
4523	</ul>
4524
4525	In either case, you can get access to the <link to="IConsole" />
4526	object which controls VM execution.
4527
4528	Also in all of the above cases, one must always call
4529	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4530	the machine's state will eventually be set to "Aborted".
4531
4532	To change settings on a machine, the following sequence is typically
4533	performed:
4534
4535	<ol>
4536	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4537
4538	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4539
4540	<li>Change the settings of the machine by invoking IMachine methods.</li>
4541
4542	<li>Call <link to="IMachine::saveSettings" />.</li>
4543
4544	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4545	</ol>
4546
4547	<result name="E_UNEXPECTED">
4548	Virtual machine not registered.
4549	</result>
4550	<result name="E_ACCESSDENIED">
4551	Process not started by OpenRemoteSession.
4552	</result>
4553	<result name="VBOX_E_INVALID_OBJECT_STATE">
4554	Session already open or being opened.
4555	</result>
4556	<result name="VBOX_E_VM_ERROR">
4557	Failed to assign machine to session.
4558	</result>
4559	</desc>
4560	<param name="session" type="ISession" dir="in">
4561	<desc>
4562	Session object for which the machine will be locked.
4563	</desc>
4564	</param>
4565	<param name="lockType" type="LockType" dir="in">
4566	<desc>
4567	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4568	If set to @c Shared, then either acquire an exclusive write lock or establish
4569	a link to an existing session.
4570	</desc>
4571	</param>
4572	</method>
4573
4574	<method name="launchVMProcess">
4575	<desc>
4576	Spawns a new process that will execute the virtual machine and obtains a shared
4577	lock on the machine for the calling session.
4578
4579	If launching the VM succeeds, the new VM process will create its own session
4580	and write-lock the machine for it, preventing conflicting changes from other
4581	processes. If the machine is already locked (because it is already running or
4582	because another session has a write lock), launching the VM process will therefore
4583	fail. Reversely, future attempts to obtain a write lock will also fail while the
4584	machine is running.
4585
4586	The caller's session object remains separate from the session opened by the new
4587	VM process. It receives its own <link to="IConsole" /> object which can be used
4588	to control machine execution, but it cannot be used to change all VM settings
4589	which would be available after a <link to="#lockMachine" /> call.
4590
4591	The caller must eventually release the session's shared lock by calling
4592	<link to="ISession::unlockMachine" /> on the local session object once this call
4593	has returned. However, the session's state (see <link to="ISession::state" />)
4594	will not return to "Unlocked" until the remote session has also unlocked
4595	the machine (i.e. the machine has stopped running).
4596
4597	Launching a VM process can take some time (a new VM is started in a new process,
4598	for which memory and other resources need to be set up). Because of this,
4599	an <link to="IProgress" /> object is returned to allow the caller to wait
4600	for this asynchronous operation to be completed. Until then, the caller's
4601	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4602	and <link to="ISession::console" /> attributes cannot be accessed.
4603	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4604	similar calls to wait for completion. Completion is signalled when the VM
4605	is powered on. If launching the VM fails, error messages can be queried
4606	via the progress object, if available.
4607
4608	The progress object will have at least 2 sub-operations. The first
4609	operation covers the period up to the new VM process calls powerUp.
4610	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4611	progress object. Because <link to="IConsole::powerUp"/> may require
4612	some extra sub-operations, the <link to="IProgress::operationCount"/>
4613	may change at the completion of operation.
4614
4615	For details on the teleportation progress operation, see
4616	<link to="IConsole::powerUp"/>.
4617
4618	The @a environment argument is a string containing definitions of
4619	environment variables in the following format:
4620	<pre>
4621	NAME[=VALUE]\n
4622	NAME[=VALUE]\n
4623	...
4624	</pre>
4625	where <tt>\\n</tt> is the new line character. These environment
4626	variables will be appended to the environment of the VirtualBox server
4627	process. If an environment variable exists both in the server process
4628	and in this list, the value from this list takes precedence over the
4629	server's variable. If the value of the environment variable is
4630	omitted, this variable will be removed from the resulting environment.
4631	If the environment string is @c null or empty, the server environment
4632	is inherited by the started process as is.
4633
4634	<result name="E_UNEXPECTED">
4635	Virtual machine not registered.
4636	</result>
4637	<result name="E_INVALIDARG">
4638	Invalid session type @a type.
4639	</result>
4640	<result name="VBOX_E_OBJECT_NOT_FOUND">
4641	No machine matching @a machineId found.
4642	</result>
4643	<result name="VBOX_E_INVALID_OBJECT_STATE">
4644	Session already open or being opened.
4645	</result>
4646	<result name="VBOX_E_IPRT_ERROR">
4647	Launching process for machine failed.
4648	</result>
4649	<result name="VBOX_E_VM_ERROR">
4650	Failed to assign machine to session.
4651	</result>
4652	</desc>
4653	<param name="session" type="ISession" dir="in">
4654	<desc>
4655	Client session object to which the VM process will be connected (this
4656	must be in "Unlocked" state).
4657	</desc>
4658	</param>
4659	<param name="type" type="wstring" dir="in">
4660	<desc>
4661	Front-end to use for the new VM process. The following are currently supported:
4662	<ul>
4663	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4664	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4665	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4666	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4667	the currently running VM or session owner. In this case the
4668	@a session parameter may be @c null (if it is non-null it isn't
4669	used in any way), and the @a progress return value will be always
4670	@c null. The operation completes immediately.</li>
4671	</ul>
4672	</desc>
4673	</param>
4674	<param name="environment" type="wstring" dir="in">
4675	<desc>
4676	Environment to pass to the VM process.
4677	</desc>
4678	</param>
4679	<param name="progress" type="IProgress" dir="return">
4680	<desc>Progress object to track the operation completion.</desc>
4681	</param>
4682	</method>
4683
4684	<method name="setBootOrder">
4685	<desc>
4686	Puts the given device to the specified position in
4687	the boot order.
4688
4689	To indicate that no device is associated with the given position,
4690	<link to="DeviceType_Null"/> should be used.
4691
4692	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4693
4694	<result name="E_INVALIDARG">
4695	Boot @a position out of range.
4696	</result>
4697	<result name="E_NOTIMPL">
4698	Booting from USB @a device currently not supported.
4699	</result>
4700
4701	</desc>
4702	<param name="position" type="unsigned long" dir="in">
4703	<desc>
4704	Position in the boot order (@c 1 to the total number of
4705	devices the machine can boot from, as returned by
4706	<link to="ISystemProperties::maxBootPosition"/>).
4707	</desc>
4708	</param>
4709	<param name="device" type="DeviceType" dir="in">
4710	<desc>
4711	The type of the device used to boot at the given position.
4712	</desc>
4713	</param>
4714	</method>
4715
4716	<method name="getBootOrder" const="yes">
4717	<desc>
4718	Returns the device type that occupies the specified
4719	position in the boot order.
4720
4721	@todo [remove?]
4722	If the machine can have more than one device of the returned type
4723	(such as hard disks), then a separate method should be used to
4724	retrieve the individual device that occupies the given position.
4725
4726	If here are no devices at the given position, then
4727	<link to="DeviceType_Null"/> is returned.
4728
4729	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4730
4731	<result name="E_INVALIDARG">
4732	Boot @a position out of range.
4733	</result>
4734
4735	</desc>
4736	<param name="position" type="unsigned long" dir="in">
4737	<desc>
4738	Position in the boot order (@c 1 to the total number of
4739	devices the machine can boot from, as returned by
4740	<link to="ISystemProperties::maxBootPosition"/>).
4741	</desc>
4742	</param>
4743	<param name="device" type="DeviceType" dir="return">
4744	<desc>
4745	Device at the given position.
4746	</desc>
4747	</param>
4748	</method>
4749
4750	<method name="attachDevice">
4751	<desc>
4752	Attaches a device and optionally mounts a medium to the given storage
4753	controller (<link to="IStorageController" />, identified by @a name),
4754	at the indicated port and device.
4755
4756	This method is intended for managing storage devices in general while a
4757	machine is powered off. It can be used to attach and detach fixed
4758	and removable media. The following kind of media can be attached
4759	to a machine:
4760
4761	<ul>
4762	<li>For fixed and removable media, you can pass in a medium that was
4763	previously opened using <link to="IVirtualBox::openMedium" />.
4764	</li>
4765
4766	<li>Only for storage devices supporting removable media (such as
4767	DVDs and floppies), you can also specify a null pointer to
4768	indicate an empty drive or one of the medium objects listed
4769	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4770	arrays to indicate a host drive.
4771	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4772	to change the media while the machine is running.
4773	</li>
4774	</ul>
4775
4776	In a VM's default configuration of virtual machines, the secondary
4777	master of the IDE controller is used for a CD/DVD drive.
4778
4779	After calling this returns successfully, a new instance of
4780	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4781	attachments (see <link to="IMachine::mediumAttachments"/>).
4782
4783	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4784	information about attaching media.
4785
4786	The specified device slot must not have a device attached to it,
4787	or this method will fail.
4788
4789	<note>
4790	You cannot attach a device to a newly created machine until
4791	this machine's settings are saved to disk using
4792	<link to="#saveSettings"/>.
4793	</note>
4794	<note>
4795	If the medium is being attached indirectly, a new differencing medium
4796	will implicitly be created for it and attached instead. If the
4797	changes made to the machine settings (including this indirect
4798	attachment) are later cancelled using <link to="#discardSettings"/>,
4799	this implicitly created differencing medium will implicitly
4800	be deleted.
4801	</note>
4802
4803	<result name="E_INVALIDARG">
4804	SATA device, SATA port, IDE port or IDE slot out of range, or
4805	file or UUID not found.
4806	</result>
4807	<result name="VBOX_E_INVALID_OBJECT_STATE">
4808	Machine must be registered before media can be attached.
4809	</result>
4810	<result name="VBOX_E_INVALID_VM_STATE">
4811	Invalid machine state.
4812	</result>
4813	<result name="VBOX_E_OBJECT_IN_USE">
4814	A medium is already attached to this or another virtual machine.
4815	</result>
4816
4817	</desc>
4818	<param name="name" type="wstring" dir="in">
4819	<desc>Name of the storage controller to attach the device to.</desc>
4820	</param>
4821	<param name="controllerPort" type="long" dir="in">
4822	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4823	the primary controller and 1 specifies the secondary controller.
4824	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4825	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4826	</param>
4827	<param name="device" type="long" dir="in">
4828	<desc>Device slot in the given port to attach the device to. This is only
4829	relevant for IDE controllers, for which 0 specifies the master device and
4830	1 specifies the slave device. For all other controller types, this must
4831	be 0.</desc>
4832	</param>
4833	<param name="type" type="DeviceType" dir="in">
4834	<desc>Device type of the attached device. For media opened by
4835	<link to="IVirtualBox::openMedium" />, this must match the device type
4836	specified there.</desc>
4837	</param>
4838	<param name="medium" type="IMedium" dir="in">
4839	<desc>Medium to mount or @c null for an empty drive.</desc>
4840	</param>
4841	</method>
4842
4843	<method name="attachDeviceWithoutMedium">
4844	<desc>
4845	Attaches a device and optionally mounts a medium to the given storage
4846	controller (<link to="IStorageController" />, identified by @a name),
4847	at the indicated port and device.
4848
4849	This method is intended for managing storage devices in general while a
4850	machine is powered off. It can be used to attach and detach fixed
4851	and removable media. The following kind of media can be attached
4852	to a machine:
4853	<ul>
4854	<li>
4855	For fixed and removable media, you can pass in a medium that was
4856	previously opened using <link to="IVirtualBox::openMedium" />.
4857	</li>
4858
4859	<li>Only for storage devices supporting removable media (such as
4860	DVDs and floppies) with an empty drive or one of the medium objects listed
4861	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4862	arrays to indicate a host drive.
4863	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4864	to change the media while the machine is running.
4865	</li>
4866	</ul>
4867
4868	In a VM's default configuration of virtual machines, the secondary
4869	master of the IDE controller is used for a CD/DVD drive.
4870	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4871	attachments (see <link to="IMachine::mediumAttachments"/>).
4872
4873	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4874	information about attaching media.
4875
4876	The specified device slot must not have a device attached to it,
4877	or this method will fail.
4878	<note>
4879	You cannot attach a device to a newly created machine until
4880	this machine's settings are saved to disk using
4881	<link to="#saveSettings"/>.
4882	</note>
4883	<note>
4884	If the medium is being attached indirectly, a new differencing medium
4885	will implicitly be created for it and attached instead. If the
4886	changes made to the machine settings (including this indirect
4887	attachment) are later cancelled using <link to="#discardSettings"/>,
4888	this implicitly created differencing medium will implicitly
4889	be deleted.
4890	</note>
4891
4892	<result name="E_INVALIDARG">
4893	SATA device, SATA port, IDE port or IDE slot out of range, or
4894	file or UUID not found.
4895	</result>
4896	<result name="VBOX_E_INVALID_OBJECT_STATE">
4897	Machine must be registered before media can be attached.
4898	</result>
4899	<result name="VBOX_E_INVALID_VM_STATE">
4900	Invalid machine state.
4901	</result>
4902	<result name="VBOX_E_OBJECT_IN_USE">
4903	A medium is already attached to this or another virtual machine.
4904	</result>
4905	</desc>
4906	<param name="name" type="wstring" dir="in">
4907	<desc>Name of the storage controller to attach the device to.</desc>
4908	</param>
4909	<param name="controllerPort" type="long" dir="in">
4910	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4911	the primary controller and 1 specifies the secondary controller.
4912	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4913	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4914	</param>
4915	<param name="device" type="long" dir="in">
4916	<desc>Device slot in the given port to attach the device to. This is only
4917	relevant for IDE controllers, for which 0 specifies the master device and
4918	1 specifies the slave device. For all other controller types, this must
4919	be 0.</desc>
4920	</param>
4921	<param name="type" type="DeviceType" dir="in">
4922	<desc>Device type of the attached device. For media opened by
4923	<link to="IVirtualBox::openMedium" />, this must match the device type
4924	specified there.</desc>
4925	</param>
4926	</method>
4927
4928	<method name="detachDevice">
4929	<desc>
4930	Detaches the device attached to a device slot of the specified bus.
4931
4932	Detaching the device from the virtual machine is deferred. This means
4933	that the medium remains associated with the machine when this method
4934	returns and gets actually de-associated only after a successful
4935	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4936	for more detailed information about attaching media.
4937
4938	<note>
4939	You cannot detach a device from a running machine.
4940	</note>
4941	<note>
4942	Detaching differencing media implicitly created by <link
4943	to="#attachDevice"/> for the indirect attachment using this
4944	method will <b>not</b> implicitly delete them. The
4945	<link to="IMedium::deleteStorage"/> operation should be
4946	explicitly performed by the caller after the medium is successfully
4947	detached and the settings are saved with
4948	<link to="#saveSettings"/>, if it is the desired action.
4949	</note>
4950
4951	<result name="VBOX_E_INVALID_VM_STATE">
4952	Attempt to detach medium from a running virtual machine.
4953	</result>
4954	<result name="VBOX_E_OBJECT_NOT_FOUND">
4955	No medium attached to given slot/bus.
4956	</result>
4957	<result name="VBOX_E_NOT_SUPPORTED">
4958	Medium format does not support storage deletion (only for implicitly
4959	created differencing media, should not happen).
4960	</result>
4961
4962	</desc>
4963	<param name="name" type="wstring" dir="in">
4964	<desc>Name of the storage controller to detach the medium from.</desc>
4965	</param>
4966	<param name="controllerPort" type="long" dir="in">
4967	<desc>Port number to detach the medium from.</desc>
4968	</param>
4969	<param name="device" type="long" dir="in">
4970	<desc>Device slot number to detach the medium from.</desc>
4971	</param>
4972	</method>
4973
4974	<method name="passthroughDevice">
4975	<desc>
4976	Sets the passthrough mode of an existing DVD device. Changing the
4977	setting while the VM is running is forbidden. The setting is only used
4978	if at VM start the device is configured as a host DVD drive, in all
4979	other cases it is ignored. The device must already exist; see
4980	<link to="IMachine::attachDevice"/> for how to attach a new device.
4981
4982	The @a controllerPort and @a device parameters specify the device slot and
4983	have have the same meaning as with <link to="IMachine::attachDevice" />.
4984
4985	<result name="E_INVALIDARG">
4986	SATA device, SATA port, IDE port or IDE slot out of range.
4987	</result>
4988	<result name="VBOX_E_INVALID_OBJECT_STATE">
4989	Attempt to modify an unregistered virtual machine.
4990	</result>
4991	<result name="VBOX_E_INVALID_VM_STATE">
4992	Invalid machine state.
4993	</result>
4994
4995	</desc>
4996	<param name="name" type="wstring" dir="in">
4997	<desc>Name of the storage controller.</desc>
4998	</param>
4999	<param name="controllerPort" type="long" dir="in">
5000	<desc>Storage controller port.</desc>
5001	</param>
5002	<param name="device" type="long" dir="in">
5003	<desc>Device slot in the given port.</desc>
5004	</param>
5005	<param name="passthrough" type="boolean" dir="in">
5006	<desc>New value for the passthrough setting.</desc>
5007	</param>
5008	</method>
5009
5010	<method name="temporaryEjectDevice">
5011	<desc>
5012	Sets the behavior for guest-triggered medium eject. In some situations
5013	it is desirable that such ejects update the VM configuration, and in
5014	others the eject should keep the VM configuration. The device must
5015	already exist; see <link to="IMachine::attachDevice"/> for how to
5016	attach a new device.
5017
5018	The @a controllerPort and @a device parameters specify the device slot and
5019	have have the same meaning as with <link to="IMachine::attachDevice" />.
5020
5021	<result name="E_INVALIDARG">
5022	SATA device, SATA port, IDE port or IDE slot out of range.
5023	</result>
5024	<result name="VBOX_E_INVALID_OBJECT_STATE">
5025	Attempt to modify an unregistered virtual machine.
5026	</result>
5027	<result name="VBOX_E_INVALID_VM_STATE">
5028	Invalid machine state.
5029	</result>
5030
5031	</desc>
5032	<param name="name" type="wstring" dir="in">
5033	<desc>Name of the storage controller.</desc>
5034	</param>
5035	<param name="controllerPort" type="long" dir="in">
5036	<desc>Storage controller port.</desc>
5037	</param>
5038	<param name="device" type="long" dir="in">
5039	<desc>Device slot in the given port.</desc>
5040	</param>
5041	<param name="temporaryEject" type="boolean" dir="in">
5042	<desc>New value for the eject behavior.</desc>
5043	</param>
5044	</method>
5045
5046	<method name="nonRotationalDevice">
5047	<desc>
5048	Sets a flag in the device information which indicates that the medium
5049	is not based on rotational technology, i.e. that the access times are
5050	more or less independent of the position on the medium. This may or may
5051	not be supported by a particular drive, and is silently ignored in the
5052	latter case. At the moment only hard disks (which is a misnomer in this
5053	context) accept this setting. Changing the setting while the VM is
5054	running is forbidden. The device must already exist; see
5055	<link to="IMachine::attachDevice"/> for how to attach a new device.
5056
5057	The @a controllerPort and @a device parameters specify the device slot and
5058	have have the same meaning as with <link to="IMachine::attachDevice" />.
5059
5060	<result name="E_INVALIDARG">
5061	SATA device, SATA port, IDE port or IDE slot out of range.
5062	</result>
5063	<result name="VBOX_E_INVALID_OBJECT_STATE">
5064	Attempt to modify an unregistered virtual machine.
5065	</result>
5066	<result name="VBOX_E_INVALID_VM_STATE">
5067	Invalid machine state.
5068	</result>
5069
5070	</desc>
5071	<param name="name" type="wstring" dir="in">
5072	<desc>Name of the storage controller.</desc>
5073	</param>
5074	<param name="controllerPort" type="long" dir="in">
5075	<desc>Storage controller port.</desc>
5076	</param>
5077	<param name="device" type="long" dir="in">
5078	<desc>Device slot in the given port.</desc>
5079	</param>
5080	<param name="nonRotational" type="boolean" dir="in">
5081	<desc>New value for the non-rotational device flag.</desc>
5082	</param>
5083	</method>
5084
5085	<method name="setAutoDiscardForDevice">
5086	<desc>
5087	Sets a flag in the device information which indicates that the medium
5088	supports discarding unsused blocks (called trimming for SATA or unmap
5089	for SCSI devices) .This may or may not be supported by a particular drive,
5090	and is silently ignored in the latter case. At the moment only hard disks
5091	(which is a misnomer in this context) accept this setting. Changing the
5092	setting while the VM is running is forbidden. The device must already
5093	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
5094	device.
5095
5096	The @a controllerPort and @a device parameters specify the device slot and
5097	have have the same meaning as with <link to="IMachine::attachDevice" />.
5098
5099	<result name="E_INVALIDARG">
5100	SATA device, SATA port, SCSI port out of range.
5101	</result>
5102	<result name="VBOX_E_INVALID_OBJECT_STATE">
5103	Attempt to modify an unregistered virtual machine.
5104	</result>
5105	<result name="VBOX_E_INVALID_VM_STATE">
5106	Invalid machine state.
5107	</result>
5108
5109	</desc>
5110	<param name="name" type="wstring" dir="in">
5111	<desc>Name of the storage controller.</desc>
5112	</param>
5113	<param name="controllerPort" type="long" dir="in">
5114	<desc>Storage controller port.</desc>
5115	</param>
5116	<param name="device" type="long" dir="in">
5117	<desc>Device slot in the given port.</desc>
5118	</param>
5119	<param name="discard" type="boolean" dir="in">
5120	<desc>New value for the discard device flag.</desc>
5121	</param>
5122	</method>
5123
5124	<method name="setBandwidthGroupForDevice">
5125	<desc>
5126	Sets the bandwidth group of an existing storage device.
5127	The device must already exist; see <link to="IMachine::attachDevice"/>
5128	for how to attach a new device.
5129
5130	The @a controllerPort and @a device parameters specify the device slot and
5131	have have the same meaning as with <link to="IMachine::attachDevice" />.
5132
5133	<result name="E_INVALIDARG">
5134	SATA device, SATA port, IDE port or IDE slot out of range.
5135	</result>
5136	<result name="VBOX_E_INVALID_OBJECT_STATE">
5137	Attempt to modify an unregistered virtual machine.
5138	</result>
5139	<result name="VBOX_E_INVALID_VM_STATE">
5140	Invalid machine state.
5141	</result>
5142
5143	</desc>
5144	<param name="name" type="wstring" dir="in">
5145	<desc>Name of the storage controller.</desc>
5146	</param>
5147	<param name="controllerPort" type="long" dir="in">
5148	<desc>Storage controller port.</desc>
5149	</param>
5150	<param name="device" type="long" dir="in">
5151	<desc>Device slot in the given port.</desc>
5152	</param>
5153	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
5154	<desc>New value for the bandwidth group or @c null for no group.</desc>
5155	</param>
5156	</method>
5157
5158	<method name="setNoBandwidthGroupForDevice">
5159	<desc>
5160	Sets no bandwidth group for an existing storage device.
5161	The device must already exist; see <link to="IMachine::attachDevice"/>
5162	for how to attach a new device.
5163	The @a controllerPort and @a device parameters specify the device slot and
5164	have have the same meaning as with <link to="IMachine::attachDevice" />.
5165	<result name="E_INVALIDARG">
5166	SATA device, SATA port, IDE port or IDE slot out of range.
5167	</result>
5168	<result name="VBOX_E_INVALID_OBJECT_STATE">
5169	Attempt to modify an unregistered virtual machine.
5170	</result>
5171	<result name="VBOX_E_INVALID_VM_STATE">
5172	Invalid machine state.
5173	</result>
5174
5175	</desc>
5176	<param name="name" type="wstring" dir="in">
5177	<desc>Name of the storage controller.</desc>
5178	</param>
5179	<param name="controllerPort" type="long" dir="in">
5180	<desc>Storage controller port.</desc>
5181	</param>
5182	<param name="device" type="long" dir="in">
5183	<desc>Device slot in the given port.</desc>
5184	</param>
5185	</method>
5186
5187
5188	<method name="unmountMedium">
5189	<desc>
5190	Unmounts any currently mounted medium (<link to="IMedium" />,
5191	identified by the given UUID @a id) to the given storage controller
5192	(<link to="IStorageController" />, identified by @a name),
5193	at the indicated port and device. The device must already exist;
5194
5195	This method is intended only for managing removable media, where the
5196	device is fixed but media is changeable at runtime (such as DVDs
5197	and floppies). It cannot be used for fixed media such as hard disks.
5198
5199	The @a controllerPort and @a device parameters specify the device slot
5200	and have have the same meaning as with
5201	<link to="IMachine::attachDevice" />.
5202
5203	The specified device slot must have a medium mounted, which will be
5204	unmounted. If there is no mounted medium it will do nothing.
5205	See <link to="IMedium"/> for more detailed information about
5206	attaching/unmounting media.
5207
5208	<result name="E_INVALIDARG">
5209	SATA device, SATA port, IDE port or IDE slot out of range.
5210	</result>
5211	<result name="VBOX_E_INVALID_OBJECT_STATE">
5212	Attempt to unmount medium that is not removeable - not dvd or floppy.
5213	</result>
5214	<result name="VBOX_E_INVALID_VM_STATE">
5215	Invalid machine state.
5216	</result>
5217	<result name="VBOX_E_OBJECT_IN_USE">
5218	Medium already attached to this or another virtual machine.
5219	</result>
5220	<result name="VBOX_E_OBJECT_NOT_FOUND">
5221	Medium not attached to specified port, device, controller.
5222	</result>
5223
5224	</desc>
5225	<param name="name" type="wstring" dir="in">
5226	<desc>Name of the storage controller to unmount the medium from.</desc>
5227	</param>
5228	<param name="controllerPort" type="long" dir="in">
5229	<desc>Port to unmount the medium from.</desc>
5230	</param>
5231	<param name="device" type="long" dir="in">
5232	<desc>Device slot in the given port to unmount the medium from.</desc>
5233	</param>
5234	<param name="force" type="boolean" dir="in">
5235	<desc>Allows to force unmount of a medium which is locked by
5236	the device slot in the given port medium is attached to.</desc>
5237	</param>
5238	</method>
5239
5240	<method name="mountMedium">
5241	<desc>
5242	Mounts a medium (<link to="IMedium" />, identified
5243	by the given UUID @a id) to the given storage controller
5244	(<link to="IStorageController" />, identified by @a name),
5245	at the indicated port and device. The device must already exist;
5246	see <link to="IMachine::attachDevice"/> for how to attach a new device.
5247
5248	This method is intended only for managing removable media, where the
5249	device is fixed but media is changeable at runtime (such as DVDs
5250	and floppies). It cannot be used for fixed media such as hard disks.
5251
5252	The @a controllerPort and @a device parameters specify the device slot and
5253	have have the same meaning as with <link to="IMachine::attachDevice" />.
5254
5255	The specified device slot can have a medium mounted, which will be
5256	unmounted first. Specifying a zero UUID (or an empty string) for
5257	@a medium does just an unmount.
5258
5259	See <link to="IMedium"/> for more detailed information about
5260	attaching media.
5261
5262	<result name="E_INVALIDARG">
5263	SATA device, SATA port, IDE port or IDE slot out of range.
5264	</result>
5265	<result name="VBOX_E_INVALID_OBJECT_STATE">
5266	Attempt to attach medium to an unregistered virtual machine.
5267	</result>
5268	<result name="VBOX_E_INVALID_VM_STATE">
5269	Invalid machine state.
5270	</result>
5271	<result name="VBOX_E_OBJECT_IN_USE">
5272	Medium already attached to this or another virtual machine.
5273	</result>
5274
5275	</desc>
5276	<param name="name" type="wstring" dir="in">
5277	<desc>Name of the storage controller to attach the medium to.</desc>
5278	</param>
5279	<param name="controllerPort" type="long" dir="in">
5280	<desc>Port to attach the medium to.</desc>
5281	</param>
5282	<param name="device" type="long" dir="in">
5283	<desc>Device slot in the given port to attach the medium to.</desc>
5284	</param>
5285	<param name="medium" type="IMedium" dir="in">
5286	<desc>Medium to mount or @c null for an empty drive.</desc>
5287	</param>
5288	<param name="force" type="boolean" dir="in">
5289	<desc>Allows to force unmount/mount of a medium which is locked by
5290	the device slot in the given port to attach the medium to.</desc>
5291	</param>
5292	</method>
5293
5294	<method name="getMedium" const="yes">
5295	<desc>
5296	Returns the virtual medium attached to a device slot of the specified
5297	bus.
5298
5299	Note that if the medium was indirectly attached by
5300	<link to="#mountMedium"/> to the given device slot then this
5301	method will return not the same object as passed to the
5302	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5303	more detailed information about mounting a medium.
5304
5305	<result name="VBOX_E_OBJECT_NOT_FOUND">
5306	No medium attached to given slot/bus.
5307	</result>
5308
5309	</desc>
5310	<param name="name" type="wstring" dir="in">
5311	<desc>Name of the storage controller the medium is attached to.</desc>
5312	</param>
5313	<param name="controllerPort" type="long" dir="in">
5314	<desc>Port to query.</desc>
5315	</param>
5316	<param name="device" type="long" dir="in">
5317	<desc>Device slot in the given port to query.</desc>
5318	</param>
5319	<param name="medium" type="IMedium" dir="return">
5320	<desc>Attached medium object.</desc>
5321	</param>
5322	</method>
5323
5324	<method name="getMediumAttachmentsOfController" const="yes">
5325	<desc>
5326	Returns an array of medium attachments which are attached to the
5327	the controller with the given name.
5328
5329	<result name="VBOX_E_OBJECT_NOT_FOUND">
5330	A storage controller with given name doesn't exist.
5331	</result>
5332	</desc>
5333	<param name="name" type="wstring" dir="in"/>
5334	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5335	</method>
5336
5337	<method name="getMediumAttachment" const="yes">
5338	<desc>
5339	Returns a medium attachment which corresponds to the controller with
5340	the given name, on the given port and device slot.
5341
5342	<result name="VBOX_E_OBJECT_NOT_FOUND">
5343	No attachment exists for the given controller/port/device combination.
5344	</result>
5345	</desc>
5346	<param name="name" type="wstring" dir="in"/>
5347	<param name="controllerPort" type="long" dir="in"/>
5348	<param name="device" type="long" dir="in"/>
5349	<param name="attachment" type="IMediumAttachment" dir="return"/>
5350	</method>
5351
5352	<method name="attachHostPCIDevice">
5353	<desc>
5354	Attaches host PCI device with the given (host) PCI address to the
5355	PCI bus of the virtual machine. Please note, that this operation
5356	is two phase, as real attachment will happen when VM will start,
5357	and most information will be delivered as IHostPCIDevicePlugEvent
5358	on IVirtualBox event source.
5359
5360	<see><link to="IHostPCIDevicePlugEvent"/></see>
5361
5362	<result name="VBOX_E_INVALID_VM_STATE">
5363	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5364	</result>
5365	<result name="VBOX_E_PDM_ERROR">
5366	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5367	</result>
5368	<result name="VBOX_E_NOT_SUPPORTED">
5369	Hardware or host OS doesn't allow PCI device passthrought.
5370	</result>
5371	</desc>
5372	<param name="hostAddress" type="long" dir="in">
5373	<desc>Address of the host PCI device.</desc>
5374	</param>
5375	<param name="desiredGuestAddress" type="long" dir="in">
5376	<desc>Desired position of this device on guest PCI bus.</desc>
5377	</param>
5378	<param name="tryToUnbind" type="boolean" dir="in">
5379	<desc>If VMM shall try to unbind existing drivers from the
5380	device before attaching it to the guest.</desc>
5381	</param>
5382	</method>
5383
5384	<method name="detachHostPCIDevice">
5385	<desc>
5386	Detach host PCI device from the virtual machine.
5387	Also HostPCIDevicePlugEvent on IVirtualBox event source
5388	will be delivered. As currently we don't support hot device
5389	unplug, IHostPCIDevicePlugEvent event is delivered immediately.
5390
5391	<see><link to="IHostPCIDevicePlugEvent"/></see>
5392
5393	<result name="VBOX_E_INVALID_VM_STATE">
5394	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5395	</result>
5396	<result name="VBOX_E_OBJECT_NOT_FOUND">
5397	This host device is not attached to this machine.
5398	</result>
5399	<result name="VBOX_E_PDM_ERROR">
5400	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5401	</result>
5402	<result name="VBOX_E_NOT_SUPPORTED">
5403	Hardware or host OS doesn't allow PCI device passthrought.
5404	</result>
5405	</desc>
5406	<param name="hostAddress" type="long" dir="in">
5407	<desc>Address of the host PCI device.</desc>
5408	</param>
5409	</method>
5410
5411	<method name="getNetworkAdapter" const="yes">
5412	<desc>
5413	Returns the network adapter associated with the given slot.
5414	Slots are numbered sequentially, starting with zero. The total
5415	number of adapters per machine is defined by the
5416	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5417	so the maximum slot number is one less than that property's value.
5418
5419	<result name="E_INVALIDARG">
5420	Invalid @a slot number.
5421	</result>
5422
5423	</desc>
5424	<param name="slot" type="unsigned long" dir="in"/>
5425	<param name="adapter" type="INetworkAdapter" dir="return"/>
5426	</method>
5427
5428	<method name="addStorageController">
5429	<desc>
5430	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5431	machine and returns it as an instance of
5432	<link to="IStorageController" />.
5433
5434	@a name identifies the controller for subsequent calls such as
5435	<link to="#getStorageControllerByName" />,
5436	<link to="#getStorageControllerByInstance" />,
5437	<link to="#removeStorageController" />,
5438	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5439
5440	After the controller has been added, you can set its exact
5441	type by setting the <link to="IStorageController::controllerType" />.
5442
5443	<result name="VBOX_E_OBJECT_IN_USE">
5444	A storage controller with given name exists already.
5445	</result>
5446	<result name="E_INVALIDARG">
5447	Invalid @a controllerType.
5448	</result>
5449	</desc>
5450	<param name="name" type="wstring" dir="in"/>
5451	<param name="connectionType" type="StorageBus" dir="in"/>
5452	<param name="controller" type="IStorageController" dir="return"/>
5453	</method>
5454
5455	<method name="getStorageControllerByName" const="yes">
5456	<desc>
5457	Returns a storage controller with the given name.
5458
5459	<result name="VBOX_E_OBJECT_NOT_FOUND">
5460	A storage controller with given name doesn't exist.
5461	</result>
5462	</desc>
5463	<param name="name" type="wstring" dir="in"/>
5464	<param name="storageController" type="IStorageController" dir="return"/>
5465	</method>
5466
5467	<method name="getStorageControllerByInstance" const="yes">
5468	<desc>
5469	Returns a storage controller with the given instance number.
5470
5471	<result name="VBOX_E_OBJECT_NOT_FOUND">
5472	A storage controller with given instance number doesn't exist.
5473	</result>
5474	</desc>
5475	<param name="instance" type="unsigned long" dir="in"/>
5476	<param name="storageController" type="IStorageController" dir="return"/>
5477	</method>
5478
5479	<method name="removeStorageController">
5480	<desc>
5481	Removes a storage controller from the machine with all devices attached to it.
5482
5483	<result name="VBOX_E_OBJECT_NOT_FOUND">
5484	A storage controller with given name doesn't exist.
5485	</result>
5486	<result name="VBOX_E_NOT_SUPPORTED">
5487	Medium format does not support storage deletion (only for implicitly
5488	created differencing media, should not happen).
5489	</result>
5490	</desc>
5491	<param name="name" type="wstring" dir="in"/>
5492	</method>
5493
5494	<method name="setStorageControllerBootable">
5495	<desc>
5496	Sets the bootable flag of the storage controller with the given name.
5497
5498	<result name="VBOX_E_OBJECT_NOT_FOUND">
5499	A storage controller with given name doesn't exist.
5500	</result>
5501	<result name="VBOX_E_OBJECT_IN_USE">
5502	Another storage controller is marked as bootable already.
5503	</result>
5504	</desc>
5505	<param name="name" type="wstring" dir="in"/>
5506	<param name="bootable" type="boolean" dir="in"/>
5507	</method>
5508
5509	<method name="getSerialPort" const="yes">
5510	<desc>
5511	Returns the serial port associated with the given slot.
5512	Slots are numbered sequentially, starting with zero. The total
5513	number of serial ports per machine is defined by the
5514	<link to="ISystemProperties::serialPortCount"/> property,
5515	so the maximum slot number is one less than that property's value.
5516
5517	<result name="E_INVALIDARG">
5518	Invalid @a slot number.
5519	</result>
5520
5521	</desc>
5522	<param name="slot" type="unsigned long" dir="in"/>
5523	<param name="port" type="ISerialPort" dir="return"/>
5524	</method>
5525
5526	<method name="getParallelPort" const="yes">
5527	<desc>
5528	Returns the parallel port associated with the given slot.
5529	Slots are numbered sequentially, starting with zero. The total
5530	number of parallel ports per machine is defined by the
5531	<link to="ISystemProperties::parallelPortCount"/> property,
5532	so the maximum slot number is one less than that property's value.
5533
5534	<result name="E_INVALIDARG">
5535	Invalid @a slot number.
5536	</result>
5537
5538	</desc>
5539	<param name="slot" type="unsigned long" dir="in"/>
5540	<param name="port" type="IParallelPort" dir="return"/>
5541	</method>
5542
5543	<method name="getExtraDataKeys">
5544	<desc>
5545	Returns an array representing the machine-specific extra data keys
5546	which currently have values defined.
5547	</desc>
5548	<param name="value" type="wstring" dir="return" safearray="yes">
5549	<desc>Array of extra data keys.</desc>
5550	</param>
5551	</method>
5552
5553	<method name="getExtraData">
5554	<desc>
5555	Returns associated machine-specific extra data.
5556
5557	If the requested data @a key does not exist, this function will
5558	succeed and return an empty string in the @a value argument.
5559
5560	<result name="VBOX_E_FILE_ERROR">
5561	Settings file not accessible.
5562	</result>
5563	<result name="VBOX_E_XML_ERROR">
5564	Could not parse the settings file.
5565	</result>
5566
5567	</desc>
5568	<param name="key" type="wstring" dir="in">
5569	<desc>Name of the data key to get.</desc>
5570	</param>
5571	<param name="value" type="wstring" dir="return">
5572	<desc>Value of the requested data key.</desc>
5573	</param>
5574	</method>
5575
5576	<method name="setExtraData">
5577	<desc>
5578	Sets associated machine-specific extra data.
5579
5580	If you pass @c null or an empty string as a key @a value, the given
5581	@a key will be deleted.
5582
5583	<note>
5584	Before performing the actual data change, this method will ask all
5585	registered listeners using the
5586	<link to="IExtraDataCanChangeEvent"/>
5587	notification for a permission. If one of the listeners refuses the
5588	new value, the change will not be performed.
5589	</note>
5590	<note>
5591	On success, the
5592	<link to="IExtraDataChangedEvent"/> notification
5593	is called to inform all registered listeners about a successful data
5594	change.
5595	</note>
5596	<note>
5597	This method can be called outside the machine session and therefore
5598	it's a caller's responsibility to handle possible race conditions
5599	when several clients change the same key at the same time.
5600	</note>
5601
5602	<result name="VBOX_E_FILE_ERROR">
5603	Settings file not accessible.
5604	</result>
5605	<result name="VBOX_E_XML_ERROR">
5606	Could not parse the settings file.
5607	</result>
5608
5609	</desc>
5610	<param name="key" type="wstring" dir="in">
5611	<desc>Name of the data key to set.</desc>
5612	</param>
5613	<param name="value" type="wstring" dir="in">
5614	<desc>Value to assign to the key.</desc>
5615	</param>
5616	</method>
5617
5618	<method name="getCPUProperty" const="yes">
5619	<desc>
5620	Returns the virtual CPU boolean value of the specified property.
5621
5622	<result name="E_INVALIDARG">
5623	Invalid property.
5624	</result>
5625
5626	</desc>
5627	<param name="property" type="CPUPropertyType" dir="in">
5628	<desc>
5629	Property type to query.
5630	</desc>
5631	</param>
5632	<param name="value" type="boolean" dir="return">
5633	<desc>
5634	Property value.
5635	</desc>
5636	</param>
5637	</method>
5638
5639	<method name="setCPUProperty">
5640	<desc>
5641	Sets the virtual CPU boolean value of the specified property.
5642
5643	<result name="E_INVALIDARG">
5644	Invalid property.
5645	</result>
5646
5647	</desc>
5648	<param name="property" type="CPUPropertyType" dir="in">
5649	<desc>
5650	Property type to query.
5651	</desc>
5652	</param>
5653	<param name="value" type="boolean" dir="in">
5654	<desc>
5655	Property value.
5656	</desc>
5657	</param>
5658	</method>
5659
5660	<method name="getCPUIDLeaf" const="yes">
5661	<desc>
5662	Returns the virtual CPU cpuid information for the specified leaf.
5663
5664	Currently supported index values for cpuid:
5665	Standard CPUID leafs: 0 - 0xA
5666	Extended CPUID leafs: 0x80000000 - 0x8000000A
5667
5668	See the Intel and AMD programmer's manuals for detailed information
5669	about the cpuid instruction and its leafs.
5670	<result name="E_INVALIDARG">
5671	Invalid id.
5672	</result>
5673
5674	</desc>
5675	<param name="id" type="unsigned long" dir="in">
5676	<desc>
5677	CPUID leaf index.
5678	</desc>
5679	</param>
5680	<param name="valEax" type="unsigned long" dir="out">
5681	<desc>
5682	CPUID leaf value for register eax.
5683	</desc>
5684	</param>
5685	<param name="valEbx" type="unsigned long" dir="out">
5686	<desc>
5687	CPUID leaf value for register ebx.
5688	</desc>
5689	</param>
5690	<param name="valEcx" type="unsigned long" dir="out">
5691	<desc>
5692	CPUID leaf value for register ecx.
5693	</desc>
5694	</param>
5695	<param name="valEdx" type="unsigned long" dir="out">
5696	<desc>
5697	CPUID leaf value for register edx.
5698	</desc>
5699	</param>
5700	</method>
5701
5702	<method name="setCPUIDLeaf">
5703	<desc>
5704	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5705	are not passed unmodified. VirtualBox clears features that it doesn't support.
5706
5707	Currently supported index values for cpuid:
5708	Standard CPUID leafs: 0 - 0xA
5709	Extended CPUID leafs: 0x80000000 - 0x8000000A
5710
5711	See the Intel and AMD programmer's manuals for detailed information
5712	about the cpuid instruction and its leafs.
5713
5714	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5715	random crashes inside VMs.
5716	<result name="E_INVALIDARG">
5717	Invalid id.
5718	</result>
5719
5720	</desc>
5721	<param name="id" type="unsigned long" dir="in">
5722	<desc>
5723	CPUID leaf index.
5724	</desc>
5725	</param>
5726	<param name="valEax" type="unsigned long" dir="in">
5727	<desc>
5728	CPUID leaf value for register eax.
5729	</desc>
5730	</param>
5731	<param name="valEbx" type="unsigned long" dir="in">
5732	<desc>
5733	CPUID leaf value for register ebx.
5734	</desc>
5735	</param>
5736	<param name="valEcx" type="unsigned long" dir="in">
5737	<desc>
5738	CPUID leaf value for register ecx.
5739	</desc>
5740	</param>
5741	<param name="valEdx" type="unsigned long" dir="in">
5742	<desc>
5743	CPUID leaf value for register edx.
5744	</desc>
5745	</param>
5746	</method>
5747
5748	<method name="removeCPUIDLeaf">
5749	<desc>
5750	Removes the virtual CPU cpuid leaf for the specified index
5751
5752	<result name="E_INVALIDARG">
5753	Invalid id.
5754	</result>
5755
5756	</desc>
5757	<param name="id" type="unsigned long" dir="in">
5758	<desc>
5759	CPUID leaf index.
5760	</desc>
5761	</param>
5762	</method>
5763
5764	<method name="removeAllCPUIDLeaves">
5765	<desc>
5766	Removes all the virtual CPU cpuid leaves
5767	</desc>
5768	</method>
5769
5770	<method name="getHWVirtExProperty" const="yes">
5771	<desc>
5772	Returns the value of the specified hardware virtualization boolean property.
5773
5774	<result name="E_INVALIDARG">
5775	Invalid property.
5776	</result>
5777
5778	</desc>
5779	<param name="property" type="HWVirtExPropertyType" dir="in">
5780	<desc>
5781	Property type to query.
5782	</desc>
5783	</param>
5784	<param name="value" type="boolean" dir="return">
5785	<desc>
5786	Property value.
5787	</desc>
5788	</param>
5789	</method>
5790
5791	<method name="setHWVirtExProperty">
5792	<desc>
5793	Sets a new value for the specified hardware virtualization boolean property.
5794
5795	<result name="E_INVALIDARG">
5796	Invalid property.
5797	</result>
5798
5799	</desc>
5800	<param name="property" type="HWVirtExPropertyType" dir="in">
5801	<desc>
5802	Property type to set.
5803	</desc>
5804	</param>
5805	<param name="value" type="boolean" dir="in">
5806	<desc>
5807	New property value.
5808	</desc>
5809	</param>
5810	</method>
5811
5812	<method name="saveSettings">
5813	<desc>
5814	Saves any changes to machine settings made since the session
5815	has been opened or a new machine has been created, or since the
5816	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5817	For registered machines, new settings become visible to all
5818	other VirtualBox clients after successful invocation of this
5819	method.
5820	<note>
5821	The method sends <link to="IMachineDataChangedEvent"/>
5822	notification event after the configuration has been successfully
5823	saved (only for registered machines).
5824	</note>
5825	<note>
5826	Calling this method is only valid on instances returned
5827	by <link to="ISession::machine"/> and on new machines
5828	created by <link to="IVirtualBox::createMachine"/> but not
5829	yet registered, or on unregistered machines after calling
5830	<link to="IMachine::unregister"/>.
5831	</note>
5832
5833	<result name="VBOX_E_FILE_ERROR">
5834	Settings file not accessible.
5835	</result>
5836	<result name="VBOX_E_XML_ERROR">
5837	Could not parse the settings file.
5838	</result>
5839	<result name="E_ACCESSDENIED">
5840	Modification request refused.
5841	</result>
5842
5843	</desc>
5844	</method>
5845
5846	<method name="discardSettings">
5847	<desc>
5848	Discards any changes to the machine settings made since the session
5849	has been opened or since the last call to <link to="#saveSettings"/>
5850	or <link to="#discardSettings"/>.
5851	<note>
5852	Calling this method is only valid on instances returned
5853	by <link to="ISession::machine"/> and on new machines
5854	created by <link to="IVirtualBox::createMachine"/> or
5855	opened by <link to="IVirtualBox::openMachine"/> but not
5856	yet registered, or on unregistered machines after calling
5857	<link to="IMachine::unregister"/>.
5858	</note>
5859
5860	<result name="VBOX_E_INVALID_VM_STATE">
5861	Virtual machine is not mutable.
5862	</result>
5863
5864	</desc>
5865	</method>
5866
5867	<method name="unregister">
5868	<desc>
5869	Unregisters a machine previously registered with
5870	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5871	cleanup before the machine is unregistered.
5872
5873	This method does not delete any files. It only changes the machine configuration and
5874	the list of registered machines in the VirtualBox object. To delete the files which
5875	belonged to the machine, including the XML file of the machine itself, call
5876	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5877	from this method.
5878
5879	How thoroughly this method cleans up the machine configuration before unregistering
5880	the machine depends on the @a cleanupMode argument.
5881
5882	<ul>
5883	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5884	cleanup will be performed. The call will fail if the machine is in "Saved" state
5885	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5886	It is the responsibility of the caller to delete all such configuration in this mode.
5887	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5888	which it replaces.</li>
5889	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5890	state or if it has snapshots or media attached. All media attached to the current machine
5891	state or in snapshots will be detached. No medium objects will be returned;
5892	all of the machine's media will remain open.</li>
5893	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5894	except that all the hard disk medium objects which were detached from the machine will
5895	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5896	API for closing and deletion.</li>
5897	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5898	that all media will be returned in the array, including removable media like DVDs and
5899	floppies. This might be useful if the user wants to inspect in detail which media were
5900	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5901	in that case because users will typically want to preserve ISO and RAW image files.</li>
5902	</ul>
5903
5904	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5905	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5906	deleted with all its saved states and hard disk images, but images for removable
5907	drives (such as ISO and RAW files) will remain on disk.
5908
5909	This API does not verify whether the media files returned in the array are still
5910	attached to other machines (i.e. shared between several machines). If such a shared
5911	image is passed to <link to="#delete" /> however, closing the image will fail there
5912	and the image will be silently skipped.
5913
5914	This API may, however, move media from this machine's media registry to other media
5915	registries (see <link to="IMedium" /> for details on media registries). For machines
5916	created with VirtualBox 4.0 or later, if media from this machine's media registry
5917	are also attached to another machine (shared attachments), each such medium will be
5918	moved to another machine's registry. This is because without this machine's media
5919	registry, the other machine cannot find its media any more and would become inaccessible.
5920
5921	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5922	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5923	if media are moved to other machines' media registries.
5924
5925	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5926	is fired.
5927
5928	The call will fail if the machine is currently locked (see <link to="ISession" />).
5929
5930	<note>
5931	If the given machine is inaccessible (see <link to="#accessible"/>), it
5932	will be unregistered and fully uninitialized right afterwards. As a result,
5933	the returned machine object will be unusable and an attempt to call
5934	<b>any</b> method will return the "Object not ready" error.
5935	</note>
5936
5937	<result name="VBOX_E_INVALID_OBJECT_STATE">
5938	Machine is currently locked for a session.
5939	</result>
5940	</desc>
5941
5942	<param name="cleanupMode" type="CleanupMode" dir="in">
5943	<desc>How to clean up after the machine has been unregistered.</desc>
5944	</param>
5945	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5946	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5947	</param>
5948	</method>
5949
5950	<method name="delete">
5951	<desc>
5952	Deletes the files associated with this machine from disk. If medium objects are passed
5953	in with the @a aMedia argument, they are closed and, if closing was successful, their
5954	storage files are deleted as well. For convenience, this array of media files can be
5955	the same as the one returned from a previous <link to="#unregister" /> call.
5956
5957	This method must only be called on machines which are either write-locked (i.e. on instances
5958	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5959	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5960	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5961
5962	The following files will be deleted by this method:
5963	<ul>
5964	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5965	argument other than "UnregisterOnly", this will delete all saved state files that
5966	the machine had in use; possibly one if the machine was in "Saved" state and one
5967	for each online snapshot that the machine had.</li>
5968	<li>On each medium object passed in the @a aMedia array, this will call
5969	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5970	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5971	in use, e.g. because it is still attached to a second machine; in that case the
5972	storage will not be deleted.</li>
5973	<li>Finally, the machine's own XML file will be deleted.</li>
5974	</ul>
5975
5976	Since deleting large disk image files can be a time-consuming I/O operation, this
5977	method operates asynchronously and returns an IProgress object to allow the caller
5978	to monitor the progress. There will be one sub-operation for each file that is
5979	being deleted (saved state or medium storage file).
5980
5981	<note>
5982	<link to="#settingsModified"/> will return @c true after this
5983	method successfully returns.
5984	</note>
5985
5986	<result name="VBOX_E_INVALID_VM_STATE">
5987	Machine is registered but not write-locked.
5988	</result>
5989	<result name="VBOX_E_IPRT_ERROR">
5990	Could not delete the settings file.
5991	</result>
5992	</desc>
5993	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5994	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5995	</param>
5996	<param name="aProgress" type="IProgress" dir="return">
5997	<desc>Progress object to track the operation completion.</desc>
5998	</param>
5999	</method>
6000
6001	<method name="export">
6002	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
6003	steps required to export VirtualBox machines to OVF.
6004	</desc>
6005
6006	<param name="aAppliance" type="IAppliance" dir="in">
6007	<desc>Appliance to export this machine to.</desc>
6008	</param>
6009	<param name="location" type="wstring" dir="in">
6010	<desc>The target location.</desc>
6011	</param>
6012	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
6013	<desc>VirtualSystemDescription object which is created for this machine.</desc>
6014	</param>
6015	</method >
6016
6017	<method name="findSnapshot">
6018	<desc>
6019	Returns a snapshot of this machine with the given name or UUID.
6020
6021	Returns a snapshot of this machine with the given UUID.
6022	A @c null argument can be used to obtain the first snapshot
6023	taken on this machine. To traverse the whole tree of snapshots
6024	starting from the root, inspect the root snapshot's
6025	<link to="ISnapshot::children" /> attribute and recurse over those children.
6026
6027	<result name="VBOX_E_OBJECT_NOT_FOUND">
6028	Virtual machine has no snapshots or snapshot not found.
6029	</result>
6030
6031	</desc>
6032	<param name="nameOrId" type="wstring" dir="in">
6033	<desc>What to search for. Name or UUID of the snapshot to find</desc>
6034	</param>
6035	<param name="snapshot" type="ISnapshot" dir="return">
6036	<desc>Snapshot object with the given name.</desc>
6037	</param>
6038	</method>
6039
6040	<method name="createSharedFolder">
6041	<desc>
6042	Creates a new permanent shared folder by associating the given logical
6043	name with the given host path, adds it to the collection of shared
6044	folders and starts sharing it. Refer to the description of
6045	<link to="ISharedFolder"/> to read more about logical names.
6046
6047	<result name="VBOX_E_OBJECT_IN_USE">
6048	Shared folder already exists.
6049	</result>
6050	<result name="VBOX_E_FILE_ERROR">
6051	Shared folder @a hostPath not accessible.
6052	</result>
6053
6054	</desc>
6055	<param name="name" type="wstring" dir="in">
6056	<desc>Unique logical name of the shared folder.</desc>
6057	</param>
6058	<param name="hostPath" type="wstring" dir="in">
6059	<desc>Full path to the shared folder in the host file system.</desc>
6060	</param>
6061	<param name="writable" type="boolean" dir="in">
6062	<desc>Whether the share is writable or readonly.</desc>
6063	</param>
6064	<param name="automount" type="boolean" dir="in">
6065	<desc>Whether the share gets automatically mounted by the guest
6066	or not.</desc>
6067	</param>
6068	</method>
6069
6070	<method name="removeSharedFolder">
6071	<desc>
6072	Removes the permanent shared folder with the given name previously
6073	created by <link to="#createSharedFolder"/> from the collection of
6074	shared folders and stops sharing it.
6075
6076	<result name="VBOX_E_INVALID_VM_STATE">
6077	Virtual machine is not mutable.
6078	</result>
6079	<result name="VBOX_E_OBJECT_NOT_FOUND">
6080	Shared folder @a name does not exist.
6081	</result>
6082
6083	</desc>
6084	<param name="name" type="wstring" dir="in">
6085	<desc>Logical name of the shared folder to remove.</desc>
6086	</param>
6087	</method>
6088
6089	<method name="canShowConsoleWindow">
6090	<desc>
6091	Returns @c true if the VM console process can activate the
6092	console window and bring it to foreground on the desktop of
6093	the host PC.
6094	<note>
6095	This method will fail if a session for this machine is not
6096	currently open.
6097	</note>
6098
6099	<result name="VBOX_E_INVALID_VM_STATE">
6100	Machine session is not open.
6101	</result>
6102
6103	</desc>
6104	<param name="canShow" type="boolean" dir="return">
6105	<desc>
6106	@c true if the console window can be shown and @c false otherwise.
6107	</desc>
6108	</param>
6109	</method>
6110
6111	<method name="showConsoleWindow">
6112	<desc>
6113	Activates the console window and brings it to foreground on
6114	the desktop of the host PC. Many modern window managers on
6115	many platforms implement some sort of focus stealing
6116	prevention logic, so that it may be impossible to activate
6117	a window without the help of the currently active
6118	application. In this case, this method will return a non-zero
6119	identifier that represents the top-level window of the VM
6120	console process. The caller, if it represents a currently
6121	active process, is responsible to use this identifier (in a
6122	platform-dependent manner) to perform actual window
6123	activation.
6124	<note>
6125	This method will fail if a session for this machine is not
6126	currently open.
6127	</note>
6128
6129	<result name="VBOX_E_INVALID_VM_STATE">
6130	Machine session is not open.
6131	</result>
6132
6133	</desc>
6134	<param name="winId" type="long long" dir="return">
6135	<desc>
6136	Platform-dependent identifier of the top-level VM console
6137	window, or zero if this method has performed all actions
6138	necessary to implement the <i>show window</i> semantics for
6139	the given platform and/or VirtualBox front-end.
6140	</desc>
6141	</param>
6142	</method>
6143
6144	<method name="getGuestProperty" const="yes">
6145	<desc>
6146	Reads an entry from the machine's guest property store.
6147
6148	<result name="VBOX_E_INVALID_VM_STATE">
6149	Machine session is not open.
6150	</result>
6151
6152	</desc>
6153	<param name="name" type="wstring" dir="in">
6154	<desc>
6155	The name of the property to read.
6156	</desc>
6157	</param>
6158	<param name="value" type="wstring" dir="out">
6159	<desc>
6160	The value of the property. If the property does not exist then this
6161	will be empty.
6162	</desc>
6163	</param>
6164	<param name="timestamp" type="long long" dir="out">
6165	<desc>
6166	The time at which the property was last modified, as seen by the
6167	server process.
6168	</desc>
6169	</param>
6170	<param name="flags" type="wstring" dir="out">
6171	<desc>
6172	Additional property parameters, passed as a comma-separated list of
6173	"name=value" type entries.
6174	</desc>
6175	</param>
6176	</method>
6177
6178	<method name="getGuestPropertyValue" const="yes">
6179	<desc>
6180	Reads a value from the machine's guest property store.
6181
6182	<result name="VBOX_E_INVALID_VM_STATE">
6183	Machine session is not open.
6184	</result>
6185
6186	</desc>
6187	<param name="property" type="wstring" dir="in">
6188	<desc>
6189	The name of the property to read.
6190	</desc>
6191	</param>
6192	<param name="value" type="wstring" dir="return">
6193	<desc>
6194	The value of the property. If the property does not exist then this
6195	will be empty.
6196	</desc>
6197	</param>
6198	</method>
6199
6200	<method name="getGuestPropertyTimestamp" const="yes">
6201	<desc>
6202	Reads a property timestamp from the machine's guest property store.
6203
6204	<result name="VBOX_E_INVALID_VM_STATE">
6205	Machine session is not open.
6206	</result>
6207
6208	</desc>
6209	<param name="property" type="wstring" dir="in">
6210	<desc>
6211	The name of the property to read.
6212	</desc>
6213	</param>
6214	<param name="value" type="long long" dir="return">
6215	<desc>
6216	The timestamp. If the property does not exist then this will be
6217	empty.
6218	</desc>
6219	</param>
6220	</method>
6221
6222	<method name="setGuestProperty">
6223	<desc>
6224	Sets, changes or deletes an entry in the machine's guest property
6225	store.
6226
6227	<result name="E_ACCESSDENIED">
6228	Property cannot be changed.
6229	</result>
6230	<result name="E_INVALIDARG">
6231	Invalid @a flags.
6232	</result>
6233	<result name="VBOX_E_INVALID_VM_STATE">
6234	Virtual machine is not mutable or session not open.
6235	</result>
6236	<result name="VBOX_E_INVALID_OBJECT_STATE">
6237	Cannot set transient property when machine not running.
6238	</result>
6239
6240	</desc>
6241	<param name="property" type="wstring" dir="in">
6242	<desc>
6243	The name of the property to set, change or delete.
6244	</desc>
6245	</param>
6246	<param name="value" type="wstring" dir="in">
6247	<desc>
6248	The new value of the property to set, change or delete. If the
6249	property does not yet exist and value is non-empty, it will be
6250	created. If the value is @c null or empty, the property will be
6251	deleted if it exists.
6252	</desc>
6253	</param>
6254	<param name="flags" type="wstring" dir="in">
6255	<desc>
6256	Additional property parameters, passed as a comma-separated list of
6257	"name=value" type entries.
6258	</desc>
6259	</param>
6260	</method>
6261
6262	<method name="setGuestPropertyValue">
6263	<desc>
6264	Sets, changes or deletes a value in the machine's guest property
6265	store. The flags field will be left unchanged or created empty for a
6266	new property.
6267
6268	<result name="E_ACCESSDENIED">
6269	Property cannot be changed.
6270	</result>
6271	<result name="VBOX_E_INVALID_VM_STATE">
6272	Virtual machine is not mutable or session not open.
6273	</result>
6274	<result name="VBOX_E_INVALID_OBJECT_STATE">
6275	Cannot set transient property when machine not running.
6276	</result>
6277	</desc>
6278
6279	<param name="property" type="wstring" dir="in">
6280	<desc>
6281	The name of the property to set, change or delete.
6282	</desc>
6283	</param>
6284	<param name="value" type="wstring" dir="in">
6285	<desc>
6286	The new value of the property to set, change or delete. If the
6287	property does not yet exist and value is non-empty, it will be
6288	created. If the value is @c null or empty, the property will be
6289	deleted if it exists.
6290	</desc>
6291	</param>
6292	</method>
6293
6294	<method name="deleteGuestProperty" const="yes">
6295	<desc>
6296	Deletes an entry from the machine's guest property store.
6297
6298	<result name="VBOX_E_INVALID_VM_STATE">
6299	Machine session is not open.
6300	</result>
6301
6302	</desc>
6303	<param name="name" type="wstring" dir="in">
6304	<desc>
6305	The name of the property to delete.
6306	</desc>
6307	</param>
6308	</method>
6309
6310	<method name="enumerateGuestProperties" const="yes">
6311	<desc>
6312	Return a list of the guest properties matching a set of patterns along
6313	with their values, time stamps and flags.
6314	</desc>
6315	<param name="patterns" type="wstring" dir="in">
6316	<desc>
6317	The patterns to match the properties against, separated by '\|'
6318	characters. If this is empty or @c null, all properties will match.
6319	</desc>
6320	</param>
6321	<param name="name" type="wstring" dir="out" safearray="yes">
6322	<desc>
6323	The names of the properties returned.
6324	</desc>
6325	</param>
6326	<param name="value" type="wstring" dir="out" safearray="yes">
6327	<desc>
6328	The values of the properties returned. The array entries match the
6329	corresponding entries in the @a name array.
6330	</desc>
6331	</param>
6332	<param name="timestamp" type="long long" dir="out" safearray="yes">
6333	<desc>
6334	The time stamps of the properties returned. The array entries match
6335	the corresponding entries in the @a name array.
6336	</desc>
6337	</param>
6338	<param name="flags" type="wstring" dir="out" safearray="yes">
6339	<desc>
6340	The flags of the properties returned. The array entries match the
6341	corresponding entries in the @a name array.
6342	</desc>
6343	</param>
6344	</method>
6345
6346	<method name="querySavedGuestScreenInfo" const="yes">
6347	<desc>
6348	Returns the guest dimensions from the saved state.
6349	</desc>
6350	<param name="screenId" type="unsigned long" dir="in">
6351	<desc>
6352	Saved guest screen to query info from.
6353	</desc>
6354	</param>
6355	<param name="originX" type="unsigned long" dir="out">
6356	<desc>
6357	The X position of the guest monitor top left corner.
6358	</desc>
6359	</param>
6360	<param name="originY" type="unsigned long" dir="out">
6361	<desc>
6362	The Y position of the guest monitor top left corner.
6363	</desc>
6364	</param>
6365	<param name="width" type="unsigned long" dir="out">
6366	<desc>
6367	Guest width at the time of the saved state was taken.
6368	</desc>
6369	</param>
6370	<param name="height" type="unsigned long" dir="out">
6371	<desc>
6372	Guest height at the time of the saved state was taken.
6373	</desc>
6374	</param>
6375	<param name="enabled" type="boolean" dir="out">
6376	<desc>
6377	Whether the monitor is enabled in the guest.
6378	</desc>
6379	</param>
6380	</method>
6381
6382	<method name="querySavedThumbnailSize">
6383	<desc>
6384	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6385	</desc>
6386	<param name="screenId" type="unsigned long" dir="in">
6387	<desc>
6388	Saved guest screen to query info from.
6389	</desc>
6390	</param>
6391	<param name="size" type="unsigned long" dir="out">
6392	<desc>
6393	Size of buffer required to store the bitmap.
6394	</desc>
6395	</param>
6396	<param name="width" type="unsigned long" dir="out">
6397	<desc>
6398	Bitmap width.
6399	</desc>
6400	</param>
6401	<param name="height" type="unsigned long" dir="out">
6402	<desc>
6403	Bitmap height.
6404	</desc>
6405	</param>
6406	</method>
6407
6408	<method name="readSavedThumbnailToArray">
6409	<desc>
6410	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6411	</desc>
6412	<param name="screenId" type="unsigned long" dir="in">
6413	<desc>
6414	Saved guest screen to read from.
6415	</desc>
6416	</param>
6417	<param name="BGR" type="boolean" dir="in">
6418	<desc>
6419	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6420	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6421	</desc>
6422	</param>
6423	<param name="width" type="unsigned long" dir="out">
6424	<desc>
6425	Bitmap width.
6426	</desc>
6427	</param>
6428	<param name="height" type="unsigned long" dir="out">
6429	<desc>
6430	Bitmap height.
6431	</desc>
6432	</param>
6433	<param name="data" type="octet" safearray="yes" dir="return">
6434	<desc>
6435	Array with resulting bitmap data.
6436	</desc>
6437	</param>
6438	</method>
6439
6440	<method name="readSavedThumbnailPNGToArray">
6441	<desc>
6442	Thumbnail in PNG format is retrieved to an array of bytes.
6443	</desc>
6444	<param name="screenId" type="unsigned long" dir="in">
6445	<desc>
6446	Saved guest screen to read from.
6447	</desc>
6448	</param>
6449	<param name="width" type="unsigned long" dir="out">
6450	<desc>
6451	Image width.
6452	</desc>
6453	</param>
6454	<param name="height" type="unsigned long" dir="out">
6455	<desc>
6456	Image height.
6457	</desc>
6458	</param>
6459	<param name="data" type="octet" dir="return" safearray="yes">
6460	<desc>
6461	Array with resulting PNG data.
6462	</desc>
6463	</param>
6464	</method>
6465
6466	<method name="querySavedScreenshotPNGSize">
6467	<desc>
6468	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6469	</desc>
6470	<param name="screenId" type="unsigned long" dir="in">
6471	<desc>
6472	Saved guest screen to query info from.
6473	</desc>
6474	</param>
6475	<param name="size" type="unsigned long" dir="out">
6476	<desc>
6477	Size of buffer required to store the PNG binary data.
6478	</desc>
6479	</param>
6480	<param name="width" type="unsigned long" dir="out">
6481	<desc>
6482	Image width.
6483	</desc>
6484	</param>
6485	<param name="height" type="unsigned long" dir="out">
6486	<desc>
6487	Image height.
6488	</desc>
6489	</param>
6490	</method>
6491
6492	<method name="readSavedScreenshotPNGToArray">
6493	<desc>
6494	Screenshot in PNG format is retrieved to an array of bytes.
6495	</desc>
6496	<param name="screenId" type="unsigned long" dir="in">
6497	<desc>
6498	Saved guest screen to read from.
6499	</desc>
6500	</param>
6501	<param name="width" type="unsigned long" dir="out">
6502	<desc>
6503	Image width.
6504	</desc>
6505	</param>
6506	<param name="height" type="unsigned long" dir="out">
6507	<desc>
6508	Image height.
6509	</desc>
6510	</param>
6511	<param name="data" type="octet" dir="return" safearray="yes">
6512	<desc>
6513	Array with resulting PNG data.
6514	</desc>
6515	</param>
6516	</method>
6517
6518	<method name="hotPlugCPU">
6519	<desc>
6520	Plugs a CPU into the machine.
6521	</desc>
6522	<param name="cpu" type="unsigned long" dir="in">
6523	<desc>
6524	The CPU id to insert.
6525	</desc>
6526	</param>
6527	</method>
6528
6529	<method name="hotUnplugCPU">
6530	<desc>
6531	Removes a CPU from the machine.
6532	</desc>
6533	<param name="cpu" type="unsigned long" dir="in">
6534	<desc>
6535	The CPU id to remove.
6536	</desc>
6537	</param>
6538	</method>
6539
6540	<method name="getCPUStatus">
6541	<desc>
6542	Returns the current status of the given CPU.
6543	</desc>
6544	<param name="cpu" type="unsigned long" dir="in">
6545	<desc>
6546	The CPU id to check for.
6547	</desc>
6548	</param>
6549	<param name="attached" type="boolean" dir="return">
6550	<desc>
6551	Status of the CPU.
6552	</desc>
6553	</param>
6554	</method>
6555
6556	<method name="queryLogFilename">
6557	<desc>
6558	Queries for the VM log file name of an given index. Returns an empty
6559	string if a log file with that index doesn't exists.
6560	</desc>
6561	<param name="idx" type="unsigned long" dir="in">
6562	<desc>
6563	Which log file name to query. 0=current log file.
6564	</desc>
6565	</param>
6566	<param name="filename" type="wstring" dir="return">
6567	<desc>
6568	On return the full path to the log file or an empty string on error.
6569	</desc>
6570	</param>
6571	</method>
6572
6573	<method name="readLog">
6574	<desc>
6575	Reads the VM log file. The chunk size is limited, so even if you
6576	ask for a big piece there might be less data returned.
6577	</desc>
6578	<param name="idx" type="unsigned long" dir="in">
6579	<desc>
6580	Which log file to read. 0=current log file.
6581	</desc>
6582	</param>
6583	<param name="offset" type="long long" dir="in">
6584	<desc>
6585	Offset in the log file.
6586	</desc>
6587	</param>
6588	<param name="size" type="long long" dir="in">
6589	<desc>
6590	Chunk size to read in the log file.
6591	</desc>
6592	</param>
6593	<param name="data" type="octet" dir="return" safearray="yes">
6594	<desc>
6595	Data read from the log file. A data size of 0 means end of file
6596	if the requested chunk size was not 0. This is the unprocessed
6597	file data, i.e. the line ending style depends on the platform of
6598	the system the server is running on.
6599	</desc>
6600	</param>
6601	</method>
6602
6603	<method name="cloneTo">
6604	<desc>
6605	Creates a clone of this machine, either as a full clone (which means
6606	creating independent copies of the hard disk media, save states and so
6607	on), or as a linked clone (which uses its own differencing media,
6608	sharing the parent media with the source machine).
6609
6610	The target machine object must have been created previously with <link
6611	to="IVirtualBox::createMachine"/>, and all the settings will be
6612	transferred except the VM name and the hardware UUID. You can set the
6613	VM name and the new hardware UUID when creating the target machine. The
6614	network MAC addresses are newly created for all newtwork adapters. You
6615	can change that behaviour with the options parameter. The operation is
6616	performed asynchronously, so the machine object will be not be usable
6617	until the @a progress object signals completion.
6618
6619	<result name="E_INVALIDARG">
6620	@a target is @c null.
6621	</result>
6622	</desc>
6623
6624	<param name="target" type="IMachine" dir="in">
6625	<desc>Target machine object.</desc>
6626	</param>
6627	<param name="mode" type="CloneMode" dir="in">
6628	<desc>Which states should be cloned.</desc>
6629	</param>
6630	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6631	<desc>Options for the cloning operation.</desc>
6632	</param>
6633	<param name="progress" type="IProgress" dir="return">
6634	<desc>Progress object to track the operation completion.</desc>
6635	</param>
6636	</method>
6637
6638	</interface>
6639
6640	<!--
6641	// IConsole
6642	/////////////////////////////////////////////////////////////////////////
6643	-->
6644
6645	<interface
6646	name="IVRDEServerInfo" extends="$unknown"
6647	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6648	wsmap="struct"
6649	>
6650	<desc>
6651	Contains information about the remote desktop (VRDE) server capabilities and status.
6652	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6653	</desc>
6654
6655	<attribute name="active" type="boolean" readonly="yes">
6656	<desc>
6657	Whether the remote desktop connection is active.
6658	</desc>
6659	</attribute>
6660
6661	<attribute name="port" type="long" readonly="yes">
6662	<desc>
6663	VRDE server port number. If this property is equal to <tt>0</tt>, then
6664	the VRDE server failed to start, usually because there are no free IP
6665	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6666	server has not yet been started.
6667	</desc>
6668	</attribute>
6669
6670	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6671	<desc>
6672	How many times a client connected.
6673	</desc>
6674	</attribute>
6675
6676	<attribute name="beginTime" type="long long" readonly="yes">
6677	<desc>
6678	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6679	</desc>
6680	</attribute>
6681
6682	<attribute name="endTime" type="long long" readonly="yes">
6683	<desc>
6684	When the last connection was terminated or the current time, if
6685	connection is still active, in milliseconds since 1970-01-01 UTC.
6686	</desc>
6687	</attribute>
6688
6689	<attribute name="bytesSent" type="long long" readonly="yes">
6690	<desc>
6691	How many bytes were sent in last or current, if still active, connection.
6692	</desc>
6693	</attribute>
6694
6695	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6696	<desc>
6697	How many bytes were sent in all connections.
6698	</desc>
6699	</attribute>
6700
6701	<attribute name="bytesReceived" type="long long" readonly="yes">
6702	<desc>
6703	How many bytes were received in last or current, if still active, connection.
6704	</desc>
6705	</attribute>
6706
6707	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6708	<desc>
6709	How many bytes were received in all connections.
6710	</desc>
6711	</attribute>
6712
6713	<attribute name="user" type="wstring" readonly="yes">
6714	<desc>
6715	Login user name supplied by the client.
6716	</desc>
6717	</attribute>
6718
6719	<attribute name="domain" type="wstring" readonly="yes">
6720	<desc>
6721	Login domain name supplied by the client.
6722	</desc>
6723	</attribute>
6724
6725	<attribute name="clientName" type="wstring" readonly="yes">
6726	<desc>
6727	The client name supplied by the client.
6728	</desc>
6729	</attribute>
6730
6731	<attribute name="clientIP" type="wstring" readonly="yes">
6732	<desc>
6733	The IP address of the client.
6734	</desc>
6735	</attribute>
6736
6737	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6738	<desc>
6739	The client software version number.
6740	</desc>
6741	</attribute>
6742
6743	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6744	<desc>
6745	Public key exchange method used when connection was established.
6746	Values: 0 - RDP4 public key exchange scheme.
6747	1 - X509 certificates were sent to client.
6748	</desc>
6749	</attribute>
6750
6751	</interface>
6752
6753	<interface
6754	name="IConsole" extends="$unknown"
6755	uuid="db7ab4ca-2a3f-4183-9243-c1208da92392"
6756	wsmap="managed"
6757	>
6758	<desc>
6759	The IConsole interface represents an interface to control virtual
6760	machine execution.
6761
6762	A console object gets created when a machine has been locked for a
6763	particular session (client process) using <link to="IMachine::lockMachine" />
6764	or <link to="IMachine::launchVMProcess"/>. The console object can
6765	then be found in the session's <link to="ISession::console" /> attribute.
6766
6767	Methods of the IConsole interface allow the caller to query the current
6768	virtual machine execution state, pause the machine or power it down, save
6769	the machine state or take a snapshot, attach and detach removable media
6770	and so on.
6771
6772	<see><link to="ISession"/></see>
6773	</desc>
6774
6775	<attribute name="machine" type="IMachine" readonly="yes">
6776	<desc>
6777	Machine object for this console session.
6778	<note>
6779	This is a convenience property, it has the same value as
6780	<link to="ISession::machine"/> of the corresponding session
6781	object.
6782	</note>
6783	</desc>
6784	</attribute>
6785
6786	<attribute name="state" type="MachineState" readonly="yes">
6787	<desc>
6788	Current execution state of the machine.
6789	<note>
6790	This property always returns the same value as the corresponding
6791	property of the IMachine object for this console session.
6792	For the process that owns (executes) the VM, this is the
6793	preferable way of querying the VM state, because no IPC
6794	calls are made.
6795	</note>
6796	</desc>
6797	</attribute>
6798
6799	<attribute name="guest" type="IGuest" readonly="yes">
6800	<desc>Guest object.</desc>
6801	</attribute>
6802
6803	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6804	<desc>
6805	Virtual keyboard object.
6806	<note>
6807	If the machine is not running, any attempt to use
6808	the returned object will result in an error.
6809	</note>
6810	</desc>
6811	</attribute>
6812
6813	<attribute name="mouse" type="IMouse" readonly="yes">
6814	<desc>
6815	Virtual mouse object.
6816	<note>
6817	If the machine is not running, any attempt to use
6818	the returned object will result in an error.
6819	</note>
6820	</desc>
6821	</attribute>
6822
6823	<attribute name="display" type="IDisplay" readonly="yes">
6824	<desc>Virtual display object.
6825	<note>
6826	If the machine is not running, any attempt to use
6827	the returned object will result in an error.
6828	</note>
6829	</desc>
6830	</attribute>
6831
6832	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6833	<desc>Debugging interface.</desc>
6834	</attribute>
6835
6836	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6837	<desc>
6838	Collection of USB devices currently attached to the virtual
6839	USB controller.
6840	<note>
6841	The collection is empty if the machine is not running.
6842	</note>
6843	</desc>
6844	</attribute>
6845
6846	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6847	<desc>
6848	List of USB devices currently attached to the remote VRDE client.
6849	Once a new device is physically attached to the remote host computer,
6850	it appears in this list and remains there until detached.
6851	</desc>
6852	</attribute>
6853
6854	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6855	<desc>
6856	Collection of shared folders for the current session. These folders
6857	are called transient shared folders because they are available to the
6858	guest OS running inside the associated virtual machine only for the
6859	duration of the session (as opposed to
6860	<link to="IMachine::sharedFolders"/> which represent permanent shared
6861	folders). When the session is closed (e.g. the machine is powered down),
6862	these folders are automatically discarded.
6863
6864	New shared folders are added to the collection using
6865	<link to="#createSharedFolder"/>. Existing shared folders can be
6866	removed using <link to="#removeSharedFolder"/>.
6867	</desc>
6868	</attribute>
6869
6870	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6871	<desc>
6872	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6873	</desc>
6874	</attribute>
6875
6876	<attribute name="eventSource" type="IEventSource" readonly="yes">
6877	<desc>
6878	Event source for console events.
6879	</desc>
6880	</attribute>
6881
6882	<attribute name="attachedPCIDevices" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
6883	<desc>Array of PCI devices attached to this machine.</desc>
6884	</attribute>
6885
6886	<attribute name="useHostClipboard" type="boolean">
6887	<desc>
6888	Whether the guest clipboard should be connected to the host one or
6889	whether it should only be allowed access to the VRDE clipboard. This
6890	setting may not affect existing guest clipboard connections which
6891	are already connected to the host clipboard.
6892	</desc>
6893	</attribute>
6894
6895	<method name="powerUp">
6896	<desc>
6897	Starts the virtual machine execution using the current machine
6898	state (that is, its current execution state, current settings and
6899	current storage devices).
6900
6901	<note>
6902	This method is only useful for front-ends that want to actually
6903	execute virtual machines in their own process (like the VirtualBox
6904	or VBoxSDL front-ends). Unless you are intending to write such a
6905	front-end, do not call this method. If you simply want to
6906	start virtual machine execution using one of the existing front-ends
6907	(for example the VirtualBox GUI or headless server), use
6908	<link to="IMachine::launchVMProcess"/> instead; these
6909	front-ends will power up the machine automatically for you.
6910	</note>
6911
6912	If the machine is powered off or aborted, the execution will
6913	start from the beginning (as if the real hardware were just
6914	powered on).
6915
6916	If the machine is in the <link to="MachineState_Saved"/> state,
6917	it will continue its execution the point where the state has
6918	been saved.
6919
6920	If the machine <link to="IMachine::teleporterEnabled"/> property is
6921	enabled on the machine being powered up, the machine will wait for an
6922	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6923	state. The returned progress object will have at least three
6924	operations where the last three are defined as: (1) powering up and
6925	starting TCP server, (2) waiting for incoming teleportations, and
6926	(3) perform teleportation. These operations will be reflected as the
6927	last three operations of the progress objected returned by
6928	<link to="IMachine::launchVMProcess"/> as well.
6929
6930	<see><link to="#saveState"/></see>
6931
6932	<result name="VBOX_E_INVALID_VM_STATE">
6933	Virtual machine already running.
6934	</result>
6935	<result name="VBOX_E_HOST_ERROR">
6936	Host interface does not exist or name not set.
6937	</result>
6938	<result name="VBOX_E_FILE_ERROR">
6939	Invalid saved state file.
6940	</result>
6941	</desc>
6942	<param name="progress" type="IProgress" dir="return">
6943	<desc>Progress object to track the operation completion.</desc>
6944	</param>
6945	</method>
6946
6947	<method name="powerUpPaused">
6948	<desc>
6949	Identical to powerUp except that the VM will enter the
6950	<link to="MachineState_Paused"/> state, instead of
6951	<link to="MachineState_Running"/>.
6952
6953	<see><link to="#powerUp"/></see>
6954	<result name="VBOX_E_INVALID_VM_STATE">
6955	Virtual machine already running.
6956	</result>
6957	<result name="VBOX_E_HOST_ERROR">
6958	Host interface does not exist or name not set.
6959	</result>
6960	<result name="VBOX_E_FILE_ERROR">
6961	Invalid saved state file.
6962	</result>
6963	</desc>
6964	<param name="progress" type="IProgress" dir="return">
6965	<desc>Progress object to track the operation completion.</desc>
6966	</param>
6967	</method>
6968
6969	<method name="powerDown">
6970	<desc>
6971	Initiates the power down procedure to stop the virtual machine
6972	execution.
6973
6974	The completion of the power down procedure is tracked using the returned
6975	IProgress object. After the operation is complete, the machine will go
6976	to the PoweredOff state.
6977	<result name="VBOX_E_INVALID_VM_STATE">
6978	Virtual machine must be Running, Paused or Stuck to be powered down.
6979	</result>
6980	</desc>
6981	<param name="progress" type="IProgress" dir="return">
6982	<desc>Progress object to track the operation completion.</desc>
6983	</param>
6984	</method>
6985
6986	<method name="reset">
6987	<desc>Resets the virtual machine.
6988	<result name="VBOX_E_INVALID_VM_STATE">
6989	Virtual machine not in Running state.
6990	</result>
6991	<result name="VBOX_E_VM_ERROR">
6992	Virtual machine error in reset operation.
6993	</result>
6994	</desc>
6995	</method>
6996
6997	<method name="pause">
6998	<desc>Pauses the virtual machine execution.
6999	<result name="VBOX_E_INVALID_VM_STATE">
7000	Virtual machine not in Running state.
7001	</result>
7002	<result name="VBOX_E_VM_ERROR">
7003	Virtual machine error in suspend operation.
7004	</result>
7005	</desc>
7006	</method>
7007
7008	<method name="resume">
7009	<desc>Resumes the virtual machine execution.
7010	<result name="VBOX_E_INVALID_VM_STATE">
7011	Virtual machine not in Paused state.
7012	</result>
7013	<result name="VBOX_E_VM_ERROR">
7014	Virtual machine error in resume operation.
7015	</result>
7016	</desc>
7017	</method>
7018
7019	<method name="powerButton">
7020	<desc>Sends the ACPI power button event to the guest.
7021	<result name="VBOX_E_INVALID_VM_STATE">
7022	Virtual machine not in Running state.
7023	</result>
7024	<result name="VBOX_E_PDM_ERROR">
7025	Controlled power off failed.
7026	</result>
7027	</desc>
7028	</method>
7029
7030	<method name="sleepButton">
7031	<desc>Sends the ACPI sleep button event to the guest.
7032	<result name="VBOX_E_INVALID_VM_STATE">
7033	Virtual machine not in Running state.
7034	</result>
7035	<result name="VBOX_E_PDM_ERROR">
7036	Sending sleep button event failed.
7037	</result>
7038	</desc>
7039	</method>
7040
7041	<method name="getPowerButtonHandled">
7042	<desc>Checks if the last power button event was handled by guest.
7043	<result name="VBOX_E_PDM_ERROR">
7044	Checking if the event was handled by the guest OS failed.
7045	</result>
7046	</desc>
7047	<param name="handled" type="boolean" dir="return"/>
7048	</method>
7049
7050	<method name="getGuestEnteredACPIMode">
7051	<desc>Checks if the guest entered the ACPI mode G0 (working) or
7052	G1 (sleeping). If this method returns @c false, the guest will
7053	most likely not respond to external ACPI events.
7054	<result name="VBOX_E_INVALID_VM_STATE">
7055	Virtual machine not in Running state.
7056	</result>
7057	</desc>
7058	<param name="entered" type="boolean" dir="return"/>
7059	</method>
7060
7061	<method name="saveState">
7062	<desc>
7063	Saves the current execution state of a running virtual machine
7064	and stops its execution.
7065
7066	After this operation completes, the machine will go to the
7067	Saved state. Next time it is powered up, this state will
7068	be restored and the machine will continue its execution from
7069	the place where it was saved.
7070
7071	This operation differs from taking a snapshot to the effect
7072	that it doesn't create new differencing media. Also, once
7073	the machine is powered up from the state saved using this method,
7074	the saved state is deleted, so it will be impossible to return
7075	to this state later.
7076
7077	<note>
7078	On success, this method implicitly calls
7079	<link to="IMachine::saveSettings"/> to save all current machine
7080	settings (including runtime changes to the DVD medium, etc.).
7081	Together with the impossibility to change any VM settings when it is
7082	in the Saved state, this guarantees adequate hardware
7083	configuration of the machine when it is restored from the saved
7084	state file.
7085	</note>
7086
7087	<note>
7088	The machine must be in the Running or Paused state, otherwise
7089	the operation will fail.
7090	</note>
7091	<result name="VBOX_E_INVALID_VM_STATE">
7092	Virtual machine state neither Running nor Paused.
7093	</result>
7094	<result name="VBOX_E_FILE_ERROR">
7095	Failed to create directory for saved state file.
7096	</result>
7097
7098	<see><link to="#takeSnapshot"/></see>
7099	</desc>
7100	<param name="progress" type="IProgress" dir="return">
7101	<desc>Progress object to track the operation completion.</desc>
7102	</param>
7103	</method>
7104
7105	<method name="adoptSavedState">
7106	<desc>
7107	Associates the given saved state file to the virtual machine.
7108
7109	On success, the machine will go to the Saved state. Next time it is
7110	powered up, it will be restored from the adopted saved state and
7111	continue execution from the place where the saved state file was
7112	created.
7113
7114	The specified saved state file path may be absolute or relative to the
7115	folder the VM normally saves the state to (usually,
7116	<link to="IMachine::snapshotFolder"/>).
7117
7118	<note>
7119	It's a caller's responsibility to make sure the given saved state
7120	file is compatible with the settings of this virtual machine that
7121	represent its virtual hardware (memory size, storage disk configuration
7122	etc.). If there is a mismatch, the behavior of the virtual machine
7123	is undefined.
7124	</note>
7125	<result name="VBOX_E_INVALID_VM_STATE">
7126	Virtual machine state neither PoweredOff nor Aborted.
7127	</result>
7128	</desc>
7129	<param name="savedStateFile" type="wstring" dir="in">
7130	<desc>Path to the saved state file to adopt.</desc>
7131	</param>
7132	</method>
7133
7134	<method name="discardSavedState">
7135	<desc>
7136	Forcibly resets the machine to "Powered Off" state if it is
7137	currently in the "Saved" state (previously created by <link to="#saveState"/>).
7138	Next time the machine is powered up, a clean boot will occur.
7139	<note>
7140	This operation is equivalent to resetting or powering off
7141	the machine without doing a proper shutdown of the guest
7142	operating system; as with resetting a running phyiscal
7143	computer, it can can lead to data loss.
7144	</note>
7145	If @a fRemoveFile is @c true, the file in the machine directory
7146	into which the machine state was saved is also deleted. If
7147	this is @c false, then the state can be recovered and later
7148	re-inserted into a machine using <link to="#adoptSavedState" />.
7149	The location of the file can be found in the
7150	<link to="IMachine::stateFilePath" /> attribute.
7151	<result name="VBOX_E_INVALID_VM_STATE">
7152	Virtual machine not in state Saved.
7153	</result>
7154	</desc>
7155	<param name="fRemoveFile" type="boolean" dir="in" >
7156	<desc>Whether to also remove the saved state file.</desc>
7157	</param>
7158	</method>
7159
7160	<method name="getDeviceActivity">
7161	<desc>
7162	Gets the current activity type of a given device or device group.
7163	<result name="E_INVALIDARG">
7164	Invalid device type.
7165	</result>
7166	</desc>
7167	<param name="type" type="DeviceType" dir="in"/>
7168	<param name="activity" type="DeviceActivity" dir="return"/>
7169	</method>
7170
7171	<method name="attachUSBDevice">
7172	<desc>
7173	Attaches a host USB device with the given UUID to the
7174	USB controller of the virtual machine.
7175
7176	The device needs to be in one of the following states:
7177	<link to="USBDeviceState_Busy"/>,
7178	<link to="USBDeviceState_Available"/> or
7179	<link to="USBDeviceState_Held"/>,
7180	otherwise an error is immediately returned.
7181
7182	When the device state is
7183	<link to="USBDeviceState_Busy">Busy</link>, an error may also
7184	be returned if the host computer refuses to release it for some reason.
7185
7186	<see><link to="IUSBController::deviceFilters"/>,
7187	<link to="USBDeviceState"/></see>
7188	<result name="VBOX_E_INVALID_VM_STATE">
7189	Virtual machine state neither Running nor Paused.
7190	</result>
7191	<result name="VBOX_E_PDM_ERROR">
7192	Virtual machine does not have a USB controller.
7193	</result>
7194	</desc>
7195	<param name="id" type="uuid" mod="string" dir="in">
7196	<desc>UUID of the host USB device to attach.</desc>
7197	</param>
7198	</method>
7199
7200	<method name="detachUSBDevice">
7201	<desc>
7202	Detaches an USB device with the given UUID from the USB controller
7203	of the virtual machine.
7204
7205	After this method succeeds, the VirtualBox server re-initiates
7206	all USB filters as if the device were just physically attached
7207	to the host, but filters of this machine are ignored to avoid
7208	a possible automatic re-attachment.
7209
7210	<see><link to="IUSBController::deviceFilters"/>,
7211	<link to="USBDeviceState"/></see>
7212
7213	<result name="VBOX_E_PDM_ERROR">
7214	Virtual machine does not have a USB controller.
7215	</result>
7216	<result name="E_INVALIDARG">
7217	USB device not attached to this virtual machine.
7218	</result>
7219	</desc>
7220	<param name="id" type="uuid" mod="string" dir="in">
7221	<desc>UUID of the USB device to detach.</desc>
7222	</param>
7223	<param name="device" type="IUSBDevice" dir="return">
7224	<desc>Detached USB device.</desc>
7225	</param>
7226	</method>
7227
7228	<method name="findUSBDeviceByAddress">
7229	<desc>
7230	Searches for a USB device with the given host address.
7231
7232	<result name="VBOX_E_OBJECT_NOT_FOUND">
7233	Given @c name does not correspond to any USB device.
7234	</result>
7235
7236	<see><link to="IUSBDevice::address"/></see>
7237	</desc>
7238	<param name="name" type="wstring" dir="in">
7239	<desc>
7240	Address of the USB device (as assigned by the host) to
7241	search for.
7242	</desc>
7243	</param>
7244	<param name="device" type="IUSBDevice" dir="return">
7245	<desc>Found USB device object.</desc>
7246	</param>
7247	</method>
7248
7249	<method name="findUSBDeviceById">
7250	<desc>
7251	Searches for a USB device with the given UUID.
7252
7253	<result name="VBOX_E_OBJECT_NOT_FOUND">
7254	Given @c id does not correspond to any USB device.
7255	</result>
7256
7257	<see><link to="IUSBDevice::id"/></see>
7258	</desc>
7259	<param name="id" type="uuid" mod="string" dir="in">
7260	<desc>UUID of the USB device to search for.</desc>
7261	</param>
7262	<param name="device" type="IUSBDevice" dir="return">
7263	<desc>Found USB device object.</desc>
7264	</param>
7265	</method>
7266
7267	<method name="createSharedFolder">
7268	<desc>
7269	Creates a transient new shared folder by associating the given logical
7270	name with the given host path, adds it to the collection of shared
7271	folders and starts sharing it. Refer to the description of
7272	<link to="ISharedFolder"/> to read more about logical names.
7273
7274	<result name="VBOX_E_INVALID_VM_STATE">
7275	Virtual machine in Saved state or currently changing state.
7276	</result>
7277	<result name="VBOX_E_FILE_ERROR">
7278	Shared folder already exists or not accessible.
7279	</result>
7280	</desc>
7281	<param name="name" type="wstring" dir="in">
7282	<desc>Unique logical name of the shared folder.</desc>
7283	</param>
7284	<param name="hostPath" type="wstring" dir="in">
7285	<desc>Full path to the shared folder in the host file system.</desc>
7286	</param>
7287	<param name="writable" type="boolean" dir="in">
7288	<desc>Whether the share is writable or readonly</desc>
7289	</param>
7290	<param name="automount" type="boolean" dir="in">
7291	<desc>Whether the share gets automatically mounted by the guest
7292	or not.</desc>
7293	</param>
7294	</method>
7295
7296	<method name="removeSharedFolder">
7297	<desc>
7298	Removes a transient shared folder with the given name previously
7299	created by <link to="#createSharedFolder"/> from the collection of
7300	shared folders and stops sharing it.
7301	<result name="VBOX_E_INVALID_VM_STATE">
7302	Virtual machine in Saved state or currently changing state.
7303	</result>
7304	<result name="VBOX_E_FILE_ERROR">
7305	Shared folder does not exists.
7306	</result>
7307	</desc>
7308	<param name="name" type="wstring" dir="in">
7309	<desc>Logical name of the shared folder to remove.</desc>
7310	</param>
7311	</method>
7312
7313	<method name="takeSnapshot">
7314	<desc>
7315	Saves the current execution state
7316	and all settings of the machine and creates differencing images
7317	for all normal (non-independent) media.
7318	See <link to="ISnapshot" /> for an introduction to snapshots.
7319
7320	This method can be called for a PoweredOff, Saved (see
7321	<link to="#saveState"/>), Running or
7322	Paused virtual machine. When the machine is PoweredOff, an
7323	offline snapshot is created. When the machine is Running a live
7324	snapshot is created, and an online snapshot is created when Paused.
7325
7326	The taken snapshot is always based on the
7327	<link to="IMachine::currentSnapshot">current snapshot</link>
7328	of the associated virtual machine and becomes a new current snapshot.
7329
7330	<note>
7331	This method implicitly calls <link to="IMachine::saveSettings"/> to
7332	save all current machine settings before taking an offline snapshot.
7333	</note>
7334
7335	<result name="VBOX_E_INVALID_VM_STATE">
7336	Virtual machine currently changing state.
7337	</result>
7338	</desc>
7339	<param name="name" type="wstring" dir="in">
7340	<desc>Short name for the snapshot.</desc>
7341	</param>
7342	<param name="description" type="wstring" dir="in">
7343	<desc>Optional description of the snapshot.</desc>
7344	</param>
7345	<param name="progress" type="IProgress" dir="return">
7346	<desc>Progress object to track the operation completion.</desc>
7347	</param>
7348	</method>
7349
7350	<method name="deleteSnapshot">
7351	<desc>
7352	Starts deleting the specified snapshot asynchronously.
7353	See <link to="ISnapshot" /> for an introduction to snapshots.
7354
7355	The execution state and settings of the associated machine stored in
7356	the snapshot will be deleted. The contents of all differencing media of
7357	this snapshot will be merged with the contents of their dependent child
7358	media to keep the medium chain valid (in other words, all changes
7359	represented by media being deleted will be propagated to their child
7360	medium). After that, this snapshot's differencing medium will be
7361	deleted. The parent of this snapshot will become a new parent for all
7362	its child snapshots.
7363
7364	If the deleted snapshot is the current one, its parent snapshot will
7365	become a new current snapshot. The current machine state is not directly
7366	affected in this case, except that currently attached differencing
7367	media based on media of the deleted snapshot will be also merged as
7368	described above.
7369
7370	If the deleted snapshot is the first or current snapshot, then the
7371	respective IMachine attributes will be adjusted. Deleting the current
7372	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7373	to make all current machine settings permanent.
7374
7375	Deleting a snapshot has the following preconditions:
7376
7377	<ul>
7378	<li>Child media of all normal media of the deleted snapshot
7379	must be accessible (see <link to="IMedium::state"/>) for this
7380	operation to succeed. If only one running VM refers to all images
7381	which participates in merging the operation can be performed while
7382	the VM is running. Otherwise all virtual machines whose media are
7383	directly or indirectly based on the media of deleted snapshot must
7384	be powered off. In any case, online snapshot deleting usually is
7385	slower than the same operation without any running VM.</li>
7386
7387	<li>You cannot delete the snapshot if a medium attached to it has
7388	more than one child medium (differencing images) because otherwise
7389	merging would be impossible. This might be the case if there is
7390	more than one child snapshot or differencing images were created
7391	for other reason (e.g. implicitly because of multiple machine
7392	attachments).</li>
7393	</ul>
7394
7395	The virtual machine's <link to="IMachine::state">state</link> is
7396	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7397	"DeletingSnapshotPaused" while this operation is in progress.
7398
7399	<note>
7400	Merging medium contents can be very time and disk space
7401	consuming, if these media are big in size and have many
7402	children. However, if the snapshot being deleted is the last
7403	(head) snapshot on the branch, the operation will be rather
7404	quick.
7405	</note>
7406	<result name="VBOX_E_INVALID_VM_STATE">
7407	The running virtual machine prevents deleting this snapshot. This
7408	happens only in very specific situations, usually snapshots can be
7409	deleted without trouble while a VM is running. The error message
7410	text explains the reason for the failure.
7411	</result>
7412	</desc>
7413	<param name="id" type="uuid" mod="string" dir="in">
7414	<desc>UUID of the snapshot to delete.</desc>
7415	</param>
7416	<param name="progress" type="IProgress" dir="return">
7417	<desc>Progress object to track the operation completion.</desc>
7418	</param>
7419	</method>
7420
7421	<method name="deleteSnapshotAndAllChildren">
7422	<desc>
7423	Starts deleting the specified snapshot and all its children
7424	asynchronously. See <link to="ISnapshot" /> for an introduction to
7425	snapshots. The conditions and many details are the same as with
7426	<link to="#deleteSnapshot"/>.
7427
7428	This operation is very fast if the snapshot subtree does not include
7429	the current state. It is still significantly faster than deleting the
7430	snapshots one by one if the current state is in the subtree and there
7431	are more than one snapshots from current state to the snapshot which
7432	marks the subtree, since it eliminates the incremental image merging.
7433
7434	<note>This API method is right now not implemented!</note>
7435
7436	<result name="VBOX_E_INVALID_VM_STATE">
7437	The running virtual machine prevents deleting this snapshot. This
7438	happens only in very specific situations, usually snapshots can be
7439	deleted without trouble while a VM is running. The error message
7440	text explains the reason for the failure.
7441	</result>
7442	<result name="E_NOTIMPL">
7443	The method is not implemented yet.
7444	</result>
7445	</desc>
7446	<param name="id" type="uuid" mod="string" dir="in">
7447	<desc>UUID of the snapshot to delete, including all its children.</desc>
7448	</param>
7449	<param name="progress" type="IProgress" dir="return">
7450	<desc>Progress object to track the operation completion.</desc>
7451	</param>
7452	</method>
7453
7454	<method name="deleteSnapshotRange">
7455	<desc>
7456	Starts deleting the specified snapshot range. This is limited to
7457	linear snapshot lists, which means there may not be any other child
7458	snapshots other than the direct sequence between the start and end
7459	snapshot. If the start and end snapshot point to the same snapshot this
7460	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7461	<link to="ISnapshot" /> for an introduction to snapshots. The
7462	conditions and many details are the same as with
7463	<link to="#deleteSnapshot"/>.
7464
7465	This operation is generally faster than deleting snapshots one by one
7466	and often also needs less extra disk space before freeing up disk space
7467	by deleting the removed disk images corresponding to the snapshot.
7468
7469	<note>This API method is right now not implemented!</note>
7470
7471	<result name="VBOX_E_INVALID_VM_STATE">
7472	The running virtual machine prevents deleting this snapshot. This
7473	happens only in very specific situations, usually snapshots can be
7474	deleted without trouble while a VM is running. The error message
7475	text explains the reason for the failure.
7476	</result>
7477	<result name="E_NOTIMPL">
7478	The method is not implemented yet.
7479	</result>
7480	</desc>
7481	<param name="startId" type="uuid" mod="string" dir="in">
7482	<desc>UUID of the first snapshot to delete.</desc>
7483	</param>
7484	<param name="endId" type="uuid" mod="string" dir="in">
7485	<desc>UUID of the last snapshot to delete.</desc>
7486	</param>
7487	<param name="progress" type="IProgress" dir="return">
7488	<desc>Progress object to track the operation completion.</desc>
7489	</param>
7490	</method>
7491
7492	<method name="restoreSnapshot">
7493	<desc>
7494	Starts resetting the machine's current state to the state contained
7495	in the given snapshot, asynchronously. All current settings of the
7496	machine will be reset and changes stored in differencing media
7497	will be lost.
7498	See <link to="ISnapshot" /> for an introduction to snapshots.
7499
7500	After this operation is successfully completed, new empty differencing
7501	media are created for all normal media of the machine.
7502
7503	If the given snapshot is an online snapshot, the machine will go to
7504	the <link to="MachineState_Saved"> saved state</link>, so that the
7505	next time it is powered on, the execution state will be restored
7506	from the state of the snapshot.
7507
7508	<note>
7509	The machine must not be running, otherwise the operation will fail.
7510	</note>
7511
7512	<note>
7513	If the machine state is <link to="MachineState_Saved">Saved</link>
7514	prior to this operation, the saved state file will be implicitly
7515	deleted (as if <link to="IConsole::discardSavedState"/> were
7516	called).
7517	</note>
7518
7519	<result name="VBOX_E_INVALID_VM_STATE">
7520	Virtual machine is running.
7521	</result>
7522	</desc>
7523	<param name="snapshot" type="ISnapshot" dir="in">
7524	<desc>The snapshot to restore the VM state from.</desc>
7525	</param>
7526	<param name="progress" type="IProgress" dir="return">
7527	<desc>Progress object to track the operation completion.</desc>
7528	</param>
7529	</method>
7530
7531	<method name="teleport">
7532	<desc>
7533	Teleport the VM to a different host machine or process.
7534
7535	TODO explain the details.
7536
7537	<result name="VBOX_E_INVALID_VM_STATE">
7538	Virtual machine not running or paused.
7539	</result>
7540	</desc>
7541	<param name="hostname" type="wstring" dir="in">
7542	<desc>The name or IP of the host to teleport to.</desc>
7543	</param>
7544	<param name="tcpport" type="unsigned long" dir="in">
7545	<desc>The TCP port to connect to (1..65535).</desc>
7546	</param>
7547	<param name="password" type="wstring" dir="in">
7548	<desc>The password.</desc>
7549	</param>
7550	<param name="maxDowntime" type="unsigned long" dir="in">
7551	<desc>
7552	The maximum allowed downtime given as milliseconds. 0 is not a valid
7553	value. Recommended value: 250 ms.
7554
7555	The higher the value is, the greater the chance for a successful
7556	teleportation. A small value may easily result in the teleportation
7557	process taking hours and eventually fail.
7558
7559	<note>
7560	The current implementation treats this a guideline, not as an
7561	absolute rule.
7562	</note>
7563	</desc>
7564	</param>
7565	<param name="progress" type="IProgress" dir="return">
7566	<desc>Progress object to track the operation completion.</desc>
7567	</param>
7568	</method>
7569
7570	</interface>
7571
7572	<!--
7573	// IHost
7574	/////////////////////////////////////////////////////////////////////////
7575	-->
7576
7577	<enum
7578	name="HostNetworkInterfaceMediumType"
7579	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7580	>
7581	<desc>
7582	Type of encapsulation. Ethernet encapsulation includes both wired and
7583	wireless Ethernet connections.
7584	<see><link to="IHostNetworkInterface"/></see>
7585	</desc>
7586
7587	<const name="Unknown" value="0">
7588	<desc>
7589	The type of interface cannot be determined.
7590	</desc>
7591	</const>
7592	<const name="Ethernet" value="1">
7593	<desc>
7594	Ethernet frame encapsulation.
7595	</desc>
7596	</const>
7597	<const name="PPP" value="2">
7598	<desc>
7599	Point-to-point protocol encapsulation.
7600	</desc>
7601	</const>
7602	<const name="SLIP" value="3">
7603	<desc>
7604	Serial line IP encapsulation.
7605	</desc>
7606	</const>
7607	</enum>
7608
7609	<enum
7610	name="HostNetworkInterfaceStatus"
7611	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7612	>
7613	<desc>
7614	Current status of the interface.
7615	<see><link to="IHostNetworkInterface"/></see>
7616	</desc>
7617
7618	<const name="Unknown" value="0">
7619	<desc>
7620	The state of interface cannot be determined.
7621	</desc>
7622	</const>
7623	<const name="Up" value="1">
7624	<desc>
7625	The interface is fully operational.
7626	</desc>
7627	</const>
7628	<const name="Down" value="2">
7629	<desc>
7630	The interface is not functioning.
7631	</desc>
7632	</const>
7633	</enum>
7634
7635	<enum
7636	name="HostNetworkInterfaceType"
7637	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7638	>
7639	<desc>
7640	Network interface type.
7641	</desc>
7642	<const name="Bridged" value="1"/>
7643	<const name="HostOnly" value="2"/>
7644	</enum>
7645
7646	<interface
7647	name="IHostNetworkInterface" extends="$unknown"
7648	uuid="87a4153d-6889-4dd6-9654-2e9ff0ae8dec"
7649	wsmap="managed"
7650	>
7651	<desc>
7652	Represents one of host's network interfaces. IP V6 address and network
7653	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7654	separated by colons.
7655	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7656	</desc>
7657	<attribute name="name" type="wstring" readonly="yes">
7658	<desc>Returns the host network interface name.</desc>
7659	</attribute>
7660
7661	<attribute name="id" type="uuid" mod="string" readonly="yes">
7662	<desc>Returns the interface UUID.</desc>
7663	</attribute>
7664
7665	<attribute name="networkName" type="wstring" readonly="yes">
7666	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7667	</attribute>
7668
7669	<attribute name="DHCPEnabled" type="boolean" readonly="yes">
7670	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7671	</attribute>
7672
7673	<attribute name="IPAddress" type="wstring" readonly="yes">
7674	<desc>Returns the IP V4 address of the interface.</desc>
7675	</attribute>
7676
7677	<attribute name="networkMask" type="wstring" readonly="yes">
7678	<desc>Returns the network mask of the interface.</desc>
7679	</attribute>
7680
7681	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7682	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7683	</attribute>
7684
7685	<attribute name="IPV6Address" type="wstring" readonly="yes">
7686	<desc>Returns the IP V6 address of the interface.</desc>
7687	</attribute>
7688
7689	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7690	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7691	</attribute>
7692
7693	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7694	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7695	</attribute>
7696
7697	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7698	<desc>Type of protocol encapsulation used.</desc>
7699	</attribute>
7700
7701	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7702	<desc>Status of the interface.</desc>
7703	</attribute>
7704
7705	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7706	<desc>specifies the host interface type.</desc>
7707	</attribute>
7708
7709	<method name="enableStaticIPConfig">
7710	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7711	<param name="IPAddress" type="wstring" dir="in">
7712	<desc>
7713	IP address.
7714	</desc>
7715	</param>
7716	<param name="networkMask" type="wstring" dir="in">
7717	<desc>
7718	network mask.
7719	</desc>
7720	</param>
7721	</method>
7722
7723	<method name="enableStaticIPConfigV6">
7724	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7725	<param name="IPV6Address" type="wstring" dir="in">
7726	<desc>
7727	IP address.
7728	</desc>
7729	</param>
7730	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7731	<desc>
7732	network mask.
7733	</desc>
7734	</param>
7735	</method>
7736
7737	<method name="enableDynamicIPConfig">
7738	<desc>enables the dynamic IP configuration.</desc>
7739	</method>
7740
7741	<method name="DHCPRediscover">
7742	<desc>refreshes the IP configuration for DHCP-enabled interface.</desc>
7743	</method>
7744
7745	</interface>
7746
7747	<interface
7748	name="IHost" extends="$unknown"
7749	uuid="30678943-32df-4830-b413-931b25ac86a0"
7750	wsmap="managed"
7751	>
7752	<desc>
7753	The IHost interface represents the physical machine that this VirtualBox
7754	installation runs on.
7755
7756	An object implementing this interface is returned by the
7757	<link to="IVirtualBox::host" /> attribute. This interface contains
7758	read-only information about the host's physical hardware (such as what
7759	processors and disks are available, what the host operating system is,
7760	and so on) and also allows for manipulating some of the host's hardware,
7761	such as global USB device filters and host interface networking.
7762
7763	</desc>
7764	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7765	<desc>List of DVD drives available on the host.</desc>
7766	</attribute>
7767
7768	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7769	<desc>List of floppy drives available on the host.</desc>
7770	</attribute>
7771
7772	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7773	<desc>
7774	List of USB devices currently attached to the host.
7775	Once a new device is physically attached to the host computer,
7776	it appears in this list and remains there until detached.
7777
7778	<note>
7779	If USB functionality is not available in the given edition of
7780	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7781	</note>
7782	</desc>
7783	</attribute>
7784
7785	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7786	<desc>
7787	List of USB device filters in action.
7788	When a new device is physically attached to the host computer,
7789	filters from this list are applied to it (in order they are stored
7790	in the list). The first matched filter will determine the
7791	<link to="IHostUSBDeviceFilter::action">action</link>
7792	performed on the device.
7793
7794	Unless the device is ignored by these filters, filters of all
7795	currently running virtual machines
7796	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7797
7798	<note>
7799	If USB functionality is not available in the given edition of
7800	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7801	</note>
7802
7803	<see><link to="IHostUSBDeviceFilter"/>,
7804	<link to="USBDeviceState"/></see>
7805	</desc>
7806	</attribute>
7807
7808	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7809	<desc>List of host network interfaces currently defined on the host.</desc>
7810	</attribute>
7811
7812	<attribute name="processorCount" type="unsigned long" readonly="yes">
7813	<desc>Number of (logical) CPUs installed in the host system.</desc>
7814	</attribute>
7815
7816	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7817	<desc>Number of (logical) CPUs online in the host system.</desc>
7818	</attribute>
7819
7820	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7821	<desc>Number of physical processor cores installed in the host system.</desc>
7822	</attribute>
7823
7824	<method name="getProcessorSpeed">
7825	<desc>Query the (approximate) maximum speed of a specified host CPU in
7826	Megahertz.
7827	</desc>
7828	<param name="cpuId" type="unsigned long" dir="in">
7829	<desc>
7830	Identifier of the CPU.
7831	</desc>
7832	</param>
7833	<param name="speed" type="unsigned long" dir="return">
7834	<desc>
7835	Speed value. 0 is returned if value is not known or @a cpuId is
7836	invalid.
7837	</desc>
7838	</param>
7839	</method>
7840
7841	<method name="getProcessorFeature">
7842	<desc>Query whether a CPU feature is supported or not.</desc>
7843	<param name="feature" type="ProcessorFeature" dir="in">
7844	<desc>
7845	CPU Feature identifier.
7846	</desc>
7847	</param>
7848	<param name="supported" type="boolean" dir="return">
7849	<desc>
7850	Feature is supported or not.
7851	</desc>
7852	</param>
7853	</method>
7854
7855	<method name="getProcessorDescription">
7856	<desc>Query the model string of a specified host CPU.
7857	</desc>
7858	<param name="cpuId" type="unsigned long" dir="in">
7859	<desc>
7860	Identifier of the CPU.
7861	<note>
7862	The current implementation might not necessarily return the
7863	description for this exact CPU.
7864	</note>
7865	</desc>
7866	</param>
7867	<param name="description" type="wstring" dir="return">
7868	<desc>
7869	Model string. An empty string is returned if value is not known or
7870	@a cpuId is invalid.
7871	</desc>
7872	</param>
7873	</method>
7874
7875	<method name="getProcessorCPUIDLeaf">
7876	<desc>
7877	Returns the CPU cpuid information for the specified leaf.
7878	</desc>
7879	<param name="cpuId" type="unsigned long" dir="in">
7880	<desc>
7881	Identifier of the CPU. The CPU most be online.
7882	<note>
7883	The current implementation might not necessarily return the
7884	description for this exact CPU.
7885	</note>
7886	</desc>
7887	</param>
7888	<param name="leaf" type="unsigned long" dir="in">
7889	<desc>
7890	CPUID leaf index (eax).
7891	</desc>
7892	</param>
7893	<param name="subLeaf" type="unsigned long" dir="in">
7894	<desc>
7895	CPUID leaf sub index (ecx). This currently only applies to cache
7896	information on Intel CPUs. Use 0 if retrieving values for
7897	<link to="IMachine::setCPUIDLeaf"/>.
7898	</desc>
7899	</param>
7900	<param name="valEax" type="unsigned long" dir="out">
7901	<desc>
7902	CPUID leaf value for register eax.
7903	</desc>
7904	</param>
7905	<param name="valEbx" type="unsigned long" dir="out">
7906	<desc>
7907	CPUID leaf value for register ebx.
7908	</desc>
7909	</param>
7910	<param name="valEcx" type="unsigned long" dir="out">
7911	<desc>
7912	CPUID leaf value for register ecx.
7913	</desc>
7914	</param>
7915	<param name="valEdx" type="unsigned long" dir="out">
7916	<desc>
7917	CPUID leaf value for register edx.
7918	</desc>
7919	</param>
7920	</method>
7921
7922	<attribute name="memorySize" type="unsigned long" readonly="yes">
7923	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7924	</attribute>
7925
7926	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7927	<desc>Available system memory in the host system.</desc>
7928	</attribute>
7929
7930	<attribute name="operatingSystem" type="wstring" readonly="yes">
7931	<desc>Name of the host system's operating system.</desc>
7932	</attribute>
7933
7934	<attribute name="OSVersion" type="wstring" readonly="yes">
7935	<desc>Host operating system's version string.</desc>
7936	</attribute>
7937
7938	<attribute name="UTCTime" type="long long" readonly="yes">
7939	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7940	</attribute>
7941
7942	<attribute name="acceleration3DAvailable" type="boolean" readonly="yes">
7943	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7944	</attribute>
7945
7946	<method name="createHostOnlyNetworkInterface">
7947	<desc>
7948	Creates a new adapter for Host Only Networking.
7949	<result name="E_INVALIDARG">
7950	Host network interface @a name already exists.
7951	</result>
7952	</desc>
7953	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7954	<desc>
7955	Created host interface object.
7956	</desc>
7957	</param>
7958	<param name="progress" type="IProgress" dir="return">
7959	<desc>
7960	Progress object to track the operation completion.
7961	</desc>
7962	</param>
7963	</method>
7964
7965	<method name="removeHostOnlyNetworkInterface">
7966	<desc>
7967	Removes the given Host Only Networking interface.
7968	<result name="VBOX_E_OBJECT_NOT_FOUND">
7969	No host network interface matching @a id found.
7970	</result>
7971	</desc>
7972	<param name="id" type="uuid" mod="string" dir="in">
7973	<desc>
7974	Adapter GUID.
7975	</desc>
7976	</param>
7977	<param name="progress" type="IProgress" dir="return">
7978	<desc>
7979	Progress object to track the operation completion.
7980	</desc>
7981	</param>
7982	</method>
7983
7984	<method name="createUSBDeviceFilter">
7985	<desc>
7986	Creates a new USB device filter. All attributes except
7987	the filter name are set to empty (any match),
7988	<i>active</i> is @c false (the filter is not active).
7989
7990	The created filter can be added to the list of filters using
7991	<link to="#insertUSBDeviceFilter"/>.
7992
7993	<see><link to="#USBDeviceFilters"/></see>
7994	</desc>
7995	<param name="name" type="wstring" dir="in">
7996	<desc>
7997	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7998	</desc>
7999	</param>
8000	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
8001	<desc>Created filter object.</desc>
8002	</param>
8003	</method>
8004
8005	<method name="insertUSBDeviceFilter">
8006	<desc>
8007	Inserts the given USB device to the specified position
8008	in the list of filters.
8009
8010	Positions are numbered starting from @c 0. If the specified
8011	position is equal to or greater than the number of elements in
8012	the list, the filter is added at the end of the collection.
8013
8014	<note>
8015	Duplicates are not allowed, so an attempt to insert a
8016	filter already in the list is an error.
8017	</note>
8018	<note>
8019	If USB functionality is not available in the given edition of
8020	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8021	</note>
8022
8023	<see><link to="#USBDeviceFilters"/></see>
8024
8025	<result name="VBOX_E_INVALID_OBJECT_STATE">
8026	USB device filter is not created within this VirtualBox instance.
8027	</result>
8028	<result name="E_INVALIDARG">
8029	USB device filter already in list.
8030	</result>
8031
8032	</desc>
8033	<param name="position" type="unsigned long" dir="in">
8034	<desc>Position to insert the filter to.</desc>
8035	</param>
8036	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
8037	<desc>USB device filter to insert.</desc>
8038	</param>
8039	</method>
8040
8041	<method name="removeUSBDeviceFilter">
8042	<desc>
8043	Removes a USB device filter from the specified position in the
8044	list of filters.
8045
8046	Positions are numbered starting from @c 0. Specifying a
8047	position equal to or greater than the number of elements in
8048	the list will produce an error.
8049
8050	<note>
8051	If USB functionality is not available in the given edition of
8052	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8053	</note>
8054
8055	<see><link to="#USBDeviceFilters"/></see>
8056
8057	<result name="E_INVALIDARG">
8058	USB device filter list empty or invalid @a position.
8059	</result>
8060
8061	</desc>
8062	<param name="position" type="unsigned long" dir="in">
8063	<desc>Position to remove the filter from.</desc>
8064	</param>
8065	</method>
8066
8067	<method name="findHostDVDDrive">
8068	<desc>
8069	Searches for a host DVD drive with the given @c name.
8070
8071	<result name="VBOX_E_OBJECT_NOT_FOUND">
8072	Given @c name does not correspond to any host drive.
8073	</result>
8074
8075	</desc>
8076	<param name="name" type="wstring" dir="in">
8077	<desc>Name of the host drive to search for</desc>
8078	</param>
8079	<param name="drive" type="IMedium" dir="return">
8080	<desc>Found host drive object</desc>
8081	</param>
8082	</method>
8083
8084	<method name="findHostFloppyDrive">
8085	<desc>
8086	Searches for a host floppy drive with the given @c name.
8087
8088	<result name="VBOX_E_OBJECT_NOT_FOUND">
8089	Given @c name does not correspond to any host floppy drive.
8090	</result>
8091
8092	</desc>
8093	<param name="name" type="wstring" dir="in">
8094	<desc>Name of the host floppy drive to search for</desc>
8095	</param>
8096	<param name="drive" type="IMedium" dir="return">
8097	<desc>Found host floppy drive object</desc>
8098	</param>
8099	</method>
8100
8101	<method name="findHostNetworkInterfaceByName">
8102	<desc>
8103	Searches through all host network interfaces for an interface with
8104	the given @c name.
8105	<note>
8106	The method returns an error if the given @c name does not
8107	correspond to any host network interface.
8108	</note>
8109	</desc>
8110	<param name="name" type="wstring" dir="in">
8111	<desc>Name of the host network interface to search for.</desc>
8112	</param>
8113	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8114	<desc>Found host network interface object.</desc>
8115	</param>
8116	</method>
8117	<method name="findHostNetworkInterfaceById">
8118	<desc>
8119	Searches through all host network interfaces for an interface with
8120	the given GUID.
8121	<note>
8122	The method returns an error if the given GUID does not
8123	correspond to any host network interface.
8124	</note>
8125	</desc>
8126	<param name="id" type="uuid" mod="string" dir="in">
8127	<desc>GUID of the host network interface to search for.</desc>
8128	</param>
8129	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8130	<desc>Found host network interface object.</desc>
8131	</param>
8132	</method>
8133	<method name="findHostNetworkInterfacesOfType">
8134	<desc>
8135	Searches through all host network interfaces and returns a list of interfaces of the specified type
8136	</desc>
8137	<param name="type" type="HostNetworkInterfaceType" dir="in">
8138	<desc>type of the host network interfaces to search for.</desc>
8139	</param>
8140	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
8141	<desc>Found host network interface objects.</desc>
8142	</param>
8143	</method>
8144
8145	<method name="findUSBDeviceById">
8146	<desc>
8147	Searches for a USB device with the given UUID.
8148
8149	<result name="VBOX_E_OBJECT_NOT_FOUND">
8150	Given @c id does not correspond to any USB device.
8151	</result>
8152
8153	<see><link to="IUSBDevice::id"/></see>
8154	</desc>
8155	<param name="id" type="uuid" mod="string" dir="in">
8156	<desc>UUID of the USB device to search for.</desc>
8157	</param>
8158	<param name="device" type="IHostUSBDevice" dir="return">
8159	<desc>Found USB device object.</desc>
8160	</param>
8161	</method>
8162
8163	<method name="findUSBDeviceByAddress">
8164	<desc>
8165	Searches for a USB device with the given host address.
8166
8167	<result name="VBOX_E_OBJECT_NOT_FOUND">
8168	Given @c name does not correspond to any USB device.
8169	</result>
8170
8171	<see><link to="IUSBDevice::address"/></see>
8172	</desc>
8173	<param name="name" type="wstring" dir="in">
8174	<desc>
8175	Address of the USB device (as assigned by the host) to
8176	search for.
8177	</desc>
8178	</param>
8179	<param name="device" type="IHostUSBDevice" dir="return">
8180	<desc>Found USB device object.</desc>
8181	</param>
8182	</method>
8183
8184	<method name="generateMACAddress">
8185	<desc>
8186	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
8187	</desc>
8188	<param name="address" type="wstring" dir="return">
8189	<desc>New Ethernet MAC address.</desc>
8190	</param>
8191	</method>
8192
8193	</interface>
8194
8195	<!--
8196	// ISystemProperties
8197	/////////////////////////////////////////////////////////////////////////
8198	-->
8199
8200	<interface
8201	name="ISystemProperties"
8202	extends="$unknown"
8203	uuid="1d7aca29-97f0-4287-9874-a60ec4f80ea6"
8204	wsmap="managed"
8205	>
8206	<desc>
8207	The ISystemProperties interface represents global properties of the given
8208	VirtualBox installation.
8209
8210	These properties define limits and default values for various attributes
8211	and parameters. Most of the properties are read-only, but some can be
8212	changed by a user.
8213	</desc>
8214
8215	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
8216	<desc>Minimum guest system memory in Megabytes.</desc>
8217	</attribute>
8218
8219	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
8220	<desc>Maximum guest system memory in Megabytes.</desc>
8221	</attribute>
8222
8223	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
8224	<desc>Minimum guest video memory in Megabytes.</desc>
8225	</attribute>
8226
8227	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
8228	<desc>Maximum guest video memory in Megabytes.</desc>
8229	</attribute>
8230
8231	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
8232	<desc>Minimum CPU count.</desc>
8233	</attribute>
8234
8235	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
8236	<desc>Maximum CPU count.</desc>
8237	</attribute>
8238
8239	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
8240	<desc>Maximum of monitors which could be connected.</desc>
8241	</attribute>
8242
8243	<attribute name="infoVDSize" type="long long" readonly="yes">
8244	<desc>Maximum size of a virtual disk image in bytes. Informational value,
8245	does not reflect the limits of any virtual disk image format.</desc>
8246	</attribute>
8247
8248	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
8249	<desc>
8250	Maximum number of serial ports associated with every
8251	<link to="IMachine"/> instance.
8252	</desc>
8253	</attribute>
8254
8255	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
8256	<desc>
8257	Maximum number of parallel ports associated with every
8258	<link to="IMachine"/> instance.
8259	</desc>
8260	</attribute>
8261
8262	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
8263	<desc>
8264	Maximum device position in the boot order. This value corresponds
8265	to the total number of devices a machine can boot from, to make it
8266	possible to include all possible devices to the boot list.
8267	<see><link to="IMachine::setBootOrder"/></see>
8268	</desc>
8269	</attribute>
8270
8271	<attribute name="defaultMachineFolder" type="wstring">
8272	<desc>
8273	Full path to the default directory used to create new or open
8274	existing machines when a machine settings file name contains no
8275	path.
8276
8277	Starting with VirtualBox 4.0, by default, this attribute contains
8278	the full path of folder named "VirtualBox VMs" in the user's
8279	home directory, which depends on the host platform.
8280
8281	When setting this attribute, a full path must be specified.
8282	Setting this property to @c null or an empty string or the
8283	special value "Machines" (for compatibility reasons) will restore
8284	that default value.
8285
8286	If the folder specified herein does not exist, it will be created
8287	automatically as needed.
8288
8289	<see>
8290	<link to="IVirtualBox::createMachine"/>,
8291	<link to="IVirtualBox::openMachine"/>
8292	</see>
8293	</desc>
8294	</attribute>
8295
8296	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8297	<desc>
8298	List of all medium storage formats supported by this VirtualBox
8299	installation.
8300
8301	Keep in mind that the medium format identifier
8302	(<link to="IMediumFormat::id"/>) used in other API calls like
8303	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8304	medium format is a case-insensitive string. This means that, for
8305	example, all of the following strings:
8306	<pre>
8307	"VDI"
8308	"vdi"
8309	"VdI"</pre>
8310	refer to the same medium format.
8311
8312	Note that the virtual medium framework is backend-based, therefore
8313	the list of supported formats depends on what backends are currently
8314	installed.
8315
8316	<see><link to="IMediumFormat"/></see>
8317	</desc>
8318	</attribute>
8319
8320	<attribute name="defaultHardDiskFormat" type="wstring">
8321	<desc>
8322	Identifier of the default medium format used by VirtualBox.
8323
8324	The medium format set by this attribute is used by VirtualBox
8325	when the medium format was not specified explicitly. One example is
8326	<link to="IVirtualBox::createHardDisk"/> with the empty
8327	format argument. A more complex example is implicit creation of
8328	differencing media when taking a snapshot of a virtual machine:
8329	this operation will try to use a format of the parent medium first
8330	and if this format does not support differencing media the default
8331	format specified by this argument will be used.
8332
8333	The list of supported medium formats may be obtained by the
8334	<link to="#mediumFormats"/> call. Note that the default medium
8335	format must have a capability to create differencing media;
8336	otherwise operations that create media implicitly may fail
8337	unexpectedly.
8338
8339	The initial value of this property is <tt>"VDI"</tt> in the current
8340	version of the VirtualBox product, but may change in the future.
8341
8342	<note>
8343	Setting this property to @c null or empty string will restore the
8344	initial value.
8345	</note>
8346
8347	<see>
8348	<link to="#mediumFormats"/>,
8349	<link to="IMediumFormat::id"/>,
8350	<link to="IVirtualBox::createHardDisk"/>
8351	</see>
8352	</desc>
8353	</attribute>
8354
8355	<attribute name="freeDiskSpaceWarning" type="long long">
8356	<desc>Issue a warning if the free disk space is below (or in some disk
8357	intensive operation is expected to go below) the given size in
8358	bytes.</desc>
8359	</attribute>
8360
8361	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8362	<desc>Issue a warning if the free disk space is below (or in some disk
8363	intensive operation is expected to go below) the given percentage.</desc>
8364	</attribute>
8365
8366	<attribute name="freeDiskSpaceError" type="long long">
8367	<desc>Issue an error if the free disk space is below (or in some disk
8368	intensive operation is expected to go below) the given size in
8369	bytes.</desc>
8370	</attribute>
8371
8372	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8373	<desc>Issue an error if the free disk space is below (or in some disk
8374	intensive operation is expected to go below) the given percentage.</desc>
8375	</attribute>
8376
8377	<attribute name="VRDEAuthLibrary" type="wstring">
8378	<desc>
8379	Library that provides authentication for Remote Desktop clients. The library
8380	is used if a virtual machine's authentication type is set to "external"
8381	in the VM RemoteDisplay configuration.
8382
8383	The system library extension (".DLL" or ".so") must be omitted.
8384	A full path can be specified; if not, then the library must reside on the
8385	system's default library path.
8386
8387	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8388	of that name in one of the default VirtualBox library directories.
8389
8390	For details about VirtualBox authentication libraries and how to implement
8391	them, please refer to the VirtualBox manual.
8392
8393	<note>
8394	Setting this property to @c null or empty string will restore the
8395	initial value.
8396	</note>
8397	</desc>
8398	</attribute>
8399
8400	<attribute name="webServiceAuthLibrary" type="wstring">
8401	<desc>
8402	Library that provides authentication for webservice clients. The library
8403	is used if a virtual machine's authentication type is set to "external"
8404	in the VM RemoteDisplay configuration and will be called from
8405	within the <link to="IWebsessionManager::logon" /> implementation.
8406
8407	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8408	there is no per-VM setting for this, as the webservice is a global
8409	resource (if it is running). Only for this setting (for the webservice),
8410	setting this value to a literal <tt>"null"</tt> string disables authentication,
8411	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8412	no matter what user name and password are supplied.
8413
8414	The initial value of this property is <tt>"VBoxAuth"</tt>,
8415	meaning that the webservice will use the same authentication
8416	library that is used by default for VRDE (again, see
8417	<link to="ISystemProperties::VRDEAuthLibrary" />).
8418	The format and calling convention of authentication libraries
8419	is the same for the webservice as it is for VRDE.
8420
8421	<note>
8422	Setting this property to @c null or empty string will restore the
8423	initial value.
8424	</note>
8425	</desc>
8426	</attribute>
8427
8428	<attribute name="defaultVRDEExtPack" type="wstring">
8429	<desc>
8430	The name of the extension pack providing the default VRDE.
8431
8432	This attribute is for choosing between multiple extension packs
8433	providing VRDE. If only one is installed, it will automatically be the
8434	default one. The attribute value can be empty if no VRDE extension
8435	pack is installed.
8436
8437	For details about VirtualBox Remote Desktop Extension and how to
8438	implement one, please refer to the VirtualBox SDK.
8439	</desc>
8440	</attribute>
8441
8442	<attribute name="logHistoryCount" type="unsigned long">
8443	<desc>
8444	This value specifies how many old release log files are kept.
8445	</desc>
8446	</attribute>
8447
8448	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8449	<desc>This value hold the default audio driver for the current
8450	system.</desc>
8451	</attribute>
8452
8453	<attribute name="autostartDatabasePath" type="wstring">
8454	<desc>
8455	The path to the autostart database. Depending on the host this might
8456	be a filesystem path or something else.
8457	</desc>
8458	</attribute>
8459
8460	<attribute name="defaultAdditionsISO" type="wstring">
8461	<desc>
8462	The path to the default Guest Additions ISO image. Can be empty if
8463	the location is not known in this installation.
8464	</desc>
8465	</attribute>
8466
8467	<method name="getMaxNetworkAdapters">
8468	<desc>
8469	Maximum total number of network adapters associated with every
8470	<link to="IMachine"/> instance.
8471	</desc>
8472
8473	<param name="chipset" type="ChipsetType" dir="in">
8474	<desc>The chipset type to get the value for.</desc>
8475	</param>
8476
8477
8478	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8479	<desc>The maximum total number of network adapters allowed.</desc>
8480	</param>
8481
8482	</method>
8483
8484	<method name="getMaxNetworkAdaptersOfType">
8485	<desc>
8486	Maximum number of network adapters of a given attachment type,
8487	associated with every <link to="IMachine"/> instance.
8488	</desc>
8489
8490	<param name="chipset" type="ChipsetType" dir="in">
8491	<desc>The chipset type to get the value for.</desc>
8492	</param>
8493
8494	<param name="type" type="NetworkAttachmentType" dir="in">
8495	<desc>Type of attachment.</desc>
8496	</param>
8497
8498	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8499	<desc>The maximum number of network adapters allowed for
8500	particular chipset and attachment type.</desc>
8501	</param>
8502
8503	</method>
8504
8505
8506	<method name="getMaxDevicesPerPortForStorageBus">
8507	<desc>Returns the maximum number of devices which can be attached to a port
8508	for the given storage bus.</desc>
8509
8510	<param name="bus" type="StorageBus" dir="in">
8511	<desc>The storage bus type to get the value for.</desc>
8512	</param>
8513
8514	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8515	<desc>The maximum number of devices which can be attached to the port for the given
8516	storage bus.</desc>
8517	</param>
8518	</method>
8519
8520	<method name="getMinPortCountForStorageBus">
8521	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8522
8523	<param name="bus" type="StorageBus" dir="in">
8524	<desc>The storage bus type to get the value for.</desc>
8525	</param>
8526
8527	<param name="minPortCount" type="unsigned long" dir="return">
8528	<desc>The minimum number of ports for the given storage bus.</desc>
8529	</param>
8530	</method>
8531
8532	<method name="getMaxPortCountForStorageBus">
8533	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8534
8535	<param name="bus" type="StorageBus" dir="in">
8536	<desc>The storage bus type to get the value for.</desc>
8537	</param>
8538
8539	<param name="maxPortCount" type="unsigned long" dir="return">
8540	<desc>The maximum number of ports for the given storage bus.</desc>
8541	</param>
8542	</method>
8543
8544	<method name="getMaxInstancesOfStorageBus">
8545	<desc>Returns the maximum number of storage bus instances which
8546	can be configured for each VM. This corresponds to the number of
8547	storage controllers one can have. Value may depend on chipset type
8548	used.</desc>
8549
8550	<param name="chipset" type="ChipsetType" dir="in">
8551	<desc>The chipset type to get the value for.</desc>
8552	</param>
8553
8554	<param name="bus" type="StorageBus" dir="in">
8555	<desc>The storage bus type to get the value for.</desc>
8556	</param>
8557
8558	<param name="maxInstances" type="unsigned long" dir="return">
8559	<desc>The maximum number of instances for the given storage bus.</desc>
8560	</param>
8561	</method>
8562
8563	<method name="getDeviceTypesForStorageBus">
8564	<desc>Returns list of all the supported device types
8565	(<link to="DeviceType"/>) for the given type of storage
8566	bus.</desc>
8567
8568	<param name="bus" type="StorageBus" dir="in">
8569	<desc>The storage bus type to get the value for.</desc>
8570	</param>
8571
8572	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8573	<desc>The list of all supported device types for the given storage bus.</desc>
8574	</param>
8575	</method>
8576
8577	<method name="getDefaultIoCacheSettingForStorageController">
8578	<desc>Returns the default I/O cache setting for the
8579	given storage controller</desc>
8580
8581	<param name="controllerType" type="StorageControllerType" dir="in">
8582	<desc>The storage controller to the setting for.</desc>
8583	</param>
8584
8585	<param name="enabled" type="boolean" dir="return">
8586	<desc>Returned flag indicating the default value</desc>
8587	</param>
8588	</method>
8589	</interface>
8590
8591	<!--
8592	// IGuest
8593	/////////////////////////////////////////////////////////////////////////
8594	-->
8595
8596	<interface
8597	name="IGuestOSType" extends="$unknown"
8598	uuid="6d968f9a-858b-4c50-bf17-241f069e94c2"
8599	wsmap="struct"
8600	>
8601	<desc>
8602	</desc>
8603
8604	<attribute name="familyId" type="wstring" readonly="yes">
8605	<desc>Guest OS family identifier string.</desc>
8606	</attribute>
8607
8608	<attribute name="familyDescription" type="wstring" readonly="yes">
8609	<desc>Human readable description of the guest OS family.</desc>
8610	</attribute>
8611
8612	<attribute name="id" type="wstring" readonly="yes">
8613	<desc>Guest OS identifier string.</desc>
8614	</attribute>
8615
8616	<attribute name="description" type="wstring" readonly="yes">
8617	<desc>Human readable description of the guest OS.</desc>
8618	</attribute>
8619
8620	<attribute name="is64Bit" type="boolean" readonly="yes">
8621	<desc>Returns @c true if the given OS is 64-bit</desc>
8622	</attribute>
8623
8624	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8625	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8626	</attribute>
8627
8628	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8629	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8630	</attribute>
8631
8632	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8633	<desc>Recommended RAM size in Megabytes.</desc>
8634	</attribute>
8635
8636	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8637	<desc>Recommended video RAM size in Megabytes.</desc>
8638	</attribute>
8639
8640	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8641	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8642	</attribute>
8643
8644	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8645	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8646	</attribute>
8647
8648	<attribute name="recommendedHDD" type="long long" readonly="yes">
8649	<desc>Recommended hard disk size in bytes.</desc>
8650	</attribute>
8651
8652	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8653	<desc>Returns recommended network adapter for this OS type.</desc>
8654	</attribute>
8655
8656	<attribute name="recommendedPAE" type="boolean" readonly="yes">
8657	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8658	</attribute>
8659
8660	<attribute name="recommendedDVDStorageController" type="StorageControllerType" readonly="yes">
8661	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8662	</attribute>
8663
8664	<attribute name="recommendedDVDStorageBus" type="StorageBus" readonly="yes">
8665	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8666	</attribute>
8667
8668	<attribute name="recommendedHDStorageController" type="StorageControllerType" readonly="yes">
8669	<desc>Recommended storage controller type for HD drives.</desc>
8670	</attribute>
8671
8672	<attribute name="recommendedHDStorageBus" type="StorageBus" readonly="yes">
8673	<desc>Recommended storage bus type for HD drives.</desc>
8674	</attribute>
8675
8676	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8677	<desc>Recommended firmware type.</desc>
8678	</attribute>
8679
8680	<attribute name="recommendedUSBHID" type="boolean" readonly="yes">
8681	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8682	</attribute>
8683
8684	<attribute name="recommendedHPET" type="boolean" readonly="yes">
8685	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8686	</attribute>
8687
8688	<attribute name="recommendedUSBTablet" type="boolean" readonly="yes">
8689	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8690	</attribute>
8691
8692	<attribute name="recommendedRTCUseUTC" type="boolean" readonly="yes">
8693	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8694	</attribute>
8695
8696	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8697	<desc>Recommended chipset type.</desc>
8698	</attribute>
8699
8700	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8701	<desc>Recommended audio type.</desc>
8702	</attribute>
8703
8704	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8705	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8706	</attribute>
8707
8708	<attribute name="recommendedUSB" type="boolean" readonly="yes">
8709	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8710	</attribute>
8711
8712	</interface>
8713
8714	<enum
8715	name="AdditionsFacilityType"
8716	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8717	>
8718	<desc>
8719	Guest Additions facility IDs.
8720	</desc>
8721
8722	<const name="None" value="0">
8723	<desc>No/invalid facility.</desc>
8724	</const>
8725	<const name="VBoxGuestDriver" value="20">
8726	<desc>VirtualBox base driver (VBoxGuest).</desc>
8727	</const>
8728	<const name="AutoLogon" value="90">
8729	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8730	</const>
8731	<const name="VBoxService" value="100">
8732	<desc>VirtualBox system service (VBoxService).</desc>
8733	</const>
8734	<const name="VBoxTrayClient" value="101">
8735	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8736	</const>
8737	<const name="Seamless" value="1000">
8738	<desc>Seamless guest desktop integration.</desc>
8739	</const>
8740	<const name="Graphics" value="1100">
8741	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8742	are not immediately acted on and guest display resizes are probably not initiated by
8743	the guest additions.
8744	</desc>
8745	</const>
8746	<const name="All" value="2147483646">
8747	<desc>All facilities selected.</desc>
8748	</const>
8749	</enum>
8750
8751	<enum
8752	name="AdditionsFacilityClass"
8753	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8754	>
8755	<desc>
8756	Guest Additions facility classes.
8757	</desc>
8758
8759	<const name="None" value="0">
8760	<desc>No/invalid class.</desc>
8761	</const>
8762	<const name="Driver" value="10">
8763	<desc>Driver.</desc>
8764	</const>
8765	<const name="Service" value="30">
8766	<desc>System service.</desc>
8767	</const>
8768	<const name="Program" value="50">
8769	<desc>Program.</desc>
8770	</const>
8771	<const name="Feature" value="100">
8772	<desc>Feature.</desc>
8773	</const>
8774	<const name="ThirdParty" value="999">
8775	<desc>Third party.</desc>
8776	</const>
8777	<const name="All" value="2147483646">
8778	<desc>All facility classes selected.</desc>
8779	</const>
8780	</enum>
8781
8782	<enum
8783	name="AdditionsFacilityStatus"
8784	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8785	>
8786	<desc>
8787	Guest Additions facility states.
8788	</desc>
8789
8790	<const name="Inactive" value="0">
8791	<desc>Facility is not active.</desc>
8792	</const>
8793	<const name="Paused" value="1">
8794	<desc>Facility has been paused.</desc>
8795	</const>
8796	<const name="PreInit" value="20">
8797	<desc>Facility is preparing to initialize.</desc>
8798	</const>
8799	<const name="Init" value="30">
8800	<desc>Facility is initializing.</desc>
8801	</const>
8802	<const name="Active" value="50">
8803	<desc>Facility is up and running.</desc>
8804	</const>
8805	<const name="Terminating" value="100">
8806	<desc>Facility is shutting down.</desc>
8807	</const>
8808	<const name="Terminated" value="101">
8809	<desc>Facility successfully shut down.</desc>
8810	</const>
8811	<const name="Failed" value="800">
8812	<desc>Facility failed to start.</desc>
8813	</const>
8814	<const name="Unknown" value="999">
8815	<desc>Facility status is unknown.</desc>
8816	</const>
8817	</enum>
8818
8819	<interface
8820	name="IAdditionsFacility" extends="$unknown"
8821	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8822	wsmap="struct"
8823	>
8824	<desc>
8825	Structure representing a Guest Additions facility.
8826	</desc>
8827
8828	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8829	<desc>The class this facility is part of.</desc>
8830	</attribute>
8831
8832	<attribute name="lastUpdated" type="long long" readonly="yes">
8833	<desc>
8834	Time stamp of the last status update,
8835	in milliseconds since 1970-01-01 UTC.
8836	</desc>
8837	</attribute>
8838
8839	<attribute name="name" type="wstring" readonly="yes">
8840	<desc>The facility's friendly name.</desc>
8841	</attribute>
8842
8843	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8844	<desc>The current status.</desc>
8845	</attribute>
8846
8847	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8848	<desc>The facility's type ID.</desc>
8849	</attribute>
8850	</interface>
8851
8852	<enum
8853	name="AdditionsRunLevelType"
8854	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8855	>
8856	<desc>
8857	Guest Additions run level type.
8858	</desc>
8859
8860	<const name="None" value="0">
8861	<desc>Guest Additions are not loaded.</desc>
8862	</const>
8863	<const name="System" value="1">
8864	<desc>Guest drivers are loaded.</desc>
8865	</const>
8866	<const name="Userland" value="2">
8867	<desc>Common components (such as application services) are loaded.</desc>
8868	</const>
8869	<const name="Desktop" value="3">
8870	<desc>Per-user desktop components are loaded.</desc>
8871	</const>
8872	</enum>
8873
8874	<enum
8875	name="AdditionsUpdateFlag"
8876	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8877	>
8878	<desc>
8879	Guest Additions update flags.
8880	</desc>
8881
8882	<const name="None" value="0">
8883	<desc>No flag set.</desc>
8884	</const>
8885	<const name="WaitForUpdateStartOnly" value="1">
8886	<desc>Only wait for the update process being started and do not
8887	wait while peforming the actual update.</desc>
8888	</const>
8889	</enum>
8890
8891	<enum
8892	name="ExecuteProcessFlag"
8893	uuid="1c49b831-b2c7-4a30-97dd-999a2e2cbf90"
8894	>
8895	<desc>
8896	Guest process execution flags.
8897	</desc>
8898
8899	<const name="None" value="0">
8900	<desc>No flag set.</desc>
8901	</const>
8902	<const name="WaitForProcessStartOnly" value="1">
8903	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8904	process itself then uses an infinite timeout.</desc>
8905	</const>
8906	<const name="IgnoreOrphanedProcesses" value="2">
8907	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8908	</const>
8909	<const name="Hidden" value="4">
8910	<desc>Do not show the started process according to the guest OS guidelines.</desc>
8911	</const>
8912	<const name="NoProfile" value="8">
8913	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8914	</const>
8915	<const name="WaitForStdOut" value="16">
8916	<desc>The guest process waits until all data from stdout is read out.</desc>
8917	</const>
8918	<const name="WaitForStdErr" value="32">
8919	<desc>The guest process waits until all data from stderr is read out.</desc>
8920	</const>
8921	</enum>
8922
8923	<enum
8924	name="ExecuteProcessStatus"
8925	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8926	>
8927	<desc>
8928	Guest process execution status.
8929	</desc>
8930	<const name="Undefined" value="0">
8931	<desc>Process is in an undefined state.</desc>
8932	</const>
8933
8934	<const name="Started" value="1">
8935	<desc>Process has been started.</desc>
8936	</const>
8937	<const name="TerminatedNormally" value="2">
8938	<desc>Process terminated normally.</desc>
8939	</const>
8940	<const name="TerminatedSignal" value="3">
8941	<desc>Process terminated via signal.</desc>
8942	</const>
8943	<const name="TerminatedAbnormally" value="4">
8944	<desc>Process terminated abnormally.</desc>
8945	</const>
8946	<const name="TimedOutKilled" value="5">
8947	<desc>Process timed out and was killed.</desc>
8948	</const>
8949	<const name="TimedOutAbnormally" value="6">
8950	<desc>Process timed out and was not killed successfully.</desc>
8951	</const>
8952	<const name="Down" value="7">
8953	<desc>Service/OS is stopping, process was killed.</desc>
8954	</const>
8955	<const name="Error" value="8">
8956	<desc>Something went wrong (error code in flags).</desc>
8957	</const>
8958	</enum>
8959
8960	<enum
8961	name="FileSeekType"
8962	uuid="1b73f4f3-3515-4073-a506-76878d9e2541"
8963	>
8964	<desc>
8965	TODO
8966	</desc>
8967
8968	<const name="Set" value="0">
8969	<desc>TODO</desc>
8970	</const>
8971	<const name="Current" value="1">
8972	<desc>TODO</desc>
8973	</const>
8974	</enum>
8975
8976	<enum
8977	name="ProcessInputFlag"
8978	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8979	>
8980	<desc>
8981	Guest process input flags.
8982	</desc>
8983	<const name="None" value="0">
8984	<desc>No flag set.</desc>
8985	</const>
8986	<const name="EndOfFile" value="1">
8987	<desc>End of file (input) reached.</desc>
8988	</const>
8989	</enum>
8990
8991	<enum
8992	name="ProcessOutputFlag"
8993	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8994	>
8995	<desc>
8996	Guest process output flags for specifying which
8997	type of output to retrieve.
8998	</desc>
8999	<const name="None" value="0">
9000	<desc>No flags set. Get output from stdout.</desc>
9001	</const>
9002	<const name="StdErr" value="1">
9003	<desc>Get output from stderr.</desc>
9004	</const>
9005	</enum>
9006
9007	<enum
9008	name="ProcessWaitForFlag"
9009	uuid="23b550c7-78e1-437e-98f0-65fd9757bcd2"
9010	>
9011	<desc>
9012	TODO
9013	</desc>
9014
9015	<const name="None" value="0">
9016	<desc>TODO</desc>
9017	</const>
9018	<const name="Start" value="1">
9019	<desc>TODO</desc>
9020	</const>
9021	<const name="Terminate" value="2">
9022	<desc>TODO</desc>
9023	</const>
9024	<const name="StdIn" value="4">
9025	<desc>TODO</desc>
9026	</const>
9027	<const name="StdOut" value="8">
9028	<desc>TODO</desc>
9029	</const>
9030	<const name="StdErr" value="16">
9031	<desc>TODO</desc>
9032	</const>
9033	</enum>
9034
9035	<enum
9036	name="ProcessWaitResult"
9037	uuid="24a4d49f-a7c1-44b0-b01f-5686a316466b"
9038	>
9039	<desc>
9040	TODO
9041	</desc>
9042
9043	<const name="None" value="0">
9044	<desc>TODO</desc>
9045	</const>
9046	<const name="Start" value="1">
9047	<desc>TODO</desc>
9048	</const>
9049	<const name="Terminate" value="2">
9050	<desc>TODO</desc>
9051	</const>
9052	<const name="Status" value="3">
9053	<desc>TODO</desc>
9054	</const>
9055	<const name="Error" value="4">
9056	<desc>TODO</desc>
9057	</const>
9058	<const name="Timeout" value="5">
9059	<desc>TODO</desc>
9060	</const>
9061	<const name="StdIn" value="6">
9062	<desc>TODO</desc>
9063	</const>
9064	<const name="StdOut" value="7">
9065	<desc>TODO</desc>
9066	</const>
9067	<const name="StdErr" value="8">
9068	<desc>TODO</desc>
9069	</const>
9070	<const name="Any" value="9">
9071	<desc>TODO</desc>
9072	</const>
9073	</enum>
9074
9075	<enum
9076	name="CopyFileFlag"
9077	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
9078	>
9079	<desc>
9080	Host/Guest copy flags. At the moment none of these flags
9081	are implemented.
9082	</desc>
9083	<const name="None" value="0">
9084	<desc>No flag set.</desc>
9085	</const>
9086	<const name="Recursive" value="1">
9087	<desc>Copy directories recursively.</desc>
9088	</const>
9089	<const name="Update" value="2">
9090	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
9091	</const>
9092	<const name="FollowLinks" value="4">
9093	<desc>Follow symbolic links.</desc>
9094	</const>
9095	</enum>
9096
9097	<enum
9098	name="DirectoryCreateFlag"
9099	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
9100	>
9101	<desc>
9102	Directory creation flags.
9103	</desc>
9104	<const name="None" value="0">
9105	<desc>No flag set.</desc>
9106	</const>
9107	<const name="Parents" value="1">
9108	<desc>No error if existing, make parent directories as needed.</desc>
9109	</const>
9110	</enum>
9111
9112	<enum
9113	name="DirectoryRemoveRecFlag"
9114	uuid="455aabf0-7692-48f6-9061-f21579b65769"
9115	>
9116	<desc>
9117	TODO
9118	</desc>
9119
9120	<const name="None" value="0">
9121	<desc>No flag set.</desc>
9122	</const>
9123	<const name="ContentAndDir" value="1">
9124	<desc>TODO</desc>
9125	</const>
9126	<const name="ContentOnly" value="2">
9127	<desc>TODO</desc>
9128	</const>
9129	</enum>
9130
9131	<enum
9132	name="PathRenameFlag"
9133	uuid="f3baa09f-c758-453d-b91c-c7787d76351d"
9134	>
9135	<desc>
9136	TODO
9137	</desc>
9138
9139	<const name="None" value="0">
9140	<desc>No flag set.</desc>
9141	</const>
9142	<const name="NoReplace" value="1">
9143	<desc>TODO</desc>
9144	</const>
9145	<const name="Replace" value="2">
9146	<desc>TODO</desc>
9147	</const>
9148	<const name="NoSymlinks" value="4">
9149	<desc>TODO</desc>
9150	</const>
9151	</enum>
9152
9153	<enum
9154	name="ProcessCreateFlag"
9155	uuid="35192799-bfde-405d-9bea-c735ab9998e4"
9156	>
9157	<desc>
9158	Guest process execution flags.
9159	</desc>
9160
9161	<const name="None" value="0">
9162	<desc>No flag set.</desc>
9163	</const>
9164	<const name="WaitForProcessStartOnly" value="1">
9165	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
9166	process itself then uses an infinite timeout.</desc>
9167	</const>
9168	<const name="IgnoreOrphanedProcesses" value="2">
9169	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
9170	</const>
9171	<const name="Hidden" value="4">
9172	<desc>Do not show the started process according to the guest OS guidelines.</desc>
9173	</const>
9174	<const name="NoProfile" value="8">
9175	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
9176	</const>
9177	<const name="WaitForStdOut" value="16">
9178	<desc>The guest process waits until all data from stdout is read out.</desc>
9179	</const>
9180	<const name="WaitForStdErr" value="32">
9181	<desc>The guest process waits until all data from stderr is read out.</desc>
9182	</const>
9183	<const name="ExpandArguments" value="64">
9184	<desc>Expands environment variables in process arguments.</desc>
9185	</const>
9186	</enum>
9187
9188	<enum
9189	name="ProcessPriority"
9190	uuid="ee8cac50-e232-49fe-806b-d1214d9c2e49"
9191	>
9192	<desc>
9193	TODO
9194	</desc>
9195
9196	<const name="Invalid" value="0">
9197	<desc>TODO</desc>
9198	</const>
9199	<const name="Default" value="1">
9200	<desc>TODO</desc>
9201	</const>
9202	</enum>
9203
9204	<enum
9205	name="SymlinkType"
9206	uuid="37794668-f8f1-4714-98a5-6f8fa2ed0118"
9207	>
9208	<desc>
9209	TODO
9210	</desc>
9211
9212	<const name="Unknown" value="0">
9213	<desc>TODO</desc>
9214	</const>
9215	<const name="Directory" value="1">
9216	<desc>TODO</desc>
9217	</const>
9218	<const name="File" value="2">
9219	<desc>TODO</desc>
9220	</const>
9221	</enum>
9222
9223	<enum
9224	name="SymlinkReadFlag"
9225	uuid="b7fe2b9d-790e-4b25-8adf-1ca33026931f"
9226	>
9227	<desc>
9228	TODO
9229	</desc>
9230
9231	<const name="None" value="0">
9232	<desc>TODO.</desc>
9233	</const>
9234	<const name="NoSymlinks" value="1">
9235	<desc>TODO</desc>
9236	</const>
9237	</enum>
9238
9239	<enum
9240	name="ProcessStatus"
9241	uuid="4d52368f-5b48-4bfe-b486-acf89139b52f"
9242	>
9243	<desc>
9244	Guest process execution status.
9245	</desc>
9246	<const name="Undefined" value="0">
9247	<desc>Process is in an undefined state.</desc>
9248	</const>
9249
9250	<const name="Starting" value="10">
9251	<desc>TODO</desc>
9252	</const>
9253	<const name="Started" value="100">
9254	<desc>Process has been started.</desc>
9255	</const>
9256	<const name="Paused" value="110">
9257	<desc>TODO</desc>
9258	</const>
9259	<const name="Terminating" value="480">
9260	<desc>TODO</desc>
9261	</const>
9262	<const name="TerminatedNormally" value="500">
9263	<desc>Process terminated normally.</desc>
9264	</const>
9265	<const name="TerminatedSignal" value="510">
9266	<desc>Process terminated via signal.</desc>
9267	</const>
9268	<const name="TerminatedAbnormally" value="511">
9269	<desc>Process terminated abnormally.</desc>
9270	</const>
9271	<const name="TimedOutKilled" value="512">
9272	<desc>Process timed out and was killed.</desc>
9273	</const>
9274	<const name="TimedOutAbnormally" value="513">
9275	<desc>Process timed out and was not killed successfully.</desc>
9276	</const>
9277	<const name="Down" value="600">
9278	<desc>Service/OS is stopping, process was killed.</desc>
9279	</const>
9280	<const name="Error" value="800">
9281	<desc>Something went wrong (error code in flags).</desc>
9282	</const>
9283	</enum>
9284
9285	<enum
9286	name="FsObjType"
9287	uuid="a1ed437c-b3c3-4ca2-b19c-4239d658d5e8"
9288	>
9289	<desc>
9290	TODO
9291	</desc>
9292
9293	<const name="Undefined" value="0">
9294	<desc>TODO</desc>
9295	</const>
9296	<const name="FIFO" value="1">
9297	<desc>TODO</desc>
9298	</const>
9299	<const name="DevChar" value="10">
9300	<desc>TODO</desc>
9301	</const>
9302	<const name="DevBlock" value="11">
9303	<desc>TODO</desc>
9304	</const>
9305	<const name="Directory" value="50">
9306	<desc>TODO</desc>
9307	</const>
9308	<const name="File" value="80">
9309	<desc>TODO</desc>
9310	</const>
9311	<const name="Symlink" value="100">
9312	<desc>TODO</desc>
9313	</const>
9314	<const name="Socket" value="200">
9315	<desc>TODO</desc>
9316	</const>
9317	<const name="Whiteout" value="400">
9318	<desc>TODO</desc>
9319	</const>
9320	</enum>
9321
9322	<enum
9323	name="DragAndDropAction"
9324	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
9325	>
9326	<desc>
9327	Possible actions within an Drag and Drop operation.
9328	</desc>
9329
9330	<const name="Ignore" value="0">
9331	<desc>Do nothing.</desc>
9332	</const>
9333
9334	<const name="Copy" value="1">
9335	<desc>Copy the item to the target.</desc>
9336	</const>
9337
9338	<const name="Move" value="2">
9339	<desc>Move the item to the target.</desc>
9340	</const>
9341
9342	<const name="Link" value="3">
9343	<desc>Link the item from within the target.</desc>
9344	</const>
9345	</enum>
9346
9347	<enum
9348	name="DirectoryOpenFlag"
9349	uuid="5138837a-8fd2-4194-a1b0-08f7bc3949d0"
9350	>
9351	<desc>
9352	Directory open flags.
9353	</desc>
9354	<const name="None" value="0">
9355	<desc>No flag set.</desc>
9356	</const>
9357	<const name="NoSymlinks" value="1">
9358	<desc>Don't allow symbolic links as part of the path.</desc>
9359	</const>
9360	</enum>
9361
9362	<enum
9363	name="GuestDirEntryType"
9364	uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
9365	>
9366	<desc>
9367	Guest directory entry type.
9368	</desc>
9369	<const name="Unknown" value="0">
9370	<desc>Unknown.</desc>
9371	</const>
9372	<const name="Directory" value="4">
9373	<desc>Regular file.</desc>
9374	</const>
9375	<const name="File" value="10">
9376	<desc>Regular file.</desc>
9377	</const>
9378	<const name="Symlink" value="12">
9379	<desc>Symbolic link.</desc>
9380	</const>
9381	</enum>
9382
9383	<interface
9384	name="IGuestDirEntry" extends="$unknown"
9385	uuid="20a66efc-c2f6-4438-826f-38454c04369e"
9386	wsmap="struct"
9387	>
9388	<desc>
9389	Structure representing a directory entry on the guest OS.
9390	</desc>
9391	<attribute name="nodeId" type="long long" readonly="yes">
9392	<desc>The unique identifier (within the guest's file system) of this file system object.</desc>
9393	</attribute>
9394	<attribute name="name" type="wstring" readonly="yes">
9395	<desc>The filename.</desc>
9396	</attribute>
9397	<attribute name="type" type="GuestDirEntryType" readonly="yes">
9398	<desc>The entry type.</desc>
9399	</attribute>
9400	</interface>
9401
9402	<interface
9403	name="IGuestSession" extends="$unknown"
9404	uuid="45aca317-55d7-4b6c-bbec-d053289118b9"
9405	wsmap="managed"
9406	>
9407
9408	<attribute name="user" type="wstring" readonly="yes">
9409	<desc>
9410	TODO
9411	<note>
9412	TODO
9413	</note>
9414	</desc>
9415	</attribute>
9416
9417	<attribute name="domain" type="wstring" readonly="yes">
9418	<desc>
9419	TODO
9420	<note>
9421	TODO
9422	</note>
9423	</desc>
9424	</attribute>
9425
9426	<attribute name="name" type="wstring" readonly="yes">
9427	<desc>
9428	TODO
9429	<note>
9430	TODO
9431	</note>
9432	</desc>
9433	</attribute>
9434
9435	<attribute name="id" type="unsigned long" readonly="yes">
9436	<desc>
9437	TODO
9438	<note>
9439	TODO
9440	</note>
9441	</desc>
9442	</attribute>
9443
9444	<attribute name="timeout" type="unsigned long" readonly="no">
9445	<desc>
9446	TODO
9447	<note>
9448	TODO
9449	</note>
9450	</desc>
9451	</attribute>
9452
9453	<attribute name="environment" type="wstring" safearray="yes">
9454	<desc>
9455	TODO
9456	</desc>
9457	</attribute>
9458
9459	<attribute name="processes" type="IGuestProcess" readonly="yes" safearray="yes">
9460	<desc>
9461	TODO
9462	</desc>
9463	</attribute>
9464
9465	<attribute name="directories" type="IGuestDirectory" readonly="yes" safearray="yes">
9466	<desc>
9467	TODO
9468	</desc>
9469	</attribute>
9470
9471	<attribute name="files" type="IGuestFile" readonly="yes" safearray="yes">
9472	<desc>
9473	TODO
9474	</desc>
9475	</attribute>
9476
9477	<method name="close">
9478	<desc>
9479	TODO
9480
9481	<result name="VBOX_E_NOT_SUPPORTED">
9482	TODO
9483	</result>
9484	</desc>
9485	</method>
9486
9487	<method name="copyFrom">
9488	<desc>
9489	TODO
9490
9491	<result name="VBOX_E_NOT_SUPPORTED">
9492	TODO
9493	</result>
9494	</desc>
9495	<param name="source" type="wstring" dir="in">
9496	<desc>TODO</desc>
9497	</param>
9498	<param name="dest" type="wstring" dir="in">
9499	<desc>TODO</desc>
9500	</param>
9501	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9502	<desc>TODO</desc>
9503	</param>
9504	<param name="progress" type="IProgress" dir="return">
9505	<desc>Progress object to track the operation completion.</desc>
9506	</param>
9507	</method>
9508
9509	<method name="copyTo">
9510	<desc>
9511	TODO
9512
9513	<result name="VBOX_E_NOT_SUPPORTED">
9514	TODO
9515	</result>
9516	</desc>
9517	<param name="source" type="wstring" dir="in">
9518	<desc>TODO</desc>
9519	</param>
9520	<param name="dest" type="wstring" dir="in">
9521	<desc>TODO</desc>
9522	</param>
9523	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9524	<desc>TODO</desc>
9525	</param>
9526	<param name="progress" type="IProgress" dir="return">
9527	<desc>Progress object to track the operation completion.</desc>
9528	</param>
9529	</method>
9530
9531	<method name="directoryCreate">
9532	<desc>
9533	TODO
9534
9535	<result name="VBOX_E_NOT_SUPPORTED">
9536	TODO
9537	</result>
9538	</desc>
9539	<param name="path" type="wstring" dir="in">
9540	<desc>TODO</desc>
9541	</param>
9542	<param name="mode" type="unsigned long" dir="in">
9543	<desc>TODO</desc>
9544	</param>
9545	<param name="flags" type="DirectoryCreateFlag" dir="in" safearray="yes">
9546	<desc>TODO</desc>
9547	</param>
9548	<param name="directory" type="IGuestDirectory" dir="return">
9549	<desc>Optional.</desc>
9550	</param>
9551	</method>
9552
9553	<method name="directoryCreateTemp">
9554	<desc>
9555	Create a temporary directory on the guest.
9556
9557	<result name="VBOX_E_NOT_SUPPORTED">
9558	The operation is not possible as requested on this particular
9559	guest type.
9560	</result>
9561	<result name="E_INVALIDARG">
9562	Invalid argument. This includes an incorrectly formatted template,
9563	or a non-absolute path.
9564	</result>
9565	<result name="VBOX_E_IPRT_ERROR">
9566	The temporary directory could not be created. Possible reasons
9567	include a non-existing path or an insecure path when the secure
9568	option was requested.
9569	</result>
9570	</desc>
9571	<param name="templateName" type="wstring" dir="in">
9572	<desc>Template for the name of the directory to create. This must
9573	contain at least one 'X' character. The first group of consecutive
9574	'X' characters in the template will be replaced by a random
9575	alphanumeric string to produce a unique name.</desc>
9576	</param>
9577	<param name="mode" type="unsigned long" dir="in">
9578	<desc>The mode of the directory to create. Use 0700 unless there are
9579	reasons not to. This parameter is ignored if "secure" is specified.
9580	</desc>
9581	</param>
9582	<param name="path" type="wstring" dir="in">
9583	<desc>The absolute path to create the temporary directory in.</desc>
9584	</param>
9585	<param name="secure" type="boolean" dir="in">
9586	<desc>Whether to fail if the directory can not be securely created.
9587	Currently this means that another unprivileged user cannot
9588	manipulate the path specified or remove the temporary directory
9589	after it has been created. Also causes the mode specified to be
9590	ignored. May not be supported on all guest types.</desc>
9591	</param>
9592	<param name="directory" type="wstring" dir="return">
9593	<desc>On success this will contain the name of the directory created
9594	with full path.</desc>
9595	</param>
9596	</method>
9597
9598	<method name="directoryExists">
9599	<desc>
9600	TODO
9601
9602	<result name="VBOX_E_NOT_SUPPORTED">
9603	TODO
9604	</result>
9605	</desc>
9606	<param name="path" type="wstring" dir="in">
9607	<desc>TODO</desc>
9608	</param>
9609	<param name="exists" type="boolean" dir="return">
9610	<desc>TODO</desc>
9611	</param>
9612	</method>
9613
9614	<method name="directoryOpen">
9615	<desc>
9616	TODO
9617
9618	<result name="VBOX_E_NOT_SUPPORTED">
9619	TODO
9620	</result>
9621	</desc>
9622	<param name="path" type="wstring" dir="in">
9623	<desc>TODO</desc>
9624	</param>
9625	<param name="filter" type="wstring" dir="in">
9626	<desc>TODO</desc>
9627	</param>
9628	<param name="flags" type="DirectoryOpenFlag" dir="in" safearray="yes">
9629	<desc>TODO</desc>
9630	</param>
9631	<param name="directory" type="IGuestDirectory" dir="return">
9632	<desc>TODO</desc>
9633	</param>
9634	</method>
9635
9636	<method name="directoryQueryInfo">
9637	<desc>
9638	TODO
9639
9640	<result name="VBOX_E_NOT_SUPPORTED">
9641	TODO
9642	</result>
9643	</desc>
9644	<param name="path" type="wstring" dir="in">
9645	<desc>TODO</desc>
9646	</param>
9647	<param name="info" type="IGuestFsObjInfo" dir="return">
9648	<desc>TODO</desc>
9649	</param>
9650	</method>
9651
9652	<method name="directoryRemove">
9653	<desc>
9654	TODO
9655
9656	<result name="VBOX_E_NOT_SUPPORTED">
9657	TODO
9658	</result>
9659	</desc>
9660	<param name="path" type="wstring" dir="in">
9661	<desc>TODO</desc>
9662	</param>
9663	</method>
9664
9665	<method name="directoryRemoveRecursive">
9666	<desc>
9667	TODO
9668
9669	<result name="VBOX_E_NOT_SUPPORTED">
9670	TODO
9671	</result>
9672	</desc>
9673	<param name="path" type="wstring" dir="in">
9674	<desc>TODO</desc>
9675	</param>
9676	<param name="flags" type="DirectoryRemoveRecFlag" dir="in" safearray="yes">
9677	<desc>TODO</desc>
9678	</param>
9679	<param name="progress" type="IProgress" dir="return">
9680	<desc>TODO</desc>
9681	</param>
9682	</method>
9683
9684	<method name="directoryRename">
9685	<desc>
9686	TODO
9687
9688	<result name="VBOX_E_NOT_SUPPORTED">
9689	TODO
9690	</result>
9691	</desc>
9692	<param name="source" type="wstring" dir="in">
9693	<desc>TODO</desc>
9694	</param>
9695	<param name="dest" type="wstring" dir="in">
9696	<desc>TODO</desc>
9697	</param>
9698	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
9699	<desc>TODO</desc>
9700	</param>
9701	</method>
9702
9703	<method name="directorySetACL">
9704	<desc>
9705	TODO
9706
9707	<result name="VBOX_E_NOT_SUPPORTED">
9708	TODO
9709	</result>
9710	</desc>
9711	<param name="path" type="wstring" dir="in">
9712	<desc>TODO</desc>
9713	</param>
9714	<param name="acl" type="wstring" dir="in">
9715	<desc>TODO</desc>
9716	</param>
9717	</method>
9718
9719	<method name="environmentClear">
9720	<desc>
9721	TODO
9722
9723	<result name="VBOX_E_NOT_SUPPORTED">
9724	TODO
9725	</result>
9726	</desc>
9727	</method>
9728
9729	<method name="environmentGet">
9730	<desc>
9731	TODO
9732
9733	<result name="VBOX_E_NOT_SUPPORTED">
9734	TODO
9735	</result>
9736	</desc>
9737	<param name="name" type="wstring" dir="in">
9738	<desc>TODO</desc>
9739	</param>
9740	<param name="value" type="wstring" dir="return">
9741	<desc>TODO</desc>
9742	</param>
9743	</method>
9744
9745	<method name="environmentSet">
9746	<desc>
9747	TODO
9748
9749	<result name="VBOX_E_NOT_SUPPORTED">
9750	TODO
9751	</result>
9752	</desc>
9753	<param name="name" type="wstring" dir="in">
9754	<desc>TODO</desc>
9755	</param>
9756	<param name="value" type="wstring" dir="in">
9757	<desc>TODO</desc>
9758	</param>
9759	</method>
9760
9761	<method name="environmentUnset">
9762	<desc>
9763	TODO
9764
9765	<result name="VBOX_E_NOT_SUPPORTED">
9766	TODO
9767	</result>
9768	</desc>
9769	<param name="name" type="wstring" dir="in">
9770	<desc>TODO</desc>
9771	</param>
9772	</method>
9773
9774	<method name="fileCreateTemp">
9775	<desc>
9776	Create a temporary file on the guest.
9777
9778	<result name="VBOX_E_NOT_SUPPORTED">
9779	The operation is not possible as requested on this particular
9780	guest type.
9781	</result>
9782	<result name="E_INVALIDARG">
9783	Invalid argument. This includes an incorrectly formatted template,
9784	or a non-absolute path.
9785	</result>
9786	<result name="VBOX_E_IPRT_ERROR">
9787	The temporary file could not be created. Possible reasons include
9788	a non-existing path or an insecure path when the secure
9789	option was requested.
9790	</result>
9791	</desc>
9792	<param name="templateName" type="wstring" dir="in">
9793	<desc>Template for the name of the file to create. This must contain
9794	at least one 'X' character. The first group of consecutive 'X'
9795	characters in the template will be replaced by a random
9796	alphanumeric string to produce a unique name.
9797	</desc>
9798	</param>
9799	<param name="mode" type="unsigned long" dir="in">
9800	<desc>The mode of the file to create. Use 0700 unless there are
9801	reasons not to. This parameter is ignored if "secure" is specified.
9802	</desc>
9803	</param>
9804	<param name="path" type="wstring" dir="in">
9805	<desc>The absolute path to create the temporary file in.</desc>
9806	</param>
9807	<param name="secure" type="boolean" dir="in">
9808	<desc>Whether to fail if the file can not be securely created.
9809	Currently this means that another unprivileged user cannot
9810	manipulate the path specified or remove the temporary file after
9811	it has been created. Also causes the mode specified to be ignored.
9812	May not be supported on all guest types.</desc>
9813	</param>
9814	<param name="file" type="IGuestFile" dir="return">
9815	<desc>On success this will contain an open file object for the new
9816	temporary file.
9817	</desc>
9818	</param>
9819	</method>
9820
9821	<method name="fileExists">
9822	<desc>
9823	TODO
9824
9825	<result name="VBOX_E_NOT_SUPPORTED">
9826	TODO
9827	</result>
9828	</desc>
9829	<param name="path" type="wstring" dir="in">
9830	<desc>TODO</desc>
9831	</param>
9832	<param name="exists" type="boolean" dir="return">
9833	<desc>TODO</desc>
9834	</param>
9835	</method>
9836
9837	<method name="fileRemove">
9838	<desc>
9839	Remove a single file on the guest.
9840
9841	</desc>
9842	<param name="path" type="wstring" dir="in">
9843	<desc>Path to the file to remove.</desc>
9844	</param>
9845	</method>
9846
9847	<method name="fileOpen">
9848	<desc>
9849	TODO
9850
9851	<result name="VBOX_E_NOT_SUPPORTED">
9852	TODO
9853	</result>
9854	</desc>
9855	<param name="path" type="wstring" dir="in">
9856	<desc>TODO</desc>
9857	</param>
9858	<param name="openMode" type="wstring" dir="in">
9859	<desc>TODO</desc>
9860	</param>
9861	<param name="disposition" type="wstring" dir="in">
9862	<desc>TODO</desc>
9863	</param>
9864	<param name="creationMode" type="unsigned long" dir="in">
9865	<desc>TODO</desc>
9866	</param>
9867	<param name="offset" type="long long" dir="in">
9868	<desc>TODO</desc>
9869	</param>
9870	<param name="file" type="IGuestFile" dir="return">
9871	<desc>TODO</desc>
9872	</param>
9873	</method>
9874
9875	<method name="fileQueryInfo">
9876	<desc>
9877	TODO
9878
9879	<result name="VBOX_E_NOT_SUPPORTED">
9880	TODO
9881	</result>
9882	</desc>
9883	<param name="path" type="wstring" dir="in">
9884	<desc>TODO</desc>
9885	</param>
9886	<param name="info" type="IGuestFsObjInfo" dir="return">
9887	<desc>TODO</desc>
9888	</param>
9889	</method>
9890
9891	<method name="fileQuerySize">
9892	<desc>
9893	TODO
9894
9895	<result name="VBOX_E_NOT_SUPPORTED">
9896	TODO
9897	</result>
9898	</desc>
9899	<param name="path" type="wstring" dir="in">
9900	<desc>TODO</desc>
9901	</param>
9902	<param name="size" type="long long" dir="return">
9903	<desc>TODO</desc>
9904	</param>
9905	</method>
9906
9907	<method name="fileRename">
9908	<desc>
9909	TODO
9910
9911	<result name="VBOX_E_NOT_SUPPORTED">
9912	TODO
9913	</result>
9914	</desc>
9915	<param name="source" type="wstring" dir="in">
9916	<desc>TODO</desc>
9917	</param>
9918	<param name="dest" type="wstring" dir="in">
9919	<desc>TODO</desc>
9920	</param>
9921	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
9922	<desc>TODO</desc>
9923	</param>
9924	</method>
9925
9926	<method name="fileSetACL">
9927	<desc>
9928	TODO
9929
9930	<result name="VBOX_E_NOT_SUPPORTED">
9931	TODO
9932	</result>
9933	</desc>
9934	<param name="file" type="wstring" dir="in">
9935	<desc>TODO</desc>
9936	</param>
9937	<param name="acl" type="wstring" dir="in">
9938	<desc>TODO</desc>
9939	</param>
9940	</method>
9941
9942	<method name="processCreate">
9943	<desc>
9944	TODO
9945
9946	<result name="VBOX_E_NOT_SUPPORTED">
9947	TODO
9948	</result>
9949	</desc>
9950	<param name="command" type="wstring" dir="in">
9951	<desc>TODO</desc>
9952	</param>
9953	<param name="arguments" type="wstring" dir="in" safearray="yes">
9954	<desc>TODO</desc>
9955	</param>
9956	<param name="environment" type="wstring" dir="in" safearray="yes">
9957	<desc>TODO</desc>
9958	</param>
9959	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
9960	<desc>TODO</desc>
9961	</param>
9962	<param name="timeoutMS" type="unsigned long" dir="in">
9963	<desc>TODO</desc>
9964	</param>
9965	<param name="guestProcess" type="IGuestProcess" dir="return">
9966	<desc>TODO</desc>
9967	</param>
9968	</method>
9969
9970	<method name="processCreateEx">
9971	<desc>
9972	TODO
9973
9974	<result name="VBOX_E_NOT_SUPPORTED">
9975	TODO
9976	</result>
9977	</desc>
9978	<param name="command" type="wstring" dir="in">
9979	<desc>TODO</desc>
9980	</param>
9981	<param name="arguments" type="wstring" dir="in" safearray="yes">
9982	<desc>TODO</desc>
9983	</param>
9984	<param name="environment" type="wstring" dir="in" safearray="yes">
9985	<desc>TODO</desc>
9986	</param>
9987	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
9988	<desc>TODO</desc>
9989	</param>
9990	<param name="timeoutMS" type="unsigned long" dir="in">
9991	<desc>TODO</desc>
9992	</param>
9993	<param name="priority" type="ProcessPriority" dir="in">
9994	<desc>TODO</desc>
9995	</param>
9996	<param name="affinity" type="long" dir="in" safearray="yes">
9997	<desc>TODO</desc>
9998	</param>
9999	<param name="guestProcess" type="IGuestProcess" dir="return">
10000	<desc>TODO</desc>
10001	</param>
10002	</method>
10003
10004	<method name="processGet">
10005	<desc>
10006	TODO
10007
10008	<result name="VBOX_E_NOT_SUPPORTED">
10009	TODO
10010	</result>
10011	</desc>
10012	<param name="pid" type="unsigned long" dir="in">
10013	<desc>TODO</desc>
10014	</param>
10015	<param name="guestProcess" type="IGuestProcess" dir="return">
10016	<desc>TODO</desc>
10017	</param>
10018	</method>
10019
10020	<method name="symlinkCreate">
10021	<desc>
10022	TODO
10023
10024	<result name="VBOX_E_NOT_SUPPORTED">
10025	TODO
10026	</result>
10027	</desc>
10028	<param name="source" type="wstring" dir="in">
10029	<desc>TODO</desc>
10030	</param>
10031	<param name="target" type="wstring" dir="in">
10032	<desc>TODO</desc>
10033	</param>
10034	<param name="type" type="SymlinkType" dir="in">
10035	<desc>TODO</desc>
10036	</param>
10037	</method>
10038
10039	<method name="symlinkExists">
10040	<desc>
10041	TODO
10042
10043	<result name="VBOX_E_NOT_SUPPORTED">
10044	TODO
10045	</result>
10046	</desc>
10047	<param name="symlink" type="wstring" dir="in">
10048	<desc>TODO</desc>
10049	</param>
10050	<param name="exists" type="boolean" dir="return">
10051	<desc>TODO</desc>
10052	</param>
10053	</method>
10054
10055	<method name="symlinkRead">
10056	<desc>
10057	TODO
10058
10059	<result name="VBOX_E_NOT_SUPPORTED">
10060	TODO
10061	</result>
10062	</desc>
10063	<param name="symlink" type="wstring" dir="in">
10064	<desc>TODO</desc>
10065	</param>
10066	<param name="flags" type="SymlinkReadFlag" dir="in" safearray="yes">
10067	<desc>TODO</desc>
10068	</param>
10069	<param name="target" type="wstring" dir="return">
10070	<desc>TODO</desc>
10071	</param>
10072	</method>
10073
10074	<method name="symlinkRemoveDirectory">
10075	<desc>
10076	TODO
10077
10078	<result name="VBOX_E_NOT_SUPPORTED">
10079	TODO
10080	</result>
10081	</desc>
10082	<param name="path" type="wstring" dir="in">
10083	<desc>TODO</desc>
10084	</param>
10085	</method>
10086
10087	<method name="symlinkRemoveFile">
10088	<desc>
10089	TODO
10090
10091	<result name="VBOX_E_NOT_SUPPORTED">
10092	TODO
10093	</result>
10094	</desc>
10095	<param name="file" type="wstring" dir="in">
10096	<desc>TODO</desc>
10097	</param>
10098	</method>
10099
10100	</interface>
10101
10102	<interface
10103	name="IProcess" extends="$unknown"
10104	uuid="896df50a-c5d1-4892-8bc6-b78d0c1f4e33"
10105	wsmap="managed"
10106	>
10107	<desc>
10108	TODO
10109	</desc>
10110	<attribute name="PID" type="unsigned long" readonly="yes">
10111	<desc>
10112	TODO
10113	<note>
10114	TODO
10115	</note>
10116	</desc>
10117	</attribute>
10118	<attribute name="status" type="ProcessStatus" readonly="yes">
10119	<desc>
10120	TODO
10121	<note>
10122	TODO
10123	</note>
10124	</desc>
10125	</attribute>
10126	<attribute name="exitCode" type="long" readonly="yes">
10127	<desc>
10128	TODO
10129	<note>
10130	TODO
10131	</note>
10132	</desc>
10133	</attribute>
10134	<attribute name="environment" type="wstring" readonly="yes" safearray="yes">
10135	<desc>
10136	TODO
10137	<note>
10138	TODO
10139	</note>
10140	</desc>
10141	</attribute>
10142	<attribute name="arguments" type="wstring" readonly="yes" safearray="yes">
10143	<desc>
10144	TODO
10145	<note>
10146	TODO
10147	</note>
10148	</desc>
10149	</attribute>
10150	<attribute name="executablePath" type="wstring" readonly="yes">
10151	<desc>
10152	TODO
10153	<note>
10154	TODO
10155	</note>
10156	</desc>
10157	</attribute>
10158	<attribute name="name" type="wstring" readonly="yes">
10159	<desc>
10160	TODO
10161	<note>
10162	TODO
10163	</note>
10164	</desc>
10165	</attribute>
10166
10167	<method name="waitFor">
10168	<desc>
10169	TODO
10170
10171	<result name="VBOX_E_NOT_SUPPORTED">
10172	TODO
10173	</result>
10174	</desc>
10175	<param name="waitFor" type="unsigned long" dir="in">
10176	<desc>TODO</desc>
10177	</param>
10178	<param name="timeoutMS" type="unsigned long" dir="in">
10179	<desc>TODO</desc>
10180	</param>
10181	<param name="reason" type="ProcessWaitResult" dir="return">
10182	<desc>TODO</desc>
10183	</param>
10184	</method>
10185
10186	<method name="waitForArray">
10187	<desc>
10188	Scriptable version of <link to="#waitFor" />.
10189
10190	<result name="VBOX_E_NOT_SUPPORTED">
10191	TODO
10192	</result>
10193	</desc>
10194	<param name="waitFor" type="ProcessWaitForFlag" dir="in" safearray="yes">
10195	<desc>TODO</desc>
10196	</param>
10197	<param name="timeoutMS" type="unsigned long" dir="in">
10198	<desc>TODO</desc>
10199	</param>
10200	<param name="reason" type="ProcessWaitResult" dir="return">
10201	<desc>TODO</desc>
10202	</param>
10203	</method>
10204
10205	<method name="read">
10206	<desc>
10207	TODO
10208
10209	<result name="VBOX_E_NOT_SUPPORTED">
10210	TODO
10211	</result>
10212	</desc>
10213	<param name="handle" type="unsigned long" dir="in">
10214	<desc>TODO</desc>
10215	</param>
10216	<param name="size" type="unsigned long" dir="in">
10217	<desc>TODO</desc>
10218	</param>
10219	<param name="timeoutMS" type="unsigned long" dir="in">
10220	<desc>TODO</desc>
10221	</param>
10222	<param name="data" type="octet" dir="return" safearray="yes">
10223	<desc>TODO</desc>
10224	</param>
10225	</method>
10226
10227	<method name="write">
10228	<desc>
10229	TODO
10230
10231	<result name="VBOX_E_NOT_SUPPORTED">
10232	TODO
10233	</result>
10234	</desc>
10235	<param name="handle" type="unsigned long" dir="in">
10236	<desc>TODO</desc>
10237	</param>
10238	<param name="flags" type="unsigned long" dir="in">
10239	<desc>
10240	<link to="ProcessInputFlag"/> flags.
10241	</desc>
10242	</param>
10243	<param name="data" type="octet" dir="in" safearray="yes">
10244	<desc>TODO</desc>
10245	</param>
10246	<param name="timeoutMS" type="unsigned long" dir="in">
10247	<desc>TODO</desc>
10248	</param>
10249	<param name="written" type="unsigned long" dir="return">
10250	<desc>TODO</desc>
10251	</param>
10252	</method>
10253
10254	<method name="WriteArray">
10255	<desc>
10256	TODO
10257
10258	<result name="VBOX_E_NOT_SUPPORTED">
10259	TODO
10260	</result>
10261	</desc>
10262	<param name="handle" type="unsigned long" dir="in">
10263	<desc>TODO</desc>
10264	</param>
10265	<param name="flags" type="ProcessInputFlag" dir="in" safearray="yes">
10266	<desc>
10267	<link to="ProcessInputFlag"/> flags.
10268	</desc>
10269	</param>
10270	<param name="data" type="octet" dir="in" safearray="yes">
10271	<desc>TODO</desc>
10272	</param>
10273	<param name="timeoutMS" type="unsigned long" dir="in">
10274	<desc>TODO</desc>
10275	</param>
10276	<param name="written" type="unsigned long" dir="return">
10277	<desc>TODO</desc>
10278	</param>
10279	</method>
10280
10281	<method name="terminate">
10282	<desc>
10283	TODO
10284
10285	<result name="VBOX_E_NOT_SUPPORTED">
10286	TODO
10287	</result>
10288	</desc>
10289	</method>
10290	</interface>
10291
10292	<interface
10293	name="IGuestProcess" extends="IProcess"
10294	uuid="dfa39a36-5d43-4840-a025-67ea956b3111"
10295	wsmap="managed"
10296	>
10297	<desc>
10298	TODO
10299	</desc>
10300	</interface>
10301
10302	<interface
10303	name="IDirectory" extends="$unknown"
10304	uuid="1b70dd03-26d7-483a-8877-89bbb0f87b70"
10305	wsmap="managed"
10306	>
10307	<desc>
10308	TODO
10309	</desc>
10310
10311	<attribute name="directoryName" type="wstring" readonly="yes">
10312	<desc>
10313	Full path of directory.
10314	<note>
10315	TODO
10316	</note>
10317	</desc>
10318	</attribute>
10319
10320	<attribute name="filter" type="wstring" readonly="yes">
10321	<desc>
10322	The open filter.
10323	<note>
10324	TODO
10325	</note>
10326	</desc>
10327	</attribute>
10328
10329	<method name="close">
10330	<desc>
10331	TODO
10332
10333	<result name="VBOX_E_NOT_SUPPORTED">
10334	TODO
10335	</result>
10336	</desc>
10337	</method>
10338
10339	<method name="read">
10340	<desc>
10341	TODO
10342
10343	<result name="VBOX_E_OBJECT_NOT_FOUND">
10344	End of directory listing reached.
10345	</result>
10346	</desc>
10347	<param name="objInfo" type="IFsObjInfo" dir="return">
10348	<desc>TODO</desc>
10349	</param>
10350	</method>
10351	</interface>
10352
10353	<interface
10354	name="IGuestDirectory" extends="IDirectory"
10355	uuid="af4a8ce0-0725-42b7-8826-46e3c7ba7357"
10356	wsmap="managed"
10357	>
10358	<desc>
10359	TODO
10360	</desc>
10361	</interface>
10362
10363	<interface
10364	name="IFile" extends="$unknown"
10365	uuid="b3484293-b98b-4952-ae23-f18eca6a5ff9"
10366	wsmap="managed"
10367	>
10368	<desc>
10369	TODO
10370	</desc>
10371	<attribute name="creationMode" type="unsigned long" readonly="yes">
10372	<desc>
10373	TODO
10374	<note>
10375	TODO
10376	</note>
10377	</desc>
10378	</attribute>
10379	<attribute name="disposition" type="unsigned long" readonly="yes">
10380	<desc>
10381	TODO
10382	<note>
10383	TODO
10384	</note>
10385	</desc>
10386	</attribute>
10387	<attribute name="fileName" type="wstring" readonly="yes">
10388	<desc>
10389	TODO
10390	<note>
10391	TODO
10392	</note>
10393	</desc>
10394	</attribute>
10395	<attribute name="initialSize" type="long long" readonly="yes">
10396	<desc>
10397	TODO
10398	<note>
10399	TODO
10400	</note>
10401	</desc>
10402	</attribute>
10403	<attribute name="openMode" type="unsigned long" readonly="yes">
10404	<desc>
10405	TODO
10406	<note>
10407	TODO
10408	</note>
10409	</desc>
10410	</attribute>
10411	<attribute name="offset" type="long long" readonly="yes">
10412	<desc>
10413	TODO
10414	<note>
10415	TODO
10416	</note>
10417	</desc>
10418	</attribute>
10419
10420	<method name="close">
10421	<desc>
10422	TODO
10423
10424	<result name="VBOX_E_NOT_SUPPORTED">
10425	TODO
10426	</result>
10427	</desc>
10428	</method>
10429
10430	<method name="queryInfo">
10431	<desc>
10432	TODO
10433
10434	<result name="VBOX_E_NOT_SUPPORTED">
10435	TODO
10436	</result>
10437	</desc>
10438	<param name="objInfo" type="IFsObjInfo" dir="return">
10439	<desc>TODO</desc>
10440	</param>
10441	</method>
10442
10443	<method name="read">
10444	<desc>
10445	TODO
10446
10447	<result name="VBOX_E_NOT_SUPPORTED">
10448	TODO
10449	</result>
10450	</desc>
10451	<param name="toRead" type="unsigned long" dir="in">
10452	<desc>TODO</desc>
10453	</param>
10454	<param name="read" type="unsigned long" dir="out">
10455	<desc>TODO</desc>
10456	</param>
10457	<param name="data" type="octet" dir="return" safearray="yes">
10458	<desc>TODO</desc>
10459	</param>
10460	</method>
10461
10462	<method name="readAt">
10463	<desc>
10464	TODO
10465
10466	<result name="VBOX_E_NOT_SUPPORTED">
10467	TODO
10468	</result>
10469	</desc>
10470	<param name="offset" type="long long" dir="in">
10471	<desc>TODO</desc>
10472	</param>
10473	<param name="toRead" type="unsigned long" dir="in">
10474	<desc>TODO</desc>
10475	</param>
10476	<param name="read" type="unsigned long" dir="out">
10477	<desc>TODO</desc>
10478	</param>
10479	<param name="data" type="octet" dir="return" safearray="yes">
10480	<desc>TODO</desc>
10481	</param>
10482	</method>
10483
10484	<method name="seek">
10485	<desc>
10486	TODO
10487
10488	<result name="VBOX_E_NOT_SUPPORTED">
10489	TODO
10490	</result>
10491	</desc>
10492	<param name="offset" type="long long" dir="in">
10493	<desc>TODO</desc>
10494	</param>
10495	<param name="whence" type="FileSeekType" dir="in">
10496	<desc>TODO</desc>
10497	</param>
10498	</method>
10499
10500	<method name="setACL">
10501	<desc>
10502	TODO
10503
10504	<result name="VBOX_E_NOT_SUPPORTED">
10505	TODO
10506	</result>
10507	</desc>
10508	<param name="acl" type="wstring" dir="in">
10509	<desc>TODO</desc>
10510	</param>
10511	</method>
10512
10513	<method name="write">
10514	<desc>
10515	TODO
10516
10517	<result name="VBOX_E_NOT_SUPPORTED">
10518	TODO
10519	</result>
10520	</desc>
10521	<param name="data" type="octet" dir="in" safearray="yes">
10522	<desc>TODO</desc>
10523	</param>
10524	<param name="written" type="unsigned long" dir="return">
10525	<desc>TODO</desc>
10526	</param>
10527	</method>
10528
10529	<method name="writeAt">
10530	<desc>
10531	TODO
10532
10533	<result name="VBOX_E_NOT_SUPPORTED">
10534	TODO
10535	</result>
10536	</desc>
10537	<param name="offset" type="long long" dir="in">
10538	<desc>TODO</desc>
10539	</param>
10540	<param name="data" type="octet" dir="in" safearray="yes">
10541	<desc>TODO</desc>
10542	</param>
10543	<param name="written" type="unsigned long" dir="return">
10544	<desc>TODO</desc>
10545	</param>
10546	</method>
10547
10548	</interface>
10549
10550	<interface
10551	name="IGuestFile" extends="IFile"
10552	uuid="60661aec-145f-4d11-b80e-8ea151598093"
10553	wsmap="managed"
10554	>
10555	<desc>
10556	TODO
10557	</desc>
10558	</interface>
10559
10560	<interface
10561	name="IFsObjInfo" extends="$unknown"
10562	uuid="4047ba30-7006-4966-ae86-94164e5e20eb"
10563	wsmap="managed"
10564	>
10565	<desc>
10566	TODO
10567	</desc>
10568
10569	<attribute name="accessTime" type="long long" readonly="yes">
10570	<desc>
10571	TODO
10572	<note>
10573	TODO
10574	</note>
10575	</desc>
10576	</attribute>
10577	<attribute name="allocatedSize" type="long long" readonly="yes">
10578	<desc>
10579	TODO
10580	<note>
10581	TODO
10582	</note>
10583	</desc>
10584	</attribute>
10585	<attribute name="birthTime" type="long long" readonly="yes">
10586	<desc>
10587	TODO
10588	<note>
10589	TODO
10590	</note>
10591	</desc>
10592	</attribute>
10593	<attribute name="changeTime" type="long long" readonly="yes">
10594	<desc>
10595	TODO
10596	<note>
10597	TODO
10598	</note>
10599	</desc>
10600	</attribute>
10601	<attribute name="deviceNumber" type="unsigned long" readonly="yes">
10602	<desc>
10603	TODO
10604	<note>
10605	TODO
10606	</note>
10607	</desc>
10608	</attribute>
10609	<attribute name="fileAttributes" type="wstring" readonly="yes">
10610	<desc>
10611	TODO
10612	<note>
10613	TODO
10614	</note>
10615	</desc>
10616	</attribute>
10617	<attribute name="generationId" type="unsigned long" readonly="yes">
10618	<desc>
10619	TODO
10620	<note>
10621	TODO
10622	</note>
10623	</desc>
10624	</attribute>
10625	<attribute name="GID" type="unsigned long" readonly="yes">
10626	<desc>
10627	TODO
10628	<note>
10629	TODO
10630	</note>
10631	</desc>
10632	</attribute>
10633	<attribute name="groupName" type="wstring" readonly="yes">
10634	<desc>
10635	TODO
10636	<note>
10637	TODO
10638	</note>
10639	</desc>
10640	</attribute>
10641	<attribute name="hardLinks" type="unsigned long" readonly="yes">
10642	<desc>
10643	TODO
10644	<note>
10645	TODO
10646	</note>
10647	</desc>
10648	</attribute>
10649	<attribute name="modificationTime" type="long long" readonly="yes">
10650	<desc>
10651	TODO
10652	<note>
10653	TODO
10654	</note>
10655	</desc>
10656	</attribute>
10657	<attribute name="name" type="wstring" readonly="yes">
10658	<desc>
10659	TODO
10660	<note>
10661	TODO
10662	</note>
10663	</desc>
10664	</attribute>
10665	<attribute name="nodeId" type="long long" readonly="yes">
10666	<desc>
10667	TODO
10668	<note>
10669	TODO
10670	</note>
10671	</desc>
10672	</attribute>
10673	<attribute name="nodeIdDevice" type="unsigned long" readonly="yes">
10674	<desc>
10675	TODO
10676	<note>
10677	TODO
10678	</note>
10679	</desc>
10680	</attribute>
10681	<attribute name="objectSize" type="long long" readonly="yes">
10682	<desc>
10683	TODO
10684	<note>
10685	TODO
10686	</note>
10687	</desc>
10688	</attribute>
10689	<attribute name="type" type="FsObjType" readonly="yes">
10690	<desc>
10691	TODO
10692	<note>
10693	TODO
10694	</note>
10695	</desc>
10696	</attribute>
10697	<attribute name="UID" type="unsigned long" readonly="yes">
10698	<desc>
10699	TODO
10700	<note>
10701	TODO
10702	</note>
10703	</desc>
10704	</attribute>
10705	<attribute name="userFlags" type="unsigned long" readonly="yes">
10706	<desc>
10707	TODO
10708	<note>
10709	TODO
10710	</note>
10711	</desc>
10712	</attribute>
10713	<attribute name="userName" type="wstring" readonly="yes">
10714	<desc>
10715	TODO
10716	<note>
10717	TODO
10718	</note>
10719	</desc>
10720	</attribute>
10721
10722	</interface>
10723
10724	<interface
10725	name="IGuestFsObjInfo" extends="IFsObjInfo"
10726	uuid="d5cf678e-3484-4e4a-ac55-329e15462e18"
10727	wsmap="managed"
10728	>
10729	<desc>
10730	TODO
10731	</desc>
10732	</interface>
10733
10734	<interface
10735	name="IGuest" extends="$unknown"
10736	uuid="19c32350-0618-4ede-b0c3-2b4311bf0d9b"
10737	wsmap="managed"
10738	>
10739	<desc>
10740	The IGuest interface represents information about the operating system
10741	running inside the virtual machine. Used in
10742	<link to="IConsole::guest"/>.
10743
10744	IGuest provides information about the guest operating system, whether
10745	Guest Additions are installed and other OS-specific virtual machine
10746	properties.
10747	</desc>
10748
10749	<attribute name="OSTypeId" type="wstring" readonly="yes">
10750	<desc>
10751	Identifier of the Guest OS type as reported by the Guest
10752	Additions.
10753	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
10754	an IGuestOSType object representing details about the given
10755	Guest OS type.
10756	<note>
10757	If Guest Additions are not installed, this value will be
10758	the same as <link to="IMachine::OSTypeId"/>.
10759	</note>
10760	</desc>
10761	</attribute>
10762
10763	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
10764	<desc>
10765	Current run level of the Guest Additions.
10766	</desc>
10767	</attribute>
10768
10769	<attribute name="additionsVersion" type="wstring" readonly="yes">
10770	<desc>
10771	Version of the Guest Additions in the same format as
10772	<link to="IVirtualBox::version"/>.
10773	</desc>
10774	</attribute>
10775
10776	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
10777	<desc>
10778	The internal build revision number of the additions.
10779
10780	See also <link to="IVirtualBox::revision"/>.
10781	</desc>
10782	</attribute>
10783
10784	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
10785	<desc>
10786	Array of current known facilities. Only returns facilities where a status is known,
10787	e.g. facilities with an unknown status will not be returned.
10788	</desc>
10789	</attribute>
10790
10791	<attribute name="sessions" type="IGuestSession" readonly="yes" safearray="yes">
10792	<desc>TODO</desc>
10793	</attribute>
10794
10795	<attribute name="memoryBalloonSize" type="unsigned long">
10796	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
10797	</attribute>
10798
10799	<attribute name="statisticsUpdateInterval" type="unsigned long">
10800	<desc>Interval to update guest statistics in seconds.</desc>
10801	</attribute>
10802
10803	<method name="internalGetStatistics">
10804	<desc>
10805	Internal method; do not use as it might change at any time.
10806	</desc>
10807	<param name="cpuUser" type="unsigned long" dir="out">
10808	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
10809	</param>
10810	<param name="cpuKernel" type="unsigned long" dir="out">
10811	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
10812	</param>
10813	<param name="cpuIdle" type="unsigned long" dir="out">
10814	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
10815	</param>
10816	<param name="memTotal" type="unsigned long" dir="out">
10817	<desc>Total amount of physical guest RAM.</desc>
10818	</param>
10819	<param name="memFree" type="unsigned long" dir="out">
10820	<desc>Free amount of physical guest RAM.</desc>
10821	</param>
10822	<param name="memBalloon" type="unsigned long" dir="out">
10823	<desc>Amount of ballooned physical guest RAM.</desc>
10824	</param>
10825	<param name="memShared" type="unsigned long" dir="out">
10826	<desc>Amount of shared physical guest RAM.</desc>
10827	</param>
10828	<param name="memCache" type="unsigned long" dir="out">
10829	<desc>Total amount of guest (disk) cache memory.</desc>
10830	</param>
10831	<param name="pagedTotal" type="unsigned long" dir="out">
10832	<desc>Total amount of space in the page file.</desc>
10833	</param>
10834	<param name="memAllocTotal" type="unsigned long" dir="out">
10835	<desc>Total amount of memory allocated by the hypervisor.</desc>
10836	</param>
10837	<param name="memFreeTotal" type="unsigned long" dir="out">
10838	<desc>Total amount of free memory available in the hypervisor.</desc>
10839	</param>
10840	<param name="memBalloonTotal" type="unsigned long" dir="out">
10841	<desc>Total amount of memory ballooned by the hypervisor.</desc>
10842	</param>
10843	<param name="memSharedTotal" type="unsigned long" dir="out">
10844	<desc>Total amount of shared memory in the hypervisor.</desc>
10845	</param>
10846	</method>
10847
10848	<method name="getFacilityStatus">
10849	<desc>
10850	Get the current status of a Guest Additions facility.
10851	</desc>
10852	<param name="facility" type="AdditionsFacilityType" dir="in">
10853	<desc>Facility to check status for.</desc>
10854	</param>
10855	<param name="timestamp" type="long long" dir="out">
10856	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
10857	</param>
10858	<param name="status" type="AdditionsFacilityStatus" dir="return">
10859	<desc>The current (latest) facility status.</desc>
10860	</param>
10861	</method>
10862
10863	<method name="getAdditionsStatus">
10864	<desc>
10865	Retrieve the current status of a certain Guest Additions run level.
10866
10867	<result name="VBOX_E_NOT_SUPPORTED">
10868	Wrong status level specified.
10869	</result>
10870
10871	</desc>
10872	<param name="level" type="AdditionsRunLevelType" dir="in">
10873	<desc>Status level to check</desc>
10874	</param>
10875	<param name="active" type="boolean" dir="return">
10876	<desc>Flag whether the status level has been reached or not</desc>
10877	</param>
10878	</method>
10879
10880	<method name="setCredentials">
10881	<desc>
10882	Store login credentials that can be queried by guest operating
10883	systems with Additions installed. The credentials are transient
10884	to the session and the guest may also choose to erase them. Note
10885	that the caller cannot determine whether the guest operating system
10886	has queried or made use of the credentials.
10887
10888	<result name="VBOX_E_VM_ERROR">
10889	VMM device is not available.
10890	</result>
10891
10892	</desc>
10893	<param name="userName" type="wstring" dir="in">
10894	<desc>User name string, can be empty</desc>
10895	</param>
10896	<param name="password" type="wstring" dir="in">
10897	<desc>Password string, can be empty</desc>
10898	</param>
10899	<param name="domain" type="wstring" dir="in">
10900	<desc>Domain name (guest logon scheme specific), can be empty</desc>
10901	</param>
10902	<param name="allowInteractiveLogon" type="boolean" dir="in">
10903	<desc>
10904	Flag whether the guest should alternatively allow the user to
10905	interactively specify different credentials. This flag might
10906	not be supported by all versions of the Additions.
10907	</desc>
10908	</param>
10909	</method>
10910
10911	<method name="dragHGEnter">
10912	<desc>
10913	Informs the guest about a Drag and Drop enter event.
10914
10915	This is used in Host - Guest direction.
10916
10917	<result name="VBOX_E_VM_ERROR">
10918	VMM device is not available.
10919	</result>
10920
10921	</desc>
10922	<param name="screenId" type="unsigned long" dir="in">
10923	<desc>The screen id where the Drag and Drop event occured.</desc>
10924	</param>
10925	<param name="y" type="unsigned long" dir="in">
10926	<desc>y-position of the event.</desc>
10927	</param>
10928	<param name="x" type="unsigned long" dir="in">
10929	<desc>x-position of the event.</desc>
10930	</param>
10931	<param name="defaultAction" type="DragAndDropAction" dir="in">
10932	<desc>The default action to use.</desc>
10933	</param>
10934	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10935	<desc>The actions which are allowed.</desc>
10936	</param>
10937	<param name="formats" type="wstring" dir="in" safearray="yes">
10938	<desc>The supported mime types.</desc>
10939	</param>
10940	<param name="resultAction" type="DragAndDropAction" dir="return">
10941	<desc>The resulting action of this event.</desc>
10942	</param>
10943	</method>
10944
10945	<method name="dragHGMove">
10946	<desc>
10947	Informs the guest about a Drag and Drop move event.
10948
10949	This is used in Host - Guest direction.
10950
10951	<result name="VBOX_E_VM_ERROR">
10952	VMM device is not available.
10953	</result>
10954
10955	</desc>
10956	<param name="screenId" type="unsigned long" dir="in">
10957	<desc>The screen id where the Drag and Drop event occured.</desc>
10958	</param>
10959	<param name="x" type="unsigned long" dir="in">
10960	<desc>x-position of the event.</desc>
10961	</param>
10962	<param name="y" type="unsigned long" dir="in">
10963	<desc>y-position of the event.</desc>
10964	</param>
10965	<param name="defaultAction" type="DragAndDropAction" dir="in">
10966	<desc>The default action to use.</desc>
10967	</param>
10968	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10969	<desc>The actions which are allowed.</desc>
10970	</param>
10971	<param name="formats" type="wstring" dir="in" safearray="yes">
10972	<desc>The supported mime types.</desc>
10973	</param>
10974	<param name="resultAction" type="DragAndDropAction" dir="return">
10975	<desc>The resulting action of this event.</desc>
10976	</param>
10977	</method>
10978
10979	<method name="dragHGLeave">
10980	<desc>
10981	Informs the guest about a Drag and Drop leave event.
10982
10983	This is used in Host - Guest direction.
10984
10985	<result name="VBOX_E_VM_ERROR">
10986	VMM device is not available.
10987	</result>
10988
10989	</desc>
10990	<param name="screenId" type="unsigned long" dir="in">
10991	<desc>The screen id where the Drag and Drop event occured.</desc>
10992	</param>
10993	</method>
10994
10995	<method name="dragHGDrop">
10996	<desc>
10997	Informs the guest about a drop event.
10998
10999	This is used in Host - Guest direction.
11000
11001	<result name="VBOX_E_VM_ERROR">
11002	VMM device is not available.
11003	</result>
11004
11005	</desc>
11006	<param name="screenId" type="unsigned long" dir="in">
11007	<desc>The screen id where the Drag and Drop event occured.</desc>
11008	</param>
11009	<param name="x" type="unsigned long" dir="in">
11010	<desc>x-position of the event.</desc>
11011	</param>
11012	<param name="y" type="unsigned long" dir="in">
11013	<desc>y-position of the event.</desc>
11014	</param>
11015	<param name="defaultAction" type="DragAndDropAction" dir="in">
11016	<desc>The default action to use.</desc>
11017	</param>
11018	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11019	<desc>The actions which are allowed.</desc>
11020	</param>
11021	<param name="formats" type="wstring" dir="in" safearray="yes">
11022	<desc>The supported mime types.</desc>
11023	</param>
11024	<param name="format" type="wstring" dir="out">
11025	<desc>The resulting format of this event.</desc>
11026	</param>
11027	<param name="resultAction" type="DragAndDropAction" dir="return">
11028	<desc>The resulting action of this event.</desc>
11029	</param>
11030	</method>
11031
11032	<method name="dragHGPutData">
11033	<desc>
11034	Informs the guest about a drop data event.
11035
11036	This is used in Host - Guest direction.
11037
11038	<result name="VBOX_E_VM_ERROR">
11039	VMM device is not available.
11040	</result>
11041
11042	</desc>
11043	<param name="screenId" type="unsigned long" dir="in">
11044	<desc>The screen id where the Drag and Drop event occured.</desc>
11045	</param>
11046	<param name="format" type="wstring" dir="in">
11047	<desc>The mime type the data is in.</desc>
11048	</param>
11049	<param name="data" type="octet" dir="in" safearray="yes">
11050	<desc>The actual data.</desc>
11051	</param>
11052	<param name="progress" type="IProgress" dir="return">
11053	<desc>Progress object to track the operation completion.</desc>
11054	</param>
11055	</method>
11056
11057	<method name="dragGHPending">
11058	<desc>
11059	Ask the guest if there is any Drag and Drop operation pending in the guest.
11060
11061	If no Drag and Drop operation is pending currently, Ignore is returned.
11062
11063	This is used in Guest - Host direction.
11064
11065	<result name="VBOX_E_VM_ERROR">
11066	VMM device is not available.
11067	</result>
11068
11069	</desc>
11070	<param name="screenId" type="unsigned long" dir="in">
11071	<desc>The screen id where the Drag and Drop event occured.</desc>
11072	</param>
11073	<param name="format" type="wstring" dir="out" safearray="yes">
11074	<desc>On return the supported mime types.</desc>
11075	</param>
11076	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
11077	<desc>On return the actions which are allowed.</desc>
11078	</param>
11079	<param name="defaultAction" type="DragAndDropAction" dir="return">
11080	<desc>On return the default action to use.</desc>
11081	</param>
11082	</method>
11083
11084	<method name="dragGHDropped">
11085	<desc>
11086	Informs the guest that a drop event occured for a pending Drag and Drop event.
11087
11088	This is used in Guest - Host direction.
11089
11090	<result name="VBOX_E_VM_ERROR">
11091	VMM device is not available.
11092	</result>
11093
11094	</desc>
11095
11096	<param name="format" type="wstring" dir="in">
11097	<desc>The mime type the data must be in.</desc>
11098	</param>
11099	<param name="action" type="DragAndDropAction" dir="in">
11100	<desc>The action to use.</desc>
11101	</param>
11102	<param name="progress" type="IProgress" dir="return">
11103	<desc>Progress object to track the operation completion.</desc>
11104	</param>
11105	</method>
11106
11107	<method name="dragGHGetData">
11108	<desc>
11109	Fetch the data of a previously Drag and Drop event from the guest.
11110
11111	This is used in Guest - Host direction.
11112
11113	<result name="VBOX_E_VM_ERROR">
11114	VMM device is not available.
11115	</result>
11116
11117	</desc>
11118
11119	<param name="data" type="octet" safearray="yes" dir="return">
11120	<desc>The actual data.</desc>
11121	</param>
11122	</method>
11123
11124	<method name="createSession">
11125	<desc>
11126	TODO
11127	</desc>
11128	<param name="user" type="wstring" dir="in">
11129	<desc>
11130	TODO
11131	</desc>
11132	</param>
11133	<param name="password" type="wstring" dir="in">
11134	<desc>
11135	TODO
11136	</desc>
11137	</param>
11138	<param name="domain" type="wstring" dir="in">
11139	<desc>
11140	TODO
11141	</desc>
11142	</param>
11143	<param name="sessionName" type="wstring" dir="in">
11144	<desc>
11145	TODO
11146	</desc>
11147	</param>
11148	<param name="guestSession" type="IGuestSession" dir="return">
11149	<desc>
11150	TODO
11151	</desc>
11152	</param>
11153	</method>
11154
11155	<method name="findSession">
11156	<desc>
11157	TODO
11158	</desc>
11159	<param name="sessionName" type="wstring" dir="in">
11160	<desc>
11161	TODO
11162	</desc>
11163	</param>
11164	<param name="sessions" type="IGuestSession" safearray="yes" dir="return">
11165	<desc>
11166	TODO
11167	</desc>
11168	</param>
11169	</method>
11170
11171	<method name="executeProcess">
11172	<desc>
11173	Executes an existing program inside the guest VM.
11174
11175	<note>
11176	Starting at VirtualBox 4.1.8 guest process execution by default is limited
11177	to serve up to 25 guest processes at a time. If all 25 guest processes
11178	are still active and running, starting a new guest process will result in an
11179	appropriate error message.
11180
11181	If ExecuteProcessFlag_WaitForStdOut and/or respectively
11182	ExecuteProcessFlag_WaitForStdErr of <link to="ExecuteProcessFlag"/> is
11183	set, the guest process will not exit until all data from the specified
11184	stream(s) is/are read out.
11185
11186	To raise or lower the guest process execution limit, either the guest property
11187	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
11188	command line by specifying "--control-procs-max-kept" needs to be modified.
11189	A restart of the guest OS is required afterwards. To serve unlimited guest
11190	processes, a value of "0" needs to be set (not recommended).
11191	</note>
11192
11193	<result name="VBOX_E_IPRT_ERROR">
11194	Could not execute process.
11195	</result>
11196
11197	</desc>
11198	<param name="execName" type="wstring" dir="in">
11199	<desc>
11200	Full path name of the command to execute on the guest; the
11201	commands has to exists in the guest VM in order to be executed.
11202	</desc>
11203	</param>
11204	<param name="flags" type="unsigned long" dir="in">
11205	<desc>
11206	<link to="ExecuteProcessFlag"/> flags.
11207	</desc>
11208	</param>
11209	<param name="arguments" type="wstring" safearray="yes" dir="in">
11210	<desc>
11211	Array of arguments passed to the execution command.
11212	</desc>
11213	</param>
11214	<param name="environment" type="wstring" safearray="yes" dir="in">
11215	<desc>
11216	Environment variables that can be set while the command is being
11217	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
11218	variable just set its name ("NAME") without a value.
11219	</desc>
11220	</param>
11221	<param name="userName" type="wstring" dir="in">
11222	<desc>
11223	User name under which the command will be executed; has to exist
11224	and have the appropriate rights to execute programs in the VM.
11225	</desc>
11226	</param>
11227	<param name="password" type="wstring" dir="in">
11228	<desc>
11229	Password of the user account specified.
11230	</desc>
11231	</param>
11232	<param name="timeoutMS" type="unsigned long" dir="in">
11233	<desc>
11234	The maximum timeout value (in msec) to wait for finished program
11235	execution. Pass 0 for an infinite timeout.
11236	</desc>
11237	</param>
11238	<param name="pid" type="unsigned long" dir="out">
11239	<desc>
11240	The PID (process ID) of the started command for later reference.
11241	</desc>
11242	</param>
11243	<param name="progress" type="IProgress" dir="return">
11244	<desc>Progress object to track the operation completion.</desc>
11245	</param>
11246	</method>
11247
11248	<method name="getProcessOutput">
11249	<desc>
11250	Retrieves output of a formerly started and running guest process.
11251
11252	<note>
11253	Starting with VirtualBox 4.1.8 this only will return output data
11254	from stdout or stderr if flag ExecuteProcessFlag_WaitForStdOut
11255	and/or respectively ExecuteProcessFlag_WaitForStdErr of
11256	<link to="ExecuteProcessFlag"/> is set in the
11257	former <link to="#executeProcess"/> call for this guest process.
11258	</note>
11259
11260	<result name="VBOX_E_IPRT_ERROR">
11261	Could not retrieve output.
11262	</result>
11263
11264	</desc>
11265	<param name="pid" type="unsigned long" dir="in">
11266	<desc>
11267	Process id returned by earlier <link to="#executeProcess"/> call.
11268	</desc>
11269	</param>
11270	<param name="flags" type="unsigned long" dir="in">
11271	<desc>
11272	<link to="ProcessOutputFlag"/> flags.
11273	</desc>
11274	</param>
11275	<param name="timeoutMS" type="unsigned long" dir="in">
11276	<desc>
11277	The maximum timeout value (in msec) to wait for output
11278	data. Pass 0 for an infinite timeout.
11279	</desc>
11280	</param>
11281	<param name="size" type="long long" dir="in">
11282	<desc>
11283	Size in bytes to read in the buffer.
11284	</desc>
11285	</param>
11286	<param name="data" type="octet" safearray="yes" dir="return">
11287	<desc>
11288	Buffer for retrieving the actual output. A data size of 0 means end of file
11289	if the requested size was not 0. This is the unprocessed
11290	output data, i.e. the line ending style depends on the platform of
11291	the system the server is running on.
11292	</desc>
11293	</param>
11294	</method>
11295
11296	<method name="getProcessStatus">
11297	<desc>
11298	Retrieves status, exit code and the exit reason of a formerly started
11299	guest process. If a guest process exited or got terminated this function
11300	returns its final status and removes this process from the list of
11301	known guest processes for further retrieval.
11302
11303	<result name="VBOX_E_IPRT_ERROR">
11304	Process with specified PID was not found.
11305	</result>
11306
11307	</desc>
11308	<param name="pid" type="unsigned long" dir="in">
11309	<desc>
11310	Process id returned by earlier <link to="#executeProcess"/> call.
11311	</desc>
11312	</param>
11313	<param name="exitcode" type="unsigned long" dir="out">
11314	<desc>
11315	The exit code (if available).
11316	</desc>
11317	</param>
11318	<param name="flags" type="unsigned long" dir="out">
11319	<desc>
11320	Additional flags of process status. Not used at the moment and
11321	must be set to 0.
11322	</desc>
11323	</param>
11324	<param name="reason" type="ExecuteProcessStatus" dir="return">
11325	<desc>
11326	The current process status.
11327	</desc>
11328	</param>
11329	</method>
11330
11331	<method name="copyFromGuest">
11332	<desc>
11333	Copies files/directories from guest to the host.
11334
11335	<result name="VBOX_E_IPRT_ERROR">
11336	Error while copying.
11337	</result>
11338
11339	</desc>
11340	<param name="source" type="wstring" dir="in">
11341	<desc>
11342	Source file on the guest to copy.
11343	</desc>
11344	</param>
11345	<param name="dest" type="wstring" dir="in">
11346	<desc>
11347	Destination path on the host.
11348	</desc>
11349	</param>
11350	<param name="userName" type="wstring" dir="in">
11351	<desc>
11352	User name under which the copy command will be executed; the
11353	user has to exist and have the appropriate rights to read from
11354	the source path.
11355	</desc>
11356	</param>
11357	<param name="password" type="wstring" dir="in">
11358	<desc>
11359	Password of the user account specified.
11360	</desc>
11361	</param>
11362	<param name="flags" type="unsigned long" dir="in">
11363	<desc>
11364	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
11365	</desc>
11366	</param>
11367	<param name="progress" type="IProgress" dir="return">
11368	<desc>Progress object to track the operation completion.</desc>
11369	</param>
11370	</method>
11371
11372	<method name="copyToGuest">
11373	<desc>
11374	Copies files/directories from host to the guest.
11375
11376	<result name="VBOX_E_IPRT_ERROR">
11377	Error while copying.
11378	</result>
11379
11380	</desc>
11381	<param name="source" type="wstring" dir="in">
11382	<desc>
11383	Source file on the host to copy.
11384	</desc>
11385	</param>
11386	<param name="dest" type="wstring" dir="in">
11387	<desc>
11388	Destination path on the guest.
11389	</desc>
11390	</param>
11391	<param name="userName" type="wstring" dir="in">
11392	<desc>
11393	User name under which the copy command will be executed; the
11394	user has to exist and have the appropriate rights to write to
11395	the destination path.
11396	</desc>
11397	</param>
11398	<param name="password" type="wstring" dir="in">
11399	<desc>
11400	Password of the user account specified.
11401	</desc>
11402	</param>
11403	<param name="flags" type="unsigned long" dir="in">
11404	<desc>
11405	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
11406	</desc>
11407	</param>
11408	<param name="progress" type="IProgress" dir="return">
11409	<desc>Progress object to track the operation completion.</desc>
11410	</param>
11411	</method>
11412
11413	<method name="directoryClose">
11414	<desc>
11415	Closes a formerly opened guest directory.
11416
11417	<result name="VBOX_E_IPRT_ERROR">
11418	Error while closing directory.
11419	</result>
11420
11421	</desc>
11422	<param name="handle" type="unsigned long" dir="in">
11423	<desc>
11424	Handle of opened directory to close.
11425	</desc>
11426	</param>
11427	</method>
11428
11429	<method name="directoryCreate">
11430	<desc>
11431	Creates a directory on the guest.
11432
11433	<result name="VBOX_E_IPRT_ERROR">
11434	Error while creating directory.
11435	</result>
11436
11437	</desc>
11438	<param name="directory" type="wstring" dir="in">
11439	<desc>
11440	Directory to create.
11441	</desc>
11442	</param>
11443	<param name="userName" type="wstring" dir="in">
11444	<desc>
11445	User name under which the directory creation will be executed; the
11446	user has to exist and have the appropriate rights to create the
11447	desired directory.
11448	</desc>
11449	</param>
11450	<param name="password" type="wstring" dir="in">
11451	<desc>
11452	Password of the user account specified.
11453	</desc>
11454	</param>
11455	<param name="mode" type="unsigned long" dir="in">
11456	<desc>
11457	File mode.
11458	</desc>
11459	</param>
11460	<param name="flags" type="unsigned long" dir="in">
11461	<desc>
11462	<link to="DirectoryCreateFlag"/> flags.
11463	</desc>
11464	</param>
11465	</method>
11466
11467	<method name="directoryOpen">
11468	<desc>
11469	Opens a directory on the guest.
11470
11471	<result name="VBOX_E_IPRT_ERROR">
11472	Error while opening / reading directory.
11473	</result>
11474
11475	</desc>
11476	<param name="directory" type="wstring" dir="in">
11477	<desc>
11478	Directory to read.
11479	</desc>
11480	</param>
11481	<param name="filter" type="wstring" dir="in">
11482	<desc>
11483	Directory filter (DOS style wildcards). Set to empty
11484	string if no filter required.
11485	</desc>
11486	</param>
11487	<param name="flags" type="unsigned long" dir="in">
11488	<desc>
11489	<link to="DirectoryOpenFlag"/> flags.
11490	</desc>
11491	</param>
11492	<param name="userName" type="wstring" dir="in">
11493	<desc>
11494	User name under which the directory reading will be performed; the
11495	user has to exist and have the appropriate rights to access / read the
11496	desired directory.
11497	</desc>
11498	</param>
11499	<param name="password" type="wstring" dir="in">
11500	<desc>
11501	Password of the user account specified.
11502	</desc>
11503	</param>
11504	<param name="handle" type="unsigned long" dir="return">
11505	<desc>
11506	Handle of opened directory returned by openDirectory.
11507	</desc>
11508	</param>
11509	</method>
11510
11511	<method name="directoryRead">
11512	<desc>
11513	Reads the next directory entry of an opened guest directory.
11514
11515	<result name="E_ABORT">
11516	When the end of the directory has been reached.
11517	</result>
11518
11519	<result name="VBOX_E_IPRT_ERROR">
11520	Error while opening / reading directory.
11521	</result>
11522
11523	</desc>
11524	<param name="handle" type="unsigned long" dir="in">
11525	<desc>
11526	Handle of opened directory returned by openDirectory.
11527	</desc>
11528	</param>
11529	<param name="entry" type="IGuestDirEntry" dir="return">
11530	<desc>
11531	Information about next directory entry on success.
11532	</desc>
11533	</param>
11534	</method>
11535
11536	<method name="fileExists">
11537	<desc>
11538	Checks if the specified file name exists and is a regular file.
11539
11540	If the file name ends with a slash or backslash, the function assumes
11541	it's a directory and will check if the specified directory exists and
11542	is a regular directory.
11543
11544	<result name="VBOX_E_IPRT_ERROR">
11545	Error while looking up information.
11546	</result>
11547
11548	</desc>
11549	<param name="file" type="wstring" dir="in">
11550	<desc>
11551	Full path of file to check.
11552	</desc>
11553	</param>
11554	<param name="userName" type="wstring" dir="in">
11555	<desc>
11556	User name under which the lookup will be performed; the
11557	user has to exist and have the appropriate rights to access / read the
11558	desired directory.
11559	</desc>
11560	</param>
11561	<param name="password" type="wstring" dir="in">
11562	<desc>
11563	Password of the user account specified.
11564	</desc>
11565	</param>
11566	<param name="exists" type="boolean" dir="return">
11567	<desc>
11568	True if it's a regular file, false if it isn't (or doesn't exist).
11569	</desc>
11570	</param>
11571	</method>
11572
11573	<method name="fileQuerySize">
11574	<desc>
11575	Queries the size of a file, given the path to it.
11576
11577	<result name="VBOX_E_IPRT_ERROR">
11578	Error while looking up information.
11579	</result>
11580
11581	</desc>
11582	<param name="file" type="wstring" dir="in">
11583	<desc>
11584	Full path of file to query file size for.
11585	</desc>
11586	</param>
11587	<param name="userName" type="wstring" dir="in">
11588	<desc>
11589	User name under which the lookup will be performed; the
11590	user has to exist and have the appropriate rights to access / read the
11591	desired directory.
11592	</desc>
11593	</param>
11594	<param name="password" type="wstring" dir="in">
11595	<desc>
11596	Password of the user account specified.
11597	</desc>
11598	</param>
11599	<param name="size" type="long long" dir="return">
11600	<desc>
11601	Size (in bytes) of file specified.
11602	</desc>
11603	</param>
11604	</method>
11605
11606	<method name="setProcessInput">
11607	<desc>
11608	Sends input into a formerly started process.
11609
11610	<result name="VBOX_E_IPRT_ERROR">
11611	Could not send input.
11612	</result>
11613
11614	</desc>
11615	<param name="pid" type="unsigned long" dir="in">
11616	<desc>
11617	Process id returned by earlier <link to="#executeProcess"/> call.
11618	</desc>
11619	</param>
11620	<param name="flags" type="unsigned long" dir="in">
11621	<desc>
11622	<link to="ProcessInputFlag"/> flags.
11623	</desc>
11624	</param>
11625	<param name="timeoutMS" type="unsigned long" dir="in">
11626	<desc>
11627	The maximum timeout value (in msec) to wait for getting the
11628	data transfered to the guest. Pass 0 for an infinite timeout.
11629	</desc>
11630	</param>
11631	<param name="data" type="octet" dir="in" safearray="yes">
11632	<desc>
11633	Buffer of input data to send to the started process to.
11634	</desc>
11635	</param>
11636	<param name="written" type="unsigned long" dir="return">
11637	<desc>
11638	Number of bytes written.
11639	</desc>
11640	</param>
11641	</method>
11642
11643	<method name="updateGuestAdditions">
11644	<desc>
11645	Updates already installed Guest Additions in a VM
11646	(Windows guests only).
11647
11648	<result name="VBOX_E_IPRT_ERROR">
11649	Error while updating.
11650	</result>
11651
11652	</desc>
11653	<param name="source" type="wstring" dir="in">
11654	<desc>
11655	Path to the Guest Additions .ISO file to use for the upate.
11656	</desc>
11657	</param>
11658	<param name="flags" type="AdditionsUpdateFlag" dir="in" safearray="yes">
11659	<desc>
11660	<link to="AdditionsUpdateFlag"/> flags.
11661	</desc>
11662	</param>
11663	<param name="progress" type="IProgress" dir="return">
11664	<desc>Progress object to track the operation completion.</desc>
11665	</param>
11666	</method>
11667
11668	</interface>
11669
11670
11671	<!--
11672	// IProgress
11673	/////////////////////////////////////////////////////////////////////////
11674	-->
11675
11676	<interface
11677	name="IProgress" extends="$unknown"
11678	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
11679	wsmap="managed"
11680	>
11681	<desc>
11682	The IProgress interface is used to track and control
11683	asynchronous tasks within VirtualBox.
11684
11685	An instance of this is returned every time VirtualBox starts
11686	an asynchronous task (in other words, a separate thread) which
11687	continues to run after a method call returns. For example,
11688	<link to="IConsole::saveState" />, which saves the state of
11689	a running virtual machine, can take a long time to complete.
11690	To be able to display a progress bar, a user interface such as
11691	the VirtualBox graphical user interface can use the IProgress
11692	object returned by that method.
11693
11694	Note that IProgress is a "read-only" interface in the sense
11695	that only the VirtualBox internals behind the Main API can
11696	create and manipulate progress objects, whereas client code
11697	can only use the IProgress object to monitor a task's
11698	progress and, if <link to="#cancelable" /> is @c true,
11699	cancel the task by calling <link to="#cancel" />.
11700
11701	A task represented by IProgress consists of either one or
11702	several sub-operations that run sequentially, one by one (see
11703	<link to="#operation" /> and <link to="#operationCount" />).
11704	Every operation is identified by a number (starting from 0)
11705	and has a separate description.
11706
11707	You can find the individual percentage of completion of the current
11708	operation in <link to="#operationPercent" /> and the
11709	percentage of completion of the task as a whole
11710	in <link to="#percent" />.
11711
11712	Similarly, you can wait for the completion of a particular
11713	operation via <link to="#waitForOperationCompletion" /> or
11714	for the completion of the whole task via
11715	<link to="#waitForCompletion" />.
11716	</desc>
11717
11718	<attribute name="id" type="uuid" mod="string" readonly="yes">
11719	<desc>ID of the task.</desc>
11720	</attribute>
11721
11722	<attribute name="description" type="wstring" readonly="yes">
11723	<desc>Description of the task.</desc>
11724	</attribute>
11725
11726	<attribute name="initiator" type="$unknown" readonly="yes">
11727	<desc>Initiator of the task.</desc>
11728	</attribute>
11729
11730	<attribute name="cancelable" type="boolean" readonly="yes">
11731	<desc>Whether the task can be interrupted.</desc>
11732	</attribute>
11733
11734	<attribute name="percent" type="unsigned long" readonly="yes">
11735	<desc>
11736	Current progress value of the task as a whole, in percent.
11737	This value depends on how many operations are already complete.
11738	Returns 100 if <link to="#completed" /> is @c true.
11739	</desc>
11740	</attribute>
11741
11742	<attribute name="timeRemaining" type="long" readonly="yes">
11743	<desc>
11744	Estimated remaining time until the task completes, in
11745	seconds. Returns 0 once the task has completed; returns -1
11746	if the remaining time cannot be computed, in particular if
11747	the current progress is 0.
11748
11749	Even if a value is returned, the estimate will be unreliable
11750	for low progress values. It will become more reliable as the
11751	task progresses; it is not recommended to display an ETA
11752	before at least 20% of a task have completed.
11753	</desc>
11754	</attribute>
11755
11756	<attribute name="completed" type="boolean" readonly="yes">
11757	<desc>Whether the task has been completed.</desc>
11758	</attribute>
11759
11760	<attribute name="canceled" type="boolean" readonly="yes">
11761	<desc>Whether the task has been canceled.</desc>
11762	</attribute>
11763
11764	<attribute name="resultCode" type="long" readonly="yes">
11765	<desc>
11766	Result code of the progress task.
11767	Valid only if <link to="#completed"/> is @c true.
11768	</desc>
11769	</attribute>
11770
11771	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
11772	<desc>
11773	Extended information about the unsuccessful result of the
11774	progress operation. May be @c null if no extended information
11775	is available.
11776	Valid only if <link to="#completed"/> is @c true and
11777	<link to="#resultCode"/> indicates a failure.
11778	</desc>
11779	</attribute>
11780
11781	<attribute name="operationCount" type="unsigned long" readonly="yes">
11782	<desc>
11783	Number of sub-operations this task is divided into.
11784	Every task consists of at least one suboperation.
11785	</desc>
11786	</attribute>
11787
11788	<attribute name="operation" type="unsigned long" readonly="yes">
11789	<desc>Number of the sub-operation being currently executed.</desc>
11790	</attribute>
11791
11792	<attribute name="operationDescription" type="wstring" readonly="yes">
11793	<desc>
11794	Description of the sub-operation being currently executed.
11795	</desc>
11796	</attribute>
11797
11798	<attribute name="operationPercent" type="unsigned long" readonly="yes">
11799	<desc>Progress value of the current sub-operation only, in percent.</desc>
11800	</attribute>
11801
11802	<attribute name="operationWeight" type="unsigned long" readonly="yes">
11803	<desc>Weight value of the current sub-operation only.</desc>
11804	</attribute>
11805
11806	<attribute name="timeout" type="unsigned long">
11807	<desc>
11808	When non-zero, this specifies the number of milliseconds after which
11809	the operation will automatically be canceled. This can only be set on
11810	cancelable objects.
11811	</desc>
11812	</attribute>
11813
11814	<method name="setCurrentOperationProgress">
11815	<desc>Internal method, not to be called externally.</desc>
11816	<param name="percent" type="unsigned long" dir="in" />
11817	</method>
11818	<method name="setNextOperation">
11819	<desc>Internal method, not to be called externally.</desc>
11820	<param name="nextOperationDescription" type="wstring" dir="in" />
11821	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
11822	</method>
11823
11824	<method name="waitForCompletion">
11825	<desc>
11826	Waits until the task is done (including all sub-operations)
11827	with a given timeout in milliseconds; specify -1 for an indefinite wait.
11828
11829	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
11830	thread are not processed while waiting. Neglecting event queues may
11831	have dire consequences (degrade performance, resource hogs,
11832	deadlocks, etc.), this is specially so for the main thread on
11833	platforms using XPCOM. Callers are adviced wait for short periods
11834	and service their event queues between calls, or to create a worker
11835	thread to do the waiting.
11836
11837	<result name="VBOX_E_IPRT_ERROR">
11838	Failed to wait for task completion.
11839	</result>
11840	</desc>
11841
11842	<param name="timeout" type="long" dir="in">
11843	<desc>
11844	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11845	</desc>
11846	</param>
11847	</method>
11848
11849	<method name="waitForOperationCompletion">
11850	<desc>
11851	Waits until the given operation is done with a given timeout in
11852	milliseconds; specify -1 for an indefinite wait.
11853
11854	See <link to="#waitForCompletion"> for event queue considerations.</link>
11855
11856	<result name="VBOX_E_IPRT_ERROR">
11857	Failed to wait for operation completion.
11858	</result>
11859
11860	</desc>
11861	<param name="operation" type="unsigned long" dir="in">
11862	<desc>
11863	Number of the operation to wait for.
11864	Must be less than <link to="#operationCount"/>.
11865	</desc>
11866	</param>
11867	<param name="timeout" type="long" dir="in">
11868	<desc>
11869	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11870	</desc>
11871	</param>
11872	</method>
11873
11874	<method name="waitForAsyncProgressCompletion">
11875	<desc>
11876	Waits until the other task is completed (including all
11877	sub-operations) and forward all changes from the other progress to
11878	this progress. This means sub-operation number, description, percent
11879	and so on.
11880
11881	You have to take care on setting up at least the same count on
11882	sub-operations in this progress object like there are in the other
11883	progress object.
11884
11885	If the other progress object supports cancel and this object gets any
11886	cancel request (when here enabled as well), it will be forwarded to
11887	the other progress object.
11888
11889	If there is an error in the other progress, this error isn't
11890	automatically transfered to this progress object. So you have to
11891	check any operation error within the other progress object, after
11892	this method returns.
11893	</desc>
11894
11895	<param name="pProgressAsync" type="IProgress" dir="in">
11896	<desc>
11897	The progress object of the asynchrony process.
11898	</desc>
11899	</param>
11900	</method>
11901
11902	<method name="cancel">
11903	<desc>
11904	Cancels the task.
11905	<note>
11906	If <link to="#cancelable"/> is @c false, then this method will fail.
11907	</note>
11908
11909	<result name="VBOX_E_INVALID_OBJECT_STATE">
11910	Operation cannot be canceled.
11911	</result>
11912
11913	</desc>
11914	</method>
11915
11916	</interface>
11917
11918	<!--
11919	// ISnapshot
11920	/////////////////////////////////////////////////////////////////////////
11921	-->
11922
11923	<interface
11924	name="ISnapshot" extends="$unknown"
11925	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
11926	wsmap="managed"
11927	>
11928	<desc>
11929	The ISnapshot interface represents a snapshot of the virtual
11930	machine.
11931
11932	Together with the differencing media that are created
11933	when a snapshot is taken, a machine can be brought back to
11934	the exact state it was in when the snapshot was taken.
11935
11936	The ISnapshot interface has no methods, only attributes; snapshots
11937	are controlled through methods of the <link to="IConsole" /> interface
11938	which also manage the media associated with the snapshot.
11939	The following operations exist:
11940
11941	<ul>
11942	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
11943	by creating new, empty differencing images for the machine's
11944	media and saving the VM settings and (if the VM is running)
11945	the current VM state in the snapshot.
11946
11947	The differencing images will then receive all data written to
11948	the machine's media, while their parent (base) images
11949	remain unmodified after the snapshot has been taken (see
11950	<link to="IMedium" /> for details about differencing images).
11951	This simplifies restoring a machine to the state of a snapshot:
11952	only the differencing images need to be deleted.
11953
11954	The current machine state is not changed by taking a snapshot
11955	except that <link to="IMachine::currentSnapshot" /> is set to
11956	the newly created snapshot, which is also added to the machine's
11957	snapshots tree.
11958	</li>
11959
11960	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
11961	the state of a previous snapshot by deleting the differencing
11962	image of each of the machine's media and setting the machine's
11963	settings and state to the state that was saved in the snapshot (if any).
11964
11965	This destroys the machine's current state. After calling this,
11966	<link to="IMachine::currentSnapshot" /> points to the snapshot
11967	that was restored.
11968	</li>
11969
11970	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
11971	without affecting the current machine state.
11972
11973	This does not change the current machine state, but instead frees the
11974	resources allocated when the snapshot was taken: the settings and machine
11975	state file are deleted (if any), and the snapshot's differencing image for
11976	each of the machine's media gets merged with its parent image.
11977
11978	Neither the current machine state nor other snapshots are affected
11979	by this operation, except that parent media will be modified
11980	to contain the disk data associated with the snapshot being deleted.
11981
11982	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
11983	attribute is set to the current snapshot's parent or @c null if it
11984	has no parent. Otherwise the attribute is unchanged.
11985	</li>
11986	</ul>
11987
11988	Each snapshot contains a copy of virtual machine's settings (hardware
11989	configuration etc.). This copy is contained in an immutable (read-only)
11990	instance of <link to="IMachine" /> which is available from the snapshot's
11991	<link to="#machine" /> attribute. When restoring the snapshot, these
11992	settings are copied back to the original machine.
11993
11994	In addition, if the machine was running when the
11995	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
11996	the current VM state is saved in the snapshot (similarly to what happens
11997	when a VM's state is saved). The snapshot is then said to be <i>online</i>
11998	because when restoring it, the VM will be running.
11999
12000	If the machine was in <link to="MachineState_Saved">saved</link> saved,
12001	the snapshot receives a copy of the execution state file
12002	(<link to="IMachine::stateFilePath"/>).
12003
12004	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
12005	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
12006	it then contains a so-called "zero execution state", representing a
12007	machine that is powered off.
12008	</desc>
12009
12010	<attribute name="id" type="uuid" mod="string" readonly="yes">
12011	<desc>UUID of the snapshot.</desc>
12012	</attribute>
12013
12014	<attribute name="name" type="wstring">
12015	<desc>Short name of the snapshot.
12016	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
12017	be called implicitly.</note>
12018	</desc>
12019	</attribute>
12020
12021	<attribute name="description" type="wstring">
12022	<desc>Optional description of the snapshot.
12023	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
12024	be called implicitly.</note>
12025	</desc>
12026	</attribute>
12027
12028	<attribute name="timeStamp" type="long long" readonly="yes">
12029	<desc>
12030	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
12031	</desc>
12032	</attribute>
12033
12034	<attribute name="online" type="boolean" readonly="yes">
12035	<desc>
12036	@c true if this snapshot is an online snapshot and @c false otherwise.
12037
12038	When this attribute is @c true, the
12039	<link to="IMachine::stateFilePath"/> attribute of the
12040	<link to="#machine"/> object associated with this snapshot
12041	will point to the saved state file. Otherwise, it will be
12042	an empty string.
12043	</desc>
12044	</attribute>
12045
12046	<attribute name="machine" type="IMachine" readonly="yes">
12047	<desc>
12048	Virtual machine this snapshot is taken on. This object
12049	stores all settings the machine had when taking this snapshot.
12050	<note>
12051	The returned machine object is immutable, i.e. no
12052	any settings can be changed.
12053	</note>
12054	</desc>
12055	</attribute>
12056
12057	<attribute name="parent" type="ISnapshot" readonly="yes">
12058	<desc>
12059	Parent snapshot (a snapshot this one is based on), or
12060	@c null if the snapshot has no parent (i.e. is the first snapshot).
12061	</desc>
12062	</attribute>
12063
12064	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
12065	<desc>
12066	Child snapshots (all snapshots having this one as a parent).
12067	By inspecting this attribute starting with a machine's root snapshot
12068	(which can be obtained by calling <link to="IMachine::findSnapshot" />
12069	with a @c null UUID), a machine's snapshots tree can be iterated over.
12070	</desc>
12071	</attribute>
12072
12073	<method name="getChildrenCount" const="yes">
12074	<desc>
12075	Returns the number of direct childrens of this snapshot.
12076	</desc>
12077	<param name="childrenCount" type="unsigned long" dir="return">
12078	<desc>
12079	</desc>
12080	</param>
12081	</method>
12082
12083	</interface>
12084
12085
12086	<!--
12087	// IMedium
12088	/////////////////////////////////////////////////////////////////////////
12089	-->
12090
12091	<enum
12092	name="MediumState"
12093	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
12094	>
12095	<desc>
12096	Virtual medium state.
12097	<see><link to="IMedium"/></see>
12098	</desc>
12099
12100	<const name="NotCreated" value="0">
12101	<desc>
12102	Associated medium storage does not exist (either was not created yet or
12103	was deleted).
12104	</desc>
12105	</const>
12106	<const name="Created" value="1">
12107	<desc>
12108	Associated storage exists and accessible; this gets set if the
12109	accessibility check performed by <link to="IMedium::refreshState" />
12110	was successful.
12111	</desc>
12112	</const>
12113	<const name="LockedRead" value="2">
12114	<desc>
12115	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
12116	no data modification is possible.
12117	</desc>
12118	</const>
12119	<const name="LockedWrite" value="3">
12120	<desc>
12121	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
12122	no concurrent data reading or modification is possible.
12123	</desc>
12124	</const>
12125	<const name="Inaccessible" value="4">
12126	<desc>
12127	Medium accessibility check (see <link to="IMedium::refreshState" />) has
12128	not yet been performed, or else, associated medium storage is not
12129	accessible. In the first case, <link to="IMedium::lastAccessError"/>
12130	is empty, in the second case, it describes the error that occurred.
12131	</desc>
12132	</const>
12133	<const name="Creating" value="5">
12134	<desc>
12135	Associated medium storage is being created.
12136	</desc>
12137	</const>
12138	<const name="Deleting" value="6">
12139	<desc>
12140	Associated medium storage is being deleted.
12141	</desc>
12142	</const>
12143	</enum>
12144
12145	<enum
12146	name="MediumType"
12147	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
12148	>
12149	<desc>
12150	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
12151	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
12152	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
12153	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
12154	</desc>
12155
12156	<const name="Normal" value="0">
12157	<desc>
12158	Normal medium (attached directly or indirectly, preserved
12159	when taking snapshots).
12160	</desc>
12161	</const>
12162	<const name="Immutable" value="1">
12163	<desc>
12164	Immutable medium (attached indirectly, changes are wiped out
12165	the next time the virtual machine is started).
12166	</desc>
12167	</const>
12168	<const name="Writethrough" value="2">
12169	<desc>
12170	Write through medium (attached directly, ignored when
12171	taking snapshots).
12172	</desc>
12173	</const>
12174	<const name="Shareable" value="3">
12175	<desc>
12176	Allow using this medium concurrently by several machines.
12177	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
12178	</desc>
12179	</const>
12180	<const name="Readonly" value="4">
12181	<desc>
12182	A readonly medium, which can of course be used by several machines.
12183	<note>Present and accepted since VirtualBox 4.0.</note>
12184	</desc>
12185	</const>
12186	<const name="MultiAttach" value="5">
12187	<desc>
12188	A medium which is indirectly attached, so that one base medium can
12189	be used for several VMs which have their own differencing medium to
12190	store their modifications. In some sense a variant of Immutable
12191	with unset AutoReset flag in each differencing medium.
12192	<note>Present and accepted since VirtualBox 4.0.</note>
12193	</desc>
12194	</const>
12195	</enum>
12196
12197	<enum
12198	name="MediumVariant"
12199	uuid="80685b6b-e42f-497d-8271-e77bf3c61ada"
12200	>
12201	<desc>
12202	Virtual medium image variant. More than one flag may be set.
12203	<see><link to="IMedium"/></see>
12204	</desc>
12205
12206	<const name="Standard" value="0">
12207	<desc>
12208	No particular variant requested, results in using the backend default.
12209	</desc>
12210	</const>
12211	<const name="VmdkSplit2G" value="0x01">
12212	<desc>
12213	VMDK image split in chunks of less than 2GByte.
12214	</desc>
12215	</const>
12216	<const name="VmdkRawDisk" value="0x02">
12217	<desc>
12218	VMDK image representing a raw disk.
12219	</desc>
12220	</const>
12221	<const name="VmdkStreamOptimized" value="0x04">
12222	<desc>
12223	VMDK streamOptimized image. Special import/export format which is
12224	read-only/append-only.
12225	</desc>
12226	</const>
12227	<const name="VmdkESX" value="0x08">
12228	<desc>
12229	VMDK format variant used on ESX products.
12230	</desc>
12231	</const>
12232	<const name="Fixed" value="0x10000">
12233	<desc>
12234	Fixed image. Only allowed for base images.
12235	</desc>
12236	</const>
12237	<const name="Diff" value="0x20000">
12238	<desc>
12239	Differencing image. Only allowed for child images.
12240	</desc>
12241	</const>
12242	<const name="NoCreateDir" value="0x40000000">
12243	<desc>
12244	Special flag which suppresses automatic creation of the subdirectory.
12245	Only used when passing the medium variant as an input parameter.
12246	</desc>
12247	</const>
12248	</enum>
12249
12250	<interface
12251	name="IMediumAttachment" extends="$unknown"
12252	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
12253	wsmap="struct"
12254	>
12255	<desc>
12256	The IMediumAttachment interface links storage media to virtual machines.
12257	For each medium (<link to="IMedium"/>) which has been attached to a
12258	storage controller (<link to="IStorageController"/>) of a machine
12259	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
12260	method, one instance of IMediumAttachment is added to the machine's
12261	<link to="IMachine::mediumAttachments"/> array attribute.
12262
12263	Each medium attachment specifies the storage controller as well as a
12264	port and device number and the IMedium instance representing a virtual
12265	hard disk or floppy or DVD image.
12266
12267	For removable media (DVDs or floppies), there are two additional
12268	options. For one, the IMedium instance can be @c null to represent
12269	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
12270	secondly, the medium can be one of the pseudo-media for host drives
12271	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
12272
12273	<h3>Attaching Hard Disks</h3>
12274
12275	Hard disks are attached to virtual machines using the
12276	<link to="IMachine::attachDevice"/> method and detached using the
12277	<link to="IMachine::detachDevice"/> method. Depending on a medium's
12278	type (see <link to="IMedium::type" />), hard disks are attached either
12279	<i>directly</i> or <i>indirectly</i>.
12280
12281	When a hard disk is being attached directly, it is associated with the
12282	virtual machine and used for hard disk operations when the machine is
12283	running. When a hard disk is being attached indirectly, a new differencing
12284	hard disk linked to it is implicitly created and this differencing hard
12285	disk is associated with the machine and used for hard disk operations.
12286	This also means that if <link to="IMachine::attachDevice"/> performs
12287	a direct attachment then the same hard disk will be returned in response
12288	to the subsequent <link to="IMachine::getMedium"/> call; however if
12289	an indirect attachment is performed then
12290	<link to="IMachine::getMedium"/> will return the implicitly created
12291	differencing hard disk, not the original one passed to <link
12292	to="IMachine::attachDevice"/>. In detail:
12293
12294	<ul>
12295	<li><b>Normal base</b> hard disks that do not have children (i.e.
12296	differencing hard disks linked to them) and that are not already
12297	attached to virtual machines in snapshots are attached <b>directly</b>.
12298	Otherwise, they are attached <b>indirectly</b> because having
12299	dependent children or being part of the snapshot makes it impossible
12300	to modify hard disk contents without breaking the integrity of the
12301	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
12302	quickly determine the kind of the attachment for the given hard
12303	disk. Note that if a normal base hard disk is to be indirectly
12304	attached to a virtual machine with snapshots then a special
12305	procedure called <i>smart attachment</i> is performed (see below).</li>
12306	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
12307	they are attached <b>directly</b> if they do not have children and are
12308	not attached to virtual machines in snapshots, and <b>indirectly</b>
12309	otherwise. Note that the smart attachment procedure is never performed
12310	for differencing hard disks.</li>
12311	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
12312	they are designed to be non-writable. If an immutable hard disk is
12313	attached to a virtual machine with snapshots then a special
12314	procedure called smart attachment is performed (see below).</li>
12315	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
12316	also as designed. This also means that writethrough hard disks cannot
12317	have other hard disks linked to them at all.</li>
12318	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
12319	also as designed. This also means that shareable hard disks cannot
12320	have other hard disks linked to them at all. They behave almost
12321	like writethrough hard disks, except that shareable hard disks can
12322	be attached to several virtual machines which are running, allowing
12323	concurrent accesses. You need special cluster software running in
12324	the virtual machines to make use of such disks.</li>
12325	</ul>
12326
12327	Note that the same hard disk, regardless of its type, may be attached to
12328	more than one virtual machine at a time. In this case, the machine that is
12329	started first gains exclusive access to the hard disk and attempts to
12330	start other machines having this hard disk attached will fail until the
12331	first machine is powered down.
12332
12333	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
12334	that the given hard disk remains associated with the given machine after a
12335	successful <link to="IMachine::detachDevice"/> call until
12336	<link to="IMachine::saveSettings"/> is called to save all changes to
12337	machine settings to disk. This deferring is necessary to guarantee that
12338	the hard disk configuration may be restored at any time by a call to
12339	<link to="IMachine::discardSettings"/> before the settings
12340	are saved (committed).
12341
12342	Note that if <link to="IMachine::discardSettings"/> is called after
12343	indirectly attaching some hard disks to the machine but before a call to
12344	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
12345	all differencing hard disks implicitly created by
12346	<link to="IMachine::attachDevice"/> for these indirect attachments.
12347	Such implicitly created hard disks will also be immediately deleted when
12348	detached explicitly using the <link to="IMachine::detachDevice"/>
12349	call if it is made before <link to="IMachine::saveSettings"/>. This
12350	implicit deletion is safe because newly created differencing hard
12351	disks do not contain any user data.
12352
12353	However, keep in mind that detaching differencing hard disks that were
12354	implicitly created by <link to="IMachine::attachDevice"/>
12355	before the last <link to="IMachine::saveSettings"/> call will
12356	<b>not</b> implicitly delete them as they may already contain some data
12357	(for example, as a result of virtual machine execution). If these hard
12358	disks are no more necessary, the caller can always delete them explicitly
12359	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
12360	from this machine by the <link to="IMachine::saveSettings"/> call.
12361
12362	<h3>Smart Attachment</h3>
12363
12364	When normal base or immutable hard disks are indirectly attached to a
12365	virtual machine then some additional steps are performed to make sure the
12366	virtual machine will have the most recent "view" of the hard disk being
12367	attached. These steps include walking through the machine's snapshots
12368	starting from the current one and going through ancestors up to the first
12369	snapshot. Hard disks attached to the virtual machine in all
12370	of the encountered snapshots are checked whether they are descendants of
12371	the given normal base or immutable hard disk. The first found child (which
12372	is the differencing hard disk) will be used instead of the normal base or
12373	immutable hard disk as a parent for creating a new differencing hard disk
12374	that will be actually attached to the machine. And only if no descendants
12375	are found or if the virtual machine does not have any snapshots then the
12376	normal base or immutable hard disk will be used itself as a parent for
12377	this differencing hard disk.
12378
12379	It is easier to explain what smart attachment does using the
12380	following example:
12381	<pre>
12382	BEFORE attaching B.vdi: AFTER attaching B.vdi:
12383
12384	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
12385	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
12386	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
12387	Snapshot 4 (none) Snapshot 4 (none)
12388	CurState (none) CurState (D3->D2.vdi)
12389
12390	NOT
12391	...
12392	CurState (D3->B.vdi)
12393	</pre>
12394	The first column is the virtual machine configuration before the base hard
12395	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
12396	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
12397	mean that the hard disk that is actually attached to the machine is a
12398	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
12399	another hard disk, <tt>B.vdi</tt>.
12400
12401	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
12402	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
12403	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
12404	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
12405	it cannot be attached directly and needs an indirect attachment (i.e.
12406	implicit creation of a new differencing hard disk). Due to the smart
12407	attachment procedure, the new differencing hard disk
12408	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
12409	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
12410	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
12411	machine.
12412
12413	Note that if there is more than one descendant hard disk of the given base
12414	hard disk found in a snapshot, and there is an exact device, channel and
12415	bus match, then this exact match will be used. Otherwise, the youngest
12416	descendant will be picked up.
12417
12418	There is one more important aspect of the smart attachment procedure which
12419	is not related to snapshots at all. Before walking through the snapshots
12420	as described above, the backup copy of the current list of hard disk
12421	attachment is searched for descendants. This backup copy is created when
12422	the hard disk configuration is changed for the first time after the last
12423	<link to="IMachine::saveSettings"/> call and used by
12424	<link to="IMachine::discardSettings"/> to undo the recent hard disk
12425	changes. When such a descendant is found in this backup copy, it will be
12426	simply re-attached back, without creating a new differencing hard disk for
12427	it. This optimization is necessary to make it possible to re-attach the
12428	base or immutable hard disk to a different bus, channel or device slot
12429	without losing the contents of the differencing hard disk actually
12430	attached to the machine in place of it.
12431
12432	</desc>
12433
12434	<attribute name="medium" type="IMedium" readonly="yes">
12435	<desc>Medium object associated with this attachment; it
12436	can be @c null for removable devices.</desc>
12437	</attribute>
12438
12439	<attribute name="controller" type="wstring" readonly="yes">
12440	<desc>Name of the storage controller of this attachment; this
12441	refers to one of the controllers in <link to="IMachine::storageControllers" />
12442	by name.</desc>
12443	</attribute>
12444
12445	<attribute name="port" type="long" readonly="yes">
12446	<desc>Port number of this attachment.
12447	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12448	</desc>
12449	</attribute>
12450
12451	<attribute name="device" type="long" readonly="yes">
12452	<desc>Device slot number of this attachment.
12453	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12454	</desc>
12455	</attribute>
12456
12457	<attribute name="type" type="DeviceType" readonly="yes">
12458	<desc>Device type of this attachment.</desc>
12459	</attribute>
12460
12461	<attribute name="passthrough" type="boolean" readonly="yes">
12462	<desc>Pass I/O requests through to a device on the host.</desc>
12463	</attribute>
12464
12465	<attribute name="temporaryEject" type="boolean" readonly="yes">
12466	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
12467	</attribute>
12468
12469	<attribute name="isEjected" type="boolean" readonly="yes">
12470	<desc>Signals that the removable medium has been ejected. This is not
12471	necessarily equivalent to having a @c null medium association.</desc>
12472	</attribute>
12473
12474	<attribute name="nonRotational" type="boolean" readonly="yes">
12475	<desc>Whether the associated medium is non-rotational.</desc>
12476	</attribute>
12477
12478	<attribute name="discard" type="boolean" readonly="yes">
12479	<desc>Whether the associated medium supports discarding unused blocks.</desc>
12480	</attribute>
12481
12482	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
12483	<desc>The bandwidth group this medium attachment is assigned to.</desc>
12484	</attribute>
12485
12486	</interface>
12487
12488	<interface
12489	name="IMedium" extends="$unknown"
12490	uuid="29989373-b111-4654-8493-2e1176cba890"
12491	wsmap="managed"
12492	>
12493	<desc>
12494	The IMedium interface represents virtual storage for a machine's
12495	hard disks, CD/DVD or floppy drives. It will typically represent
12496	a disk image on the host, for example a VDI or VMDK file representing
12497	a virtual hard disk, or an ISO or RAW file representing virtual
12498	removable media, but can also point to a network location (e.g.
12499	for iSCSI targets).
12500
12501	Instances of IMedium are connected to virtual machines by way of medium
12502	attachments, which link the storage medium to a particular device slot
12503	of a storage controller of the virtual machine.
12504	In the VirtualBox API, virtual storage is therefore always represented
12505	by the following chain of object links:
12506
12507	<ul>
12508	<li><link to="IMachine::storageControllers"/> contains an array of
12509	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
12510	these are instances of <link to="IStorageController"/>).</li>
12511	<li><link to="IMachine::mediumAttachments"/> contains an array of
12512	medium attachments (instances of <link to="IMediumAttachment"/>
12513	created by <link to="IMachine::attachDevice" />),
12514	each containing a storage controller from the above array, a
12515	port/device specification, and an instance of IMedium representing
12516	the medium storage (image file).
12517
12518	For removable media, the storage medium is optional; a medium
12519	attachment with no medium represents a CD/DVD or floppy drive
12520	with no medium inserted. By contrast, hard disk attachments
12521	will always have an IMedium object attached.</li>
12522	<li>Each IMedium in turn points to a storage unit (such as a file
12523	on the host computer or a network resource) that holds actual
12524	data. This location is represented by the <link to="#location"/>
12525	attribute.</li>
12526	</ul>
12527
12528	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
12529	new hard disk media can be created with the VirtualBox API using the
12530	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
12531	disks (see below) are usually implicitly created by VirtualBox as
12532	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
12533	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
12534	should be created with external tools and then opened from within VirtualBox.
12535
12536	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
12537	drive. In that case the <link to="#id" /> attribute contains the UUID of
12538	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
12539
12540	<h3>Media registries</h3>
12541
12542	When a medium has been opened or created using one of the aforementioned
12543	APIs, it becomes "known" to VirtualBox. Known media can be attached
12544	to virtual machines and re-found through <link to="IVirtualBox::openMedium"/>.
12545	They also appear in the global
12546	<link to="IVirtualBox::hardDisks" />,
12547	<link to="IVirtualBox::DVDImages" /> and
12548	<link to="IVirtualBox::floppyImages" /> arrays.
12549
12550	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
12551	in the VirtualBox.xml file, which was shared between all machines and made
12552	transporting machines and their media from one host to another difficult.
12553
12554	Starting with VirtualBox 4.0, media are only added to a registry when they are
12555	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
12556	backwards compatibility, which registry a medium is added to depends on which
12557	VirtualBox version created a machine:
12558
12559	<ul>
12560	<li>If the medium has first been attached to a machine which was created by
12561	VirtualBox 4.0 or later, it is added to that machine's media registry in
12562	the machine XML settings file. This way all information about a machine's
12563	media attachments is contained in a single file and can be transported
12564	easily.</li>
12565	<li>For older media attachments (i.e. if the medium was first attached to a
12566	machine which was created with a VirtualBox version before 4.0), media
12567	continue to be registered in the global VirtualBox settings file, for
12568	backwards compatibility.</li>
12569	</ul>
12570
12571	See <link to="IVirtualBox::openMedium" /> for more information.
12572
12573	Media are removed from media registries by the <link to="IMedium::close"/>,
12574	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
12575
12576	<h3>Accessibility checks</h3>
12577
12578	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
12579	method is called explicitly on a medium. This is done to make the VirtualBox object
12580	ready for serving requests as fast as possible and let the end-user
12581	application decide if it needs to check media accessibility right away or not.
12582
12583	As a result, when VirtualBox starts up (e.g. the VirtualBox
12584	object gets created for the first time), all known media are in the
12585	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
12586	attribute is an empty string because no actual accessibility check has
12587	been made yet.
12588
12589	After calling <link to="#refreshState" />, a medium is considered
12590	<i>accessible</i> if its storage unit can be read. In that case, the
12591	<link to="#state"/> attribute has a value of "Created". If the storage
12592	unit cannot be read (for example, because it is located on a disconnected
12593	network resource, or was accidentally deleted outside VirtualBox),
12594	the medium is considered <i>inaccessible</i>, which is indicated by the
12595	"Inaccessible" state. The exact reason why the medium is inaccessible can be
12596	obtained by reading the <link to="#lastAccessError"/> attribute.
12597
12598	<h3>Medium types</h3>
12599
12600	There are five types of medium behavior which are stored in the
12601	<link to="#type"/> attribute (see <link to="MediumType" />) and
12602	which define the medium's behavior with attachments and snapshots.
12603
12604	All media can be also divided in two groups: <i>base</i> media and
12605	<i>differencing</i> media. A base medium contains all sectors of the
12606	medium data in its own storage and therefore can be used independently.
12607	In contrast, a differencing medium is a "delta" to some other medium and
12608	contains only those sectors which differ from that other medium, which is
12609	then called a <i>parent</i>. The differencing medium is said to be
12610	<i>linked to</i> that parent. The parent may be itself a differencing
12611	medium, thus forming a chain of linked media. The last element in that
12612	chain must always be a base medium. Note that several differencing
12613	media may be linked to the same parent medium.
12614
12615	Differencing media can be distinguished from base media by querying the
12616	<link to="#parent"/> attribute: base media do not have parents they would
12617	depend on, so the value of this attribute is always @c null for them.
12618	Using this attribute, it is possible to walk up the medium tree (from the
12619	child medium to its parent). It is also possible to walk down the tree
12620	using the <link to="#children"/> attribute.
12621
12622	Note that the type of all differencing media is "normal"; all other
12623	values are meaningless for them. Base media may be of any type.
12624
12625	<h3>Automatic composition of the file name part</h3>
12626
12627	Another extension to the <link to="IMedium::location"/> attribute is that
12628	there is a possibility to cause VirtualBox to compose a unique value for
12629	the file name part of the location using the UUID of the hard disk. This
12630	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
12631	e.g. before the storage unit is created, and works as follows. You set the
12632	value of the <link to="IMedium::location"/> attribute to a location
12633	specification which only contains the path specification but not the file
12634	name part and ends with either a forward slash or a backslash character.
12635	In response, VirtualBox will generate a new UUID for the hard disk and
12636	compose the file name using the following pattern:
12637	<pre>
12638	<path>/{<uuid>}.<ext>
12639	</pre>
12640	where <tt><path></tt> is the supplied path specification,
12641	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
12642	is the default extension for the storage format of this hard disk. After
12643	that, you may call any of the methods that create a new hard disk storage
12644	unit and they will use the generated UUID and file name.
12645	</desc>
12646
12647	<attribute name="id" type="uuid" mod="string" readonly="yes">
12648	<desc>
12649	UUID of the medium. For a newly created medium, this value is a randomly
12650	generated UUID.
12651
12652	<note>
12653	For media in one of MediumState_NotCreated, MediumState_Creating or
12654	MediumState_Deleting states, the value of this property is undefined
12655	and will most likely be an empty UUID.
12656	</note>
12657	</desc>
12658	</attribute>
12659
12660	<attribute name="description" type="wstring">
12661	<desc>
12662	Optional description of the medium. For a newly created medium the value
12663	of this attribute is an empty string.
12664
12665	Medium types that don't support this attribute will return E_NOTIMPL in
12666	attempt to get or set this attribute's value.
12667
12668	<note>
12669	For some storage types, reading this attribute may return an outdated
12670	(last known) value when <link to="#state"/> is <link
12671	to="MediumState_Inaccessible"/> or <link
12672	to="MediumState_LockedWrite"/> because the value of this attribute is
12673	stored within the storage unit itself. Also note that changing the
12674	attribute value is not possible in such case, as well as when the
12675	medium is the <link to="MediumState_LockedRead"/> state.
12676	</note>
12677	</desc>
12678	</attribute>
12679
12680	<attribute name="state" type="MediumState" readonly="yes">
12681	<desc>
12682	Returns the current medium state, which is the last state set by
12683	the accessibility check performed by <link to="#refreshState"/>.
12684	If that method has not yet been called on the medium, the state
12685	is "Inaccessible"; as opposed to truly inaccessible media, the
12686	value of <link to="#lastAccessError"/> will be an empty string in
12687	that case.
12688
12689	<note>As of version 3.1, this no longer performs an accessibility check
12690	automatically; call <link to="#refreshState"/> for that.
12691	</note>
12692	</desc>
12693	</attribute>
12694
12695	<attribute name="variant" type="unsigned long" readonly="yes">
12696	<desc>
12697	Returns the storage format variant information for this medium
12698	as a combination of the flags described at <link to="MediumVariant" />.
12699	Before <link to="#refreshState"/> is called this method returns
12700	an undefined value.
12701	</desc>
12702	</attribute>
12703
12704	<attribute name="location" type="wstring">
12705	<desc>
12706	Location of the storage unit holding medium data.
12707
12708	The format of the location string is medium type specific. For medium
12709	types using regular files in a host's file system, the location
12710	string is the full file name.
12711
12712	Some medium types may support changing the storage unit location by
12713	simply changing the value of this property. If this operation is not
12714	supported, the implementation will return E_NOTIMPL in attempt to set
12715	this attribute's value.
12716
12717	When setting a value of the location attribute which is a regular file
12718	in the host's file system, the given file name may be either relative to
12719	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
12720	absolute. Note that if the given location specification does not contain
12721	the file extension part then a proper default extension will be
12722	automatically appended by the implementation depending on the medium type.
12723	</desc>
12724	</attribute>
12725
12726	<attribute name="name" type="wstring" readonly="yes">
12727	<desc>
12728	Name of the storage unit holding medium data.
12729
12730	The returned string is a short version of the <link to="#location"/>
12731	attribute that is suitable for representing the medium in situations
12732	where the full location specification is too long (such as lists
12733	and comboboxes in GUI frontends). This string is also used by frontends
12734	to sort the media list alphabetically when needed.
12735
12736	For example, for locations that are regular files in the host's file
12737	system, the value of this attribute is just the file name (+ extension),
12738	without the path specification.
12739
12740	Note that as opposed to the <link to="#location"/> attribute, the name
12741	attribute will not necessary be unique for a list of media of the
12742	given type and format.
12743	</desc>
12744	</attribute>
12745
12746	<attribute name="deviceType" type="DeviceType" readonly="yes">
12747	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
12748	medium.</desc>
12749	</attribute>
12750
12751	<attribute name="hostDrive" type="boolean" readonly="yes">
12752	<desc>True if this corresponds to a drive on the host.</desc>
12753	</attribute>
12754
12755	<attribute name="size" type="long long" readonly="yes">
12756	<desc>
12757	Physical size of the storage unit used to hold medium data (in bytes).
12758
12759	<note>
12760	For media whose <link to="#state"/> is <link
12761	to="MediumState_Inaccessible"/>, the value of this property is the
12762	last known size. For <link to="MediumState_NotCreated"/> media,
12763	the returned value is zero.
12764	</note>
12765	</desc>
12766	</attribute>
12767
12768	<attribute name="format" type="wstring" readonly="yes">
12769	<desc>
12770	Storage format of this medium.
12771
12772	The value of this attribute is a string that specifies a backend used
12773	to store medium data. The storage format is defined when you create a
12774	new medium or automatically detected when you open an existing medium,
12775	and cannot be changed later.
12776
12777	The list of all storage formats supported by this VirtualBox
12778	installation can be obtained using
12779	<link to="ISystemProperties::mediumFormats"/>.
12780	</desc>
12781	</attribute>
12782
12783	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
12784	<desc>
12785	Storage medium format object corresponding to this medium.
12786
12787	The value of this attribute is a reference to the medium format object
12788	that specifies the backend properties used to store medium data. The
12789	storage format is defined when you create a new medium or automatically
12790	detected when you open an existing medium, and cannot be changed later.
12791
12792	<note>@c null is returned if there is no associated medium format
12793	object. This can e.g. happen for medium objects representing host
12794	drives and other special medium objects.</note>
12795	</desc>
12796	</attribute>
12797
12798	<attribute name="type" type="MediumType">
12799	<desc>
12800	Type (role) of this medium.
12801
12802	The following constraints apply when changing the value of this
12803	attribute:
12804	<ul>
12805	<li>If a medium is attached to a virtual machine (either in the
12806	current state or in one of the snapshots), its type cannot be
12807	changed.
12808	</li>
12809	<li>As long as the medium has children, its type cannot be set
12810	to <link to="MediumType_Writethrough"/>.
12811	</li>
12812	<li>The type of all differencing media is
12813	<link to="MediumType_Normal"/> and cannot be changed.
12814	</li>
12815	</ul>
12816
12817	The type of a newly created or opened medium is set to
12818	<link to="MediumType_Normal"/>, except for DVD and floppy media,
12819	which have a type of <link to="MediumType_Writethrough"/>.
12820	</desc>
12821	</attribute>
12822
12823	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
12824	<desc>
12825	Returns which medium types can selected for this medium.
12826
12827	<result name="E_NOTIMPL">
12828	This attribute is not implemented at the moment.
12829	</result>
12830	</desc>
12831	</attribute>
12832
12833	<attribute name="parent" type="IMedium" readonly="yes">
12834	<desc>
12835	Parent of this medium (the medium this medium is directly based
12836	on).
12837
12838	Only differencing media have parents. For base (non-differencing)
12839	media, @c null is returned.
12840	</desc>
12841	</attribute>
12842
12843	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
12844	<desc>
12845	Children of this medium (all differencing media directly based
12846	on this medium). A @c null array is returned if this medium
12847	does not have any children.
12848	</desc>
12849	</attribute>
12850
12851	<attribute name="base" type="IMedium" readonly="yes">
12852	<desc>
12853	Base medium of this medium.
12854
12855	If this is a differencing medium, its base medium is the medium
12856	the given medium branch starts from. For all other types of media, this
12857	property returns the medium object itself (i.e. the same object this
12858	property is read on).
12859	</desc>
12860	</attribute>
12861
12862	<attribute name="readOnly" type="boolean" readonly="yes">
12863	<desc>
12864	Returns @c true if this medium is read-only and @c false otherwise.
12865
12866	A medium is considered to be read-only when its contents cannot be
12867	modified without breaking the integrity of other parties that depend on
12868	this medium such as its child media or snapshots of virtual machines
12869	where this medium is attached to these machines. If there are no
12870	children and no such snapshots then there is no dependency and the
12871	medium is not read-only.
12872
12873	The value of this attribute can be used to determine the kind of the
12874	attachment that will take place when attaching this medium to a
12875	virtual machine. If the value is @c false then the medium will
12876	be attached directly. If the value is @c true then the medium
12877	will be attached indirectly by creating a new differencing child
12878	medium for that. See the interface description for more information.
12879
12880	Note that all <link to="MediumType_Immutable">Immutable</link> media
12881	are always read-only while all
12882	<link to="MediumType_Writethrough">Writethrough</link> media are
12883	always not.
12884
12885	<note>
12886	The read-only condition represented by this attribute is related to
12887	the medium type and usage, not to the current
12888	<link to="IMedium::state">medium state</link> and not to the read-only
12889	state of the storage unit.
12890	</note>
12891	</desc>
12892	</attribute>
12893
12894	<attribute name="logicalSize" type="long long" readonly="yes">
12895	<desc>
12896	Logical size of this medium (in bytes), as reported to the
12897	guest OS running inside the virtual machine this medium is
12898	attached to. The logical size is defined when the medium is created
12899	and cannot be changed later.
12900
12901	<note>
12902	Reading this property on a differencing medium will return the size
12903	of its <link to="#base"/> medium.
12904	</note>
12905	<note>
12906	For media whose state is <link to="#state"/> is <link
12907	to="MediumState_Inaccessible"/>, the value of this property is the
12908	last known logical size. For <link to="MediumState_NotCreated"/>
12909	media, the returned value is zero.
12910	</note>
12911	</desc>
12912	</attribute>
12913
12914	<attribute name="autoReset" type="boolean">
12915	<desc>
12916	Whether this differencing medium will be automatically reset each
12917	time a virtual machine it is attached to is powered up. This
12918	attribute is automatically set to @c true for the last
12919	differencing image of an "immutable" medium (see
12920	<link to="MediumType" />).
12921
12922	See <link to="#reset"/> for more information about resetting
12923	differencing media.
12924
12925	<note>
12926	Reading this property on a base (non-differencing) medium will
12927	always @c false. Changing the value of this property in this
12928	case is not supported.
12929	</note>
12930
12931	<result name="VBOX_E_NOT_SUPPORTED">
12932	This is not a differencing medium (when changing the attribute
12933	value).
12934	</result>
12935	</desc>
12936	</attribute>
12937
12938	<attribute name="lastAccessError" type="wstring" readonly="yes">
12939	<desc>
12940	Text message that represents the result of the last accessibility
12941	check performed by <link to="#refreshState"/>.
12942
12943	An empty string is returned if the last accessibility check
12944	was successful or has not yet been called. As a result, if
12945	<link to="#state" /> is "Inaccessible" and this attribute is empty,
12946	then <link to="#refreshState"/> has yet to be called; this is the
12947	default value of media after VirtualBox initialization.
12948	A non-empty string indicates a failure and should normally describe
12949	a reason of the failure (for example, a file read error).
12950	</desc>
12951	</attribute>
12952
12953	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
12954	<desc>
12955	Array of UUIDs of all machines this medium is attached to.
12956
12957	A @c null array is returned if this medium is not attached to any
12958	machine or to any machine's snapshot.
12959
12960	<note>
12961	The returned array will include a machine even if this medium is not
12962	attached to that machine in the current state but attached to it in
12963	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
12964	details.
12965	</note>
12966	</desc>
12967	</attribute>
12968
12969	<method name="setIds">
12970	<desc>
12971	Changes the UUID and parent UUID for a hard disk medium.
12972	</desc>
12973	<param name="setImageId" type="boolean" dir="in">
12974	<desc>
12975	Select whether a new image UUID is set or not.
12976	</desc>
12977	</param>
12978	<param name="imageId" type="uuid" mod="string" dir="in">
12979	<desc>
12980	New UUID for the image. If an empty string is passed, then a new
12981	UUID is automatically created, provided that @a setImageId is @c true.
12982	Specifying a zero UUID is not allowed.
12983	</desc>
12984	</param>
12985	<param name="setParentId" type="boolean" dir="in">
12986	<desc>
12987	Select whether a new parent UUID is set or not.
12988	</desc>
12989	</param>
12990	<param name="parentId" type="uuid" mod="string" dir="in">
12991	<desc>
12992	New parent UUID for the image. If an empty string is passed, then a
12993	new UUID is automatically created, provided @a setParentId is
12994	@c true. A zero UUID is valid.
12995	</desc>
12996	</param>
12997	<result name="E_INVALIDARG">
12998	Invalid parameter combination.
12999	</result>
13000	<result name="VBOX_E_NOT_SUPPORTED">
13001	Medium is not a hard disk medium.
13002	</result>
13003	</method>
13004
13005	<method name="refreshState">
13006	<desc>
13007	If the current medium state (see <link to="MediumState"/>) is one of
13008	"Created", "Inaccessible" or "LockedRead", then this performs an
13009	accessibility check on the medium and sets the value of the <link to="#state"/>
13010	attribute accordingly; that value is also returned for convenience.
13011
13012	For all other state values, this does not perform a refresh but returns
13013	the state only.
13014
13015	The refresh, if performed, may take a long time (several seconds or even
13016	minutes, depending on the storage unit location and format) because it performs an
13017	accessibility check of the storage unit. This check may cause a significant
13018	delay if the storage unit of the given medium is, for example, a file located
13019	on a network share which is not currently accessible due to connectivity
13020	problems. In that case, the call will not return until a timeout
13021	interval defined by the host OS for this operation expires. For this reason,
13022	it is recommended to never read this attribute on the main UI thread to avoid
13023	making the UI unresponsive.
13024
13025	If the last known state of the medium is "Created" and the accessibility
13026	check fails, then the state would be set to "Inaccessible", and
13027	<link to="#lastAccessError"/> may be used to get more details about the
13028	failure. If the state of the medium is "LockedRead", then it remains the
13029	same, and a non-empty value of <link to="#lastAccessError"/> will
13030	indicate a failed accessibility check in this case.
13031
13032	Note that not all medium states are applicable to all medium types.
13033	</desc>
13034	<param name="state" type="MediumState" dir="return">
13035	<desc>
13036	New medium state.
13037	</desc>
13038	</param>
13039	</method>
13040
13041	<method name="getSnapshotIds">
13042	<desc>
13043	Returns an array of UUIDs of all snapshots of the given machine where
13044	this medium is attached to.
13045
13046	If the medium is attached to the machine in the current state, then the
13047	first element in the array will always be the ID of the queried machine
13048	(i.e. the value equal to the @c machineId argument), followed by
13049	snapshot IDs (if any).
13050
13051	If the medium is not attached to the machine in the current state, then
13052	the array will contain only snapshot IDs.
13053
13054	The returned array may be @c null if this medium is not attached
13055	to the given machine at all, neither in the current state nor in one of
13056	the snapshots.
13057	</desc>
13058	<param name="machineId" type="uuid" mod="string" dir="in">
13059	<desc>
13060	UUID of the machine to query.
13061	</desc>
13062	</param>
13063	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
13064	<desc>
13065	Array of snapshot UUIDs of the given machine using this medium.
13066	</desc>
13067	</param>
13068	</method>
13069
13070	<method name="lockRead">
13071	<desc>
13072	Locks this medium for reading.
13073
13074	A read lock is shared: many clients can simultaneously lock the
13075	same medium for reading unless it is already locked for writing (see
13076	<link to="#lockWrite"/>) in which case an error is returned.
13077
13078	When the medium is locked for reading, it cannot be modified
13079	from within VirtualBox. This means that any method that changes
13080	the properties of this medium or contents of the storage unit
13081	will return an error (unless explicitly stated otherwise). That
13082	includes an attempt to start a virtual machine that wants to
13083	write to the the medium.
13084
13085	When the virtual machine is started up, it locks for reading all
13086	media it uses in read-only mode. If some medium cannot be locked
13087	for reading, the startup procedure will fail.
13088	A medium is typically locked for reading while it is used by a running
13089	virtual machine but has a depending differencing image that receives
13090	the actual write operations. This way one base medium can have
13091	multiple child differencing images which can be written to
13092	simultaneously. Read-only media such as DVD and floppy images are
13093	also locked for reading only (so they can be in use by multiple
13094	machines simultaneously).
13095
13096	A medium is also locked for reading when it is the source of a
13097	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
13098
13099	The medium locked for reading must be unlocked using the <link
13100	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
13101	can be nested and must be followed by the same number of paired
13102	<link to="#unlockRead"/> calls.
13103
13104	This method sets the medium state (see <link to="#state"/>) to
13105	"LockedRead" on success. The medium's previous state must be
13106	one of "Created", "Inaccessible" or "LockedRead".
13107
13108	Locking an inaccessible medium is not an error; this method performs
13109	a logical lock that prevents modifications of this medium through
13110	the VirtualBox API, not a physical file-system lock of the underlying
13111	storage unit.
13112
13113	This method returns the current state of the medium
13114	<i>before</i> the operation.
13115
13116	<result name="VBOX_E_INVALID_OBJECT_STATE">
13117	Invalid medium state (e.g. not created, locked, inaccessible,
13118	creating, deleting).
13119	</result>
13120
13121	</desc>
13122	<param name="state" type="MediumState" dir="return">
13123	<desc>
13124	State of the medium after the operation.
13125	</desc>
13126	</param>
13127	</method>
13128
13129	<method name="unlockRead">
13130	<desc>
13131	Cancels the read lock previously set by <link to="#lockRead"/>.
13132
13133	For both success and failure, this method returns the current state
13134	of the medium <i>after</i> the operation.
13135
13136	See <link to="#lockRead"/> for more details.
13137
13138	<result name="VBOX_E_INVALID_OBJECT_STATE">
13139	Medium not locked for reading.
13140	</result>
13141
13142	</desc>
13143	<param name="state" type="MediumState" dir="return">
13144	<desc>
13145	State of the medium after the operation.
13146	</desc>
13147	</param>
13148	</method>
13149
13150	<method name="lockWrite">
13151	<desc>
13152	Locks this medium for writing.
13153
13154	A write lock, as opposed to <link to="#lockRead"/>, is
13155	exclusive: there may be only one client holding a write lock,
13156	and there may be no read locks while the write lock is held.
13157	As a result, read-locking fails if a write lock is held, and
13158	write-locking fails if either a read or another write lock is held.
13159
13160	When a medium is locked for writing, it cannot be modified
13161	from within VirtualBox, and it is not guaranteed that the values
13162	of its properties are up-to-date. Any method that changes the
13163	properties of this medium or contents of the storage unit will
13164	return an error (unless explicitly stated otherwise).
13165
13166	When a virtual machine is started up, it locks for writing all
13167	media it uses to write data to. If any medium could not be locked
13168	for writing, the startup procedure will fail. If a medium has
13169	differencing images, then while the machine is running, only
13170	the last ("leaf") differencing image is locked for writing,
13171	whereas its parents are locked for reading only.
13172
13173	A medium is also locked for writing when it is the target of a
13174	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
13175
13176	The medium locked for writing must be unlocked using the <link
13177	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
13178
13179	This method sets the medium state (see <link to="#state"/>) to
13180	"LockedWrite" on success. The medium's previous state must be
13181	either "Created" or "Inaccessible".
13182
13183	Locking an inaccessible medium is not an error; this method performs
13184	a logical lock that prevents modifications of this medium through
13185	the VirtualBox API, not a physical file-system lock of the underlying
13186	storage unit.
13187
13188	For both, success and failure, this method returns the current
13189	state of the medium <i>before</i> the operation.
13190
13191	<result name="VBOX_E_INVALID_OBJECT_STATE">
13192	Invalid medium state (e.g. not created, locked, inaccessible,
13193	creating, deleting).
13194	</result>
13195
13196	</desc>
13197	<param name="state" type="MediumState" dir="return">
13198	<desc>
13199	State of the medium after the operation.
13200	</desc>
13201	</param>
13202	</method>
13203
13204	<method name="unlockWrite">
13205	<desc>
13206	Cancels the write lock previously set by <link to="#lockWrite"/>.
13207
13208	For both success and failure, this method returns the current
13209	state of the medium <i>after</i> the operation.
13210
13211	See <link to="#lockWrite"/> for more details.
13212
13213	<result name="VBOX_E_INVALID_OBJECT_STATE">
13214	Medium not locked for writing.
13215	</result>
13216
13217	</desc>
13218	<param name="state" type="MediumState" dir="return">
13219	<desc>
13220	State of the medium after the operation.
13221	</desc>
13222	</param>
13223	</method>
13224
13225	<method name="close">
13226	<desc>
13227	Closes this medium.
13228
13229	The medium must not be attached to any known virtual machine
13230	and must not have any known child media, otherwise the
13231	operation will fail.
13232
13233	When the medium is successfully closed, it is removed from
13234	the list of registered media, but its storage unit is not
13235	deleted. In particular, this means that this medium can
13236	later be opened again using the <link to="IVirtualBox::openMedium"/>
13237	call.
13238
13239	Note that after this method successfully returns, the given medium
13240	object becomes uninitialized. This means that any attempt
13241	to call any of its methods or attributes will fail with the
13242	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
13243
13244	<result name="VBOX_E_INVALID_OBJECT_STATE">
13245	Invalid medium state (other than not created, created or
13246	inaccessible).
13247	</result>
13248	<result name="VBOX_E_OBJECT_IN_USE">
13249	Medium attached to virtual machine.
13250	</result>
13251	<result name="VBOX_E_FILE_ERROR">
13252	Settings file not accessible.
13253	</result>
13254	<result name="VBOX_E_XML_ERROR">
13255	Could not parse the settings file.
13256	</result>
13257
13258	</desc>
13259	</method>
13260
13261	<!-- property methods -->
13262
13263	<method name="getProperty" const="yes">
13264	<desc>
13265	Returns the value of the custom medium property with the given name.
13266
13267	The list of all properties supported by the given medium format can
13268	be obtained with <link to="IMediumFormat::describeProperties"/>.
13269
13270	<note>If this method returns an empty string in @a value, the requested
13271	property is supported but currently not assigned any value.</note>
13272
13273	<result name="VBOX_E_OBJECT_NOT_FOUND">
13274	Requested property does not exist (not supported by the format).
13275	</result>
13276	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13277	</desc>
13278	<param name="name" type="wstring" dir="in">
13279	<desc>Name of the property to get.</desc>
13280	</param>
13281	<param name="value" type="wstring" dir="return">
13282	<desc>Current property value.</desc>
13283	</param>
13284	</method>
13285
13286	<method name="setProperty">
13287	<desc>
13288	Sets the value of the custom medium property with the given name.
13289
13290	The list of all properties supported by the given medium format can
13291	be obtained with <link to="IMediumFormat::describeProperties"/>.
13292
13293	<note>Setting the property value to @c null or an empty string is
13294	equivalent to deleting the existing value. A default value (if it is
13295	defined for this property) will be used by the format backend in this
13296	case.</note>
13297
13298	<result name="VBOX_E_OBJECT_NOT_FOUND">
13299	Requested property does not exist (not supported by the format).
13300	</result>
13301	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13302	</desc>
13303	<param name="name" type="wstring" dir="in">
13304	<desc>Name of the property to set.</desc>
13305	</param>
13306	<param name="value" type="wstring" dir="in">
13307	<desc>Property value to set.</desc>
13308	</param>
13309	</method>
13310
13311	<method name="getProperties" const="yes">
13312	<desc>
13313	Returns values for a group of properties in one call.
13314
13315	The names of the properties to get are specified using the @a names
13316	argument which is a list of comma-separated property names or
13317	an empty string if all properties are to be returned.
13318	<note>Currently the value of this argument is ignored and the method
13319	always returns all existing properties.</note>
13320
13321	The list of all properties supported by the given medium format can
13322	be obtained with <link to="IMediumFormat::describeProperties"/>.
13323
13324	The method returns two arrays, the array of property names corresponding
13325	to the @a names argument and the current values of these properties.
13326	Both arrays have the same number of elements with each element at the
13327	given index in the first array corresponds to an element at the same
13328	index in the second array.
13329
13330	For properties that do not have assigned values, an empty string is
13331	returned at the appropriate index in the @a returnValues array.
13332
13333	</desc>
13334	<param name="names" type="wstring" dir="in">
13335	<desc>
13336	Names of properties to get.
13337	</desc>
13338	</param>
13339	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13340	<desc>Names of returned properties.</desc>
13341	</param>
13342	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13343	<desc>Values of returned properties.</desc>
13344	</param>
13345	</method>
13346
13347	<method name="setProperties">
13348	<desc>
13349	Sets values for a group of properties in one call.
13350
13351	The names of the properties to set are passed in the @a names
13352	array along with the new values for them in the @a values array. Both
13353	arrays have the same number of elements with each element at the given
13354	index in the first array corresponding to an element at the same index
13355	in the second array.
13356
13357	If there is at least one property name in @a names that is not valid,
13358	the method will fail before changing the values of any other properties
13359	from the @a names array.
13360
13361	Using this method over <link to="#setProperty"/> is preferred if you
13362	need to set several properties at once since it is more efficient.
13363
13364	The list of all properties supported by the given medium format can
13365	be obtained with <link to="IMediumFormat::describeProperties"/>.
13366
13367	Setting the property value to @c null or an empty string is equivalent
13368	to deleting the existing value. A default value (if it is defined for
13369	this property) will be used by the format backend in this case.
13370	</desc>
13371	<param name="names" type="wstring" safearray="yes" dir="in">
13372	<desc>Names of properties to set.</desc>
13373	</param>
13374	<param name="values" type="wstring" safearray="yes" dir="in">
13375	<desc>Values of properties to set.</desc>
13376	</param>
13377	</method>
13378
13379	<!-- storage methods -->
13380
13381	<method name="createBaseStorage">
13382	<desc>
13383	Starts creating a hard disk storage unit (fixed/dynamic, according
13384	to the variant flags) in in the background. The previous storage unit
13385	created for this object, if any, must first be deleted using
13386	<link to="#deleteStorage"/>, otherwise the operation will fail.
13387
13388	Before the operation starts, the medium is placed in
13389	<link to="MediumState_Creating"/> state. If the create operation
13390	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
13391	state.
13392
13393	After the returned progress object reports that the operation has
13394	successfully completed, the medium state will be set to <link
13395	to="MediumState_Created"/>, the medium will be remembered by this
13396	VirtualBox installation and may be attached to virtual machines.
13397
13398	<result name="VBOX_E_NOT_SUPPORTED">
13399	The variant of storage creation operation is not supported. See <link
13400	to="IMediumFormat::capabilities"/>.
13401	</result>
13402	</desc>
13403	<param name="logicalSize" type="long long" dir="in">
13404	<desc>Maximum logical size of the medium in bytes.</desc>
13405	</param>
13406	<param name="variant" type="unsigned long" dir="in">
13407	<desc>Exact image variant which should be created (as a combination of
13408	<link to="MediumVariant" /> flags).</desc>
13409	</param>
13410	<param name="progress" type="IProgress" dir="return">
13411	<desc>Progress object to track the operation completion.</desc>
13412	</param>
13413	</method>
13414
13415	<method name="deleteStorage">
13416	<desc>
13417	Starts deleting the storage unit of this medium.
13418
13419	The medium must not be attached to any known virtual machine and must
13420	not have any known child media, otherwise the operation will fail.
13421	It will also fail if there is no storage unit to delete or if deletion
13422	is already in progress, or if the medium is being in use (locked for
13423	read or for write) or inaccessible. Therefore, the only valid state for
13424	this operation to succeed is <link to="MediumState_Created"/>.
13425
13426	Before the operation starts, the medium is placed in
13427	<link to="MediumState_Deleting"/> state and gets removed from the list
13428	of remembered hard disks (media registry). If the delete operation
13429	fails, the medium will be remembered again and placed back to
13430	<link to="MediumState_Created"/> state.
13431
13432	After the returned progress object reports that the operation is
13433	complete, the medium state will be set to
13434	<link to="MediumState_NotCreated"/> and you will be able to use one of
13435	the storage creation methods to create it again.
13436
13437	<see><link to="#close"/></see>
13438
13439	<result name="VBOX_E_OBJECT_IN_USE">
13440	Medium is attached to a virtual machine.
13441	</result>
13442	<result name="VBOX_E_NOT_SUPPORTED">
13443	Storage deletion is not allowed because neither of storage creation
13444	operations are supported. See
13445	<link to="IMediumFormat::capabilities"/>.
13446	</result>
13447
13448	<note>
13449	If the deletion operation fails, it is not guaranteed that the storage
13450	unit still exists. You may check the <link to="IMedium::state"/> value
13451	to answer this question.
13452	</note>
13453	</desc>
13454	<param name="progress" type="IProgress" dir="return">
13455	<desc>Progress object to track the operation completion.</desc>
13456	</param>
13457	</method>
13458
13459	<!-- diff methods -->
13460
13461	<method name="createDiffStorage">
13462	<desc>
13463	Starts creating an empty differencing storage unit based on this
13464	medium in the format and at the location defined by the @a target
13465	argument.
13466
13467	The target medium must be in <link to="MediumState_NotCreated"/>
13468	state (i.e. must not have an existing storage unit). Upon successful
13469	completion, this operation will set the type of the target medium to
13470	<link to="MediumType_Normal"/> and create a storage unit necessary to
13471	represent the differencing medium data in the given format (according
13472	to the storage format of the target object).
13473
13474	After the returned progress object reports that the operation is
13475	successfully complete, the target medium gets remembered by this
13476	VirtualBox installation and may be attached to virtual machines.
13477
13478	<note>
13479	The medium will be set to <link to="MediumState_LockedRead"/>
13480	state for the duration of this operation.
13481	</note>
13482	<result name="VBOX_E_OBJECT_IN_USE">
13483	Medium not in @c NotCreated state.
13484	</result>
13485	</desc>
13486	<param name="target" type="IMedium" dir="in">
13487	<desc>Target medium.</desc>
13488	</param>
13489	<param name="variant" type="unsigned long" dir="in">
13490	<desc>Exact image variant which should be created (as a combination of
13491	<link to="MediumVariant" /> flags).</desc>
13492	</param>
13493	<param name="progress" type="IProgress" dir="return">
13494	<desc>Progress object to track the operation completion.</desc>
13495	</param>
13496	</method>
13497
13498	<method name="mergeTo">
13499	<desc>
13500	Starts merging the contents of this medium and all intermediate
13501	differencing media in the chain to the given target medium.
13502
13503	The target medium must be either a descendant of this medium or
13504	its ancestor (otherwise this method will immediately return a failure).
13505	It follows that there are two logical directions of the merge operation:
13506	from ancestor to descendant (<i>forward merge</i>) and from descendant to
13507	ancestor (<i>backward merge</i>). Let us consider the following medium
13508	chain:
13509
13510	<pre>Base <- Diff_1 <- Diff_2</pre>
13511
13512	Here, calling this method on the <tt>Base</tt> medium object with
13513	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
13514	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
13515	merge. Note that in both cases the contents of the resulting medium
13516	will be the same, the only difference is the medium object that takes
13517	the result of the merge operation. In case of the forward merge in the
13518	above example, the result will be written to <tt>Diff_2</tt>; in case of
13519	the backward merge, the result will be written to <tt>Base</tt>. In
13520	other words, the result of the operation is always stored in the target
13521	medium.
13522
13523	Upon successful operation completion, the storage units of all media in
13524	the chain between this (source) medium and the target medium, including
13525	the source medium itself, will be automatically deleted and the
13526	relevant medium objects (including this medium) will become
13527	uninitialized. This means that any attempt to call any of
13528	their methods or attributes will fail with the
13529	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
13530	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
13531	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
13532	Note that <tt>Diff_2</tt> in this case will become a base medium
13533	itself since it will no longer be based on any other medium.
13534
13535	Considering the above, all of the following conditions must be met in
13536	order for the merge operation to succeed:
13537	<ul>
13538	<li>
13539	Neither this (source) medium nor any intermediate
13540	differencing medium in the chain between it and the target
13541	medium is attached to any virtual machine.
13542	</li>
13543	<li>
13544	Neither the source medium nor the target medium is an
13545	<link to="MediumType_Immutable"/> medium.
13546	</li>
13547	<li>
13548	The part of the medium tree from the source medium to the
13549	target medium is a linear chain, i.e. all medium in this
13550	chain have exactly one child which is the next medium in this
13551	chain. The only exception from this rule is the target medium in
13552	the forward merge operation; it is allowed to have any number of
13553	child media because the merge operation will not change its
13554	logical contents (as it is seen by the guest OS or by children).
13555	</li>
13556	<li>
13557	None of the involved media are in
13558	<link to="MediumState_LockedRead"/> or
13559	<link to="MediumState_LockedWrite"/> state.
13560	</li>
13561	</ul>
13562
13563	<note>
13564	This (source) medium and all intermediates will be placed to <link
13565	to="MediumState_Deleting"/> state and the target medium will be
13566	placed to <link to="MediumState_LockedWrite"/> state and for the
13567	duration of this operation.
13568	</note>
13569	</desc>
13570	<param name="target" type="IMedium" dir="in">
13571	<desc>Target medium.</desc>
13572	</param>
13573	<param name="progress" type="IProgress" dir="return">
13574	<desc>Progress object to track the operation completion.</desc>
13575	</param>
13576	</method>
13577
13578	<!-- clone method -->
13579
13580	<method name="cloneTo">
13581	<desc>
13582	Starts creating a clone of this medium in the format and at the
13583	location defined by the @a target argument.
13584
13585	The target medium must be either in <link to="MediumState_NotCreated"/>
13586	state (i.e. must not have an existing storage unit) or in
13587	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13588	big enough to hold the data or else the copy will be partial). Upon
13589	successful completion, the cloned medium will contain exactly the
13590	same sector data as the medium being cloned, except that in the
13591	first case a new UUID for the clone will be randomly generated, and in
13592	the second case the UUID will remain unchanged.
13593
13594	The @a parent argument defines which medium will be the parent
13595	of the clone. Passing a @c null reference indicates that the clone will
13596	be a base image, i.e. completely independent. It is possible to specify
13597	an arbitrary medium for this parameter, including the parent of the
13598	medium which is being cloned. Even cloning to a child of the source
13599	medium is possible. Note that when cloning to an existing image, the
13600	@a parent argument is ignored.
13601
13602	After the returned progress object reports that the operation is
13603	successfully complete, the target medium gets remembered by this
13604	VirtualBox installation and may be attached to virtual machines.
13605
13606	<note>
13607	This medium will be placed to <link to="MediumState_LockedRead"/>
13608	state for the duration of this operation.
13609	</note>
13610	<result name="E_NOTIMPL">
13611	The specified cloning variant is not supported at the moment.
13612	</result>
13613	</desc>
13614	<param name="target" type="IMedium" dir="in">
13615	<desc>Target medium.</desc>
13616	</param>
13617	<param name="variant" type="unsigned long" dir="in">
13618	<desc>Exact image variant which should be created (as a combination of
13619	<link to="MediumVariant" /> flags).</desc>
13620	</param>
13621	<param name="parent" type="IMedium" dir="in">
13622	<desc>Parent of the cloned medium.</desc>
13623	</param>
13624	<param name="progress" type="IProgress" dir="return">
13625	<desc>Progress object to track the operation completion.</desc>
13626	</param>
13627	</method>
13628
13629	<method name="cloneToBase">
13630	<desc>
13631	Starts creating a clone of this medium in the format and at the
13632	location defined by the @a target argument.
13633
13634	The target medium must be either in <link to="MediumState_NotCreated"/>
13635	state (i.e. must not have an existing storage unit) or in
13636	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13637	big enough to hold the data or else the copy will be partial). Upon
13638	successful completion, the cloned medium will contain exactly the
13639	same sector data as the medium being cloned, except that in the
13640	first case a new UUID for the clone will be randomly generated, and in
13641	the second case the UUID will remain unchanged.
13642
13643	The @a parent argument defines which medium will be the parent
13644	of the clone. In this case the clone will be a base image, i.e.
13645	completely independent. It is possible to specify an arbitrary
13646	medium for this parameter, including the parent of the
13647	medium which is being cloned. Even cloning to a child of the source
13648	medium is possible. Note that when cloning to an existing image, the
13649	@a parent argument is ignored.
13650
13651	After the returned progress object reports that the operation is
13652	successfully complete, the target medium gets remembered by this
13653	VirtualBox installation and may be attached to virtual machines.
13654
13655	<note>
13656	This medium will be placed to <link to="MediumState_LockedRead"/>
13657	state for the duration of this operation.
13658	</note>
13659	<result name="E_NOTIMPL">
13660	The specified cloning variant is not supported at the moment.
13661	</result>
13662	</desc>
13663	<param name="target" type="IMedium" dir="in">
13664	<desc>Target medium.</desc>
13665	</param>
13666	<param name="variant" type="unsigned long" dir="in">
13667	<desc>Exact image variant which should be created (as a combination of
13668	<link to="MediumVariant" /> flags).</desc>
13669	</param>
13670	<param name="progress" type="IProgress" dir="return">
13671	<desc>Progress object to track the operation completion.</desc>
13672	</param>
13673	</method>
13674
13675	<!-- other methods -->
13676
13677	<method name="compact">
13678	<desc>
13679	Starts compacting of this medium. This means that the medium is
13680	transformed into a possibly more compact storage representation.
13681	This potentially creates temporary images, which can require a
13682	substantial amount of additional disk space.
13683
13684	This medium will be placed to <link to="MediumState_LockedWrite"/>
13685	state and all its parent media (if any) will be placed to
13686	<link to="MediumState_LockedRead"/> state for the duration of this
13687	operation.
13688
13689	Please note that the results can be either returned straight away,
13690	or later as the result of the background operation via the object
13691	returned via the @a progress parameter.
13692
13693	<result name="VBOX_E_NOT_SUPPORTED">
13694	Medium format does not support compacting (but potentially
13695	needs it).
13696	</result>
13697	</desc>
13698	<param name="progress" type="IProgress" dir="return">
13699	<desc>Progress object to track the operation completion.</desc>
13700	</param>
13701	</method>
13702
13703	<method name="resize">
13704	<desc>
13705	Starts resizing this medium. This means that the nominal size of the
13706	medium is set to the new value. Both increasing and decreasing the
13707	size is possible, and there are no safety checks, since VirtualBox
13708	does not make any assumptions about the medium contents.
13709
13710	Resizing usually needs additional disk space, and possibly also
13711	some temporary disk space. Note that resize does not create a full
13712	temporary copy of the medium, so the additional disk space requirement
13713	is usually much lower than using the clone operation.
13714
13715	This medium will be placed to <link to="MediumState_LockedWrite"/>
13716	state for the duration of this operation.
13717
13718	Please note that the results can be either returned straight away,
13719	or later as the result of the background operation via the object
13720	returned via the @a progress parameter.
13721
13722	<result name="VBOX_E_NOT_SUPPORTED">
13723	Medium format does not support resizing.
13724	</result>
13725	</desc>
13726	<param name="logicalSize" type="long long" dir="in">
13727	<desc>New nominal capacity of the medium in bytes.</desc>
13728	</param>
13729	<param name="progress" type="IProgress" dir="return">
13730	<desc>Progress object to track the operation completion.</desc>
13731	</param>
13732	</method>
13733
13734	<method name="reset">
13735	<desc>
13736	Starts erasing the contents of this differencing medium.
13737
13738	This operation will reset the differencing medium to its initial
13739	state when it does not contain any sector data and any read operation is
13740	redirected to its parent medium. This automatically gets called
13741	during VM power-up for every medium whose <link to="#autoReset" />
13742	attribute is @c true.
13743
13744	The medium will be write-locked for the duration of this operation (see
13745	<link to="#lockWrite" />).
13746
13747	<result name="VBOX_E_NOT_SUPPORTED">
13748	This is not a differencing medium.
13749	</result>
13750	<result name="VBOX_E_INVALID_OBJECT_STATE">
13751	Medium is not in <link to="MediumState_Created"/> or
13752	<link to="MediumState_Inaccessible"/> state.
13753	</result>
13754	</desc>
13755	<param name="progress" type="IProgress" dir="return">
13756	<desc>Progress object to track the operation completion.</desc>
13757	</param>
13758	</method>
13759
13760	</interface>
13761
13762
13763	<!--
13764	// IMediumFormat
13765	/////////////////////////////////////////////////////////////////////////
13766	-->
13767
13768	<enum
13769	name="DataType"
13770	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
13771	>
13772	<const name="Int32" value="0"/>
13773	<const name="Int8" value="1"/>
13774	<const name="String" value="2"/>
13775	</enum>
13776
13777	<enum
13778	name="DataFlags"
13779	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
13780	>
13781	<const name="None" value="0x00"/>
13782	<const name="Mandatory" value="0x01"/>
13783	<const name="Expert" value="0x02"/>
13784	<const name="Array" value="0x04"/>
13785	<const name="FlagMask" value="0x07"/>
13786	</enum>
13787
13788	<enum
13789	name="MediumFormatCapabilities"
13790	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
13791	>
13792	<desc>
13793	Medium format capability flags.
13794	</desc>
13795
13796	<const name="Uuid" value="0x01">
13797	<desc>
13798	Supports UUIDs as expected by VirtualBox code.
13799	</desc>
13800	</const>
13801
13802	<const name="CreateFixed" value="0x02">
13803	<desc>
13804	Supports creating fixed size images, allocating all space instantly.
13805	</desc>
13806	</const>
13807
13808	<const name="CreateDynamic" value="0x04">
13809	<desc>
13810	Supports creating dynamically growing images, allocating space on
13811	demand.
13812	</desc>
13813	</const>
13814
13815	<const name="CreateSplit2G" value="0x08">
13816	<desc>
13817	Supports creating images split in chunks of a bit less than 2 GBytes.
13818	</desc>
13819	</const>
13820
13821	<const name="Differencing" value="0x10">
13822	<desc>
13823	Supports being used as a format for differencing media (see <link
13824	to="IMedium::createDiffStorage"/>).
13825	</desc>
13826	</const>
13827
13828	<const name="Asynchronous" value="0x20">
13829	<desc>
13830	Supports asynchronous I/O operations for at least some configurations.
13831	</desc>
13832	</const>
13833
13834	<const name="File" value="0x40">
13835	<desc>
13836	The format backend operates on files (the <link to="IMedium::location"/>
13837	attribute of the medium specifies a file used to store medium
13838	data; for a list of supported file extensions see
13839	<link to="IMediumFormat::describeFileExtensions"/>).
13840	</desc>
13841	</const>
13842
13843	<const name="Properties" value="0x80">
13844	<desc>
13845	The format backend uses the property interface to configure the storage
13846	location and properties (the <link to="IMediumFormat::describeProperties"/>
13847	method is used to get access to properties supported by the given medium format).
13848	</desc>
13849	</const>
13850
13851	<const name="TcpNetworking" value="0x100">
13852	<desc>
13853	The format backend uses the TCP networking interface for network access.
13854	</desc>
13855	</const>
13856
13857	<const name="VFS" value="0x200">
13858	<desc>
13859	The format backend supports virtual filesystem functionality.
13860	</desc>
13861	</const>
13862
13863	<const name="CapabilityMask" value="0x3FF"/>
13864	</enum>
13865
13866	<interface
13867	name="IMediumFormat" extends="$unknown"
13868	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
13869	wsmap="managed"
13870	>
13871	<desc>
13872	The IMediumFormat interface represents a medium format.
13873
13874	Each medium format has an associated backend which is used to handle
13875	media stored in this format. This interface provides information
13876	about the properties of the associated backend.
13877
13878	Each medium format is identified by a string represented by the
13879	<link to="#id"/> attribute. This string is used in calls like
13880	<link to="IVirtualBox::createHardDisk"/> to specify the desired
13881	format.
13882
13883	The list of all supported medium formats can be obtained using
13884	<link to="ISystemProperties::mediumFormats"/>.
13885
13886	<see><link to="IMedium"/></see>
13887	</desc>
13888
13889	<attribute name="id" type="wstring" readonly="yes">
13890	<desc>
13891	Identifier of this format.
13892
13893	The format identifier is a non-@c null non-empty ASCII string. Note that
13894	this string is case-insensitive. This means that, for example, all of
13895	the following strings:
13896	<pre>
13897	"VDI"
13898	"vdi"
13899	"VdI"</pre>
13900	refer to the same medium format.
13901
13902	This string is used in methods of other interfaces where it is necessary
13903	to specify a medium format, such as
13904	<link to="IVirtualBox::createHardDisk"/>.
13905	</desc>
13906	</attribute>
13907
13908	<attribute name="name" type="wstring" readonly="yes">
13909	<desc>
13910	Human readable description of this format.
13911
13912	Mainly for use in file open dialogs.
13913	</desc>
13914	</attribute>
13915
13916	<attribute name="capabilities" type="unsigned long" readonly="yes">
13917	<desc>
13918	Capabilities of the format as a set of bit flags.
13919
13920	For the meaning of individual capability flags see
13921	<link to="MediumFormatCapabilities"/>.
13922	</desc>
13923	</attribute>
13924
13925	<method name="describeFileExtensions">
13926	<desc>
13927	Returns two arrays describing the supported file extensions.
13928
13929	The first array contains the supported extensions and the seconds one
13930	the type each extension supports. Both have the same size.
13931
13932	Note that some backends do not work on files, so this array may be
13933	empty.
13934
13935	<see><link to="IMediumFormat::capabilities"/></see>
13936	</desc>
13937	<param name="extensions" type="wstring" safearray="yes" dir="out">
13938	<desc>The array of supported extensions.</desc>
13939	</param>
13940	<param name="type" type="DeviceType" safearray="yes" dir="out">
13941	<desc>The array which indicates the device type for every given extension.</desc>
13942	</param>
13943	</method>
13944
13945	<method name="describeProperties" const="yes">
13946	<desc>
13947	Returns several arrays describing the properties supported by this
13948	format.
13949
13950	An element with the given index in each array describes one
13951	property. Thus, the number of elements in each returned array is the
13952	same and corresponds to the number of supported properties.
13953
13954	The returned arrays are filled in only if the
13955	<link to="MediumFormatCapabilities_Properties"/> flag is set.
13956	All arguments must be non-@c null.
13957
13958	<see><link to="DataType"/>, <link to="DataFlags"/></see>
13959	</desc>
13960
13961	<param name="names" type="wstring" safearray="yes" dir="out">
13962	<desc>Array of property names.</desc>
13963	</param>
13964	<param name="description" type="wstring" safearray="yes" dir="out">
13965	<desc>Array of property descriptions.</desc>
13966	</param>
13967	<param name="types" type="DataType" safearray="yes" dir="out">
13968	<desc>Array of property types.</desc>
13969	</param>
13970	<param name="flags" type="unsigned long" safearray="yes" dir="out">
13971	<desc>Array of property flags.</desc>
13972	</param>
13973	<param name="defaults" type="wstring" safearray="yes" dir="out">
13974	<desc>Array of default property values.</desc>
13975	</param>
13976	</method>
13977
13978	</interface>
13979
13980
13981	<!--
13982	// IKeyboard
13983	/////////////////////////////////////////////////////////////////////////
13984	-->
13985
13986	<interface
13987	name="IKeyboard" extends="$unknown"
13988	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
13989	wsmap="managed"
13990	>
13991	<desc>
13992	The IKeyboard interface represents the virtual machine's keyboard. Used
13993	in <link to="IConsole::keyboard"/>.
13994
13995	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
13996	to the virtual machine.
13997
13998	</desc>
13999	<method name="putScancode">
14000	<desc>Sends a scancode to the keyboard.
14001
14002	<result name="VBOX_E_IPRT_ERROR">
14003	Could not send scan code to virtual keyboard.
14004	</result>
14005
14006	</desc>
14007	<param name="scancode" type="long" dir="in"/>
14008	</method>
14009
14010	<method name="putScancodes">
14011	<desc>Sends an array of scancodes to the keyboard.
14012
14013	<result name="VBOX_E_IPRT_ERROR">
14014	Could not send all scan codes to virtual keyboard.
14015	</result>
14016
14017	</desc>
14018	<param name="scancodes" type="long" dir="in" safearray="yes"/>
14019	<param name="codesStored" type="unsigned long" dir="return"/>
14020	</method>
14021
14022	<method name="putCAD">
14023	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
14024	function is nothing special, it is just a convenience function
14025	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
14026
14027	<result name="VBOX_E_IPRT_ERROR">
14028	Could not send all scan codes to virtual keyboard.
14029	</result>
14030
14031	</desc>
14032	</method>
14033
14034	<attribute name="eventSource" type="IEventSource" readonly="yes">
14035	<desc>
14036	Event source for keyboard events.
14037	</desc>
14038	</attribute>
14039
14040	</interface>
14041
14042
14043	<!--
14044	// IMouse
14045	/////////////////////////////////////////////////////////////////////////
14046	-->
14047
14048	<enum
14049	name="MouseButtonState"
14050	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
14051	>
14052	<desc>
14053	Mouse button state.
14054	</desc>
14055
14056	<const name="LeftButton" value="0x01"/>
14057	<const name="RightButton" value="0x02"/>
14058	<const name="MiddleButton" value="0x04"/>
14059	<const name="WheelUp" value="0x08"/>
14060	<const name="WheelDown" value="0x10"/>
14061	<const name="XButton1" value="0x20"/>
14062	<const name="XButton2" value="0x40"/>
14063	<const name="MouseStateMask" value="0x7F"/>
14064	</enum>
14065
14066	<interface
14067	name="IMouse" extends="$unknown"
14068	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
14069	wsmap="managed"
14070	>
14071	<desc>
14072	The IMouse interface represents the virtual machine's mouse. Used in
14073	<link to="IConsole::mouse"/>.
14074
14075	Through this interface, the virtual machine's virtual mouse can be
14076	controlled.
14077	</desc>
14078
14079	<attribute name="absoluteSupported" type="boolean" readonly="yes">
14080	<desc>
14081	Whether the guest OS supports absolute mouse pointer positioning
14082	or not.
14083	<note>
14084	You can use the <link to="IMouseCapabilityChangedEvent"/>
14085	event to be instantly informed about changes of this attribute
14086	during virtual machine execution.
14087	</note>
14088	<see><link to="#putMouseEventAbsolute"/></see>
14089	</desc>
14090	</attribute>
14091
14092	<attribute name="relativeSupported" type="boolean" readonly="yes">
14093	<desc>
14094	Whether the guest OS supports relative mouse pointer positioning
14095	or not.
14096	<note>
14097	You can use the <link to="IMouseCapabilityChangedEvent"/>
14098	event to be instantly informed about changes of this attribute
14099	during virtual machine execution.
14100	</note>
14101	<see><link to="#putMouseEvent"/></see>
14102	</desc>
14103	</attribute>
14104
14105	<attribute name="needsHostCursor" type="boolean" readonly="yes">
14106	<desc>
14107	Whether the guest OS can currently switch to drawing it's own mouse
14108	cursor on demand.
14109	<note>
14110	You can use the <link to="IMouseCapabilityChangedEvent"/>
14111	event to be instantly informed about changes of this attribute
14112	during virtual machine execution.
14113	</note>
14114	<see><link to="#putMouseEvent"/></see>
14115	</desc>
14116	</attribute>
14117
14118	<method name="putMouseEvent">
14119	<desc>
14120	Initiates a mouse event using relative pointer movements
14121	along x and y axis.
14122
14123	<result name="E_ACCESSDENIED">
14124	Console not powered up.
14125	</result>
14126	<result name="VBOX_E_IPRT_ERROR">
14127	Could not send mouse event to virtual mouse.
14128	</result>
14129
14130	</desc>
14131
14132	<param name="dx" type="long" dir="in">
14133	<desc>
14134	Amount of pixels the mouse should move to the right.
14135	Negative values move the mouse to the left.
14136	</desc>
14137	</param>
14138	<param name="dy" type="long" dir="in">
14139	<desc>
14140	Amount of pixels the mouse should move downwards.
14141	Negative values move the mouse upwards.
14142	</desc>
14143	</param>
14144	<param name="dz" type="long" dir="in">
14145	<desc>
14146	Amount of mouse wheel moves.
14147	Positive values describe clockwise wheel rotations,
14148	negative values describe counterclockwise rotations.
14149	</desc>
14150	</param>
14151	<param name="dw" type="long" dir="in">
14152	<desc>
14153	Amount of horizontal mouse wheel moves.
14154	Positive values describe a movement to the left,
14155	negative values describe a movement to the right.
14156	</desc>
14157	</param>
14158	<param name="buttonState" type="long" dir="in">
14159	<desc>
14160	The current state of mouse buttons. Every bit represents
14161	a mouse button as follows:
14162	<table>
14163	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14164	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14165	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14166	</table>
14167	A value of <tt>1</tt> means the corresponding button is pressed.
14168	otherwise it is released.
14169	</desc>
14170	</param>
14171	</method>
14172
14173	<method name="putMouseEventAbsolute">
14174	<desc>
14175	Positions the mouse pointer using absolute x and y coordinates.
14176	These coordinates are expressed in pixels and
14177	start from <tt>[1,1]</tt> which corresponds to the top left
14178	corner of the virtual display.
14179
14180	<result name="E_ACCESSDENIED">
14181	Console not powered up.
14182	</result>
14183	<result name="VBOX_E_IPRT_ERROR">
14184	Could not send mouse event to virtual mouse.
14185	</result>
14186
14187	<note>
14188	This method will have effect only if absolute mouse
14189	positioning is supported by the guest OS.
14190	</note>
14191
14192	<see><link to="#absoluteSupported"/></see>
14193	</desc>
14194
14195	<param name="x" type="long" dir="in">
14196	<desc>
14197	X coordinate of the pointer in pixels, starting from @c 1.
14198	</desc>
14199	</param>
14200	<param name="y" type="long" dir="in">
14201	<desc>
14202	Y coordinate of the pointer in pixels, starting from @c 1.
14203	</desc>
14204	</param>
14205	<param name="dz" type="long" dir="in">
14206	<desc>
14207	Amount of mouse wheel moves.
14208	Positive values describe clockwise wheel rotations,
14209	negative values describe counterclockwise rotations.
14210	</desc>
14211	</param>
14212	<param name="dw" type="long" dir="in">
14213	<desc>
14214	Amount of horizontal mouse wheel moves.
14215	Positive values describe a movement to the left,
14216	negative values describe a movement to the right.
14217	</desc>
14218	</param>
14219	<param name="buttonState" type="long" dir="in">
14220	<desc>
14221	The current state of mouse buttons. Every bit represents
14222	a mouse button as follows:
14223	<table>
14224	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14225	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14226	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14227	</table>
14228	A value of @c 1 means the corresponding button is pressed.
14229	otherwise it is released.
14230	</desc>
14231	</param>
14232	</method>
14233
14234	<attribute name="eventSource" type="IEventSource" readonly="yes">
14235	<desc>
14236	Event source for mouse events.
14237	</desc>
14238	</attribute>
14239
14240	</interface>
14241
14242	<!--
14243	// IDisplay
14244	/////////////////////////////////////////////////////////////////////////
14245	-->
14246
14247	<enum
14248	name="FramebufferPixelFormat"
14249	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
14250	>
14251	<desc>
14252	Format of the video memory buffer. Constants represented by this enum can
14253	be used to test for particular values of <link
14254	to="IFramebuffer::pixelFormat"/>. See also <link
14255	to="IFramebuffer::requestResize"/>.
14256
14257	See also www.fourcc.org for more information about FOURCC pixel formats.
14258	</desc>
14259
14260	<const name="Opaque" value="0">
14261	<desc>
14262	Unknown buffer format (the user may not assume any particular format of
14263	the buffer).
14264	</desc>
14265	</const>
14266	<const name="FOURCC_RGB" value="0x32424752">
14267	<desc>
14268	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
14269	bit layout).
14270	</desc>
14271	</const>
14272	</enum>
14273
14274	<interface
14275	name="IFramebuffer" extends="$unknown"
14276	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
14277	wsmap="suppress"
14278	>
14279	<attribute name="address" type="octet" mod="ptr" readonly="yes">
14280	<desc>Address of the start byte of the frame buffer.</desc>
14281	</attribute>
14282
14283	<attribute name="width" type="unsigned long" readonly="yes">
14284	<desc>Frame buffer width, in pixels.</desc>
14285	</attribute>
14286
14287	<attribute name="height" type="unsigned long" readonly="yes">
14288	<desc>Frame buffer height, in pixels.</desc>
14289	</attribute>
14290
14291	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
14292	<desc>
14293	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
14294	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
14295	are: 8, 15, 16, 24 and 32.
14296	</desc>
14297	</attribute>
14298
14299	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
14300	<desc>
14301	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
14302	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
14303	size of the scan line must be aligned to 32 bits.
14304	</desc>
14305	</attribute>
14306
14307	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
14308	<desc>
14309	Frame buffer pixel format. It's either one of the values defined by <link
14310	to="FramebufferPixelFormat"/> or a raw FOURCC code.
14311	<note>
14312	This attribute must never return <link
14313	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
14314	<link to="#address"/> points to must be always known.
14315	</note>
14316	</desc>
14317	</attribute>
14318
14319	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
14320	<desc>
14321	Defines whether this frame buffer uses the virtual video card's memory
14322	buffer (guest VRAM) directly or not. See <link
14323	to="IFramebuffer::requestResize"/> for more information.
14324	</desc>
14325	</attribute>
14326
14327	<attribute name="heightReduction" type="unsigned long" readonly="yes">
14328	<desc>
14329	Hint from the frame buffer about how much of the standard
14330	screen height it wants to use for itself. This information is
14331	exposed to the guest through the VESA BIOS and VMMDev interface
14332	so that it can use it for determining its video mode table. It
14333	is not guaranteed that the guest respects the value.
14334	</desc>
14335	</attribute>
14336
14337	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
14338	<desc>
14339	An alpha-blended overlay which is superposed over the frame buffer.
14340	The initial purpose is to allow the display of icons providing
14341	information about the VM state, including disk activity, in front
14342	ends which do not have other means of doing that. The overlay is
14343	designed to controlled exclusively by IDisplay. It has no locking
14344	of its own, and any changes made to it are not guaranteed to be
14345	visible until the affected portion of IFramebuffer is updated. The
14346	overlay can be created lazily the first time it is requested. This
14347	attribute can also return @c null to signal that the overlay is not
14348	implemented.
14349	</desc>
14350	</attribute>
14351
14352	<attribute name="winId" type="long long" readonly="yes">
14353	<desc>
14354	Platform-dependent identifier of the window where context of this
14355	frame buffer is drawn, or zero if there's no such window.
14356	</desc>
14357	</attribute>
14358
14359	<method name="lock">
14360	<desc>
14361	Locks the frame buffer.
14362	Gets called by the IDisplay object where this frame buffer is
14363	bound to.
14364	</desc>
14365	</method>
14366
14367	<method name="unlock">
14368	<desc>
14369	Unlocks the frame buffer.
14370	Gets called by the IDisplay object where this frame buffer is
14371	bound to.
14372	</desc>
14373	</method>
14374
14375	<method name="notifyUpdate">
14376	<desc>
14377	Informs about an update.
14378	Gets called by the display object where this buffer is
14379	registered.
14380	</desc>
14381	<param name="x" type="unsigned long" dir="in"/>
14382	<param name="y" type="unsigned long" dir="in"/>
14383	<param name="width" type="unsigned long" dir="in"/>
14384	<param name="height" type="unsigned long" dir="in"/>
14385	</method>
14386
14387	<method name="requestResize">
14388	<desc>
14389	Requests a size and pixel format change.
14390
14391	There are two modes of working with the video buffer of the virtual
14392	machine. The <i>indirect</i> mode implies that the IFramebuffer
14393	implementation allocates a memory buffer for the requested display mode
14394	and provides it to the virtual machine. In <i>direct</i> mode, the
14395	IFramebuffer implementation uses the memory buffer allocated and owned
14396	by the virtual machine. This buffer represents the video memory of the
14397	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
14398	usually faster because the implementation gets a raw pointer to the
14399	guest VRAM buffer which it can directly use for visualizing the contents
14400	of the virtual display, as opposed to the indirect mode where the
14401	contents of guest VRAM are copied to the memory buffer provided by
14402	the implementation every time a display update occurs.
14403
14404	It is important to note that the direct mode is really fast only when
14405	the implementation uses the given guest VRAM buffer directly, for
14406	example, by blitting it to the window representing the virtual machine's
14407	display, which saves at least one copy operation comparing to the
14408	indirect mode. However, using the guest VRAM buffer directly is not
14409	always possible: the format and the color depth of this buffer may be
14410	not supported by the target window, or it may be unknown (opaque) as in
14411	case of text or non-linear multi-plane VGA video modes. In this case,
14412	the indirect mode (that is always available) should be used as a
14413	fallback: when the guest VRAM contents are copied to the
14414	implementation-provided memory buffer, color and format conversion is
14415	done automatically by the underlying code.
14416
14417	The @a pixelFormat parameter defines whether the direct mode is
14418	available or not. If @a pixelFormat is <link
14419	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
14420	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
14421	@a bytesPerLine parameters must be ignored and the implementation must use
14422	the indirect mode (where it provides its own buffer in one of the
14423	supported formats). In all other cases, @a pixelFormat together with
14424	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
14425	buffer pointed to by the @a VRAM parameter and the implementation is
14426	free to choose which mode to use. To indicate that this frame buffer uses
14427	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
14428	attribute must return @c true and <link to="#address"/> must
14429	return exactly the same address that is passed in the @a VRAM parameter
14430	of this method; otherwise it is assumed that the indirect strategy is
14431	chosen.
14432
14433	The @a width and @a height parameters represent the size of the
14434	requested display mode in both modes. In case of indirect mode, the
14435	provided memory buffer should be big enough to store data of the given
14436	display mode. In case of direct mode, it is guaranteed that the given
14437	@a VRAM buffer contains enough space to represent the display mode of the
14438	given size. Note that this frame buffer's <link to="#width"/> and <link
14439	to="#height"/> attributes must return exactly the same values as
14440	passed to this method after the resize is completed (see below).
14441
14442	The @a finished output parameter determines if the implementation has
14443	finished resizing the frame buffer or not. If, for some reason, the
14444	resize cannot be finished immediately during this call, @a finished
14445	must be set to @c false, and the implementation must call
14446	<link to="IDisplay::resizeCompleted"/> after it has returned from
14447	this method as soon as possible. If @a finished is @c false, the
14448	machine will not call any frame buffer methods until
14449	<link to="IDisplay::resizeCompleted"/> is called.
14450
14451	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
14452	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
14453	this frame buffer must return exactly the same values as specified in the
14454	parameters of this method, after the resize is completed. If the
14455	indirect mode is chosen, these attributes must return values describing
14456	the format of the implementation's own memory buffer <link
14457	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
14458	value must always correlate with <link to="#pixelFormat"/>. Note that
14459	the <link to="#pixelFormat"/> attribute must never return <link
14460	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
14461
14462	<note>
14463	This method is called by the IDisplay object under the
14464	<link to="#lock"/> provided by this IFramebuffer
14465	implementation. If this method returns @c false in @a finished, then
14466	this lock is not released until
14467	<link to="IDisplay::resizeCompleted"/> is called.
14468	</note>
14469	</desc>
14470	<param name="screenId" type="unsigned long" dir="in">
14471	<desc>
14472	Logical screen number. Must be used in the corresponding call to
14473	<link to="IDisplay::resizeCompleted"/> if this call is made.
14474	</desc>
14475	</param>
14476	<param name="pixelFormat" type="unsigned long" dir="in">
14477	<desc>
14478	Pixel format of the memory buffer pointed to by @a VRAM.
14479	See also <link to="FramebufferPixelFormat"/>.
14480	</desc>
14481	</param>
14482	<param name="VRAM" type="octet" mod="ptr" dir="in">
14483	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
14484	</param>
14485	<param name="bitsPerPixel" type="unsigned long" dir="in">
14486	<desc>Color depth, bits per pixel.</desc>
14487	</param>
14488	<param name="bytesPerLine" type="unsigned long" dir="in">
14489	<desc>Size of one scan line, in bytes.</desc>
14490	</param>
14491	<param name="width" type="unsigned long" dir="in">
14492	<desc>Width of the guest display, in pixels.</desc>
14493	</param>
14494	<param name="height" type="unsigned long" dir="in">
14495	<desc>Height of the guest display, in pixels.</desc>
14496	</param>
14497	<param name="finished" type="boolean" dir="return">
14498	<desc>
14499	Can the VM start using the new frame buffer immediately
14500	after this method returns or it should wait for
14501	<link to="IDisplay::resizeCompleted"/>.
14502	</desc>
14503	</param>
14504	</method>
14505
14506	<method name="videoModeSupported">
14507	<desc>
14508	Returns whether the frame buffer implementation is willing to
14509	support a given video mode. In case it is not able to render
14510	the video mode (or for some reason not willing), it should
14511	return @c false. Usually this method is called when the guest
14512	asks the VMM device whether a given video mode is supported
14513	so the information returned is directly exposed to the guest.
14514	It is important that this method returns very quickly.
14515	</desc>
14516	<param name="width" type="unsigned long" dir="in"/>
14517	<param name="height" type="unsigned long" dir="in"/>
14518	<param name="bpp" type="unsigned long" dir="in"/>
14519	<param name="supported" type="boolean" dir="return"/>
14520	</method>
14521
14522	<method name="getVisibleRegion">
14523	<desc>
14524	Returns the visible region of this frame buffer.
14525
14526	If the @a rectangles parameter is @c null then the value of the
14527	@a count parameter is ignored and the number of elements necessary to
14528	describe the current visible region is returned in @a countCopied.
14529
14530	If @a rectangles is not @c null but @a count is less
14531	than the required number of elements to store region data, the method
14532	will report a failure. If @a count is equal or greater than the
14533	required number of elements, then the actual number of elements copied
14534	to the provided array will be returned in @a countCopied.
14535
14536	<note>
14537	The address of the provided array must be in the process space of
14538	this IFramebuffer object.
14539	</note>
14540	<note>
14541	Method not yet implemented.
14542	</note>
14543	</desc>
14544	<param name="rectangles" type="octet" mod="ptr" dir="in">
14545	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
14546	</param>
14547	<param name="count" type="unsigned long" dir="in">
14548	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14549	</param>
14550	<param name="countCopied" type="unsigned long" dir="return">
14551	<desc>Number of elements copied to the @a rectangles array.</desc>
14552	</param>
14553	</method>
14554
14555	<method name="setVisibleRegion">
14556	<desc>
14557	Suggests a new visible region to this frame buffer. This region
14558	represents the area of the VM display which is a union of regions of
14559	all top-level windows of the guest operating system running inside the
14560	VM (if the Guest Additions for this system support this
14561	functionality). This information may be used by the frontends to
14562	implement the seamless desktop integration feature.
14563
14564	<note>
14565	The address of the provided array must be in the process space of
14566	this IFramebuffer object.
14567	</note>
14568	<note>
14569	The IFramebuffer implementation must make a copy of the provided
14570	array of rectangles.
14571	</note>
14572	<note>
14573	Method not yet implemented.
14574	</note>
14575	</desc>
14576	<param name="rectangles" type="octet" mod="ptr" dir="in">
14577	<desc>Pointer to the @c RTRECT array.</desc>
14578	</param>
14579	<param name="count" type="unsigned long" dir="in">
14580	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14581	</param>
14582	</method>
14583
14584	<method name="processVHWACommand">
14585	<desc>
14586	Posts a Video HW Acceleration Command to the frame buffer for processing.
14587	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
14588	are posted from quest to the host to be processed by the host hardware.
14589
14590	<note>
14591	The address of the provided command must be in the process space of
14592	this IFramebuffer object.
14593	</note>
14594	</desc>
14595
14596	<param name="command" type="octet" mod="ptr" dir="in">
14597	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
14598	</param>
14599	</method>
14600
14601	</interface>
14602
14603	<interface
14604	name="IFramebufferOverlay" extends="IFramebuffer"
14605	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
14606	wsmap="suppress"
14607	>
14608	<desc>
14609	The IFramebufferOverlay interface represents an alpha blended overlay
14610	for displaying status icons above an IFramebuffer. It is always created
14611	not visible, so that it must be explicitly shown. It only covers a
14612	portion of the IFramebuffer, determined by its width, height and
14613	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
14614	that order) format, and may be written to directly. Do re-read the
14615	width though, after setting it, as it may be adjusted (increased) to
14616	make it more suitable for the front end.
14617	</desc>
14618	<attribute name="x" type="unsigned long" readonly="yes">
14619	<desc>X position of the overlay, relative to the frame buffer.</desc>
14620	</attribute>
14621
14622	<attribute name="y" type="unsigned long" readonly="yes">
14623	<desc>Y position of the overlay, relative to the frame buffer.</desc>
14624	</attribute>
14625
14626	<attribute name="visible" type="boolean" readonly="no">
14627	<desc>
14628	Whether the overlay is currently visible.
14629	</desc>
14630	</attribute>
14631
14632	<attribute name="alpha" type="unsigned long" readonly="no">
14633	<desc>
14634	The global alpha value for the overlay. This may or may not be
14635	supported by a given front end.
14636	</desc>
14637	</attribute>
14638
14639	<method name="move">
14640	<desc>
14641	Changes the overlay's position relative to the IFramebuffer.
14642	</desc>
14643	<param name="x" type="unsigned long" dir="in"/>
14644	<param name="y" type="unsigned long" dir="in"/>
14645	</method>
14646
14647	</interface>
14648
14649	<interface
14650	name="IDisplay" extends="$unknown"
14651	uuid="b83ee395-8679-40ca-8d60-1a0cbe724930"
14652	wsmap="managed"
14653	>
14654	<desc>
14655	The IDisplay interface represents the virtual machine's display.
14656
14657	The object implementing this interface is contained in each
14658	<link to="IConsole::display"/> attribute and represents the visual
14659	output of the virtual machine.
14660
14661	The virtual display supports pluggable output targets represented by the
14662	IFramebuffer interface. Examples of the output target are a window on
14663	the host computer or an RDP session's display on a remote computer.
14664	</desc>
14665	<method name="getScreenResolution">
14666	<desc>Queries display width, height and color depth for given screen.</desc>
14667	<param name="screenId" type="unsigned long" dir="in"/>
14668	<param name="width" type="unsigned long" dir="out"/>
14669	<param name="height" type="unsigned long" dir="out"/>
14670	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
14671	</method>
14672
14673	<method name="setFramebuffer">
14674	<desc>
14675	Sets the framebuffer for given screen.
14676	</desc>
14677	<param name="screenId" type="unsigned long" dir="in"/>
14678	<param name="framebuffer" type="IFramebuffer" dir="in"/>
14679	</method>
14680
14681	<method name="getFramebuffer">
14682	<desc>
14683	Queries the framebuffer for given screen.
14684	</desc>
14685	<param name="screenId" type="unsigned long" dir="in"/>
14686	<param name="framebuffer" type="IFramebuffer" dir="out"/>
14687	<param name="xOrigin" type="long" dir="out"/>
14688	<param name="yOrigin" type="long" dir="out"/>
14689	</method>
14690
14691	<method name="setVideoModeHint">
14692	<desc>
14693	Asks VirtualBox to request the given video mode from
14694	the guest. This is just a hint and it cannot be guaranteed
14695	that the requested resolution will be used. Guest Additions
14696	are required for the request to be seen by guests. The caller
14697	should issue the request and wait for a resolution change and
14698	after a timeout retry.
14699
14700	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
14701	parameters means that the corresponding values should be taken from the
14702	current video mode (i.e. left unchanged).
14703
14704	If the guest OS supports multi-monitor configuration then the @a display
14705	parameter specifies the number of the guest display to send the hint to:
14706	@c 0 is the primary display, @c 1 is the first secondary and
14707	so on. If the multi-monitor configuration is not supported, @a display
14708	must be @c 0.
14709
14710	<result name="E_INVALIDARG">
14711	The @a display is not associated with any monitor.
14712	</result>
14713
14714	</desc>
14715	<param name="display" type="unsigned long" dir="in">
14716	<desc>
14717	The number of the guest display to send the hint to.
14718	</desc>
14719	</param>
14720	<param name="enabled" type="boolean" dir="in">
14721	<desc>
14722	@c True, if this guest screen is enabled,
14723	@c False otherwise.
14724	</desc>
14725	</param>
14726	<param name="changeOrigin" type="boolean" dir="in">
14727	<desc>
14728	@c True, if the origin of the guest screen should be changed,
14729	@c False otherwise.
14730	</desc>
14731	</param>
14732	<param name="originX" type="long" dir="in">
14733	<desc>
14734	The X origin of the guest screen.
14735	</desc>
14736	</param>
14737	<param name="originY" type="long" dir="in">
14738	<desc>
14739	The Y origin of the guest screen.
14740	</desc>
14741	</param>
14742	<param name="width" type="unsigned long" dir="in"/>
14743	<param name="height" type="unsigned long" dir="in"/>
14744	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
14745	</method>
14746
14747	<method name="setSeamlessMode">
14748	<desc>
14749	Enables or disables seamless guest display rendering (seamless desktop
14750	integration) mode.
14751	<note>
14752	Calling this method has no effect if <link
14753	to="IGuest::getFacilityStatus"/> with facility @c Seamless
14754	does not return @c Active.
14755	</note>
14756	</desc>
14757	<param name="enabled" type="boolean" dir="in"/>
14758	</method>
14759
14760	<method name="takeScreenShot">
14761	<desc>
14762	Takes a screen shot of the requested size and copies it to the
14763	32-bpp buffer allocated by the caller and pointed to by @a address.
14764	A pixel consists of 4 bytes in order: B, G, R, 0.
14765
14766	<note>This API can be used only locally by a VM process through the
14767	COM/XPCOM C++ API as it requires pointer support. It is not
14768	available for scripting langages, Java or any webservice clients.
14769	Unless you are writing a new VM frontend use
14770	<link to="#takeScreenShotToArray" />.
14771	</note>
14772
14773	<result name="E_NOTIMPL">
14774	Feature not implemented.
14775	</result>
14776	<result name="VBOX_E_IPRT_ERROR">
14777	Could not take a screenshot.
14778	</result>
14779
14780	</desc>
14781	<param name="screenId" type="unsigned long" dir="in"/>
14782	<param name="address" type="octet" mod="ptr" dir="in"/>
14783	<param name="width" type="unsigned long" dir="in"/>
14784	<param name="height" type="unsigned long" dir="in"/>
14785	</method>
14786
14787	<method name="takeScreenShotToArray">
14788	<desc>
14789	Takes a guest screen shot of the requested size and returns it as
14790	an array of bytes in uncompressed 32-bit RGBA format.
14791	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
14792
14793	This API is slow, but could be the only option to get guest screenshot
14794	for scriptable languages not allowed to manipulate with addresses
14795	directly.
14796
14797	<result name="E_NOTIMPL">
14798	Feature not implemented.
14799	</result>
14800	<result name="VBOX_E_IPRT_ERROR">
14801	Could not take a screenshot.
14802	</result>
14803	</desc>
14804	<param name="screenId" type="unsigned long" dir="in">
14805	<desc>
14806	Monitor to take screenshot from.
14807	</desc>
14808	</param>
14809	<param name="width" type="unsigned long" dir="in">
14810	<desc>
14811	Desired image width.
14812	</desc>
14813	</param>
14814	<param name="height" type="unsigned long" dir="in">
14815	<desc>
14816	Desired image height.
14817	</desc>
14818	</param>
14819	<param name="screenData" type="octet" dir="return" safearray="yes">
14820	<desc>
14821	Array with resulting screen data.
14822	</desc>
14823	</param>
14824	</method>
14825
14826	<method name="takeScreenShotPNGToArray">
14827	<desc>
14828	Takes a guest screen shot of the requested size and returns it as
14829	PNG image in array.
14830
14831	<result name="E_NOTIMPL">
14832	Feature not implemented.
14833	</result>
14834	<result name="VBOX_E_IPRT_ERROR">
14835	Could not take a screenshot.
14836	</result>
14837	</desc>
14838	<param name="screenId" type="unsigned long" dir="in">
14839	<desc>
14840	Monitor to take the screenshot from.
14841	</desc>
14842	</param>
14843	<param name="width" type="unsigned long" dir="in">
14844	<desc>
14845	Desired image width.
14846	</desc>
14847	</param>
14848	<param name="height" type="unsigned long" dir="in">
14849	<desc>
14850	Desired image height.
14851	</desc>
14852	</param>
14853	<param name="screenData" type="octet" dir="return" safearray="yes">
14854	<desc>
14855	Array with resulting screen data.
14856	</desc>
14857	</param>
14858	</method>
14859
14860	<method name="drawToScreen">
14861	<desc>
14862	Draws a 32-bpp image of the specified size from the given buffer
14863	to the given point on the VM display.
14864
14865	<result name="E_NOTIMPL">
14866	Feature not implemented.
14867	</result>
14868	<result name="VBOX_E_IPRT_ERROR">
14869	Could not draw to screen.
14870	</result>
14871
14872	</desc>
14873	<param name="screenId" type="unsigned long" dir="in">
14874	<desc>
14875	Monitor to take the screenshot from.
14876	</desc>
14877	</param>
14878	<param name="address" type="octet" mod="ptr" dir="in">
14879	<desc>
14880	Address to store the screenshot to
14881	</desc>
14882	</param>
14883	<param name="x" type="unsigned long" dir="in">
14884	<desc>
14885	Relative to the screen top left corner.
14886	</desc>
14887	</param>
14888	<param name="y" type="unsigned long" dir="in">
14889	<desc>
14890	Relative to the screen top left corner.
14891	</desc>
14892	</param>
14893	<param name="width" type="unsigned long" dir="in">
14894	<desc>
14895	Desired image width.
14896	</desc>
14897	</param>
14898	<param name="height" type="unsigned long" dir="in">
14899	<desc>
14900	Desired image height.
14901	</desc>
14902	</param>
14903	</method>
14904
14905	<method name="invalidateAndUpdate">
14906	<desc>
14907	Does a full invalidation of the VM display and instructs the VM
14908	to update it.
14909
14910	<result name="VBOX_E_IPRT_ERROR">
14911	Could not invalidate and update screen.
14912	</result>
14913
14914	</desc>
14915	</method>
14916
14917	<method name="resizeCompleted">
14918	<desc>
14919	Signals that a framebuffer has completed the resize operation.
14920
14921	<result name="VBOX_E_NOT_SUPPORTED">
14922	Operation only valid for external frame buffers.
14923	</result>
14924
14925	</desc>
14926	<param name="screenId" type="unsigned long" dir="in"/>
14927	</method>
14928
14929	<method name="completeVHWACommand">
14930	<desc>
14931	Signals that the Video HW Acceleration command has completed.
14932	</desc>
14933
14934	<param name="command" type="octet" mod="ptr" dir="in">
14935	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
14936	</param>
14937	</method>
14938
14939	<method name="viewportChanged">
14940	<desc>
14941	Signals that framebuffer window viewport has changed.
14942
14943	<result name="E_INVALIDARG">
14944	The specified viewport data is invalid.
14945	</result>
14946
14947	</desc>
14948
14949	<param name="screenId" type="unsigned long" dir="in">
14950	<desc>
14951	Monitor to take the screenshot from.
14952	</desc>
14953	</param>
14954	<param name="x" type="unsigned long" dir="in">
14955	<desc>
14956	Framebuffer x offset.
14957	</desc>
14958	</param>
14959	<param name="y" type="unsigned long" dir="in">
14960	<desc>
14961	Framebuffer y offset.
14962	</desc>
14963	</param>
14964	<param name="width" type="unsigned long" dir="in">
14965	<desc>
14966	Viewport width.
14967	</desc>
14968	</param>
14969	<param name="height" type="unsigned long" dir="in">
14970	<desc>
14971	Viewport height.
14972	</desc>
14973	</param>
14974	</method>
14975	</interface>
14976
14977	<!--
14978	// INetworkAdapter
14979	/////////////////////////////////////////////////////////////////////////
14980	-->
14981
14982	<enum
14983	name="NetworkAttachmentType"
14984	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
14985	>
14986	<desc>
14987	Network attachment type.
14988	</desc>
14989
14990	<const name="Null" value="0">
14991	<desc>Null value, also means "not attached".</desc>
14992	</const>
14993	<const name="NAT" value="1"/>
14994	<const name="Bridged" value="2"/>
14995	<const name="Internal" value="3"/>
14996	<const name="HostOnly" value="4"/>
14997	<const name="Generic" value="5"/>
14998	</enum>
14999
15000	<enum
15001	name="NetworkAdapterType"
15002	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
15003	>
15004	<desc>
15005	Network adapter type.
15006	</desc>
15007
15008	<const name="Null" value="0">
15009	<desc>Null value (never used by the API).</desc>
15010	</const>
15011	<const name="Am79C970A" value="1">
15012	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
15013	</const>
15014	<const name="Am79C973" value="2">
15015	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
15016	</const>
15017	<const name="I82540EM" value="3">
15018	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
15019	</const>
15020	<const name="I82543GC" value="4">
15021	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
15022	</const>
15023	<const name="I82545EM" value="5">
15024	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
15025	</const>
15026	<const name="Virtio" value="6">
15027	<desc>Virtio network device.</desc>
15028	</const>
15029	</enum>
15030
15031	<enum
15032	name="NetworkAdapterPromiscModePolicy"
15033	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
15034	>
15035	<desc>
15036	The promiscuous mode policy of an interface.
15037	</desc>
15038
15039	<const name="Deny" value="1">
15040	<desc>Deny promiscuous mode requests.</desc>
15041	</const>
15042	<const name="AllowNetwork" value="2">
15043	<desc>
15044	Allow promicuous mode, but restrict the scope it to the internal
15045	network so that it only applies to other VMs.
15046	</desc>
15047	</const>
15048	<const name="AllowAll" value="3">
15049	<desc>
15050	Allow promicuous mode, include unrelated traffic going over the wire
15051	and internally on the host.
15052	</desc>
15053	</const>
15054	</enum>
15055
15056	<interface
15057	name="INetworkAdapter" extends="$unknown"
15058	uuid="efa0f965-63c7-4c60-afdf-b1cc9943b9c0"
15059	wsmap="managed"
15060	>
15061	<desc>
15062	Represents a virtual network adapter that is attached to a virtual machine.
15063	Each virtual machine has a fixed number of network adapter slots with one
15064	instance of this attached to each of them. Call
15065	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
15066	is attached to a given slot in a given machine.
15067
15068	Each network adapter can be in one of five attachment modes, which are
15069	represented by the <link to="NetworkAttachmentType" /> enumeration;
15070	see the <link to="#attachmentType" /> attribute.
15071	</desc>
15072
15073	<attribute name="adapterType" type="NetworkAdapterType">
15074	<desc>
15075	Type of the virtual network adapter. Depending on this value,
15076	VirtualBox will provide a different virtual network hardware
15077	to the guest.
15078	</desc>
15079	</attribute>
15080
15081	<attribute name="slot" type="unsigned long" readonly="yes">
15082	<desc>
15083	Slot number this adapter is plugged into. Corresponds to
15084	the value you pass to <link to="IMachine::getNetworkAdapter"/>
15085	to obtain this instance.
15086	</desc>
15087	</attribute>
15088
15089	<attribute name="enabled" type="boolean">
15090	<desc>
15091	Flag whether the network adapter is present in the
15092	guest system. If disabled, the virtual guest hardware will
15093	not contain this network adapter. Can only be changed when
15094	the VM is not running.
15095	</desc>
15096	</attribute>
15097
15098	<attribute name="MACAddress" type="wstring">
15099	<desc>
15100	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
15101	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
15102	</desc>
15103	</attribute>
15104
15105	<attribute name="attachmentType" type="NetworkAttachmentType">
15106	<desc>
15107	Sets/Gets network attachment type of this network adapter.
15108	</desc>
15109	</attribute>
15110
15111	<attribute name="bridgedInterface" type="wstring">
15112	<desc>
15113	Name of the network interface the VM should be bridged to.
15114	</desc>
15115	</attribute>
15116
15117	<attribute name="hostOnlyInterface" type="wstring">
15118	<desc>
15119	Name of the host only network interface the VM is attached to.
15120	</desc>
15121	</attribute>
15122
15123	<attribute name="internalNetwork" type="wstring">
15124	<desc>
15125	Name of the internal network the VM is attached to.
15126	</desc>
15127	</attribute>
15128
15129	<attribute name="NATNetwork" type="wstring">
15130	<desc>
15131	Name of the NAT network the VM is attached to.
15132	</desc>
15133	</attribute>
15134
15135	<attribute name="genericDriver" type="wstring">
15136	<desc>
15137	Name of the driver to use for the "Generic" network attachment type.
15138	</desc>
15139	</attribute>
15140
15141	<attribute name="cableConnected" type="boolean">
15142	<desc>
15143	Flag whether the adapter reports the cable as connected or not.
15144	It can be used to report offline situations to a VM.
15145	</desc>
15146	</attribute>
15147
15148	<attribute name="lineSpeed" type="unsigned long">
15149	<desc>
15150	Line speed reported by custom drivers, in units of 1 kbps.
15151	</desc>
15152	</attribute>
15153
15154	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
15155	<desc>
15156	The promiscuous mode policy of the network adapter when attached to an
15157	internal network, host only network or a bridge.
15158	</desc>
15159	</attribute>
15160
15161	<attribute name="traceEnabled" type="boolean">
15162	<desc>
15163	Flag whether network traffic from/to the network card should be traced.
15164	Can only be toggled when the VM is turned off.
15165	</desc>
15166	</attribute>
15167
15168	<attribute name="traceFile" type="wstring">
15169	<desc>
15170	Filename where a network trace will be stored. If not set, VBox-pid.pcap
15171	will be used.
15172	</desc>
15173	</attribute>
15174
15175	<attribute name="NATEngine" type="INATEngine" readonly="yes">
15176	<desc>
15177	Points to the NAT engine which handles the network address translation
15178	for this interface. This is active only when the interface actually uses
15179	NAT.
15180	</desc>
15181	</attribute>
15182
15183	<attribute name="bootPriority" type="unsigned long">
15184	<desc>
15185	Network boot priority of the adapter. Priority 1 is highest. If not set,
15186	the priority is considered to be at the lowest possible setting.
15187	</desc>
15188	</attribute>
15189
15190	<attribute name="bandwidthGroup" type="IBandwidthGroup">
15191	<desc>The bandwidth group this network adapter is assigned to.</desc>
15192	</attribute>
15193
15194	<!-- property methods -->
15195
15196	<method name="getProperty" const="yes">
15197	<desc>
15198	Returns the value of the network attachment property with the given name.
15199
15200	If the requested data @a key does not exist, this function will
15201	succeed and return an empty string in the @a value argument.
15202
15203	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
15204	</desc>
15205	<param name="key" type="wstring" dir="in">
15206	<desc>Name of the property to get.</desc>
15207	</param>
15208	<param name="value" type="wstring" dir="return">
15209	<desc>Current property value.</desc>
15210	</param>
15211	</method>
15212
15213	<method name="setProperty">
15214	<desc>
15215	Sets the value of the network attachment property with the given name.
15216
15217	Setting the property value to @c null or an empty string is equivalent
15218	to deleting the existing value.
15219
15220	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
15221	</desc>
15222	<param name="key" type="wstring" dir="in">
15223	<desc>Name of the property to set.</desc>
15224	</param>
15225	<param name="value" type="wstring" dir="in">
15226	<desc>Property value to set.</desc>
15227	</param>
15228	</method>
15229
15230	<method name="getProperties" const="yes">
15231	<desc>
15232	Returns values for a group of properties in one call.
15233
15234	The names of the properties to get are specified using the @a names
15235	argument which is a list of comma-separated property names or
15236	an empty string if all properties are to be returned.
15237	<note>Currently the value of this argument is ignored and the method
15238	always returns all existing properties.</note>
15239
15240	The method returns two arrays, the array of property names corresponding
15241	to the @a names argument and the current values of these properties.
15242	Both arrays have the same number of elements with each element at the
15243	given index in the first array corresponds to an element at the same
15244	index in the second array.
15245	</desc>
15246	<param name="names" type="wstring" dir="in">
15247	<desc>
15248	Names of properties to get.
15249	</desc>
15250	</param>
15251	<param name="returnNames" type="wstring" safearray="yes" dir="out">
15252	<desc>Names of returned properties.</desc>
15253	</param>
15254	<param name="returnValues" type="wstring" safearray="yes" dir="return">
15255	<desc>Values of returned properties.</desc>
15256	</param>
15257	</method>
15258
15259	</interface>
15260
15261
15262	<!--
15263	// ISerialPort
15264	/////////////////////////////////////////////////////////////////////////
15265	-->
15266
15267	<enum
15268	name="PortMode"
15269	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
15270	>
15271	<desc>
15272	The PortMode enumeration represents possible communication modes for
15273	the virtual serial port device.
15274	</desc>
15275
15276	<const name="Disconnected" value="0">
15277	<desc>Virtual device is not attached to any real host device.</desc>
15278	</const>
15279	<const name="HostPipe" value="1">
15280	<desc>Virtual device is attached to a host pipe.</desc>
15281	</const>
15282	<const name="HostDevice" value="2">
15283	<desc>Virtual device is attached to a host device.</desc>
15284	</const>
15285	<const name="RawFile" value="3">
15286	<desc>Virtual device is attached to a raw file.</desc>
15287	</const>
15288	</enum>
15289
15290	<interface
15291	name="ISerialPort" extends="$unknown"
15292	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
15293	wsmap="managed"
15294	>
15295
15296	<desc>
15297	The ISerialPort interface represents the virtual serial port device.
15298
15299	The virtual serial port device acts like an ordinary serial port
15300	inside the virtual machine. This device communicates to the real
15301	serial port hardware in one of two modes: host pipe or host device.
15302
15303	In host pipe mode, the #path attribute specifies the path to the pipe on
15304	the host computer that represents a serial port. The #server attribute
15305	determines if this pipe is created by the virtual machine process at
15306	machine startup or it must already exist before starting machine
15307	execution.
15308
15309	In host device mode, the #path attribute specifies the name of the
15310	serial port device on the host computer.
15311
15312	There is also a third communication mode: the disconnected mode. In this
15313	mode, the guest OS running inside the virtual machine will be able to
15314	detect the serial port, but all port write operations will be discarded
15315	and all port read operations will return no data.
15316
15317	<see><link to="IMachine::getSerialPort"/></see>
15318	</desc>
15319
15320	<attribute name="slot" type="unsigned long" readonly="yes">
15321	<desc>
15322	Slot number this serial port is plugged into. Corresponds to
15323	the value you pass to <link to="IMachine::getSerialPort"/>
15324	to obtain this instance.
15325	</desc>
15326	</attribute>
15327
15328	<attribute name="enabled" type="boolean">
15329	<desc>
15330	Flag whether the serial port is enabled. If disabled,
15331	the serial port will not be reported to the guest OS.
15332	</desc>
15333	</attribute>
15334
15335	<attribute name="IOBase" type="unsigned long">
15336	<desc>Base I/O address of the serial port.</desc>
15337	</attribute>
15338
15339	<attribute name="IRQ" type="unsigned long">
15340	<desc>IRQ number of the serial port.</desc>
15341	</attribute>
15342
15343	<attribute name="hostMode" type="PortMode">
15344	<desc>
15345	How is this port connected to the host.
15346	<note>
15347	Changing this attribute may fail if the conditions for
15348	<link to="#path"/> are not met.
15349	</note>
15350	</desc>
15351	</attribute>
15352
15353	<attribute name="server" type="boolean">
15354	<desc>
15355	Flag whether this serial port acts as a server (creates a new pipe on
15356	the host) or as a client (uses the existing pipe). This attribute is
15357	used only when <link to="#hostMode"/> is PortMode_HostPipe.
15358	</desc>
15359	</attribute>
15360
15361	<attribute name="path" type="wstring">
15362	<desc>
15363	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
15364	PortMode_HostPipe, or the host serial device name when
15365	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
15366	cases, setting a @c null or empty string as the attribute's value
15367	is an error. Otherwise, the value of this property is ignored.
15368	</desc>
15369	</attribute>
15370
15371	</interface>
15372
15373	<!--
15374	// IParallelPort
15375	/////////////////////////////////////////////////////////////////////////
15376	-->
15377
15378	<interface
15379	name="IParallelPort" extends="$unknown"
15380	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
15381	wsmap="managed"
15382	>
15383
15384	<desc>
15385	The IParallelPort interface represents the virtual parallel port device.
15386
15387	The virtual parallel port device acts like an ordinary parallel port
15388	inside the virtual machine. This device communicates to the real
15389	parallel port hardware using the name of the parallel device on the host
15390	computer specified in the #path attribute.
15391
15392	Each virtual parallel port device is assigned a base I/O address and an
15393	IRQ number that will be reported to the guest operating system and used
15394	to operate the given parallel port from within the virtual machine.
15395
15396	<see><link to="IMachine::getParallelPort"/></see>
15397	</desc>
15398
15399	<attribute name="slot" type="unsigned long" readonly="yes">
15400	<desc>
15401	Slot number this parallel port is plugged into. Corresponds to
15402	the value you pass to <link to="IMachine::getParallelPort"/>
15403	to obtain this instance.
15404	</desc>
15405	</attribute>
15406
15407	<attribute name="enabled" type="boolean">
15408	<desc>
15409	Flag whether the parallel port is enabled. If disabled,
15410	the parallel port will not be reported to the guest OS.
15411	</desc>
15412	</attribute>
15413
15414	<attribute name="IOBase" type="unsigned long">
15415	<desc>Base I/O address of the parallel port.</desc>
15416	</attribute>
15417
15418	<attribute name="IRQ" type="unsigned long">
15419	<desc>IRQ number of the parallel port.</desc>
15420	</attribute>
15421
15422	<attribute name="path" type="wstring">
15423	<desc>
15424	Host parallel device name. If this parallel port is enabled, setting a
15425	@c null or an empty string as this attribute's value will result in
15426	an error.
15427	</desc>
15428	</attribute>
15429
15430	</interface>
15431
15432
15433	<!--
15434	// IMachineDebugger
15435	/////////////////////////////////////////////////////////////////////////
15436	-->
15437
15438	<interface
15439	name="IMachineDebugger" extends="$unknown"
15440	uuid="a9abbb7c-d678-43b2-bed2-19ec0e32303d"
15441	wsmap="suppress"
15442	>
15443	<method name="dumpGuestCore">
15444	<desc>
15445	Takes a core dump of the guest.
15446
15447	See include/VBox/dbgfcorefmt.h for details on the file format.
15448	</desc>
15449	<param name="filename" type="wstring" dir="in">
15450	<desc>
15451	The name of the output file. The file must not exist.
15452	</desc>
15453	</param>
15454	<param name="compression" type="wstring" dir="in">
15455	<desc>
15456	Reserved for future compression method indicator.
15457	</desc>
15458	</param>
15459	</method>
15460
15461	<method name="dumpHostProcessCore">
15462	<desc>
15463	Takes a core dump of the VM process on the host.
15464
15465	This feature is not implemented in the 4.0.0 release but it may show up
15466	in a dot release.
15467	</desc>
15468	<param name="filename" type="wstring" dir="in">
15469	<desc>
15470	The name of the output file. The file must not exist.
15471	</desc>
15472	</param>
15473	<param name="compression" type="wstring" dir="in">
15474	<desc>
15475	Reserved for future compression method indicator.
15476	</desc>
15477	</param>
15478	</method>
15479
15480	<method name="info">
15481	<desc>
15482	Interfaces with the info dumpers (DBGFInfo).
15483
15484	This feature is not implemented in the 4.0.0 release but it may show up
15485	in a dot release.
15486	</desc>
15487	<param name="name" type="wstring" dir="in">
15488	<desc>
15489	The name of the info item.
15490	</desc>
15491	</param>
15492	<param name="args" type="wstring" dir="in">
15493	<desc>
15494	Arguments to the info dumper.
15495	</desc>
15496	</param>
15497	<param name="info" type="wstring" dir="return">
15498	<desc>
15499	The into string.
15500	</desc>
15501	</param>
15502	</method>
15503
15504	<method name="injectNMI">
15505	<desc>
15506	Inject an NMI into a running VT-x/AMD-V VM.
15507	</desc>
15508	</method>
15509
15510	<method name="modifyLogGroups">
15511	<desc>
15512	Modifies the group settings of the debug or release logger.
15513	</desc>
15514	<param name="settings" type="wstring" dir="in">
15515	<desc>
15516	The group settings string. See iprt/log.h for details. To target the
15517	release logger, prefix the string with "release:".
15518	</desc>
15519	</param>
15520	</method>
15521
15522	<method name="modifyLogFlags">
15523	<desc>
15524	Modifies the debug or release logger flags.
15525	</desc>
15526	<param name="settings" type="wstring" dir="in">
15527	<desc>
15528	The flags settings string. See iprt/log.h for details. To target the
15529	release logger, prefix the string with "release:".
15530	</desc>
15531	</param>
15532	</method>
15533
15534	<method name="modifyLogDestinations">
15535	<desc>
15536	Modifies the debug or release logger destinations.
15537	</desc>
15538	<param name="settings" type="wstring" dir="in">
15539	<desc>
15540	The destination settings string. See iprt/log.h for details. To target the
15541	release logger, prefix the string with "release:".
15542	</desc>
15543	</param>
15544	</method>
15545
15546	<method name="readPhysicalMemory">
15547	<desc>
15548	Reads guest physical memory, no side effects (MMIO++).
15549
15550	This feature is not implemented in the 4.0.0 release but may show up
15551	in a dot release.
15552	</desc>
15553	<param name="address" type="long long" dir="in">
15554	<desc>The guest physical address.</desc>
15555	</param>
15556	<param name="size" type="unsigned long" dir="in">
15557	<desc>The number of bytes to read.</desc>
15558	</param>
15559	<param name="bytes" type="octet" safearray="yes" dir="return">
15560	<desc>The bytes read.</desc>
15561	</param>
15562	</method>
15563
15564	<method name="writePhysicalMemory">
15565	<desc>
15566	Writes guest physical memory, access handles (MMIO++) are ignored.
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="address" type="long long" dir="in">
15572	<desc>The guest physical address.</desc>
15573	</param>
15574	<param name="size" type="unsigned long" dir="in">
15575	<desc>The number of bytes to read.</desc>
15576	</param>
15577	<param name="bytes" type="octet" safearray="yes" dir="in">
15578	<desc>The bytes to write.</desc>
15579	</param>
15580	</method>
15581
15582	<method name="readVirtualMemory">
15583	<desc>
15584	Reads guest virtual memory, no side effects (MMIO++).
15585
15586	This feature is not implemented in the 4.0.0 release but may show up
15587	in a dot release.
15588	</desc>
15589	<param name="cpuId" type="unsigned long" dir="in">
15590	<desc>The identifier of the Virtual CPU.</desc>
15591	</param>
15592	<param name="address" type="long long" dir="in">
15593	<desc>The guest virtual address.</desc>
15594	</param>
15595	<param name="size" type="unsigned long" dir="in">
15596	<desc>The number of bytes to read.</desc>
15597	</param>
15598	<param name="bytes" type="octet" safearray="yes" dir="return">
15599	<desc>The bytes read.</desc>
15600	</param>
15601	</method>
15602
15603	<method name="writeVirtualMemory">
15604	<desc>
15605	Writes guest virtual memory, access handles (MMIO++) are ignored.
15606
15607	This feature is not implemented in the 4.0.0 release but may show up
15608	in a dot release.
15609	</desc>
15610	<param name="cpuId" type="unsigned long" dir="in">
15611	<desc>The identifier of the Virtual CPU.</desc>
15612	</param>
15613	<param name="address" type="long long" dir="in">
15614	<desc>The guest virtual address.</desc>
15615	</param>
15616	<param name="size" type="unsigned long" dir="in">
15617	<desc>The number of bytes to read.</desc>
15618	</param>
15619	<param name="bytes" type="octet" safearray="yes" dir="in">
15620	<desc>The bytes to write.</desc>
15621	</param>
15622	</method>
15623
15624	<method name="detectOS">
15625	<desc>
15626	Tries to (re-)detect the guest OS kernel.
15627
15628	This feature is not implemented in the 4.0.0 release but may show up
15629	in a dot release.
15630	</desc>
15631	<param name="os" type="wstring" dir="return">
15632	<desc>
15633	The detected OS kernel on success.
15634	</desc>
15635	</param>
15636	</method>
15637
15638	<method name="getRegister">
15639	<desc>
15640	Gets one register.
15641
15642	This feature is not implemented in the 4.0.0 release but may show up
15643	in a dot release.
15644	</desc>
15645	<param name="cpuId" type="unsigned long" dir="in">
15646	<desc>The identifier of the Virtual CPU.</desc>
15647	</param>
15648	<param name="name" type="wstring" dir="in">
15649	<desc>The register name, case is ignored.</desc>
15650	</param>
15651	<param name="value" type="wstring" dir="return">
15652	<desc>
15653	The register value. This is usually a hex value (always 0x prefixed)
15654	but other format may be used for floating point registers (TBD).
15655	</desc>
15656	</param>
15657	</method>
15658
15659	<method name="getRegisters">
15660	<desc>
15661	Gets all the registers for the given CPU.
15662
15663	This feature is not implemented in the 4.0.0 release but may show up
15664	in a dot release.
15665	</desc>
15666	<param name="cpuId" type="unsigned long" dir="in">
15667	<desc>The identifier of the Virtual CPU.</desc>
15668	</param>
15669	<param name="names" type="wstring" dir="out" safearray="yes">
15670	<desc>Array containing the lowercase register names.</desc>
15671	</param>
15672	<param name="values" type="wstring" dir="out" safearray="yes">
15673	<desc>
15674	Array paralell to the names holding the register values as if the
15675	register was returned by <link to="IMachineDebugger::getRegister"/>.
15676	</desc>
15677	</param>
15678	</method>
15679
15680	<method name="setRegister">
15681	<desc>
15682	Gets one register.
15683
15684	This feature is not implemented in the 4.0.0 release but may show up
15685	in a dot release.
15686	</desc>
15687	<param name="cpuId" type="unsigned long" dir="in">
15688	<desc>The identifier of the Virtual CPU.</desc>
15689	</param>
15690	<param name="name" type="wstring" dir="in">
15691	<desc>The register name, case is ignored.</desc>
15692	</param>
15693	<param name="value" type="wstring" dir="in">
15694	<desc>
15695	The new register value. Hexadecimal, decimal and octal formattings
15696	are supported in addition to any special formattings returned by
15697	the getters.
15698	</desc>
15699	</param>
15700	</method>
15701
15702	<method name="setRegisters">
15703	<desc>
15704	Sets zero or more registers atomically.
15705
15706	This feature is not implemented in the 4.0.0 release but may show up
15707	in a dot release.
15708	</desc>
15709	<param name="cpuId" type="unsigned long" dir="in">
15710	<desc>The identifier of the Virtual CPU.</desc>
15711	</param>
15712	<param name="names" type="wstring" dir="in" safearray="yes">
15713	<desc>Array containing the register names, case ignored.</desc>
15714	</param>
15715	<param name="values" type="wstring" dir="in" safearray="yes">
15716	<desc>
15717	Array paralell to the names holding the register values. See
15718	<link to="IMachineDebugger::setRegister"/> for formatting
15719	guidelines.
15720	</desc>
15721	</param>
15722	</method>
15723
15724	<method name="dumpGuestStack">
15725	<desc>
15726	Produce a simple stack dump using the current guest state.
15727
15728	This feature is not implemented in the 4.0.0 release but may show up
15729	in a dot release.
15730	</desc>
15731	<param name="cpuId" type="unsigned long" dir="in">
15732	<desc>The identifier of the Virtual CPU.</desc>
15733	</param>
15734	<param name="stack" type="wstring" dir="return">
15735	<desc>String containing the formatted stack dump.</desc>
15736	</param>
15737	</method>
15738
15739	<method name="resetStats">
15740	<desc>
15741	Reset VM statistics.
15742	</desc>
15743	<param name="pattern" type="wstring" dir="in">
15744	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15745	</param>
15746	</method>
15747
15748	<method name="dumpStats">
15749	<desc>
15750	Dumps VM statistics.
15751	</desc>
15752	<param name="pattern" type="wstring" dir="in">
15753	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15754	</param>
15755	</method>
15756
15757	<method name="getStats">
15758	<desc>
15759	Get the VM statistics in a XMLish format.
15760	</desc>
15761	<param name="pattern" type="wstring" dir="in">
15762	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15763	</param>
15764	<param name="withDescriptions" type="boolean" dir="in">
15765	<desc>Whether to include the descriptions.</desc>
15766	</param>
15767	<param name="stats" type="wstring" dir="out">
15768	<desc>The XML document containing the statistics.</desc>
15769	</param>
15770	</method>
15771
15772	<attribute name="singleStep" type="boolean">
15773	<desc>Switch for enabling single-stepping.</desc>
15774	</attribute>
15775
15776	<attribute name="recompileUser" type="boolean">
15777	<desc>Switch for forcing code recompilation for user mode code.</desc>
15778	</attribute>
15779
15780	<attribute name="recompileSupervisor" type="boolean">
15781	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
15782	</attribute>
15783
15784	<attribute name="PATMEnabled" type="boolean">
15785	<desc>Switch for enabling and disabling the PATM component.</desc>
15786	</attribute>
15787
15788	<attribute name="CSAMEnabled" type="boolean">
15789	<desc>Switch for enabling and disabling the CSAM component.</desc>
15790	</attribute>
15791
15792	<attribute name="logEnabled" type="boolean">
15793	<desc>Switch for enabling and disabling the debug logger.</desc>
15794	</attribute>
15795
15796	<attribute name="logDbgFlags" type="wstring" readonly="yes">
15797	<desc>The debug logger flags.</desc>
15798	</attribute>
15799
15800	<attribute name="logDbgGroups" type="wstring" readonly="yes">
15801	<desc>The debug logger's group settings.</desc>
15802	</attribute>
15803
15804	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
15805	<desc>The debug logger's destination settings.</desc>
15806	</attribute>
15807
15808	<attribute name="logRelFlags" type="wstring" readonly="yes">
15809	<desc>The release logger flags.</desc>
15810	</attribute>
15811
15812	<attribute name="logRelGroups" type="wstring" readonly="yes">
15813	<desc>The release logger's group settings.</desc>
15814	</attribute>
15815
15816	<attribute name="logRelDestinations" type="wstring" readonly="yes">
15817	<desc>The relase logger's destination settings.</desc>
15818	</attribute>
15819
15820	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
15821	<desc>
15822	Flag indicating whether the VM is currently making use of CPU hardware
15823	virtualization extensions.
15824	</desc>
15825	</attribute>
15826
15827	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
15828	<desc>
15829	Flag indicating whether the VM is currently making use of the nested paging
15830	CPU hardware virtualization extension.
15831	</desc>
15832	</attribute>
15833
15834	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
15835	<desc>
15836	Flag indicating whether the VM is currently making use of the VPID
15837	VT-x extension.
15838	</desc>
15839	</attribute>
15840
15841	<attribute name="OSName" type="wstring" readonly="yes">
15842	<desc>
15843	Query the guest OS kernel name as detected by the DBGF.
15844
15845	This feature is not implemented in the 4.0.0 release but may show up
15846	in a dot release.
15847	</desc>
15848	</attribute>
15849
15850	<attribute name="OSVersion" type="wstring" readonly="yes">
15851	<desc>
15852	Query the guest OS kernel version string as detected by the DBGF.
15853
15854	This feature is not implemented in the 4.0.0 release but may show up
15855	in a dot release.
15856	</desc>
15857	</attribute>
15858
15859	<attribute name="PAEEnabled" type="boolean" readonly="yes">
15860	<desc>
15861	Flag indicating whether the VM is currently making use of the Physical
15862	Address Extension CPU feature.
15863	</desc>
15864	</attribute>
15865
15866	<attribute name="virtualTimeRate" type="unsigned long">
15867	<desc>
15868	The rate at which the virtual time runs expressed as a percentage.
15869	The accepted range is 2% to 20000%.
15870	</desc>
15871	</attribute>
15872
15873	<attribute name="VM" type="long long" readonly="yes">
15874	<desc>
15875	Gets the VM handle. This is only for internal use while
15876	we carve the details of this interface.
15877	</desc>
15878	</attribute>
15879
15880	</interface>
15881
15882	<!--
15883	// IUSBController
15884	/////////////////////////////////////////////////////////////////////////
15885	-->
15886
15887	<interface
15888	name="IUSBController" extends="$unknown"
15889	uuid="01e6f13a-0580-452f-a40f-74e32a5e4921"
15890	wsmap="managed"
15891	>
15892	<attribute name="enabled" type="boolean">
15893	<desc>
15894	Flag whether the USB controller is present in the
15895	guest system. If disabled, the virtual guest hardware will
15896	not contain any USB controller. Can only be changed when
15897	the VM is powered off.
15898	</desc>
15899	</attribute>
15900
15901	<attribute name="enabledEHCI" type="boolean">
15902	<desc>
15903	Flag whether the USB EHCI controller is present in the
15904	guest system. If disabled, the virtual guest hardware will
15905	not contain a USB EHCI controller. Can only be changed when
15906	the VM is powered off.
15907	</desc>
15908	</attribute>
15909
15910	<attribute name="proxyAvailable" type="boolean" readonly="yes">
15911	<desc>
15912	Flag whether there is an USB proxy available.
15913	</desc>
15914	</attribute>
15915
15916	<attribute name="USBStandard" type="unsigned short" readonly="yes">
15917	<desc>
15918	USB standard version which the controller implements.
15919	This is a BCD which means that the major version is in the
15920	high byte and minor version is in the low byte.
15921	</desc>
15922	</attribute>
15923
15924	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
15925	<desc>
15926	List of USB device filters associated with the machine.
15927
15928	If the machine is currently running, these filters are activated
15929	every time a new (supported) USB device is attached to the host
15930	computer that was not ignored by global filters
15931	(<link to="IHost::USBDeviceFilters"/>).
15932
15933	These filters are also activated when the machine is powered up.
15934	They are run against a list of all currently available USB
15935	devices (in states
15936	<link to="USBDeviceState_Available"/>,
15937	<link to="USBDeviceState_Busy"/>,
15938	<link to="USBDeviceState_Held"/>) that were not previously
15939	ignored by global filters.
15940
15941	If at least one filter matches the USB device in question, this
15942	device is automatically captured (attached to) the virtual USB
15943	controller of this machine.
15944
15945	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
15946	</desc>
15947	</attribute>
15948
15949	<method name="createDeviceFilter">
15950	<desc>
15951	Creates a new USB device filter. All attributes except
15952	the filter name are set to empty (any match),
15953	<i>active</i> is @c false (the filter is not active).
15954
15955	The created filter can then be added to the list of filters using
15956	<link to="#insertDeviceFilter"/>.
15957
15958	<result name="VBOX_E_INVALID_VM_STATE">
15959	The virtual machine is not mutable.
15960	</result>
15961
15962	<see><link to="#deviceFilters"/></see>
15963	</desc>
15964	<param name="name" type="wstring" dir="in">
15965	<desc>
15966	Filter name. See <link to="IUSBDeviceFilter::name"/>
15967	for more info.
15968	</desc>
15969	</param>
15970	<param name="filter" type="IUSBDeviceFilter" dir="return">
15971	<desc>Created filter object.</desc>
15972	</param>
15973	</method>
15974
15975	<method name="insertDeviceFilter">
15976	<desc>
15977	Inserts the given USB device to the specified position
15978	in the list of filters.
15979
15980	Positions are numbered starting from <tt>0</tt>. If the specified
15981	position is equal to or greater than the number of elements in
15982	the list, the filter is added to the end of the collection.
15983
15984	<note>
15985	Duplicates are not allowed, so an attempt to insert a
15986	filter that is already in the collection, will return an
15987	error.
15988	</note>
15989
15990	<result name="VBOX_E_INVALID_VM_STATE">
15991	Virtual machine is not mutable.
15992	</result>
15993	<result name="E_INVALIDARG">
15994	USB device filter not created within this VirtualBox instance.
15995	</result>
15996	<result name="VBOX_E_INVALID_OBJECT_STATE">
15997	USB device filter already in list.
15998	</result>
15999
16000	<see><link to="#deviceFilters"/></see>
16001	</desc>
16002	<param name="position" type="unsigned long" dir="in">
16003	<desc>Position to insert the filter to.</desc>
16004	</param>
16005	<param name="filter" type="IUSBDeviceFilter" dir="in">
16006	<desc>USB device filter to insert.</desc>
16007	</param>
16008	</method>
16009
16010	<method name="removeDeviceFilter">
16011	<desc>
16012	Removes a USB device filter from the specified position in the
16013	list of filters.
16014
16015	Positions are numbered starting from <tt>0</tt>. Specifying a
16016	position equal to or greater than the number of elements in
16017	the list will produce an error.
16018
16019	<see><link to="#deviceFilters"/></see>
16020
16021	<result name="VBOX_E_INVALID_VM_STATE">
16022	Virtual machine is not mutable.
16023	</result>
16024	<result name="E_INVALIDARG">
16025	USB device filter list empty or invalid @a position.
16026	</result>
16027
16028	</desc>
16029	<param name="position" type="unsigned long" dir="in">
16030	<desc>Position to remove the filter from.</desc>
16031	</param>
16032	<param name="filter" type="IUSBDeviceFilter" dir="return">
16033	<desc>Removed USB device filter.</desc>
16034	</param>
16035	</method>
16036
16037	</interface>
16038
16039
16040	<!--
16041	// IUSBDevice
16042	/////////////////////////////////////////////////////////////////////////
16043	-->
16044
16045	<interface
16046	name="IUSBDevice" extends="$unknown"
16047	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
16048	wsmap="managed"
16049	>
16050	<desc>
16051	The IUSBDevice interface represents a virtual USB device attached to the
16052	virtual machine.
16053
16054	A collection of objects implementing this interface is stored in the
16055	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
16056	attached to a running virtual machine's USB controller.
16057	</desc>
16058
16059	<attribute name="id" type="uuid" mod="string" readonly="yes">
16060	<desc>
16061	Unique USB device ID. This ID is built from #vendorId,
16062	#productId, #revision and #serialNumber.
16063	</desc>
16064	</attribute>
16065
16066	<attribute name="vendorId" type="unsigned short" readonly="yes">
16067	<desc>Vendor ID.</desc>
16068	</attribute>
16069
16070	<attribute name="productId" type="unsigned short" readonly="yes">
16071	<desc>Product ID.</desc>
16072	</attribute>
16073
16074	<attribute name="revision" type="unsigned short" readonly="yes">
16075	<desc>
16076	Product revision number. This is a packed BCD represented as
16077	unsigned short. The high byte is the integer part and the low
16078	byte is the decimal.
16079	</desc>
16080	</attribute>
16081
16082	<attribute name="manufacturer" type="wstring" readonly="yes">
16083	<desc>Manufacturer string.</desc>
16084	</attribute>
16085
16086	<attribute name="product" type="wstring" readonly="yes">
16087	<desc>Product string.</desc>
16088	</attribute>
16089
16090	<attribute name="serialNumber" type="wstring" readonly="yes">
16091	<desc>Serial number string.</desc>
16092	</attribute>
16093
16094	<attribute name="address" type="wstring" readonly="yes">
16095	<desc>Host specific address of the device.</desc>
16096	</attribute>
16097
16098	<attribute name="port" type="unsigned short" readonly="yes">
16099	<desc>
16100	Host USB port number the device is physically
16101	connected to.
16102	</desc>
16103	</attribute>
16104
16105	<attribute name="version" type="unsigned short" readonly="yes">
16106	<desc>
16107	The major USB version of the device - 1 or 2.
16108	</desc>
16109	</attribute>
16110
16111	<attribute name="portVersion" type="unsigned short" readonly="yes">
16112	<desc>
16113	The major USB version of the host USB port the device is
16114	physically connected to - 1 or 2. For devices not connected to
16115	anything this will have the same value as the version attribute.
16116	</desc>
16117	</attribute>
16118
16119	<attribute name="remote" type="boolean" readonly="yes">
16120	<desc>
16121	Whether the device is physically connected to a remote VRDE
16122	client or to a local host machine.
16123	</desc>
16124	</attribute>
16125
16126	</interface>
16127
16128
16129	<!--
16130	// IUSBDeviceFilter
16131	/////////////////////////////////////////////////////////////////////////
16132	-->
16133
16134	<interface
16135	name="IUSBDeviceFilter" extends="$unknown"
16136	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
16137	wsmap="managed"
16138	>
16139	<desc>
16140	The IUSBDeviceFilter interface represents an USB device filter used
16141	to perform actions on a group of USB devices.
16142
16143	This type of filters is used by running virtual machines to
16144	automatically capture selected USB devices once they are physically
16145	attached to the host computer.
16146
16147	A USB device is matched to the given device filter if and only if all
16148	attributes of the device match the corresponding attributes of the
16149	filter (that is, attributes are joined together using the logical AND
16150	operation). On the other hand, all together, filters in the list of
16151	filters carry the semantics of the logical OR operation. So if it is
16152	desirable to create a match like "this vendor id OR this product id",
16153	one needs to create two filters and specify "any match" (see below)
16154	for unused attributes.
16155
16156	All filter attributes used for matching are strings. Each string
16157	is an expression representing a set of values of the corresponding
16158	device attribute, that will match the given filter. Currently, the
16159	following filtering expressions are supported:
16160
16161	<ul>
16162	<li><i>Interval filters</i>. Used to specify valid intervals for
16163	integer device attributes (Vendor ID, Product ID and Revision).
16164	The format of the string is:
16165
16166	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
16167
16168	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
16169	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
16170	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
16171	is omitted before a dash (<tt>-</tt>), the minimum possible integer
16172	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
16173	possible integer is assumed.
16174	</li>
16175	<li><i>Boolean filters</i>. Used to specify acceptable values for
16176	boolean device attributes. The format of the string is:
16177
16178	<tt>true\|false\|yes\|no\|0\|1</tt>
16179
16180	</li>
16181	<li><i>Exact match</i>. Used to specify a single value for the given
16182	device attribute. Any string that doesn't start with <tt>int:</tt>
16183	represents the exact match. String device attributes are compared to
16184	this string including case of symbols. Integer attributes are first
16185	converted to a string (see individual filter attributes) and then
16186	compared ignoring case.
16187
16188	</li>
16189	<li><i>Any match</i>. Any value of the corresponding device attribute
16190	will match the given filter. An empty or @c null string is
16191	used to construct this type of filtering expressions.
16192
16193	</li>
16194	</ul>
16195
16196	<note>
16197	On the Windows host platform, interval filters are not currently
16198	available. Also all string filter attributes
16199	(<link to="#manufacturer"/>, <link to="#product"/>,
16200	<link to="#serialNumber"/>) are ignored, so they behave as
16201	<i>any match</i> no matter what string expression is specified.
16202	</note>
16203
16204	<see><link to="IUSBController::deviceFilters"/>,
16205	<link to="IHostUSBDeviceFilter"/></see>
16206	</desc>
16207
16208	<attribute name="name" type="wstring">
16209	<desc>
16210	Visible name for this filter.
16211	This name is used to visually distinguish one filter from another,
16212	so it can neither be @c null nor an empty string.
16213	</desc>
16214	</attribute>
16215
16216	<attribute name="active" type="boolean">
16217	<desc>Whether this filter active or has been temporarily disabled.</desc>
16218	</attribute>
16219
16220	<attribute name="vendorId" type="wstring">
16221	<desc>
16222	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
16223	The string representation for the <i>exact matching</i>
16224	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16225	(including leading zeroes).
16226	</desc>
16227	</attribute>
16228
16229	<attribute name="productId" type="wstring">
16230	<desc>
16231	<link to="IUSBDevice::productId">Product ID</link> filter.
16232	The string representation for the <i>exact matching</i>
16233	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16234	(including leading zeroes).
16235	</desc>
16236	</attribute>
16237
16238	<attribute name="revision" type="wstring">
16239	<desc>
16240	<link to="IUSBDevice::productId">Product revision number</link>
16241	filter. The string representation for the <i>exact matching</i>
16242	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
16243	of the integer part of the revision, and <tt>F</tt> is the
16244	decimal digit of its fractional part (including leading and
16245	trailing zeros).
16246	Note that for interval filters, it's best to use the hexadecimal
16247	form, because the revision is stored as a 16 bit packed BCD value;
16248	so the expression <tt>int:0x0100-0x0199</tt> will match any
16249	revision from <tt>1.0</tt> to <tt>1.99</tt>.
16250	</desc>
16251	</attribute>
16252
16253	<attribute name="manufacturer" type="wstring">
16254	<desc>
16255	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
16256	</desc>
16257	</attribute>
16258
16259	<attribute name="product" type="wstring">
16260	<desc>
16261	<link to="IUSBDevice::product">Product</link> filter.
16262	</desc>
16263	</attribute>
16264
16265	<attribute name="serialNumber" type="wstring">
16266	<desc>
16267	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
16268	</desc>
16269	</attribute>
16270
16271	<attribute name="port" type="wstring">
16272	<desc>
16273	<link to="IUSBDevice::port">Host USB port</link> filter.
16274	</desc>
16275	</attribute>
16276
16277	<attribute name="remote" type="wstring">
16278	<desc>
16279	<link to="IUSBDevice::remote">Remote state</link> filter.
16280	<note>
16281	This filter makes sense only for machine USB filters,
16282	i.e. it is ignored by IHostUSBDeviceFilter objects.
16283	</note>
16284	</desc>
16285	</attribute>
16286
16287	<attribute name="maskedInterfaces" type="unsigned long">
16288	<desc>
16289	This is an advanced option for hiding one or more USB interfaces
16290	from the guest. The value is a bit mask where the bits that are set
16291	means the corresponding USB interface should be hidden, masked off
16292	if you like.
16293	This feature only works on Linux hosts.
16294	</desc>
16295	</attribute>
16296
16297	</interface>
16298
16299
16300	<!--
16301	// IHostUSBDevice
16302	/////////////////////////////////////////////////////////////////////////
16303	-->
16304
16305	<enum
16306	name="USBDeviceState"
16307	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
16308	>
16309	<desc>
16310	USB device state. This enumeration represents all possible states
16311	of the USB device physically attached to the host computer regarding
16312	its state on the host computer and availability to guest computers
16313	(all currently running virtual machines).
16314
16315	Once a supported USB device is attached to the host, global USB
16316	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
16317	either ignore the device, or put it to USBDeviceState_Held state, or do
16318	nothing. Unless the device is ignored by global filters, filters of all
16319	currently running guests (<link to="IUSBController::deviceFilters"/>) are
16320	activated that can put it to USBDeviceState_Captured state.
16321
16322	If the device was ignored by global filters, or didn't match
16323	any filters at all (including guest ones), it is handled by the host
16324	in a normal way. In this case, the device state is determined by
16325	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
16326	or USBDeviceState_Available, depending on the current device usage.
16327
16328	Besides auto-capturing based on filters, the device can be manually
16329	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
16330	state is USBDeviceState_Busy, USBDeviceState_Available or
16331	USBDeviceState_Held.
16332
16333	<note>
16334	Due to differences in USB stack implementations in Linux and Win32,
16335	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
16336	only to the Linux version of the product. This also means that (<link
16337	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
16338	device state is USBDeviceState_Held.
16339	</note>
16340
16341	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
16342	</desc>
16343
16344	<const name="NotSupported" value="0">
16345	<desc>
16346	Not supported by the VirtualBox server, not available to guests.
16347	</desc>
16348	</const>
16349	<const name="Unavailable" value="1">
16350	<desc>
16351	Being used by the host computer exclusively,
16352	not available to guests.
16353	</desc>
16354	</const>
16355	<const name="Busy" value="2">
16356	<desc>
16357	Being used by the host computer, potentially available to guests.
16358	</desc>
16359	</const>
16360	<const name="Available" value="3">
16361	<desc>
16362	Not used by the host computer, available to guests (the host computer
16363	can also start using the device at any time).
16364	</desc>
16365	</const>
16366	<const name="Held" value="4">
16367	<desc>
16368	Held by the VirtualBox server (ignored by the host computer),
16369	available to guests.
16370	</desc>
16371	</const>
16372	<const name="Captured" value="5">
16373	<desc>
16374	Captured by one of the guest computers, not available
16375	to anybody else.
16376	</desc>
16377	</const>
16378	</enum>
16379
16380	<interface
16381	name="IHostUSBDevice" extends="IUSBDevice"
16382	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
16383	wsmap="managed"
16384	>
16385	<desc>
16386	The IHostUSBDevice interface represents a physical USB device attached
16387	to the host computer.
16388
16389	Besides properties inherited from IUSBDevice, this interface adds the
16390	<link to="#state"/> property that holds the current state of the USB
16391	device.
16392
16393	<see><link to="IHost::USBDevices"/>,
16394	<link to="IHost::USBDeviceFilters"/></see>
16395	</desc>
16396
16397	<attribute name="state" type="USBDeviceState" readonly="yes">
16398	<desc>
16399	Current state of the device.
16400	</desc>
16401	</attribute>
16402
16403	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
16404
16405	</interface>
16406
16407
16408	<!--
16409	// IHostUSBDeviceFilter
16410	/////////////////////////////////////////////////////////////////////////
16411	-->
16412
16413	<enum
16414	name="USBDeviceFilterAction"
16415	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
16416	>
16417	<desc>
16418	Actions for host USB device filters.
16419	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
16420	</desc>
16421
16422	<const name="Null" value="0">
16423	<desc>Null value (never used by the API).</desc>
16424	</const>
16425	<const name="Ignore" value="1">
16426	<desc>Ignore the matched USB device.</desc>
16427	</const>
16428	<const name="Hold" value="2">
16429	<desc>Hold the matched USB device.</desc>
16430	</const>
16431	</enum>
16432
16433	<interface
16434	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
16435	uuid="4cc70246-d74a-400f-8222-3900489c0374"
16436	wsmap="managed"
16437	>
16438	<desc>
16439	The IHostUSBDeviceFilter interface represents a global filter for a
16440	physical USB device used by the host computer. Used indirectly in
16441	<link to="IHost::USBDeviceFilters"/>.
16442
16443	Using filters of this type, the host computer determines the initial
16444	state of the USB device after it is physically attached to the
16445	host's USB controller.
16446
16447	<note>
16448	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
16449	filters, because it makes sense only for
16450	<link to="IUSBController::deviceFilters">machine USB filters</link>.
16451	</note>
16452
16453	<see><link to="IHost::USBDeviceFilters"/></see>
16454	</desc>
16455
16456	<attribute name="action" type="USBDeviceFilterAction">
16457	<desc>
16458	Action performed by the host when an attached USB device
16459	matches this filter.
16460	</desc>
16461	</attribute>
16462
16463	</interface>
16464
16465	<!--
16466	// IAudioAdapter
16467	/////////////////////////////////////////////////////////////////////////
16468	-->
16469
16470	<enum
16471	name="AudioDriverType"
16472	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
16473	>
16474	<desc>
16475	Host audio driver type.
16476	</desc>
16477
16478	<const name="Null" value="0">
16479	<desc>Null value, also means "dummy audio driver".</desc>
16480	</const>
16481	<const name="WinMM" value="1">
16482	<desc>Windows multimedia (Windows hosts only).</desc>
16483	</const>
16484	<const name="OSS" value="2">
16485	<desc>Open Sound System (Linux hosts only).</desc>
16486	</const>
16487	<const name="ALSA" value="3">
16488	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
16489	</const>
16490	<const name="DirectSound" value="4">
16491	<desc>DirectSound (Windows hosts only).</desc>
16492	</const>
16493	<const name="CoreAudio" value="5">
16494	<desc>CoreAudio (Mac hosts only).</desc>
16495	</const>
16496	<const name="MMPM" value="6">
16497	<desc>Reserved for historical reasons.</desc>
16498	</const>
16499	<const name="Pulse" value="7">
16500	<desc>PulseAudio (Linux hosts only).</desc>
16501	</const>
16502	<const name="SolAudio" value="8">
16503	<desc>Solaris audio (Solaris hosts only).</desc>
16504	</const>
16505	</enum>
16506
16507	<enum
16508	name="AudioControllerType"
16509	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
16510	>
16511	<desc>
16512	Virtual audio controller type.
16513	</desc>
16514
16515	<const name="AC97" value="0"/>
16516	<const name="SB16" value="1"/>
16517	<const name="HDA" value="2"/>
16518	</enum>
16519
16520	<interface
16521	name="IAudioAdapter" extends="$unknown"
16522	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
16523	wsmap="managed"
16524	>
16525	<desc>
16526	The IAudioAdapter interface represents the virtual audio adapter of
16527	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
16528	</desc>
16529	<attribute name="enabled" type="boolean">
16530	<desc>
16531	Flag whether the audio adapter is present in the
16532	guest system. If disabled, the virtual guest hardware will
16533	not contain any audio adapter. Can only be changed when
16534	the VM is not running.
16535	</desc>
16536	</attribute>
16537	<attribute name="audioController" type="AudioControllerType">
16538	<desc>
16539	The audio hardware we emulate.
16540	</desc>
16541	</attribute>
16542	<attribute name="audioDriver" type="AudioDriverType">
16543	<desc>
16544	Audio driver the adapter is connected to. This setting
16545	can only be changed when the VM is not running.
16546	</desc>
16547	</attribute>
16548	</interface>
16549
16550	<enum
16551	name="AuthType"
16552	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
16553	>
16554	<desc>
16555	VirtualBox authentication type.
16556	</desc>
16557
16558	<const name="Null" value="0">
16559	<desc>Null value, also means "no authentication".</desc>
16560	</const>
16561	<const name="External" value="1"/>
16562	<const name="Guest" value="2"/>
16563	</enum>
16564
16565	<!--
16566	// IVRDEServer
16567	/////////////////////////////////////////////////////////////////////////
16568	-->
16569
16570	<interface
16571	name="IVRDEServer" extends="$unknown"
16572	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
16573	wsmap="managed"
16574	>
16575	<attribute name="enabled" type="boolean">
16576	<desc>VRDE server status.</desc>
16577	</attribute>
16578
16579	<attribute name="authType" type="AuthType">
16580	<desc>VRDE authentication method.</desc>
16581	</attribute>
16582
16583	<attribute name="authTimeout" type="unsigned long">
16584	<desc>Timeout for guest authentication. Milliseconds.</desc>
16585	</attribute>
16586
16587	<attribute name="allowMultiConnection" type="boolean">
16588	<desc>
16589	Flag whether multiple simultaneous connections to the VM are permitted.
16590	Note that this will be replaced by a more powerful mechanism in the future.
16591	</desc>
16592	</attribute>
16593
16594	<attribute name="reuseSingleConnection" type="boolean">
16595	<desc>
16596	Flag whether the existing connection must be dropped and a new connection
16597	must be established by the VRDE server, when a new client connects in single
16598	connection mode.
16599	</desc>
16600	</attribute>
16601
16602	<attribute name="VRDEExtPack" type="wstring">
16603	<desc>
16604	The name of Extension Pack providing VRDE for this VM. Overrides
16605	<link to="ISystemProperties::defaultVRDEExtPack"/>.
16606	</desc>
16607	</attribute>
16608
16609	<attribute name="authLibrary" type="wstring">
16610	<desc>
16611	Library used for authentication of RDP clients by this VM. Overrides
16612	<link to="ISystemProperties::VRDEAuthLibrary"/>.
16613	</desc>
16614	</attribute>
16615
16616	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
16617	<desc>
16618	Array of names of properties, which are supported by this VRDE server.
16619	</desc>
16620	</attribute>
16621
16622	<method name="setVRDEProperty">
16623	<desc>
16624	Sets a VRDE specific property string.
16625
16626	If you pass @c null or empty string as a key @a value, the given @a key
16627	will be deleted.
16628
16629	</desc>
16630	<param name="key" type="wstring" dir="in">
16631	<desc>Name of the key to set.</desc>
16632	</param>
16633	<param name="value" type="wstring" dir="in">
16634	<desc>Value to assign to the key.</desc>
16635	</param>
16636	</method>
16637
16638	<method name="getVRDEProperty" const="yes">
16639	<desc>
16640	Returns a VRDE specific property string.
16641
16642	If the requested data @a key does not exist, this function will
16643	succeed and return an empty string in the @a value argument.
16644
16645	</desc>
16646	<param name="key" type="wstring" dir="in">
16647	<desc>Name of the key to get.</desc>
16648	</param>
16649	<param name="value" type="wstring" dir="return">
16650	<desc>Value of the requested key.</desc>
16651	</param>
16652	</method>
16653
16654	</interface>
16655
16656
16657	<!--
16658	// ISharedFolder
16659	/////////////////////////////////////////////////////////////////////////
16660	-->
16661
16662	<interface
16663	name="ISharedFolder" extends="$unknown"
16664	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
16665	wsmap="struct"
16666	>
16667	<desc>
16668	The ISharedFolder interface represents a folder in the host computer's
16669	file system accessible from the guest OS running inside a virtual
16670	machine using an associated logical name.
16671
16672	There are three types of shared folders:
16673	<ul>
16674	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
16675	folders available to all virtual machines.</li>
16676	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
16677	VM-specific shared folders available to the given virtual machine at
16678	startup.</li>
16679	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
16680	VM-specific shared folders created in the session context (for
16681	example, when the virtual machine is running) and automatically
16682	discarded when the session is closed (the VM is powered off).</li>
16683	</ul>
16684
16685	Logical names of shared folders must be unique within the given scope
16686	(global, permanent or transient). However, they do not need to be unique
16687	across scopes. In this case, the definition of the shared folder in a
16688	more specific scope takes precedence over definitions in all other
16689	scopes. The order of precedence is (more specific to more general):
16690	<ol>
16691	<li>Transient definitions</li>
16692	<li>Permanent definitions</li>
16693	<li>Global definitions</li>
16694	</ol>
16695
16696	For example, if MyMachine has a shared folder named
16697	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
16698	transient shared folder named <tt>C_DRIVE</tt> (that points
16699	to <tt>C:\\\\WINDOWS</tt>) will change the definition
16700	of <tt>C_DRIVE</tt> in the guest OS so
16701	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
16702	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
16703	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
16704	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
16705	to <tt>C:\\</tt> if it still exists.
16706
16707	Note that permanent and transient shared folders of different machines
16708	are in different name spaces, so they don't overlap and don't need to
16709	have unique logical names.
16710
16711	<note>
16712	Global shared folders are not implemented in the current version of the
16713	product.
16714	</note>
16715	</desc>
16716
16717	<attribute name="name" type="wstring" readonly="yes">
16718	<desc>Logical name of the shared folder.</desc>
16719	</attribute>
16720
16721	<attribute name="hostPath" type="wstring" readonly="yes">
16722	<desc>Full path to the shared folder in the host file system.</desc>
16723	</attribute>
16724
16725	<attribute name="accessible" type="boolean" readonly="yes">
16726	<desc>
16727	Whether the folder defined by the host path is currently
16728	accessible or not.
16729	For example, the folder can be inaccessible if it is placed
16730	on the network share that is not available by the time
16731	this property is read.
16732	</desc>
16733	</attribute>
16734
16735	<attribute name="writable" type="boolean" readonly="yes">
16736	<desc>
16737	Whether the folder defined by the host path is writable or
16738	not.
16739	</desc>
16740	</attribute>
16741
16742	<attribute name="autoMount" type="boolean" readonly="yes">
16743	<desc>
16744	Whether the folder gets automatically mounted by the guest or not.
16745	</desc>
16746	</attribute>
16747
16748	<attribute name="lastAccessError" type="wstring" readonly="yes">
16749	<desc>
16750	Text message that represents the result of the last accessibility
16751	check.
16752
16753	Accessibility checks are performed each time the <link to="#accessible"/>
16754	attribute is read. An empty string is returned if the last
16755	accessibility check was successful. A non-empty string indicates a
16756	failure and should normally describe a reason of the failure (for
16757	example, a file read error).
16758	</desc>
16759	</attribute>
16760
16761	</interface>
16762
16763	<!--
16764	// ISession
16765	/////////////////////////////////////////////////////////////////////////
16766	-->
16767
16768	<interface
16769	name="IInternalSessionControl" extends="$unknown"
16770	uuid="3e83963a-1c3b-400d-8c5f-f2d077b0a597"
16771	internal="yes"
16772	wsmap="suppress"
16773	>
16774	<method name="getPID">
16775	<desc>PID of the process that has created this Session object.
16776	</desc>
16777	<param name="pid" type="unsigned long" dir="return"/>
16778	</method>
16779
16780	<method name="getRemoteConsole">
16781	<desc>
16782	Returns the console object suitable for remote control.
16783
16784	<result name="VBOX_E_INVALID_VM_STATE">
16785	Session state prevents operation.
16786	</result>
16787	<result name="VBOX_E_INVALID_OBJECT_STATE">
16788	Session type prevents operation.
16789	</result>
16790
16791	</desc>
16792	<param name="console" type="IConsole" dir="return"/>
16793	</method>
16794
16795	<method name="assignMachine">
16796	<desc>
16797	Assigns the machine object associated with this direct-type
16798	session or informs the session that it will be a remote one
16799	(if @a machine == @c null).
16800
16801	<result name="VBOX_E_INVALID_VM_STATE">
16802	Session state prevents operation.
16803	</result>
16804	<result name="VBOX_E_INVALID_OBJECT_STATE">
16805	Session type prevents operation.
16806	</result>
16807
16808	</desc>
16809	<param name="machine" type="IMachine" dir="in"/>
16810	<param name="lockType" type="LockType" dir="in"/>
16811	</method>
16812
16813	<method name="assignRemoteMachine">
16814	<desc>
16815	Assigns the machine and the (remote) console object associated with
16816	this remote-type session.
16817
16818	<result name="VBOX_E_INVALID_VM_STATE">
16819	Session state prevents operation.
16820	</result>
16821
16822	</desc>
16823	<param name="machine" type="IMachine" dir="in"/>
16824	<param name="console" type="IConsole" dir="in"/>
16825	</method>
16826
16827	<method name="updateMachineState">
16828	<desc>
16829	Updates the machine state in the VM process.
16830	Must be called only in certain cases
16831	(see the method implementation).
16832
16833	<result name="VBOX_E_INVALID_VM_STATE">
16834	Session state prevents operation.
16835	</result>
16836	<result name="VBOX_E_INVALID_OBJECT_STATE">
16837	Session type prevents operation.
16838	</result>
16839
16840	</desc>
16841	<param name="aMachineState" type="MachineState" dir="in"/>
16842	</method>
16843
16844	<method name="uninitialize">
16845	<desc>
16846	Uninitializes (closes) this session. Used by VirtualBox to close
16847	the corresponding remote session when the direct session dies
16848	or gets closed.
16849
16850	<result name="VBOX_E_INVALID_VM_STATE">
16851	Session state prevents operation.
16852	</result>
16853
16854	</desc>
16855	</method>
16856
16857	<method name="onNetworkAdapterChange">
16858	<desc>
16859	Triggered when settings of a network adapter of the
16860	associated virtual machine have changed.
16861
16862	<result name="VBOX_E_INVALID_VM_STATE">
16863	Session state prevents operation.
16864	</result>
16865	<result name="VBOX_E_INVALID_OBJECT_STATE">
16866	Session type prevents operation.
16867	</result>
16868
16869	</desc>
16870	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
16871	<param name="changeAdapter" type="boolean" dir="in"/>
16872	</method>
16873
16874	<method name="onSerialPortChange">
16875	<desc>
16876	Triggered when settings of a serial port of the
16877	associated virtual machine have changed.
16878
16879	<result name="VBOX_E_INVALID_VM_STATE">
16880	Session state prevents operation.
16881	</result>
16882	<result name="VBOX_E_INVALID_OBJECT_STATE">
16883	Session type prevents operation.
16884	</result>
16885
16886	</desc>
16887	<param name="serialPort" type="ISerialPort" dir="in"/>
16888	</method>
16889
16890	<method name="onParallelPortChange">
16891	<desc>
16892	Triggered when settings of a parallel port of the
16893	associated virtual machine have changed.
16894
16895	<result name="VBOX_E_INVALID_VM_STATE">
16896	Session state prevents operation.
16897	</result>
16898	<result name="VBOX_E_INVALID_OBJECT_STATE">
16899	Session type prevents operation.
16900	</result>
16901
16902	</desc>
16903	<param name="parallelPort" type="IParallelPort" dir="in"/>
16904	</method>
16905
16906	<method name="onStorageControllerChange">
16907	<desc>
16908	Triggered when settings of a storage controller of the
16909	associated virtual machine have changed.
16910
16911	<result name="VBOX_E_INVALID_VM_STATE">
16912	Session state prevents operation.
16913	</result>
16914	<result name="VBOX_E_INVALID_OBJECT_STATE">
16915	Session type prevents operation.
16916	</result>
16917
16918	</desc>
16919	</method>
16920
16921	<method name="onMediumChange">
16922	<desc>
16923	Triggered when attached media of the
16924	associated virtual machine have changed.
16925
16926	<result name="VBOX_E_INVALID_VM_STATE">
16927	Session state prevents operation.
16928	</result>
16929	<result name="VBOX_E_INVALID_OBJECT_STATE">
16930	Session type prevents operation.
16931	</result>
16932
16933	</desc>
16934
16935	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16936	<desc>The medium attachment which changed.</desc>
16937	</param>
16938	<param name="force" type="boolean" dir="in">
16939	<desc>If the medium change was forced.</desc>
16940	</param>
16941	</method>
16942
16943	<method name="onStorageDeviceChange">
16944	<desc>
16945	Triggered when attached storage devices of the
16946	associated virtual machine have changed.
16947
16948	<result name="VBOX_E_INVALID_VM_STATE">
16949	Session state prevents operation.
16950	</result>
16951	<result name="VBOX_E_INVALID_OBJECT_STATE">
16952	Session type prevents operation.
16953	</result>
16954
16955	</desc>
16956
16957	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16958	<desc>The medium attachment which changed.</desc>
16959	</param>
16960	<param name="remove" type="boolean" dir="in">
16961	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
16962	</param>
16963	</method>
16964
16965	<method name="onClipboardModeChange">
16966	<desc>
16967	Notification when the shared clipboard mode changes.
16968	</desc>
16969	<param name="clipboardMode" type="ClipboardMode" dir="in">
16970	<desc>The new shared clipboard mode.</desc>
16971	</param>
16972	</method>
16973
16974	<method name="onDragAndDropModeChange">
16975	<desc>
16976	Notification when the drag'n'drop mode changes.
16977	</desc>
16978	<param name="dragAndDropMode" type="DragAndDropMode" dir="in">
16979	<desc>The new mode for drag'n'drop.</desc>
16980	</param>
16981	</method>
16982
16983	<method name="onCPUChange">
16984	<desc>
16985	Notification when a CPU changes.
16986	</desc>
16987	<param name="cpu" type="unsigned long" dir="in">
16988	<desc>The CPU which changed</desc>
16989	</param>
16990	<param name="add" type="boolean" dir="in">
16991	<desc>Flag whether the CPU was added or removed</desc>
16992	</param>
16993	</method>
16994
16995	<method name="onCPUExecutionCapChange">
16996	<desc>
16997	Notification when the CPU execution cap changes.
16998	</desc>
16999	<param name="executionCap" type="unsigned long" dir="in">
17000	<desc>The new CPU execution cap value. (1-100)</desc>
17001	</param>
17002	</method>
17003
17004	<method name="onVRDEServerChange">
17005	<desc>
17006	Triggered when settings of the VRDE server object of the
17007	associated virtual machine have changed.
17008
17009	<result name="VBOX_E_INVALID_VM_STATE">
17010	Session state prevents operation.
17011	</result>
17012	<result name="VBOX_E_INVALID_OBJECT_STATE">
17013	Session type prevents operation.
17014	</result>
17015
17016	</desc>
17017	<param name="restart" type="boolean" dir="in">
17018	<desc>Flag whether the server must be restarted</desc>
17019	</param>
17020	</method>
17021
17022	<method name="onUSBControllerChange">
17023	<desc>
17024	Triggered when settings of the USB controller object of the
17025	associated virtual machine have changed.
17026
17027	<result name="VBOX_E_INVALID_VM_STATE">
17028	Session state prevents operation.
17029	</result>
17030	<result name="VBOX_E_INVALID_OBJECT_STATE">
17031	Session type prevents operation.
17032	</result>
17033
17034	</desc>
17035	</method>
17036
17037	<method name="onSharedFolderChange">
17038	<desc>
17039	Triggered when a permanent (global or machine) shared folder has been
17040	created or removed.
17041	<note>
17042	We don't pass shared folder parameters in this notification because
17043	the order in which parallel notifications are delivered is not defined,
17044	therefore it could happen that these parameters were outdated by the
17045	time of processing this notification.
17046	</note>
17047
17048	<result name="VBOX_E_INVALID_VM_STATE">
17049	Session state prevents operation.
17050	</result>
17051	<result name="VBOX_E_INVALID_OBJECT_STATE">
17052	Session type prevents operation.
17053	</result>
17054
17055	</desc>
17056	<param name="global" type="boolean" dir="in"/>
17057	</method>
17058
17059	<method name="onUSBDeviceAttach">
17060	<desc>
17061	Triggered when a request to capture a USB device (as a result
17062	of matched USB filters or direct call to
17063	<link to="IConsole::attachUSBDevice"/>) has completed.
17064	A @c null @a error object means success, otherwise it
17065	describes a failure.
17066
17067	<result name="VBOX_E_INVALID_VM_STATE">
17068	Session state prevents operation.
17069	</result>
17070	<result name="VBOX_E_INVALID_OBJECT_STATE">
17071	Session type prevents operation.
17072	</result>
17073
17074	</desc>
17075	<param name="device" type="IUSBDevice" dir="in"/>
17076	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
17077	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
17078	</method>
17079
17080	<method name="onUSBDeviceDetach">
17081	<desc>
17082	Triggered when a request to release the USB device (as a result
17083	of machine termination or direct call to
17084	<link to="IConsole::detachUSBDevice"/>) has completed.
17085	A @c null @a error object means success, otherwise it
17086	describes a failure.
17087
17088	<result name="VBOX_E_INVALID_VM_STATE">
17089	Session state prevents operation.
17090	</result>
17091	<result name="VBOX_E_INVALID_OBJECT_STATE">
17092	Session type prevents operation.
17093	</result>
17094
17095	</desc>
17096	<param name="id" type="uuid" mod="string" dir="in"/>
17097	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
17098	</method>
17099
17100	<method name="onShowWindow">
17101	<desc>
17102	Called by <link to="IMachine::canShowConsoleWindow"/> and by
17103	<link to="IMachine::showConsoleWindow"/> in order to notify
17104	console listeners
17105	<link to="ICanShowWindowEvent"/>
17106	and <link to="IShowWindowEvent"/>.
17107
17108	<result name="VBOX_E_INVALID_OBJECT_STATE">
17109	Session type prevents operation.
17110	</result>
17111
17112	</desc>
17113	<param name="check" type="boolean" dir="in"/>
17114	<param name="canShow" type="boolean" dir="out"/>
17115	<param name="winId" type="long long" dir="out"/>
17116	</method>
17117
17118	<method name="onBandwidthGroupChange">
17119	<desc>
17120	Notification when one of the bandwidth groups change.
17121	</desc>
17122	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
17123	<desc>The bandwidth group which changed.</desc>
17124	</param>
17125	</method>
17126
17127	<method name="accessGuestProperty">
17128	<desc>
17129	Called by <link to="IMachine::getGuestProperty"/> and by
17130	<link to="IMachine::setGuestProperty"/> in order to read and
17131	modify guest properties.
17132
17133	<result name="VBOX_E_INVALID_VM_STATE">
17134	Machine session is not open.
17135	</result>
17136	<result name="VBOX_E_INVALID_OBJECT_STATE">
17137	Session type is not direct.
17138	</result>
17139
17140	</desc>
17141	<param name="name" type="wstring" dir="in"/>
17142	<param name="value" type="wstring" dir="in"/>
17143	<param name="flags" type="wstring" dir="in"/>
17144	<param name="isSetter" type="boolean" dir="in"/>
17145	<param name="retValue" type="wstring" dir="out"/>
17146	<param name="retTimestamp" type="long long" dir="out"/>
17147	<param name="retFlags" type="wstring" dir="out"/>
17148	</method>
17149
17150	<method name="enumerateGuestProperties" const="yes">
17151	<desc>
17152	Return a list of the guest properties matching a set of patterns along
17153	with their values, time stamps and flags.
17154
17155	<result name="VBOX_E_INVALID_VM_STATE">
17156	Machine session is not open.
17157	</result>
17158	<result name="VBOX_E_INVALID_OBJECT_STATE">
17159	Session type is not direct.
17160	</result>
17161
17162	</desc>
17163	<param name="patterns" type="wstring" dir="in">
17164	<desc>
17165	The patterns to match the properties against as a comma-separated
17166	string. If this is empty, all properties currently set will be
17167	returned.
17168	</desc>
17169	</param>
17170	<param name="key" type="wstring" dir="out" safearray="yes">
17171	<desc>
17172	The key names of the properties returned.
17173	</desc>
17174	</param>
17175	<param name="value" type="wstring" dir="out" safearray="yes">
17176	<desc>
17177	The values of the properties returned. The array entries match the
17178	corresponding entries in the @a key array.
17179	</desc>
17180	</param>
17181	<param name="timestamp" type="long long" dir="out" safearray="yes">
17182	<desc>
17183	The time stamps of the properties returned. The array entries match
17184	the corresponding entries in the @a key array.
17185	</desc>
17186	</param>
17187	<param name="flags" type="wstring" dir="out" safearray="yes">
17188	<desc>
17189	The flags of the properties returned. The array entries match the
17190	corresponding entries in the @a key array.
17191	</desc>
17192	</param>
17193	</method>
17194
17195	<method name="onlineMergeMedium">
17196	<desc>
17197	Triggers online merging of a hard disk. Used internally when deleting
17198	a snapshot while a VM referring to the same hard disk chain is running.
17199
17200	<result name="VBOX_E_INVALID_VM_STATE">
17201	Machine session is not open.
17202	</result>
17203	<result name="VBOX_E_INVALID_OBJECT_STATE">
17204	Session type is not direct.
17205	</result>
17206
17207	</desc>
17208	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
17209	<desc>The medium attachment to identify the medium chain.</desc>
17210	</param>
17211	<param name="sourceIdx" type="unsigned long" dir="in">
17212	<desc>The index of the source image in the chain.
17213	Redundant, but drastically reduces IPC.</desc>
17214	</param>
17215	<param name="targetIdx" type="unsigned long" dir="in">
17216	<desc>The index of the target image in the chain.
17217	Redundant, but drastically reduces IPC.</desc>
17218	</param>
17219	<param name="source" type="IMedium" dir="in">
17220	<desc>Merge source medium.</desc>
17221	</param>
17222	<param name="target" type="IMedium" dir="in">
17223	<desc>Merge target medium.</desc>
17224	</param>
17225	<param name="mergeForward" type="boolean" dir="in">
17226	<desc>Merge direction.</desc>
17227	</param>
17228	<param name="parentForTarget" type="IMedium" dir="in">
17229	<desc>For forward merges: new parent for target medium.</desc>
17230	</param>
17231	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
17232	<desc>For backward merges: list of media which need their parent UUID
17233	updated.</desc>
17234	</param>
17235	<param name="progress" type="IProgress" dir="in">
17236	<desc>
17237	Progress object for this operation.
17238	</desc>
17239	</param>
17240	</method>
17241
17242	<method name="enableVMMStatistics">
17243	<desc>
17244	Enables or disables collection of VMM RAM statistics.
17245
17246	<result name="VBOX_E_INVALID_VM_STATE">
17247	Machine session is not open.
17248	</result>
17249	<result name="VBOX_E_INVALID_OBJECT_STATE">
17250	Session type is not direct.
17251	</result>
17252
17253	</desc>
17254	<param name="enable" type="boolean" dir="in">
17255	<desc>True enables statistics collection.</desc>
17256	</param>
17257	</method>
17258
17259	</interface>
17260
17261	<interface
17262	name="ISession" extends="$unknown"
17263	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
17264	wsmap="managed"
17265	>
17266	<desc>
17267	The ISession interface represents a client process and allows for locking
17268	virtual machines (represented by IMachine objects) to prevent conflicting
17269	changes to the machine.
17270
17271	Any caller wishing to manipulate a virtual machine needs to create a session
17272	object first, which lives in its own process space. Such session objects are
17273	then associated with <link to="IMachine" /> objects living in the VirtualBox
17274	server process to coordinate such changes.
17275
17276	There are two typical scenarios in which sessions are used:
17277
17278	<ul>
17279	<li>To alter machine settings or control a running virtual machine, one
17280	needs to lock a machine for a given session (client process) by calling
17281	<link to="IMachine::lockMachine"/>.
17282
17283	Whereas multiple sessions may control a running virtual machine, only
17284	one process can obtain a write lock on the machine to prevent conflicting
17285	changes. A write lock is also needed if a process wants to actually run a
17286	virtual machine in its own context, such as the VirtualBox GUI or
17287	VBoxHeadless front-ends. They must also lock a machine for their own
17288	sessions before they are allowed to power up the virtual machine.
17289
17290	As a result, no machine settings can be altered while another process is
17291	already using it, either because that process is modifying machine settings
17292	or because the machine is running.
17293	</li>
17294	<li>
17295	To start a VM using one of the existing VirtualBox front-ends (e.g. the
17296	VirtualBox GUI or VBoxHeadless), one would use
17297	<link to="IMachine::launchVMProcess"/>, which also takes a session object
17298	as its first parameter. This session then identifies the caller and lets the
17299	caller control the started machine (for example, pause machine execution or
17300	power it down) as well as be notified about machine execution state changes.
17301	</li>
17302	</ul>
17303
17304	How sessions objects are created in a client process depends on whether you use
17305	the Main API via COM or via the webservice:
17306
17307	<ul>
17308	<li>When using the COM API directly, an object of the Session class from the
17309	VirtualBox type library needs to be created. In regular COM C++ client code,
17310	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
17311	This object will then act as a local session object in further calls to open
17312	a session.
17313	</li>
17314
17315	<li>In the webservice, the session manager (IWebsessionManager) instead creates
17316	a session object automatically whenever <link to="IWebsessionManager::logon" />
17317	is called. A managed object reference to that session object can be retrieved by
17318	calling <link to="IWebsessionManager::getSessionObject" />.
17319	</li>
17320	</ul>
17321	</desc>
17322
17323	<attribute name="state" type="SessionState" readonly="yes">
17324	<desc>Current state of this session.</desc>
17325	</attribute>
17326
17327	<attribute name="type" type="SessionType" readonly="yes">
17328	<desc>
17329	Type of this session. The value of this attribute is valid only
17330	if the session currently has a machine locked (i.e. its
17331	<link to="#state" /> is Locked), otherwise an error will be returned.
17332	</desc>
17333	</attribute>
17334
17335	<attribute name="machine" type="IMachine" readonly="yes">
17336	<desc>Machine object associated with this session.</desc>
17337	</attribute>
17338
17339	<attribute name="console" type="IConsole" readonly="yes">
17340	<desc>Console object associated with this session.</desc>
17341	</attribute>
17342
17343	<method name="unlockMachine">
17344	<desc>
17345	Unlocks a machine that was previously locked for the current session.
17346
17347	Calling this method is required every time a machine has been locked
17348	for a particular session using the <link to="IMachine::launchVMProcess" />
17349	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
17350	the machine will be set to <link to="MachineState_Aborted" /> on the
17351	server, and changes made to the machine settings will be lost.
17352
17353	Generally, it is recommended to unlock all machines explicitly
17354	before terminating the application (regardless of the reason for
17355	the termination).
17356
17357	<note>
17358	Do not expect the session state (<link to="ISession::state" />
17359	to return to "Unlocked" immediately after you invoke this method,
17360	particularly if you have started a new VM process. The session
17361	state will automatically return to "Unlocked" once the VM is no
17362	longer executing, which can of course take a very long time.
17363	</note>
17364
17365	<result name="E_UNEXPECTED">
17366	Session is not locked.
17367	</result>
17368
17369	</desc>
17370	</method>
17371
17372	</interface>
17373
17374	<!--
17375	// IStorageController
17376	/////////////////////////////////////////////////////////////////////////
17377	-->
17378
17379	<enum
17380	name="StorageBus"
17381	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
17382	>
17383	<desc>
17384	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
17385	see <link to="IStorageController::bus" />.
17386	</desc>
17387	<const name="Null" value="0">
17388	<desc>@c null value. Never used by the API.</desc>
17389	</const>
17390	<const name="IDE" value="1"/>
17391	<const name="SATA" value="2"/>
17392	<const name="SCSI" value="3"/>
17393	<const name="Floppy" value="4"/>
17394	<const name="SAS" value="5"/>
17395	</enum>
17396
17397	<enum
17398	name="StorageControllerType"
17399	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
17400	>
17401	<desc>
17402	The exact variant of storage controller hardware presented
17403	to the guest; see <link to="IStorageController::controllerType" />.
17404	</desc>
17405
17406	<const name="Null" value="0">
17407	<desc>@c null value. Never used by the API.</desc>
17408	</const>
17409	<const name="LsiLogic" value="1">
17410	<desc>A SCSI controller of the LsiLogic variant.</desc>
17411	</const>
17412	<const name="BusLogic" value="2">
17413	<desc>A SCSI controller of the BusLogic variant.</desc>
17414	</const>
17415	<const name="IntelAhci" value="3">
17416	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
17417	</const>
17418	<const name="PIIX3" value="4">
17419	<desc>An IDE controller of the PIIX3 variant.</desc>
17420	</const>
17421	<const name="PIIX4" value="5">
17422	<desc>An IDE controller of the PIIX4 variant.</desc>
17423	</const>
17424	<const name="ICH6" value="6">
17425	<desc>An IDE controller of the ICH6 variant.</desc>
17426	</const>
17427	<const name="I82078" value="7">
17428	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
17429	</const>
17430	<const name="LsiLogicSas" value="8">
17431	<desc>A variant of the LsiLogic controller using SAS.</desc>
17432	</const>
17433	</enum>
17434
17435	<enum
17436	name="ChipsetType"
17437	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
17438	>
17439	<desc>
17440	Type of emulated chipset (mostly southbridge).
17441	</desc>
17442
17443	<const name="Null" value="0">
17444	<desc>@c null value. Never used by the API.</desc>
17445	</const>
17446	<const name="PIIX3" value="1">
17447	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
17448	</const>
17449	<const name="ICH9" value="2">
17450	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
17451	</const>
17452	</enum>
17453
17454	<interface
17455	name="IStorageController" extends="$unknown"
17456	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
17457	wsmap="managed"
17458	>
17459	<desc>
17460	Represents a storage controller that is attached to a virtual machine
17461	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
17462	attached to storage controllers in a real computer, virtual drives
17463	(represented by <link to="IMediumAttachment" />) are attached to virtual
17464	storage controllers, represented by this interface.
17465
17466	As opposed to physical hardware, VirtualBox has a very generic concept
17467	of a storage controller, and for purposes of the Main API, all virtual
17468	storage is attached to virtual machines via instances of this interface.
17469	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
17470	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
17471	is used, certain sub-types may be available and can be selected in
17472	<link to="#controllerType" />.
17473
17474	Depending on these settings, the guest operating system might see
17475	significantly different virtual hardware.
17476	</desc>
17477
17478	<attribute name="name" type="wstring" readonly="yes">
17479	<desc>
17480	Name of the storage controller, as originally specified with
17481	<link to="IMachine::addStorageController" />. This then uniquely
17482	identifies this controller with other method calls such as
17483	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
17484	</desc>
17485	</attribute>
17486
17487	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
17488	<desc>
17489	Maximum number of devices which can be attached to one port.
17490	</desc>
17491	</attribute>
17492
17493	<attribute name="minPortCount" type="unsigned long" readonly="yes">
17494	<desc>
17495	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
17496	</desc>
17497	</attribute>
17498
17499	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
17500	<desc>
17501	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
17502	</desc>
17503	</attribute>
17504
17505	<attribute name="instance" type="unsigned long">
17506	<desc>
17507	The instance number of the device in the running VM.
17508	</desc>
17509	</attribute>
17510
17511	<attribute name="portCount" type="unsigned long">
17512	<desc>
17513	The number of currently usable ports on the controller.
17514	The minimum and maximum number of ports for one controller are
17515	stored in <link to="IStorageController::minPortCount"/>
17516	and <link to="IStorageController::maxPortCount"/>.
17517	</desc>
17518	</attribute>
17519
17520	<attribute name="bus" type="StorageBus" readonly="yes">
17521	<desc>
17522	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
17523	</desc>
17524	</attribute>
17525
17526	<attribute name="controllerType" type="StorageControllerType">
17527	<desc>
17528	The exact variant of storage controller hardware presented
17529	to the guest.
17530	Depending on this value, VirtualBox will provide a different
17531	virtual storage controller hardware to the guest.
17532	For SATA, SAS and floppy controllers, only one variant is
17533	available, but for IDE and SCSI, there are several.
17534
17535	For SCSI controllers, the default type is LsiLogic.
17536	</desc>
17537	</attribute>
17538
17539	<attribute name="useHostIOCache" type="boolean">
17540	<desc>
17541	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
17542	caches and use synchronous file APIs on the host. This was the only option in the API before
17543	VirtualBox 3.2 and is still the default for IDE controllers.
17544
17545	If false, the host I/O cache will be disabled for image files attached to this storage controller.
17546	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
17547	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
17548	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
17549	virtual machines are running at the same time to prevent I/O cache related hangs.
17550	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
17551	</desc>
17552	</attribute>
17553
17554	<attribute name="bootable" type="boolean" readonly="yes">
17555	<desc>
17556	Returns whether it is possible to boot from disks attached to this controller.
17557	</desc>
17558	</attribute>
17559
17560	<method name="getIDEEmulationPort">
17561	<desc>
17562	Gets the corresponding port number which is emulated as an IDE device.
17563	Works only with SATA controllers.
17564
17565	<result name="E_INVALIDARG">
17566	The @a devicePosition is not in the range 0 to 3.
17567	</result>
17568	<result name="E_NOTIMPL">
17569	The storage controller type is not SATAIntelAhci.
17570	</result>
17571
17572	</desc>
17573	<param name="devicePosition" type="long" dir="in"/>
17574	<param name="portNumber" type="long" dir="return"/>
17575	</method>
17576
17577	<method name="setIDEEmulationPort">
17578	<desc>
17579	Sets the port number which is emulated as an IDE device.
17580	Works only with SATA controllers.
17581
17582	<result name="E_INVALIDARG">
17583	The @a devicePosition is not in the range 0 to 3 or the
17584	@a portNumber is not in the range 0 to 29.
17585	</result>
17586	<result name="E_NOTIMPL">
17587	The storage controller type is not SATAIntelAhci.
17588	</result>
17589
17590	</desc>
17591	<param name="devicePosition" type="long" dir="in"/>
17592	<param name="portNumber" type="long" dir="in"/>
17593	</method>
17594
17595	</interface>
17596
17597	<if target="wsdl">
17598
17599	<!--
17600	// IManagedObjectRef
17601	/////////////////////////////////////////////////////////////////////////
17602	-->
17603
17604	<interface
17605	name="IManagedObjectRef" extends="$unknown"
17606	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
17607	internal="yes"
17608	wsmap="managed"
17609	wscpp="hardcoded"
17610	>
17611	<desc>
17612	Managed object reference.
17613
17614	Only within the webservice, a managed object reference (which is really
17615	an opaque number) allows a webservice client to address an object
17616	that lives in the address space of the webservice server.
17617
17618	Behind each managed object reference, there is a COM object that lives
17619	in the webservice server's address space. The COM object is not freed
17620	until the managed object reference is released, either by an explicit
17621	call to <link to="IManagedObjectRef::release" /> or by logging off from
17622	the webservice (<link to="IWebsessionManager::logoff" />), which releases
17623	all objects created during the webservice session.
17624
17625	Whenever a method call of the VirtualBox API returns a COM object, the
17626	webservice representation of that method will instead return a
17627	managed object reference, which can then be used to invoke methods
17628	on that object.
17629	</desc>
17630
17631	<method name="getInterfaceName">
17632	<desc>
17633	Returns the name of the interface that this managed object represents,
17634	for example, "IMachine", as a string.
17635	</desc>
17636	<param name="return" type="wstring" dir="return"/>
17637	</method>
17638
17639	<method name="release">
17640	<desc>
17641	Releases this managed object reference and frees the resources that
17642	were allocated for it in the webservice server process. After calling
17643	this method, the identifier of the reference can no longer be used.
17644	</desc>
17645	</method>
17646
17647	</interface>
17648
17649	<!--
17650	// IWebsessionManager
17651	/////////////////////////////////////////////////////////////////////////
17652	-->
17653
17654	<interface
17655	name="IWebsessionManager" extends="$unknown"
17656	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
17657	internal="yes"
17658	wsmap="global"
17659	wscpp="hardcoded"
17660	>
17661	<desc>
17662	Websession manager. This provides essential services
17663	to webservice clients.
17664	</desc>
17665	<method name="logon">
17666	<desc>
17667	Logs a new client onto the webservice and returns a managed object reference to
17668	the IVirtualBox instance, which the client can then use as a basis to further
17669	queries, since all calls to the VirtualBox API are based on the IVirtualBox
17670	interface, in one way or the other.
17671	</desc>
17672	<param name="username" type="wstring" dir="in"/>
17673	<param name="password" type="wstring" dir="in"/>
17674	<param name="return" type="IVirtualBox" dir="return"/>
17675	</method>
17676
17677	<method name="getSessionObject">
17678	<desc>
17679	Returns a managed object reference to the internal ISession object that was created
17680	for this web service session when the client logged on.
17681
17682	<see><link to="ISession"/></see>
17683	</desc>
17684	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17685	<param name="return" type="ISession" dir="return"/>
17686	</method>
17687
17688	<method name="logoff">
17689	<desc>
17690	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
17691	and destroys all resources associated with the session (most importantly, all
17692	managed objects created in the server while the session was active).
17693	</desc>
17694	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17695	</method>
17696
17697	</interface>
17698
17699	</if>
17700
17701	<!--
17702	// IPerformanceCollector & friends
17703	/////////////////////////////////////////////////////////////////////////
17704	-->
17705
17706	<interface
17707	name="IPerformanceMetric" extends="$unknown"
17708	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
17709	>
17710	<desc>
17711	The IPerformanceMetric interface represents parameters of the given
17712	performance metric.
17713	</desc>
17714
17715	<attribute name="metricName" type="wstring" readonly="yes">
17716	<desc>
17717	Name of the metric.
17718	</desc>
17719	</attribute>
17720
17721	<attribute name="object" type="$unknown" readonly="yes">
17722	<desc>
17723	Object this metric belongs to.
17724	</desc>
17725	</attribute>
17726
17727	<attribute name="description" type="wstring" readonly="yes">
17728	<desc>
17729	Textual description of the metric.
17730	</desc>
17731	</attribute>
17732
17733	<attribute name="period" type="unsigned long" readonly="yes">
17734	<desc>
17735	Time interval between samples, measured in seconds.
17736	</desc>
17737	</attribute>
17738
17739	<attribute name="count" type="unsigned long" readonly="yes">
17740	<desc>
17741	Number of recent samples retained by the performance collector for this
17742	metric.
17743
17744	When the collected sample count exceeds this number, older samples
17745	are discarded.
17746	</desc>
17747	</attribute>
17748
17749	<attribute name="unit" type="wstring" readonly="yes">
17750	<desc>
17751	Unit of measurement.
17752	</desc>
17753	</attribute>
17754
17755	<attribute name="minimumValue" type="long" readonly="yes">
17756	<desc>
17757	Minimum possible value of this metric.
17758	</desc>
17759	</attribute>
17760
17761	<attribute name="maximumValue" type="long" readonly="yes">
17762	<desc>
17763	Maximum possible value of this metric.
17764	</desc>
17765	</attribute>
17766	</interface>
17767
17768	<interface
17769	name="IPerformanceCollector" extends="$unknown"
17770	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
17771	wsmap="managed"
17772	>
17773	<desc>
17774	The IPerformanceCollector interface represents a service that collects
17775	and stores performance metrics data.
17776
17777	Performance metrics are associated with objects of interfaces like IHost
17778	and IMachine. Each object has a distinct set of performance metrics. The
17779	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
17780
17781	Metric data is collected at the specified intervals and is retained
17782	internally. The interval and the number of retained samples can be set
17783	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
17784	and collection settings are not persistent, they are discarded as soon as
17785	VBoxSVC process terminates. Moreover, metric settings and data associated
17786	with a particular VM only exist while VM is running. They disappear as
17787	soon as VM shuts down. It is not possible to set up metrics for machines
17788	that are powered off. One needs to start VM first, then set up metric
17789	collection parameters.
17790
17791	Metrics are organized hierarchically, with each level separated by a
17792	slash (/) character. Generally, the scheme for metric names is like this:
17793
17794	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
17795
17796	"Category/Metric" together form the base metric name. A base metric is
17797	the smallest unit for which a sampling interval and the number of
17798	retained samples can be set. Only base metrics can be enabled and
17799	disabled. All sub-metrics are collected when their base metric is
17800	collected. Collected values for any set of sub-metrics can be queried
17801	with <link to="IPerformanceCollector::queryMetricsData" />.
17802
17803	For example "CPU/Load/User:avg" metric name stands for the "CPU"
17804	category, "Load" metric, "User" submetric, "average" aggregate. An
17805	aggregate function is computed over all retained data. Valid aggregate
17806	functions are:
17807
17808	<ul>
17809	<li>avg -- average</li>
17810	<li>min -- minimum</li>
17811	<li>max -- maximum</li>
17812	</ul>
17813
17814	When setting up metric parameters, querying metric data, enabling or
17815	disabling metrics wildcards can be used in metric names to specify a
17816	subset of metrics. For example, to select all CPU-related metrics
17817	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
17818	so on. To query metric values without aggregates <tt>*:</tt> can be used.
17819
17820	The valid names for base metrics are:
17821
17822	<ul>
17823	<li>CPU/Load</li>
17824	<li>CPU/MHz</li>
17825	<li>RAM/Usage</li>
17826	<li>RAM/VMM</li>
17827	</ul>
17828
17829	The general sequence for collecting and retrieving the metrics is:
17830	<ul>
17831	<li>
17832	Obtain an instance of IPerformanceCollector with
17833	<link to="IVirtualBox::performanceCollector" />
17834	</li>
17835	<li>
17836	Allocate and populate an array with references to objects the metrics
17837	will be collected for. Use references to IHost and IMachine objects.
17838	</li>
17839	<li>
17840	Allocate and populate an array with base metric names the data will
17841	be collected for.
17842	</li>
17843	<li>
17844	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
17845	the metric data will be collected and stored.
17846	</li>
17847	<li>
17848	Wait for the data to get collected.
17849	</li>
17850	<li>
17851	Allocate and populate an array with references to objects the metric
17852	values will be queried for. You can re-use the object array used for
17853	setting base metrics.
17854	</li>
17855	<li>
17856	Allocate and populate an array with metric names the data will be
17857	collected for. Note that metric names differ from base metric names.
17858	</li>
17859	<li>
17860	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
17861	that have been collected so far are returned. Note that the values
17862	are still retained internally and data collection continues.
17863	</li>
17864	</ul>
17865
17866	For an example of usage refer to the following files in VirtualBox SDK:
17867	<ul>
17868	<li>
17869	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
17870	</li>
17871	<li>
17872	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
17873	</li>
17874	</ul>
17875	</desc>
17876
17877	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
17878	<desc>
17879	Array of unique names of metrics.
17880
17881	This array represents all metrics supported by the performance
17882	collector. Individual objects do not necessarily support all of them.
17883	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
17884	list of supported metrics for a particular object.
17885	</desc>
17886	</attribute>
17887
17888	<method name="getMetrics">
17889	<desc>
17890	Returns parameters of specified metrics for a set of objects.
17891	<note>
17892	@c Null metrics array means all metrics. @c Null object array means
17893	all existing objects.
17894	</note>
17895	</desc>
17896	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17897	<desc>
17898	Metric name filter. Currently, only a comma-separated list of metrics
17899	is supported.
17900	</desc>
17901	</param>
17902	<param name="objects" type="$unknown" dir="in" safearray="yes">
17903	<desc>
17904	Set of objects to return metric parameters for.
17905	</desc>
17906	</param>
17907	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
17908	<desc>
17909	Array of returned metric parameters.
17910	</desc>
17911	</param>
17912	</method>
17913
17914	<method name="setupMetrics">
17915	<desc>
17916	Sets parameters of specified base metrics for a set of objects. Returns
17917	an array of <link to="IPerformanceMetric" /> describing the metrics
17918	have been affected.
17919	<note>
17920	@c Null or empty metric name array means all metrics. @c Null or
17921	empty object array means all existing objects. If metric name array
17922	contains a single element and object array contains many, the single
17923	metric name array element is applied to each object array element to
17924	form metric/object pairs.
17925	</note>
17926	</desc>
17927	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17928	<desc>
17929	Metric name filter. Comma-separated list of metrics with wildcard
17930	support.
17931	</desc>
17932	</param>
17933	<param name="objects" type="$unknown" dir="in" safearray="yes">
17934	<desc>
17935	Set of objects to setup metric parameters for.
17936	</desc>
17937	</param>
17938	<param name="period" type="unsigned long" dir="in">
17939	<desc>
17940	Time interval in seconds between two consecutive samples of
17941	performance data.
17942	</desc>
17943	</param>
17944	<param name="count" type="unsigned long" dir="in">
17945	<desc>
17946	Number of samples to retain in performance data history. Older
17947	samples get discarded.
17948	</desc>
17949	</param>
17950	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17951	<desc>
17952	Array of metrics that have been modified by the call to this method.
17953	</desc>
17954	</param>
17955	</method>
17956
17957	<method name="enableMetrics">
17958	<desc>
17959	Turns on collecting specified base metrics. Returns an array of
17960	<link to="IPerformanceMetric" /> describing the metrics have been
17961	affected.
17962	<note>
17963	@c Null or empty metric name array means all metrics. @c Null or
17964	empty object array means all existing objects. If metric name array
17965	contains a single element and object array contains many, the single
17966	metric name array element is applied to each object array element to
17967	form metric/object pairs.
17968	</note>
17969	</desc>
17970	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17971	<desc>
17972	Metric name filter. Comma-separated list of metrics with wildcard
17973	support.
17974	</desc>
17975	</param>
17976	<param name="objects" type="$unknown" dir="in" safearray="yes">
17977	<desc>
17978	Set of objects to enable metrics for.
17979	</desc>
17980	</param>
17981	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17982	<desc>
17983	Array of metrics that have been modified by the call to this method.
17984	</desc>
17985	</param>
17986	</method>
17987
17988	<method name="disableMetrics">
17989	<desc>
17990	Turns off collecting specified base metrics. Returns an array of
17991	<link to="IPerformanceMetric" /> describing the metrics have been
17992	affected.
17993	<note>
17994	@c Null or empty metric name array means all metrics. @c Null or
17995	empty object array means all existing objects. If metric name array
17996	contains a single element and object array contains many, the single
17997	metric name array element is applied to each object array element to
17998	form metric/object pairs.
17999	</note>
18000	</desc>
18001	<param name="metricNames" type="wstring" dir="in" safearray="yes">
18002	<desc>
18003	Metric name filter. Comma-separated list of metrics with wildcard
18004	support.
18005	</desc>
18006	</param>
18007	<param name="objects" type="$unknown" dir="in" safearray="yes">
18008	<desc>
18009	Set of objects to disable metrics for.
18010	</desc>
18011	</param>
18012	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
18013	<desc>
18014	Array of metrics that have been modified by the call to this method.
18015	</desc>
18016	</param>
18017	</method>
18018
18019	<method name="queryMetricsData">
18020	<desc>
18021	Queries collected metrics data for a set of objects.
18022
18023	The data itself and related metric information are returned in seven
18024	parallel and one flattened array of arrays. Elements of
18025	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
18026	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
18027	the same index describe one set of values corresponding to a single
18028	metric.
18029
18030	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
18031	start and length of a sub-array is indicated by
18032	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
18033	value for metric <tt>metricNames[i]</tt> is at
18034	<tt>returnData[returnIndices[i]]</tt>.
18035
18036	<note>
18037	@c Null or empty metric name array means all metrics. @c Null or
18038	empty object array means all existing objects. If metric name array
18039	contains a single element and object array contains many, the single
18040	metric name array element is applied to each object array element to
18041	form metric/object pairs.
18042	</note>
18043	<note>
18044	Data collection continues behind the scenes after call to @c
18045	queryMetricsData. The return data can be seen as the snapshot of the
18046	current state at the time of @c queryMetricsData call. The internally
18047	kept metric values are not cleared by the call. This makes possible
18048	querying different subsets of metrics or aggregates with subsequent
18049	calls. If periodic querying is needed it is highly suggested to query
18050	the values with @c interval*count period to avoid confusion. This way
18051	a completely new set of data values will be provided by each query.
18052	</note>
18053	</desc>
18054	<param name="metricNames" type="wstring" dir="in" safearray="yes">
18055	<desc>
18056	Metric name filter. Comma-separated list of metrics with wildcard
18057	support.
18058	</desc>
18059	</param>
18060	<param name="objects" type="$unknown" dir="in" safearray="yes">
18061	<desc>
18062	Set of objects to query metrics for.
18063	</desc>
18064	</param>
18065	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
18066	<desc>
18067	Names of metrics returned in @c returnData.
18068	</desc>
18069	</param>
18070	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
18071	<desc>
18072	Objects associated with metrics returned in @c returnData.
18073	</desc>
18074	</param>
18075	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
18076	<desc>
18077	Units of measurement for each returned metric.
18078	</desc>
18079	</param>
18080	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
18081	<desc>
18082	Divisor that should be applied to return values in order to get
18083	floating point values. For example:
18084	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
18085	will retrieve the floating point value of i-th sample of the first
18086	metric.
18087	</desc>
18088	</param>
18089	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
18090	<desc>
18091	Sequence numbers of the first elements of value sequences of
18092	particular metrics returned in @c returnData. For aggregate metrics
18093	it is the sequence number of the sample the aggregate started
18094	calculation from.
18095	</desc>
18096	</param>
18097	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
18098	<desc>
18099	Indices of the first elements of value sequences of particular
18100	metrics returned in @c returnData.
18101	</desc>
18102	</param>
18103	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
18104	<desc>
18105	Lengths of value sequences of particular metrics.
18106	</desc>
18107	</param>
18108	<param name="returnData" type="long" dir="return" safearray="yes">
18109	<desc>
18110	Flattened array of all metric data containing sequences of values for
18111	each metric.
18112	</desc>
18113	</param>
18114	</method>
18115
18116	</interface>
18117
18118	<enum
18119	name="NATAliasMode"
18120	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
18121	>
18122	<desc></desc>
18123	<const name="AliasLog" value="0x1">
18124	<desc></desc>
18125	</const>
18126	<const name="AliasProxyOnly" value="0x02">
18127	<desc></desc>
18128	</const>
18129	<const name="AliasUseSamePorts" value="0x04">
18130	<desc></desc>
18131	</const>
18132	</enum>
18133
18134	<enum
18135	name="NATProtocol"
18136	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
18137	>
18138	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
18139	<const name="UDP" value="0">
18140	<desc>Port-forwarding uses UDP protocol.</desc>
18141	</const>
18142	<const name="TCP" value="1">
18143	<desc>Port-forwarding uses TCP protocol.</desc>
18144	</const>
18145	</enum>
18146
18147	<interface
18148	name="INATEngine" extends="$unknown"
18149	uuid="26451b99-3b2d-4dcb-8e4b-d63654218175"
18150	wsmap="managed"
18151	>
18152	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
18153	allows for changing NAT behavior such as port-forwarding rules. This interface is
18154	used in the <link to="INetworkAdapter::NATEngine" /> attribute.</desc>
18155	<attribute name="network" type="wstring">
18156	<desc>The network attribute of the NAT engine (the same value is used with built-in
18157	DHCP server to fill corresponding fields of DHCP leases).</desc>
18158	</attribute>
18159	<attribute name="hostIP" type="wstring">
18160	<desc>IP of host interface to bind all opened sockets to.
18161	<note>Changing this does not change binding of port forwarding.</note>
18162	</desc>
18163	</attribute>
18164	<attribute name="TFTPPrefix" type="wstring">
18165	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
18166	the corresponding fields of DHCP leases.</desc>
18167	</attribute>
18168	<attribute name="TFTPBootFile" type="wstring">
18169	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
18170	the corresponding fields of DHCP leases.</desc>
18171	</attribute>
18172	<attribute name="TFTPNextServer" type="wstring">
18173	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
18174	the corresponding fields of DHCP leases.
18175	<note>The preferred form is IPv4 addresses.</note>
18176	</desc>
18177	</attribute>
18178	<attribute name="aliasMode" type="unsigned long">
18179	<desc></desc>
18180	</attribute>
18181	<attribute name="DNSPassDomain" type="boolean">
18182	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
18183	</attribute>
18184	<attribute name="DNSProxy" type="boolean">
18185	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18186	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
18187	</attribute>
18188	<attribute name="DNSUseHostResolver" type="boolean">
18189	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18190	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
18191	</attribute>
18192	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
18193	<desc>Array of NAT port-forwarding rules in string representation, in the following
18194	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
18195	</attribute>
18196	<method name="setNetworkSettings">
18197	<desc>Sets network configuration of the NAT engine.</desc>
18198	<param name="mtu" type="unsigned long" dir="in">
18199	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
18200	</param>
18201	<param name="sockSnd" type="unsigned long" dir="in">
18202	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
18203	</param>
18204	<param name="sockRcv" type="unsigned long" dir="in">
18205	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
18206	</param>
18207	<param name="TcpWndSnd" type="unsigned long" dir="in">
18208	<desc>Initial size of the NAT engine's sending TCP window in bytes when
18209	establishing a new TCP connection.</desc>
18210	</param>
18211	<param name="TcpWndRcv" type="unsigned long" dir="in">
18212	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
18213	establishing a new TCP connection.</desc>
18214	</param>
18215	</method>
18216	<method name="getNetworkSettings">
18217	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
18218	for parameter descriptions.</desc>
18219	<param name="mtu" type="unsigned long" dir="out" />
18220	<param name="sockSnd" type="unsigned long" dir="out" />
18221	<param name="sockRcv" type="unsigned long" dir="out" />
18222	<param name="TcpWndSnd" type="unsigned long" dir="out" />
18223	<param name="TcpWndRcv" type="unsigned long" dir="out" />
18224	</method>
18225	<method name="addRedirect">
18226	<desc>Adds a new NAT port-forwarding rule.</desc>
18227	<param name="name" type="wstring" dir="in">
18228	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
18229	auto-generates one using the other parameters.</desc>
18230	</param>
18231	<param name="proto" type="NATProtocol" dir="in">
18232	<desc>Protocol handled with the rule.</desc>
18233	</param>
18234	<param name="hostIP" type="wstring" dir="in">
18235	<desc>IP of the host interface to which the rule should apply. An empty ip address is
18236	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
18237	</param>
18238	<param name="hostPort" type="unsigned short" dir="in">
18239	<desc>The port number to listen on.</desc>
18240	</param>
18241	<param name="guestIP" type="wstring" dir="in">
18242	<desc>The IP address of the guest which the NAT engine will forward matching packets
18243	to. An empty IP address is acceptable, in which case the NAT engine will forward
18244	packets to the first DHCP lease (x.x.x.15).</desc>
18245	</param>
18246	<param name="guestPort" type="unsigned short" dir="in">
18247	<desc>The port number to forward.</desc>
18248	</param>
18249	</method>
18250	<method name="removeRedirect">
18251	<desc>Removes a port-forwarding rule that was previously registered.</desc>
18252	<param name="name" type="wstring" dir="in">
18253	<desc>The name of the rule to delete.</desc>
18254	</param>
18255	</method>
18256	</interface>
18257
18258	<!--
18259	// IExtPackManager
18260	/////////////////////////////////////////////////////////////////////////
18261	-->
18262
18263	<interface
18264	name="IExtPackPlugIn" extends="$unknown"
18265	uuid="58000040-e718-4746-bbce-4b86d96da461"
18266	wsmap="suppress"
18267	>
18268	<desc>
18269	Interface for keeping information about a plug-in that ships with an
18270	extension pack.
18271	</desc>
18272	<attribute name="name" type="wstring" readonly="yes">
18273	<desc>The plug-in name.</desc>
18274	</attribute>
18275	<attribute name="description" type="wstring" readonly="yes">
18276	<desc>The plug-in description.</desc>
18277	</attribute>
18278	<attribute name="frontend" type="wstring" readonly="yes">
18279	<desc>
18280	The name of the frontend or component name this plug-in plugs into.
18281	</desc>
18282	</attribute>
18283	<attribute name="modulePath" type="wstring" readonly="yes">
18284	<desc> The module path. </desc>
18285	</attribute>
18286	</interface>
18287
18288	<interface
18289	name="IExtPackBase" extends="$unknown"
18290	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
18291	wsmap="suppress"
18292	>
18293	<desc>
18294	Interface for querying information about an extension pack as well as
18295	accessing COM objects within it.
18296	</desc>
18297	<attribute name="name" type="wstring" readonly="yes">
18298	<desc>The extension pack name. This is unique.</desc>
18299	</attribute>
18300	<attribute name="description" type="wstring" readonly="yes">
18301	<desc>The extension pack description.</desc>
18302	</attribute>
18303	<attribute name="version" type="wstring" readonly="yes">
18304	<desc>
18305	The extension pack version string. This is restricted to the dotted
18306	version number and optionally a build indicator. No tree revision or
18307	tag will be included in the string as those things are available as
18308	separate properties. An optional publisher tag may be present like for
18309	<link to="IVirtualBox::version"/>.
18310
18311	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
18312	</desc>
18313	</attribute>
18314	<attribute name="revision" type="unsigned long" readonly="yes">
18315	<desc>The extension pack internal revision number.</desc>
18316	</attribute>
18317	<attribute name="edition" type="wstring" readonly="yes">
18318	<desc>
18319	Edition indicator. This is usually empty.
18320
18321	Can for instance be used to help distinguishing between two editions
18322	of the same extension pack where only the license, service contract or
18323	something differs.
18324	</desc>
18325	</attribute>
18326	<attribute name="VRDEModule" type="wstring" readonly="yes">
18327	<desc>The name of the VRDE module if the extension pack sports one.</desc>
18328	</attribute>
18329	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
18330	<desc>Plug-ins provided by this extension pack.</desc>
18331	</attribute>
18332	<attribute name="usable" type="boolean" readonly="yes">
18333	<desc>
18334	Indicates whether the extension pack is usable or not.
18335
18336	There are a number of reasons why an extension pack might be unusable,
18337	typical examples would be broken installation/file or that it is
18338	incompatible with the current VirtualBox version.
18339	</desc>
18340	</attribute>
18341	<attribute name="whyUnusable" type="wstring" readonly="yes">
18342	<desc>
18343	String indicating why the extension pack is not usable. This is an
18344	empty string if usable and always a non-empty string if not usable.
18345	</desc>
18346	</attribute>
18347	<attribute name="showLicense" type="boolean" readonly="yes">
18348	<desc>Whether to show the license before installation</desc>
18349	</attribute>
18350	<attribute name="license" type="wstring" readonly="yes">
18351	<desc>
18352	The default HTML license text for the extension pack. Same as
18353	calling <link to="#queryLicense">queryLicense</link> with
18354	preferredLocale and preferredLanguage as empty strings and format set
18355	to html.
18356	</desc>
18357	</attribute>
18358
18359	<method name="queryLicense">
18360	<desc>
18361	Full feature version of the license attribute.
18362	</desc>
18363	<param name="preferredLocale" type="wstring" dir="in">
18364	<desc>
18365	The preferred license locale. Pass an empty string to get the default
18366	license.
18367	</desc>
18368	</param>
18369	<param name="preferredLanguage" type="wstring" dir="in">
18370	<desc>
18371	The preferred license language. Pass an empty string to get the
18372	default language for the locale.
18373	</desc>
18374	</param>
18375	<param name="format" type="wstring" dir="in">
18376	<desc>
18377	The license format: html, rtf or txt. If a license is present there
18378	will always be an HTML of it, the rich text format (RTF) and plain
18379	text (txt) versions are optional. If
18380	</desc>
18381	</param>
18382	<param name="licenseText" type="wstring" dir="return">
18383	<desc>The license text.</desc>
18384	</param>
18385	</method>
18386
18387	</interface>
18388
18389	<interface
18390	name="IExtPack" extends="IExtPackBase"
18391	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
18392	wsmap="suppress"
18393	>
18394	<desc>
18395	Interface for querying information about an extension pack as well as
18396	accessing COM objects within it.
18397	</desc>
18398	<method name="queryObject">
18399	<desc>
18400	Queries the IUnknown interface to an object in the extension pack
18401	main module. This allows plug-ins and others to talk directly to an
18402	extension pack.
18403	</desc>
18404	<param name="objUuid" type="wstring" dir="in">
18405	<desc>The object ID. What exactly this is </desc>
18406	</param>
18407	<param name="returnInterface" type="$unknown" dir="return">
18408	<desc>The queried interface.</desc>
18409	</param>
18410	</method>
18411	</interface>
18412
18413	<interface
18414	name="IExtPackFile" extends="IExtPackBase"
18415	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
18416	wsmap="suppress"
18417	>
18418	<desc>
18419	Extension pack file (aka tarball, .vbox-extpack) representation returned
18420	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
18421	extension pack information with the addition of the file name.
18422	</desc>
18423	<attribute name="filePath" type="wstring" readonly="yes">
18424	<desc>
18425	The path to the extension pack file.
18426	</desc>
18427	</attribute>
18428
18429	<method name="install">
18430	<desc>
18431	Install the extension pack.
18432	</desc>
18433	<param name="replace" type="boolean" dir="in">
18434	<desc>
18435	Set this to automatically uninstall any existing extension pack with
18436	the same name as the one being installed.
18437	</desc>
18438	</param>
18439	<param name="displayInfo" type="wstring" dir="in">
18440	<desc>
18441	Platform specific display information. Reserved for future hacks.
18442	</desc>
18443	</param>
18444	<param name="progess" type="IProgress" dir="return">
18445	<desc>
18446	Progress object for the operation.
18447	</desc>
18448	</param>
18449	</method>
18450	</interface>
18451
18452	<interface
18453	name="IExtPackManager" extends="$unknown"
18454	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
18455	wsmap="suppress"
18456	>
18457	<desc>
18458	Interface for managing VirtualBox Extension Packs.
18459
18460	TODO: Describe extension packs, how they are managed and how to create
18461	one.
18462	</desc>
18463
18464	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
18465	<desc>
18466	List of the installed extension packs.
18467	</desc>
18468	</attribute>
18469
18470	<method name="find">
18471	<desc>
18472	Returns the extension pack with the specified name if found.
18473
18474	<result name="VBOX_E_OBJECT_NOT_FOUND">
18475	No extension pack matching @a name was found.
18476	</result>
18477	</desc>
18478	<param name="name" type="wstring" dir="in">
18479	<desc>The name of the extension pack to locate.</desc>
18480	</param>
18481	<param name="returnData" type="IExtPack" dir="return">
18482	<desc>The extension pack if found.</desc>
18483	</param>
18484	</method>
18485
18486	<method name="openExtPackFile">
18487	<desc>
18488	Attempts to open an extension pack file in preparation for
18489	installation.
18490	</desc>
18491	<param name="path" type="wstring" dir="in">
18492	<desc>The path of the extension pack tarball. This can optionally be
18493	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
18494	</param>
18495	<param name="file" type="IExtPackFile" dir="return">
18496	<desc>The interface of the extension pack file object.</desc>
18497	</param>
18498	</method>
18499
18500	<method name="uninstall">
18501	<desc>Uninstalls an extension pack, removing all related files.</desc>
18502	<param name="name" type="wstring" dir="in">
18503	<desc>The name of the extension pack to uninstall.</desc>
18504	</param>
18505	<param name="forcedRemoval" type="boolean" dir="in">
18506	<desc>
18507	Forced removal of the extension pack. This means that the uninstall
18508	hook will not be called.
18509	</desc>
18510	</param>
18511	<param name="displayInfo" type="wstring" dir="in">
18512	<desc>
18513	Platform specific display information. Reserved for future hacks.
18514	</desc>
18515	</param>
18516	<param name="progess" type="IProgress" dir="return">
18517	<desc>
18518	Progress object for the operation.
18519	</desc>
18520	</param>
18521	</method>
18522
18523	<method name="cleanup">
18524	<desc>Cleans up failed installs and uninstalls</desc>
18525	</method>
18526
18527	<method name="queryAllPlugInsForFrontend">
18528	<desc>
18529	Gets the path to all the plug-in modules for a given frontend.
18530
18531	This is a convenience method that is intended to simplify the plug-in
18532	loading process for a frontend.
18533	</desc>
18534	<param name="frontendName" type="wstring" dir="in">
18535	<desc>The name of the frontend or component.</desc>
18536	</param>
18537	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
18538	<desc>Array containing the plug-in modules (full paths).</desc>
18539	</param>
18540	</method>
18541
18542	<method name="isExtPackUsable">
18543	<desc>Check if the given extension pack is loaded and usable.</desc>
18544	<param name="name" type="wstring" dir="in">
18545	<desc>The name of the extension pack to check for.</desc>
18546	</param>
18547	<param name="usable" type="boolean" dir="return">
18548	<desc>Is the given extension pack loaded and usable.</desc>
18549	</param>
18550	</method>
18551
18552	</interface>
18553
18554	<!--
18555	// BandwidthGroupType
18556	/////////////////////////////////////////////////////////////////////////
18557	-->
18558	<enum
18559	name="BandwidthGroupType"
18560	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
18561
18562	<desc>
18563	Type of a bandwidth control group.
18564	</desc>
18565
18566	<const name="Null" value="0">
18567	<desc>
18568	Null type, must be first.
18569	</desc>
18570	</const>
18571
18572	<const name="Disk" value="1">
18573	<desc>
18574	The bandwidth group controls disk I/O.
18575	</desc>
18576	</const>
18577
18578	<const name="Network" value="2">
18579	<desc>
18580	The bandwidth group controls network I/O.
18581	</desc>
18582	</const>
18583
18584	</enum>
18585
18586	<!--
18587	// IBandwidthGroup
18588	/////////////////////////////////////////////////////////////////////////
18589	-->
18590	<interface
18591	name="IBandwidthGroup" extends="$unknown"
18592	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
18593	wsmap="managed"
18594	>
18595	<desc>Represents one bandwidth group.</desc>
18596
18597	<attribute name="name" type="wstring" readonly="yes">
18598	<desc>Name of the group.</desc>
18599	</attribute>
18600
18601	<attribute name="type" type="BandwidthGroupType" readonly="yes">
18602	<desc>Type of the group.</desc>
18603	</attribute>
18604
18605	<attribute name="reference" type="unsigned long" readonly="yes">
18606	<desc>How many devices/medium attachements use this group.</desc>
18607	</attribute>
18608
18609	<attribute name="maxBytesPerSec" type="long long">
18610	<desc>The maximum number of bytes which can be transfered by all
18611	entities attached to this group during one second.</desc>
18612	</attribute>
18613
18614	</interface>
18615
18616	<!--
18617	// IBandwidthControl
18618	/////////////////////////////////////////////////////////////////////////
18619	-->
18620	<interface
18621	name="IBandwidthControl" extends="$unknown"
18622	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
18623	wsmap="managed"
18624	>
18625	<desc>
18626	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
18627	This includes network and disk I/O.
18628	</desc>
18629
18630	<attribute name="numGroups" type="unsigned long" readonly="yes">
18631	<desc>
18632	The current number of existing bandwidth groups managed.
18633	</desc>
18634	</attribute>
18635
18636	<method name="createBandwidthGroup">
18637	<desc>
18638	Creates a new bandwidth group.
18639	</desc>
18640
18641	<param name="name" type="wstring" dir="in">
18642	<desc>Name of the bandwidth group.</desc>
18643	</param>
18644	<param name="type" type="BandwidthGroupType" dir="in">
18645	<desc>The type of the bandwidth group (network or disk).</desc>
18646	</param>
18647	<param name="maxBytesPerSec" type="long long" dir="in">
18648	<desc>The maximum number of bytes which can be transfered by all
18649	entities attached to this group during one second.</desc>
18650	</param>
18651	</method>
18652
18653	<method name="deleteBandwidthGroup">
18654	<desc>
18655	Deletes a new bandwidth group.
18656	</desc>
18657
18658	<param name="name" type="wstring" dir="in">
18659	<desc>Name of the bandwidth group to delete.</desc>
18660	</param>
18661	</method>
18662
18663	<method name="getBandwidthGroup" const="yes">
18664	<desc>
18665	Get a bandwidth group by name.
18666	</desc>
18667
18668	<param name="name" type="wstring" dir="in">
18669	<desc>Name of the bandwidth group to get.</desc>
18670	</param>
18671	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
18672	<desc>Where to store the bandwidth group on success.</desc>
18673	</param>
18674	</method>
18675
18676	<method name="getAllBandwidthGroups" const="yes">
18677	<desc>
18678	Get all managed bandwidth groups.
18679	</desc>
18680
18681	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
18682	<desc>The array of managed bandwidth groups.</desc>
18683	</param>
18684	</method>
18685	</interface>
18686
18687	<!--
18688	// IVirtualBoxClient
18689	/////////////////////////////////////////////////////////////////////////
18690	-->
18691
18692	<interface
18693	name="IVirtualBoxClient" extends="$unknown"
18694	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
18695	wsmap="suppress"
18696	>
18697	<desc>
18698	Convenience interface for client applications. Treat this as a
18699	singleton, i.e. never create more than one instance of this interface.
18700
18701	At the moment only available for clients of the local API (not usable
18702	via the webservice). Once the session logic is redesigned this might
18703	change.
18704	</desc>
18705
18706	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
18707	<desc>
18708	Reference to the server-side API root object.
18709	</desc>
18710	</attribute>
18711
18712	<attribute name="session" type="ISession" readonly="yes">
18713	<desc>
18714	Create a new session object and return the reference to it.
18715	</desc>
18716	</attribute>
18717
18718	<attribute name="eventSource" type="IEventSource" readonly="yes">
18719	<desc>
18720	Event source for VirtualBoxClient events.
18721	</desc>
18722	</attribute>
18723
18724	</interface>
18725
18726	<!--
18727	// Events
18728	/////////////////////////////////////////////////////////////////////////
18729	-->
18730	<enum
18731	name="VBoxEventType"
18732	uuid="0d67e79e-b7b1-4919-aab3-b36866075515"
18733	>
18734
18735	<desc>
18736	Type of an event.
18737	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18738	</desc>
18739
18740	<const name="Invalid" value="0">
18741	<desc>
18742	Invalid event, must be first.
18743	</desc>
18744	</const>
18745
18746	<const name="Any" value="1">
18747	<desc>
18748	Wildcard for all events.
18749	Events of this type are never delivered, and only used in
18750	<link to="IEventSource::registerListener"/> call to simplify registration.
18751	</desc>
18752	</const>
18753
18754	<const name="Vetoable" value="2">
18755	<desc>
18756	Wildcard for all vetoable events. Events of this type are never delivered, and only
18757	used in <link to="IEventSource::registerListener"/> call to simplify registration.
18758	</desc>
18759	</const>
18760
18761	<const name="MachineEvent" value="3">
18762	<desc>
18763	Wildcard for all machine events. Events of this type are never delivered, and only used in
18764	<link to="IEventSource::registerListener"/> call to simplify registration.
18765	</desc>
18766	</const>
18767
18768	<const name="SnapshotEvent" value="4">
18769	<desc>
18770	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
18771	<link to="IEventSource::registerListener"/> call to simplify registration.
18772	</desc>
18773	</const>
18774
18775	<const name="InputEvent" value="5">
18776	<desc>
18777	Wildcard for all input device (keyboard, mouse) events.
18778	Events of this type are never delivered, and only used in
18779	<link to="IEventSource::registerListener"/> call to simplify registration.
18780	</desc>
18781	</const>
18782
18783	<const name="LastWildcard" value="31">
18784	<desc>
18785	Last wildcard.
18786	</desc>
18787	</const>
18788
18789	<const name="OnMachineStateChanged" value="32">
18790	<desc>
18791	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
18792	</desc>
18793	</const>
18794	<const name="OnMachineDataChanged" value="33">
18795	<desc>
18796	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
18797	</desc>
18798	</const>
18799	<const name="OnExtraDataChanged" value="34">
18800	<desc>
18801	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
18802	</desc>
18803	</const>
18804	<const name="OnExtraDataCanChange" value="35">
18805	<desc>
18806	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
18807	</desc>
18808	</const>
18809	<const name="OnMediumRegistered" value="36">
18810	<desc>
18811	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
18812	</desc>
18813	</const>
18814	<const name="OnMachineRegistered" value="37">
18815	<desc>
18816	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
18817	</desc>
18818	</const>
18819	<const name="OnSessionStateChanged" value="38">
18820	<desc>
18821	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
18822	</desc>
18823	</const>
18824	<const name="OnSnapshotTaken" value="39">
18825	<desc>
18826	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
18827	</desc>
18828	</const>
18829	<const name="OnSnapshotDeleted" value="40">
18830	<desc>
18831	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
18832	</desc>
18833	</const>
18834	<const name="OnSnapshotChanged" value="41">
18835	<desc>
18836	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
18837	</desc>
18838	</const>
18839	<const name="OnGuestPropertyChanged" value="42">
18840	<desc>
18841	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
18842	</desc>
18843	</const>
18844	<!-- Console events -->
18845	<const name="OnMousePointerShapeChanged" value="43">
18846	<desc>
18847	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
18848	</desc>
18849	</const>
18850	<const name="OnMouseCapabilityChanged" value="44">
18851	<desc>
18852	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
18853	</desc>
18854	</const>
18855	<const name="OnKeyboardLedsChanged" value="45">
18856	<desc>
18857	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
18858	</desc>
18859	</const>
18860	<const name="OnStateChanged" value="46">
18861	<desc>
18862	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
18863	</desc>
18864	</const>
18865	<const name="OnAdditionsStateChanged" value="47">
18866	<desc>
18867	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
18868	</desc>
18869	</const>
18870	<const name="OnNetworkAdapterChanged" value="48">
18871	<desc>
18872	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
18873	</desc>
18874	</const>
18875	<const name="OnSerialPortChanged" value="49">
18876	<desc>
18877	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
18878	</desc>
18879	</const>
18880	<const name="OnParallelPortChanged" value="50">
18881	<desc>
18882	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
18883	</desc>
18884	</const>
18885	<const name="OnStorageControllerChanged" value="51">
18886	<desc>
18887	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
18888	</desc>
18889	</const>
18890	<const name="OnMediumChanged" value="52">
18891	<desc>
18892	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
18893	</desc>
18894	</const>
18895	<const name="OnVRDEServerChanged" value="53">
18896	<desc>
18897	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
18898	</desc>
18899	</const>
18900	<const name="OnUSBControllerChanged" value="54">
18901	<desc>
18902	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
18903	</desc>
18904	</const>
18905	<const name="OnUSBDeviceStateChanged" value="55">
18906	<desc>
18907	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
18908	</desc>
18909	</const>
18910	<const name="OnSharedFolderChanged" value="56">
18911	<desc>
18912	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
18913	</desc>
18914	</const>
18915	<const name="OnRuntimeError" value="57">
18916	<desc>
18917	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
18918	</desc>
18919	</const>
18920	<const name="OnCanShowWindow" value="58">
18921	<desc>
18922	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
18923	</desc>
18924	</const>
18925	<const name="OnShowWindow" value="59">
18926	<desc>
18927	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
18928	</desc>
18929	</const>
18930	<const name="OnCPUChanged" value="60">
18931	<desc>
18932	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
18933	</desc>
18934	</const>
18935	<const name="OnVRDEServerInfoChanged" value="61">
18936	<desc>
18937	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
18938	</desc>
18939	</const>
18940	<const name="OnEventSourceChanged" value="62">
18941	<desc>
18942	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
18943	</desc>
18944	</const>
18945	<const name="OnCPUExecutionCapChanged" value="63">
18946	<desc>
18947	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
18948	</desc>
18949	</const>
18950	<const name="OnGuestKeyboard" value="64">
18951	<desc>
18952	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
18953	</desc>
18954	</const>
18955	<const name="OnGuestMouse" value="65">
18956	<desc>
18957	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
18958	</desc>
18959	</const>
18960	<const name="OnNATRedirect" value="66">
18961	<desc>
18962	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
18963	</desc>
18964	</const>
18965	<const name="OnHostPCIDevicePlug" value="67">
18966	<desc>
18967	See <link to="IHostPCIDevicePlugEvent">IHostPCIDevicePlugEvent</link>.
18968	</desc>
18969	</const>
18970	<const name="OnVBoxSVCAvailabilityChanged" value="68">
18971	<desc>
18972	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
18973	</desc>
18974	</const>
18975	<const name="OnBandwidthGroupChanged" value="69">
18976	<desc>
18977	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
18978	</desc>
18979	</const>
18980	<const name="OnGuestMonitorChanged" value="70">
18981	<desc>
18982	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
18983	</desc>
18984	</const>
18985	<const name="OnStorageDeviceChanged" value="71">
18986	<desc>
18987	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
18988	</desc>
18989	</const>
18990	<const name="OnClipboardModeChanged" value="72">
18991	<desc>
18992	See <link to="IClipboardModeChangedEvent">IClipboardModeChangedEvent</link>.
18993	</desc>
18994	</const>
18995	<const name="OnDragAndDropModeChanged" value="73">
18996	<desc>
18997	See <link to="IDragAndDropModeChangedEvent">IDragAndDropModeChangedEvent</link>.
18998	</desc>
18999	</const>
19000
19001	<!-- Last event marker -->
19002	<const name="Last" value="74">
19003	<desc>
19004	Must be last event, used for iterations and structures relying on numerical event values.
19005	</desc>
19006	</const>
19007
19008	</enum>
19009
19010	<interface
19011	name="IEventSource" extends="$unknown"
19012	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
19013	wsmap="managed"
19014	>
19015	<desc>
19016	Event source. Generally, any object which could generate events can be an event source,
19017	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
19018	an event source can work with listeners in either active or passive mode. In active mode it is up to
19019	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
19020	event source keeps track of pending events for each listener and returns available events on demand.
19021
19022	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
19023	</desc>
19024
19025	<method name="createListener">
19026	<desc>
19027	Creates a new listener object, useful for passive mode.
19028	</desc>
19029	<param name="listener" type="IEventListener" dir="return"/>
19030	</method>
19031
19032	<method name="createAggregator">
19033	<desc>
19034	Creates an aggregator event source, collecting events from multiple sources.
19035	This way a single listener can listen for events coming from multiple sources,
19036	using a single blocking <link to="#getEvent"/> on the returned aggregator.
19037	</desc>
19038	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
19039	<desc>
19040	Subordinate event source this one aggregatres.
19041	</desc>
19042	</param>
19043	<param name="result" type="IEventSource" dir="return">
19044	<desc>
19045	Event source aggregating passed sources.
19046	</desc>
19047	</param>
19048	</method>
19049
19050	<method name="registerListener">
19051	<desc>
19052	Register an event listener.
19053
19054	<note>
19055	To avoid system overload, the VirtualBox server process checks if passive event
19056	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
19057	current implementation, if more than 500 pending events are detected for a passive
19058	event listener, it is forcefully unregistered by the system, and further
19059	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
19060	</note>
19061	</desc>
19062	<param name="listener" type="IEventListener" dir="in">
19063	<desc>Listener to register.</desc>
19064	</param>
19065	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
19066	<desc>
19067	Event types listener is interested in. One can use wildcards like -
19068	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
19069	than one event.
19070	</desc>
19071	</param>
19072	<param name="active" type="boolean" dir="in">
19073	<desc>
19074	Which mode this listener is operating in.
19075	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
19076	In passive mode, an internal event queue is created for this this IEventListener.
19077	For each event coming in, it is added to queues for all interested registered passive
19078	listeners. It is then up to the external code to call the listener's
19079	<link to="IEventListener::handleEvent" /> method. When done with an event, the
19080	external code must call <link to="#eventProcessed" />.
19081	</desc>
19082	</param>
19083	</method>
19084
19085	<method name="unregisterListener">
19086	<desc>
19087	Unregister an event listener. If listener is passive, and some waitable events are still
19088	in queue they are marked as processed automatically.
19089	</desc>
19090	<param name="listener" type="IEventListener" dir="in">
19091	<desc>Listener to unregister.</desc>
19092	</param>
19093	</method>
19094
19095	<method name="fireEvent">
19096	<desc>
19097	Fire an event for this source.
19098	</desc>
19099	<param name="event" type="IEvent" dir="in">
19100	<desc>Event to deliver.</desc>
19101	</param>
19102	<param name="timeout" type="long" dir="in">
19103	<desc>
19104	Maximum time to wait for event processing (if event is waitable), in ms;
19105	0 = no wait, -1 = indefinite wait.
19106	</desc>
19107	</param>
19108	<param name="result" type="boolean" dir="return">
19109	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
19110	</param>
19111	</method>
19112
19113	<method name="getEvent">
19114	<desc>
19115	Get events from this peer's event queue (for passive mode). Calling this method
19116	regularly is required for passive event listeners to avoid system overload;
19117	see <link to="IEventSource::registerListener" /> for details.
19118
19119	<result name="VBOX_E_OBJECT_NOT_FOUND">
19120	Listener is not registered, or autounregistered.
19121	</result>
19122	</desc>
19123	<param name="listener" type="IEventListener" dir="in">
19124	<desc>Which listener to get data for.</desc>
19125	</param>
19126	<param name="timeout" type="long" dir="in">
19127	<desc>
19128	Maximum time to wait for events, in ms;
19129	0 = no wait, -1 = indefinite wait.
19130	</desc>
19131	</param>
19132	<param name="event" type="IEvent" dir="return">
19133	<desc>Event retrieved, or null if none available.</desc>
19134	</param>
19135	</method>
19136
19137	<method name="eventProcessed">
19138	<desc>
19139	Must be called for waitable events after a particular listener finished its
19140	event processing. When all listeners of a particular event have called this
19141	method, the system will then call <link to="IEvent::setProcessed" />.
19142	</desc>
19143	<param name="listener" type="IEventListener" dir="in">
19144	<desc>Which listener processed event.</desc>
19145	</param>
19146	<param name="event" type="IEvent" dir="in">
19147	<desc>Which event.</desc>
19148	</param>
19149	</method>
19150
19151	</interface>
19152
19153	<interface
19154	name="IEventListener" extends="$unknown"
19155	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
19156	wsmap="managed"
19157	>
19158	<desc>
19159	Event listener. An event listener can work in either active or passive mode, depending on the way
19160	it was registered.
19161	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
19162	</desc>
19163
19164	<method name="handleEvent">
19165	<desc>
19166	Handle event callback for active listeners. It is not called for
19167	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
19168	and having received acknowledgement from all passive listeners via
19169	<link to="IEventSource::eventProcessed"/>, the event is marked as
19170	processed and <link to="IEvent::waitProcessed"/> will return
19171	immediately.
19172	</desc>
19173	<param name="event" type="IEvent" dir="in">
19174	<desc>Event available.</desc>
19175	</param>
19176	</method>
19177
19178	</interface>
19179
19180	<interface
19181	name="IEvent" extends="$unknown"
19182	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
19183	wsmap="managed"
19184	>
19185	<desc>
19186	Abstract parent interface for VirtualBox events. Actual events will typically implement
19187	a more specific interface which derives from this (see below).
19188
19189	<b>Introduction to VirtualBox events</b>
19190
19191	Generally speaking, an event (represented by this interface) signals that something
19192	happened, while an event listener (see <link to="IEventListener" />) represents an
19193	entity that is interested in certain events. In order for this to work with
19194	unidirectional protocols (i.e. web services), the concepts of passive and active
19195	listener are used.
19196
19197	Event consumers can register themselves as listeners, providing an array of
19198	events they are interested in (see <link to="IEventSource::registerListener" />).
19199	When an event triggers, the listener is notified about the event. The exact
19200	mechanism of the notification depends on whether the listener was registered as
19201	an active or passive listener:
19202
19203	<ul>
19204	<li>An active listener is very similar to a callback: it is a function invoked
19205	by the API. As opposed to the callbacks that were used in the API before
19206	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
19207	</li>
19208
19209	<li>Passive listeners are somewhat trickier to implement, but do not require
19210	a client function to be callable, which is not an option with scripting
19211	languages or web service clients. Internally the <link to="IEventSource" />
19212	implementation maintains an event queue for each passive listener, and
19213	newly arrived events are put in this queue. When the listener calls
19214	<link to="IEventSource::getEvent"/>, first element from its internal event
19215	queue is returned. When the client completes processing of an event,
19216	the <link to="IEventSource::eventProcessed" /> function must be called,
19217	acknowledging that the event was processed. It supports implementing
19218	waitable events. On passive listener unregistration, all events from its
19219	queue are auto-acknowledged.
19220	</li>
19221	</ul>
19222
19223	Waitable events are useful in situations where the event generator wants to track
19224	delivery or a party wants to wait until all listeners have completed the event. A
19225	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
19226	listeners might veto a certain action, and thus the event producer has to make
19227	sure that all listeners have processed the event and not vetoed before taking
19228	the action.
19229
19230	A given event may have both passive and active listeners at the same time.
19231
19232	<b>Using events</b>
19233
19234	Any VirtualBox object capable of producing externally visible events provides an
19235	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
19236	This event source object is notified by VirtualBox once something has happened, so
19237	consumers may register event listeners with this event source. To register a listener,
19238	an object implementing the <link to="IEventListener" /> interface must be provided.
19239	For active listeners, such an object is typically created by the consumer, while for
19240	passive listeners <link to="IEventSource::createListener" /> should be used. Please
19241	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
19242
19243	Once created, the listener must be registered to listen for the desired events
19244	(see <link to="IEventSource::registerListener" />), providing an array of
19245	<link to="VBoxEventType" /> enums. Those elements can either be the individual
19246	event IDs or wildcards matching multiple event IDs.
19247
19248	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
19249	called automatically when the event is triggered, while passive listeners have to call
19250	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
19251	an event processing loop.
19252
19253	The IEvent interface is an abstract parent interface for all such VirtualBox events
19254	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
19255	or the event processing loop is to check the <link to="#type" /> attribute of the event and
19256	then cast to the appropriate specific interface using @c QueryInterface().
19257	</desc>
19258
19259	<attribute name="type" readonly="yes" type="VBoxEventType">
19260	<desc>
19261	Event type.
19262	</desc>
19263	</attribute>
19264
19265	<attribute name="source" readonly="yes" type="IEventSource">
19266	<desc>
19267	Source of this event.
19268	</desc>
19269	</attribute>
19270
19271	<attribute name="waitable" readonly="yes" type="boolean">
19272	<desc>
19273	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
19274	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
19275	as no additional overhead associated with waitability imposed.
19276	Waitable events are needed when one need to be able to wait for particular event processed,
19277	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
19278	until all consumers confirmed events.
19279	</desc>
19280	</attribute>
19281
19282	<method name="setProcessed">
19283	<desc>
19284	Internal method called by the system when all listeners of a particular event have called
19285	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
19286	</desc>
19287	</method>
19288
19289	<method name="waitProcessed">
19290	<desc>
19291	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
19292	described semantics, for non-waitable returns true immediately.
19293	</desc>
19294	<param name="timeout" type="long" dir="in">
19295	<desc>
19296	Maximum time to wait for event processeing, in ms;
19297	0 = no wait, -1 = indefinite wait.
19298	</desc>
19299	</param>
19300	<param name="result" type="boolean" dir="return">
19301	<desc>If this event was processed before timeout.</desc>
19302	</param>
19303	</method>
19304	</interface>
19305
19306
19307	<interface
19308	name="IReusableEvent" extends="IEvent"
19309	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
19310	wsmap="managed"
19311	>
19312	<desc>Base abstract interface for all reusable events.</desc>
19313
19314	<attribute name="generation" readonly="yes" type="unsigned long">
19315	<desc>Current generation of event, incremented on reuse.</desc>
19316	</attribute>
19317
19318	<method name="reuse">
19319	<desc>
19320	Marks an event as reused, increments 'generation', fields shall no
19321	longer be considered valid.
19322	</desc>
19323	</method>
19324	</interface>
19325
19326	<interface
19327	name="IMachineEvent" extends="IEvent"
19328	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
19329	wsmap="managed" id="MachineEvent"
19330	>
19331	<desc>Base abstract interface for all machine events.</desc>
19332
19333	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
19334	<desc>ID of the machine this event relates to.</desc>
19335	</attribute>
19336
19337	</interface>
19338
19339	<interface
19340	name="IMachineStateChangedEvent" extends="IMachineEvent"
19341	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
19342	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
19343	>
19344	<desc>Machine state change event.</desc>
19345
19346	<attribute name="state" readonly="yes" type="MachineState">
19347	<desc>New execution state.</desc>
19348	</attribute>
19349	</interface>
19350
19351	<interface
19352	name="IMachineDataChangedEvent" extends="IMachineEvent"
19353	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
19354	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
19355	>
19356	<desc>
19357	Any of the settings of the given machine has changed.
19358	</desc>
19359
19360	<attribute name="temporary" readonly="yes" type="boolean">
19361	<desc>@c true if the settings change is temporary. All permanent
19362	settings changes will trigger an event, and only temporary settings
19363	changes for running VMs will trigger an event. Note: sending events
19364	for temporary changes is NOT IMPLEMENTED.</desc>
19365	</attribute>
19366	</interface>
19367
19368	<interface
19369	name="IMediumRegisteredEvent" extends="IEvent"
19370	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
19371	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
19372	>
19373	<desc>
19374	The given medium was registered or unregistered
19375	within this VirtualBox installation.
19376	</desc>
19377
19378	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
19379	<desc>ID of the medium this event relates to.</desc>
19380	</attribute>
19381
19382	<attribute name="mediumType" readonly="yes" type="DeviceType">
19383	<desc>Type of the medium this event relates to.</desc>
19384	</attribute>
19385
19386	<attribute name="registered" type="boolean" readonly="yes">
19387	<desc>
19388	If @c true, the medium was registered, otherwise it was
19389	unregistered.
19390	</desc>
19391	</attribute>
19392	</interface>
19393
19394	<interface
19395	name="IMachineRegisteredEvent" extends="IMachineEvent"
19396	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
19397	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
19398	>
19399	<desc>
19400	The given machine was registered or unregistered
19401	within this VirtualBox installation.
19402	</desc>
19403
19404	<attribute name="registered" type="boolean" readonly="yes">
19405	<desc>
19406	If @c true, the machine was registered, otherwise it was
19407	unregistered.
19408	</desc>
19409	</attribute>
19410	</interface>
19411
19412	<interface
19413	name="ISessionStateChangedEvent" extends="IMachineEvent"
19414	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
19415	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
19416	>
19417	<desc>
19418	The state of the session for the given machine was changed.
19419	<see><link to="IMachine::sessionState"/></see>
19420	</desc>
19421
19422	<attribute name="state" type="SessionState" readonly="yes">
19423	<desc>
19424	New session state.
19425	</desc>
19426	</attribute>
19427	</interface>
19428
19429	<interface
19430	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
19431	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
19432	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
19433	>
19434	<desc>
19435	Notification when a guest property has changed.
19436	</desc>
19437
19438	<attribute name="name" readonly="yes" type="wstring">
19439	<desc>
19440	The name of the property that has changed.
19441	</desc>
19442	</attribute>
19443
19444	<attribute name="value" readonly="yes" type="wstring">
19445	<desc>
19446	The new property value.
19447	</desc>
19448	</attribute>
19449
19450	<attribute name="flags" readonly="yes" type="wstring">
19451	<desc>
19452	The new property flags.
19453	</desc>
19454	</attribute>
19455
19456	</interface>
19457
19458	<interface
19459	name="ISnapshotEvent" extends="IMachineEvent"
19460	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
19461	wsmap="managed" id="SnapshotEvent"
19462	>
19463	<desc>Base interface for all snapshot events.</desc>
19464
19465	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
19466	<desc>ID of the snapshot this event relates to.</desc>
19467	</attribute>
19468
19469	</interface>
19470
19471	<interface
19472	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
19473	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
19474	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
19475	>
19476	<desc>
19477	A new snapshot of the machine has been taken.
19478	<see><link to="ISnapshot"/></see>
19479	</desc>
19480	</interface>
19481
19482	<interface
19483	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
19484	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
19485	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
19486	>
19487	<desc>
19488	Snapshot of the given machine has been deleted.
19489
19490	<note>
19491	This notification is delivered <b>after</b> the snapshot
19492	object has been uninitialized on the server (so that any
19493	attempt to call its methods will return an error).
19494	</note>
19495
19496	<see><link to="ISnapshot"/></see>
19497	</desc>
19498	</interface>
19499
19500	<interface
19501	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
19502	uuid="07541941-8079-447a-a33e-47a69c7980db"
19503	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
19504	>
19505	<desc>
19506	Snapshot properties (name and/or description) have been changed.
19507	<see><link to="ISnapshot"/></see>
19508	</desc>
19509	</interface>
19510
19511	<interface
19512	name="IMousePointerShapeChangedEvent" extends="IEvent"
19513	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
19514	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
19515	>
19516	<desc>
19517	Notification when the guest mouse pointer shape has
19518	changed. The new shape data is given.
19519	</desc>
19520
19521	<attribute name="visible" type="boolean" readonly="yes">
19522	<desc>
19523	Flag whether the pointer is visible.
19524	</desc>
19525	</attribute>
19526	<attribute name="alpha" type="boolean" readonly="yes">
19527	<desc>
19528	Flag whether the pointer has an alpha channel.
19529	</desc>
19530	</attribute>
19531	<attribute name="xhot" type="unsigned long" readonly="yes">
19532	<desc>
19533	The pointer hot spot X coordinate.
19534	</desc>
19535	</attribute>
19536	<attribute name="yhot" type="unsigned long" readonly="yes">
19537	<desc>
19538	The pointer hot spot Y coordinate.
19539	</desc>
19540	</attribute>
19541	<attribute name="width" type="unsigned long" readonly="yes">
19542	<desc>
19543	Width of the pointer shape in pixels.
19544	</desc>
19545	</attribute>
19546	<attribute name="height" type="unsigned long" readonly="yes">
19547	<desc>
19548	Height of the pointer shape in pixels.
19549	</desc>
19550	</attribute>
19551	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
19552	<desc>
19553	Shape buffer arrays.
19554
19555	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
19556	followed by a 32-bpp XOR (color) mask.
19557
19558	For pointers without alpha channel the XOR mask pixels are 32
19559	bit values: (lsb)BGR0(msb). For pointers with alpha channel
19560	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
19561
19562	An AND mask is used for pointers with alpha channel, so if the
19563	callback does not support alpha, the pointer could be
19564	displayed as a normal color pointer.
19565
19566	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
19567	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
19568	height</tt>. The padding bits at the end of each scanline are
19569	undefined.
19570
19571	The XOR mask follows the AND mask on the next 4-byte aligned
19572	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
19573	Bytes in the gap between the AND and the XOR mask are undefined.
19574	The XOR mask scanlines have no gap between them and the size of
19575	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
19576
19577	<note>
19578	If @a shape is 0, only the pointer visibility is changed.
19579	</note>
19580	</desc>
19581	</attribute>
19582	</interface>
19583
19584	<interface
19585	name="IMouseCapabilityChangedEvent" extends="IEvent"
19586	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
19587	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
19588	>
19589	<desc>
19590	Notification when the mouse capabilities reported by the
19591	guest have changed. The new capabilities are passed.
19592	</desc>
19593	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
19594	<desc>
19595	Supports absolute coordinates.
19596	</desc>
19597	</attribute>
19598	<attribute name="supportsRelative" type="boolean" readonly="yes">
19599	<desc>
19600	Supports relative coordinates.
19601	</desc>
19602	</attribute>
19603	<attribute name="needsHostCursor" type="boolean" readonly="yes">
19604	<desc>
19605	If host cursor is needed.
19606	</desc>
19607	</attribute>
19608	</interface>
19609
19610	<interface
19611	name="IKeyboardLedsChangedEvent" extends="IEvent"
19612	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
19613	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
19614	>
19615	<desc>
19616	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
19617	to alter the state of the keyboard LEDs.
19618	</desc>
19619	<attribute name="numLock" type="boolean" readonly="yes">
19620	<desc>
19621	NumLock status.
19622	</desc>
19623	</attribute>
19624	<attribute name="capsLock" type="boolean" readonly="yes">
19625	<desc>
19626	CapsLock status.
19627	</desc>
19628	</attribute>
19629	<attribute name="scrollLock" type="boolean" readonly="yes">
19630	<desc>
19631	ScrollLock status.
19632	</desc>
19633	</attribute>
19634	</interface>
19635
19636	<interface
19637	name="IStateChangedEvent" extends="IEvent"
19638	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
19639	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
19640	>
19641	<desc>
19642	Notification when the execution state of the machine has changed.
19643	The new state is given.
19644	</desc>
19645	<attribute name="state" type="MachineState" readonly="yes">
19646	<desc>
19647	New machine state.
19648	</desc>
19649	</attribute>
19650	</interface>
19651
19652	<interface
19653	name="IAdditionsStateChangedEvent" extends="IEvent"
19654	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
19655	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
19656	>
19657	<desc>
19658	Notification when a Guest Additions property changes.
19659	Interested callees should query IGuest attributes to
19660	find out what has changed.
19661	</desc>
19662	</interface>
19663
19664	<interface
19665	name="INetworkAdapterChangedEvent" extends="IEvent"
19666	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
19667	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
19668	>
19669	<desc>
19670	Notification when a property of one of the
19671	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
19672	changes. Interested callees should use INetworkAdapter methods and
19673	attributes to find out what has changed.
19674	</desc>
19675	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
19676	<desc>
19677	Network adapter that is subject to change.
19678	</desc>
19679	</attribute>
19680	</interface>
19681
19682	<interface
19683	name="ISerialPortChangedEvent" extends="IEvent"
19684	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
19685	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
19686	>
19687	<desc>
19688	Notification when a property of one of the
19689	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
19690	Interested callees should use ISerialPort methods and attributes
19691	to find out what has changed.
19692	</desc>
19693	<attribute name="serialPort" type="ISerialPort" readonly="yes">
19694	<desc>
19695	Serial port that is subject to change.
19696	</desc>
19697	</attribute>
19698	</interface>
19699
19700	<interface
19701	name="IParallelPortChangedEvent" extends="IEvent"
19702	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
19703	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
19704	>
19705	<desc>
19706	Notification when a property of one of the
19707	virtual <link to="IMachine::getParallelPort">parallel ports</link>
19708	changes. Interested callees should use ISerialPort methods and
19709	attributes to find out what has changed.
19710	</desc>
19711	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
19712	<desc>
19713	Parallel port that is subject to change.
19714	</desc>
19715	</attribute>
19716	</interface>
19717
19718	<interface
19719	name="IStorageControllerChangedEvent" extends="IEvent"
19720	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
19721	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
19722	>
19723	<desc>
19724	Notification when a
19725	<link to="IMachine::mediumAttachments">medium attachment</link>
19726	changes.
19727	</desc>
19728	</interface>
19729
19730	<interface
19731	name="IMediumChangedEvent" extends="IEvent"
19732	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
19733	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
19734	>
19735	<desc>
19736	Notification when a
19737	<link to="IMachine::mediumAttachments">medium attachment</link>
19738	changes.
19739	</desc>
19740	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
19741	<desc>
19742	Medium attachment that is subject to change.
19743	</desc>
19744	</attribute>
19745	</interface>
19746
19747	<interface
19748	name="IClipboardModeChangedEvent" extends="IEvent"
19749	uuid="cac21692-7997-4595-a731-3a509db604e5"
19750	wsmap="managed" autogen="VBoxEvent" id="OnClipboardModeChanged"
19751	>
19752	<desc>
19753	Notification when the shared clipboard mode changes.
19754	</desc>
19755	<attribute name="clipboardMode" type="ClipboardMode" readonly="yes">
19756	<desc>
19757	The new clipboard mode.
19758	</desc>
19759	</attribute>
19760	</interface>
19761
19762	<interface
19763	name="IDragAndDropModeChangedEvent" extends="IEvent"
19764	uuid="e90b8850-ac8e-4dff-8059-4100ae2c3c3d"
19765	wsmap="managed" autogen="VBoxEvent" id="OnDragAndDropModeChanged"
19766	>
19767	<desc>
19768	Notification when the drag'n'drop mode changes.
19769	</desc>
19770	<attribute name="dragAndDropMode" type="DragAndDropMode" readonly="yes">
19771	<desc>
19772	The new drag'n'drop mode.
19773	</desc>
19774	</attribute>
19775	</interface>
19776
19777	<interface
19778	name="ICPUChangedEvent" extends="IEvent"
19779	uuid="4da2dec7-71b2-4817-9a64-4ed12c17388e"
19780	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
19781	>
19782	<desc>
19783	Notification when a CPU changes.
19784	</desc>
19785	<attribute name="CPU" type="unsigned long" readonly="yes">
19786	<desc>
19787	The CPU which changed.
19788	</desc>
19789	</attribute>
19790	<attribute name="add" type="boolean" readonly="yes">
19791	<desc>
19792	Flag whether the CPU was added or removed.
19793	</desc>
19794	</attribute>
19795	</interface>
19796
19797	<interface
19798	name="ICPUExecutionCapChangedEvent" extends="IEvent"
19799	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
19800	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
19801	>
19802	<desc>
19803	Notification when the CPU execution cap changes.
19804	</desc>
19805	<attribute name="executionCap" type="unsigned long" readonly="yes">
19806	<desc>
19807	The new CPU execution cap value. (1-100)
19808	</desc>
19809	</attribute>
19810	</interface>
19811
19812	<interface
19813	name="IGuestKeyboardEvent" extends="IEvent"
19814	uuid="88394258-7006-40d4-b339-472ee3801844"
19815	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
19816	>
19817	<desc>
19818	Notification when guest keyboard event happens.
19819	</desc>
19820	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
19821	<desc>
19822	Array of scancodes.
19823	</desc>
19824	</attribute>
19825	</interface>
19826
19827	<interface
19828	name="IGuestMouseEvent" extends="IReusableEvent"
19829	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
19830	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
19831	>
19832	<desc>
19833	Notification when guest mouse event happens.
19834	</desc>
19835
19836	<attribute name="absolute" type="boolean" readonly="yes">
19837	<desc>
19838	If this event is relative or absolute.
19839	</desc>
19840	</attribute>
19841
19842	<attribute name="x" type="long" readonly="yes">
19843	<desc>
19844	New X position, or X delta.
19845	</desc>
19846	</attribute>
19847
19848	<attribute name="y" type="long" readonly="yes">
19849	<desc>
19850	New Y position, or Y delta.
19851	</desc>
19852	</attribute>
19853
19854	<attribute name="z" type="long" readonly="yes">
19855	<desc>
19856	Z delta.
19857	</desc>
19858	</attribute>
19859
19860	<attribute name="w" type="long" readonly="yes">
19861	<desc>
19862	W delta.
19863	</desc>
19864	</attribute>
19865
19866	<attribute name="buttons" type="long" readonly="yes">
19867	<desc>
19868	Button state bitmask.
19869	</desc>
19870	</attribute>
19871
19872	</interface>
19873
19874
19875	<interface
19876	name="IVRDEServerChangedEvent" extends="IEvent"
19877	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
19878	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
19879	>
19880	<desc>
19881	Notification when a property of the
19882	<link to="IMachine::VRDEServer">VRDE server</link> changes.
19883	Interested callees should use IVRDEServer methods and attributes to
19884	find out what has changed.
19885	</desc>
19886	</interface>
19887
19888	<interface
19889	name="IVRDEServerInfoChangedEvent" extends="IEvent"
19890	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
19891	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
19892	>
19893	<desc>
19894	Notification when the status of the VRDE server changes. Interested callees
19895	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
19896	attributes to find out what is the current status.
19897	</desc>
19898	</interface>
19899
19900	<interface
19901	name="IUSBControllerChangedEvent" extends="IEvent"
19902	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
19903	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
19904	>
19905	<desc>
19906	Notification when a property of the virtual
19907	<link to="IMachine::USBController">USB controller</link> changes.
19908	Interested callees should use IUSBController methods and attributes to
19909	find out what has changed.
19910	</desc>
19911	</interface>
19912
19913	<interface
19914	name="IUSBDeviceStateChangedEvent" extends="IEvent"
19915	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
19916	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
19917	>
19918	<desc>
19919	Notification when a USB device is attached to or detached from
19920	the virtual USB controller.
19921
19922	This notification is sent as a result of the indirect
19923	request to attach the device because it matches one of the
19924	machine USB filters, or as a result of the direct request
19925	issued by <link to="IConsole::attachUSBDevice"/> or
19926	<link to="IConsole::detachUSBDevice"/>.
19927
19928	This notification is sent in case of both a succeeded and a
19929	failed request completion. When the request succeeds, the
19930	@a error parameter is @c null, and the given device has been
19931	already added to (when @a attached is @c true) or removed from
19932	(when @a attached is @c false) the collection represented by
19933	<link to="IConsole::USBDevices"/>. On failure, the collection
19934	doesn't change and the @a error parameter represents the error
19935	message describing the failure.
19936	</desc>
19937	<attribute name="device" type="IUSBDevice" readonly="yes">
19938	<desc>
19939	Device that is subject to state change.
19940	</desc>
19941	</attribute>
19942	<attribute name="attached" type="boolean" readonly="yes">
19943	<desc>
19944	@c true if the device was attached and @c false otherwise.
19945	</desc>
19946	</attribute>
19947	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
19948	<desc>
19949	@c null on success or an error message object on failure.
19950	</desc>
19951	</attribute>
19952	</interface>
19953
19954	<interface
19955	name="ISharedFolderChangedEvent" extends="IEvent"
19956	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
19957	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
19958	>
19959	<desc>
19960	Notification when a shared folder is added or removed.
19961	The @a scope argument defines one of three scopes:
19962	<link to="IVirtualBox::sharedFolders">global shared folders</link>
19963	(<link to="Scope_Global">Global</link>),
19964	<link to="IMachine::sharedFolders">permanent shared folders</link> of
19965	the machine (<link to="Scope_Machine">Machine</link>) or <link
19966	to="IConsole::sharedFolders">transient shared folders</link> of the
19967	machine (<link to="Scope_Session">Session</link>). Interested callees
19968	should use query the corresponding collections to find out what has
19969	changed.
19970	</desc>
19971	<attribute name="scope" type="Scope" readonly="yes">
19972	<desc>
19973	Scope of the notification.
19974	</desc>
19975	</attribute>
19976	</interface>
19977
19978	<interface
19979	name="IRuntimeErrorEvent" extends="IEvent"
19980	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
19981	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
19982	>
19983	<desc>
19984	Notification when an error happens during the virtual
19985	machine execution.
19986
19987	There are three kinds of runtime errors:
19988	<ul>
19989	<li><i>fatal</i></li>
19990	<li><i>non-fatal with retry</i></li>
19991	<li><i>non-fatal warnings</i></li>
19992	</ul>
19993
19994	<b>Fatal</b> errors are indicated by the @a fatal parameter set
19995	to @c true. In case of fatal errors, the virtual machine
19996	execution is always paused before calling this notification, and
19997	the notification handler is supposed either to immediately save
19998	the virtual machine state using <link to="IConsole::saveState"/>
19999	or power it off using <link to="IConsole::powerDown"/>.
20000	Resuming the execution can lead to unpredictable results.
20001
20002	<b>Non-fatal</b> errors and warnings are indicated by the
20003	@a fatal parameter set to @c false. If the virtual machine
20004	is in the Paused state by the time the error notification is
20005	received, it means that the user can <i>try to resume</i> the machine
20006	execution after attempting to solve the problem that caused the
20007	error. In this case, the notification handler is supposed
20008	to show an appropriate message to the user (depending on the
20009	value of the @a id parameter) that offers several actions such
20010	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
20011	wants to retry, the notification handler should continue
20012	the machine execution using the <link to="IConsole::resume"/>
20013	call. If the machine execution is not Paused during this
20014	notification, then it means this notification is a <i>warning</i>
20015	(for example, about a fatal condition that can happen very soon);
20016	no immediate action is required from the user, the machine
20017	continues its normal execution.
20018
20019	Note that in either case the notification handler
20020	<b>must not</b> perform any action directly on a thread
20021	where this notification is called. Everything it is allowed to
20022	do is to post a message to another thread that will then talk
20023	to the user and take the corresponding action.
20024
20025	Currently, the following error identifiers are known:
20026	<ul>
20027	<li><tt>"HostMemoryLow"</tt></li>
20028	<li><tt>"HostAudioNotResponding"</tt></li>
20029	<li><tt>"VDIStorageFull"</tt></li>
20030	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
20031	</ul>
20032	</desc>
20033	<attribute name="fatal" type="boolean" readonly="yes">
20034	<desc>
20035	Whether the error is fatal or not.
20036	</desc>
20037	</attribute>
20038	<attribute name="id" type="wstring" readonly="yes">
20039	<desc>
20040	Error identifier.
20041	</desc>
20042	</attribute>
20043	<attribute name="message" type="wstring" readonly="yes">
20044	<desc>
20045	Optional error message.
20046	</desc>
20047	</attribute>
20048	</interface>
20049
20050
20051	<interface
20052	name="IEventSourceChangedEvent" extends="IEvent"
20053	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
20054	waitable="yes"
20055	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
20056	>
20057	<desc>
20058	Notification when an event source state changes (listener added or removed).
20059	</desc>
20060
20061	<attribute name="listener" type="IEventListener" readonly="yes">
20062	<desc>
20063	Event listener which has changed.
20064	</desc>
20065	</attribute>
20066
20067	<attribute name="add" type="boolean" readonly="yes">
20068	<desc>
20069	Flag whether listener was added or removed.
20070	</desc>
20071	</attribute>
20072	</interface>
20073
20074	<interface
20075	name="IExtraDataChangedEvent" extends="IEvent"
20076	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
20077	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
20078	>
20079	<desc>
20080	Notification when machine specific or global extra data
20081	has changed.
20082	</desc>
20083	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
20084	<desc>
20085	ID of the machine this event relates to.
20086	Null for global extra data changes.
20087	</desc>
20088	</attribute>
20089	<attribute name="key" type="wstring" readonly="yes">
20090	<desc>
20091	Extra data key that has changed.
20092	</desc>
20093	</attribute>
20094	<attribute name="value" type="wstring" readonly="yes">
20095	<desc>
20096	Extra data value for the given key.
20097	</desc>
20098	</attribute>
20099	</interface>
20100
20101	<interface
20102	name="IVetoEvent" extends="IEvent"
20103	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
20104	wsmap="managed"
20105	>
20106	<desc>Base abstract interface for veto events.</desc>
20107
20108	<method name="addVeto">
20109	<desc>
20110	Adds a veto on this event.
20111	</desc>
20112	<param name="reason" type="wstring" dir="in">
20113	<desc>
20114	Reason for veto, could be null or empty string.
20115	</desc>
20116	</param>
20117	</method>
20118
20119	<method name="isVetoed">
20120	<desc>
20121	If this event was vetoed.
20122	</desc>
20123	<param name="result" type="boolean" dir="return">
20124	<desc>
20125	Reason for veto.
20126	</desc>
20127	</param>
20128	</method>
20129
20130	<method name="getVetos">
20131	<desc>
20132	Current veto reason list, if size is 0 - no veto.
20133	</desc>
20134	<param name="result" type="wstring" dir="return" safearray="yes">
20135	<desc>
20136	Array of reasons for veto provided by different event handlers.
20137	</desc>
20138	</param>
20139	</method>
20140
20141	</interface>
20142
20143	<interface
20144	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
20145	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
20146	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
20147	waitable="true"
20148	>
20149	<desc>
20150	Notification when someone tries to change extra data for
20151	either the given machine or (if @c null) global extra data.
20152	This gives the chance to veto against changes.
20153	</desc>
20154	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
20155	<desc>
20156	ID of the machine this event relates to.
20157	Null for global extra data changes.
20158	</desc>
20159	</attribute>
20160	<attribute name="key" type="wstring" readonly="yes">
20161	<desc>
20162	Extra data key that has changed.
20163	</desc>
20164	</attribute>
20165	<attribute name="value" type="wstring" readonly="yes">
20166	<desc>
20167	Extra data value for the given key.
20168	</desc>
20169	</attribute>
20170	</interface>
20171
20172	<interface
20173	name="ICanShowWindowEvent" extends="IVetoEvent"
20174	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
20175	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
20176	waitable="true"
20177	>
20178	<desc>
20179	Notification when a call to
20180	<link to="IMachine::canShowConsoleWindow"/> is made by a
20181	front-end to check if a subsequent call to
20182	<link to="IMachine::showConsoleWindow"/> can succeed.
20183
20184	The callee should give an answer appropriate to the current
20185	machine state using event veto. This answer must
20186	remain valid at least until the next
20187	<link to="IConsole::state">machine state</link> change.
20188	</desc>
20189	</interface>
20190
20191	<interface
20192	name="IShowWindowEvent" extends="IEvent"
20193	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
20194	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
20195	waitable="true"
20196	>
20197	<desc>
20198	Notification when a call to
20199	<link to="IMachine::showConsoleWindow"/>
20200	requests the console window to be activated and brought to
20201	foreground on the desktop of the host PC.
20202
20203	This notification should cause the VM console process to
20204	perform the requested action as described above. If it is
20205	impossible to do it at a time of this notification, this
20206	method should return a failure.
20207
20208	Note that many modern window managers on many platforms
20209	implement some sort of focus stealing prevention logic, so
20210	that it may be impossible to activate a window without the
20211	help of the currently active application (which is supposedly
20212	an initiator of this notification). In this case, this method
20213	must return a non-zero identifier that represents the
20214	top-level window of the VM console process. The caller, if it
20215	represents a currently active process, is responsible to use
20216	this identifier (in a platform-dependent manner) to perform
20217	actual window activation.
20218
20219	This method must set @a winId to zero if it has performed all
20220	actions necessary to complete the request and the console
20221	window is now active and in foreground, to indicate that no
20222	further action is required on the caller's side.
20223	</desc>
20224	<attribute name="winId" type="long long">
20225	<desc>
20226	Platform-dependent identifier of the top-level VM console
20227	window, or zero if this method has performed all actions
20228	necessary to implement the <i>show window</i> semantics for
20229	the given platform and/or this VirtualBox front-end.
20230	</desc>
20231	</attribute>
20232	</interface>
20233
20234	<interface
20235	name="INATRedirectEvent" extends="IMachineEvent"
20236	uuid="24eef068-c380-4510-bc7c-19314a7352f1"
20237	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
20238	>
20239	<desc>
20240	Notification when NAT redirect rule added or removed.
20241	</desc>
20242	<attribute name="slot" type="unsigned long" readonly="yes">
20243	<desc>
20244	Adapter which NAT attached to.
20245	</desc>
20246	</attribute>
20247	<attribute name="remove" type="boolean" readonly="yes">
20248	<desc>
20249	Whether rule remove or add.
20250	</desc>
20251	</attribute>
20252	<attribute name="name" type="wstring" readonly="yes">
20253	<desc>
20254	Name of the rule.
20255	</desc>
20256	</attribute>
20257	<attribute name="proto" type="NATProtocol" readonly="yes">
20258	<desc>
20259	Protocol (TCP or UDP) of the redirect rule.
20260	</desc>
20261	</attribute>
20262	<attribute name="hostIP" type="wstring" readonly="yes">
20263	<desc>
20264	Host ip address to bind socket on.
20265	</desc>
20266	</attribute>
20267	<attribute name="hostPort" type="long" readonly="yes">
20268	<desc>
20269	Host port to bind socket on.
20270	</desc>
20271	</attribute>
20272	<attribute name="guestIP" type="wstring" readonly="yes">
20273	<desc>
20274	Guest ip address to redirect to.
20275	</desc>
20276	</attribute>
20277	<attribute name="guestPort" type="long" readonly="yes">
20278	<desc>
20279	Guest port to redirect to.
20280	</desc>
20281	</attribute>
20282	</interface>
20283
20284	<interface
20285	name="IHostPCIDevicePlugEvent" extends="IMachineEvent"
20286	waitable="yes"
20287	uuid="a0bad6df-d612-47d3-89d4-db3992533948"
20288	wsmap="managed" autogen="VBoxEvent" id="OnHostPCIDevicePlug"
20289	>
20290	<desc>
20291	Notification when host PCI device is plugged/unplugged. Plugging
20292	usually takes place on VM startup, unplug - when
20293	<link to="IMachine::detachHostPCIDevice"/> is called.
20294
20295	<see><link to="IMachine::detachHostPCIDevice"/></see>
20296
20297	</desc>
20298
20299	<attribute name="plugged" type="boolean" readonly="yes">
20300	<desc>
20301	If device successfully plugged or unplugged.
20302	</desc>
20303	</attribute>
20304
20305	<attribute name="success" type="boolean" readonly="yes">
20306	<desc>
20307	If operation was successful, if false - 'message' attribute
20308	may be of interest.
20309	</desc>
20310	</attribute>
20311
20312	<attribute name="attachment" type="IPCIDeviceAttachment" readonly="yes">
20313	<desc>
20314	Attachment info for this device.
20315	</desc>
20316	</attribute>
20317
20318	<attribute name="message" type="wstring" readonly="yes">
20319	<desc>
20320	Optional error message.
20321	</desc>
20322	</attribute>
20323
20324	</interface>
20325
20326	<interface
20327	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
20328	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
20329	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
20330	>
20331	<desc>
20332	Notification when VBoxSVC becomes unavailable (due to a crash or similar
20333	unexpected circumstances) or available again.
20334	</desc>
20335
20336	<attribute name="available" type="boolean" readonly="yes">
20337	<desc>
20338	Whether VBoxSVC is available now.
20339	</desc>
20340	</attribute>
20341	</interface>
20342
20343	<interface
20344	name="IBandwidthGroupChangedEvent" extends="IEvent"
20345	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
20346	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
20347	>
20348	<desc>
20349	Notification when one of the bandwidth groups changed
20350	</desc>
20351	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
20352	<desc>
20353	The changed bandwidth group.
20354	</desc>
20355	</attribute>
20356	</interface>
20357
20358	<enum
20359	name="GuestMonitorChangedEventType"
20360	uuid="ef172985-7e36-4297-95be-e46396968d66"
20361	>
20362
20363	<desc>
20364	How the guest monitor has been changed.
20365	</desc>
20366
20367	<const name="Enabled" value="0">
20368	<desc>
20369	The guest monitor has been enabled by the guest.
20370	</desc>
20371	</const>
20372
20373	<const name="Disabled" value="1">
20374	<desc>
20375	The guest monitor has been disabled by the guest.
20376	</desc>
20377	</const>
20378
20379	<const name="NewOrigin" value="2">
20380	<desc>
20381	The guest monitor origin has changed in the guest.
20382	</desc>
20383	</const>
20384	</enum>
20385
20386	<interface
20387	name="IGuestMonitorChangedEvent" extends="IEvent"
20388	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
20389	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
20390	>
20391	<desc>
20392	Notification when the guest enables one of its monitors.
20393	</desc>
20394
20395	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
20396	<desc>
20397	What was changed for this guest monitor.
20398	</desc>
20399	</attribute>
20400
20401	<attribute name="screenId" type="unsigned long" readonly="yes">
20402	<desc>
20403	The monitor which was changed.
20404	</desc>
20405	</attribute>
20406
20407	<attribute name="originX" type="unsigned long" readonly="yes">
20408	<desc>
20409	Physical X origin relative to the primary screen.
20410	Valid for Enabled and NewOrigin.
20411	</desc>
20412	</attribute>
20413
20414	<attribute name="originY" type="unsigned long" readonly="yes">
20415	<desc>
20416	Physical Y origin relative to the primary screen.
20417	Valid for Enabled and NewOrigin.
20418	</desc>
20419	</attribute>
20420
20421	<attribute name="width" type="unsigned long" readonly="yes">
20422	<desc>
20423	Width of the screen.
20424	Valid for Enabled.
20425	</desc>
20426	</attribute>
20427
20428	<attribute name="height" type="unsigned long" readonly="yes">
20429	<desc>
20430	Height of the screen.
20431	Valid for Enabled.
20432	</desc>
20433	</attribute>
20434
20435	</interface>
20436
20437	<interface
20438	name="IStorageDeviceChangedEvent" extends="IEvent"
20439	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
20440	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
20441	>
20442	<desc>
20443	Notification when a
20444	<link to="IMachine::mediumAttachments">storage device</link>
20445	is attached or removed.
20446	</desc>
20447	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
20448	<desc>
20449	Storage device that is subject to change.
20450	</desc>
20451	</attribute>
20452	<attribute name="removed" type="boolean" readonly="yes">
20453	<desc>
20454	Flag whether the device was removed or added to the VM.
20455	</desc>
20456	</attribute>
20457	</interface>
20458
20459	<module name="VBoxSVC" context="LocalServer">
20460	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
20461	namespace="virtualbox.org">
20462	<interface name="IVirtualBox" default="yes"/>
20463	</class>
20464	</module>
20465
20466	<module name="VBoxC" context="InprocServer" threadingModel="Free">
20467	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
20468	namespace="virtualbox.org">
20469	<interface name="IVirtualBoxClient" default="yes"/>
20470	</class>
20471
20472	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
20473	namespace="virtualbox.org">
20474	<interface name="ISession" default="yes"/>
20475	</class>
20476	</module>
20477
20478	</library>
20479
20480	</idl>
20481
20482	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format