VirtualBox.xidl@ 45422

Last change on this file since 45422 was 45422, checked in by vboxsync, 12 years ago
Trim trailing spaces.
Property svn:eol-style set to `native`
File size: 751.4 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2013 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109
110	The naming of methods and attributes is very clearly defined: they all start
111	with a lowercase letter (except if they start with an acronym), and are using
112	CamelCase style otherwise. This naming only applies to the IDL description,
113	and is modified by the various language bindings (some convert the first
114	character to upper case, some not). See the SDK reference for more details
115	about how to call a method or attribute from a specific programming language.
116	</desc>
117
118	<if target="midl">
119	<cpp line="enum {"/>
120	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
121	<cpp line=" kTypeLibraryMinorVersion = 0"/>
122	<cpp line="};"/>
123	</if>
124
125	<if target="xpidl">
126	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
127	<cpp>
128	/* currently, nsISupportsImpl.h lacks the below-like macros */
129
130	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
131	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
132	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
133	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
134	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE5_CI NS_IMPL_QUERY_INTERFACE5_CI
135	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE6_CI NS_IMPL_QUERY_INTERFACE6_CI
136	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE7_CI NS_IMPL_QUERY_INTERFACE7_CI
137	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE8_CI NS_IMPL_QUERY_INTERFACE8_CI
138
139
140	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
141	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
142	NS_IMPL_THREADSAFE_ADDREF(_class) \
143	NS_IMPL_THREADSAFE_RELEASE(_class) \
144	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
145	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
146	#endif
147
148	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
149	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
150	NS_IMPL_THREADSAFE_ADDREF(_class) \
151	NS_IMPL_THREADSAFE_RELEASE(_class) \
152	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
153	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
154	#endif
155
156	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
157	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
158	NS_IMPL_THREADSAFE_ADDREF(_class) \
159	NS_IMPL_THREADSAFE_RELEASE(_class) \
160	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
161	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
162	#endif
163
164	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
165	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
166	NS_IMPL_THREADSAFE_ADDREF(_class) \
167	NS_IMPL_THREADSAFE_RELEASE(_class) \
168	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
169	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
170	#endif
171
172	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS5_CI
173	# define NS_IMPL_THREADSAFE_ISUPPORTS5_CI(_class, _i1, _i2, _i3, _i4, _i5) \
174	NS_IMPL_THREADSAFE_ADDREF(_class) \
175	NS_IMPL_THREADSAFE_RELEASE(_class) \
176	NS_IMPL_THREADSAFE_QUERY_INTERFACE5_CI(_class, _i1, _i2, _i3, _i4, _i5) \
177	NS_IMPL_CI_INTERFACE_GETTER5(_class, _i1, _i2, _i3, _i4, _i5)
178	#endif
179
180	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS6_CI
181	# define NS_IMPL_THREADSAFE_ISUPPORTS6_CI(_class, _i1, _i2, _i3, _i4, _i5, _i6) \
182	NS_IMPL_THREADSAFE_ADDREF(_class) \
183	NS_IMPL_THREADSAFE_RELEASE(_class) \
184	NS_IMPL_THREADSAFE_QUERY_INTERFACE6_CI(_class, _i1, _i2, _i3, _i4, _i5, _i6) \
185	NS_IMPL_CI_INTERFACE_GETTER6(_class, _i1, _i2, _i3, _i4, _i5, _i6)
186	#endif
187
188	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS7_CI
189	# define NS_IMPL_THREADSAFE_ISUPPORTS7_CI(_class, _i1, _i2, _i3, _i4, _i5, _i6, _i7) \
190	NS_IMPL_THREADSAFE_ADDREF(_class) \
191	NS_IMPL_THREADSAFE_RELEASE(_class) \
192	NS_IMPL_THREADSAFE_QUERY_INTERFACE7_CI(_class, _i1, _i2, _i3, _i4, _i5, _i6, _i7) \
193	NS_IMPL_CI_INTERFACE_GETTER7(_class, _i1, _i2, _i3, _i4, _i5, _i6, _i7)
194	#endif
195
196	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS8_CI
197	# define NS_IMPL_THREADSAFE_ISUPPORTS8_CI(_class, _i1, _i2, _i3, _i4, _i5, _i6, _i7, _i8) \
198	NS_IMPL_THREADSAFE_ADDREF(_class) \
199	NS_IMPL_THREADSAFE_RELEASE(_class) \
200	NS_IMPL_THREADSAFE_QUERY_INTERFACE8_CI(_class, _i1, _i2, _i3, _i4, _i5, _i6, _i7, _i8) \
201	NS_IMPL_CI_INTERFACE_GETTER8(_class, _i1, _i2, _i3, _i4, _i5, _i6, _i7, _i8)
202	#endif
203
204	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
205	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
206	NS_INTERFACE_MAP_BEGIN(_class) \
207	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
208	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
209	NS_IMPL_QUERY_CLASSINFO(_class) \
210	NS_INTERFACE_MAP_END
211	#endif
212
213	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
214	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
215	_i2, _ic2) \
216	NS_INTERFACE_MAP_BEGIN(_class) \
217	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
218	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
219	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
220	NS_IMPL_QUERY_CLASSINFO(_class) \
221	NS_INTERFACE_MAP_END
222	#endif
223
224	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
225	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
226	_i2, _ic2, _i3, _ic3) \
227	NS_INTERFACE_MAP_BEGIN(_class) \
228	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
229	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
230	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
231	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
232	NS_IMPL_QUERY_CLASSINFO(_class) \
233	NS_INTERFACE_MAP_END
234	#endif
235
236	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
237	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
238	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
239
240	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
241	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
242	NS_IMPL_THREADSAFE_ADDREF(_class) \
243	NS_IMPL_THREADSAFE_RELEASE(_class) \
244	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
245	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
246	#endif
247
248	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
249	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
250	_i2, _ic2) \
251	NS_IMPL_THREADSAFE_ADDREF(_class) \
252	NS_IMPL_THREADSAFE_RELEASE(_class) \
253	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
254	_i2, _ic2) \
255	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
256	#endif
257
258	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
259	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
260	_i2, _ic2, _i3, _ic3) \
261	NS_IMPL_THREADSAFE_ADDREF(_class) \
262	NS_IMPL_THREADSAFE_RELEASE(_class) \
263	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
264	_i2, _ic2, _i3, _ic3) \
265	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
266	#endif
267
268	</cpp>
269	</if>
270
271	<library
272	name="VirtualBox"
273	uuid="d7569351-1750-46f0-936e-bd127d5bc264"
274	version="1.3"
275	desc="VirtualBox Type Library"
276	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
277	supportsErrorInfo="yes"
278	>
279
280
281	<!--
282	// COM result codes for VirtualBox
283	/////////////////////////////////////////////////////////////////////////
284	-->
285
286	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
287	<desc>
288	This section describes all VirtualBox-specific COM result codes that may
289	be returned by methods of VirtualBox COM interfaces in addition to
290	standard COM result codes.
291
292	Note that along with the result code, every VirtualBox method returns
293	extended error information through the IVirtualBoxErrorInfo interface on
294	failure. This interface is a preferred way to present the error to the end
295	user because it contains a human readable description of the error. Raw
296	result codes, both standard and described in this section, are intended to
297	be used by programs to analyze the reason of a failure and select an
298	appropriate course of action without involving the end user (for example,
299	retry the operation later or make a different call).
300
301	The standard COM result codes that may originate from our methods include:
302
303	<table>
304	<tr><td>E_INVALIDARG</td>
305	<td>
306	Returned when the value of the method's argument is not within the range
307	of valid values. This should not be confused with situations when the
308	value is within the range but simply doesn't suit the current object
309	state and there is a possibility that it will be accepted later (in such
310	cases VirtualBox-specific codes are returned, for example,
311	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
312	</td>
313	</tr>
314	<tr><td>E_POINTER</td>
315	<td>
316	Returned if a memory pointer for the output argument is invalid (for
317	example, @c null). When pointers representing input arguments (such
318	as strings) are invalid, E_INVALIDARG is returned.
319	</td>
320	</tr>
321	<tr><td>E_ACCESSDENIED</td>
322	<td>
323	Returned when the called object is not ready. Since the lifetime of a
324	public COM object cannot be fully controlled by the implementation,
325	VirtualBox maintains the readiness state for all objects it creates and
326	returns this code in response to any method call on the object that was
327	deactivated by VirtualBox and is not functioning any more.
328	</td>
329	</tr>
330	<tr><td>E_OUTOFMEMORY</td>
331	<td>
332	Returned when a memory allocation operation fails.
333	</td>
334	</tr>
335	</table>
336	</desc>
337	</descGroup>
338
339	<!--
340	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
341	everything in <result>/<desc> after (and including) the first dot, so express
342	the matter of the error code in the first sentence and keep it short.
343	-->
344
345	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
346	<desc>
347	Object corresponding to the supplied arguments does not exist.
348	</desc>
349	</result>
350
351	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
352	<desc>
353	Current virtual machine state prevents the operation.
354	</desc>
355	</result>
356
357	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
358	<desc>
359	Virtual machine error occurred attempting the operation.
360	</desc>
361	</result>
362
363	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
364	<desc>
365	File not accessible or erroneous file contents.
366	</desc>
367	</result>
368
369	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
370	<desc>
371	Runtime subsystem error.
372	</desc>
373	</result>
374
375	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
376	<desc>
377	Pluggable Device Manager error.
378	</desc>
379	</result>
380
381	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
382	<desc>
383	Current object state prohibits operation.
384	</desc>
385	</result>
386
387	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
388	<desc>
389	Host operating system related error.
390	</desc>
391	</result>
392
393	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
394	<desc>
395	Requested operation is not supported.
396	</desc>
397	</result>
398
399	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
400	<desc>
401	Invalid XML found.
402	</desc>
403	</result>
404
405	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
406	<desc>
407	Current session state prohibits operation.
408	</desc>
409	</result>
410
411	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
412	<desc>
413	Object being in use prohibits operation.
414	</desc>
415	</result>
416
417	<!--
418	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
419	everything in <result>/<desc> after (and including) the first dot, so express
420	the matter of the error code in the first sentence and keep it short.
421	-->
422
423	<descGroup/>
424
425	<!--
426	// all common enums
427	/////////////////////////////////////////////////////////////////////////
428	-->
429
430	<enum
431	name="SettingsVersion"
432	uuid="d5b15ca7-3de7-46b2-a63a-ddcce42bfa3f"
433	>
434	<desc>
435	Settings version of VirtualBox settings files. This is written to
436	the "version" attribute of the root "VirtualBox" element in the settings
437	file XML and indicates which VirtualBox version wrote the file.
438	</desc>
439
440	<const name="Null" value="0">
441	<desc>Null value, indicates invalid version.</desc>
442	</const>
443	<const name="v1_0" value="1">
444	<desc>Legacy settings version, not currently supported.</desc>
445	</const>
446	<const name="v1_1" value="2">
447	<desc>Legacy settings version, not currently supported.</desc>
448	</const>
449	<const name="v1_2" value="3">
450	<desc>Legacy settings version, not currently supported.</desc>
451	</const>
452	<const name="v1_3pre" value="4">
453	<desc>Legacy settings version, not currently supported.</desc>
454	</const>
455	<const name="v1_3" value="5">
456	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
457	<!--
458	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
459	-->
460	</const>
461	<const name="v1_4" value="6">
462	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
463	<!--
464	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
465	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
466	-->
467	</const>
468	<const name="v1_5" value="7">
469	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
470	<!--
471	2008-09-04: 2.0.0 released
472	2008-11-20: settings version 1.5 introduced
473	2008-12-17: 2.1.0 released
474	Machine changes:
475	guest OS identifiers changed;
476	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
477	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
478	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
479	-->
480	</const>
481	<const name="v1_6" value="8">
482	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
483	<!--
484	2008-12-17: 2.1.0 released
485	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
486	2009-04-08: 2.2.0 released
487	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
488	-->
489	</const>
490	<const name="v1_7" value="9">
491	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
492	<!--
493	2008-12-17: 2.1.0 released
494	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
495	2009-04-08: 2.2.0 released
496	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
497	Machine changes: HardDiskAttachments is now StorageControllers (done)
498	-->
499	</const>
500	<const name="v1_8" value="10">
501	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
502	<!--
503	Machine additions: Display/@accelerate2DVideo (done)
504	-->
505	</const>
506	<const name="v1_9" value="11">
507	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
508	<!--
509	The big storage controller / DVD / Floppy rework (done)
510	-->
511	</const>
512	<const name="v1_10" value="12">
513	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
514	<!--
515	Machine changes: RTC localOrUTC (done)
516	CPU hot-plug support
517	-->
518	</const>
519	<const name="v1_11" value="13">
520	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
521	<!--
522	Machine changes: HD Audio controller, per-machine disk registries,
523	/@format attribute for DVD and floppy images.
524	-->
525	</const>
526	<const name="v1_12" value="14">
527	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
528	<!--
529	Machine changes: raw PCI device attachment;
530	NetworkAdapter changes: bandwidth group.
531	-->
532	</const>
533	<const name="v1_13" value="15">
534	<desc>Settings version "1.13", written by VirtualBox 4.2.x.</desc>
535	<!--
536	Machine changes: tracing config, groups, autostart;
537	NetworkAdapter changes: unit for bandwidth group limits.
538	-->
539	</const>
540	<const name="v1_14" value="16">
541	<desc>Settings version "1.14", written by VirtualBox 4.3.x.</desc>
542	<!--
543	Machine changes: default frontend.
544	-->
545	</const>
546
547	<const name="Future" value="99999">
548	<desc>Settings version greater than "1.13", written by a future VirtualBox version.</desc>
549	</const>
550	</enum>
551
552	<enum
553	name="AccessMode"
554	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
555	>
556	<desc>
557	Access mode for opening files.
558	</desc>
559
560	<const name="ReadOnly" value="1"/>
561	<const name="ReadWrite" value="2"/>
562	</enum>
563
564	<enum
565	name="MachineState"
566	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
567	>
568	<desc>
569	Virtual machine execution state.
570
571	This enumeration represents possible values of the <link
572	to="IMachine::state"/> attribute.
573
574	Below is the basic virtual machine state diagram. It shows how the state
575	changes during virtual machine execution. The text in square braces shows
576	a method of the IConsole interface that performs the given state
577	transition.
578
579	<pre>
580	+---------[powerDown()] <- Stuck <--[failure]-+
581	V \|
582	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
583	\| \| \| \| V \|
584	\| Aborted -----+ +--> Running --[pause()]--> Paused
585	\| \| ^ \| ^ \|
586	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
587	\| ^ \| \| \| \|
588	\| \| +-----------------------------------------+-\|-------------------+ +
589	\| \| \| \| \|
590	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
591	\| \| \| \|
592	\| +-------- Saving <--------[saveState()]<----------+---------------------+
593	\| \| \|
594	+-------------- Stopping -------[powerDown()]<----------+---------------------+
595	</pre>
596
597	Note that states to the right from PoweredOff, Aborted and Saved in the
598	above diagram are called <i>online VM states</i>. These states
599	represent the virtual machine which is being executed in a dedicated
600	process (usually with a GUI window attached to it where you can see the
601	activity of the virtual machine and interact with it). There are two
602	special pseudo-states, FirstOnline and LastOnline, that can be used in
603	relational expressions to detect if the given machine state is online or
604	not:
605
606	<pre>
607	if (machine.GetState() >= MachineState_FirstOnline &&
608	machine.GetState() <= MachineState_LastOnline)
609	{
610	...the machine is being executed...
611	}
612	</pre>
613
614	When the virtual machine is in one of the online VM states (that is, being
615	executed), only a few machine settings can be modified. Methods working
616	with such settings contain an explicit note about that. An attempt to
617	change any other setting or perform a modifying operation during this time
618	will result in the @c VBOX_E_INVALID_VM_STATE error.
619
620	All online states except Running, Paused and Stuck are transitional: they
621	represent temporary conditions of the virtual machine that will last as
622	long as the operation that initiated such a condition.
623
624	The Stuck state is a special case. It means that execution of the machine
625	has reached the "Guru Meditation" condition. This condition indicates an
626	internal VMM (virtual machine manager) failure which may happen as a
627	result of either an unhandled low-level virtual hardware exception or one
628	of the recompiler exceptions (such as the <i>too-many-traps</i>
629	condition).
630
631	Note also that any online VM state may transit to the Aborted state. This
632	happens if the process that is executing the virtual machine terminates
633	unexpectedly (for example, crashes). Other than that, the Aborted state is
634	equivalent to PoweredOff.
635
636	There are also a few additional state diagrams that do not deal with
637	virtual machine execution and therefore are shown separately. The states
638	shown on these diagrams are called <i>offline VM states</i> (this includes
639	PoweredOff, Aborted and Saved too).
640
641	The first diagram shows what happens when a lengthy setup operation is
642	being executed (such as <link to="IMachine::attachDevice"/>).
643
644	<pre>
645	+----------------------------------(same state as before the call)------+
646	\| \|
647	+-> PoweredOff --+ \|
648	\| \| \|
649	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
650	\| \|
651	+-> Saved -------+
652	</pre>
653
654	The next two diagrams demonstrate the process of taking a snapshot of a
655	powered off virtual machine, restoring the state to that as of a snapshot
656	or deleting a snapshot, respectively.
657
658	<pre>
659	+----------------------------------(same state as before the call)------+
660	\| \|
661	+-> PoweredOff --+ \|
662	\| +-->[takeSnapshot()] -------------------> Saving ------+
663	+-> Aborted -----+
664
665	+-> PoweredOff --+
666	\| \|
667	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
668	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
669	+-> Saved -------+ \|
670	\| \|
671	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
672	</pre>
673
674	Note that the Saving state is present in both the offline state group and
675	online state group. Currently, the only way to determine what group is
676	assumed in a particular case is to remember the previous machine state: if
677	it was Running or Paused, then Saving is an online state, otherwise it is
678	an offline state. This inconsistency may be removed in one of the future
679	versions of VirtualBox by adding a new state.
680
681	<note internal="yes">
682	For whoever decides to touch this enum: In order to keep the
683	comparisons involving FirstOnline and LastOnline pseudo-states valid,
684	the numeric values of these states must be correspondingly updated if
685	needed: for any online VM state, the condition
686	<tt>FirstOnline <= state <= LastOnline</tt> must be
687	@c true. The same relates to transient states for which
688	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
689	@c true.
690	</note>
691	</desc>
692
693	<const name="Null" value="0">
694	<desc>Null value (never used by the API).</desc>
695	</const>
696	<const name="PoweredOff" value="1">
697	<desc>
698	The machine is not running and has no saved execution state; it has
699	either never been started or been shut down successfully.
700	</desc>
701	</const>
702	<const name="Saved" value="2">
703	<desc>
704	The machine is not currently running, but the execution state of the machine
705	has been saved to an external file when it was running, from where
706	it can be resumed.
707	</desc>
708	</const>
709	<const name="Teleported" value="3">
710	<desc>
711	The machine was teleported to a different host (or process) and then
712	powered off. Take care when powering it on again may corrupt resources
713	it shares with the teleportation target (e.g. disk and network).
714	</desc>
715	</const>
716	<const name="Aborted" value="4">
717	<desc>
718	The process running the machine has terminated abnormally. This may
719	indicate a crash of the VM process in host execution context, or
720	the VM process has been terminated externally.
721	</desc>
722	</const>
723	<const name="Running" value="5">
724	<desc>
725	The machine is currently being executed.
726	<note internal="yes">
727	For whoever decides to touch this enum: In order to keep the
728	comparisons in the old source code valid, this state must immediately
729	precede the Paused state.
730	TODO: Lift this spectacularly wonderful restriction.
731	</note>
732	</desc>
733	</const>
734	<const name="Paused" value="6">
735	<desc>
736	Execution of the machine has been paused.
737	<note internal="yes">
738	For whoever decides to touch this enum: In order to keep the
739	comparisons in the old source code valid, this state must immediately
740	follow the Running state.
741	TODO: Lift this spectacularly wonderful restriction.
742	</note>
743	</desc>
744	</const>
745	<const name="Stuck" value="7">
746	<desc>
747	Execution of the machine has reached the "Guru Meditation"
748	condition. This indicates a severe error in the hypervisor itself.
749	<note internal="yes">
750	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
751	"Guru", perhaps? Or are there some other VMM states that are
752	intended to be lumped in here as well?
753	</note>
754	</desc>
755	</const>
756	<const name="Teleporting" value="8">
757	<desc>
758	The machine is about to be teleported to a different host or process.
759	It is possible to pause a machine in this state, but it will go to the
760	@c TeleportingPausedVM state and it will not be
761	possible to resume it again unless the teleportation fails.
762	</desc>
763	</const>
764	<const name="LiveSnapshotting" value="9">
765	<desc>
766	A live snapshot is being taken. The machine is running normally, but
767	some of the runtime configuration options are inaccessible. Also, if
768	paused while in this state it will transition to
769	@c Saving and it will not be resume the
770	execution until the snapshot operation has completed.
771	</desc>
772	</const>
773	<const name="Starting" value="10">
774	<desc>
775	Machine is being started after powering it on from a
776	zero execution state.
777	</desc>
778	</const>
779	<const name="Stopping" value="11">
780	<desc>
781	Machine is being normally stopped powering it off, or after the guest OS
782	has initiated a shutdown sequence.
783	</desc>
784	</const>
785	<const name="Saving" value="12">
786	<desc>
787	Machine is saving its execution state to a file, or an online
788	snapshot of the machine is being taken.
789	</desc>
790	</const>
791	<const name="Restoring" value="13">
792	<desc>
793	Execution state of the machine is being restored from a file
794	after powering it on from the saved execution state.
795	</desc>
796	</const>
797	<const name="TeleportingPausedVM" value="14">
798	<desc>
799	The machine is being teleported to another host or process, but it is
800	not running. This is the paused variant of the
801	@c state.
802	</desc>
803	</const>
804	<const name="TeleportingIn" value="15">
805	<desc>
806	Teleporting the machine state in from another host or process.
807	</desc>
808	</const>
809	<const name="FaultTolerantSyncing" value="16">
810	<desc>
811	The machine is being synced with a fault tolerant VM running elsewhere.
812	</desc>
813	</const>
814	<const name="DeletingSnapshotOnline" value="17">
815	<desc>
816	Like @c DeletingSnapshot, but the merging of media is ongoing in
817	the background while the machine is running.
818	</desc>
819	</const>
820	<const name="DeletingSnapshotPaused" value="18">
821	<desc>
822	Like @c DeletingSnapshotOnline, but the machine was paused when the
823	merging of differencing media was started.
824	</desc>
825	</const>
826	<const name="RestoringSnapshot" value="19">
827	<desc>
828	A machine snapshot is being restored; this typically does not take long.
829	</desc>
830	</const>
831	<const name="DeletingSnapshot" value="20">
832	<desc>
833	A machine snapshot is being deleted; this can take a long time since this
834	may require merging differencing media. This value indicates that the
835	machine is not running while the snapshot is being deleted.
836	</desc>
837	</const>
838	<const name="SettingUp" value="21">
839	<desc>
840	Lengthy setup operation is in progress.
841	</desc>
842	</const>
843
844	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
845	<desc>
846	Pseudo-state: first online state (for use in relational expressions).
847	</desc>
848	</const>
849	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
850	<desc>
851	Pseudo-state: last online state (for use in relational expressions).
852	</desc>
853	</const>
854
855	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
856	<desc>
857	Pseudo-state: first transient state (for use in relational expressions).
858	</desc>
859	</const>
860	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
861	<desc>
862	Pseudo-state: last transient state (for use in relational expressions).
863	</desc>
864	</const>
865
866	</enum>
867
868	<enum
869	name="SessionState"
870	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
871	>
872	<desc>
873	Session state. This enumeration represents possible values of
874	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
875	attributes.
876	</desc>
877
878	<const name="Null" value="0">
879	<desc>Null value (never used by the API).</desc>
880	</const>
881	<const name="Unlocked" value="1">
882	<desc>
883	In <link to="IMachine::sessionState"/>, this means that the machine
884	is not locked for any sessions.
885
886	In <link to="ISession::state"/>, this means that no machine is
887	currently locked for this session.
888	</desc>
889	</const>
890	<const name="Locked" value="2">
891	<desc>
892	In <link to="IMachine::sessionState"/>, this means that the machine
893	is currently locked for a session, whose process identifier can
894	then be found in the <link to="IMachine::sessionPID" /> attribute.
895
896	In <link to="ISession::state"/>, this means that a machine is
897	currently locked for this session, and the mutable machine object
898	can be found in the <link to="ISession::machine"/> attribute
899	(see <link to="IMachine::lockMachine" /> for details).
900	</desc>
901	</const>
902	<const name="Spawning" value="3">
903	<desc>
904	A new process is being spawned for the machine as a result of
905	<link to="IMachine::launchVMProcess"/> call. This state also occurs
906	as a short transient state during an <link to="IMachine::lockMachine"/>
907	call.
908	</desc>
909	</const>
910	<const name="Unlocking" value="4">
911	<desc>
912	The session is being unlocked.
913	</desc>
914	</const>
915	</enum>
916
917	<enum
918	name="CPUPropertyType"
919	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
920	>
921	<desc>
922	Virtual CPU property type. This enumeration represents possible values of the
923	IMachine get- and setCPUProperty methods.
924	</desc>
925	<const name="Null" value="0">
926	<desc>Null value (never used by the API).</desc>
927	</const>
928	<const name="PAE" value="1">
929	<desc>
930	This setting determines whether VirtualBox will expose the Physical Address
931	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
932	is not available, it will not be reported.
933	</desc>
934	</const>
935	<const name="Synthetic" value="2">
936	<desc>
937	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
938	teleporting between host systems that differ significantly.
939	</desc>
940	</const>
941	</enum>
942
943
944	<enum
945	name="HWVirtExPropertyType"
946	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
947	>
948	<desc>
949	Hardware virtualization property type. This enumeration represents possible values
950	for the <link to="IMachine::getHWVirtExProperty"/> and
951	<link to="IMachine::setHWVirtExProperty"/> methods.
952	</desc>
953	<const name="Null" value="0">
954	<desc>Null value (never used by the API).</desc>
955	</const>
956	<const name="Enabled" value="1">
957	<desc>
958	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
959	such extensions are not available, they will not be used.
960	</desc>
961	</const>
962	<const name="Exclusive" value="2">
963	<desc>
964	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
965	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
966	feature of the host. To share these with other hypervisors, you must disable this property.
967	</desc>
968	</const>
969	<const name="VPID" value="3">
970	<desc>
971	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
972	</desc>
973	</const>
974	<const name="NestedPaging" value="4">
975	<desc>
976	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
977	</desc>
978	</const>
979	<const name="LargePages" value="5">
980	<desc>
981	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
982	</desc>
983	</const>
984	<const name="Force" value="6">
985	<desc>
986	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
987	not set, there will be an automatic fallback to software virtualization.
988	</desc>
989	</const>
990	</enum>
991
992	<enum
993	name="FaultToleranceState"
994	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
995	>
996	<desc>
997	Used with <link to="IMachine::faultToleranceState" />.
998	</desc>
999	<const name="Inactive" value="1">
1000	<desc>No fault tolerance enabled.</desc>
1001	</const>
1002	<const name="Master" value="2">
1003	<desc>Fault tolerant master VM.</desc>
1004	</const>
1005	<const name="Standby" value="3">
1006	<desc>Fault tolerant standby VM.</desc>
1007	</const>
1008	</enum>
1009
1010	<enum
1011	name="LockType"
1012	uuid="168a6a8e-12fd-4878-a1f9-38a750a56089"
1013	>
1014	<desc>
1015	Used with <link to="IMachine::lockMachine" />.
1016	</desc>
1017	<const name="Write" value="2">
1018	<desc>Lock the machine for writing.</desc>
1019	</const>
1020	<const name="Shared" value="1">
1021	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
1022	</const>
1023	<const name="VM" value="3">
1024	<desc>Lock the machine for writing, and create objects necessary for
1025	running a VM in this process.</desc>
1026	</const>
1027	</enum>
1028
1029	<enum
1030	name="SessionType"
1031	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
1032	>
1033	<desc>
1034	Session type. This enumeration represents possible values of the
1035	<link to="ISession::type"/> attribute.
1036	</desc>
1037
1038	<const name="Null" value="0">
1039	<desc>Null value (never used by the API).</desc>
1040	</const>
1041	<const name="WriteLock" value="1">
1042	<desc>
1043	Session has acquired an exclusive write lock on a machine
1044	using <link to="IMachine::lockMachine"/>.
1045	</desc>
1046	</const>
1047	<const name="Remote" value="2">
1048	<desc>
1049	Session has launched a VM process using
1050	<link to="IMachine::launchVMProcess"/>
1051	</desc>
1052	</const>
1053	<const name="Shared" value="3">
1054	<desc>
1055	Session has obtained a link to another session using
1056	<link to="IMachine::lockMachine"/>
1057	</desc>
1058	</const>
1059	</enum>
1060
1061	<enum
1062	name="DeviceType"
1063	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1064	>
1065	<desc>
1066	Device type.
1067	</desc>
1068	<const name="Null" value="0">
1069	<desc>
1070	Null value, may also mean "no device" (not allowed for
1071	<link to="IConsole::getDeviceActivity"/>).
1072	</desc>
1073	</const>
1074	<const name="Floppy" value="1">
1075	<desc>Floppy device.</desc>
1076	</const>
1077	<const name="DVD" value="2">
1078	<desc>CD/DVD-ROM device.</desc>
1079	</const>
1080	<const name="HardDisk" value="3">
1081	<desc>Hard disk device.</desc>
1082	</const>
1083	<const name="Network" value="4">
1084	<desc>Network device.</desc>
1085	</const>
1086	<const name="USB" value="5">
1087	<desc>USB device.</desc>
1088	</const>
1089	<const name="SharedFolder" value="6">
1090	<desc>Shared folder device.</desc>
1091	</const>
1092	</enum>
1093
1094	<enum
1095	name="DeviceActivity"
1096	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1097	>
1098	<desc>
1099	Device activity for <link to="IConsole::getDeviceActivity"/>.
1100	</desc>
1101
1102	<const name="Null" value="0"/>
1103	<const name="Idle" value="1"/>
1104	<const name="Reading" value="2"/>
1105	<const name="Writing" value="3"/>
1106	</enum>
1107
1108	<enum
1109	name="ClipboardMode"
1110	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1111	>
1112	<desc>
1113	Host-Guest clipboard interchange mode.
1114	</desc>
1115
1116	<const name="Disabled" value="0"/>
1117	<const name="HostToGuest" value="1"/>
1118	<const name="GuestToHost" value="2"/>
1119	<const name="Bidirectional" value="3"/>
1120	</enum>
1121
1122	<enum
1123	name="DragAndDropMode"
1124	uuid="b618ea0e-b6fb-4f8d-97f7-5e237e49b547"
1125	>
1126	<desc>
1127	Drag'n'Drop interchange mode.
1128	</desc>
1129
1130	<const name="Disabled" value="0"/>
1131	<const name="HostToGuest" value="1"/>
1132	<const name="GuestToHost" value="2"/>
1133	<const name="Bidirectional" value="3"/>
1134	</enum>
1135
1136	<enum
1137	name="Scope"
1138	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1139	>
1140	<desc>
1141	Scope of the operation.
1142
1143	A generic enumeration used in various methods to define the action or
1144	argument scope.
1145	</desc>
1146
1147	<const name="Global" value="0"/>
1148	<const name="Machine" value="1"/>
1149	<const name="Session" value="2"/>
1150	</enum>
1151
1152	<enum
1153	name="BIOSBootMenuMode"
1154	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1155	>
1156	<desc>
1157	BIOS boot menu mode.
1158	</desc>
1159
1160	<const name="Disabled" value="0"/>
1161	<const name="MenuOnly" value="1"/>
1162	<const name="MessageAndMenu" value="2"/>
1163	</enum>
1164
1165	<enum
1166	name="ProcessorFeature"
1167	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1168	>
1169	<desc>
1170	CPU features.
1171	</desc>
1172
1173	<const name="HWVirtEx" value="0"/>
1174	<const name="PAE" value="1"/>
1175	<const name="LongMode" value="2"/>
1176	<const name="NestedPaging" value="3"/>
1177	</enum>
1178
1179	<enum
1180	name="FirmwareType"
1181	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1182	>
1183	<desc>
1184	Firmware type.
1185	</desc>
1186	<const name="BIOS" value="1">
1187	<desc>BIOS Firmware.</desc>
1188	</const>
1189	<const name="EFI" value="2">
1190	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1191	</const>
1192	<const name="EFI32" value="3">
1193	<desc>Efi firmware, 32-bit.</desc>
1194	</const>
1195	<const name="EFI64" value="4">
1196	<desc>Efi firmware, 64-bit.</desc>
1197	</const>
1198	<const name="EFIDUAL" value="5">
1199	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1200	</const>
1201	</enum>
1202
1203	<enum
1204	name="PointingHIDType"
1205	uuid="e44b2f7b-72ba-44fb-9e53-2186014f0d17"
1206	>
1207	<desc>
1208	Type of pointing device used in a virtual machine.
1209	</desc>
1210	<const name="None" value="1">
1211	<desc>No mouse.</desc>
1212	</const>
1213	<const name="PS2Mouse" value="2">
1214	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1215	</const>
1216	<const name="USBMouse" value="3">
1217	<desc>USB mouse (relative pointer).</desc>
1218	</const>
1219	<const name="USBTablet" value="4">
1220	<desc>USB tablet (absolute pointer).</desc>
1221	</const>
1222	<const name="ComboMouse" value="5">
1223	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1224	Using of such device can have negative performance implications. </desc>
1225	</const>
1226	</enum>
1227
1228	<enum
1229	name="KeyboardHIDType"
1230	uuid="383e43d7-5c7c-4ec8-9cb8-eda1bccd6699"
1231	>
1232	<desc>
1233	Type of keyboard device used in a virtual machine.
1234	</desc>
1235	<const name="None" value="1">
1236	<desc>No keyboard.</desc>
1237	</const>
1238	<const name="PS2Keyboard" value="2">
1239	<desc>PS/2 keyboard.</desc>
1240	</const>
1241	<const name="USBKeyboard" value="3">
1242	<desc>USB keyboard.</desc>
1243	</const>
1244	<const name="ComboKeyboard" value="4">
1245	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1246	Using of such device can have negative performance implications. </desc>
1247	</const>
1248	</enum>
1249
1250	<!--
1251	// IVirtualBoxErrorInfo
1252	/////////////////////////////////////////////////////////////////////////
1253	-->
1254
1255	<interface
1256	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1257	uuid="f91e6e91-49e1-4fd2-b21e-269003350d06"
1258	supportsErrorInfo="no"
1259	wsmap="managed"
1260	>
1261	<desc>
1262	The IVirtualBoxErrorInfo interface represents extended error information.
1263
1264	Extended error information can be set by VirtualBox components after
1265	unsuccessful or partially successful method invocation. This information
1266	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1267	and then shown to the client in addition to the plain 32-bit result code.
1268
1269	In MS COM, this interface extends the IErrorInfo interface,
1270	in XPCOM, it extends the nsIException interface. In both cases,
1271	it provides a set of common attributes to retrieve error
1272	information.
1273
1274	Sometimes invocation of some component's method may involve methods of
1275	other components that may also fail (independently of this method's
1276	failure), or a series of non-fatal errors may precede a fatal error that
1277	causes method failure. In cases like that, it may be desirable to preserve
1278	information about all errors happened during method invocation and deliver
1279	it to the caller. The <link to="#next"/> attribute is intended
1280	specifically for this purpose and allows to represent a chain of errors
1281	through a single IVirtualBoxErrorInfo object set after method invocation.
1282
1283	<note>errors are stored to a chain in the reverse order, i.e. the
1284	initial error object you query right after method invocation is the last
1285	error set by the callee, the object it points to in the @a next attribute
1286	is the previous error and so on, up to the first error (which is the last
1287	in the chain).</note>
1288	</desc>
1289
1290	<attribute name="resultCode" type="long" readonly="yes">
1291	<desc>
1292	Result code of the error.
1293	Usually, it will be the same as the result code returned
1294	by the method that provided this error information, but not
1295	always. For example, on Win32, CoCreateInstance() will most
1296	likely return E_NOINTERFACE upon unsuccessful component
1297	instantiation attempt, but not the value the component factory
1298	returned. Value is typed 'long', not 'result',
1299	to make interface usable from scripting languages.
1300	<note>
1301	In MS COM, there is no equivalent.
1302	In XPCOM, it is the same as nsIException::result.
1303	</note>
1304	</desc>
1305	</attribute>
1306
1307	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1308	<desc>
1309	UUID of the interface that defined the error.
1310	<note>
1311	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1312	data type.
1313	In XPCOM, there is no equivalent.
1314	</note>
1315	</desc>
1316	</attribute>
1317
1318	<attribute name="component" type="wstring" readonly="yes">
1319	<desc>
1320	Name of the component that generated the error.
1321	<note>
1322	In MS COM, it is the same as IErrorInfo::GetSource.
1323	In XPCOM, there is no equivalent.
1324	</note>
1325	</desc>
1326	</attribute>
1327
1328	<attribute name="text" type="wstring" readonly="yes">
1329	<desc>
1330	Text description of the error.
1331	<note>
1332	In MS COM, it is the same as IErrorInfo::GetDescription.
1333	In XPCOM, it is the same as nsIException::message.
1334	</note>
1335	</desc>
1336	</attribute>
1337
1338	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1339	<desc>
1340	Next error object if there is any, or @c null otherwise.
1341	<note>
1342	In MS COM, there is no equivalent.
1343	In XPCOM, it is the same as nsIException::inner.
1344	</note>
1345	</desc>
1346	</attribute>
1347
1348	</interface>
1349
1350	<!--
1351	// IVirtualBox
1352	/////////////////////////////////////////////////////////////////////////
1353	-->
1354	<!-- This is experimental interface to LWIP based NAT server -->
1355	<interface name="INATNetwork" extends="$unknown"
1356	uuid="03DFD6F7-1B78-48A3-8345-C785281E9523"
1357	wsmap="managed">
1358	<attribute name="NetworkName" type="wstring">
1359	<desc>
1360	TBD: the idea, technically we can start any number of the NAT networks,
1361	but we should expect that at some point we will get collisions because of
1362	port-forwanding rules. so perhaps we should support only single instance of NAT
1363	network.
1364	</desc>
1365	</attribute>
1366	<attribute name="enabled" type="boolean"/>
1367	<attribute name="network" type="wstring">
1368	<desc>
1369	This is CIDR IPv4 string. Specifiying it user defines IPv4 addresses
1370	of gateway (low address + 1) and dhcp server (= low address + 2).
1371	Note: if there're defined IPv4 port-forward rules update of network
1372	will be ignored (because new assignment could break existing rules).
1373	</desc>
1374	</attribute>
1375	<attribute name="gateway" type="wstring" readonly="yes">
1376	<desc>
1377	This attribute is read-only. It's recalculated on changing
1378	network attribute (low address of network + 1).
1379	</desc>
1380	</attribute>
1381	<attribute name="IPv6Enabled" type="boolean">
1382	<desc>
1383	This attribute define whether gateway will support IPv6 or not.
1384	</desc>
1385	</attribute>
1386	<attribute name="IPv6Prefix" type="wstring">
1387	<desc>
1388	This a CIDR IPv6 defining prefix for link-local addresses autoconfiguration within network. Note: ignored if attribute ipv6enabled is false.
1389	</desc>
1390	</attribute>
1391	<attribute name="advertiseDefaultIPv6RouteEnabled" type="boolean"/>
1392	<attribute name="needDhcpServer" type="boolean"/>
1393	<attribute name="eventSource" type="IEventSource" readonly="yes"/>
1394	<attribute name="portForwardRules4" type="wstring" readonly="yes" safearray="yes">
1395	<desc>Array of NAT port-forwarding rules in string representation,
1396	in the following format:
1397	"name:protocolid:[host ip]:host port:[guest ip]:guest port".
1398	</desc>
1399	</attribute>
1400	<attribute name="portForwardRules6" type="wstring" readonly="yes" safearray="yes">
1401	<desc>Array of NAT port-forwarding rules in string representation, in the
1402	following format: "name:protocolid:[host ip]:host port:[guest ip]:guest port".
1403	</desc>
1404	</attribute>
1405	<method name="addPortForwardRule">
1406	<param name="isIpv6" type="boolean" dir="in"/>
1407	<param name="ruleName" type="wstring" dir="in"/>
1408	<param name="proto" type="NATProtocol" dir="in">
1409	<desc>Protocol handled with the rule.</desc>
1410	</param>
1411	<param name="hostIP" type="wstring" dir="in">
1412	<desc>IP of the host interface to which the rule should apply.
1413	An empty ip address is acceptable, in which case the NAT engine
1414	binds the handling socket to any interface.
1415	</desc>
1416	</param>
1417	<param name="hostPort" type="unsigned short" dir="in">
1418	<desc>The port number to listen on.</desc>
1419	</param>
1420	<param name="guestIP" type="wstring" dir="in">
1421	<desc>The IP address of the guest which the NAT engine will forward
1422	matching packets to. An empty IP address is not acceptable.</desc>
1423	</param>
1424	<param name="guestPort" type="unsigned short" dir="in">
1425	<desc>The port number to forward.</desc>
1426	</param>
1427	</method>
1428	<method name="removePortForwardRule">
1429	<param name="iSipv6" type="boolean" dir="in"/>
1430	<param name="ruleName" type="wstring" dir="in"/>
1431	</method>
1432	<method name="start">
1433	<param name="trunkType" type="wstring" dir="in">
1434	<desc>
1435	Type of internal network trunk.
1436	</desc>
1437	</param>
1438	</method>
1439	<method name="stop"/>
1440	</interface>
1441
1442	<interface
1443	name="IDHCPServer" extends="$unknown"
1444	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1445	wsmap="managed"
1446	>
1447	<desc>
1448	The IDHCPServer interface represents the vbox DHCP server configuration.
1449
1450	To enumerate all the DHCP servers on the host, use the
1451	<link to="IVirtualBox::DHCPServers"/> attribute.
1452	</desc>
1453
1454	<attribute name="enabled" type="boolean">
1455	<desc>
1456	specifies if the DHCP server is enabled
1457	</desc>
1458	</attribute>
1459
1460	<attribute name="IPAddress" type="wstring" readonly="yes">
1461	<desc>
1462	specifies server IP
1463	</desc>
1464	</attribute>
1465
1466	<attribute name="networkMask" type="wstring" readonly="yes">
1467	<desc>
1468	specifies server network mask
1469	</desc>
1470	</attribute>
1471
1472	<attribute name="networkName" type="wstring" readonly="yes">
1473	<desc>
1474	specifies internal network name the server is used for
1475	</desc>
1476	</attribute>
1477
1478	<attribute name="lowerIP" type="wstring" readonly="yes">
1479	<desc>
1480	specifies from IP address in server address range
1481	</desc>
1482	</attribute>
1483
1484	<attribute name="upperIP" type="wstring" readonly="yes">
1485	<desc>
1486	specifies to IP address in server address range
1487	</desc>
1488	</attribute>
1489
1490	<method name="setConfiguration">
1491	<desc>
1492	configures the server
1493	<result name="E_INVALIDARG">
1494	invalid configuration supplied
1495	</result>
1496	</desc>
1497	<param name="IPAddress" type="wstring" dir="in">
1498	<desc>
1499	server IP address
1500	</desc>
1501	</param>
1502	<param name="networkMask" type="wstring" dir="in">
1503	<desc>
1504	server network mask
1505	</desc>
1506	</param>
1507	<param name="FromIPAddress" type="wstring" dir="in">
1508	<desc>
1509	server From IP address for address range
1510	</desc>
1511	</param>
1512	<param name="ToIPAddress" type="wstring" dir="in">
1513	<desc>
1514	server To IP address for address range
1515	</desc>
1516	</param>
1517	</method>
1518
1519	<method name="start">
1520	<desc>
1521	Starts DHCP server process.
1522	<result name="E_FAIL">
1523	Failed to start the process.
1524	</result>
1525	</desc>
1526	<param name="networkName" type="wstring" dir="in">
1527	<desc>
1528	Name of internal network DHCP server should attach to.
1529	</desc>
1530	</param>
1531	<param name="trunkName" type="wstring" dir="in">
1532	<desc>
1533	Name of internal network trunk.
1534	</desc>
1535	</param>
1536	<param name="trunkType" type="wstring" dir="in">
1537	<desc>
1538	Type of internal network trunk.
1539	</desc>
1540	</param>
1541	</method>
1542
1543	<method name="stop">
1544	<desc>
1545	Stops DHCP server process.
1546	<result name="E_FAIL">
1547	Failed to stop the process.
1548	</result>
1549	</desc>
1550	</method>
1551	</interface>
1552
1553	<interface
1554	name="IVirtualBox" extends="$unknown"
1555	uuid="fafa4e17-1ee2-4905-a10e-fe7c18bf5554"
1556	wsmap="managed"
1557	>
1558	<desc>
1559	The IVirtualBox interface represents the main interface exposed by the
1560	product that provides virtual machine management.
1561
1562	An instance of IVirtualBox is required for the product to do anything
1563	useful. Even though the interface does not expose this, internally,
1564	IVirtualBox is implemented as a singleton and actually lives in the
1565	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1566	IVirtualBox can track the state of all virtual machines on a particular
1567	host, regardless of which frontend started them.
1568
1569	To enumerate all the virtual machines on the host, use the
1570	<link to="IVirtualBox::machines"/> attribute.
1571	</desc>
1572
1573	<attribute name="version" type="wstring" readonly="yes">
1574	<desc>
1575	A string representing the version number of the product. The
1576	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1577	last number represents the build number and will frequently change.
1578
1579	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1580	in prerelease builds. Non-Oracle builds may (/shall) also have a
1581	publisher tag, at the end. The publisher tag starts with an underscore
1582	just like the prerelease build type tag.
1583	</desc>
1584	</attribute>
1585
1586	<attribute name="versionNormalized" type="wstring" readonly="yes">
1587	<desc>
1588	A string representing the version number of the product,
1589	without the publisher information (but still with other tags).
1590	See <link to="#version" />.
1591	</desc>
1592	</attribute>
1593
1594	<attribute name="revision" type="unsigned long" readonly="yes">
1595	<desc>
1596	The internal build revision number of the product.
1597	</desc>
1598	</attribute>
1599
1600	<attribute name="packageType" type="wstring" readonly="yes">
1601	<desc>
1602	A string representing the package type of this product. The
1603	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1604	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1605	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1606	this.
1607	</desc>
1608	</attribute>
1609
1610	<attribute name="APIVersion" type="wstring" readonly="yes">
1611	<desc>
1612	A string representing the VirtualBox API version number. The format is
1613	2 integer numbers divided by an underscore (e.g. 1_0). After the
1614	first public release of packages with a particular API version the
1615	API will not be changed in an incompatible way. Note that this
1616	guarantee does not apply to development builds, and also there is no
1617	guarantee that this version is identical to the first two integer
1618	numbers of the package version.
1619	</desc>
1620	</attribute>
1621
1622	<attribute name="homeFolder" type="wstring" readonly="yes">
1623	<desc>
1624	Full path to the directory where the global settings file,
1625	<tt>VirtualBox.xml</tt>, is stored.
1626
1627	In this version of VirtualBox, the value of this property is
1628	always <tt><user_dir>/.VirtualBox</tt> (where
1629	<tt><user_dir></tt> is the path to the user directory,
1630	as determined by the host OS), and cannot be changed.
1631
1632	This path is also used as the base to resolve relative paths in
1633	places where relative paths are allowed (unless otherwise
1634	expressly indicated).
1635	</desc>
1636	</attribute>
1637
1638	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1639	<desc>
1640	Full name of the global settings file.
1641	The value of this property corresponds to the value of
1642	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1643	</desc>
1644	</attribute>
1645
1646	<attribute name="host" type="IHost" readonly="yes">
1647	<desc>Associated host object.</desc>
1648	</attribute>
1649
1650	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1651	<desc>Associated system information object.</desc>
1652	</attribute>
1653
1654	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1655	<desc>
1656	Array of machine objects registered within this VirtualBox instance.
1657	</desc>
1658	</attribute>
1659
1660	<attribute name="machineGroups" type="wstring" readonly="yes" safearray="yes">
1661	<desc>
1662	Array of all machine group names which are used by the machines which
1663	are accessible. Each group is only listed once, however they are listed
1664	in no particular order and there is no guarantee that there are no gaps
1665	in the group hierarchy (i.e. <tt>"/"</tt>, <tt>"/group/subgroup"</tt>
1666	is a valid result).
1667	</desc>
1668	</attribute>
1669
1670	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1671	<desc>
1672	Array of medium objects known to this VirtualBox installation.
1673
1674	This array contains only base media. All differencing
1675	media of the given base medium can be enumerated using
1676	<link to="IMedium::children"/>.
1677	</desc>
1678	</attribute>
1679
1680	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1681	<desc>
1682	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1683	</desc>
1684	</attribute>
1685
1686	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1687	<desc>
1688	Array of floppy image objects currently in use by this VirtualBox instance.
1689	</desc>
1690	</attribute>
1691
1692	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1693
1694	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1695
1696	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1697	<desc>
1698	Collection of global shared folders. Global shared folders are
1699	available to all virtual machines.
1700
1701	New shared folders are added to the collection using
1702	<link to="#createSharedFolder"/>. Existing shared folders can be
1703	removed using <link to="#removeSharedFolder"/>.
1704
1705	<note>
1706	In the current version of the product, global shared folders are not
1707	implemented and therefore this collection is always empty.
1708	</note>
1709	</desc>
1710	</attribute>
1711
1712	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1713	<desc>
1714	Associated performance collector object.
1715	</desc>
1716	</attribute>
1717
1718	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1719	<desc>
1720	DHCP servers.
1721	</desc>
1722	</attribute>
1723	<!-- Array of NAT networks -->
1724	<attribute name="NATNetworks" type="INATNetwork" safearray="yes" readonly="yes"/>
1725
1726	<attribute name="eventSource" type="IEventSource" readonly="yes">
1727	<desc>
1728	Event source for VirtualBox events.
1729	</desc>
1730	</attribute>
1731
1732	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1733	<desc>
1734	The extension pack manager.
1735	</desc>
1736	</attribute>
1737
1738
1739	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1740	<desc>
1741	Names of all internal networks.
1742	</desc>
1743	</attribute>
1744
1745	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1746	<desc>
1747	Names of all generic network drivers.
1748	</desc>
1749	</attribute>
1750
1751	<method name="composeMachineFilename">
1752	<desc>
1753	Returns a recommended full path of the settings file name for a new virtual
1754	machine.
1755
1756	This API serves two purposes:
1757
1758	<ul>
1759	<li>It gets called by <link to="#createMachine" /> if @c null or
1760	empty string (which is recommended) is specified for the
1761	@a settingsFile argument there, which means that API should use
1762	a recommended default file name.</li>
1763
1764	<li>It can be called manually by a client software before creating a machine,
1765	e.g. if that client wants to pre-create the machine directory to create
1766	virtual hard disks in that directory together with the new machine
1767	settings file. In that case, the file name should be stripped from the
1768	full settings file path returned by this function to obtain the
1769	machine directory.</li>
1770	</ul>
1771
1772	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1773	details about the machine name.
1774
1775	@a groupName defines which additional subdirectory levels should be
1776	included. It must be either a valid group name or @c null or empty
1777	string which designates that the machine will not be related to a
1778	machine group.
1779
1780	If @a baseFolder is a @c null or empty string (which is recommended), the
1781	default machine settings folder
1782	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1783	a base folder for the created machine, resulting in a file name like
1784	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1785	will be used.
1786
1787	This method does not access the host disks. In particular, it does not check
1788	for whether a machine with this name already exists.
1789	</desc>
1790	<param name="name" type="wstring" dir="in">
1791	<desc>Suggested machine name.</desc>
1792	</param>
1793	<param name="group" type="wstring" dir="in">
1794	<desc>Machine group name for the new machine or machine group. It is
1795	used to determine the right subdirectory.</desc>
1796	</param>
1797	<param name="createFlags" type="wstring" dir="in">
1798	<desc>Machine creation flags, see <link to="#createMachine" /> (optional).</desc>
1799	</param>
1800	<param name="baseFolder" type="wstring" dir="in">
1801	<desc>Base machine folder (optional).</desc>
1802	</param>
1803	<param name="file" type="wstring" dir="return">
1804	<desc>Fully qualified path where the machine would be created.</desc>
1805	</param>
1806	</method>
1807
1808	<method name="createMachine">
1809	<desc>
1810	Creates a new virtual machine by creating a machine settings file at
1811	the given location.
1812
1813	VirtualBox machine settings files use a custom XML dialect. Starting
1814	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1815	and machine files can be created at arbitrary locations.
1816
1817	However, it is recommended that machines are created in the default
1818	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1819	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1820	@c null or empty string (which is recommended) for the @a settingsFile
1821	argument, <link to="#composeMachineFilename" /> is called automatically
1822	to have such a recommended name composed based on the machine name
1823	given in the @a name argument and the primary group.
1824
1825	If the resulting settings file already exists, this method will fail,
1826	unless the forceOverwrite flag is set.
1827
1828	The new machine is created unregistered, with the initial configuration
1829	set according to the specified guest OS type. A typical sequence of
1830	actions to create a new virtual machine is as follows:
1831
1832	<ol>
1833	<li>
1834	Call this method to have a new machine created. The returned machine
1835	object will be "mutable" allowing to change any machine property.
1836	</li>
1837
1838	<li>
1839	Configure the machine using the appropriate attributes and methods.
1840	</li>
1841
1842	<li>
1843	Call <link to="IMachine::saveSettings" /> to write the settings
1844	to the machine's XML settings file. The configuration of the newly
1845	created machine will not be saved to disk until this method is
1846	called.
1847	</li>
1848
1849	<li>
1850	Call <link to="#registerMachine" /> to add the machine to the list
1851	of machines known to VirtualBox.
1852	</li>
1853	</ol>
1854
1855	The specified guest OS type identifier must match an ID of one of known
1856	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1857	array.
1858
1859	<note>
1860	There is no way to change the name of the settings file or
1861	subfolder of the created machine directly.
1862	</note>
1863
1864	<result name="VBOX_E_OBJECT_NOT_FOUND">
1865	@a osTypeId is invalid.
1866	</result>
1867	<result name="VBOX_E_FILE_ERROR">
1868	Resulting settings file name is invalid or the settings file already
1869	exists or could not be created due to an I/O error.
1870	</result>
1871	<result name="E_INVALIDARG">
1872	@a name is empty or @c null.
1873	</result>
1874	</desc>
1875
1876	<param name="settingsFile" type="wstring" dir="in">
1877	<desc>Fully qualified path where the settings file should be created,
1878	empty string or @c null for a default folder and file based on the
1879	@a name argument and the primary group.
1880	(see <link to="#composeMachineFilename" />).</desc>
1881	</param>
1882	<param name="name" type="wstring" dir="in">
1883	<desc>Machine name.</desc>
1884	</param>
1885	<param name="groups" type="wstring" safearray="yes" dir="in">
1886	<desc>Array of group names. @c null or an empty array have the same
1887	meaning as an array with just the empty string or <tt>"/"</tt>, i.e.
1888	create a machine without group association.</desc>
1889	</param>
1890	<param name="osTypeId" type="wstring" dir="in">
1891	<desc>Guest OS Type ID.</desc>
1892	</param>
1893	<param name="flags" type="wstring" dir="in">
1894	<desc>
1895	Additional property parameters, passed as a comma-separated list of
1896	"name=value" type entries. The following ones are recognized:
1897	<tt>forceOverwrite=1</tt> to overwrite an existing machine settings
1898	file, <tt>UUID=<uuid></tt> to specify a machine UUID and
1899	<tt>directoryIncludesUUID=1</tt> to switch to a special VM directory
1900	naming scheme which should not be used unless necessary.
1901	</desc>
1902	</param>
1903	<param name="machine" type="IMachine" dir="return">
1904	<desc>Created machine object.</desc>
1905	</param>
1906	</method>
1907
1908	<method name="openMachine">
1909	<desc>
1910	Opens a virtual machine from the existing settings file.
1911	The opened machine remains unregistered until you call
1912	<link to="#registerMachine"/>.
1913
1914	The specified settings file name must be fully qualified.
1915	The file must exist and be a valid machine XML settings file
1916	whose contents will be used to construct the machine object.
1917
1918	<result name="VBOX_E_FILE_ERROR">
1919	Settings file name invalid, not found or sharing violation.
1920	</result>
1921	</desc>
1922	<param name="settingsFile" type="wstring" dir="in">
1923	<desc>
1924	Name of the machine settings file.
1925	</desc>
1926	</param>
1927	<param name="machine" type="IMachine" dir="return">
1928	<desc>Opened machine object.</desc>
1929	</param>
1930	<note>
1931	<link to="IMachine::settingsModified"/> will return
1932	@c false for the created machine, until any of machine settings
1933	are changed.
1934	</note>
1935	</method>
1936
1937	<method name="registerMachine">
1938	<desc>
1939
1940	Registers the machine previously created using
1941	<link to="#createMachine"/> or opened using
1942	<link to="#openMachine"/> within this VirtualBox installation. After
1943	successful method invocation, the
1944	<link to="IMachineRegisteredEvent"/> event is fired.
1945
1946	<note>
1947	This method implicitly calls <link to="IMachine::saveSettings"/>
1948	to save all current machine settings before registering it.
1949	</note>
1950
1951	<result name="VBOX_E_OBJECT_NOT_FOUND">
1952	No matching virtual machine found.
1953	</result>
1954	<result name="VBOX_E_INVALID_OBJECT_STATE">
1955	Virtual machine was not created within this VirtualBox instance.
1956	</result>
1957
1958	</desc>
1959	<param name="machine" type="IMachine" dir="in"/>
1960	</method>
1961
1962	<method name="findMachine">
1963	<desc>
1964	Attempts to find a virtual machine given its name or UUID.
1965
1966	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1967	cannot safely be determined.</note>
1968
1969	<result name="VBOX_E_OBJECT_NOT_FOUND">
1970	Could not find registered machine matching @a nameOrId.
1971	</result>
1972
1973	</desc>
1974	<param name="nameOrId" type="wstring" dir="in">
1975	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1976	</param>
1977	<param name="machine" type="IMachine" dir="return">
1978	<desc>Machine object, if found.</desc>
1979	</param>
1980	</method>
1981
1982	<method name="getMachinesByGroups">
1983	<desc>
1984	Gets all machine references which are in one of the specified groups.
1985	</desc>
1986	<param name="groups" type="wstring" dir="in" safearray="yes">
1987	<desc>What groups to match. The usual group list rules apply, i.e.
1988	passing an empty list will match VMs in the toplevel group, likewise
1989	the empty string.</desc>
1990	</param>
1991	<param name="machines" type="IMachine" dir="return" safearray="yes">
1992	<desc>All machines which matched.</desc>
1993	</param>
1994	</method>
1995
1996	<method name="getMachineStates">
1997	<desc>
1998	Gets the state of several machines in a single operation.
1999	</desc>
2000	<param name="machines" type="IMachine" dir="in" safearray="yes">
2001	<desc>Array with the machine references.</desc>
2002	</param>
2003	<param name="states" type="MachineState" dir="return" safearray="yes">
2004	<desc>Machine states, corresponding to the machines.</desc>
2005	</param>
2006	</method>
2007
2008	<method name="createAppliance">
2009	<desc>
2010	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
2011	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
2012	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
2013	</desc>
2014	<param name="appliance" type="IAppliance" dir="return">
2015	<desc>New appliance.</desc>
2016	</param>
2017	</method>
2018
2019	<method name="createHardDisk">
2020	<desc>
2021	Creates a new base medium object that will use the given storage
2022	format and location for medium data.
2023
2024	The actual storage unit is not created by this method. In order to
2025	do it, and before you are able to attach the created medium to
2026	virtual machines, you must call one of the following methods to
2027	allocate a format-specific storage unit at the specified location:
2028	<ul>
2029	<li><link to="IMedium::createBaseStorage"/></li>
2030	<li><link to="IMedium::createDiffStorage"/></li>
2031	</ul>
2032
2033	Some medium attributes, such as <link to="IMedium::id"/>, may
2034	remain uninitialized until the medium storage unit is successfully
2035	created by one of the above methods.
2036
2037	After the storage unit is successfully created, it will be
2038	accessible through the <link to="#openMedium"/> method and can
2039	be found in the <link to="#hardDisks"/> array.
2040
2041	The list of all storage formats supported by this VirtualBox
2042	installation can be obtained using
2043	<link to="ISystemProperties::mediumFormats"/>. If the @a format
2044	attribute is empty or @c null then the default storage format
2045	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
2046	be used for creating a storage unit of the medium.
2047
2048	Note that the format of the location string is storage format specific.
2049	See <link to="IMedium::location"/> and IMedium for more details.
2050
2051	<result name="VBOX_E_OBJECT_NOT_FOUND">
2052	@a format identifier is invalid. See
2053	<link to="ISystemProperties::mediumFormats"/>.
2054	</result>
2055	<result name="VBOX_E_FILE_ERROR">
2056	@a location is a not valid file name (for file-based formats only).
2057	</result>
2058	</desc>
2059	<param name="format" type="wstring" dir="in">
2060	<desc>
2061	Identifier of the storage format to use for the new medium.
2062	</desc>
2063	</param>
2064	<param name="location" type="wstring" dir="in">
2065	<desc>
2066	Location of the storage unit for the new medium.
2067	</desc>
2068	</param>
2069	<param name="medium" type="IMedium" dir="return">
2070	<desc>Created medium object.</desc>
2071	</param>
2072	</method>
2073
2074	<method name="openMedium">
2075	<desc>
2076	Finds existing media or opens a medium from an existing storage location.
2077
2078	Once a medium has been opened, it can be passed to other VirtualBox
2079	methods, in particular to <link to="IMachine::attachDevice" />.
2080
2081	Depending on the given device type, the file at the storage location
2082	must be in one of the media formats understood by VirtualBox:
2083
2084	<ul>
2085	<li>With a "HardDisk" device type, the file must be a hard disk image
2086	in one of the formats supported by VirtualBox (see
2087	<link to="ISystemProperties::mediumFormats" />).
2088	After this method succeeds, if the medium is a base medium, it
2089	will be added to the <link to="#hardDisks"/> array attribute. </li>
2090	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
2091	After this method succeeds, the medium will be added to the
2092	<link to="#DVDImages"/> array attribute.</li>
2093	<li>With a "Floppy" device type, the file must be an RAW floppy image.
2094	After this method succeeds, the medium will be added to the
2095	<link to="#floppyImages"/> array attribute.</li>
2096	</ul>
2097
2098	After having been opened, the medium can be re-found by this method
2099	and can be attached to virtual machines. See <link to="IMedium" /> for
2100	more details.
2101
2102	The UUID of the newly opened medium will either be retrieved from the
2103	storage location, if the format supports it (e.g. for hard disk images),
2104	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
2105	If for some reason you need to change the medium's UUID, use
2106	<link to="IMedium::setIds" />.
2107
2108	If a differencing hard disk medium is to be opened by this method, the
2109	operation will succeed only if its parent medium and all ancestors,
2110	if any, are already known to this VirtualBox installation (for example,
2111	were opened by this method before).
2112
2113	This method attempts to guess the storage format of the specified medium
2114	by reading medium data at the specified location.
2115
2116	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
2117	the image is opened for read/write access and must have according permissions,
2118	as VirtualBox may actually write status information into the disk's metadata
2119	sections.
2120
2121	Note that write access is required for all typical hard disk usage in VirtualBox,
2122	since VirtualBox may need to write metadata such as a UUID into the image.
2123	The only exception is opening a source image temporarily for copying and
2124	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
2125	again soon.
2126
2127	The format of the location string is storage format specific. See
2128	<link to="IMedium::location"/> and IMedium for more details.
2129
2130	<result name="VBOX_E_FILE_ERROR">
2131	Invalid medium storage file location or could not find the medium
2132	at the specified location.
2133	</result>
2134	<result name="VBOX_E_IPRT_ERROR">
2135	Could not get medium storage format.
2136	</result>
2137	<result name="E_INVALIDARG">
2138	Invalid medium storage format.
2139	</result>
2140	<result name="VBOX_E_INVALID_OBJECT_STATE">
2141	Medium has already been added to a media registry.
2142	</result>
2143	</desc>
2144	<param name="location" type="wstring" dir="in">
2145	<desc>
2146	Location of the storage unit that contains medium data in one of
2147	the supported storage formats.
2148	</desc>
2149	</param>
2150	<param name="deviceType" type="DeviceType" dir="in">
2151	<desc>
2152	Must be one of "HardDisk", "DVD" or "Floppy".
2153	</desc>
2154	</param>
2155	<param name="accessMode" type="AccessMode" dir="in">
2156	<desc>Whether to open the image in read/write or read-only mode. For
2157	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
2158	</param>
2159	<param name="forceNewUuid" type="boolean" dir="in">
2160	<desc>Allows the caller to request a completely new medium UUID for
2161	the image which is to be opened. Useful if one intends to open an exact
2162	copy of a previously opened image, as this would normally fail due to
2163	the duplicate UUID.</desc>
2164	</param>
2165	<param name="medium" type="IMedium" dir="return">
2166	<desc>Opened medium object.</desc>
2167	</param>
2168	</method>
2169
2170	<method name="getGuestOSType">
2171	<desc>
2172	Returns an object describing the specified guest OS type.
2173
2174	The requested guest OS type is specified using a string which is a
2175	mnemonic identifier of the guest operating system, such as
2176	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2177	particular virtual machine can be read or set using the
2178	<link to="IMachine::OSTypeId"/> attribute.
2179
2180	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2181	available guest OS type objects. Each object has an
2182	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2183	the guest OS this object describes.
2184
2185	<result name="E_INVALIDARG">
2186	@a id is not a valid Guest OS type.
2187	</result>
2188
2189	</desc>
2190	<param name="id" type="uuid" mod="string" dir="in">
2191	<desc>Guest OS type ID string.</desc>
2192	</param>
2193	<param name="type" type="IGuestOSType" dir="return">
2194	<desc>Guest OS type object.</desc>
2195	</param>
2196	</method>
2197
2198	<method name="createSharedFolder">
2199	<desc>
2200	Creates a new global shared folder by associating the given logical
2201	name with the given host path, adds it to the collection of shared
2202	folders and starts sharing it. Refer to the description of
2203	<link to="ISharedFolder"/> to read more about logical names.
2204	<note>
2205	In the current implementation, this operation is not
2206	implemented.
2207	</note>
2208	</desc>
2209	<param name="name" type="wstring" dir="in">
2210	<desc>Unique logical name of the shared folder.</desc>
2211	</param>
2212	<param name="hostPath" type="wstring" dir="in">
2213	<desc>Full path to the shared folder in the host file system.</desc>
2214	</param>
2215	<param name="writable" type="boolean" dir="in">
2216	<desc>Whether the share is writable or readonly</desc>
2217	</param>
2218	<param name="automount" type="boolean" dir="in">
2219	<desc>Whether the share gets automatically mounted by the guest
2220	or not.</desc>
2221	</param>
2222	</method>
2223
2224	<method name="removeSharedFolder">
2225	<desc>
2226	Removes the global shared folder with the given name previously
2227	created by <link to="#createSharedFolder"/> from the collection of
2228	shared folders and stops sharing it.
2229	<note>
2230	In the current implementation, this operation is not
2231	implemented.
2232	</note>
2233	</desc>
2234	<param name="name" type="wstring" dir="in">
2235	<desc>Logical name of the shared folder to remove.</desc>
2236	</param>
2237	</method>
2238
2239	<method name="getExtraDataKeys">
2240	<desc>
2241	Returns an array representing the global extra data keys which currently
2242	have values defined.
2243	</desc>
2244	<param name="keys" type="wstring" dir="return" safearray="yes">
2245	<desc>Array of extra data keys.</desc>
2246	</param>
2247	</method>
2248
2249	<method name="getExtraData">
2250	<desc>
2251	Returns associated global extra data.
2252
2253	If the requested data @a key does not exist, this function will
2254	succeed and return an empty string in the @a value argument.
2255
2256	<result name="VBOX_E_FILE_ERROR">
2257	Settings file not accessible.
2258	</result>
2259	<result name="VBOX_E_XML_ERROR">
2260	Could not parse the settings file.
2261	</result>
2262
2263	</desc>
2264	<param name="key" type="wstring" dir="in">
2265	<desc>Name of the data key to get.</desc>
2266	</param>
2267	<param name="value" type="wstring" dir="return">
2268	<desc>Value of the requested data key.</desc>
2269	</param>
2270	</method>
2271
2272	<method name="setExtraData">
2273	<desc>
2274	Sets associated global extra data.
2275
2276	If you pass @c null or empty string as a key @a value, the given @a key
2277	will be deleted.
2278
2279	<note>
2280	Before performing the actual data change, this method will ask all
2281	registered event listener using the
2282	<link to="IExtraDataCanChangeEvent"/>
2283	notification for a permission. If one of the listeners refuses the
2284	new value, the change will not be performed.
2285	</note>
2286	<note>
2287	On success, the
2288	<link to="IExtraDataChangedEvent"/> notification
2289	is called to inform all registered listeners about a successful data
2290	change.
2291	</note>
2292
2293	<result name="VBOX_E_FILE_ERROR">
2294	Settings file not accessible.
2295	</result>
2296	<result name="VBOX_E_XML_ERROR">
2297	Could not parse the settings file.
2298	</result>
2299	<result name="E_ACCESSDENIED">
2300	Modification request refused.
2301	</result>
2302
2303	</desc>
2304	<param name="key" type="wstring" dir="in">
2305	<desc>Name of the data key to set.</desc>
2306	</param>
2307	<param name="value" type="wstring" dir="in">
2308	<desc>Value to assign to the key.</desc>
2309	</param>
2310	</method>
2311
2312	<method name="setSettingsSecret">
2313	<desc>
2314	Unlocks the secret data by passing the unlock password to the
2315	server. The server will cache the password for that machine.
2316
2317	<result name="VBOX_E_INVALID_VM_STATE">
2318	Virtual machine is not mutable.
2319	</result>
2320
2321	</desc>
2322	<param name="password" type="wstring" dir="in">
2323	<desc>
2324	The cipher key.
2325	</desc>
2326	</param>
2327	</method>
2328
2329	<!--method name="createDHCPServerForInterface">
2330	<desc>
2331	Creates a DHCP server settings to be used for the given interface
2332	<result name="E_INVALIDARG">
2333	Host network interface @a name already exists.
2334	</result>
2335	</desc>
2336	<param name="interface" type="IHostNetworkInterface" dir="in">
2337	<desc>Network Interface</desc>
2338	</param>
2339	<param name="server" type="IDHCPServer" dir="out">
2340	<desc>DHCP server settings</desc>
2341	</param>
2342	</method-->
2343
2344	<method name="createDHCPServer">
2345	<desc>
2346	Creates a DHCP server settings to be used for the given internal network name
2347	<result name="E_INVALIDARG">
2348	Host network interface @a name already exists.
2349	</result>
2350	</desc>
2351	<param name="name" type="wstring" dir="in">
2352	<desc>server name</desc>
2353	</param>
2354	<param name="server" type="IDHCPServer" dir="return">
2355	<desc>DHCP server settings</desc>
2356	</param>
2357	</method>
2358
2359	<method name="findDHCPServerByNetworkName">
2360	<desc>
2361	Searches a DHCP server settings to be used for the given internal network name
2362	<result name="E_INVALIDARG">
2363	Host network interface @a name already exists.
2364	</result>
2365
2366	</desc>
2367	<param name="name" type="wstring" dir="in">
2368	<desc>server name</desc>
2369	</param>
2370	<param name="server" type="IDHCPServer" dir="return">
2371	<desc>DHCP server settings</desc>
2372	</param>
2373	</method>
2374
2375	<!--method name="findDHCPServerForInterface">
2376	<desc>
2377	Searches a DHCP server settings to be used for the given interface
2378	<result name="E_INVALIDARG">
2379	Host network interface @a name already exists.
2380	</result>
2381	</desc>
2382	<param name="interface" type="IHostNetworkInterface" dir="in">
2383	<desc>Network Interface</desc>
2384	</param>
2385	<param name="server" type="IDHCPServer" dir="out">
2386	<desc>DHCP server settings</desc>
2387	</param>
2388	</method-->
2389
2390	<method name="removeDHCPServer">
2391	<desc>
2392	Removes the DHCP server settings
2393	<result name="E_INVALIDARG">
2394	Host network interface @a name already exists.
2395	</result>
2396	</desc>
2397	<param name="server" type="IDHCPServer" dir="in">
2398	<desc>DHCP server settings to be removed</desc>
2399	</param>
2400	</method>
2401
2402	<!-- bunch of metods to create NAT -->
2403	<method name="createNATNetwork">
2404	<!-- Here we create a record in NAT network array with name
2405	and gateway/network parameters this information should
2406	be enough for VBoxNet[Lwip]NAT and VBoxNetDHCP for
2407	servicing the guests.
2408	-->
2409	<param name="networkName" type="wstring" dir="in"/>
2410	<param name="network" type="INATNetwork" dir="return"/>
2411	</method>
2412
2413	<!--
2414	Returns the NATNetwork by name, e.g. for adding porforward rule or delition.
2415	-->
2416	<method name="findNATNetworkByName">
2417	<param name="networkName" type="wstring" dir="in"/>
2418	<param name="network" type="INATNetwork" dir="return"/>
2419	</method>
2420	<!--
2421	Deletes given NAT network.
2422	-->
2423	<method name="removeNATNetwork">
2424	<param name="network" type="INATNetwork" dir="in"/>
2425	</method>
2426
2427	<method name="checkFirmwarePresent">
2428	<desc>
2429	Check if this VirtualBox installation has a firmware
2430	of the given type available, either system-wide or per-user.
2431	Optionally, this may return a hint where this firmware can be
2432	downloaded from.
2433	</desc>
2434	<param name="firmwareType" type="FirmwareType" dir="in">
2435	<desc>
2436	Type of firmware to check.
2437	</desc>
2438	</param>
2439	<param name="version" type="wstring" dir="in">
2440	<desc>Expected version number, usually empty string (presently ignored).</desc>
2441	</param>
2442
2443	<param name="url" type="wstring" dir="out">
2444	<desc>
2445	Suggested URL to download this firmware from.
2446	</desc>
2447	</param>
2448
2449	<param name="file" type="wstring" dir="out">
2450	<desc>
2451	Filename of firmware, only valid if result == TRUE.
2452	</desc>
2453	</param>
2454
2455	<param name="result" type="boolean" dir="return">
2456	<desc>If firmware of this type and version is available.</desc>
2457	</param>
2458	</method>
2459
2460	</interface>
2461
2462	<!--
2463	// IVFSExplorer
2464	/////////////////////////////////////////////////////////////////////////
2465	-->
2466
2467	<enum
2468	name="VFSType"
2469	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2470	>
2471	<desc>
2472	Virtual file systems supported by VFSExplorer.
2473	</desc>
2474
2475	<const name="File" value="1" />
2476	<const name="Cloud" value="2" />
2477	<const name="S3" value="3" />
2478	<const name="WebDav" value="4" />
2479	</enum>
2480
2481	<enum
2482	name="VFSFileType"
2483	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2484	>
2485	<desc>
2486	File types known by VFSExplorer.
2487	</desc>
2488
2489	<const name="Unknown" value="1" />
2490	<const name="Fifo" value="2" />
2491	<const name="DevChar" value="3" />
2492	<const name="Directory" value="4" />
2493	<const name="DevBlock" value="5" />
2494	<const name="File" value="6" />
2495	<const name="SymLink" value="7" />
2496	<const name="Socket" value="8" />
2497	<const name="WhiteOut" value="9" />
2498	</enum>
2499
2500	<interface
2501	name="IVFSExplorer" extends="$unknown"
2502	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2503	wsmap="managed"
2504	>
2505	<desc>
2506	The VFSExplorer interface unifies access to different file system
2507	types. This includes local file systems as well remote file systems like
2508	S3. For a list of supported types see <link to="VFSType" />.
2509	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2510	</desc>
2511
2512	<attribute name="path" type="wstring" readonly="yes">
2513	<desc>Returns the current path in the virtual file system.</desc>
2514	</attribute>
2515
2516	<attribute name="type" type="VFSType" readonly="yes">
2517	<desc>Returns the file system type which is currently in use.</desc>
2518	</attribute>
2519
2520	<method name="update">
2521	<desc>Updates the internal list of files/directories from the
2522	current directory level. Use <link to="#entryList" /> to get the full list
2523	after a call to this method.</desc>
2524
2525	<param name="progress" type="IProgress" dir="return">
2526	<desc>Progress object to track the operation completion.</desc>
2527	</param>
2528	</method>
2529
2530	<method name="cd">
2531	<desc>Change the current directory level.</desc>
2532
2533	<param name="dir" type="wstring" dir="in">
2534	<desc>The name of the directory to go in.</desc>
2535	</param>
2536
2537	<param name="progress" type="IProgress" dir="return">
2538	<desc>Progress object to track the operation completion.</desc>
2539	</param>
2540	</method>
2541
2542	<method name="cdUp">
2543	<desc>Go one directory upwards from the current directory level.</desc>
2544
2545	<param name="progress" type="IProgress" dir="return">
2546	<desc>Progress object to track the operation completion.</desc>
2547	</param>
2548	</method>
2549
2550	<method name="entryList">
2551	<desc>Returns a list of files/directories after a call to <link
2552	to="#update" />. The user is responsible for keeping this internal
2553	list up do date.</desc>
2554
2555	<param name="names" type="wstring" safearray="yes" dir="out">
2556	<desc>The list of names for the entries.</desc>
2557	</param>
2558
2559	<param name="types" type="unsigned long" safearray="yes" dir="out">
2560	<desc>The list of types for the entries.</desc>
2561	</param>
2562
2563	<param name="sizes" type="unsigned long" safearray="yes" dir="out">
2564	<desc>The list of sizes (in bytes) for the entries.</desc>
2565	</param>
2566
2567	<param name="modes" type="unsigned long" safearray="yes" dir="out">
2568	<desc>The list of file modes (in octal form) for the entries.</desc>
2569	</param>
2570	</method>
2571
2572	<method name="exists">
2573	<desc>Checks if the given file list exists in the current directory
2574	level.</desc>
2575
2576	<param name="names" type="wstring" safearray="yes" dir="in">
2577	<desc>The names to check.</desc>
2578	</param>
2579
2580	<param name="exists" type="wstring" safearray="yes" dir="return">
2581	<desc>The names which exist.</desc>
2582	</param>
2583	</method>
2584
2585	<method name="remove">
2586	<desc>Deletes the given files in the current directory level.</desc>
2587
2588	<param name="names" type="wstring" safearray="yes" dir="in">
2589	<desc>The names to remove.</desc>
2590	</param>
2591
2592	<param name="progress" type="IProgress" dir="return">
2593	<desc>Progress object to track the operation completion.</desc>
2594	</param>
2595	</method>
2596
2597	</interface>
2598
2599	<enum
2600	name="ImportOptions" extends="$unknown"
2601	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2602	>
2603
2604	<desc>
2605	Import options, used with <link to="IAppliance::importMachines" />.
2606	</desc>
2607
2608	<const name="KeepAllMACs" value="1">
2609	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2610	</const>
2611	<const name="KeepNATMACs" value="2">
2612	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2613	</const>
2614
2615	</enum>
2616
2617
2618	<!--
2619	// IAppliance
2620	/////////////////////////////////////////////////////////////////////////
2621	-->
2622
2623	<interface
2624	name="IAppliance" extends="$unknown"
2625	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2626	wsmap="managed"
2627	>
2628	<desc>
2629	Represents a platform-independent appliance in OVF format. An instance of this is returned
2630	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2631	virtual machines within an appliance with VirtualBox.
2632
2633	The OVF standard suggests two different physical file formats:
2634
2635	<ol>
2636	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2637	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2638	this descriptor file references other files such as disk images, as OVF appliances typically
2639	do, those additional files must be in the same directory as the descriptor file.</li>
2640
2641	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2642	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2643	files and optionally other files.
2644
2645	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2646	be added with a later version.</li>
2647	</ol>
2648
2649	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2650	<link to="IMachine" /> involves the following sequence of API calls:
2651
2652	<ol>
2653	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2654	</li>
2655
2656	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2657	would like to import. So long as this file is syntactically valid, this will succeed
2658	and fill the appliance object with the parsed data from the OVF file.
2659	</li>
2660
2661	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2662	contents of the IAppliance attributes accordingly. These can be inspected by a
2663	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2664	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2665	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2666	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2667	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2668	The GUI can then give the user the option to confirm and/or change these suggestions.
2669	</li>
2670
2671	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2672	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2673	</li>
2674
2675	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2676	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2677	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2678	can be found in the <link to="#machines" /> array attribute.
2679	</li>
2680	</ol>
2681
2682	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2683
2684	<ol>
2685	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2686	an empty IAppliance object.
2687	</li>
2688
2689	<li>For each machine you would like to export, call <link to="IMachine::exportTo" />
2690	with the IAppliance object you just created. Each such call creates one instance of
2691	<link to="IVirtualSystemDescription" /> inside the appliance.
2692	</li>
2693
2694	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2695	virtual system (machine) to override the suggestions made by the <link to="IMachine::exportTo"/> routine.
2696	</li>
2697
2698	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2699	file written.</li>
2700	</ol>
2701
2702	</desc>
2703
2704	<attribute name="path" type="wstring" readonly="yes">
2705	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2706	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2707	<link to="#write" /> (for export).
2708	This attribute is empty until one of these methods has been called.
2709	</desc>
2710	</attribute>
2711
2712	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2713	<desc>
2714	Array of virtual disk definitions. One such description exists for each
2715	disk definition in the OVF; each string array item represents one such piece of
2716	disk information, with the information fields separated by tab (\\t) characters.
2717
2718	The caller should be prepared for additional fields being appended to
2719	this string in future versions of VirtualBox and therefore check for
2720	the number of tabs in the strings returned.
2721
2722	In the current version, the following eight fields are returned per string
2723	in the array:
2724
2725	<ol>
2726	<li>Disk ID (unique string identifier given to disk)</li>
2727
2728	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2729
2730	<li>Populated size (optional unsigned integer indicating the current size of the
2731	disk; can be approximate; -1 if unspecified)</li>
2732
2733	<li>Format (string identifying the disk format, typically
2734	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2735
2736	<li>Reference (where to find the disk image, typically a file name; if empty,
2737	then the disk should be created on import)</li>
2738
2739	<li>Image size (optional unsigned integer indicating the size of the image,
2740	which need not necessarily be the same as the values specified above, since
2741	the image may be compressed or sparse; -1 if not specified)</li>
2742
2743	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2744	presently unsupported and always -1)</li>
2745
2746	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2747	</ol>
2748	</desc>
2749	</attribute>
2750
2751	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2752	<desc> Array of virtual system descriptions. One such description is created
2753	for each virtual system (machine) found in the OVF.
2754	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::exportTo" />
2755	(for export) has been called.
2756	</desc>
2757	</attribute>
2758
2759	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2760	<desc>
2761	Contains the UUIDs of the machines created from the information in this appliances. This is only
2762	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2763	succeeded.
2764	</desc>
2765	</attribute>
2766
2767	<method name="read">
2768	<desc>
2769	Reads an OVF file into the appliance object.
2770
2771	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2772	mere fact that this method returns successfully does not mean that VirtualBox supports all
2773	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2774	</desc>
2775	<param name="file" type="wstring" dir="in">
2776	<desc>
2777	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2778	on whether the appliance is distributed as a set of files or as a single file, respectively).
2779	</desc>
2780	</param>
2781	<param name="progress" type="IProgress" dir="return">
2782	<desc>Progress object to track the operation completion.</desc>
2783	</param>
2784	</method>
2785
2786	<method name="interpret">
2787	<desc>
2788	Interprets the OVF data that was read when the appliance was constructed. After
2789	calling this method, one can inspect the
2790	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2791	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2792	the appliance.
2793
2794	Calling this method is the second step of importing an appliance into VirtualBox;
2795	see <link to="IAppliance" /> for an overview.
2796
2797	After calling this method, one should call <link to="#getWarnings" /> to find out
2798	if problems were encountered during the processing which might later lead to
2799	errors.
2800	</desc>
2801	</method>
2802
2803	<method name="importMachines">
2804	<desc>
2805	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2806	and other interfaces that match the information contained in the appliance as
2807	closely as possible, as represented by the import instructions in the
2808	<link to="#virtualSystemDescriptions" /> array.
2809
2810	Calling this method is the final step of importing an appliance into VirtualBox;
2811	see <link to="IAppliance" /> for an overview.
2812
2813	Since importing the appliance will most probably involve copying and converting
2814	disk images, which can take a long time, this method operates asynchronously and
2815	returns an IProgress object to allow the caller to monitor the progress.
2816
2817	After the import succeeded, the UUIDs of the IMachine instances created can be
2818	retrieved from the <link to="#machines" /> array attribute.
2819	</desc>
2820
2821	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2822	<desc>Options for the importing operation.</desc>
2823	</param>
2824
2825	<param name="progress" type="IProgress" dir="return">
2826	<desc>Progress object to track the operation completion.</desc>
2827	</param>
2828	</method>
2829
2830	<method name="createVFSExplorer">
2831	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2832
2833	<param name="URI" type="wstring" dir="in">
2834	<desc>The URI describing the file system to use.</desc>
2835	</param>
2836
2837	<param name="explorer" type="IVFSExplorer" dir="return">
2838	<desc></desc>
2839	</param>
2840	</method>
2841
2842	<method name="write">
2843	<desc>
2844	Writes the contents of the appliance exports into a new OVF file.
2845
2846	Calling this method is the final step of exporting an appliance from VirtualBox;
2847	see <link to="IAppliance" /> for an overview.
2848
2849	Since exporting the appliance will most probably involve copying and converting
2850	disk images, which can take a long time, this method operates asynchronously and
2851	returns an IProgress object to allow the caller to monitor the progress.
2852	</desc>
2853	<param name="format" type="wstring" dir="in">
2854	<desc>
2855	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2856	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2857	</desc>
2858	</param>
2859	<param name="manifest" type="boolean" dir="in">
2860	<desc>
2861	Indicate if the optional manifest file (.mf) should be written. The manifest file
2862	is used for integrity checks prior import.
2863	</desc>
2864	</param>
2865	<param name="path" type="wstring" dir="in">
2866	<desc>
2867	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2868	on whether the appliance is distributed as a set of files or as a single file, respectively).
2869	</desc>
2870	</param>
2871	<param name="progress" type="IProgress" dir="return">
2872	<desc>Progress object to track the operation completion.</desc>
2873	</param>
2874	</method>
2875
2876	<method name="getWarnings">
2877	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2878
2879	<param name="warnings" type="wstring" dir="return" safearray="yes">
2880	<desc></desc>
2881	</param>
2882	</method>
2883
2884	</interface>
2885
2886	<enum
2887	name="VirtualSystemDescriptionType"
2888	uuid="303c0900-a746-4612-8c67-79003e91f459"
2889	>
2890	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2891	a configuration value.</desc>
2892
2893	<const name="Ignore" value="1" />
2894	<const name="OS" value="2" />
2895	<const name="Name" value="3" />
2896	<const name="Product" value="4" />
2897	<const name="Vendor" value="5" />
2898	<const name="Version" value="6" />
2899	<const name="ProductUrl" value="7" />
2900	<const name="VendorUrl" value="8" />
2901	<const name="Description" value="9" />
2902	<const name="License" value="10" />
2903	<const name="Miscellaneous" value="11" />
2904	<const name="CPU" value="12" />
2905	<const name="Memory" value="13" />
2906	<const name="HardDiskControllerIDE" value="14" />
2907	<const name="HardDiskControllerSATA" value="15" />
2908	<const name="HardDiskControllerSCSI" value="16" />
2909	<const name="HardDiskControllerSAS" value="17" />
2910	<const name="HardDiskImage" value="18" />
2911	<const name="Floppy" value="19" />
2912	<const name="CDROM" value="20" />
2913	<const name="NetworkAdapter" value="21" />
2914	<const name="USBController" value="22" />
2915	<const name="SoundCard" value="23" />
2916	<const name="SettingsFile" value="24">
2917	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2918	</const>
2919	</enum>
2920
2921	<enum
2922	name="VirtualSystemDescriptionValueType"
2923	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2924	>
2925	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2926	type to fetch.</desc>
2927
2928	<const name="Reference" value="1" />
2929	<const name="Original" value="2" />
2930	<const name="Auto" value="3" />
2931	<const name="ExtraConfig" value="4" />
2932
2933	</enum>
2934
2935	<interface
2936	name="IVirtualSystemDescription" extends="$unknown"
2937	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2938	wsmap="managed"
2939	>
2940
2941	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2942	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2943	<link to="IAppliance::interpret" /> has been called, that array contains information
2944	about how the virtual systems described in the OVF should best be imported into
2945	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2946	import an OVF into VirtualBox.
2947	</desc>
2948
2949	<attribute name="count" type="unsigned long" readonly="yes">
2950	<desc>Return the number of virtual system description entries.</desc>
2951	</attribute>
2952
2953	<method name="getDescription">
2954	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2955	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2956
2957	The list below identifies the value sets that are possible depending on the
2958	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2959	the array item with the same index in @a OVFValues[] will contain the original value as contained
2960	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2961	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2962	the @a aExtraConfigValues[] array item may also be used.
2963
2964	<ul>
2965	<li>
2966	"OS": the guest operating system type. There must be exactly one such array item on import. The
2967	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2968	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2969	item in @a OVFValues[] will contain a numerical value that described the operating system in the OVF.
2970	</li>
2971	<li>
2972	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2973	if none is present on import, then an automatic name will be created from the operating system
2974	type. The corresponding item im @a OVFValues[] will contain the suggested virtual machine name
2975	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2976	<link to="IMachine" /> name that does not exist yet.
2977	</li>
2978	<li>
2979	"Description": an arbitrary description.
2980	</li>
2981	<li>
2982	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2983	code to display such a license for agreement; the Main API does not enforce any such policy.
2984	</li>
2985	<li>
2986	Miscellaneous: reserved for future use.
2987	</li>
2988	<li>
2989	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2990	</li>
2991	<li>
2992	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2993	is present on import, then VirtualBox will set a meaningful default based on the operating system
2994	type.
2995	</li>
2996	<li>
2997	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2998	An optional value in @a OVFValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2999	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
3000	writes into the OVF.
3001	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
3002	type can use to specify which hard disk controller a virtual disk should be connected to.
3003	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
3004	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
3005	its virtual machines supports four channels (primary master, primary slave, secondary master,
3006	secondary slave) and thus maps to two IDE controllers in the OVF sense.
3007	</li>
3008	<li>
3009	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3010	has no value in @a OVFValues[] or @a aVBoxValues[].
3011	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3012	</li>
3013	<li>
3014	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3015	The items in @a OVFValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
3016	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
3017	whereas VirtualBox considers it a class of storage controllers of its own; see
3018	<link to="StorageControllerType" />).
3019	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3020	</li>
3021	<li>
3022	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3023	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3024
3025	The array item in @a OVFValues[] will contain the file specification from the OVF file (without
3026	a path since the image file should be in the same location as the OVF file itself), whereas the
3027	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3028	hard disk image. This means that on import the image will be copied and converted from the
3029	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3030
3031	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
3032	format: "controller=<index>;channel=<c>"
3033	In this string, <index> must be an integer specifying the hard disk controller to connect
3034	the image to. That number must be the index of an array item with one of the hard disk controller
3035	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
3036	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3037	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
3038	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
3039	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
3040	</li>
3041	<li>
3042	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
3043	attachment information as with "HardDiskImage" items.
3044	</li>
3045	<li>
3046	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
3047	attachment information as with "HardDiskImage" items.
3048	</li>
3049	<li>
3050	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
3051	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
3052	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3053	</li>
3054	<li>
3055	"USBController": a USB controller. There can be at most one such item. If and only if such an
3056	item ispresent, USB support will be enabled for the new virtual machine.
3057	</li>
3058	<li>
3059	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3060	present, sound support will be enabled for the new virtual machine. Note that the virtual
3061	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3062	may be different from the virtual soundcard expected by the appliance.
3063	</li>
3064	</ul>
3065
3066	</desc>
3067
3068	<param name="types" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3069	<desc></desc>
3070	</param>
3071
3072	<param name="refs" type="wstring" dir="out" safearray="yes">
3073	<desc></desc>
3074	</param>
3075
3076	<param name="OVFValues" type="wstring" dir="out" safearray="yes">
3077	<desc></desc>
3078	</param>
3079
3080	<param name="VBoxValues" type="wstring" dir="out" safearray="yes">
3081	<desc></desc>
3082	</param>
3083
3084	<param name="extraConfigValues" type="wstring" dir="out" safearray="yes">
3085	<desc></desc>
3086	</param>
3087
3088	</method>
3089
3090	<method name="getDescriptionByType">
3091	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3092	should be returned.</desc>
3093
3094	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3095	<desc></desc>
3096	</param>
3097
3098	<param name="types" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3099	<desc></desc>
3100	</param>
3101
3102	<param name="refs" type="wstring" dir="out" safearray="yes">
3103	<desc></desc>
3104	</param>
3105
3106	<param name="OVFValues" type="wstring" dir="out" safearray="yes">
3107	<desc></desc>
3108	</param>
3109
3110	<param name="VBoxValues" type="wstring" dir="out" safearray="yes">
3111	<desc></desc>
3112	</param>
3113
3114	<param name="extraConfigValues" type="wstring" dir="out" safearray="yes">
3115	<desc></desc>
3116	</param>
3117
3118	</method>
3119
3120	<method name="getValuesByType">
3121	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3122	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3123	values.</desc>
3124
3125	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3126	<desc></desc>
3127	</param>
3128
3129	<param name="which" type="VirtualSystemDescriptionValueType" dir="in">
3130	<desc></desc>
3131	</param>
3132
3133	<param name="values" type="wstring" dir="return" safearray="yes">
3134	<desc></desc>
3135	</param>
3136
3137	</method>
3138
3139	<method name="setFinalValues">
3140	<desc>
3141	This method allows the appliance's user to change the configuration for the virtual
3142	system descriptions. For each array item returned from <link to="#getDescription" />,
3143	you must pass in one boolean value and one configuration value.
3144
3145	Each item in the boolean array determines whether the particular configuration item
3146	should be enabled.
3147	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3148	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3149	and SoundCard.
3150
3151	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3152	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
3153	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
3154	for valid configuration values for the individual array item types. If the
3155	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3156	</desc>
3157
3158	<param name="enabled" type="boolean" dir="in" safearray="yes">
3159	<desc></desc>
3160	</param>
3161
3162	<param name="VBoxValues" type="wstring" dir="in" safearray="yes">
3163	<desc></desc>
3164	</param>
3165
3166	<param name="extraConfigValues" type="wstring" dir="in" safearray="yes">
3167	<desc></desc>
3168	</param>
3169	</method>
3170
3171	<method name="addDescription">
3172	<desc>
3173	This method adds an additional description entry to the stack of already
3174	available descriptions for this virtual system. This is handy for writing
3175	values which aren't directly supported by VirtualBox. One example would
3176	be the License type of <link to="VirtualSystemDescriptionType" />.
3177	</desc>
3178
3179	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3180	<desc></desc>
3181	</param>
3182
3183	<param name="VBoxValue" type="wstring" dir="in">
3184	<desc></desc>
3185	</param>
3186
3187	<param name="extraConfigValue" type="wstring" dir="in">
3188	<desc></desc>
3189	</param>
3190	</method>
3191	</interface>
3192
3193
3194	<!--
3195	// IMachine
3196	/////////////////////////////////////////////////////////////////////////
3197	-->
3198
3199	<interface
3200	name="IInternalMachineControl" extends="$unknown"
3201	uuid="dca36a92-703c-4649-98a4-f40c1ef0c336"
3202	internal="yes"
3203	wsmap="suppress"
3204	>
3205	<method name="setRemoveSavedStateFile">
3206	<desc>
3207	Updates the flag whether the saved state file is removed on a
3208	machine state change from Saved to PoweredOff.
3209	</desc>
3210	<param name="remove" type="boolean" dir="in"/>
3211	</method>
3212
3213	<method name="updateState">
3214	<desc>
3215	Updates the VM state.
3216	<note>
3217	This operation will also update the settings file with the correct
3218	information about the saved state file and delete this file from disk
3219	when appropriate.
3220	</note>
3221	</desc>
3222	<param name="state" type="MachineState" dir="in"/>
3223	</method>
3224
3225	<method name="getIPCId">
3226	<param name="id" type="wstring" dir="return"/>
3227	</method>
3228
3229	<method name="beginPowerUp">
3230	<desc>
3231	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3232	gives it the progress object that should be part of any pending
3233	<link to="IMachine::launchVMProcess"/> operations. The progress
3234	object may be called back to reflect an early cancelation, so some care
3235	have to be taken with respect to any cancelation callbacks. The console
3236	object will call <link to="IInternalMachineControl::endPowerUp"/>
3237	to signal the completion of the progress object.
3238	</desc>
3239	<param name="progress" type="IProgress" dir="in" />
3240	</method>
3241
3242	<method name="endPowerUp">
3243	<desc>
3244	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3245	This method may query status information from the progress object it
3246	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3247	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3248	call in order to complete that progress object.
3249	</desc>
3250	<param name="result" type="long" dir="in"/>
3251	</method>
3252
3253	<method name="beginPoweringDown">
3254	<desc>
3255	Called by the VM process to inform the server it wants to
3256	stop the VM execution and power down.
3257	</desc>
3258	<param name="progress" type="IProgress" dir="out">
3259	<desc>
3260	Progress object created by VBoxSVC to wait until
3261	the VM is powered down.
3262	</desc>
3263	</param>
3264	</method>
3265
3266	<method name="endPoweringDown">
3267	<desc>
3268	Called by the VM process to inform the server that powering
3269	down previously requested by #beginPoweringDown is either
3270	successfully finished or there was a failure.
3271
3272	<result name="VBOX_E_FILE_ERROR">
3273	Settings file not accessible.
3274	</result>
3275	<result name="VBOX_E_XML_ERROR">
3276	Could not parse the settings file.
3277	</result>
3278
3279	</desc>
3280
3281	<param name="result" type="long" dir="in">
3282	<desc>@c S_OK to indicate success.
3283	</desc>
3284	</param>
3285	<param name="errMsg" type="wstring" dir="in">
3286	<desc>@c human readable error message in case of failure.
3287	</desc>
3288	</param>
3289	</method>
3290
3291	<method name="runUSBDeviceFilters">
3292	<desc>
3293	Asks the server to run USB devices filters of the associated
3294	machine against the given USB device and tell if there is
3295	a match.
3296	<note>
3297	Intended to be used only for remote USB devices. Local
3298	ones don't require to call this method (this is done
3299	implicitly by the Host and USBProxyService).
3300	</note>
3301	</desc>
3302	<param name="device" type="IUSBDevice" dir="in"/>
3303	<param name="matched" type="boolean" dir="out"/>
3304	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3305	</method>
3306
3307	<method name="captureUSBDevice">
3308	<desc>
3309	Requests a capture of the given host USB device.
3310	When the request is completed, the VM process will
3311	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3312	notification.
3313	</desc>
3314	<param name="id" type="uuid" mod="string" dir="in"/>
3315	</method>
3316
3317	<method name="detachUSBDevice">
3318	<desc>
3319	Notification that a VM is going to detach (@a done = @c false) or has
3320	already detached (@a done = @c true) the given USB device.
3321	When the @a done = @c true request is completed, the VM process will
3322	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3323	notification.
3324	<note>
3325	In the @a done = @c true case, the server must run its own filters
3326	and filters of all VMs but this one on the detached device
3327	as if it were just attached to the host computer.
3328	</note>
3329	</desc>
3330	<param name="id" type="uuid" mod="string" dir="in"/>
3331	<param name="done" type="boolean" dir="in"/>
3332	</method>
3333
3334	<method name="autoCaptureUSBDevices">
3335	<desc>
3336	Requests a capture all matching USB devices attached to the host.
3337	When the request is completed, the VM process will
3338	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3339	notification per every captured device.
3340	</desc>
3341	</method>
3342
3343	<method name="detachAllUSBDevices">
3344	<desc>
3345	Notification that a VM that is being powered down. The done
3346	parameter indicates whether which stage of the power down
3347	we're at. When @a done = @c false the VM is announcing its
3348	intentions, while when @a done = @c true the VM is reporting
3349	what it has done.
3350	<note>
3351	In the @a done = @c true case, the server must run its own filters
3352	and filters of all VMs but this one on all detach devices as
3353	if they were just attached to the host computer.
3354	</note>
3355	</desc>
3356	<param name="done" type="boolean" dir="in"/>
3357	</method>
3358
3359	<method name="onSessionEnd">
3360	<desc>
3361	Triggered by the given session object when the session is about
3362	to close normally.
3363	</desc>
3364	<param name="session" type="ISession" dir="in">
3365	<desc>Session that is being closed</desc>
3366	</param>
3367	<param name="progress" type="IProgress" dir="return">
3368	<desc>
3369	Used to wait until the corresponding machine is actually
3370	dissociated from the given session on the server.
3371	Returned only when this session is a direct one.
3372	</desc>
3373	</param>
3374	</method>
3375
3376	<method name="beginSavingState">
3377	<desc>
3378	Called by the VM process to inform the server it wants to
3379	save the current state and stop the VM execution.
3380	</desc>
3381	<param name="progress" type="IProgress" dir="out">
3382	<desc>
3383	Progress object created by VBoxSVC to wait until
3384	the state is saved.
3385	</desc>
3386	</param>
3387	<param name="stateFilePath" type="wstring" dir="out">
3388	<desc>
3389	File path the VM process must save the execution state to.
3390	</desc>
3391	</param>
3392	</method>
3393
3394	<method name="endSavingState">
3395	<desc>
3396	Called by the VM process to inform the server that saving
3397	the state previously requested by #beginSavingState is either
3398	successfully finished or there was a failure.
3399
3400	<result name="VBOX_E_FILE_ERROR">
3401	Settings file not accessible.
3402	</result>
3403	<result name="VBOX_E_XML_ERROR">
3404	Could not parse the settings file.
3405	</result>
3406
3407	</desc>
3408
3409	<param name="result" type="long" dir="in">
3410	<desc>@c S_OK to indicate success.
3411	</desc>
3412	</param>
3413	<param name="errMsg" type="wstring" dir="in">
3414	<desc>@c human readable error message in case of failure.
3415	</desc>
3416	</param>
3417	</method>
3418
3419	<method name="adoptSavedState">
3420	<desc>
3421	Gets called by <link to="IConsole::adoptSavedState"/>.
3422	<result name="VBOX_E_FILE_ERROR">
3423	Invalid saved state file path.
3424	</result>
3425	</desc>
3426	<param name="savedStateFile" type="wstring" dir="in">
3427	<desc>Path to the saved state file to adopt.</desc>
3428	</param>
3429	</method>
3430
3431	<method name="beginTakingSnapshot">
3432	<desc>
3433	Called from the VM process to request from the server to perform the
3434	server-side actions of creating a snapshot (creating differencing images
3435	and the snapshot object).
3436
3437	<result name="VBOX_E_FILE_ERROR">
3438	Settings file not accessible.
3439	</result>
3440	<result name="VBOX_E_XML_ERROR">
3441	Could not parse the settings file.
3442	</result>
3443	</desc>
3444	<param name="initiator" type="IConsole" dir="in">
3445	<desc>The console object that initiated this call.</desc>
3446	</param>
3447	<param name="name" type="wstring" dir="in">
3448	<desc>Snapshot name.</desc>
3449	</param>
3450	<param name="description" type="wstring" dir="in">
3451	<desc>Snapshot description.</desc>
3452	</param>
3453	<param name="consoleProgress" type="IProgress" dir="in">
3454	<desc>
3455	Progress object created by the VM process tracking the
3456	snapshot's progress. This has the following sub-operations:
3457	<ul>
3458	<li>setting up (weight 1);</li>
3459	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3460	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3461	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3462	<li>finishing up (weight 1)</li>
3463	</ul>
3464	</desc>
3465	</param>
3466	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3467	<desc>
3468	Whether this is an online snapshot (i.e. the machine is running).
3469	</desc>
3470	</param>
3471	<param name="stateFilePath" type="wstring" dir="out">
3472	<desc>
3473	File path the VM process must save the execution state to.
3474	</desc>
3475	</param>
3476	</method>
3477
3478	<method name="endTakingSnapshot">
3479	<desc>
3480	Called by the VM process to inform the server that the snapshot
3481	previously requested by #beginTakingSnapshot is either
3482	successfully taken or there was a failure.
3483	</desc>
3484
3485	<param name="success" type="boolean" dir="in">
3486	<desc>@c true to indicate success and @c false otherwise</desc>
3487	</param>
3488	</method>
3489
3490	<method name="deleteSnapshot">
3491	<desc>
3492	Gets called by <link to="IConsole::deleteSnapshot"/>,
3493	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3494	<link to="IConsole::deleteSnapshotRange"/>.
3495	<result name="VBOX_E_INVALID_OBJECT_STATE">
3496	Snapshot has more than one child snapshot. Only possible if the
3497	delete operation does not delete all children or the range does
3498	not meet the linearity condition.
3499	</result>
3500	</desc>
3501	<param name="initiator" type="IConsole" dir="in">
3502	<desc>The console object that initiated this call.</desc>
3503	</param>
3504	<param name="startId" type="uuid" mod="string" dir="in">
3505	<desc>UUID of the first snapshot to delete.</desc>
3506	</param>
3507	<param name="endId" type="uuid" mod="string" dir="in">
3508	<desc>UUID of the last snapshot to delete.</desc>
3509	</param>
3510	<param name="deleteAllChildren" type="boolean" dir="in">
3511	<desc>Whether all children should be deleted.</desc>
3512	</param>
3513	<param name="machineState" type="MachineState" dir="out">
3514	<desc>New machine state after this operation is started.</desc>
3515	</param>
3516	<param name="progress" type="IProgress" dir="return">
3517	<desc>Progress object to track the operation completion.</desc>
3518	</param>
3519	</method>
3520
3521	<method name="finishOnlineMergeMedium">
3522	<desc>
3523	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3524	</desc>
3525	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3526	<desc>The medium attachment which needs to be cleaned up.</desc>
3527	</param>
3528	<param name="source" type="IMedium" dir="in">
3529	<desc>Merge source medium.</desc>
3530	</param>
3531	<param name="target" type="IMedium" dir="in">
3532	<desc>Merge target medium.</desc>
3533	</param>
3534	<param name="mergeForward" type="boolean" dir="in">
3535	<desc>Merge direction.</desc>
3536	</param>
3537	<param name="parentForTarget" type="IMedium" dir="in">
3538	<desc>For forward merges: new parent for target medium.</desc>
3539	</param>
3540	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3541	<desc>For backward merges: list of media which need their parent UUID
3542	updated.</desc>
3543	</param>
3544	</method>
3545
3546	<method name="restoreSnapshot">
3547	<desc>
3548	Gets called by <link to="IConsole::restoreSnapshot"/>.
3549	</desc>
3550	<param name="initiator" type="IConsole" dir="in">
3551	<desc>The console object that initiated this call.</desc>
3552	</param>
3553	<param name="snapshot" type="ISnapshot" dir="in">
3554	<desc>The snapshot to restore the VM state from.</desc>
3555	</param>
3556	<param name="machineState" type="MachineState" dir="out">
3557	<desc>New machine state after this operation is started.</desc>
3558	</param>
3559	<param name="progress" type="IProgress" dir="return">
3560	<desc>Progress object to track the operation completion.</desc>
3561	</param>
3562	</method>
3563
3564	<method name="pullGuestProperties">
3565	<desc>
3566	Get the list of the guest properties matching a set of patterns along
3567	with their values, time stamps and flags and give responsibility for
3568	managing properties to the console.
3569	</desc>
3570	<param name="names" type="wstring" dir="out" safearray="yes">
3571	<desc>
3572	The names of the properties returned.
3573	</desc>
3574	</param>
3575	<param name="values" type="wstring" dir="out" safearray="yes">
3576	<desc>
3577	The values of the properties returned. The array entries match the
3578	corresponding entries in the @a name array.
3579	</desc>
3580	</param>
3581	<param name="timestamps" type="long long" dir="out" safearray="yes">
3582	<desc>
3583	The time stamps of the properties returned. The array entries match
3584	the corresponding entries in the @a name array.
3585	</desc>
3586	</param>
3587	<param name="flags" type="wstring" dir="out" safearray="yes">
3588	<desc>
3589	The flags of the properties returned. The array entries match the
3590	corresponding entries in the @a name array.
3591	</desc>
3592	</param>
3593	</method>
3594
3595	<method name="pushGuestProperty">
3596	<desc>
3597	Update a single guest property in IMachine.
3598	</desc>
3599	<param name="name" type="wstring" dir="in">
3600	<desc>
3601	The name of the property to be updated.
3602	</desc>
3603	</param>
3604	<param name="value" type="wstring" dir="in">
3605	<desc>
3606	The value of the property.
3607	</desc>
3608	</param>
3609	<param name="timestamp" type="long long" dir="in">
3610	<desc>
3611	The timestamp of the property.
3612	</desc>
3613	</param>
3614	<param name="flags" type="wstring" dir="in">
3615	<desc>
3616	The flags of the property.
3617	</desc>
3618	</param>
3619	</method>
3620
3621	<method name="lockMedia">
3622	<desc>
3623	Locks all media attached to the machine for writing and parents of
3624	attached differencing media (if any) for reading. This operation is
3625	atomic so that if it fails no media is actually locked.
3626
3627	This method is intended to be called when the machine is in Starting or
3628	Restoring state. The locked media will be automatically unlocked when
3629	the machine is powered off or crashed.
3630	</desc>
3631	</method>
3632	<method name="unlockMedia">
3633	<desc>
3634	Unlocks all media previously locked using
3635	<link to="IInternalMachineControl::lockMedia"/>.
3636
3637	This method is intended to be used with teleportation so that it is
3638	possible to teleport between processes on the same machine.
3639	</desc>
3640	</method>
3641
3642	<method name="ejectMedium">
3643	<desc>
3644	Tells VBoxSVC that the guest has ejected the medium associated with
3645	the medium attachment.
3646	</desc>
3647	<param name="attachment" type="IMediumAttachment" dir="in">
3648	<desc>
3649	The medium attachment where the eject happened.
3650	</desc>
3651	</param>
3652	<param name="newAttachment" type="IMediumAttachment" dir="return">
3653	<desc>
3654	A new reference to the medium attachment, as the config change can
3655	result in the creation of a new instance.
3656	</desc>
3657	</param>
3658	</method>
3659
3660	<method name="reportVmStatistics">
3661	<desc>
3662	Passes statistics collected by VM (including guest statistics) to VBoxSVC.
3663	</desc>
3664	<param name="validStats" type="unsigned long" dir="in">
3665	<desc>
3666	Mask defining which parameters are valid. For example: 0x11 means
3667	that cpuIdle and XXX are valid. Other parameters should be ignored.
3668	</desc>
3669	</param>
3670	<param name="cpuUser" type="unsigned long" dir="in">
3671	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3672	</param>
3673	<param name="cpuKernel" type="unsigned long" dir="in">
3674	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3675	</param>
3676	<param name="cpuIdle" type="unsigned long" dir="in">
3677	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3678	</param>
3679	<param name="memTotal" type="unsigned long" dir="in">
3680	<desc>Total amount of physical guest RAM.</desc>
3681	</param>
3682	<param name="memFree" type="unsigned long" dir="in">
3683	<desc>Free amount of physical guest RAM.</desc>
3684	</param>
3685	<param name="memBalloon" type="unsigned long" dir="in">
3686	<desc>Amount of ballooned physical guest RAM.</desc>
3687	</param>
3688	<param name="memShared" type="unsigned long" dir="in">
3689	<desc>Amount of shared physical guest RAM.</desc>
3690	</param>
3691	<param name="memCache" type="unsigned long" dir="in">
3692	<desc>Total amount of guest (disk) cache memory.</desc>
3693	</param>
3694	<param name="pagedTotal" type="unsigned long" dir="in">
3695	<desc>Total amount of space in the page file.</desc>
3696	</param>
3697	<param name="memAllocTotal" type="unsigned long" dir="in">
3698	<desc>Total amount of memory allocated by the hypervisor.</desc>
3699	</param>
3700	<param name="memFreeTotal" type="unsigned long" dir="in">
3701	<desc>Total amount of free memory available in the hypervisor.</desc>
3702	</param>
3703	<param name="memBalloonTotal" type="unsigned long" dir="in">
3704	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3705	</param>
3706	<param name="memSharedTotal" type="unsigned long" dir="in">
3707	<desc>Total amount of shared memory in the hypervisor.</desc>
3708	</param>
3709	<param name="vmNetRx" type="unsigned long" dir="in">
3710	<desc>Network receive rate for VM.</desc>
3711	</param>
3712	<param name="vmNetTx" type="unsigned long" dir="in">
3713	<desc>Network transmit rate for VM.</desc>
3714	</param>
3715	</method>
3716	</interface>
3717
3718	<interface
3719	name="IBIOSSettings" extends="$unknown"
3720	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3721	wsmap="managed"
3722	>
3723	<desc>
3724	The IBIOSSettings interface represents BIOS settings of the virtual
3725	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3726	</desc>
3727	<attribute name="logoFadeIn" type="boolean">
3728	<desc>Fade in flag for BIOS logo animation.</desc>
3729	</attribute>
3730
3731	<attribute name="logoFadeOut" type="boolean">
3732	<desc>Fade out flag for BIOS logo animation.</desc>
3733	</attribute>
3734
3735	<attribute name="logoDisplayTime" type="unsigned long">
3736	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3737	</attribute>
3738
3739	<attribute name="logoImagePath" type="wstring">
3740	<desc>
3741	Local file system path for external BIOS splash image. Empty string
3742	means the default image is shown on boot.
3743	</desc>
3744	</attribute>
3745
3746	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3747	<desc>Mode of the BIOS boot device menu.</desc>
3748	</attribute>
3749
3750	<attribute name="ACPIEnabled" type="boolean">
3751	<desc>ACPI support flag.</desc>
3752	</attribute>
3753
3754	<attribute name="IOAPICEnabled" type="boolean">
3755	<desc>
3756	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3757	and support IRQs above 15.
3758	</desc>
3759	</attribute>
3760
3761	<attribute name="timeOffset" type="long long">
3762	<desc>
3763	Offset in milliseconds from the host system time. This allows for
3764	guests running with a different system date/time than the host.
3765	It is equivalent to setting the system date/time in the BIOS except
3766	it is not an absolute value but a relative one. Guest Additions
3767	time synchronization honors this offset.
3768	</desc>
3769	</attribute>
3770
3771	<attribute name="PXEDebugEnabled" type="boolean">
3772	<desc>
3773	PXE debug logging flag. If set, VirtualBox will write extensive
3774	PXE trace information to the release log.
3775	</desc>
3776	</attribute>
3777	</interface>
3778
3779	<enum
3780	name="CleanupMode"
3781	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3782	>
3783	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3784	</desc>
3785	<const name="UnregisterOnly" value="1">
3786	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3787	</const>
3788	<const name="DetachAllReturnNone" value="2">
3789	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3790	</const>
3791	<const name="DetachAllReturnHardDisksOnly" value="3">
3792	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3793	</const>
3794	<const name="Full" value="4">
3795	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3796	</const>
3797	</enum>
3798
3799	<interface
3800	name="IPCIAddress" extends="$unknown"
3801	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3802	wsmap="struct"
3803	>
3804
3805	<desc>
3806	Address on the PCI bus.
3807	</desc>
3808
3809	<attribute name="bus" type="short">
3810	<desc>
3811	Bus number.
3812	</desc>
3813	</attribute>
3814
3815	<attribute name="device" type="short">
3816	<desc>
3817	Device number.
3818	</desc>
3819	</attribute>
3820
3821	<attribute name="devFunction" type="short">
3822	<desc>
3823	Device function number.
3824	</desc>
3825	</attribute>
3826
3827	<method name="asLong">
3828	<desc>
3829	Convert PCI address into long.
3830	</desc>
3831	<param name="result" type="long" dir="return" />
3832	</method>
3833
3834	<method name="fromLong">
3835	<desc>
3836	Make PCI address from long.
3837	</desc>
3838	<param name="number" type="long" dir="in" />
3839	</method>
3840	</interface>
3841
3842	<interface
3843	name="IPCIDeviceAttachment" extends="$unknown"
3844	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3845	wsmap="struct"
3846	>
3847
3848	<desc>
3849	Information about PCI attachments.
3850	</desc>
3851
3852	<attribute name="name" type="wstring" readonly="yes">
3853	<desc>
3854	Device name.
3855	</desc>
3856	</attribute>
3857
3858	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3859	<desc>
3860	If this is physical or virtual device.
3861	</desc>
3862	</attribute>
3863
3864	<attribute name="hostAddress" type="long" readonly="yes">
3865	<desc>
3866	Address of device on the host, applicable only to host devices.
3867	</desc>
3868	</attribute>
3869
3870	<attribute name="guestAddress" type="long" readonly="yes">
3871	<desc>
3872	Address of device on the guest.
3873	</desc>
3874	</attribute>
3875
3876	</interface>
3877
3878	<enum
3879	name="CloneMode" extends="$unknown"
3880	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3881	>
3882
3883	<desc>
3884	Clone mode, used with <link to="IMachine::cloneTo" />.
3885	</desc>
3886
3887	<const name="MachineState" value="1">
3888	<desc>Clone the state of the selected machine.</desc>
3889	</const>
3890	<const name="MachineAndChildStates" value="2">
3891	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3892	</const>
3893	<const name="AllStates" value="3">
3894	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3895	</const>
3896
3897	</enum>
3898
3899	<enum
3900	name="CloneOptions" extends="$unknown"
3901	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3902	>
3903
3904	<desc>
3905	Clone options, used with <link to="IMachine::cloneTo" />.
3906	</desc>
3907
3908	<const name="Link" value="1">
3909	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3910	</const>
3911	<const name="KeepAllMACs" value="2">
3912	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3913	</const>
3914	<const name="KeepNATMACs" value="3">
3915	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3916	</const>
3917	<const name="KeepDiskNames" value="4">
3918	<desc>Don't change the disk names.</desc>
3919	</const>
3920
3921	</enum>
3922
3923	<enum
3924	name="AutostopType" extends="$unknown"
3925	uuid="6bb96740-cf34-470d-aab2-2cd48ea2e10e"
3926	>
3927
3928	<desc>
3929	Autostop types, used with <link to="IMachine::autostopType" />.
3930	</desc>
3931
3932	<const name="Disabled" value="1">
3933	<desc>Stopping the VM during system shutdown is disabled.</desc>
3934	</const>
3935	<const name="SaveState" value="2">
3936	<desc>The state of the VM will be saved when the system shuts down.</desc>
3937	</const>
3938	<const name="PowerOff" value="3">
3939	<desc>The VM is powered off when the system shuts down.</desc>
3940	</const>
3941	<const name="AcpiShutdown" value="4">
3942	<desc>An ACPI shutdown event is generated.</desc>
3943	</const>
3944
3945	</enum>
3946
3947
3948	<interface
3949	name="IMachine" extends="$unknown"
3950	uuid="381e3f31-2b27-45b7-818a-30609ade86b3"
3951	wsmap="managed"
3952	>
3953	<desc>
3954	The IMachine interface represents a virtual machine, or guest, created
3955	in VirtualBox.
3956
3957	This interface is used in two contexts. First of all, a collection of
3958	objects implementing this interface is stored in the
3959	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3960	machines that are currently registered with this VirtualBox
3961	installation. Also, once a session has been opened for the given virtual
3962	machine (e.g. the virtual machine is running), the machine object
3963	associated with the open session can be queried from the session object;
3964	see <link to="ISession"/> for details.
3965
3966	The main role of this interface is to expose the settings of the virtual
3967	machine and provide methods to change various aspects of the virtual
3968	machine's configuration. For machine objects stored in the
3969	<link to="IVirtualBox::machines"/> collection, all attributes are
3970	read-only unless explicitly stated otherwise in individual attribute
3971	and method descriptions.
3972
3973	In order to change a machine setting, a session for this machine must be
3974	opened using one of the <link to="IMachine::lockMachine" /> or
3975	<link to="IMachine::launchVMProcess"/> methods. After the
3976	machine has been successfully locked for a session, a mutable machine object
3977	needs to be queried from the session object and then the desired settings
3978	changes can be applied to the returned object using IMachine attributes and
3979	methods. See the <link to="ISession"/> interface description for more
3980	information about sessions.
3981
3982	Note that IMachine does not provide methods to control virtual machine
3983	execution (such as start the machine, or power it down) -- these methods
3984	are grouped in a separate interface called <link to="IConsole" />.
3985
3986	<see><link to="ISession"/>, <link to="IConsole"/></see>
3987	</desc>
3988
3989	<attribute name="parent" type="IVirtualBox" readonly="yes">
3990	<desc>Associated parent object.</desc>
3991	</attribute>
3992
3993	<attribute name="accessible" type="boolean" readonly="yes">
3994	<desc>
3995	Whether this virtual machine is currently accessible or not.
3996
3997	A machine is always deemed accessible unless it is registered <i>and</i>
3998	its settings file cannot be read or parsed (either because the file itself
3999	is unavailable or has invalid XML contents).
4000
4001	Every time this property is read, the accessibility state of
4002	this machine is re-evaluated. If the returned value is @c false,
4003	the <link to="#accessError"/> property may be used to get the
4004	detailed error information describing the reason of
4005	inaccessibility, including XML error messages.
4006
4007	When the machine is inaccessible, only the following properties
4008	can be used on it:
4009	<ul>
4010	<li><link to="#parent"/></li>
4011	<li><link to="#id"/></li>
4012	<li><link to="#settingsFilePath"/></li>
4013	<li><link to="#accessible"/></li>
4014	<li><link to="#accessError"/></li>
4015	</ul>
4016
4017	An attempt to access any other property or method will return
4018	an error.
4019
4020	The only possible action you can perform on an inaccessible
4021	machine is to unregister it using the
4022	<link to="IMachine::unregister"/> call (or, to check
4023	for the accessibility state once more by querying this
4024	property).
4025
4026	<note>
4027	In the current implementation, once this property returns
4028	@c true, the machine will never become inaccessible
4029	later, even if its settings file cannot be successfully
4030	read/written any more (at least, until the VirtualBox
4031	server is restarted). This limitation may be removed in
4032	future releases.
4033	</note>
4034	</desc>
4035	</attribute>
4036
4037	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4038	<desc>
4039	Error information describing the reason of machine
4040	inaccessibility.
4041
4042	Reading this property is only valid after the last call to
4043	<link to="#accessible"/> returned @c false (i.e. the
4044	machine is currently inaccessible). Otherwise, a @c null
4045	IVirtualBoxErrorInfo object will be returned.
4046	</desc>
4047	</attribute>
4048
4049	<attribute name="name" type="wstring">
4050	<desc>
4051	Name of the virtual machine.
4052
4053	Besides being used for human-readable identification purposes
4054	everywhere in VirtualBox, the virtual machine name is also used
4055	as a name of the machine's settings file and as a name of the
4056	subdirectory this settings file resides in. Thus, every time you
4057	change the value of this property, the settings file will be
4058	renamed once you call <link to="#saveSettings"/> to confirm the
4059	change. The containing subdirectory will be also renamed, but
4060	only if it has exactly the same name as the settings file
4061	itself prior to changing this property (for backward compatibility
4062	with previous API releases). The above implies the following
4063	limitations:
4064	<ul>
4065	<li>The machine name cannot be empty.</li>
4066	<li>The machine name can contain only characters that are valid
4067	file name characters according to the rules of the file
4068	system used to store VirtualBox configuration.</li>
4069	<li>You cannot have two or more machines with the same name
4070	if they use the same subdirectory for storing the machine
4071	settings files.</li>
4072	<li>You cannot change the name of the machine if it is running,
4073	or if any file in the directory containing the settings file
4074	is being used by another running machine or by any other
4075	process in the host operating system at a time when
4076	<link to="#saveSettings"/> is called.
4077	</li>
4078	</ul>
4079	If any of the above limitations are hit, <link to="#saveSettings"/>
4080	will return an appropriate error message explaining the exact
4081	reason and the changes you made to this machine will not be saved.
4082
4083	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
4084	file is recommended, but not enforced. (Previous versions always
4085	used a generic ".xml" extension.)
4086	</desc>
4087	</attribute>
4088
4089	<attribute name="description" type="wstring">
4090	<desc>
4091	Description of the virtual machine.
4092
4093	The description attribute can contain any text and is
4094	typically used to describe the hardware and software
4095	configuration of the virtual machine in detail (i.e. network
4096	settings, versions of the installed software and so on).
4097	</desc>
4098	</attribute>
4099
4100	<attribute name="id" type="uuid" mod="string" readonly="yes">
4101	<desc>UUID of the virtual machine.</desc>
4102	</attribute>
4103
4104	<attribute name="groups" type="wstring" safearray="yes">
4105	<desc>
4106	Array of machine group names of which this machine is a member.
4107	<tt>""</tt> and <tt>"/"</tt> are synonyms for the toplevel group. Each
4108	group is only listed once, however they are listed in no particular
4109	order and there is no guarantee that there are no gaps in the group
4110	hierarchy (i.e. <tt>"/group"</tt>,
4111	<tt>"/group/subgroup/subsubgroup"</tt> is a valid result).
4112	</desc>
4113	</attribute>
4114
4115	<attribute name="OSTypeId" type="wstring">
4116	<desc>
4117	User-defined identifier of the Guest OS type.
4118	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4119	an IGuestOSType object representing details about the given
4120	Guest OS type.
4121	<note>
4122	This value may differ from the value returned by
4123	<link to="IGuest::OSTypeId"/> if Guest Additions are
4124	installed to the guest OS.
4125	</note>
4126	</desc>
4127	</attribute>
4128
4129	<attribute name="hardwareVersion" type="wstring">
4130	<desc>Hardware version identifier. Internal use only for now.</desc>
4131	</attribute>
4132
4133	<attribute name="hardwareUUID" type="uuid" mod="string">
4134	<desc>
4135	The UUID presented to the guest via memory tables, hardware and guest
4136	properties. For most VMs this is the same as the @a id, but for VMs
4137	which have been cloned or teleported it may be the same as the source
4138	VM. The latter is because the guest shouldn't notice that it was
4139	cloned or teleported.
4140	</desc>
4141	</attribute>
4142
4143	<attribute name="CPUCount" type="unsigned long">
4144	<desc>Number of virtual CPUs in the VM.</desc>
4145	</attribute>
4146
4147	<attribute name="CPUHotPlugEnabled" type="boolean">
4148	<desc>
4149	This setting determines whether VirtualBox allows CPU
4150	hotplugging for this machine.</desc>
4151	</attribute>
4152
4153	<attribute name="CPUExecutionCap" type="unsigned long">
4154	<desc>
4155	Means to limit the number of CPU cycles a guest can use. The unit
4156	is percentage of host CPU cycles per second. The valid range
4157	is 1 - 100. 100 (the default) implies no limit.
4158	</desc>
4159	</attribute>
4160
4161	<attribute name="memorySize" type="unsigned long">
4162	<desc>System memory size in megabytes.</desc>
4163	</attribute>
4164
4165	<attribute name="memoryBalloonSize" type="unsigned long">
4166	<desc>Memory balloon size in megabytes.</desc>
4167	</attribute>
4168
4169	<attribute name="pageFusionEnabled" type="boolean">
4170	<desc>
4171	This setting determines whether VirtualBox allows page
4172	fusion for this machine (64 bits host only).
4173	</desc>
4174	</attribute>
4175
4176	<attribute name="VRAMSize" type="unsigned long">
4177	<desc>Video memory size in megabytes.</desc>
4178	</attribute>
4179
4180	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4181	<desc>
4182	This setting determines whether VirtualBox allows this machine to make
4183	use of the 3D graphics support available on the host.</desc>
4184	</attribute>
4185
4186	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4187	<desc>
4188	This setting determines whether VirtualBox allows this machine to make
4189	use of the 2D video acceleration support available on the host.</desc>
4190	</attribute>
4191
4192	<attribute name="monitorCount" type="unsigned long">
4193	<desc>
4194	Number of virtual monitors.
4195	<note>
4196	Only effective on Windows XP and later guests with
4197	Guest Additions installed.
4198	</note>
4199	</desc>
4200	</attribute>
4201
4202	<attribute name="VideoCaptureEnabled" type="boolean" default="false">
4203	<desc>
4204	This setting determines whether VirtualBox uses video recording to
4205	record VM session.</desc>
4206	</attribute>
4207
4208	<attribute name="VideoCaptureFile" type="wstring" default="Test.webm">
4209	<desc>
4210	This setting determines what filename VirtualBox uses to save
4211	the recorded content.</desc>
4212	</attribute>
4213
4214	<attribute name="VideoCaptureWidth" type="unsigned long" default="640">
4215	<desc>
4216	This setting determines what should be the horizontal resolution of
4217	recorded video.</desc>
4218	</attribute>
4219
4220	<attribute name="VideoCaptureHeight" type="unsigned long" default="480">
4221	<desc>
4222	This setting determines what should be the vertical resolution
4223	of recorded video.</desc>
4224	</attribute>
4225
4226	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4227	<desc>Object containing all BIOS settings.</desc>
4228	</attribute>
4229
4230	<attribute name="firmwareType" type="FirmwareType">
4231	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4232	bootstrap in this VM.</desc>
4233	</attribute>
4234
4235	<attribute name="pointingHIDType" type="PointingHIDType">
4236	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4237	The default is typically "PS2Mouse" but can vary depending on the
4238	requirements of the guest operating system.</desc>
4239	</attribute>
4240
4241	<attribute name="keyboardHIDType" type="KeyboardHIDType">
4242	<desc>Type of keyboard HID used in this VM.
4243	The default is typically "PS2Keyboard" but can vary depending on the
4244	requirements of the guest operating system.</desc>
4245	</attribute>
4246
4247	<attribute name="HPETEnabled" type="boolean">
4248	<desc>This attribute controls if High Precision Event Timer (HPET) is
4249	enabled in this VM. Use this property if you want to provide guests
4250	with additional time source, or if guest requires HPET to function correctly.
4251	Default is false.</desc>
4252	</attribute>
4253
4254	<attribute name="chipsetType" type="ChipsetType">
4255	<desc>Chipset type used in this VM.</desc>
4256	</attribute>
4257
4258	<attribute name="snapshotFolder" type="wstring">
4259	<desc>
4260	Full path to the directory used to store snapshot data
4261	(differencing media and saved state files) of this machine.
4262
4263	The initial value of this property is
4264	<tt><</tt><link to="#settingsFilePath">
4265	path_to_settings_file</link><tt>>/<</tt>
4266	<link to="#id">machine_uuid</link>
4267	<tt>></tt>.
4268
4269	Currently, it is an error to try to change this property on
4270	a machine that has snapshots (because this would require to
4271	move possibly large files to a different location).
4272	A separate method will be available for this purpose later.
4273
4274	<note>
4275	Setting this property to @c null or to an empty string will restore
4276	the initial value.
4277	</note>
4278	<note>
4279	When setting this property, the specified path can be
4280	absolute (full path) or relative to the directory where the
4281	<link to="#settingsFilePath">machine settings file</link>
4282	is located. When reading this property, a full path is
4283	always returned.
4284	</note>
4285	<note>
4286	The specified path may not exist, it will be created
4287	when necessary.
4288	</note>
4289	</desc>
4290	</attribute>
4291
4292	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4293	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4294	</attribute>
4295
4296	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4297	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4298
4299	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4300	<desc>Array of media attached to this machine.</desc>
4301	</attribute>
4302
4303	<attribute name="USBController" type="IUSBController" readonly="yes">
4304	<desc>
4305	Associated USB controller object.
4306
4307	<note>
4308	If USB functionality is not available in the given edition of
4309	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4310	</note>
4311	</desc>
4312	</attribute>
4313
4314	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4315	<desc>Associated audio adapter, always present.</desc>
4316	</attribute>
4317
4318	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4319	<desc>Array of storage controllers attached to this machine.</desc>
4320	</attribute>
4321
4322	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4323	<desc>
4324	Full name of the file containing machine settings data.
4325	</desc>
4326	</attribute>
4327
4328	<attribute name="settingsModified" type="boolean" readonly="yes">
4329	<desc>
4330	Whether the settings of this machine have been modified
4331	(but neither yet saved nor discarded).
4332	<note>
4333	Reading this property is only valid on instances returned
4334	by <link to="ISession::machine"/> and on new machines
4335	created by <link to="IVirtualBox::createMachine"/> or opened
4336	by <link to="IVirtualBox::openMachine"/> but not
4337	yet registered, or on unregistered machines after calling
4338	<link to="IMachine::unregister"/>. For all other
4339	cases, the settings can never be modified.
4340	</note>
4341	<note>
4342	For newly created unregistered machines, the value of this
4343	property is always @c true until <link to="#saveSettings"/>
4344	is called (no matter if any machine settings have been
4345	changed after the creation or not). For opened machines
4346	the value is set to @c false (and then follows to normal rules).
4347	</note>
4348	</desc>
4349	</attribute>
4350
4351	<attribute name="sessionState" type="SessionState" readonly="yes">
4352	<desc>Current session state for this machine.</desc>
4353	</attribute>
4354
4355	<attribute name="sessionType" type="wstring" readonly="yes">
4356	<desc>
4357	Type of the session. If <link to="#sessionState"/> is
4358	Spawning or Locked, this attribute contains the
4359	same value as passed to the
4360	<link to="IMachine::launchVMProcess"/> method in the
4361	@a type parameter. If the session was used with
4362	<link to="IMachine::lockMachine" />, or if
4363	<link to="#sessionState"/> is SessionClosed, the value of this
4364	attribute is an empty string.
4365	</desc>
4366	</attribute>
4367
4368	<attribute name="sessionPID" type="unsigned long" readonly="yes">
4369	<desc>
4370	Identifier of the session process. This attribute contains the
4371	platform-dependent identifier of the process whose session was
4372	used with <link to="IMachine::lockMachine" /> call. The returned
4373	value is only valid if <link to="#sessionState"/> is Locked or
4374	Unlocking by the time this property is read.
4375	</desc>
4376	</attribute>
4377
4378	<attribute name="state" type="MachineState" readonly="yes">
4379	<desc>Current execution state of this machine.</desc>
4380	</attribute>
4381
4382	<attribute name="lastStateChange" type="long long" readonly="yes">
4383	<desc>
4384	Time stamp of the last execution state change,
4385	in milliseconds since 1970-01-01 UTC.
4386	</desc>
4387	</attribute>
4388
4389	<attribute name="stateFilePath" type="wstring" readonly="yes">
4390	<desc>
4391	Full path to the file that stores the execution state of
4392	the machine when it is in the <link to="MachineState_Saved"/> state.
4393	<note>
4394	When the machine is not in the Saved state, this attribute is
4395	an empty string.
4396	</note>
4397	</desc>
4398	</attribute>
4399
4400	<attribute name="logFolder" type="wstring" readonly="yes">
4401	<desc>
4402	Full path to the folder that stores a set of rotated log files
4403	recorded during machine execution. The most recent log file is
4404	named <tt>VBox.log</tt>, the previous log file is
4405	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4406	in the current version).
4407	</desc>
4408	</attribute>
4409
4410	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4411	<desc>
4412	Current snapshot of this machine. This is @c null if the machine
4413	currently has no snapshots. If it is not @c null, then it was
4414	set by one of <link to="IConsole::takeSnapshot" />,
4415	<link to="IConsole::deleteSnapshot" />
4416	or <link to="IConsole::restoreSnapshot" />, depending on which
4417	was called last. See <link to="ISnapshot"/> for details.
4418	</desc>
4419	</attribute>
4420
4421	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4422	<desc>
4423	Number of snapshots taken on this machine. Zero means the
4424	machine doesn't have any snapshots.
4425	</desc>
4426	</attribute>
4427
4428	<attribute name="currentStateModified" type="boolean" readonly="yes">
4429	<desc>
4430	Returns @c true if the current state of the machine is not
4431	identical to the state stored in the current snapshot.
4432
4433	The current state is identical to the current snapshot only
4434	directly after one of the following calls are made:
4435
4436	<ul>
4437	<li><link to="IConsole::restoreSnapshot"/>
4438	</li>
4439	<li><link to="IConsole::takeSnapshot"/> (issued on a
4440	"powered off" or "saved" machine, for which
4441	<link to="#settingsModified"/> returns @c false)
4442	</li>
4443	</ul>
4444
4445	The current state remains identical until one of the following
4446	happens:
4447	<ul>
4448	<li>settings of the machine are changed</li>
4449	<li>the saved state is deleted</li>
4450	<li>the current snapshot is deleted</li>
4451	<li>an attempt to execute the machine is made</li>
4452	</ul>
4453
4454	<note>
4455	For machines that don't have snapshots, this property is
4456	always @c false.
4457	</note>
4458	</desc>
4459	</attribute>
4460
4461	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4462	<desc>
4463	Collection of shared folders for this machine (permanent shared
4464	folders). These folders are shared automatically at machine startup
4465	and available only to the guest OS installed within this machine.
4466
4467	New shared folders are added to the collection using
4468	<link to="#createSharedFolder"/>. Existing shared folders can be
4469	removed using <link to="#removeSharedFolder"/>.
4470	</desc>
4471	</attribute>
4472
4473	<attribute name="clipboardMode" type="ClipboardMode">
4474	<desc>
4475	Synchronization mode between the host OS clipboard
4476	and the guest OS clipboard.
4477	</desc>
4478	</attribute>
4479
4480	<attribute name="dragAndDropMode" type="DragAndDropMode">
4481	<desc>
4482	Which mode is allowed for drag'n'drop.
4483	</desc>
4484	</attribute>
4485
4486	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4487	<desc>
4488	A comma-separated list of simple glob patterns. Changes to guest
4489	properties whose name matches one of the patterns will generate an
4490	<link to="IGuestPropertyChangedEvent"/> signal.
4491	</desc>
4492	</attribute>
4493
4494	<attribute name="teleporterEnabled" type="boolean">
4495	<desc>
4496	When set to @a true, the virtual machine becomes a target teleporter
4497	the next time it is powered on. This can only set to @a true when the
4498	VM is in the @a PoweredOff or @a Aborted state.
4499
4500	<!-- This property is automatically set to @a false when the VM is powered
4501	on. (bird: This doesn't work yet ) -->
4502	</desc>
4503	</attribute>
4504
4505	<attribute name="teleporterPort" type="unsigned long">
4506	<desc>
4507	The TCP port the target teleporter will listen for incoming
4508	teleportations on.
4509
4510	0 means the port is automatically selected upon power on. The actual
4511	value can be read from this property while the machine is waiting for
4512	incoming teleportations.
4513	</desc>
4514	</attribute>
4515
4516	<attribute name="teleporterAddress" type="wstring">
4517	<desc>
4518	The address the target teleporter will listen on. If set to an empty
4519	string, it will listen on all addresses.
4520	</desc>
4521	</attribute>
4522
4523	<attribute name="teleporterPassword" type="wstring">
4524	<desc>
4525	The password to check for on the target teleporter. This is just a
4526	very basic measure to prevent simple hacks and operators accidentally
4527	beaming a virtual machine to the wrong place.
4528
4529	Note that you SET a plain text password while reading back a HASHED
4530	password. Setting a hashed password is currently not supported.
4531	</desc>
4532	</attribute>
4533
4534	<attribute name="faultToleranceState" type="FaultToleranceState">
4535	<desc>
4536	Fault tolerance state; disabled, source or target.
4537	This property can be changed at any time. If you change it for a running
4538	VM, then the fault tolerance address and port must be set beforehand.
4539	</desc>
4540	</attribute>
4541
4542	<attribute name="faultTolerancePort" type="unsigned long">
4543	<desc>
4544	The TCP port the fault tolerance source or target will use for
4545	communication.
4546	</desc>
4547	</attribute>
4548
4549	<attribute name="faultToleranceAddress" type="wstring">
4550	<desc>
4551	The address the fault tolerance source or target.
4552	</desc>
4553	</attribute>
4554
4555	<attribute name="faultTolerancePassword" type="wstring">
4556	<desc>
4557	The password to check for on the standby VM. This is just a
4558	very basic measure to prevent simple hacks and operators accidentally
4559	choosing the wrong standby VM.
4560	</desc>
4561	</attribute>
4562
4563	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4564	<desc>
4565	The interval in ms used for syncing the state between source and target.
4566	</desc>
4567	</attribute>
4568
4569	<attribute name="RTCUseUTC" type="boolean">
4570	<desc>
4571	When set to @a true, the RTC device of the virtual machine will run
4572	in UTC time, otherwise in local time. Especially Unix guests prefer
4573	the time in UTC.
4574	</desc>
4575	</attribute>
4576
4577	<attribute name="IOCacheEnabled" type="boolean">
4578	<desc>
4579	When set to @a true, the builtin I/O cache of the virtual machine
4580	will be enabled.
4581	</desc>
4582	</attribute>
4583
4584	<attribute name="IOCacheSize" type="unsigned long">
4585	<desc>
4586	Maximum size of the I/O cache in MB.
4587	</desc>
4588	</attribute>
4589
4590	<attribute name="PCIDeviceAssignments" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
4591	<desc>Array of PCI devices assigned to this machine, to get list of all
4592	PCI devices attached to the machine use
4593	<link to="IConsole::attachedPCIDevices"/> attribute, as this attribute
4594	is intended to list only devices additional to what described in
4595	virtual hardware config. Usually, this list keeps host's physical
4596	devices assigned to the particular machine.
4597	</desc>
4598	</attribute>
4599
4600	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4601	<desc>
4602	Bandwidth control manager.
4603	</desc>
4604	</attribute>
4605
4606	<attribute name="tracingEnabled" type="boolean">
4607	<desc>
4608	Enables the tracing facility in the VMM (including PDM devices +
4609	drivers). The VMM will consume about 0.5MB of more memory when
4610	enabled and there may be some extra overhead from tracepoints that are
4611	always enabled.
4612	</desc>
4613	</attribute>
4614
4615	<attribute name="tracingConfig" type="wstring">
4616	<desc>
4617	Tracepoint configuration to apply at startup when
4618	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4619	a space separated of tracepoint group names to enable. The special
4620	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4621	more details on available tracepoint groups and such.
4622
4623	Note that on hosts supporting DTrace (or similar), a lot of the
4624	tracepoints may be implemented exclusivly as DTrace probes. So, the
4625	effect of the same config may differ between Solaris and Windows for
4626	example.
4627	</desc>
4628	</attribute>
4629
4630	<attribute name="allowTracingToAccessVM" type="boolean">
4631	<desc>
4632	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4633	structures when firing off trace points. This is especially useful
4634	with DTrace tracepoints, as it allows you to use the VMCPU or VM
4635	pointer to obtain useful information such as guest register state.
4636
4637	This is disabled by default because devices and drivers normally has no
4638	business accessing the VMCPU or VM structures, and are therefore unable
4639	to get any pointers to these.
4640	</desc>
4641	</attribute>
4642
4643	<attribute name="autostartEnabled" type="boolean">
4644	<desc>
4645	Enables autostart of the VM during system boot.
4646	</desc>
4647	</attribute>
4648
4649	<attribute name="autostartDelay" type="unsigned long">
4650	<desc>
4651	Number of seconds to wait until the VM should be started during system boot.
4652	</desc>
4653	</attribute>
4654
4655	<attribute name="autostopType" type="AutostopType">
4656	<desc>
4657	Action type to do when the system is shutting down.
4658	</desc>
4659	</attribute>
4660
4661	<attribute name="defaultFrontend" type="wstring">
4662	<desc>
4663	Selects which VM frontend should be used by default when launching
4664	this VM through the <link to="IMachine::launchVMProcess" /> method.
4665	Empty or @c null strings do not define a particular default, it is up
4666	to <link to="IMachine::launchVMProcess" /> to select one. See the
4667	description of <link to="IMachine::launchVMProcess" /> for the valid
4668	frontend types.
4669
4670	This per-VM setting overrides the default defined by
4671	<link to="ISystemProperties::defaultFrontend" /> attribute, and is
4672	overridden by a frontend type passed to
4673	<link to="IMachine::launchVMProcess" />.
4674	</desc>
4675	</attribute>
4676
4677	<method name="lockMachine">
4678	<desc>
4679	Locks the machine for the given session to enable the caller
4680	to make changes to the machine or start the VM or control
4681	VM execution.
4682
4683	There are two ways to lock a machine for such uses:
4684
4685	<ul>
4686	<li>If you want to make changes to the machine settings,
4687	you must obtain an exclusive write lock on the machine
4688	by setting @a lockType to @c Write.
4689
4690	This will only succeed if no other process has locked
4691	the machine to prevent conflicting changes. Only after
4692	an exclusive write lock has been obtained using this method, one
4693	can change all VM settings or execute the VM in the process
4694	space of the session object. (Note that the latter is only of
4695	interest if you actually want to write a new front-end for
4696	virtual machines; but this API gets called internally by
4697	the existing front-ends such as VBoxHeadless and the VirtualBox
4698	GUI to acquire a write lock on the machine that they are running.)
4699
4700	On success, write-locking the machine for a session creates
4701	a second copy of the IMachine object. It is this second object
4702	upon which changes can be made; in VirtualBox terminology, the
4703	second copy is "mutable". It is only this second, mutable machine
4704	object upon which you can call methods that change the
4705	machine state. After having called this method, you can
4706	obtain this second, mutable machine object using the
4707	<link to="ISession::machine" /> attribute.
4708	</li>
4709	<li>If you only want to check the machine state or control
4710	machine execution without actually changing machine
4711	settings (e.g. to get access to VM statistics or take
4712	a snapshot or save the machine state), then set the
4713	@a lockType argument to @c Shared.
4714
4715	If no other session has obtained a lock, you will obtain an
4716	exclusive write lock as described above. However, if another
4717	session has already obtained such a lock, then a link to that
4718	existing session will be established which allows you
4719	to control that existing session.
4720
4721	To find out which type of lock was obtained, you can
4722	inspect <link to="ISession::type" />, which will have been
4723	set to either @c WriteLock or @c Shared.
4724	</li>
4725	</ul>
4726
4727	In either case, you can get access to the <link to="IConsole" />
4728	object which controls VM execution.
4729
4730	Also in all of the above cases, one must always call
4731	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4732	the machine's state will eventually be set to "Aborted".
4733
4734	To change settings on a machine, the following sequence is typically
4735	performed:
4736
4737	<ol>
4738	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4739
4740	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4741
4742	<li>Change the settings of the machine by invoking IMachine methods.</li>
4743
4744	<li>Call <link to="IMachine::saveSettings" />.</li>
4745
4746	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4747	</ol>
4748
4749	<result name="E_UNEXPECTED">
4750	Virtual machine not registered.
4751	</result>
4752	<result name="E_ACCESSDENIED">
4753	Process not started by OpenRemoteSession.
4754	</result>
4755	<result name="VBOX_E_INVALID_OBJECT_STATE">
4756	Session already open or being opened.
4757	</result>
4758	<result name="VBOX_E_VM_ERROR">
4759	Failed to assign machine to session.
4760	</result>
4761	</desc>
4762	<param name="session" type="ISession" dir="in">
4763	<desc>
4764	Session object for which the machine will be locked.
4765	</desc>
4766	</param>
4767	<param name="lockType" type="LockType" dir="in">
4768	<desc>
4769	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4770	If set to @c Shared, then either acquire an exclusive write lock or establish
4771	a link to an existing session.
4772	</desc>
4773	</param>
4774	</method>
4775
4776	<method name="launchVMProcess">
4777	<desc>
4778	Spawns a new process that will execute the virtual machine and obtains a shared
4779	lock on the machine for the calling session.
4780
4781	If launching the VM succeeds, the new VM process will create its own session
4782	and write-lock the machine for it, preventing conflicting changes from other
4783	processes. If the machine is already locked (because it is already running or
4784	because another session has a write lock), launching the VM process will therefore
4785	fail. Reversely, future attempts to obtain a write lock will also fail while the
4786	machine is running.
4787
4788	The caller's session object remains separate from the session opened by the new
4789	VM process. It receives its own <link to="IConsole" /> object which can be used
4790	to control machine execution, but it cannot be used to change all VM settings
4791	which would be available after a <link to="#lockMachine" /> call.
4792
4793	The caller must eventually release the session's shared lock by calling
4794	<link to="ISession::unlockMachine" /> on the local session object once this call
4795	has returned. However, the session's state (see <link to="ISession::state" />)
4796	will not return to "Unlocked" until the remote session has also unlocked
4797	the machine (i.e. the machine has stopped running).
4798
4799	Launching a VM process can take some time (a new VM is started in a new process,
4800	for which memory and other resources need to be set up). Because of this,
4801	an <link to="IProgress" /> object is returned to allow the caller to wait
4802	for this asynchronous operation to be completed. Until then, the caller's
4803	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4804	and <link to="ISession::console" /> attributes cannot be accessed.
4805	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4806	similar calls to wait for completion. Completion is signalled when the VM
4807	is powered on. If launching the VM fails, error messages can be queried
4808	via the progress object, if available.
4809
4810	The progress object will have at least 2 sub-operations. The first
4811	operation covers the period up to the new VM process calls powerUp.
4812	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4813	progress object. Because <link to="IConsole::powerUp"/> may require
4814	some extra sub-operations, the <link to="IProgress::operationCount"/>
4815	may change at the completion of operation.
4816
4817	For details on the teleportation progress operation, see
4818	<link to="IConsole::powerUp"/>.
4819
4820	The @a environment argument is a string containing definitions of
4821	environment variables in the following format:
4822	<pre>
4823	NAME[=VALUE]\n
4824	NAME[=VALUE]\n
4825	...
4826	</pre>
4827	where <tt>\\n</tt> is the new line character. These environment
4828	variables will be appended to the environment of the VirtualBox server
4829	process. If an environment variable exists both in the server process
4830	and in this list, the value from this list takes precedence over the
4831	server's variable. If the value of the environment variable is
4832	omitted, this variable will be removed from the resulting environment.
4833	If the environment string is @c null or empty, the server environment
4834	is inherited by the started process as is.
4835
4836	<result name="E_UNEXPECTED">
4837	Virtual machine not registered.
4838	</result>
4839	<result name="E_INVALIDARG">
4840	Invalid session type @a type.
4841	</result>
4842	<result name="VBOX_E_OBJECT_NOT_FOUND">
4843	No machine matching @a machineId found.
4844	</result>
4845	<result name="VBOX_E_INVALID_OBJECT_STATE">
4846	Session already open or being opened.
4847	</result>
4848	<result name="VBOX_E_IPRT_ERROR">
4849	Launching process for machine failed.
4850	</result>
4851	<result name="VBOX_E_VM_ERROR">
4852	Failed to assign machine to session.
4853	</result>
4854	</desc>
4855	<param name="session" type="ISession" dir="in">
4856	<desc>
4857	Client session object to which the VM process will be connected (this
4858	must be in "Unlocked" state).
4859	</desc>
4860	</param>
4861	<param name="type" type="wstring" dir="in">
4862	<desc>
4863	Front-end to use for the new VM process. The following are currently supported:
4864	<ul>
4865	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4866	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4867	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4868	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4869	the currently running VM or session owner. In this case the
4870	@a session parameter may be @c null (if it is non-null it isn't
4871	used in any way), and the @a progress return value will be always
4872	@c null. The operation completes immediately.</li>
4873	<li><tt>""</tt>: use the per-VM default frontend if set, otherwise
4874	the global default defined in the system properties. If neither
4875	are set, the API will launch a <tt>"gui"</tt> session, which may
4876	fail if there is no windowing environment available. See
4877	<link to="IMachine::defaultFrontend"/> and
4878	<link to="ISystemProperties::defaultFrontend"/>.</li>
4879	</ul>
4880	</desc>
4881	</param>
4882	<param name="environment" type="wstring" dir="in">
4883	<desc>
4884	Environment to pass to the VM process.
4885	</desc>
4886	</param>
4887	<param name="progress" type="IProgress" dir="return">
4888	<desc>Progress object to track the operation completion.</desc>
4889	</param>
4890	</method>
4891
4892	<method name="setBootOrder">
4893	<desc>
4894	Puts the given device to the specified position in
4895	the boot order.
4896
4897	To indicate that no device is associated with the given position,
4898	<link to="DeviceType_Null"/> should be used.
4899
4900	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4901
4902	<result name="E_INVALIDARG">
4903	Boot @a position out of range.
4904	</result>
4905	<result name="E_NOTIMPL">
4906	Booting from USB @a device currently not supported.
4907	</result>
4908
4909	</desc>
4910	<param name="position" type="unsigned long" dir="in">
4911	<desc>
4912	Position in the boot order (@c 1 to the total number of
4913	devices the machine can boot from, as returned by
4914	<link to="ISystemProperties::maxBootPosition"/>).
4915	</desc>
4916	</param>
4917	<param name="device" type="DeviceType" dir="in">
4918	<desc>
4919	The type of the device used to boot at the given position.
4920	</desc>
4921	</param>
4922	</method>
4923
4924	<method name="getBootOrder" const="yes">
4925	<desc>
4926	Returns the device type that occupies the specified
4927	position in the boot order.
4928
4929	@todo [remove?]
4930	If the machine can have more than one device of the returned type
4931	(such as hard disks), then a separate method should be used to
4932	retrieve the individual device that occupies the given position.
4933
4934	If here are no devices at the given position, then
4935	<link to="DeviceType_Null"/> is returned.
4936
4937	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4938
4939	<result name="E_INVALIDARG">
4940	Boot @a position out of range.
4941	</result>
4942
4943	</desc>
4944	<param name="position" type="unsigned long" dir="in">
4945	<desc>
4946	Position in the boot order (@c 1 to the total number of
4947	devices the machine can boot from, as returned by
4948	<link to="ISystemProperties::maxBootPosition"/>).
4949	</desc>
4950	</param>
4951	<param name="device" type="DeviceType" dir="return">
4952	<desc>
4953	Device at the given position.
4954	</desc>
4955	</param>
4956	</method>
4957
4958	<method name="attachDevice">
4959	<desc>
4960	Attaches a device and optionally mounts a medium to the given storage
4961	controller (<link to="IStorageController" />, identified by @a name),
4962	at the indicated port and device.
4963
4964	This method is intended for managing storage devices in general while a
4965	machine is powered off. It can be used to attach and detach fixed
4966	and removable media. The following kind of media can be attached
4967	to a machine:
4968
4969	<ul>
4970	<li>For fixed and removable media, you can pass in a medium that was
4971	previously opened using <link to="IVirtualBox::openMedium" />.
4972	</li>
4973
4974	<li>Only for storage devices supporting removable media (such as
4975	DVDs and floppies), you can also specify a null pointer to
4976	indicate an empty drive or one of the medium objects listed
4977	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4978	arrays to indicate a host drive.
4979	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4980	to change the media while the machine is running.
4981	</li>
4982	</ul>
4983
4984	In a VM's default configuration of virtual machines, the secondary
4985	master of the IDE controller is used for a CD/DVD drive.
4986
4987	After calling this returns successfully, a new instance of
4988	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4989	attachments (see <link to="IMachine::mediumAttachments"/>).
4990
4991	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4992	information about attaching media.
4993
4994	The specified device slot must not have a device attached to it,
4995	or this method will fail.
4996
4997	<note>
4998	You cannot attach a device to a newly created machine until
4999	this machine's settings are saved to disk using
5000	<link to="#saveSettings"/>.
5001	</note>
5002	<note>
5003	If the medium is being attached indirectly, a new differencing medium
5004	will implicitly be created for it and attached instead. If the
5005	changes made to the machine settings (including this indirect
5006	attachment) are later cancelled using <link to="#discardSettings"/>,
5007	this implicitly created differencing medium will implicitly
5008	be deleted.
5009	</note>
5010
5011	<result name="E_INVALIDARG">
5012	SATA device, SATA port, IDE port or IDE slot out of range, or
5013	file or UUID not found.
5014	</result>
5015	<result name="VBOX_E_INVALID_OBJECT_STATE">
5016	Machine must be registered before media can be attached.
5017	</result>
5018	<result name="VBOX_E_INVALID_VM_STATE">
5019	Invalid machine state.
5020	</result>
5021	<result name="VBOX_E_OBJECT_IN_USE">
5022	A medium is already attached to this or another virtual machine.
5023	</result>
5024
5025	</desc>
5026	<param name="name" type="wstring" dir="in">
5027	<desc>Name of the storage controller to attach the device to.</desc>
5028	</param>
5029	<param name="controllerPort" type="long" dir="in">
5030	<desc>Port to attach the device to. For an IDE controller, 0 specifies
5031	the primary controller and 1 specifies the secondary controller.
5032	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
5033	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
5034	</param>
5035	<param name="device" type="long" dir="in">
5036	<desc>Device slot in the given port to attach the device to. This is only
5037	relevant for IDE controllers, for which 0 specifies the master device and
5038	1 specifies the slave device. For all other controller types, this must
5039	be 0.</desc>
5040	</param>
5041	<param name="type" type="DeviceType" dir="in">
5042	<desc>Device type of the attached device. For media opened by
5043	<link to="IVirtualBox::openMedium" />, this must match the device type
5044	specified there.</desc>
5045	</param>
5046	<param name="medium" type="IMedium" dir="in">
5047	<desc>Medium to mount or @c null for an empty drive.</desc>
5048	</param>
5049	</method>
5050
5051	<method name="attachDeviceWithoutMedium">
5052	<desc>
5053	Attaches a device and optionally mounts a medium to the given storage
5054	controller (<link to="IStorageController" />, identified by @a name),
5055	at the indicated port and device.
5056
5057	This method is intended for managing storage devices in general while a
5058	machine is powered off. It can be used to attach and detach fixed
5059	and removable media. The following kind of media can be attached
5060	to a machine:
5061	<ul>
5062	<li>
5063	For fixed and removable media, you can pass in a medium that was
5064	previously opened using <link to="IVirtualBox::openMedium" />.
5065	</li>
5066
5067	<li>Only for storage devices supporting removable media (such as
5068	DVDs and floppies) with an empty drive or one of the medium objects listed
5069	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
5070	arrays to indicate a host drive.
5071	For removable devices, you can also use <link to="IMachine::mountMedium"/>
5072	to change the media while the machine is running.
5073	</li>
5074	</ul>
5075
5076	In a VM's default configuration of virtual machines, the secondary
5077	master of the IDE controller is used for a CD/DVD drive.
5078	<link to="IMediumAttachment"/> will appear in the machine's list of medium
5079	attachments (see <link to="IMachine::mediumAttachments"/>).
5080
5081	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
5082	information about attaching media.
5083
5084	The specified device slot must not have a device attached to it,
5085	or this method will fail.
5086	<note>
5087	You cannot attach a device to a newly created machine until
5088	this machine's settings are saved to disk using
5089	<link to="#saveSettings"/>.
5090	</note>
5091	<note>
5092	If the medium is being attached indirectly, a new differencing medium
5093	will implicitly be created for it and attached instead. If the
5094	changes made to the machine settings (including this indirect
5095	attachment) are later cancelled using <link to="#discardSettings"/>,
5096	this implicitly created differencing medium will implicitly
5097	be deleted.
5098	</note>
5099
5100	<result name="E_INVALIDARG">
5101	SATA device, SATA port, IDE port or IDE slot out of range, or
5102	file or UUID not found.
5103	</result>
5104	<result name="VBOX_E_INVALID_OBJECT_STATE">
5105	Machine must be registered before media can be attached.
5106	</result>
5107	<result name="VBOX_E_INVALID_VM_STATE">
5108	Invalid machine state.
5109	</result>
5110	<result name="VBOX_E_OBJECT_IN_USE">
5111	A medium is already attached to this or another virtual machine.
5112	</result>
5113	</desc>
5114	<param name="name" type="wstring" dir="in">
5115	<desc>Name of the storage controller to attach the device to.</desc>
5116	</param>
5117	<param name="controllerPort" type="long" dir="in">
5118	<desc>Port to attach the device to. For an IDE controller, 0 specifies
5119	the primary controller and 1 specifies the secondary controller.
5120	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
5121	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
5122	</param>
5123	<param name="device" type="long" dir="in">
5124	<desc>Device slot in the given port to attach the device to. This is only
5125	relevant for IDE controllers, for which 0 specifies the master device and
5126	1 specifies the slave device. For all other controller types, this must
5127	be 0.</desc>
5128	</param>
5129	<param name="type" type="DeviceType" dir="in">
5130	<desc>Device type of the attached device. For media opened by
5131	<link to="IVirtualBox::openMedium" />, this must match the device type
5132	specified there.</desc>
5133	</param>
5134	</method>
5135
5136	<method name="detachDevice">
5137	<desc>
5138	Detaches the device attached to a device slot of the specified bus.
5139
5140	Detaching the device from the virtual machine is deferred. This means
5141	that the medium remains associated with the machine when this method
5142	returns and gets actually de-associated only after a successful
5143	<link to="#saveSettings"/> call. See <link to="IMedium"/>
5144	for more detailed information about attaching media.
5145
5146	<note>
5147	You cannot detach a device from a running machine.
5148	</note>
5149	<note>
5150	Detaching differencing media implicitly created by <link
5151	to="#attachDevice"/> for the indirect attachment using this
5152	method will <b>not</b> implicitly delete them. The
5153	<link to="IMedium::deleteStorage"/> operation should be
5154	explicitly performed by the caller after the medium is successfully
5155	detached and the settings are saved with
5156	<link to="#saveSettings"/>, if it is the desired action.
5157	</note>
5158
5159	<result name="VBOX_E_INVALID_VM_STATE">
5160	Attempt to detach medium from a running virtual machine.
5161	</result>
5162	<result name="VBOX_E_OBJECT_NOT_FOUND">
5163	No medium attached to given slot/bus.
5164	</result>
5165	<result name="VBOX_E_NOT_SUPPORTED">
5166	Medium format does not support storage deletion (only for implicitly
5167	created differencing media, should not happen).
5168	</result>
5169
5170	</desc>
5171	<param name="name" type="wstring" dir="in">
5172	<desc>Name of the storage controller to detach the medium from.</desc>
5173	</param>
5174	<param name="controllerPort" type="long" dir="in">
5175	<desc>Port number to detach the medium from.</desc>
5176	</param>
5177	<param name="device" type="long" dir="in">
5178	<desc>Device slot number to detach the medium from.</desc>
5179	</param>
5180	</method>
5181
5182	<method name="passthroughDevice">
5183	<desc>
5184	Sets the passthrough mode of an existing DVD device. Changing the
5185	setting while the VM is running is forbidden. The setting is only used
5186	if at VM start the device is configured as a host DVD drive, in all
5187	other cases it is ignored. The device must already exist; see
5188	<link to="IMachine::attachDevice"/> for how to attach a new device.
5189
5190	The @a controllerPort and @a device parameters specify the device slot and
5191	have have the same meaning as with <link to="IMachine::attachDevice" />.
5192
5193	<result name="E_INVALIDARG">
5194	SATA device, SATA port, IDE port or IDE slot out of range.
5195	</result>
5196	<result name="VBOX_E_INVALID_OBJECT_STATE">
5197	Attempt to modify an unregistered virtual machine.
5198	</result>
5199	<result name="VBOX_E_INVALID_VM_STATE">
5200	Invalid machine state.
5201	</result>
5202
5203	</desc>
5204	<param name="name" type="wstring" dir="in">
5205	<desc>Name of the storage controller.</desc>
5206	</param>
5207	<param name="controllerPort" type="long" dir="in">
5208	<desc>Storage controller port.</desc>
5209	</param>
5210	<param name="device" type="long" dir="in">
5211	<desc>Device slot in the given port.</desc>
5212	</param>
5213	<param name="passthrough" type="boolean" dir="in">
5214	<desc>New value for the passthrough setting.</desc>
5215	</param>
5216	</method>
5217
5218	<method name="temporaryEjectDevice">
5219	<desc>
5220	Sets the behavior for guest-triggered medium eject. In some situations
5221	it is desirable that such ejects update the VM configuration, and in
5222	others the eject should keep the VM configuration. The device must
5223	already exist; see <link to="IMachine::attachDevice"/> for how to
5224	attach a new device.
5225
5226	The @a controllerPort and @a device parameters specify the device slot and
5227	have have the same meaning as with <link to="IMachine::attachDevice" />.
5228
5229	<result name="E_INVALIDARG">
5230	SATA device, SATA port, IDE port or IDE slot out of range.
5231	</result>
5232	<result name="VBOX_E_INVALID_OBJECT_STATE">
5233	Attempt to modify an unregistered virtual machine.
5234	</result>
5235	<result name="VBOX_E_INVALID_VM_STATE">
5236	Invalid machine state.
5237	</result>
5238
5239	</desc>
5240	<param name="name" type="wstring" dir="in">
5241	<desc>Name of the storage controller.</desc>
5242	</param>
5243	<param name="controllerPort" type="long" dir="in">
5244	<desc>Storage controller port.</desc>
5245	</param>
5246	<param name="device" type="long" dir="in">
5247	<desc>Device slot in the given port.</desc>
5248	</param>
5249	<param name="temporaryEject" type="boolean" dir="in">
5250	<desc>New value for the eject behavior.</desc>
5251	</param>
5252	</method>
5253
5254	<method name="nonRotationalDevice">
5255	<desc>
5256	Sets a flag in the device information which indicates that the medium
5257	is not based on rotational technology, i.e. that the access times are
5258	more or less independent of the position on the medium. This may or may
5259	not be supported by a particular drive, and is silently ignored in the
5260	latter case. At the moment only hard disks (which is a misnomer in this
5261	context) accept this setting. Changing the setting while the VM is
5262	running is forbidden. The device must already exist; see
5263	<link to="IMachine::attachDevice"/> for how to attach a new device.
5264
5265	The @a controllerPort and @a device parameters specify the device slot and
5266	have have the same meaning as with <link to="IMachine::attachDevice" />.
5267
5268	<result name="E_INVALIDARG">
5269	SATA device, SATA port, IDE port or IDE slot out of range.
5270	</result>
5271	<result name="VBOX_E_INVALID_OBJECT_STATE">
5272	Attempt to modify an unregistered virtual machine.
5273	</result>
5274	<result name="VBOX_E_INVALID_VM_STATE">
5275	Invalid machine state.
5276	</result>
5277
5278	</desc>
5279	<param name="name" type="wstring" dir="in">
5280	<desc>Name of the storage controller.</desc>
5281	</param>
5282	<param name="controllerPort" type="long" dir="in">
5283	<desc>Storage controller port.</desc>
5284	</param>
5285	<param name="device" type="long" dir="in">
5286	<desc>Device slot in the given port.</desc>
5287	</param>
5288	<param name="nonRotational" type="boolean" dir="in">
5289	<desc>New value for the non-rotational device flag.</desc>
5290	</param>
5291	</method>
5292
5293	<method name="setAutoDiscardForDevice">
5294	<desc>
5295	Sets a flag in the device information which indicates that the medium
5296	supports discarding unsused blocks (called trimming for SATA or unmap
5297	for SCSI devices) .This may or may not be supported by a particular drive,
5298	and is silently ignored in the latter case. At the moment only hard disks
5299	(which is a misnomer in this context) accept this setting. Changing the
5300	setting while the VM is running is forbidden. The device must already
5301	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
5302	device.
5303
5304	The @a controllerPort and @a device parameters specify the device slot and
5305	have have the same meaning as with <link to="IMachine::attachDevice" />.
5306
5307	<result name="E_INVALIDARG">
5308	SATA device, SATA port, SCSI port out of range.
5309	</result>
5310	<result name="VBOX_E_INVALID_OBJECT_STATE">
5311	Attempt to modify an unregistered virtual machine.
5312	</result>
5313	<result name="VBOX_E_INVALID_VM_STATE">
5314	Invalid machine state.
5315	</result>
5316
5317	</desc>
5318	<param name="name" type="wstring" dir="in">
5319	<desc>Name of the storage controller.</desc>
5320	</param>
5321	<param name="controllerPort" type="long" dir="in">
5322	<desc>Storage controller port.</desc>
5323	</param>
5324	<param name="device" type="long" dir="in">
5325	<desc>Device slot in the given port.</desc>
5326	</param>
5327	<param name="discard" type="boolean" dir="in">
5328	<desc>New value for the discard device flag.</desc>
5329	</param>
5330	</method>
5331
5332	<method name="setBandwidthGroupForDevice">
5333	<desc>
5334	Sets the bandwidth group of an existing storage device.
5335	The device must already exist; see <link to="IMachine::attachDevice"/>
5336	for how to attach a new device.
5337
5338	The @a controllerPort and @a device parameters specify the device slot and
5339	have have the same meaning as with <link to="IMachine::attachDevice" />.
5340
5341	<result name="E_INVALIDARG">
5342	SATA device, SATA port, IDE port or IDE slot out of range.
5343	</result>
5344	<result name="VBOX_E_INVALID_OBJECT_STATE">
5345	Attempt to modify an unregistered virtual machine.
5346	</result>
5347	<result name="VBOX_E_INVALID_VM_STATE">
5348	Invalid machine state.
5349	</result>
5350
5351	</desc>
5352	<param name="name" type="wstring" dir="in">
5353	<desc>Name of the storage controller.</desc>
5354	</param>
5355	<param name="controllerPort" type="long" dir="in">
5356	<desc>Storage controller port.</desc>
5357	</param>
5358	<param name="device" type="long" dir="in">
5359	<desc>Device slot in the given port.</desc>
5360	</param>
5361	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
5362	<desc>New value for the bandwidth group or @c null for no group.</desc>
5363	</param>
5364	</method>
5365
5366	<method name="setNoBandwidthGroupForDevice">
5367	<desc>
5368	Sets no bandwidth group for an existing storage device.
5369	The device must already exist; see <link to="IMachine::attachDevice"/>
5370	for how to attach a new device.
5371	The @a controllerPort and @a device parameters specify the device slot and
5372	have have the same meaning as with <link to="IMachine::attachDevice" />.
5373	<result name="E_INVALIDARG">
5374	SATA device, SATA port, IDE port or IDE slot out of range.
5375	</result>
5376	<result name="VBOX_E_INVALID_OBJECT_STATE">
5377	Attempt to modify an unregistered virtual machine.
5378	</result>
5379	<result name="VBOX_E_INVALID_VM_STATE">
5380	Invalid machine state.
5381	</result>
5382
5383	</desc>
5384	<param name="name" type="wstring" dir="in">
5385	<desc>Name of the storage controller.</desc>
5386	</param>
5387	<param name="controllerPort" type="long" dir="in">
5388	<desc>Storage controller port.</desc>
5389	</param>
5390	<param name="device" type="long" dir="in">
5391	<desc>Device slot in the given port.</desc>
5392	</param>
5393	</method>
5394
5395
5396	<method name="unmountMedium">
5397	<desc>
5398	Unmounts any currently mounted medium (<link to="IMedium" />,
5399	identified by the given UUID @a id) to the given storage controller
5400	(<link to="IStorageController" />, identified by @a name),
5401	at the indicated port and device. The device must already exist;
5402
5403	This method is intended only for managing removable media, where the
5404	device is fixed but media is changeable at runtime (such as DVDs
5405	and floppies). It cannot be used for fixed media such as hard disks.
5406
5407	The @a controllerPort and @a device parameters specify the device slot
5408	and have have the same meaning as with
5409	<link to="IMachine::attachDevice" />.
5410
5411	The specified device slot must have a medium mounted, which will be
5412	unmounted. If there is no mounted medium it will do nothing.
5413	See <link to="IMedium"/> for more detailed information about
5414	attaching/unmounting media.
5415
5416	<result name="E_INVALIDARG">
5417	SATA device, SATA port, IDE port or IDE slot out of range.
5418	</result>
5419	<result name="VBOX_E_INVALID_OBJECT_STATE">
5420	Attempt to unmount medium that is not removeable - not dvd or floppy.
5421	</result>
5422	<result name="VBOX_E_INVALID_VM_STATE">
5423	Invalid machine state.
5424	</result>
5425	<result name="VBOX_E_OBJECT_IN_USE">
5426	Medium already attached to this or another virtual machine.
5427	</result>
5428	<result name="VBOX_E_OBJECT_NOT_FOUND">
5429	Medium not attached to specified port, device, controller.
5430	</result>
5431
5432	</desc>
5433	<param name="name" type="wstring" dir="in">
5434	<desc>Name of the storage controller to unmount the medium from.</desc>
5435	</param>
5436	<param name="controllerPort" type="long" dir="in">
5437	<desc>Port to unmount the medium from.</desc>
5438	</param>
5439	<param name="device" type="long" dir="in">
5440	<desc>Device slot in the given port to unmount the medium from.</desc>
5441	</param>
5442	<param name="force" type="boolean" dir="in">
5443	<desc>Allows to force unmount of a medium which is locked by
5444	the device slot in the given port medium is attached to.</desc>
5445	</param>
5446	</method>
5447
5448	<method name="mountMedium">
5449	<desc>
5450	Mounts a medium (<link to="IMedium" />, identified
5451	by the given UUID @a id) to the given storage controller
5452	(<link to="IStorageController" />, identified by @a name),
5453	at the indicated port and device. The device must already exist;
5454	see <link to="IMachine::attachDevice"/> for how to attach a new device.
5455
5456	This method is intended only for managing removable media, where the
5457	device is fixed but media is changeable at runtime (such as DVDs
5458	and floppies). It cannot be used for fixed media such as hard disks.
5459
5460	The @a controllerPort and @a device parameters specify the device slot and
5461	have have the same meaning as with <link to="IMachine::attachDevice" />.
5462
5463	The specified device slot can have a medium mounted, which will be
5464	unmounted first. Specifying a zero UUID (or an empty string) for
5465	@a medium does just an unmount.
5466
5467	See <link to="IMedium"/> for more detailed information about
5468	attaching media.
5469
5470	<result name="E_INVALIDARG">
5471	SATA device, SATA port, IDE port or IDE slot out of range.
5472	</result>
5473	<result name="VBOX_E_INVALID_OBJECT_STATE">
5474	Attempt to attach medium to an unregistered virtual machine.
5475	</result>
5476	<result name="VBOX_E_INVALID_VM_STATE">
5477	Invalid machine state.
5478	</result>
5479	<result name="VBOX_E_OBJECT_IN_USE">
5480	Medium already attached to this or another virtual machine.
5481	</result>
5482
5483	</desc>
5484	<param name="name" type="wstring" dir="in">
5485	<desc>Name of the storage controller to attach the medium to.</desc>
5486	</param>
5487	<param name="controllerPort" type="long" dir="in">
5488	<desc>Port to attach the medium to.</desc>
5489	</param>
5490	<param name="device" type="long" dir="in">
5491	<desc>Device slot in the given port to attach the medium to.</desc>
5492	</param>
5493	<param name="medium" type="IMedium" dir="in">
5494	<desc>Medium to mount or @c null for an empty drive.</desc>
5495	</param>
5496	<param name="force" type="boolean" dir="in">
5497	<desc>Allows to force unmount/mount of a medium which is locked by
5498	the device slot in the given port to attach the medium to.</desc>
5499	</param>
5500	</method>
5501
5502	<method name="getMedium" const="yes">
5503	<desc>
5504	Returns the virtual medium attached to a device slot of the specified
5505	bus.
5506
5507	Note that if the medium was indirectly attached by
5508	<link to="#mountMedium"/> to the given device slot then this
5509	method will return not the same object as passed to the
5510	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5511	more detailed information about mounting a medium.
5512
5513	<result name="VBOX_E_OBJECT_NOT_FOUND">
5514	No medium attached to given slot/bus.
5515	</result>
5516
5517	</desc>
5518	<param name="name" type="wstring" dir="in">
5519	<desc>Name of the storage controller the medium is attached to.</desc>
5520	</param>
5521	<param name="controllerPort" type="long" dir="in">
5522	<desc>Port to query.</desc>
5523	</param>
5524	<param name="device" type="long" dir="in">
5525	<desc>Device slot in the given port to query.</desc>
5526	</param>
5527	<param name="medium" type="IMedium" dir="return">
5528	<desc>Attached medium object.</desc>
5529	</param>
5530	</method>
5531
5532	<method name="getMediumAttachmentsOfController" const="yes">
5533	<desc>
5534	Returns an array of medium attachments which are attached to the
5535	the controller with the given name.
5536
5537	<result name="VBOX_E_OBJECT_NOT_FOUND">
5538	A storage controller with given name doesn't exist.
5539	</result>
5540	</desc>
5541	<param name="name" type="wstring" dir="in"/>
5542	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5543	</method>
5544
5545	<method name="getMediumAttachment" const="yes">
5546	<desc>
5547	Returns a medium attachment which corresponds to the controller with
5548	the given name, on the given port and device slot.
5549
5550	<result name="VBOX_E_OBJECT_NOT_FOUND">
5551	No attachment exists for the given controller/port/device combination.
5552	</result>
5553	</desc>
5554	<param name="name" type="wstring" dir="in"/>
5555	<param name="controllerPort" type="long" dir="in"/>
5556	<param name="device" type="long" dir="in"/>
5557	<param name="attachment" type="IMediumAttachment" dir="return"/>
5558	</method>
5559
5560	<method name="attachHostPCIDevice">
5561	<desc>
5562	Attaches host PCI device with the given (host) PCI address to the
5563	PCI bus of the virtual machine. Please note, that this operation
5564	is two phase, as real attachment will happen when VM will start,
5565	and most information will be delivered as IHostPCIDevicePlugEvent
5566	on IVirtualBox event source.
5567
5568	<see><link to="IHostPCIDevicePlugEvent"/></see>
5569
5570	<result name="VBOX_E_INVALID_VM_STATE">
5571	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5572	</result>
5573	<result name="VBOX_E_PDM_ERROR">
5574	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5575	</result>
5576	<result name="VBOX_E_NOT_SUPPORTED">
5577	Hardware or host OS doesn't allow PCI device passthrought.
5578	</result>
5579	</desc>
5580	<param name="hostAddress" type="long" dir="in">
5581	<desc>Address of the host PCI device.</desc>
5582	</param>
5583	<param name="desiredGuestAddress" type="long" dir="in">
5584	<desc>Desired position of this device on guest PCI bus.</desc>
5585	</param>
5586	<param name="tryToUnbind" type="boolean" dir="in">
5587	<desc>If VMM shall try to unbind existing drivers from the
5588	device before attaching it to the guest.</desc>
5589	</param>
5590	</method>
5591
5592	<method name="detachHostPCIDevice">
5593	<desc>
5594	Detach host PCI device from the virtual machine.
5595	Also HostPCIDevicePlugEvent on IVirtualBox event source
5596	will be delivered. As currently we don't support hot device
5597	unplug, IHostPCIDevicePlugEvent event is delivered immediately.
5598
5599	<see><link to="IHostPCIDevicePlugEvent"/></see>
5600
5601	<result name="VBOX_E_INVALID_VM_STATE">
5602	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5603	</result>
5604	<result name="VBOX_E_OBJECT_NOT_FOUND">
5605	This host device is not attached to this machine.
5606	</result>
5607	<result name="VBOX_E_PDM_ERROR">
5608	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5609	</result>
5610	<result name="VBOX_E_NOT_SUPPORTED">
5611	Hardware or host OS doesn't allow PCI device passthrought.
5612	</result>
5613	</desc>
5614	<param name="hostAddress" type="long" dir="in">
5615	<desc>Address of the host PCI device.</desc>
5616	</param>
5617	</method>
5618
5619	<method name="getNetworkAdapter" const="yes">
5620	<desc>
5621	Returns the network adapter associated with the given slot.
5622	Slots are numbered sequentially, starting with zero. The total
5623	number of adapters per machine is defined by the
5624	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5625	so the maximum slot number is one less than that property's value.
5626
5627	<result name="E_INVALIDARG">
5628	Invalid @a slot number.
5629	</result>
5630
5631	</desc>
5632	<param name="slot" type="unsigned long" dir="in"/>
5633	<param name="adapter" type="INetworkAdapter" dir="return"/>
5634	</method>
5635
5636	<method name="addStorageController">
5637	<desc>
5638	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5639	machine and returns it as an instance of
5640	<link to="IStorageController" />.
5641
5642	@a name identifies the controller for subsequent calls such as
5643	<link to="#getStorageControllerByName" />,
5644	<link to="#getStorageControllerByInstance" />,
5645	<link to="#removeStorageController" />,
5646	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5647
5648	After the controller has been added, you can set its exact
5649	type by setting the <link to="IStorageController::controllerType" />.
5650
5651	<result name="VBOX_E_OBJECT_IN_USE">
5652	A storage controller with given name exists already.
5653	</result>
5654	<result name="E_INVALIDARG">
5655	Invalid @a controllerType.
5656	</result>
5657	</desc>
5658	<param name="name" type="wstring" dir="in"/>
5659	<param name="connectionType" type="StorageBus" dir="in"/>
5660	<param name="controller" type="IStorageController" dir="return"/>
5661	</method>
5662
5663	<method name="getStorageControllerByName" const="yes">
5664	<desc>
5665	Returns a storage controller with the given name.
5666
5667	<result name="VBOX_E_OBJECT_NOT_FOUND">
5668	A storage controller with given name doesn't exist.
5669	</result>
5670	</desc>
5671	<param name="name" type="wstring" dir="in"/>
5672	<param name="storageController" type="IStorageController" dir="return"/>
5673	</method>
5674
5675	<method name="getStorageControllerByInstance" const="yes">
5676	<desc>
5677	Returns a storage controller with the given instance number.
5678
5679	<result name="VBOX_E_OBJECT_NOT_FOUND">
5680	A storage controller with given instance number doesn't exist.
5681	</result>
5682	</desc>
5683	<param name="instance" type="unsigned long" dir="in"/>
5684	<param name="storageController" type="IStorageController" dir="return"/>
5685	</method>
5686
5687	<method name="removeStorageController">
5688	<desc>
5689	Removes a storage controller from the machine with all devices attached to it.
5690
5691	<result name="VBOX_E_OBJECT_NOT_FOUND">
5692	A storage controller with given name doesn't exist.
5693	</result>
5694	<result name="VBOX_E_NOT_SUPPORTED">
5695	Medium format does not support storage deletion (only for implicitly
5696	created differencing media, should not happen).
5697	</result>
5698	</desc>
5699	<param name="name" type="wstring" dir="in"/>
5700	</method>
5701
5702	<method name="setStorageControllerBootable">
5703	<desc>
5704	Sets the bootable flag of the storage controller with the given name.
5705
5706	<result name="VBOX_E_OBJECT_NOT_FOUND">
5707	A storage controller with given name doesn't exist.
5708	</result>
5709	<result name="VBOX_E_OBJECT_IN_USE">
5710	Another storage controller is marked as bootable already.
5711	</result>
5712	</desc>
5713	<param name="name" type="wstring" dir="in"/>
5714	<param name="bootable" type="boolean" dir="in"/>
5715	</method>
5716
5717	<method name="getSerialPort" const="yes">
5718	<desc>
5719	Returns the serial port associated with the given slot.
5720	Slots are numbered sequentially, starting with zero. The total
5721	number of serial ports per machine is defined by the
5722	<link to="ISystemProperties::serialPortCount"/> property,
5723	so the maximum slot number is one less than that property's value.
5724
5725	<result name="E_INVALIDARG">
5726	Invalid @a slot number.
5727	</result>
5728
5729	</desc>
5730	<param name="slot" type="unsigned long" dir="in"/>
5731	<param name="port" type="ISerialPort" dir="return"/>
5732	</method>
5733
5734	<method name="getParallelPort" const="yes">
5735	<desc>
5736	Returns the parallel port associated with the given slot.
5737	Slots are numbered sequentially, starting with zero. The total
5738	number of parallel ports per machine is defined by the
5739	<link to="ISystemProperties::parallelPortCount"/> property,
5740	so the maximum slot number is one less than that property's value.
5741
5742	<result name="E_INVALIDARG">
5743	Invalid @a slot number.
5744	</result>
5745
5746	</desc>
5747	<param name="slot" type="unsigned long" dir="in"/>
5748	<param name="port" type="IParallelPort" dir="return"/>
5749	</method>
5750
5751	<method name="getExtraDataKeys">
5752	<desc>
5753	Returns an array representing the machine-specific extra data keys
5754	which currently have values defined.
5755	</desc>
5756	<param name="keys" type="wstring" dir="return" safearray="yes">
5757	<desc>Array of extra data keys.</desc>
5758	</param>
5759	</method>
5760
5761	<method name="getExtraData">
5762	<desc>
5763	Returns associated machine-specific extra data.
5764
5765	If the requested data @a key does not exist, this function will
5766	succeed and return an empty string in the @a value argument.
5767
5768	<result name="VBOX_E_FILE_ERROR">
5769	Settings file not accessible.
5770	</result>
5771	<result name="VBOX_E_XML_ERROR">
5772	Could not parse the settings file.
5773	</result>
5774
5775	</desc>
5776	<param name="key" type="wstring" dir="in">
5777	<desc>Name of the data key to get.</desc>
5778	</param>
5779	<param name="value" type="wstring" dir="return">
5780	<desc>Value of the requested data key.</desc>
5781	</param>
5782	</method>
5783
5784	<method name="setExtraData">
5785	<desc>
5786	Sets associated machine-specific extra data.
5787
5788	If you pass @c null or an empty string as a key @a value, the given
5789	@a key will be deleted.
5790
5791	<note>
5792	Before performing the actual data change, this method will ask all
5793	registered listeners using the
5794	<link to="IExtraDataCanChangeEvent"/>
5795	notification for a permission. If one of the listeners refuses the
5796	new value, the change will not be performed.
5797	</note>
5798	<note>
5799	On success, the
5800	<link to="IExtraDataChangedEvent"/> notification
5801	is called to inform all registered listeners about a successful data
5802	change.
5803	</note>
5804	<note>
5805	This method can be called outside the machine session and therefore
5806	it's a caller's responsibility to handle possible race conditions
5807	when several clients change the same key at the same time.
5808	</note>
5809
5810	<result name="VBOX_E_FILE_ERROR">
5811	Settings file not accessible.
5812	</result>
5813	<result name="VBOX_E_XML_ERROR">
5814	Could not parse the settings file.
5815	</result>
5816
5817	</desc>
5818	<param name="key" type="wstring" dir="in">
5819	<desc>Name of the data key to set.</desc>
5820	</param>
5821	<param name="value" type="wstring" dir="in">
5822	<desc>Value to assign to the key.</desc>
5823	</param>
5824	</method>
5825
5826	<method name="getCPUProperty" const="yes">
5827	<desc>
5828	Returns the virtual CPU boolean value of the specified property.
5829
5830	<result name="E_INVALIDARG">
5831	Invalid property.
5832	</result>
5833
5834	</desc>
5835	<param name="property" type="CPUPropertyType" dir="in">
5836	<desc>
5837	Property type to query.
5838	</desc>
5839	</param>
5840	<param name="value" type="boolean" dir="return">
5841	<desc>
5842	Property value.
5843	</desc>
5844	</param>
5845	</method>
5846
5847	<method name="setCPUProperty">
5848	<desc>
5849	Sets the virtual CPU boolean value of the specified property.
5850
5851	<result name="E_INVALIDARG">
5852	Invalid property.
5853	</result>
5854
5855	</desc>
5856	<param name="property" type="CPUPropertyType" dir="in">
5857	<desc>
5858	Property type to query.
5859	</desc>
5860	</param>
5861	<param name="value" type="boolean" dir="in">
5862	<desc>
5863	Property value.
5864	</desc>
5865	</param>
5866	</method>
5867
5868	<method name="getCPUIDLeaf" const="yes">
5869	<desc>
5870	Returns the virtual CPU cpuid information for the specified leaf.
5871
5872	Currently supported index values for cpuid:
5873	Standard CPUID leafs: 0 - 0xA
5874	Extended CPUID leafs: 0x80000000 - 0x8000000A
5875
5876	See the Intel and AMD programmer's manuals for detailed information
5877	about the cpuid instruction and its leafs.
5878	<result name="E_INVALIDARG">
5879	Invalid id.
5880	</result>
5881
5882	</desc>
5883	<param name="id" type="unsigned long" dir="in">
5884	<desc>
5885	CPUID leaf index.
5886	</desc>
5887	</param>
5888	<param name="valEax" type="unsigned long" dir="out">
5889	<desc>
5890	CPUID leaf value for register eax.
5891	</desc>
5892	</param>
5893	<param name="valEbx" type="unsigned long" dir="out">
5894	<desc>
5895	CPUID leaf value for register ebx.
5896	</desc>
5897	</param>
5898	<param name="valEcx" type="unsigned long" dir="out">
5899	<desc>
5900	CPUID leaf value for register ecx.
5901	</desc>
5902	</param>
5903	<param name="valEdx" type="unsigned long" dir="out">
5904	<desc>
5905	CPUID leaf value for register edx.
5906	</desc>
5907	</param>
5908	</method>
5909
5910	<method name="setCPUIDLeaf">
5911	<desc>
5912	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5913	are not passed unmodified. VirtualBox clears features that it doesn't support.
5914
5915	Currently supported index values for cpuid:
5916	Standard CPUID leafs: 0 - 0xA
5917	Extended CPUID leafs: 0x80000000 - 0x8000000A
5918
5919	See the Intel and AMD programmer's manuals for detailed information
5920	about the cpuid instruction and its leafs.
5921
5922	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5923	random crashes inside VMs.
5924	<result name="E_INVALIDARG">
5925	Invalid id.
5926	</result>
5927
5928	</desc>
5929	<param name="id" type="unsigned long" dir="in">
5930	<desc>
5931	CPUID leaf index.
5932	</desc>
5933	</param>
5934	<param name="valEax" type="unsigned long" dir="in">
5935	<desc>
5936	CPUID leaf value for register eax.
5937	</desc>
5938	</param>
5939	<param name="valEbx" type="unsigned long" dir="in">
5940	<desc>
5941	CPUID leaf value for register ebx.
5942	</desc>
5943	</param>
5944	<param name="valEcx" type="unsigned long" dir="in">
5945	<desc>
5946	CPUID leaf value for register ecx.
5947	</desc>
5948	</param>
5949	<param name="valEdx" type="unsigned long" dir="in">
5950	<desc>
5951	CPUID leaf value for register edx.
5952	</desc>
5953	</param>
5954	</method>
5955
5956	<method name="removeCPUIDLeaf">
5957	<desc>
5958	Removes the virtual CPU cpuid leaf for the specified index
5959
5960	<result name="E_INVALIDARG">
5961	Invalid id.
5962	</result>
5963
5964	</desc>
5965	<param name="id" type="unsigned long" dir="in">
5966	<desc>
5967	CPUID leaf index.
5968	</desc>
5969	</param>
5970	</method>
5971
5972	<method name="removeAllCPUIDLeaves">
5973	<desc>
5974	Removes all the virtual CPU cpuid leaves
5975	</desc>
5976	</method>
5977
5978	<method name="getHWVirtExProperty" const="yes">
5979	<desc>
5980	Returns the value of the specified hardware virtualization boolean property.
5981
5982	<result name="E_INVALIDARG">
5983	Invalid property.
5984	</result>
5985
5986	</desc>
5987	<param name="property" type="HWVirtExPropertyType" dir="in">
5988	<desc>
5989	Property type to query.
5990	</desc>
5991	</param>
5992	<param name="value" type="boolean" dir="return">
5993	<desc>
5994	Property value.
5995	</desc>
5996	</param>
5997	</method>
5998
5999	<method name="setHWVirtExProperty">
6000	<desc>
6001	Sets a new value for the specified hardware virtualization boolean property.
6002
6003	<result name="E_INVALIDARG">
6004	Invalid property.
6005	</result>
6006
6007	</desc>
6008	<param name="property" type="HWVirtExPropertyType" dir="in">
6009	<desc>
6010	Property type to set.
6011	</desc>
6012	</param>
6013	<param name="value" type="boolean" dir="in">
6014	<desc>
6015	New property value.
6016	</desc>
6017	</param>
6018	</method>
6019
6020	<method name="saveSettings">
6021	<desc>
6022	Saves any changes to machine settings made since the session
6023	has been opened or a new machine has been created, or since the
6024	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
6025	For registered machines, new settings become visible to all
6026	other VirtualBox clients after successful invocation of this
6027	method.
6028	<note>
6029	The method sends <link to="IMachineDataChangedEvent"/>
6030	notification event after the configuration has been successfully
6031	saved (only for registered machines).
6032	</note>
6033	<note>
6034	Calling this method is only valid on instances returned
6035	by <link to="ISession::machine"/> and on new machines
6036	created by <link to="IVirtualBox::createMachine"/> but not
6037	yet registered, or on unregistered machines after calling
6038	<link to="IMachine::unregister"/>.
6039	</note>
6040
6041	<result name="VBOX_E_FILE_ERROR">
6042	Settings file not accessible.
6043	</result>
6044	<result name="VBOX_E_XML_ERROR">
6045	Could not parse the settings file.
6046	</result>
6047	<result name="E_ACCESSDENIED">
6048	Modification request refused.
6049	</result>
6050
6051	</desc>
6052	</method>
6053
6054	<method name="discardSettings">
6055	<desc>
6056	Discards any changes to the machine settings made since the session
6057	has been opened or since the last call to <link to="#saveSettings"/>
6058	or <link to="#discardSettings"/>.
6059	<note>
6060	Calling this method is only valid on instances returned
6061	by <link to="ISession::machine"/> and on new machines
6062	created by <link to="IVirtualBox::createMachine"/> or
6063	opened by <link to="IVirtualBox::openMachine"/> but not
6064	yet registered, or on unregistered machines after calling
6065	<link to="IMachine::unregister"/>.
6066	</note>
6067
6068	<result name="VBOX_E_INVALID_VM_STATE">
6069	Virtual machine is not mutable.
6070	</result>
6071
6072	</desc>
6073	</method>
6074
6075	<method name="unregister">
6076	<desc>
6077	Unregisters a machine previously registered with
6078	<link to="IVirtualBox::registerMachine"/> and optionally do additional
6079	cleanup before the machine is unregistered.
6080
6081	This method does not delete any files. It only changes the machine configuration and
6082	the list of registered machines in the VirtualBox object. To delete the files which
6083	belonged to the machine, including the XML file of the machine itself, call
6084	<link to="#deleteConfig"/>, optionally with the array of IMedium objects which was returned
6085	from this method.
6086
6087	How thoroughly this method cleans up the machine configuration before unregistering
6088	the machine depends on the @a cleanupMode argument.
6089
6090	<ul>
6091	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
6092	cleanup will be performed. The call will fail if the machine is in "Saved" state
6093	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
6094	It is the responsibility of the caller to delete all such configuration in this mode.
6095	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
6096	which it replaces.</li>
6097	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
6098	state or if it has snapshots or media attached. All media attached to the current machine
6099	state or in snapshots will be detached. No medium objects will be returned;
6100	all of the machine's media will remain open.</li>
6101	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
6102	except that all the hard disk medium objects which were detached from the machine will
6103	be returned as an array. This allows for quickly passing them to the <link to="#deleteConfig" />
6104	API for closing and deletion.</li>
6105	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
6106	that all media will be returned in the array, including removable media like DVDs and
6107	floppies. This might be useful if the user wants to inspect in detail which media were
6108	attached to the machine. Be careful when passing the media array to <link to="#deleteConfig" />
6109	in that case because users will typically want to preserve ISO and RAW image files.</li>
6110	</ul>
6111
6112	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
6113	resulting IMedium array to <link to="#deleteConfig"/>. This way, the machine is completely
6114	deleted with all its saved states and hard disk images, but images for removable
6115	drives (such as ISO and RAW files) will remain on disk.
6116
6117	This API does not verify whether the media files returned in the array are still
6118	attached to other machines (i.e. shared between several machines). If such a shared
6119	image is passed to <link to="#deleteConfig" /> however, closing the image will fail there
6120	and the image will be silently skipped.
6121
6122	This API may, however, move media from this machine's media registry to other media
6123	registries (see <link to="IMedium" /> for details on media registries). For machines
6124	created with VirtualBox 4.0 or later, if media from this machine's media registry
6125	are also attached to another machine (shared attachments), each such medium will be
6126	moved to another machine's registry. This is because without this machine's media
6127	registry, the other machine cannot find its media any more and would become inaccessible.
6128
6129	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
6130	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
6131	if media are moved to other machines' media registries.
6132
6133	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
6134	is fired.
6135
6136	The call will fail if the machine is currently locked (see <link to="ISession" />).
6137
6138	<note>
6139	If the given machine is inaccessible (see <link to="#accessible"/>), it
6140	will be unregistered and fully uninitialized right afterwards. As a result,
6141	the returned machine object will be unusable and an attempt to call
6142	<b>any</b> method will return the "Object not ready" error.
6143	</note>
6144
6145	<result name="VBOX_E_INVALID_OBJECT_STATE">
6146	Machine is currently locked for a session.
6147	</result>
6148	</desc>
6149
6150	<param name="cleanupMode" type="CleanupMode" dir="in">
6151	<desc>How to clean up after the machine has been unregistered.</desc>
6152	</param>
6153	<param name="media" type="IMedium" safearray="yes" dir="return">
6154	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
6155	</param>
6156	</method>
6157
6158	<method name="deleteConfig">
6159	<desc>
6160	Deletes the files associated with this machine from disk. If medium objects are passed
6161	in with the @a aMedia argument, they are closed and, if closing was successful, their
6162	storage files are deleted as well. For convenience, this array of media files can be
6163	the same as the one returned from a previous <link to="#unregister" /> call.
6164
6165	This method must only be called on machines which are either write-locked (i.e. on instances
6166	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
6167	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
6168	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
6169
6170	The following files will be deleted by this method:
6171	<ul>
6172	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
6173	argument other than "UnregisterOnly", this will delete all saved state files that
6174	the machine had in use; possibly one if the machine was in "Saved" state and one
6175	for each online snapshot that the machine had.</li>
6176	<li>On each medium object passed in the @a aMedia array, this will call
6177	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
6178	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
6179	in use, e.g. because it is still attached to a second machine; in that case the
6180	storage will not be deleted.</li>
6181	<li>Finally, the machine's own XML file will be deleted.</li>
6182	</ul>
6183
6184	Since deleting large disk image files can be a time-consuming I/O operation, this
6185	method operates asynchronously and returns an IProgress object to allow the caller
6186	to monitor the progress. There will be one sub-operation for each file that is
6187	being deleted (saved state or medium storage file).
6188
6189	<note>
6190	<link to="#settingsModified"/> will return @c true after this
6191	method successfully returns.
6192	</note>
6193
6194	<result name="VBOX_E_INVALID_VM_STATE">
6195	Machine is registered but not write-locked.
6196	</result>
6197	<result name="VBOX_E_IPRT_ERROR">
6198	Could not delete the settings file.
6199	</result>
6200	</desc>
6201	<param name="media" type="IMedium" safearray="yes" dir="in">
6202	<desc>List of media to be closed and whose storage files will be deleted.</desc>
6203	</param>
6204	<param name="progress" type="IProgress" dir="return">
6205	<desc>Progress object to track the operation completion.</desc>
6206	</param>
6207	</method>
6208
6209	<method name="exportTo">
6210	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
6211	steps required to export VirtualBox machines to OVF.
6212	</desc>
6213
6214	<param name="appliance" type="IAppliance" dir="in">
6215	<desc>Appliance to export this machine to.</desc>
6216	</param>
6217	<param name="location" type="wstring" dir="in">
6218	<desc>The target location.</desc>
6219	</param>
6220	<param name="description" type="IVirtualSystemDescription" dir="return">
6221	<desc>VirtualSystemDescription object which is created for this machine.</desc>
6222	</param>
6223	</method >
6224
6225	<method name="findSnapshot">
6226	<desc>
6227	Returns a snapshot of this machine with the given name or UUID.
6228
6229	Returns a snapshot of this machine with the given UUID.
6230	A @c null argument can be used to obtain the first snapshot
6231	taken on this machine. To traverse the whole tree of snapshots
6232	starting from the root, inspect the root snapshot's
6233	<link to="ISnapshot::children" /> attribute and recurse over those children.
6234
6235	<result name="VBOX_E_OBJECT_NOT_FOUND">
6236	Virtual machine has no snapshots or snapshot not found.
6237	</result>
6238
6239	</desc>
6240	<param name="nameOrId" type="wstring" dir="in">
6241	<desc>What to search for. Name or UUID of the snapshot to find</desc>
6242	</param>
6243	<param name="snapshot" type="ISnapshot" dir="return">
6244	<desc>Snapshot object with the given name.</desc>
6245	</param>
6246	</method>
6247
6248	<method name="createSharedFolder">
6249	<desc>
6250	Creates a new permanent shared folder by associating the given logical
6251	name with the given host path, adds it to the collection of shared
6252	folders and starts sharing it. Refer to the description of
6253	<link to="ISharedFolder"/> to read more about logical names.
6254
6255	<result name="VBOX_E_OBJECT_IN_USE">
6256	Shared folder already exists.
6257	</result>
6258	<result name="VBOX_E_FILE_ERROR">
6259	Shared folder @a hostPath not accessible.
6260	</result>
6261
6262	</desc>
6263	<param name="name" type="wstring" dir="in">
6264	<desc>Unique logical name of the shared folder.</desc>
6265	</param>
6266	<param name="hostPath" type="wstring" dir="in">
6267	<desc>Full path to the shared folder in the host file system.</desc>
6268	</param>
6269	<param name="writable" type="boolean" dir="in">
6270	<desc>Whether the share is writable or readonly.</desc>
6271	</param>
6272	<param name="automount" type="boolean" dir="in">
6273	<desc>Whether the share gets automatically mounted by the guest
6274	or not.</desc>
6275	</param>
6276	</method>
6277
6278	<method name="removeSharedFolder">
6279	<desc>
6280	Removes the permanent shared folder with the given name previously
6281	created by <link to="#createSharedFolder"/> from the collection of
6282	shared folders and stops sharing it.
6283
6284	<result name="VBOX_E_INVALID_VM_STATE">
6285	Virtual machine is not mutable.
6286	</result>
6287	<result name="VBOX_E_OBJECT_NOT_FOUND">
6288	Shared folder @a name does not exist.
6289	</result>
6290
6291	</desc>
6292	<param name="name" type="wstring" dir="in">
6293	<desc>Logical name of the shared folder to remove.</desc>
6294	</param>
6295	</method>
6296
6297	<method name="canShowConsoleWindow">
6298	<desc>
6299	Returns @c true if the VM console process can activate the
6300	console window and bring it to foreground on the desktop of
6301	the host PC.
6302	<note>
6303	This method will fail if a session for this machine is not
6304	currently open.
6305	</note>
6306
6307	<result name="VBOX_E_INVALID_VM_STATE">
6308	Machine session is not open.
6309	</result>
6310
6311	</desc>
6312	<param name="canShow" type="boolean" dir="return">
6313	<desc>
6314	@c true if the console window can be shown and @c false otherwise.
6315	</desc>
6316	</param>
6317	</method>
6318
6319	<method name="showConsoleWindow">
6320	<desc>
6321	Activates the console window and brings it to foreground on
6322	the desktop of the host PC. Many modern window managers on
6323	many platforms implement some sort of focus stealing
6324	prevention logic, so that it may be impossible to activate
6325	a window without the help of the currently active
6326	application. In this case, this method will return a non-zero
6327	identifier that represents the top-level window of the VM
6328	console process. The caller, if it represents a currently
6329	active process, is responsible to use this identifier (in a
6330	platform-dependent manner) to perform actual window
6331	activation.
6332	<note>
6333	This method will fail if a session for this machine is not
6334	currently open.
6335	</note>
6336
6337	<result name="VBOX_E_INVALID_VM_STATE">
6338	Machine session is not open.
6339	</result>
6340
6341	</desc>
6342	<param name="winId" type="long long" dir="return">
6343	<desc>
6344	Platform-dependent identifier of the top-level VM console
6345	window, or zero if this method has performed all actions
6346	necessary to implement the <i>show window</i> semantics for
6347	the given platform and/or VirtualBox front-end.
6348	</desc>
6349	</param>
6350	</method>
6351
6352	<method name="getGuestProperty" const="yes">
6353	<desc>
6354	Reads an entry from the machine's guest property store.
6355
6356	<result name="VBOX_E_INVALID_VM_STATE">
6357	Machine session is not open.
6358	</result>
6359
6360	</desc>
6361	<param name="name" type="wstring" dir="in">
6362	<desc>
6363	The name of the property to read.
6364	</desc>
6365	</param>
6366	<param name="value" type="wstring" dir="out">
6367	<desc>
6368	The value of the property. If the property does not exist then this
6369	will be empty.
6370	</desc>
6371	</param>
6372	<param name="timestamp" type="long long" dir="out">
6373	<desc>
6374	The time at which the property was last modified, as seen by the
6375	server process.
6376	</desc>
6377	</param>
6378	<param name="flags" type="wstring" dir="out">
6379	<desc>
6380	Additional property parameters, passed as a comma-separated list of
6381	"name=value" type entries.
6382	</desc>
6383	</param>
6384	</method>
6385
6386	<method name="getGuestPropertyValue" const="yes">
6387	<desc>
6388	Reads a value from the machine's guest property store.
6389
6390	<result name="VBOX_E_INVALID_VM_STATE">
6391	Machine session is not open.
6392	</result>
6393
6394	</desc>
6395	<param name="property" type="wstring" dir="in">
6396	<desc>
6397	The name of the property to read.
6398	</desc>
6399	</param>
6400	<param name="value" type="wstring" dir="return">
6401	<desc>
6402	The value of the property. If the property does not exist then this
6403	will be empty.
6404	</desc>
6405	</param>
6406	</method>
6407
6408	<method name="getGuestPropertyTimestamp" const="yes">
6409	<desc>
6410	Reads a property timestamp from the machine's guest property store.
6411
6412	<result name="VBOX_E_INVALID_VM_STATE">
6413	Machine session is not open.
6414	</result>
6415
6416	</desc>
6417	<param name="property" type="wstring" dir="in">
6418	<desc>
6419	The name of the property to read.
6420	</desc>
6421	</param>
6422	<param name="value" type="long long" dir="return">
6423	<desc>
6424	The timestamp. If the property does not exist then this will be
6425	empty.
6426	</desc>
6427	</param>
6428	</method>
6429
6430	<method name="setGuestProperty">
6431	<desc>
6432	Sets, changes or deletes an entry in the machine's guest property
6433	store.
6434
6435	<result name="E_ACCESSDENIED">
6436	Property cannot be changed.
6437	</result>
6438	<result name="E_INVALIDARG">
6439	Invalid @a flags.
6440	</result>
6441	<result name="VBOX_E_INVALID_VM_STATE">
6442	Virtual machine is not mutable or session not open.
6443	</result>
6444	<result name="VBOX_E_INVALID_OBJECT_STATE">
6445	Cannot set transient property when machine not running.
6446	</result>
6447
6448	</desc>
6449	<param name="property" type="wstring" dir="in">
6450	<desc>
6451	The name of the property to set, change or delete.
6452	</desc>
6453	</param>
6454	<param name="value" type="wstring" dir="in">
6455	<desc>
6456	The new value of the property to set, change or delete. If the
6457	property does not yet exist and value is non-empty, it will be
6458	created. If the value is @c null or empty, the property will be
6459	deleted if it exists.
6460	</desc>
6461	</param>
6462	<param name="flags" type="wstring" dir="in">
6463	<desc>
6464	Additional property parameters, passed as a comma-separated list of
6465	"name=value" type entries.
6466	</desc>
6467	</param>
6468	</method>
6469
6470	<method name="setGuestPropertyValue">
6471	<desc>
6472	Sets or changes a value in the machine's guest property
6473	store. The flags field will be left unchanged or created empty for a
6474	new property.
6475
6476	<result name="E_ACCESSDENIED">
6477	Property cannot be changed.
6478	</result>
6479	<result name="VBOX_E_INVALID_VM_STATE">
6480	Virtual machine is not mutable or session not open.
6481	</result>
6482	<result name="VBOX_E_INVALID_OBJECT_STATE">
6483	Cannot set transient property when machine not running.
6484	</result>
6485	</desc>
6486
6487	<param name="property" type="wstring" dir="in">
6488	<desc>
6489	The name of the property to set or change.
6490	</desc>
6491	</param>
6492	<param name="value" type="wstring" dir="in">
6493	<desc>
6494	The new value of the property to set or change. If the
6495	property does not yet exist and value is non-empty, it will be
6496	created.
6497	</desc>
6498	</param>
6499	</method>
6500
6501	<method name="deleteGuestProperty" const="yes">
6502	<desc>
6503	Deletes an entry from the machine's guest property store.
6504
6505	<result name="VBOX_E_INVALID_VM_STATE">
6506	Machine session is not open.
6507	</result>
6508
6509	</desc>
6510	<param name="name" type="wstring" dir="in">
6511	<desc>
6512	The name of the property to delete.
6513	</desc>
6514	</param>
6515	</method>
6516
6517	<method name="enumerateGuestProperties" const="yes">
6518	<desc>
6519	Return a list of the guest properties matching a set of patterns along
6520	with their values, time stamps and flags.
6521	</desc>
6522	<param name="patterns" type="wstring" dir="in">
6523	<desc>
6524	The patterns to match the properties against, separated by '\|'
6525	characters. If this is empty or @c null, all properties will match.
6526	</desc>
6527	</param>
6528	<param name="names" type="wstring" dir="out" safearray="yes">
6529	<desc>
6530	The names of the properties returned.
6531	</desc>
6532	</param>
6533	<param name="values" type="wstring" dir="out" safearray="yes">
6534	<desc>
6535	The values of the properties returned. The array entries match the
6536	corresponding entries in the @a name array.
6537	</desc>
6538	</param>
6539	<param name="timestamps" type="long long" dir="out" safearray="yes">
6540	<desc>
6541	The time stamps of the properties returned. The array entries match
6542	the corresponding entries in the @a name array.
6543	</desc>
6544	</param>
6545	<param name="flags" type="wstring" dir="out" safearray="yes">
6546	<desc>
6547	The flags of the properties returned. The array entries match the
6548	corresponding entries in the @a name array.
6549	</desc>
6550	</param>
6551	</method>
6552
6553	<method name="querySavedGuestScreenInfo" const="yes">
6554	<desc>
6555	Returns the guest dimensions from the saved state.
6556	</desc>
6557	<param name="screenId" type="unsigned long" dir="in">
6558	<desc>
6559	Saved guest screen to query info from.
6560	</desc>
6561	</param>
6562	<param name="originX" type="unsigned long" dir="out">
6563	<desc>
6564	The X position of the guest monitor top left corner.
6565	</desc>
6566	</param>
6567	<param name="originY" type="unsigned long" dir="out">
6568	<desc>
6569	The Y position of the guest monitor top left corner.
6570	</desc>
6571	</param>
6572	<param name="width" type="unsigned long" dir="out">
6573	<desc>
6574	Guest width at the time of the saved state was taken.
6575	</desc>
6576	</param>
6577	<param name="height" type="unsigned long" dir="out">
6578	<desc>
6579	Guest height at the time of the saved state was taken.
6580	</desc>
6581	</param>
6582	<param name="enabled" type="boolean" dir="out">
6583	<desc>
6584	Whether the monitor is enabled in the guest.
6585	</desc>
6586	</param>
6587	</method>
6588
6589	<method name="querySavedThumbnailSize">
6590	<desc>
6591	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6592	</desc>
6593	<param name="screenId" type="unsigned long" dir="in">
6594	<desc>
6595	Saved guest screen to query info from.
6596	</desc>
6597	</param>
6598	<param name="size" type="unsigned long" dir="out">
6599	<desc>
6600	Size of buffer required to store the bitmap.
6601	</desc>
6602	</param>
6603	<param name="width" type="unsigned long" dir="out">
6604	<desc>
6605	Bitmap width.
6606	</desc>
6607	</param>
6608	<param name="height" type="unsigned long" dir="out">
6609	<desc>
6610	Bitmap height.
6611	</desc>
6612	</param>
6613	</method>
6614
6615	<method name="readSavedThumbnailToArray">
6616	<desc>
6617	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6618	</desc>
6619	<param name="screenId" type="unsigned long" dir="in">
6620	<desc>
6621	Saved guest screen to read from.
6622	</desc>
6623	</param>
6624	<param name="BGR" type="boolean" dir="in">
6625	<desc>
6626	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6627	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6628	</desc>
6629	</param>
6630	<param name="width" type="unsigned long" dir="out">
6631	<desc>
6632	Bitmap width.
6633	</desc>
6634	</param>
6635	<param name="height" type="unsigned long" dir="out">
6636	<desc>
6637	Bitmap height.
6638	</desc>
6639	</param>
6640	<param name="data" type="octet" safearray="yes" dir="return">
6641	<desc>
6642	Array with resulting bitmap data.
6643	</desc>
6644	</param>
6645	</method>
6646
6647	<method name="readSavedThumbnailPNGToArray">
6648	<desc>
6649	Thumbnail in PNG format is retrieved to an array of bytes.
6650	</desc>
6651	<param name="screenId" type="unsigned long" dir="in">
6652	<desc>
6653	Saved guest screen to read from.
6654	</desc>
6655	</param>
6656	<param name="width" type="unsigned long" dir="out">
6657	<desc>
6658	Image width.
6659	</desc>
6660	</param>
6661	<param name="height" type="unsigned long" dir="out">
6662	<desc>
6663	Image height.
6664	</desc>
6665	</param>
6666	<param name="data" type="octet" dir="return" safearray="yes">
6667	<desc>
6668	Array with resulting PNG data.
6669	</desc>
6670	</param>
6671	</method>
6672
6673	<method name="querySavedScreenshotPNGSize">
6674	<desc>
6675	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6676	</desc>
6677	<param name="screenId" type="unsigned long" dir="in">
6678	<desc>
6679	Saved guest screen to query info from.
6680	</desc>
6681	</param>
6682	<param name="size" type="unsigned long" dir="out">
6683	<desc>
6684	Size of buffer required to store the PNG binary data.
6685	</desc>
6686	</param>
6687	<param name="width" type="unsigned long" dir="out">
6688	<desc>
6689	Image width.
6690	</desc>
6691	</param>
6692	<param name="height" type="unsigned long" dir="out">
6693	<desc>
6694	Image height.
6695	</desc>
6696	</param>
6697	</method>
6698
6699	<method name="readSavedScreenshotPNGToArray">
6700	<desc>
6701	Screenshot in PNG format is retrieved to an array of bytes.
6702	</desc>
6703	<param name="screenId" type="unsigned long" dir="in">
6704	<desc>
6705	Saved guest screen to read from.
6706	</desc>
6707	</param>
6708	<param name="width" type="unsigned long" dir="out">
6709	<desc>
6710	Image width.
6711	</desc>
6712	</param>
6713	<param name="height" type="unsigned long" dir="out">
6714	<desc>
6715	Image height.
6716	</desc>
6717	</param>
6718	<param name="data" type="octet" dir="return" safearray="yes">
6719	<desc>
6720	Array with resulting PNG data.
6721	</desc>
6722	</param>
6723	</method>
6724
6725	<method name="hotPlugCPU">
6726	<desc>
6727	Plugs a CPU into the machine.
6728	</desc>
6729	<param name="cpu" type="unsigned long" dir="in">
6730	<desc>
6731	The CPU id to insert.
6732	</desc>
6733	</param>
6734	</method>
6735
6736	<method name="hotUnplugCPU">
6737	<desc>
6738	Removes a CPU from the machine.
6739	</desc>
6740	<param name="cpu" type="unsigned long" dir="in">
6741	<desc>
6742	The CPU id to remove.
6743	</desc>
6744	</param>
6745	</method>
6746
6747	<method name="getCPUStatus">
6748	<desc>
6749	Returns the current status of the given CPU.
6750	</desc>
6751	<param name="cpu" type="unsigned long" dir="in">
6752	<desc>
6753	The CPU id to check for.
6754	</desc>
6755	</param>
6756	<param name="attached" type="boolean" dir="return">
6757	<desc>
6758	Status of the CPU.
6759	</desc>
6760	</param>
6761	</method>
6762
6763	<method name="queryLogFilename">
6764	<desc>
6765	Queries for the VM log file name of an given index. Returns an empty
6766	string if a log file with that index doesn't exists.
6767	</desc>
6768	<param name="idx" type="unsigned long" dir="in">
6769	<desc>
6770	Which log file name to query. 0=current log file.
6771	</desc>
6772	</param>
6773	<param name="filename" type="wstring" dir="return">
6774	<desc>
6775	On return the full path to the log file or an empty string on error.
6776	</desc>
6777	</param>
6778	</method>
6779
6780	<method name="readLog">
6781	<desc>
6782	Reads the VM log file. The chunk size is limited, so even if you
6783	ask for a big piece there might be less data returned.
6784	</desc>
6785	<param name="idx" type="unsigned long" dir="in">
6786	<desc>
6787	Which log file to read. 0=current log file.
6788	</desc>
6789	</param>
6790	<param name="offset" type="long long" dir="in">
6791	<desc>
6792	Offset in the log file.
6793	</desc>
6794	</param>
6795	<param name="size" type="long long" dir="in">
6796	<desc>
6797	Chunk size to read in the log file.
6798	</desc>
6799	</param>
6800	<param name="data" type="octet" dir="return" safearray="yes">
6801	<desc>
6802	Data read from the log file. A data size of 0 means end of file
6803	if the requested chunk size was not 0. This is the unprocessed
6804	file data, i.e. the line ending style depends on the platform of
6805	the system the server is running on.
6806	</desc>
6807	</param>
6808	</method>
6809
6810	<method name="cloneTo">
6811	<desc>
6812	Creates a clone of this machine, either as a full clone (which means
6813	creating independent copies of the hard disk media, save states and so
6814	on), or as a linked clone (which uses its own differencing media,
6815	sharing the parent media with the source machine).
6816
6817	The target machine object must have been created previously with <link
6818	to="IVirtualBox::createMachine"/>, and all the settings will be
6819	transferred except the VM name and the hardware UUID. You can set the
6820	VM name and the new hardware UUID when creating the target machine. The
6821	network MAC addresses are newly created for all newtwork adapters. You
6822	can change that behaviour with the options parameter. The operation is
6823	performed asynchronously, so the machine object will be not be usable
6824	until the @a progress object signals completion.
6825
6826	<result name="E_INVALIDARG">
6827	@a target is @c null.
6828	</result>
6829	</desc>
6830
6831	<param name="target" type="IMachine" dir="in">
6832	<desc>Target machine object.</desc>
6833	</param>
6834	<param name="mode" type="CloneMode" dir="in">
6835	<desc>Which states should be cloned.</desc>
6836	</param>
6837	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6838	<desc>Options for the cloning operation.</desc>
6839	</param>
6840	<param name="progress" type="IProgress" dir="return">
6841	<desc>Progress object to track the operation completion.</desc>
6842	</param>
6843	</method>
6844
6845	</interface>
6846
6847	<!--
6848	// IConsole
6849	/////////////////////////////////////////////////////////////////////////
6850	-->
6851
6852	<interface
6853	name="IVRDEServerInfo" extends="$unknown"
6854	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6855	wsmap="struct"
6856	>
6857	<desc>
6858	Contains information about the remote desktop (VRDE) server capabilities and status.
6859	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6860	</desc>
6861
6862	<attribute name="active" type="boolean" readonly="yes">
6863	<desc>
6864	Whether the remote desktop connection is active.
6865	</desc>
6866	</attribute>
6867
6868	<attribute name="port" type="long" readonly="yes">
6869	<desc>
6870	VRDE server port number. If this property is equal to <tt>0</tt>, then
6871	the VRDE server failed to start, usually because there are no free IP
6872	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6873	server has not yet been started.
6874	</desc>
6875	</attribute>
6876
6877	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6878	<desc>
6879	How many times a client connected.
6880	</desc>
6881	</attribute>
6882
6883	<attribute name="beginTime" type="long long" readonly="yes">
6884	<desc>
6885	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6886	</desc>
6887	</attribute>
6888
6889	<attribute name="endTime" type="long long" readonly="yes">
6890	<desc>
6891	When the last connection was terminated or the current time, if
6892	connection is still active, in milliseconds since 1970-01-01 UTC.
6893	</desc>
6894	</attribute>
6895
6896	<attribute name="bytesSent" type="long long" readonly="yes">
6897	<desc>
6898	How many bytes were sent in last or current, if still active, connection.
6899	</desc>
6900	</attribute>
6901
6902	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6903	<desc>
6904	How many bytes were sent in all connections.
6905	</desc>
6906	</attribute>
6907
6908	<attribute name="bytesReceived" type="long long" readonly="yes">
6909	<desc>
6910	How many bytes were received in last or current, if still active, connection.
6911	</desc>
6912	</attribute>
6913
6914	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6915	<desc>
6916	How many bytes were received in all connections.
6917	</desc>
6918	</attribute>
6919
6920	<attribute name="user" type="wstring" readonly="yes">
6921	<desc>
6922	Login user name supplied by the client.
6923	</desc>
6924	</attribute>
6925
6926	<attribute name="domain" type="wstring" readonly="yes">
6927	<desc>
6928	Login domain name supplied by the client.
6929	</desc>
6930	</attribute>
6931
6932	<attribute name="clientName" type="wstring" readonly="yes">
6933	<desc>
6934	The client name supplied by the client.
6935	</desc>
6936	</attribute>
6937
6938	<attribute name="clientIP" type="wstring" readonly="yes">
6939	<desc>
6940	The IP address of the client.
6941	</desc>
6942	</attribute>
6943
6944	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6945	<desc>
6946	The client software version number.
6947	</desc>
6948	</attribute>
6949
6950	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6951	<desc>
6952	Public key exchange method used when connection was established.
6953	Values: 0 - RDP4 public key exchange scheme.
6954	1 - X509 certificates were sent to client.
6955	</desc>
6956	</attribute>
6957
6958	</interface>
6959
6960	<interface
6961	name="IConsole" extends="$unknown"
6962	uuid="db7ab4ca-2a3f-4183-9243-c1208da92392"
6963	wsmap="managed"
6964	>
6965	<desc>
6966	The IConsole interface represents an interface to control virtual
6967	machine execution.
6968
6969	A console object gets created when a machine has been locked for a
6970	particular session (client process) using <link to="IMachine::lockMachine" />
6971	or <link to="IMachine::launchVMProcess"/>. The console object can
6972	then be found in the session's <link to="ISession::console" /> attribute.
6973
6974	Methods of the IConsole interface allow the caller to query the current
6975	virtual machine execution state, pause the machine or power it down, save
6976	the machine state or take a snapshot, attach and detach removable media
6977	and so on.
6978
6979	<see><link to="ISession"/></see>
6980	</desc>
6981
6982	<attribute name="machine" type="IMachine" readonly="yes">
6983	<desc>
6984	Machine object for this console session.
6985	<note>
6986	This is a convenience property, it has the same value as
6987	<link to="ISession::machine"/> of the corresponding session
6988	object.
6989	</note>
6990	</desc>
6991	</attribute>
6992
6993	<attribute name="state" type="MachineState" readonly="yes">
6994	<desc>
6995	Current execution state of the machine.
6996	<note>
6997	This property always returns the same value as the corresponding
6998	property of the IMachine object for this console session.
6999	For the process that owns (executes) the VM, this is the
7000	preferable way of querying the VM state, because no IPC
7001	calls are made.
7002	</note>
7003	</desc>
7004	</attribute>
7005
7006	<attribute name="guest" type="IGuest" readonly="yes">
7007	<desc>Guest object.</desc>
7008	</attribute>
7009
7010	<attribute name="keyboard" type="IKeyboard" readonly="yes">
7011	<desc>
7012	Virtual keyboard object.
7013	<note>
7014	If the machine is not running, any attempt to use
7015	the returned object will result in an error.
7016	</note>
7017	</desc>
7018	</attribute>
7019
7020	<attribute name="mouse" type="IMouse" readonly="yes">
7021	<desc>
7022	Virtual mouse object.
7023	<note>
7024	If the machine is not running, any attempt to use
7025	the returned object will result in an error.
7026	</note>
7027	</desc>
7028	</attribute>
7029
7030	<attribute name="display" type="IDisplay" readonly="yes">
7031	<desc>Virtual display object.
7032	<note>
7033	If the machine is not running, any attempt to use
7034	the returned object will result in an error.
7035	</note>
7036	</desc>
7037	</attribute>
7038
7039	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
7040	<desc>Debugging interface.</desc>
7041	</attribute>
7042
7043	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
7044	<desc>
7045	Collection of USB devices currently attached to the virtual
7046	USB controller.
7047	<note>
7048	The collection is empty if the machine is not running.
7049	</note>
7050	</desc>
7051	</attribute>
7052
7053	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7054	<desc>
7055	List of USB devices currently attached to the remote VRDE client.
7056	Once a new device is physically attached to the remote host computer,
7057	it appears in this list and remains there until detached.
7058	</desc>
7059	</attribute>
7060
7061	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
7062	<desc>
7063	Collection of shared folders for the current session. These folders
7064	are called transient shared folders because they are available to the
7065	guest OS running inside the associated virtual machine only for the
7066	duration of the session (as opposed to
7067	<link to="IMachine::sharedFolders"/> which represent permanent shared
7068	folders). When the session is closed (e.g. the machine is powered down),
7069	these folders are automatically discarded.
7070
7071	New shared folders are added to the collection using
7072	<link to="#createSharedFolder"/>. Existing shared folders can be
7073	removed using <link to="#removeSharedFolder"/>.
7074	</desc>
7075	</attribute>
7076
7077	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
7078	<desc>
7079	Interface that provides information on Remote Desktop Extension (VRDE) connection.
7080	</desc>
7081	</attribute>
7082
7083	<attribute name="eventSource" type="IEventSource" readonly="yes">
7084	<desc>
7085	Event source for console events.
7086	</desc>
7087	</attribute>
7088
7089	<attribute name="attachedPCIDevices" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
7090	<desc>Array of PCI devices attached to this machine.</desc>
7091	</attribute>
7092
7093	<attribute name="useHostClipboard" type="boolean">
7094	<desc>
7095	Whether the guest clipboard should be connected to the host one or
7096	whether it should only be allowed access to the VRDE clipboard. This
7097	setting may not affect existing guest clipboard connections which
7098	are already connected to the host clipboard.
7099	</desc>
7100	</attribute>
7101
7102	<method name="powerUp">
7103	<desc>
7104	Starts the virtual machine execution using the current machine
7105	state (that is, its current execution state, current settings and
7106	current storage devices).
7107
7108	<note>
7109	This method is only useful for front-ends that want to actually
7110	execute virtual machines in their own process (like the VirtualBox
7111	or VBoxSDL front-ends). Unless you are intending to write such a
7112	front-end, do not call this method. If you simply want to
7113	start virtual machine execution using one of the existing front-ends
7114	(for example the VirtualBox GUI or headless server), use
7115	<link to="IMachine::launchVMProcess"/> instead; these
7116	front-ends will power up the machine automatically for you.
7117	</note>
7118
7119	If the machine is powered off or aborted, the execution will
7120	start from the beginning (as if the real hardware were just
7121	powered on).
7122
7123	If the machine is in the <link to="MachineState_Saved"/> state,
7124	it will continue its execution the point where the state has
7125	been saved.
7126
7127	If the machine <link to="IMachine::teleporterEnabled"/> property is
7128	enabled on the machine being powered up, the machine will wait for an
7129	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
7130	state. The returned progress object will have at least three
7131	operations where the last three are defined as: (1) powering up and
7132	starting TCP server, (2) waiting for incoming teleportations, and
7133	(3) perform teleportation. These operations will be reflected as the
7134	last three operations of the progress objected returned by
7135	<link to="IMachine::launchVMProcess"/> as well.
7136
7137	<see><link to="#saveState"/></see>
7138
7139	<result name="VBOX_E_INVALID_VM_STATE">
7140	Virtual machine already running.
7141	</result>
7142	<result name="VBOX_E_HOST_ERROR">
7143	Host interface does not exist or name not set.
7144	</result>
7145	<result name="VBOX_E_FILE_ERROR">
7146	Invalid saved state file.
7147	</result>
7148	</desc>
7149	<param name="progress" type="IProgress" dir="return">
7150	<desc>Progress object to track the operation completion.</desc>
7151	</param>
7152	</method>
7153
7154	<method name="powerUpPaused">
7155	<desc>
7156	Identical to powerUp except that the VM will enter the
7157	<link to="MachineState_Paused"/> state, instead of
7158	<link to="MachineState_Running"/>.
7159
7160	<see><link to="#powerUp"/></see>
7161	<result name="VBOX_E_INVALID_VM_STATE">
7162	Virtual machine already running.
7163	</result>
7164	<result name="VBOX_E_HOST_ERROR">
7165	Host interface does not exist or name not set.
7166	</result>
7167	<result name="VBOX_E_FILE_ERROR">
7168	Invalid saved state file.
7169	</result>
7170	</desc>
7171	<param name="progress" type="IProgress" dir="return">
7172	<desc>Progress object to track the operation completion.</desc>
7173	</param>
7174	</method>
7175
7176	<method name="powerDown">
7177	<desc>
7178	Initiates the power down procedure to stop the virtual machine
7179	execution.
7180
7181	The completion of the power down procedure is tracked using the returned
7182	IProgress object. After the operation is complete, the machine will go
7183	to the PoweredOff state.
7184	<result name="VBOX_E_INVALID_VM_STATE">
7185	Virtual machine must be Running, Paused or Stuck to be powered down.
7186	</result>
7187	</desc>
7188	<param name="progress" type="IProgress" dir="return">
7189	<desc>Progress object to track the operation completion.</desc>
7190	</param>
7191	</method>
7192
7193	<method name="reset">
7194	<desc>Resets the virtual machine.
7195	<result name="VBOX_E_INVALID_VM_STATE">
7196	Virtual machine not in Running state.
7197	</result>
7198	<result name="VBOX_E_VM_ERROR">
7199	Virtual machine error in reset operation.
7200	</result>
7201	</desc>
7202	</method>
7203
7204	<method name="pause">
7205	<desc>Pauses the virtual machine execution.
7206	<result name="VBOX_E_INVALID_VM_STATE">
7207	Virtual machine not in Running state.
7208	</result>
7209	<result name="VBOX_E_VM_ERROR">
7210	Virtual machine error in suspend operation.
7211	</result>
7212	</desc>
7213	</method>
7214
7215	<method name="resume">
7216	<desc>Resumes the virtual machine execution.
7217	<result name="VBOX_E_INVALID_VM_STATE">
7218	Virtual machine not in Paused state.
7219	</result>
7220	<result name="VBOX_E_VM_ERROR">
7221	Virtual machine error in resume operation.
7222	</result>
7223	</desc>
7224	</method>
7225
7226	<method name="powerButton">
7227	<desc>Sends the ACPI power button event to the guest.
7228	<result name="VBOX_E_INVALID_VM_STATE">
7229	Virtual machine not in Running state.
7230	</result>
7231	<result name="VBOX_E_PDM_ERROR">
7232	Controlled power off failed.
7233	</result>
7234	</desc>
7235	</method>
7236
7237	<method name="sleepButton">
7238	<desc>Sends the ACPI sleep button event to the guest.
7239	<result name="VBOX_E_INVALID_VM_STATE">
7240	Virtual machine not in Running state.
7241	</result>
7242	<result name="VBOX_E_PDM_ERROR">
7243	Sending sleep button event failed.
7244	</result>
7245	</desc>
7246	</method>
7247
7248	<method name="getPowerButtonHandled">
7249	<desc>Checks if the last power button event was handled by guest.
7250	<result name="VBOX_E_PDM_ERROR">
7251	Checking if the event was handled by the guest OS failed.
7252	</result>
7253	</desc>
7254	<param name="handled" type="boolean" dir="return"/>
7255	</method>
7256
7257	<method name="getGuestEnteredACPIMode">
7258	<desc>Checks if the guest entered the ACPI mode G0 (working) or
7259	G1 (sleeping). If this method returns @c false, the guest will
7260	most likely not respond to external ACPI events.
7261	<result name="VBOX_E_INVALID_VM_STATE">
7262	Virtual machine not in Running state.
7263	</result>
7264	</desc>
7265	<param name="entered" type="boolean" dir="return"/>
7266	</method>
7267
7268	<method name="saveState">
7269	<desc>
7270	Saves the current execution state of a running virtual machine
7271	and stops its execution.
7272
7273	After this operation completes, the machine will go to the
7274	Saved state. Next time it is powered up, this state will
7275	be restored and the machine will continue its execution from
7276	the place where it was saved.
7277
7278	This operation differs from taking a snapshot to the effect
7279	that it doesn't create new differencing media. Also, once
7280	the machine is powered up from the state saved using this method,
7281	the saved state is deleted, so it will be impossible to return
7282	to this state later.
7283
7284	<note>
7285	On success, this method implicitly calls
7286	<link to="IMachine::saveSettings"/> to save all current machine
7287	settings (including runtime changes to the DVD medium, etc.).
7288	Together with the impossibility to change any VM settings when it is
7289	in the Saved state, this guarantees adequate hardware
7290	configuration of the machine when it is restored from the saved
7291	state file.
7292	</note>
7293
7294	<note>
7295	The machine must be in the Running or Paused state, otherwise
7296	the operation will fail.
7297	</note>
7298	<result name="VBOX_E_INVALID_VM_STATE">
7299	Virtual machine state neither Running nor Paused.
7300	</result>
7301	<result name="VBOX_E_FILE_ERROR">
7302	Failed to create directory for saved state file.
7303	</result>
7304
7305	<see><link to="#takeSnapshot"/></see>
7306	</desc>
7307	<param name="progress" type="IProgress" dir="return">
7308	<desc>Progress object to track the operation completion.</desc>
7309	</param>
7310	</method>
7311
7312	<method name="adoptSavedState">
7313	<desc>
7314	Associates the given saved state file to the virtual machine.
7315
7316	On success, the machine will go to the Saved state. Next time it is
7317	powered up, it will be restored from the adopted saved state and
7318	continue execution from the place where the saved state file was
7319	created.
7320
7321	The specified saved state file path may be absolute or relative to the
7322	folder the VM normally saves the state to (usually,
7323	<link to="IMachine::snapshotFolder"/>).
7324
7325	<note>
7326	It's a caller's responsibility to make sure the given saved state
7327	file is compatible with the settings of this virtual machine that
7328	represent its virtual hardware (memory size, storage disk configuration
7329	etc.). If there is a mismatch, the behavior of the virtual machine
7330	is undefined.
7331	</note>
7332	<result name="VBOX_E_INVALID_VM_STATE">
7333	Virtual machine state neither PoweredOff nor Aborted.
7334	</result>
7335	</desc>
7336	<param name="savedStateFile" type="wstring" dir="in">
7337	<desc>Path to the saved state file to adopt.</desc>
7338	</param>
7339	</method>
7340
7341	<method name="discardSavedState">
7342	<desc>
7343	Forcibly resets the machine to "Powered Off" state if it is
7344	currently in the "Saved" state (previously created by <link to="#saveState"/>).
7345	Next time the machine is powered up, a clean boot will occur.
7346	<note>
7347	This operation is equivalent to resetting or powering off
7348	the machine without doing a proper shutdown of the guest
7349	operating system; as with resetting a running phyiscal
7350	computer, it can can lead to data loss.
7351	</note>
7352	If @a fRemoveFile is @c true, the file in the machine directory
7353	into which the machine state was saved is also deleted. If
7354	this is @c false, then the state can be recovered and later
7355	re-inserted into a machine using <link to="#adoptSavedState" />.
7356	The location of the file can be found in the
7357	<link to="IMachine::stateFilePath" /> attribute.
7358	<result name="VBOX_E_INVALID_VM_STATE">
7359	Virtual machine not in state Saved.
7360	</result>
7361	</desc>
7362	<param name="fRemoveFile" type="boolean" dir="in" >
7363	<desc>Whether to also remove the saved state file.</desc>
7364	</param>
7365	</method>
7366
7367	<method name="getDeviceActivity">
7368	<desc>
7369	Gets the current activity type of a given device or device group.
7370	<result name="E_INVALIDARG">
7371	Invalid device type.
7372	</result>
7373	</desc>
7374	<param name="type" type="DeviceType" dir="in"/>
7375	<param name="activity" type="DeviceActivity" dir="return"/>
7376	</method>
7377
7378	<method name="attachUSBDevice">
7379	<desc>
7380	Attaches a host USB device with the given UUID to the
7381	USB controller of the virtual machine.
7382
7383	The device needs to be in one of the following states:
7384	<link to="USBDeviceState_Busy"/>,
7385	<link to="USBDeviceState_Available"/> or
7386	<link to="USBDeviceState_Held"/>,
7387	otherwise an error is immediately returned.
7388
7389	When the device state is
7390	<link to="USBDeviceState_Busy">Busy</link>, an error may also
7391	be returned if the host computer refuses to release it for some reason.
7392
7393	<see><link to="IUSBController::deviceFilters"/>,
7394	<link to="USBDeviceState"/></see>
7395	<result name="VBOX_E_INVALID_VM_STATE">
7396	Virtual machine state neither Running nor Paused.
7397	</result>
7398	<result name="VBOX_E_PDM_ERROR">
7399	Virtual machine does not have a USB controller.
7400	</result>
7401	</desc>
7402	<param name="id" type="uuid" mod="string" dir="in">
7403	<desc>UUID of the host USB device to attach.</desc>
7404	</param>
7405	</method>
7406
7407	<method name="detachUSBDevice">
7408	<desc>
7409	Detaches an USB device with the given UUID from the USB controller
7410	of the virtual machine.
7411
7412	After this method succeeds, the VirtualBox server re-initiates
7413	all USB filters as if the device were just physically attached
7414	to the host, but filters of this machine are ignored to avoid
7415	a possible automatic re-attachment.
7416
7417	<see><link to="IUSBController::deviceFilters"/>,
7418	<link to="USBDeviceState"/></see>
7419
7420	<result name="VBOX_E_PDM_ERROR">
7421	Virtual machine does not have a USB controller.
7422	</result>
7423	<result name="E_INVALIDARG">
7424	USB device not attached to this virtual machine.
7425	</result>
7426	</desc>
7427	<param name="id" type="uuid" mod="string" dir="in">
7428	<desc>UUID of the USB device to detach.</desc>
7429	</param>
7430	<param name="device" type="IUSBDevice" dir="return">
7431	<desc>Detached USB device.</desc>
7432	</param>
7433	</method>
7434
7435	<method name="findUSBDeviceByAddress">
7436	<desc>
7437	Searches for a USB device with the given host address.
7438
7439	<result name="VBOX_E_OBJECT_NOT_FOUND">
7440	Given @c name does not correspond to any USB device.
7441	</result>
7442
7443	<see><link to="IUSBDevice::address"/></see>
7444	</desc>
7445	<param name="name" type="wstring" dir="in">
7446	<desc>
7447	Address of the USB device (as assigned by the host) to
7448	search for.
7449	</desc>
7450	</param>
7451	<param name="device" type="IUSBDevice" dir="return">
7452	<desc>Found USB device object.</desc>
7453	</param>
7454	</method>
7455
7456	<method name="findUSBDeviceById">
7457	<desc>
7458	Searches for a USB device with the given UUID.
7459
7460	<result name="VBOX_E_OBJECT_NOT_FOUND">
7461	Given @c id does not correspond to any USB device.
7462	</result>
7463
7464	<see><link to="IUSBDevice::id"/></see>
7465	</desc>
7466	<param name="id" type="uuid" mod="string" dir="in">
7467	<desc>UUID of the USB device to search for.</desc>
7468	</param>
7469	<param name="device" type="IUSBDevice" dir="return">
7470	<desc>Found USB device object.</desc>
7471	</param>
7472	</method>
7473
7474	<method name="createSharedFolder">
7475	<desc>
7476	Creates a transient new shared folder by associating the given logical
7477	name with the given host path, adds it to the collection of shared
7478	folders and starts sharing it. Refer to the description of
7479	<link to="ISharedFolder"/> to read more about logical names.
7480
7481	<result name="VBOX_E_INVALID_VM_STATE">
7482	Virtual machine in Saved state or currently changing state.
7483	</result>
7484	<result name="VBOX_E_FILE_ERROR">
7485	Shared folder already exists or not accessible.
7486	</result>
7487	</desc>
7488	<param name="name" type="wstring" dir="in">
7489	<desc>Unique logical name of the shared folder.</desc>
7490	</param>
7491	<param name="hostPath" type="wstring" dir="in">
7492	<desc>Full path to the shared folder in the host file system.</desc>
7493	</param>
7494	<param name="writable" type="boolean" dir="in">
7495	<desc>Whether the share is writable or readonly</desc>
7496	</param>
7497	<param name="automount" type="boolean" dir="in">
7498	<desc>Whether the share gets automatically mounted by the guest
7499	or not.</desc>
7500	</param>
7501	</method>
7502
7503	<method name="removeSharedFolder">
7504	<desc>
7505	Removes a transient shared folder with the given name previously
7506	created by <link to="#createSharedFolder"/> from the collection of
7507	shared folders and stops sharing it.
7508	<result name="VBOX_E_INVALID_VM_STATE">
7509	Virtual machine in Saved state or currently changing state.
7510	</result>
7511	<result name="VBOX_E_FILE_ERROR">
7512	Shared folder does not exists.
7513	</result>
7514	</desc>
7515	<param name="name" type="wstring" dir="in">
7516	<desc>Logical name of the shared folder to remove.</desc>
7517	</param>
7518	</method>
7519
7520	<method name="takeSnapshot">
7521	<desc>
7522	Saves the current execution state
7523	and all settings of the machine and creates differencing images
7524	for all normal (non-independent) media.
7525	See <link to="ISnapshot" /> for an introduction to snapshots.
7526
7527	This method can be called for a PoweredOff, Saved (see
7528	<link to="#saveState"/>), Running or
7529	Paused virtual machine. When the machine is PoweredOff, an
7530	offline snapshot is created. When the machine is Running a live
7531	snapshot is created, and an online snapshot is created when Paused.
7532
7533	The taken snapshot is always based on the
7534	<link to="IMachine::currentSnapshot">current snapshot</link>
7535	of the associated virtual machine and becomes a new current snapshot.
7536
7537	<note>
7538	This method implicitly calls <link to="IMachine::saveSettings"/> to
7539	save all current machine settings before taking an offline snapshot.
7540	</note>
7541
7542	<result name="VBOX_E_INVALID_VM_STATE">
7543	Virtual machine currently changing state.
7544	</result>
7545	</desc>
7546	<param name="name" type="wstring" dir="in">
7547	<desc>Short name for the snapshot.</desc>
7548	</param>
7549	<param name="description" type="wstring" dir="in">
7550	<desc>Optional description of the snapshot.</desc>
7551	</param>
7552	<param name="progress" type="IProgress" dir="return">
7553	<desc>Progress object to track the operation completion.</desc>
7554	</param>
7555	</method>
7556
7557	<method name="deleteSnapshot">
7558	<desc>
7559	Starts deleting the specified snapshot asynchronously.
7560	See <link to="ISnapshot" /> for an introduction to snapshots.
7561
7562	The execution state and settings of the associated machine stored in
7563	the snapshot will be deleted. The contents of all differencing media of
7564	this snapshot will be merged with the contents of their dependent child
7565	media to keep the medium chain valid (in other words, all changes
7566	represented by media being deleted will be propagated to their child
7567	medium). After that, this snapshot's differencing medium will be
7568	deleted. The parent of this snapshot will become a new parent for all
7569	its child snapshots.
7570
7571	If the deleted snapshot is the current one, its parent snapshot will
7572	become a new current snapshot. The current machine state is not directly
7573	affected in this case, except that currently attached differencing
7574	media based on media of the deleted snapshot will be also merged as
7575	described above.
7576
7577	If the deleted snapshot is the first or current snapshot, then the
7578	respective IMachine attributes will be adjusted. Deleting the current
7579	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7580	to make all current machine settings permanent.
7581
7582	Deleting a snapshot has the following preconditions:
7583
7584	<ul>
7585	<li>Child media of all normal media of the deleted snapshot
7586	must be accessible (see <link to="IMedium::state"/>) for this
7587	operation to succeed. If only one running VM refers to all images
7588	which participates in merging the operation can be performed while
7589	the VM is running. Otherwise all virtual machines whose media are
7590	directly or indirectly based on the media of deleted snapshot must
7591	be powered off. In any case, online snapshot deleting usually is
7592	slower than the same operation without any running VM.</li>
7593
7594	<li>You cannot delete the snapshot if a medium attached to it has
7595	more than one child medium (differencing images) because otherwise
7596	merging would be impossible. This might be the case if there is
7597	more than one child snapshot or differencing images were created
7598	for other reason (e.g. implicitly because of multiple machine
7599	attachments).</li>
7600	</ul>
7601
7602	The virtual machine's <link to="IMachine::state">state</link> is
7603	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7604	"DeletingSnapshotPaused" while this operation is in progress.
7605
7606	<note>
7607	Merging medium contents can be very time and disk space
7608	consuming, if these media are big in size and have many
7609	children. However, if the snapshot being deleted is the last
7610	(head) snapshot on the branch, the operation will be rather
7611	quick.
7612	</note>
7613	<result name="VBOX_E_INVALID_VM_STATE">
7614	The running virtual machine prevents deleting this snapshot. This
7615	happens only in very specific situations, usually snapshots can be
7616	deleted without trouble while a VM is running. The error message
7617	text explains the reason for the failure.
7618	</result>
7619	</desc>
7620	<param name="id" type="uuid" mod="string" dir="in">
7621	<desc>UUID of the snapshot to delete.</desc>
7622	</param>
7623	<param name="progress" type="IProgress" dir="return">
7624	<desc>Progress object to track the operation completion.</desc>
7625	</param>
7626	</method>
7627
7628	<method name="deleteSnapshotAndAllChildren">
7629	<desc>
7630	Starts deleting the specified snapshot and all its children
7631	asynchronously. See <link to="ISnapshot" /> for an introduction to
7632	snapshots. The conditions and many details are the same as with
7633	<link to="#deleteSnapshot"/>.
7634
7635	This operation is very fast if the snapshot subtree does not include
7636	the current state. It is still significantly faster than deleting the
7637	snapshots one by one if the current state is in the subtree and there
7638	are more than one snapshots from current state to the snapshot which
7639	marks the subtree, since it eliminates the incremental image merging.
7640
7641	<note>This API method is right now not implemented!</note>
7642
7643	<result name="VBOX_E_INVALID_VM_STATE">
7644	The running virtual machine prevents deleting this snapshot. This
7645	happens only in very specific situations, usually snapshots can be
7646	deleted without trouble while a VM is running. The error message
7647	text explains the reason for the failure.
7648	</result>
7649	<result name="E_NOTIMPL">
7650	The method is not implemented yet.
7651	</result>
7652	</desc>
7653	<param name="id" type="uuid" mod="string" dir="in">
7654	<desc>UUID of the snapshot to delete, including all its children.</desc>
7655	</param>
7656	<param name="progress" type="IProgress" dir="return">
7657	<desc>Progress object to track the operation completion.</desc>
7658	</param>
7659	</method>
7660
7661	<method name="deleteSnapshotRange">
7662	<desc>
7663	Starts deleting the specified snapshot range. This is limited to
7664	linear snapshot lists, which means there may not be any other child
7665	snapshots other than the direct sequence between the start and end
7666	snapshot. If the start and end snapshot point to the same snapshot this
7667	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7668	<link to="ISnapshot" /> for an introduction to snapshots. The
7669	conditions and many details are the same as with
7670	<link to="#deleteSnapshot"/>.
7671
7672	This operation is generally faster than deleting snapshots one by one
7673	and often also needs less extra disk space before freeing up disk space
7674	by deleting the removed disk images corresponding to the snapshot.
7675
7676	<note>This API method is right now not implemented!</note>
7677
7678	<result name="VBOX_E_INVALID_VM_STATE">
7679	The running virtual machine prevents deleting this snapshot. This
7680	happens only in very specific situations, usually snapshots can be
7681	deleted without trouble while a VM is running. The error message
7682	text explains the reason for the failure.
7683	</result>
7684	<result name="E_NOTIMPL">
7685	The method is not implemented yet.
7686	</result>
7687	</desc>
7688	<param name="startId" type="uuid" mod="string" dir="in">
7689	<desc>UUID of the first snapshot to delete.</desc>
7690	</param>
7691	<param name="endId" type="uuid" mod="string" dir="in">
7692	<desc>UUID of the last snapshot to delete.</desc>
7693	</param>
7694	<param name="progress" type="IProgress" dir="return">
7695	<desc>Progress object to track the operation completion.</desc>
7696	</param>
7697	</method>
7698
7699	<method name="restoreSnapshot">
7700	<desc>
7701	Starts resetting the machine's current state to the state contained
7702	in the given snapshot, asynchronously. All current settings of the
7703	machine will be reset and changes stored in differencing media
7704	will be lost.
7705	See <link to="ISnapshot" /> for an introduction to snapshots.
7706
7707	After this operation is successfully completed, new empty differencing
7708	media are created for all normal media of the machine.
7709
7710	If the given snapshot is an online snapshot, the machine will go to
7711	the <link to="MachineState_Saved"> saved state</link>, so that the
7712	next time it is powered on, the execution state will be restored
7713	from the state of the snapshot.
7714
7715	<note>
7716	The machine must not be running, otherwise the operation will fail.
7717	</note>
7718
7719	<note>
7720	If the machine state is <link to="MachineState_Saved">Saved</link>
7721	prior to this operation, the saved state file will be implicitly
7722	deleted (as if <link to="IConsole::discardSavedState"/> were
7723	called).
7724	</note>
7725
7726	<result name="VBOX_E_INVALID_VM_STATE">
7727	Virtual machine is running.
7728	</result>
7729	</desc>
7730	<param name="snapshot" type="ISnapshot" dir="in">
7731	<desc>The snapshot to restore the VM state from.</desc>
7732	</param>
7733	<param name="progress" type="IProgress" dir="return">
7734	<desc>Progress object to track the operation completion.</desc>
7735	</param>
7736	</method>
7737
7738	<method name="teleport">
7739	<desc>
7740	Teleport the VM to a different host machine or process.
7741
7742	TODO explain the details.
7743
7744	<result name="VBOX_E_INVALID_VM_STATE">
7745	Virtual machine not running or paused.
7746	</result>
7747	</desc>
7748	<param name="hostname" type="wstring" dir="in">
7749	<desc>The name or IP of the host to teleport to.</desc>
7750	</param>
7751	<param name="tcpport" type="unsigned long" dir="in">
7752	<desc>The TCP port to connect to (1..65535).</desc>
7753	</param>
7754	<param name="password" type="wstring" dir="in">
7755	<desc>The password.</desc>
7756	</param>
7757	<param name="maxDowntime" type="unsigned long" dir="in">
7758	<desc>
7759	The maximum allowed downtime given as milliseconds. 0 is not a valid
7760	value. Recommended value: 250 ms.
7761
7762	The higher the value is, the greater the chance for a successful
7763	teleportation. A small value may easily result in the teleportation
7764	process taking hours and eventually fail.
7765
7766	<note>
7767	The current implementation treats this a guideline, not as an
7768	absolute rule.
7769	</note>
7770	</desc>
7771	</param>
7772	<param name="progress" type="IProgress" dir="return">
7773	<desc>Progress object to track the operation completion.</desc>
7774	</param>
7775	</method>
7776
7777	</interface>
7778
7779	<!--
7780	// IHost
7781	/////////////////////////////////////////////////////////////////////////
7782	-->
7783
7784	<enum
7785	name="HostNetworkInterfaceMediumType"
7786	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7787	>
7788	<desc>
7789	Type of encapsulation. Ethernet encapsulation includes both wired and
7790	wireless Ethernet connections.
7791	<see><link to="IHostNetworkInterface"/></see>
7792	</desc>
7793
7794	<const name="Unknown" value="0">
7795	<desc>
7796	The type of interface cannot be determined.
7797	</desc>
7798	</const>
7799	<const name="Ethernet" value="1">
7800	<desc>
7801	Ethernet frame encapsulation.
7802	</desc>
7803	</const>
7804	<const name="PPP" value="2">
7805	<desc>
7806	Point-to-point protocol encapsulation.
7807	</desc>
7808	</const>
7809	<const name="SLIP" value="3">
7810	<desc>
7811	Serial line IP encapsulation.
7812	</desc>
7813	</const>
7814	</enum>
7815
7816	<enum
7817	name="HostNetworkInterfaceStatus"
7818	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7819	>
7820	<desc>
7821	Current status of the interface.
7822	<see><link to="IHostNetworkInterface"/></see>
7823	</desc>
7824
7825	<const name="Unknown" value="0">
7826	<desc>
7827	The state of interface cannot be determined.
7828	</desc>
7829	</const>
7830	<const name="Up" value="1">
7831	<desc>
7832	The interface is fully operational.
7833	</desc>
7834	</const>
7835	<const name="Down" value="2">
7836	<desc>
7837	The interface is not functioning.
7838	</desc>
7839	</const>
7840	</enum>
7841
7842	<enum
7843	name="HostNetworkInterfaceType"
7844	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7845	>
7846	<desc>
7847	Network interface type.
7848	</desc>
7849	<const name="Bridged" value="1"/>
7850	<const name="HostOnly" value="2"/>
7851	</enum>
7852
7853	<interface
7854	name="IHostNetworkInterface" extends="$unknown"
7855	uuid="87a4153d-6889-4dd6-9654-2e9ff0ae8dec"
7856	wsmap="managed"
7857	>
7858	<desc>
7859	Represents one of host's network interfaces. IP V6 address and network
7860	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7861	separated by colons.
7862	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7863	</desc>
7864	<attribute name="name" type="wstring" readonly="yes">
7865	<desc>Returns the host network interface name.</desc>
7866	</attribute>
7867
7868	<attribute name="id" type="uuid" mod="string" readonly="yes">
7869	<desc>Returns the interface UUID.</desc>
7870	</attribute>
7871
7872	<attribute name="networkName" type="wstring" readonly="yes">
7873	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7874	</attribute>
7875
7876	<attribute name="DHCPEnabled" type="boolean" readonly="yes">
7877	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7878	</attribute>
7879
7880	<attribute name="IPAddress" type="wstring" readonly="yes">
7881	<desc>Returns the IP V4 address of the interface.</desc>
7882	</attribute>
7883
7884	<attribute name="networkMask" type="wstring" readonly="yes">
7885	<desc>Returns the network mask of the interface.</desc>
7886	</attribute>
7887
7888	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7889	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7890	</attribute>
7891
7892	<attribute name="IPV6Address" type="wstring" readonly="yes">
7893	<desc>Returns the IP V6 address of the interface.</desc>
7894	</attribute>
7895
7896	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7897	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7898	</attribute>
7899
7900	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7901	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7902	</attribute>
7903
7904	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7905	<desc>Type of protocol encapsulation used.</desc>
7906	</attribute>
7907
7908	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7909	<desc>Status of the interface.</desc>
7910	</attribute>
7911
7912	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7913	<desc>specifies the host interface type.</desc>
7914	</attribute>
7915
7916	<method name="enableStaticIPConfig">
7917	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7918	<param name="IPAddress" type="wstring" dir="in">
7919	<desc>
7920	IP address.
7921	</desc>
7922	</param>
7923	<param name="networkMask" type="wstring" dir="in">
7924	<desc>
7925	network mask.
7926	</desc>
7927	</param>
7928	</method>
7929
7930	<method name="enableStaticIPConfigV6">
7931	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7932	<param name="IPV6Address" type="wstring" dir="in">
7933	<desc>
7934	IP address.
7935	</desc>
7936	</param>
7937	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7938	<desc>
7939	network mask.
7940	</desc>
7941	</param>
7942	</method>
7943
7944	<method name="enableDynamicIPConfig">
7945	<desc>enables the dynamic IP configuration.</desc>
7946	</method>
7947
7948	<method name="DHCPRediscover">
7949	<desc>refreshes the IP configuration for DHCP-enabled interface.</desc>
7950	</method>
7951
7952	</interface>
7953
7954	<interface
7955	name="IHost" extends="$unknown"
7956	uuid="30678943-32df-4830-b413-931b25ac86a0"
7957	wsmap="managed"
7958	>
7959	<desc>
7960	The IHost interface represents the physical machine that this VirtualBox
7961	installation runs on.
7962
7963	An object implementing this interface is returned by the
7964	<link to="IVirtualBox::host" /> attribute. This interface contains
7965	read-only information about the host's physical hardware (such as what
7966	processors and disks are available, what the host operating system is,
7967	and so on) and also allows for manipulating some of the host's hardware,
7968	such as global USB device filters and host interface networking.
7969
7970	</desc>
7971	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7972	<desc>List of DVD drives available on the host.</desc>
7973	</attribute>
7974
7975	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7976	<desc>List of floppy drives available on the host.</desc>
7977	</attribute>
7978
7979	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7980	<desc>
7981	List of USB devices currently attached to the host.
7982	Once a new device is physically attached to the host computer,
7983	it appears in this list and remains there until detached.
7984
7985	<note>
7986	If USB functionality is not available in the given edition of
7987	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7988	</note>
7989	</desc>
7990	</attribute>
7991
7992	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7993	<desc>
7994	List of USB device filters in action.
7995	When a new device is physically attached to the host computer,
7996	filters from this list are applied to it (in order they are stored
7997	in the list). The first matched filter will determine the
7998	<link to="IHostUSBDeviceFilter::action">action</link>
7999	performed on the device.
8000
8001	Unless the device is ignored by these filters, filters of all
8002	currently running virtual machines
8003	(<link to="IUSBController::deviceFilters"/>) are applied to it.
8004
8005	<note>
8006	If USB functionality is not available in the given edition of
8007	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8008	</note>
8009
8010	<see><link to="IHostUSBDeviceFilter"/>,
8011	<link to="USBDeviceState"/></see>
8012	</desc>
8013	</attribute>
8014
8015	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
8016	<desc>List of host network interfaces currently defined on the host.</desc>
8017	</attribute>
8018
8019	<attribute name="processorCount" type="unsigned long" readonly="yes">
8020	<desc>Number of (logical) CPUs installed in the host system.</desc>
8021	</attribute>
8022
8023	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
8024	<desc>Number of (logical) CPUs online in the host system.</desc>
8025	</attribute>
8026
8027	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
8028	<desc>Number of physical processor cores installed in the host system.</desc>
8029	</attribute>
8030
8031	<method name="getProcessorSpeed">
8032	<desc>Query the (approximate) maximum speed of a specified host CPU in
8033	Megahertz.
8034	</desc>
8035	<param name="cpuId" type="unsigned long" dir="in">
8036	<desc>
8037	Identifier of the CPU.
8038	</desc>
8039	</param>
8040	<param name="speed" type="unsigned long" dir="return">
8041	<desc>
8042	Speed value. 0 is returned if value is not known or @a cpuId is
8043	invalid.
8044	</desc>
8045	</param>
8046	</method>
8047
8048	<method name="getProcessorFeature">
8049	<desc>Query whether a CPU feature is supported or not.</desc>
8050	<param name="feature" type="ProcessorFeature" dir="in">
8051	<desc>
8052	CPU Feature identifier.
8053	</desc>
8054	</param>
8055	<param name="supported" type="boolean" dir="return">
8056	<desc>
8057	Feature is supported or not.
8058	</desc>
8059	</param>
8060	</method>
8061
8062	<method name="getProcessorDescription">
8063	<desc>Query the model string of a specified host CPU.
8064	</desc>
8065	<param name="cpuId" type="unsigned long" dir="in">
8066	<desc>
8067	Identifier of the CPU.
8068	<note>
8069	The current implementation might not necessarily return the
8070	description for this exact CPU.
8071	</note>
8072	</desc>
8073	</param>
8074	<param name="description" type="wstring" dir="return">
8075	<desc>
8076	Model string. An empty string is returned if value is not known or
8077	@a cpuId is invalid.
8078	</desc>
8079	</param>
8080	</method>
8081
8082	<method name="getProcessorCPUIDLeaf">
8083	<desc>
8084	Returns the CPU cpuid information for the specified leaf.
8085	</desc>
8086	<param name="cpuId" type="unsigned long" dir="in">
8087	<desc>
8088	Identifier of the CPU. The CPU most be online.
8089	<note>
8090	The current implementation might not necessarily return the
8091	description for this exact CPU.
8092	</note>
8093	</desc>
8094	</param>
8095	<param name="leaf" type="unsigned long" dir="in">
8096	<desc>
8097	CPUID leaf index (eax).
8098	</desc>
8099	</param>
8100	<param name="subLeaf" type="unsigned long" dir="in">
8101	<desc>
8102	CPUID leaf sub index (ecx). This currently only applies to cache
8103	information on Intel CPUs. Use 0 if retrieving values for
8104	<link to="IMachine::setCPUIDLeaf"/>.
8105	</desc>
8106	</param>
8107	<param name="valEax" type="unsigned long" dir="out">
8108	<desc>
8109	CPUID leaf value for register eax.
8110	</desc>
8111	</param>
8112	<param name="valEbx" type="unsigned long" dir="out">
8113	<desc>
8114	CPUID leaf value for register ebx.
8115	</desc>
8116	</param>
8117	<param name="valEcx" type="unsigned long" dir="out">
8118	<desc>
8119	CPUID leaf value for register ecx.
8120	</desc>
8121	</param>
8122	<param name="valEdx" type="unsigned long" dir="out">
8123	<desc>
8124	CPUID leaf value for register edx.
8125	</desc>
8126	</param>
8127	</method>
8128
8129	<attribute name="memorySize" type="unsigned long" readonly="yes">
8130	<desc>Amount of system memory in megabytes installed in the host system.</desc>
8131	</attribute>
8132
8133	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
8134	<desc>Available system memory in the host system.</desc>
8135	</attribute>
8136
8137	<attribute name="operatingSystem" type="wstring" readonly="yes">
8138	<desc>Name of the host system's operating system.</desc>
8139	</attribute>
8140
8141	<attribute name="OSVersion" type="wstring" readonly="yes">
8142	<desc>Host operating system's version string.</desc>
8143	</attribute>
8144
8145	<attribute name="UTCTime" type="long long" readonly="yes">
8146	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
8147	</attribute>
8148
8149	<attribute name="acceleration3DAvailable" type="boolean" readonly="yes">
8150	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
8151	</attribute>
8152
8153	<method name="createHostOnlyNetworkInterface">
8154	<desc>
8155	Creates a new adapter for Host Only Networking.
8156	<result name="E_INVALIDARG">
8157	Host network interface @a name already exists.
8158	</result>
8159	</desc>
8160	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
8161	<desc>
8162	Created host interface object.
8163	</desc>
8164	</param>
8165	<param name="progress" type="IProgress" dir="return">
8166	<desc>
8167	Progress object to track the operation completion.
8168	</desc>
8169	</param>
8170	</method>
8171
8172	<method name="removeHostOnlyNetworkInterface">
8173	<desc>
8174	Removes the given Host Only Networking interface.
8175	<result name="VBOX_E_OBJECT_NOT_FOUND">
8176	No host network interface matching @a id found.
8177	</result>
8178	</desc>
8179	<param name="id" type="uuid" mod="string" dir="in">
8180	<desc>
8181	Adapter GUID.
8182	</desc>
8183	</param>
8184	<param name="progress" type="IProgress" dir="return">
8185	<desc>
8186	Progress object to track the operation completion.
8187	</desc>
8188	</param>
8189	</method>
8190
8191	<method name="createUSBDeviceFilter">
8192	<desc>
8193	Creates a new USB device filter. All attributes except
8194	the filter name are set to empty (any match),
8195	<i>active</i> is @c false (the filter is not active).
8196
8197	The created filter can be added to the list of filters using
8198	<link to="#insertUSBDeviceFilter"/>.
8199
8200	<see><link to="#USBDeviceFilters"/></see>
8201	</desc>
8202	<param name="name" type="wstring" dir="in">
8203	<desc>
8204	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
8205	</desc>
8206	</param>
8207	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
8208	<desc>Created filter object.</desc>
8209	</param>
8210	</method>
8211
8212	<method name="insertUSBDeviceFilter">
8213	<desc>
8214	Inserts the given USB device to the specified position
8215	in the list of filters.
8216
8217	Positions are numbered starting from @c 0. If the specified
8218	position is equal to or greater than the number of elements in
8219	the list, the filter is added at the end of the collection.
8220
8221	<note>
8222	Duplicates are not allowed, so an attempt to insert a
8223	filter already in the list is an error.
8224	</note>
8225	<note>
8226	If USB functionality is not available in the given edition of
8227	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8228	</note>
8229
8230	<see><link to="#USBDeviceFilters"/></see>
8231
8232	<result name="VBOX_E_INVALID_OBJECT_STATE">
8233	USB device filter is not created within this VirtualBox instance.
8234	</result>
8235	<result name="E_INVALIDARG">
8236	USB device filter already in list.
8237	</result>
8238
8239	</desc>
8240	<param name="position" type="unsigned long" dir="in">
8241	<desc>Position to insert the filter to.</desc>
8242	</param>
8243	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
8244	<desc>USB device filter to insert.</desc>
8245	</param>
8246	</method>
8247
8248	<method name="removeUSBDeviceFilter">
8249	<desc>
8250	Removes a USB device filter from the specified position in the
8251	list of filters.
8252
8253	Positions are numbered starting from @c 0. Specifying a
8254	position equal to or greater than the number of elements in
8255	the list will produce an error.
8256
8257	<note>
8258	If USB functionality is not available in the given edition of
8259	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8260	</note>
8261
8262	<see><link to="#USBDeviceFilters"/></see>
8263
8264	<result name="E_INVALIDARG">
8265	USB device filter list empty or invalid @a position.
8266	</result>
8267
8268	</desc>
8269	<param name="position" type="unsigned long" dir="in">
8270	<desc>Position to remove the filter from.</desc>
8271	</param>
8272	</method>
8273
8274	<method name="findHostDVDDrive">
8275	<desc>
8276	Searches for a host DVD drive with the given @c name.
8277
8278	<result name="VBOX_E_OBJECT_NOT_FOUND">
8279	Given @c name does not correspond to any host drive.
8280	</result>
8281
8282	</desc>
8283	<param name="name" type="wstring" dir="in">
8284	<desc>Name of the host drive to search for</desc>
8285	</param>
8286	<param name="drive" type="IMedium" dir="return">
8287	<desc>Found host drive object</desc>
8288	</param>
8289	</method>
8290
8291	<method name="findHostFloppyDrive">
8292	<desc>
8293	Searches for a host floppy drive with the given @c name.
8294
8295	<result name="VBOX_E_OBJECT_NOT_FOUND">
8296	Given @c name does not correspond to any host floppy drive.
8297	</result>
8298
8299	</desc>
8300	<param name="name" type="wstring" dir="in">
8301	<desc>Name of the host floppy drive to search for</desc>
8302	</param>
8303	<param name="drive" type="IMedium" dir="return">
8304	<desc>Found host floppy drive object</desc>
8305	</param>
8306	</method>
8307
8308	<method name="findHostNetworkInterfaceByName">
8309	<desc>
8310	Searches through all host network interfaces for an interface with
8311	the given @c name.
8312	<note>
8313	The method returns an error if the given @c name does not
8314	correspond to any host network interface.
8315	</note>
8316	</desc>
8317	<param name="name" type="wstring" dir="in">
8318	<desc>Name of the host network interface to search for.</desc>
8319	</param>
8320	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8321	<desc>Found host network interface object.</desc>
8322	</param>
8323	</method>
8324	<method name="findHostNetworkInterfaceById">
8325	<desc>
8326	Searches through all host network interfaces for an interface with
8327	the given GUID.
8328	<note>
8329	The method returns an error if the given GUID does not
8330	correspond to any host network interface.
8331	</note>
8332	</desc>
8333	<param name="id" type="uuid" mod="string" dir="in">
8334	<desc>GUID of the host network interface to search for.</desc>
8335	</param>
8336	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8337	<desc>Found host network interface object.</desc>
8338	</param>
8339	</method>
8340	<method name="findHostNetworkInterfacesOfType">
8341	<desc>
8342	Searches through all host network interfaces and returns a list of interfaces of the specified type
8343	</desc>
8344	<param name="type" type="HostNetworkInterfaceType" dir="in">
8345	<desc>type of the host network interfaces to search for.</desc>
8346	</param>
8347	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
8348	<desc>Found host network interface objects.</desc>
8349	</param>
8350	</method>
8351
8352	<method name="findUSBDeviceById">
8353	<desc>
8354	Searches for a USB device with the given UUID.
8355
8356	<result name="VBOX_E_OBJECT_NOT_FOUND">
8357	Given @c id does not correspond to any USB device.
8358	</result>
8359
8360	<see><link to="IUSBDevice::id"/></see>
8361	</desc>
8362	<param name="id" type="uuid" mod="string" dir="in">
8363	<desc>UUID of the USB device to search for.</desc>
8364	</param>
8365	<param name="device" type="IHostUSBDevice" dir="return">
8366	<desc>Found USB device object.</desc>
8367	</param>
8368	</method>
8369
8370	<method name="findUSBDeviceByAddress">
8371	<desc>
8372	Searches for a USB device with the given host address.
8373
8374	<result name="VBOX_E_OBJECT_NOT_FOUND">
8375	Given @c name does not correspond to any USB device.
8376	</result>
8377
8378	<see><link to="IUSBDevice::address"/></see>
8379	</desc>
8380	<param name="name" type="wstring" dir="in">
8381	<desc>
8382	Address of the USB device (as assigned by the host) to
8383	search for.
8384	</desc>
8385	</param>
8386	<param name="device" type="IHostUSBDevice" dir="return">
8387	<desc>Found USB device object.</desc>
8388	</param>
8389	</method>
8390
8391	<method name="generateMACAddress">
8392	<desc>
8393	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
8394	</desc>
8395	<param name="address" type="wstring" dir="return">
8396	<desc>New Ethernet MAC address.</desc>
8397	</param>
8398	</method>
8399
8400	</interface>
8401
8402	<!--
8403	// ISystemProperties
8404	/////////////////////////////////////////////////////////////////////////
8405	-->
8406
8407	<interface
8408	name="ISystemProperties"
8409	extends="$unknown"
8410	uuid="413ea94c-efd9-491e-81fc-5df0c4d864bb"
8411	wsmap="managed"
8412	>
8413	<desc>
8414	The ISystemProperties interface represents global properties of the given
8415	VirtualBox installation.
8416
8417	These properties define limits and default values for various attributes
8418	and parameters. Most of the properties are read-only, but some can be
8419	changed by a user.
8420	</desc>
8421
8422	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
8423	<desc>Minimum guest system memory in Megabytes.</desc>
8424	</attribute>
8425
8426	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
8427	<desc>Maximum guest system memory in Megabytes.</desc>
8428	</attribute>
8429
8430	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
8431	<desc>Minimum guest video memory in Megabytes.</desc>
8432	</attribute>
8433
8434	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
8435	<desc>Maximum guest video memory in Megabytes.</desc>
8436	</attribute>
8437
8438	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
8439	<desc>Minimum CPU count.</desc>
8440	</attribute>
8441
8442	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
8443	<desc>Maximum CPU count.</desc>
8444	</attribute>
8445
8446	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
8447	<desc>Maximum of monitors which could be connected.</desc>
8448	</attribute>
8449
8450	<attribute name="infoVDSize" type="long long" readonly="yes">
8451	<desc>Maximum size of a virtual disk image in bytes. Informational value,
8452	does not reflect the limits of any virtual disk image format.</desc>
8453	</attribute>
8454
8455	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
8456	<desc>
8457	Maximum number of serial ports associated with every
8458	<link to="IMachine"/> instance.
8459	</desc>
8460	</attribute>
8461
8462	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
8463	<desc>
8464	Maximum number of parallel ports associated with every
8465	<link to="IMachine"/> instance.
8466	</desc>
8467	</attribute>
8468
8469	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
8470	<desc>
8471	Maximum device position in the boot order. This value corresponds
8472	to the total number of devices a machine can boot from, to make it
8473	possible to include all possible devices to the boot list.
8474	<see><link to="IMachine::setBootOrder"/></see>
8475	</desc>
8476	</attribute>
8477
8478	<attribute name="defaultMachineFolder" type="wstring">
8479	<desc>
8480	Full path to the default directory used to create new or open
8481	existing machines when a machine settings file name contains no
8482	path.
8483
8484	Starting with VirtualBox 4.0, by default, this attribute contains
8485	the full path of folder named "VirtualBox VMs" in the user's
8486	home directory, which depends on the host platform.
8487
8488	When setting this attribute, a full path must be specified.
8489	Setting this property to @c null or an empty string or the
8490	special value "Machines" (for compatibility reasons) will restore
8491	that default value.
8492
8493	If the folder specified herein does not exist, it will be created
8494	automatically as needed.
8495
8496	<see>
8497	<link to="IVirtualBox::createMachine"/>,
8498	<link to="IVirtualBox::openMachine"/>
8499	</see>
8500	</desc>
8501	</attribute>
8502
8503	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8504	<desc>
8505	List of all medium storage formats supported by this VirtualBox
8506	installation.
8507
8508	Keep in mind that the medium format identifier
8509	(<link to="IMediumFormat::id"/>) used in other API calls like
8510	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8511	medium format is a case-insensitive string. This means that, for
8512	example, all of the following strings:
8513	<pre>
8514	"VDI"
8515	"vdi"
8516	"VdI"</pre>
8517	refer to the same medium format.
8518
8519	Note that the virtual medium framework is backend-based, therefore
8520	the list of supported formats depends on what backends are currently
8521	installed.
8522
8523	<see><link to="IMediumFormat"/></see>
8524	</desc>
8525	</attribute>
8526
8527	<attribute name="defaultHardDiskFormat" type="wstring">
8528	<desc>
8529	Identifier of the default medium format used by VirtualBox.
8530
8531	The medium format set by this attribute is used by VirtualBox
8532	when the medium format was not specified explicitly. One example is
8533	<link to="IVirtualBox::createHardDisk"/> with the empty
8534	format argument. A more complex example is implicit creation of
8535	differencing media when taking a snapshot of a virtual machine:
8536	this operation will try to use a format of the parent medium first
8537	and if this format does not support differencing media the default
8538	format specified by this argument will be used.
8539
8540	The list of supported medium formats may be obtained by the
8541	<link to="#mediumFormats"/> call. Note that the default medium
8542	format must have a capability to create differencing media;
8543	otherwise operations that create media implicitly may fail
8544	unexpectedly.
8545
8546	The initial value of this property is <tt>"VDI"</tt> in the current
8547	version of the VirtualBox product, but may change in the future.
8548
8549	<note>
8550	Setting this property to @c null or empty string will restore the
8551	initial value.
8552	</note>
8553
8554	<see>
8555	<link to="#mediumFormats"/>,
8556	<link to="IMediumFormat::id"/>,
8557	<link to="IVirtualBox::createHardDisk"/>
8558	</see>
8559	</desc>
8560	</attribute>
8561
8562	<attribute name="freeDiskSpaceWarning" type="long long">
8563	<desc>Issue a warning if the free disk space is below (or in some disk
8564	intensive operation is expected to go below) the given size in
8565	bytes.</desc>
8566	</attribute>
8567
8568	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8569	<desc>Issue a warning if the free disk space is below (or in some disk
8570	intensive operation is expected to go below) the given percentage.</desc>
8571	</attribute>
8572
8573	<attribute name="freeDiskSpaceError" type="long long">
8574	<desc>Issue an error if the free disk space is below (or in some disk
8575	intensive operation is expected to go below) the given size in
8576	bytes.</desc>
8577	</attribute>
8578
8579	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8580	<desc>Issue an error if the free disk space is below (or in some disk
8581	intensive operation is expected to go below) the given percentage.</desc>
8582	</attribute>
8583
8584	<attribute name="VRDEAuthLibrary" type="wstring">
8585	<desc>
8586	Library that provides authentication for Remote Desktop clients. The library
8587	is used if a virtual machine's authentication type is set to "external"
8588	in the VM RemoteDisplay configuration.
8589
8590	The system library extension (".DLL" or ".so") must be omitted.
8591	A full path can be specified; if not, then the library must reside on the
8592	system's default library path.
8593
8594	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8595	of that name in one of the default VirtualBox library directories.
8596
8597	For details about VirtualBox authentication libraries and how to implement
8598	them, please refer to the VirtualBox manual.
8599
8600	<note>
8601	Setting this property to @c null or empty string will restore the
8602	initial value.
8603	</note>
8604	</desc>
8605	</attribute>
8606
8607	<attribute name="webServiceAuthLibrary" type="wstring">
8608	<desc>
8609	Library that provides authentication for webservice clients. The library
8610	is used if a virtual machine's authentication type is set to "external"
8611	in the VM RemoteDisplay configuration and will be called from
8612	within the <link to="IWebsessionManager::logon" /> implementation.
8613
8614	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8615	there is no per-VM setting for this, as the webservice is a global
8616	resource (if it is running). Only for this setting (for the webservice),
8617	setting this value to a literal <tt>"null"</tt> string disables authentication,
8618	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8619	no matter what user name and password are supplied.
8620
8621	The initial value of this property is <tt>"VBoxAuth"</tt>,
8622	meaning that the webservice will use the same authentication
8623	library that is used by default for VRDE (again, see
8624	<link to="ISystemProperties::VRDEAuthLibrary" />).
8625	The format and calling convention of authentication libraries
8626	is the same for the webservice as it is for VRDE.
8627
8628	<note>
8629	Setting this property to @c null or empty string will restore the
8630	initial value.
8631	</note>
8632	</desc>
8633	</attribute>
8634
8635	<attribute name="defaultVRDEExtPack" type="wstring">
8636	<desc>
8637	The name of the extension pack providing the default VRDE.
8638
8639	This attribute is for choosing between multiple extension packs
8640	providing VRDE. If only one is installed, it will automatically be the
8641	default one. The attribute value can be empty if no VRDE extension
8642	pack is installed.
8643
8644	For details about VirtualBox Remote Desktop Extension and how to
8645	implement one, please refer to the VirtualBox SDK.
8646	</desc>
8647	</attribute>
8648
8649	<attribute name="logHistoryCount" type="unsigned long">
8650	<desc>
8651	This value specifies how many old release log files are kept.
8652	</desc>
8653	</attribute>
8654
8655	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8656	<desc>This value hold the default audio driver for the current
8657	system.</desc>
8658	</attribute>
8659
8660	<attribute name="autostartDatabasePath" type="wstring">
8661	<desc>
8662	The path to the autostart database. Depending on the host this might
8663	be a filesystem path or something else.
8664	</desc>
8665	</attribute>
8666
8667	<attribute name="defaultAdditionsISO" type="wstring">
8668	<desc>
8669	The path to the default Guest Additions ISO image. Can be empty if
8670	the location is not known in this installation.
8671	</desc>
8672	</attribute>
8673
8674	<attribute name="defaultFrontend" type="wstring">
8675	<desc>
8676	Selects which VM frontend should be used by default when launching
8677	a VM through the <link to="IMachine::launchVMProcess" /> method.
8678	Empty or @c null strings do not define a particular default, it is up
8679	to <link to="IMachine::launchVMProcess" /> to select one. See the
8680	description of <link to="IMachine::launchVMProcess" /> for the valid
8681	frontend types.
8682
8683	This global setting is overridden by the per-VM attribute
8684	<link to="IMachine::defaultFrontend" /> or a frontend type
8685	passed to <link to="IMachine::launchVMProcess" />.
8686	</desc>
8687	</attribute>
8688
8689	<method name="getMaxNetworkAdapters">
8690	<desc>
8691	Maximum total number of network adapters associated with every
8692	<link to="IMachine"/> instance.
8693	</desc>
8694
8695	<param name="chipset" type="ChipsetType" dir="in">
8696	<desc>The chipset type to get the value for.</desc>
8697	</param>
8698
8699
8700	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8701	<desc>The maximum total number of network adapters allowed.</desc>
8702	</param>
8703
8704	</method>
8705
8706	<method name="getMaxNetworkAdaptersOfType">
8707	<desc>
8708	Maximum number of network adapters of a given attachment type,
8709	associated with every <link to="IMachine"/> instance.
8710	</desc>
8711
8712	<param name="chipset" type="ChipsetType" dir="in">
8713	<desc>The chipset type to get the value for.</desc>
8714	</param>
8715
8716	<param name="type" type="NetworkAttachmentType" dir="in">
8717	<desc>Type of attachment.</desc>
8718	</param>
8719
8720	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8721	<desc>The maximum number of network adapters allowed for
8722	particular chipset and attachment type.</desc>
8723	</param>
8724
8725	</method>
8726
8727
8728	<method name="getMaxDevicesPerPortForStorageBus">
8729	<desc>Returns the maximum number of devices which can be attached to a port
8730	for the given storage bus.</desc>
8731
8732	<param name="bus" type="StorageBus" dir="in">
8733	<desc>The storage bus type to get the value for.</desc>
8734	</param>
8735
8736	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8737	<desc>The maximum number of devices which can be attached to the port for the given
8738	storage bus.</desc>
8739	</param>
8740	</method>
8741
8742	<method name="getMinPortCountForStorageBus">
8743	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8744
8745	<param name="bus" type="StorageBus" dir="in">
8746	<desc>The storage bus type to get the value for.</desc>
8747	</param>
8748
8749	<param name="minPortCount" type="unsigned long" dir="return">
8750	<desc>The minimum number of ports for the given storage bus.</desc>
8751	</param>
8752	</method>
8753
8754	<method name="getMaxPortCountForStorageBus">
8755	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8756
8757	<param name="bus" type="StorageBus" dir="in">
8758	<desc>The storage bus type to get the value for.</desc>
8759	</param>
8760
8761	<param name="maxPortCount" type="unsigned long" dir="return">
8762	<desc>The maximum number of ports for the given storage bus.</desc>
8763	</param>
8764	</method>
8765
8766	<method name="getMaxInstancesOfStorageBus">
8767	<desc>Returns the maximum number of storage bus instances which
8768	can be configured for each VM. This corresponds to the number of
8769	storage controllers one can have. Value may depend on chipset type
8770	used.</desc>
8771
8772	<param name="chipset" type="ChipsetType" dir="in">
8773	<desc>The chipset type to get the value for.</desc>
8774	</param>
8775
8776	<param name="bus" type="StorageBus" dir="in">
8777	<desc>The storage bus type to get the value for.</desc>
8778	</param>
8779
8780	<param name="maxInstances" type="unsigned long" dir="return">
8781	<desc>The maximum number of instances for the given storage bus.</desc>
8782	</param>
8783	</method>
8784
8785	<method name="getDeviceTypesForStorageBus">
8786	<desc>Returns list of all the supported device types
8787	(<link to="DeviceType"/>) for the given type of storage
8788	bus.</desc>
8789
8790	<param name="bus" type="StorageBus" dir="in">
8791	<desc>The storage bus type to get the value for.</desc>
8792	</param>
8793
8794	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8795	<desc>The list of all supported device types for the given storage bus.</desc>
8796	</param>
8797	</method>
8798
8799	<method name="getDefaultIoCacheSettingForStorageController">
8800	<desc>Returns the default I/O cache setting for the
8801	given storage controller</desc>
8802
8803	<param name="controllerType" type="StorageControllerType" dir="in">
8804	<desc>The storage controller to the setting for.</desc>
8805	</param>
8806
8807	<param name="enabled" type="boolean" dir="return">
8808	<desc>Returned flag indicating the default value</desc>
8809	</param>
8810	</method>
8811	</interface>
8812
8813	<!--
8814	// IGuest
8815	/////////////////////////////////////////////////////////////////////////
8816	-->
8817
8818	<interface
8819	name="IGuestOSType" extends="$unknown"
8820	uuid="6d968f9a-858b-4c50-bf17-241f069e94c2"
8821	wsmap="struct"
8822	>
8823	<desc>
8824	</desc>
8825
8826	<attribute name="familyId" type="wstring" readonly="yes">
8827	<desc>Guest OS family identifier string.</desc>
8828	</attribute>
8829
8830	<attribute name="familyDescription" type="wstring" readonly="yes">
8831	<desc>Human readable description of the guest OS family.</desc>
8832	</attribute>
8833
8834	<attribute name="id" type="wstring" readonly="yes">
8835	<desc>Guest OS identifier string.</desc>
8836	</attribute>
8837
8838	<attribute name="description" type="wstring" readonly="yes">
8839	<desc>Human readable description of the guest OS.</desc>
8840	</attribute>
8841
8842	<attribute name="is64Bit" type="boolean" readonly="yes">
8843	<desc>Returns @c true if the given OS is 64-bit</desc>
8844	</attribute>
8845
8846	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8847	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8848	</attribute>
8849
8850	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8851	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8852	</attribute>
8853
8854	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8855	<desc>Recommended RAM size in Megabytes.</desc>
8856	</attribute>
8857
8858	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8859	<desc>Recommended video RAM size in Megabytes.</desc>
8860	</attribute>
8861
8862	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8863	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8864	</attribute>
8865
8866	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8867	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8868	</attribute>
8869
8870	<attribute name="recommendedHDD" type="long long" readonly="yes">
8871	<desc>Recommended hard disk size in bytes.</desc>
8872	</attribute>
8873
8874	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8875	<desc>Returns recommended network adapter for this OS type.</desc>
8876	</attribute>
8877
8878	<attribute name="recommendedPAE" type="boolean" readonly="yes">
8879	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8880	</attribute>
8881
8882	<attribute name="recommendedDVDStorageController" type="StorageControllerType" readonly="yes">
8883	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8884	</attribute>
8885
8886	<attribute name="recommendedDVDStorageBus" type="StorageBus" readonly="yes">
8887	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8888	</attribute>
8889
8890	<attribute name="recommendedHDStorageController" type="StorageControllerType" readonly="yes">
8891	<desc>Recommended storage controller type for HD drives.</desc>
8892	</attribute>
8893
8894	<attribute name="recommendedHDStorageBus" type="StorageBus" readonly="yes">
8895	<desc>Recommended storage bus type for HD drives.</desc>
8896	</attribute>
8897
8898	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8899	<desc>Recommended firmware type.</desc>
8900	</attribute>
8901
8902	<attribute name="recommendedUSBHID" type="boolean" readonly="yes">
8903	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8904	</attribute>
8905
8906	<attribute name="recommendedHPET" type="boolean" readonly="yes">
8907	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8908	</attribute>
8909
8910	<attribute name="recommendedUSBTablet" type="boolean" readonly="yes">
8911	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8912	</attribute>
8913
8914	<attribute name="recommendedRTCUseUTC" type="boolean" readonly="yes">
8915	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8916	</attribute>
8917
8918	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8919	<desc>Recommended chipset type.</desc>
8920	</attribute>
8921
8922	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8923	<desc>Recommended audio type.</desc>
8924	</attribute>
8925
8926	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8927	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8928	</attribute>
8929
8930	<attribute name="recommendedUSB" type="boolean" readonly="yes">
8931	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8932	</attribute>
8933
8934	</interface>
8935
8936	<enum
8937	name="AdditionsFacilityType"
8938	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8939	>
8940	<desc>
8941	Guest Additions facility IDs.
8942	</desc>
8943
8944	<const name="None" value="0">
8945	<desc>No/invalid facility.</desc>
8946	</const>
8947	<const name="VBoxGuestDriver" value="20">
8948	<desc>VirtualBox base driver (VBoxGuest).</desc>
8949	</const>
8950	<const name="AutoLogon" value="90">
8951	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8952	</const>
8953	<const name="VBoxService" value="100">
8954	<desc>VirtualBox system service (VBoxService).</desc>
8955	</const>
8956	<const name="VBoxTrayClient" value="101">
8957	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8958	</const>
8959	<const name="Seamless" value="1000">
8960	<desc>Seamless guest desktop integration.</desc>
8961	</const>
8962	<const name="Graphics" value="1100">
8963	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8964	are not immediately acted on and guest display resizes are probably not initiated by
8965	the guest additions.
8966	</desc>
8967	</const>
8968	<const name="All" value="2147483646">
8969	<desc>All facilities selected.</desc>
8970	</const>
8971	</enum>
8972
8973	<enum
8974	name="AdditionsFacilityClass"
8975	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8976	>
8977	<desc>
8978	Guest Additions facility classes.
8979	</desc>
8980
8981	<const name="None" value="0">
8982	<desc>No/invalid class.</desc>
8983	</const>
8984	<const name="Driver" value="10">
8985	<desc>Driver.</desc>
8986	</const>
8987	<const name="Service" value="30">
8988	<desc>System service.</desc>
8989	</const>
8990	<const name="Program" value="50">
8991	<desc>Program.</desc>
8992	</const>
8993	<const name="Feature" value="100">
8994	<desc>Feature.</desc>
8995	</const>
8996	<const name="ThirdParty" value="999">
8997	<desc>Third party.</desc>
8998	</const>
8999	<const name="All" value="2147483646">
9000	<desc>All facility classes selected.</desc>
9001	</const>
9002	</enum>
9003
9004	<enum
9005	name="AdditionsFacilityStatus"
9006	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
9007	>
9008	<desc>
9009	Guest Additions facility states.
9010	</desc>
9011
9012	<const name="Inactive" value="0">
9013	<desc>Facility is not active.</desc>
9014	</const>
9015	<const name="Paused" value="1">
9016	<desc>Facility has been paused.</desc>
9017	</const>
9018	<const name="PreInit" value="20">
9019	<desc>Facility is preparing to initialize.</desc>
9020	</const>
9021	<const name="Init" value="30">
9022	<desc>Facility is initializing.</desc>
9023	</const>
9024	<const name="Active" value="50">
9025	<desc>Facility is up and running.</desc>
9026	</const>
9027	<const name="Terminating" value="100">
9028	<desc>Facility is shutting down.</desc>
9029	</const>
9030	<const name="Terminated" value="101">
9031	<desc>Facility successfully shut down.</desc>
9032	</const>
9033	<const name="Failed" value="800">
9034	<desc>Facility failed to start.</desc>
9035	</const>
9036	<const name="Unknown" value="999">
9037	<desc>Facility status is unknown.</desc>
9038	</const>
9039	</enum>
9040
9041	<interface
9042	name="IAdditionsFacility" extends="$unknown"
9043	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
9044	wsmap="struct"
9045	>
9046	<desc>
9047	Structure representing a Guest Additions facility.
9048	</desc>
9049
9050	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
9051	<desc>The class this facility is part of.</desc>
9052	</attribute>
9053
9054	<attribute name="lastUpdated" type="long long" readonly="yes">
9055	<desc>
9056	Time stamp of the last status update,
9057	in milliseconds since 1970-01-01 UTC.
9058	</desc>
9059	</attribute>
9060
9061	<attribute name="name" type="wstring" readonly="yes">
9062	<desc>The facility's friendly name.</desc>
9063	</attribute>
9064
9065	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
9066	<desc>The current status.</desc>
9067	</attribute>
9068
9069	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
9070	<desc>The facility's type ID.</desc>
9071	</attribute>
9072	</interface>
9073
9074	<enum
9075	name="AdditionsRunLevelType"
9076	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
9077	>
9078	<desc>
9079	Guest Additions run level type.
9080	</desc>
9081
9082	<const name="None" value="0">
9083	<desc>Guest Additions are not loaded.</desc>
9084	</const>
9085	<const name="System" value="1">
9086	<desc>Guest drivers are loaded.</desc>
9087	</const>
9088	<const name="Userland" value="2">
9089	<desc>Common components (such as application services) are loaded.</desc>
9090	</const>
9091	<const name="Desktop" value="3">
9092	<desc>Per-user desktop components are loaded.</desc>
9093	</const>
9094	</enum>
9095
9096	<enum
9097	name="AdditionsUpdateFlag"
9098	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
9099	>
9100	<desc>
9101	Guest Additions update flags.
9102	</desc>
9103
9104	<const name="None" value="0">
9105	<desc>No flag set.</desc>
9106	</const>
9107	<const name="WaitForUpdateStartOnly" value="1">
9108	<desc>Starts the regular updating process and waits until the
9109	actual Guest Additions update inside the guest was started.
9110	This can be necessary due to needed interaction with the guest
9111	OS during the installation phase.</desc>
9112	</const>
9113	</enum>
9114
9115	<enum
9116	name="GuestSessionStatus"
9117	uuid="ac2669da-4624-44f2-85b5-0b0bfb8d8673"
9118	>
9119	<desc>
9120	Guest session status. This enumeration represents possible values of
9121	the <link to="IGuestSession::status"/> attribute.
9122	</desc>
9123	<const name="Undefined" value="0">
9124	<desc>Guest session is in an undefined state.</desc>
9125	</const>
9126	<const name="Starting" value="10">
9127	<desc>Guest session is being started.</desc>
9128	</const>
9129	<const name="Started" value="100">
9130	<desc>Guest session has been started.</desc>
9131	</const>
9132	<const name="Terminating" value="480">
9133	<desc>Guest session is being terminated.</desc>
9134	</const>
9135	<const name="Terminated" value="500">
9136	<desc>Guest session terminated normally.</desc>
9137	</const>
9138	<const name="TimedOutKilled" value="512">
9139	<desc>Guest session timed out and was killed.</desc>
9140	</const>
9141	<const name="TimedOutAbnormally" value="513">
9142	<desc>Guest session timed out and was not killed successfully.</desc>
9143	</const>
9144	<const name="Down" value="600">
9145	<desc>Service/OS is stopping, guest session was killed.</desc>
9146	</const>
9147	<const name="Error" value="800">
9148	<desc>Something went wrong.</desc>
9149	</const>
9150	</enum>
9151
9152	<enum
9153	name="GuestSessionWaitForFlag"
9154	uuid="bb7a372a-f635-4e11-a81a-e707f3a52ef5"
9155	>
9156	<desc>
9157	Guest session waiting flags. Multiple flags can be combined.
9158	</desc>
9159
9160	<const name="None" value="0">
9161	<desc>No waiting flags specified. Do not use this.</desc>
9162	</const>
9163	<const name="Start" value="1">
9164	<desc>Wait for the guest session being started.</desc>
9165	</const>
9166	<const name="Terminate" value="2">
9167	<desc>Wait for the guest session being terminated.</desc>
9168	</const>
9169	<const name="Status" value="4">
9170	<desc>Wait for the next guest session status change.</desc>
9171	</const>
9172	</enum>
9173
9174	<enum
9175	name="GuestSessionWaitResult"
9176	uuid="c0f6a8a5-fdb6-42bf-a582-56c6f82bcd2d"
9177	>
9178	<desc>
9179	Guest session waiting results. Depending on the session waiting flags (for
9180	more information see <link to="GuestSessionWaitForFlag"/>) the waiting result
9181	can vary based on the session's current status.
9182
9183	To wait for a guest session to terminate after it has been
9184	created by <link to="IGuest::createSession"/> one would specify
9185	GuestSessionWaitResult_Terminate.
9186	</desc>
9187
9188	<const name="None" value="0">
9189	<desc>No result was returned. Not being used.</desc>
9190	</const>
9191	<const name="Start" value="1">
9192	<desc>The guest session has been started.</desc>
9193	</const>
9194	<const name="Terminate" value="2">
9195	<desc>The guest session has been terminated.</desc>
9196	</const>
9197	<const name="Status" value="3">
9198	<desc>
9199	The guest session has changed its status. The status then can
9200	be retrieved via <link to="IGuestSession::status"/>.
9201	</desc>
9202	</const>
9203	<const name="Error" value="4">
9204	<desc>Error while executing the process.</desc>
9205	</const>
9206	<const name="Timeout" value="5">
9207	<desc>
9208	The waiting operation timed out. This also will happen
9209	when no event has been occured matching the
9210	current waiting flags in a <link to="IGuestSession::waitFor"/> call.
9211	</desc>
9212	</const>
9213	<const name="WaitFlagNotSupported" value="6">
9214	<desc>
9215	A waiting flag specified in the <link to="IGuestSession::waitFor"/> call
9216	is not supported by the guest.
9217	</desc>
9218	</const>
9219	</enum>
9220
9221	<enum
9222	name="FileSeekType"
9223	uuid="1b73f4f3-3515-4073-a506-76878d9e2541"
9224	>
9225	<desc>
9226	File seeking types.
9227	</desc>
9228
9229	<const name="Set" value="0">
9230	<desc>Seek from the start of the file.</desc>
9231	</const>
9232	<const name="Current" value="1">
9233	<desc>Seek from the current file position.</desc>
9234	</const>
9235	</enum>
9236
9237	<enum
9238	name="ProcessInputFlag"
9239	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
9240	>
9241	<desc>
9242	Guest process input flags.
9243	</desc>
9244	<const name="None" value="0">
9245	<desc>No flag set.</desc>
9246	</const>
9247	<const name="EndOfFile" value="1">
9248	<desc>End of file (input) reached.</desc>
9249	</const>
9250	</enum>
9251
9252	<enum
9253	name="ProcessOutputFlag"
9254	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
9255	>
9256	<desc>
9257	Guest process output flags for specifying which
9258	type of output to retrieve.
9259	</desc>
9260	<const name="None" value="0">
9261	<desc>No flags set. Get output from stdout.</desc>
9262	</const>
9263	<const name="StdErr" value="1">
9264	<desc>Get output from stderr.</desc>
9265	</const>
9266	</enum>
9267
9268	<enum
9269	name="ProcessWaitForFlag"
9270	uuid="23b550c7-78e1-437e-98f0-65fd9757bcd2"
9271	>
9272	<desc>
9273	Process waiting flags. Multiple flags can be combined.
9274	</desc>
9275
9276	<const name="None" value="0">
9277	<desc>No waiting flags specified. Do not use this.</desc>
9278	</const>
9279	<const name="Start" value="1">
9280	<desc>Wait for the process being started.</desc>
9281	</const>
9282	<const name="Terminate" value="2">
9283	<desc>Wait for the process being terminated.</desc>
9284	</const>
9285	<const name="StdIn" value="4">
9286	<desc>Wait for stdin becoming available.</desc>
9287	</const>
9288	<const name="StdOut" value="8">
9289	<desc>Wait for data becoming available on stdout.</desc>
9290	</const>
9291	<const name="StdErr" value="16">
9292	<desc>Wait for data becoming available on stderr.</desc>
9293	</const>
9294	</enum>
9295
9296	<enum
9297	name="ProcessWaitResult"
9298	uuid="40719cbe-f192-4fe9-a231-6697b3c8e2b4"
9299	>
9300	<desc>
9301	Process waiting results. Depending on the process waiting flags (for
9302	more information see <link to="ProcessWaitForFlag"/>) the waiting result
9303	can vary based on the processes' current status.
9304
9305	To wait for a guest process to terminate after it has been
9306	created by <link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>
9307	one would specify ProcessWaitResult_Terminate.
9308
9309	If a guest process has been started with ProcessCreateFlag_WaitForStdOut
9310	a client can wait with ProcessWaitResult_StdOut for new data to arrive on
9311	stdout; same applies for ProcessCreateFlag_WaitForStdErr and
9312	ProcessWaitResult_StdErr.
9313	</desc>
9314
9315	<const name="None" value="0">
9316	<desc>No result was returned. Not being used.</desc>
9317	</const>
9318	<const name="Start" value="1">
9319	<desc>The process has been started.</desc>
9320	</const>
9321	<const name="Terminate" value="2">
9322	<desc>The process has been terminated.</desc>
9323	</const>
9324	<const name="Status" value="3">
9325	<desc>
9326	The process has changed its status. The status then can
9327	be retrieved via <link to="IProcess::status"/>.
9328	</desc>
9329	</const>
9330	<const name="Error" value="4">
9331	<desc>Error while executing the process.</desc>
9332	</const>
9333	<const name="Timeout" value="5">
9334	<desc>
9335	The waiting operation timed out. This also will happen
9336	when no event has been occured matching the
9337	current waiting flags in a <link to="IProcess::waitFor"/> call.
9338	</desc>
9339	</const>
9340	<const name="StdIn" value="6">
9341	<desc>
9342	The process signalled that stdin became available for writing
9343	and that the process awaits input now.</desc>
9344	</const>
9345	<const name="StdOut" value="7">
9346	<desc>Data on stdout became available for reading.</desc>
9347	</const>
9348	<const name="StdErr" value="8">
9349	<desc>Data on stderr became available for reading.</desc>
9350	</const>
9351	<const name="WaitFlagNotSupported" value="9">
9352	<desc>
9353	A waiting flag specified in the <link to="IProcess::waitFor"/> call
9354	is not supported by the guest.
9355	</desc>
9356	</const>
9357	</enum>
9358
9359	<enum
9360	name="CopyFileFlag"
9361	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
9362	>
9363	<desc>
9364	File copying flags.
9365	</desc>
9366	<const name="None" value="0">
9367	<desc>No flag set.</desc>
9368	</const>
9369	<const name="Recursive" value="1">
9370	<desc>Copy directories recursively.</desc>
9371	</const>
9372	<const name="Update" value="2">
9373	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
9374	</const>
9375	<const name="FollowLinks" value="4">
9376	<desc>Follow symbolic links.</desc>
9377	</const>
9378	</enum>
9379
9380	<enum
9381	name="DirectoryCreateFlag"
9382	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
9383	>
9384	<desc>
9385	Directory creation flags.
9386	</desc>
9387	<const name="None" value="0">
9388	<desc>No flag set.</desc>
9389	</const>
9390	<const name="Parents" value="1">
9391	<desc>No error if existing, make parent directories as needed.</desc>
9392	</const>
9393	</enum>
9394
9395	<enum
9396	name="DirectoryRemoveRecFlag"
9397	uuid="455aabf0-7692-48f6-9061-f21579b65769"
9398	>
9399	<desc>
9400	Directory recursive removement flags.
9401	</desc>
9402
9403	<const name="None" value="0">
9404	<desc>No flag set.</desc>
9405	</const>
9406	<const name="ContentAndDir" value="1">
9407	<desc>Delete the content of the directory and the directory itself.</desc>
9408	</const>
9409	<const name="ContentOnly" value="2">
9410	<desc>Only delete the content of the directory, omit the directory it self.</desc>
9411	</const>
9412	</enum>
9413
9414	<enum
9415	name="PathRenameFlag"
9416	uuid="f3baa09f-c758-453d-b91c-c7787d76351d"
9417	>
9418	<desc>
9419	Path renaming flags.
9420	</desc>
9421
9422	<const name="None" value="0">
9423	<desc>No flag set.</desc>
9424	</const>
9425	<const name="NoReplace" value="1">
9426	<desc>Do not replace anything.</desc>
9427	</const>
9428	<const name="Replace" value="2">
9429	<desc>This will replace attempt any target which isn't a directory.</desc>
9430	</const>
9431	<const name="NoSymlinks" value="4">
9432	<desc>Don't allow symbolic links as part of the path.</desc>
9433	</const>
9434	</enum>
9435
9436	<enum
9437	name="ProcessCreateFlag"
9438	uuid="35192799-bfde-405d-9bea-c735ab9998e4"
9439	>
9440	<desc>
9441	Guest process execution flags.
9442	</desc>
9443
9444	<const name="None" value="0">
9445	<desc>No flag set.</desc>
9446	</const>
9447	<const name="WaitForProcessStartOnly" value="1">
9448	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
9449	process itself then uses an infinite timeout.</desc>
9450	</const>
9451	<const name="IgnoreOrphanedProcesses" value="2">
9452	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
9453	</const>
9454	<const name="Hidden" value="4">
9455	<desc>Do not show the started process according to the guest OS guidelines.</desc>
9456	</const>
9457	<const name="NoProfile" value="8">
9458	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
9459	</const>
9460	<const name="WaitForStdOut" value="16">
9461	<desc>The guest process waits until all data from stdout is read out.</desc>
9462	</const>
9463	<const name="WaitForStdErr" value="32">
9464	<desc>The guest process waits until all data from stderr is read out.</desc>
9465	</const>
9466	<const name="ExpandArguments" value="64">
9467	<desc>Expands environment variables in process arguments.</desc>
9468	</const>
9469	</enum>
9470
9471	<enum
9472	name="ProcessPriority"
9473	uuid="ee8cac50-e232-49fe-806b-d1214d9c2e49"
9474	>
9475	<desc>
9476	Process priorities.
9477	</desc>
9478
9479	<const name="Invalid" value="0">
9480	<desc>Invalid priority, do not use.</desc>
9481	</const>
9482	<const name="Default" value="1">
9483	<desc>Default process priority determined by the OS.</desc>
9484	</const>
9485	</enum>
9486
9487	<enum
9488	name="SymlinkType"
9489	uuid="37794668-f8f1-4714-98a5-6f8fa2ed0118"
9490	>
9491	<desc>
9492	Symbolic link types.
9493	</desc>
9494
9495	<const name="Unknown" value="0">
9496	<desc>It is not known what is being targeted.</desc>
9497	</const>
9498	<const name="Directory" value="1">
9499	<desc>The link targets a directory.</desc>
9500	</const>
9501	<const name="File" value="2">
9502	<desc>The link targets a file (or whatever else).</desc>
9503	</const>
9504	</enum>
9505
9506	<enum
9507	name="SymlinkReadFlag"
9508	uuid="b7fe2b9d-790e-4b25-8adf-1ca33026931f"
9509	>
9510	<desc>
9511	Symbolic link reading flags.
9512	</desc>
9513
9514	<const name="None" value="0">
9515	<desc>No flags set.</desc>
9516	</const>
9517	<const name="NoSymlinks" value="1">
9518	<desc>Don't allow symbolic links as part of the path.</desc>
9519	</const>
9520	</enum>
9521
9522	<enum
9523	name="ProcessStatus"
9524	uuid="4d52368f-5b48-4bfe-b486-acf89139b52f"
9525	>
9526	<desc>
9527	Process execution statuses.
9528	</desc>
9529
9530	<const name="Undefined" value="0">
9531	<desc>Process is in an undefined state.</desc>
9532	</const>
9533	<const name="Starting" value="10">
9534	<desc>Process is being started.</desc>
9535	</const>
9536	<const name="Started" value="100">
9537	<desc>Process has been started.</desc>
9538	</const>
9539	<const name="Paused" value="110">
9540	<desc>Process has been paused.</desc>
9541	</const>
9542	<const name="Terminating" value="480">
9543	<desc>Process is being terminated.</desc>
9544	</const>
9545	<const name="TerminatedNormally" value="500">
9546	<desc>Process terminated normally.</desc>
9547	</const>
9548	<const name="TerminatedSignal" value="510">
9549	<desc>Process terminated via signal.</desc>
9550	</const>
9551	<const name="TerminatedAbnormally" value="511">
9552	<desc>Process terminated abnormally.</desc>
9553	</const>
9554	<const name="TimedOutKilled" value="512">
9555	<desc>Process timed out and was killed.</desc>
9556	</const>
9557	<const name="TimedOutAbnormally" value="513">
9558	<desc>Process timed out and was not killed successfully.</desc>
9559	</const>
9560	<const name="Down" value="600">
9561	<desc>Service/OS is stopping, process was killed.</desc>
9562	</const>
9563	<const name="Error" value="800">
9564	<desc>Something went wrong.</desc>
9565	</const>
9566	</enum>
9567
9568	<enum
9569	name="ProcessInputStatus"
9570	uuid="a4a0ef9c-29cc-4805-9803-c8215ae9da6c"
9571	>
9572	<desc>
9573	Process input statuses.
9574	</desc>
9575
9576	<const name="Undefined" value="0">
9577	<desc>Undefined state.</desc>
9578	</const>
9579	<const name="Broken" value="1">
9580	<desc>TODO</desc>
9581	</const>
9582	<const name="Available" value="10">
9583	<desc>TODO</desc>
9584	</const>
9585	<const name="Written" value="50">
9586	<desc>TODO</desc>
9587	</const>
9588	<const name="Overflow" value="100">
9589	<desc>TODO</desc>
9590	</const>
9591	</enum>
9592
9593	<enum
9594	name="FileStatus"
9595	uuid="8c86468b-b97b-4080-8914-e29f5b0abd2c"
9596	>
9597	<desc>
9598	File statuses.
9599	</desc>
9600
9601	<const name="Undefined" value="0">
9602	<desc>File is in an undefined state.</desc>
9603	</const>
9604	<const name="Opening" value="10">
9605	<desc>TODO</desc>
9606	</const>
9607	<const name="Open" value="100">
9608	<desc>TODO</desc>
9609	</const>
9610	<const name="Closing" value="150">
9611	<desc>TODO</desc>
9612	</const>
9613	<const name="Closed" value="200">
9614	<desc>TODO</desc>
9615	</const>
9616	<const name="Down" value="600">
9617	<desc>TODO</desc>
9618	</const>
9619	<const name="Error" value="800">
9620	<desc>Something went wrong.</desc>
9621	</const>
9622	</enum>
9623
9624	<enum
9625	name="FsObjType"
9626	uuid="a1ed437c-b3c3-4ca2-b19c-4239d658d5e8"
9627	>
9628	<desc>
9629	File system object type.
9630	</desc>
9631
9632	<const name="Undefined" value="0">
9633	<desc>Type is undefined / unknown.</desc>
9634	</const>
9635	<const name="FIFO" value="1">
9636	<desc>Named pipe.</desc>
9637	</const>
9638	<const name="DevChar" value="10">
9639	<desc>Character device.</desc>
9640	</const>
9641	<const name="DevBlock" value="11">
9642	<desc>Block device.</desc>
9643	</const>
9644	<const name="Directory" value="50">
9645	<desc>Directory.</desc>
9646	</const>
9647	<const name="File" value="80">
9648	<desc>File.</desc>
9649	</const>
9650	<const name="Symlink" value="100">
9651	<desc>Symlink.</desc>
9652	</const>
9653	<const name="Socket" value="200">
9654	<desc>Socket.</desc>
9655	</const>
9656	<const name="Whiteout" value="400">
9657	<desc>Whiteout.</desc>
9658	</const>
9659	</enum>
9660
9661	<enum
9662	name="DragAndDropAction"
9663	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
9664	>
9665	<desc>
9666	Possible actions within an Drag and Drop operation.
9667	</desc>
9668
9669	<const name="Ignore" value="0">
9670	<desc>Do nothing.</desc>
9671	</const>
9672
9673	<const name="Copy" value="1">
9674	<desc>Copy the item to the target.</desc>
9675	</const>
9676
9677	<const name="Move" value="2">
9678	<desc>Move the item to the target.</desc>
9679	</const>
9680
9681	<const name="Link" value="3">
9682	<desc>Link the item from within the target.</desc>
9683	</const>
9684	</enum>
9685
9686	<enum
9687	name="DirectoryOpenFlag"
9688	uuid="5138837a-8fd2-4194-a1b0-08f7bc3949d0"
9689	>
9690	<desc>
9691	Directory open flags.
9692	</desc>
9693	<const name="None" value="0">
9694	<desc>No flag set.</desc>
9695	</const>
9696	<const name="NoSymlinks" value="1">
9697	<desc>Don't allow symbolic links as part of the path.</desc>
9698	</const>
9699	</enum>
9700
9701	<interface
9702	name="IGuestErrorInfo" extends="$unknown"
9703	uuid="ab576a37-dcfc-4d80-9a73-493d15e293c4"
9704	wsmap="managed"
9705	>
9706	<desc>
9707	TODO
9708	</desc>
9709
9710	<attribute name="result" type="long" readonly="yes">
9711	<desc>TODO</desc>
9712	</attribute>
9713
9714	<attribute name="text" type="wstring" readonly="yes">
9715	<desc>TODO</desc>
9716	</attribute>
9717
9718	</interface>
9719
9720	<interface
9721	name="IGuestSession" extends="$unknown"
9722	uuid="c8e8607b-5e67-4073-8f14-146515d0c1ff"
9723	wsmap="managed"
9724	>
9725	<desc>
9726	A guest session represents one impersonated user account on the guest, so
9727	every operation will use the same credentials specified when creating
9728	the session object via <link to="IGuest::createSession"/>.
9729
9730	There can be a maximum of 32 sessions at once per VM. Each session keeps
9731	track of its started guest processes, opened guest files or guest directories.
9732	To work on guest files or directories a guest session offers methods to open
9733	or create such objects (see <link to="IGuestSession::fileOpen"/> or
9734	<link to="IGuestSession::directoryOpen"/> for example).
9735
9736	When done with either of these objects, including the guest session itself,
9737	use the appropriate close() method to let the object do its cleanup work.
9738
9739	Every guest session has its own environment variable block which gets
9740	automatically applied when starting a new guest process via
9741	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
9742	To override (or unset) certain environment variables already set by the
9743	guest session, one can specify a per-process environment block when using
9744	one of the both above mentioned process creation calls.
9745	</desc>
9746
9747	<attribute name="user" type="wstring" readonly="yes">
9748	<desc>Returns the user name used by this session to impersonate
9749	users on the guest.
9750	</desc>
9751	</attribute>
9752
9753	<attribute name="domain" type="wstring" readonly="yes">
9754	<desc>Returns the domain name used by this session to impersonate
9755	users on the guest.
9756	</desc>
9757	</attribute>
9758
9759	<attribute name="name" type="wstring" readonly="yes">
9760	<desc>Returns the session's friendly name.</desc>
9761	</attribute>
9762
9763	<attribute name="id" type="unsigned long" readonly="yes">
9764	<desc>Returns the internal session ID.</desc>
9765	</attribute>
9766
9767	<attribute name="timeout" type="unsigned long">
9768	<desc>
9769	Returns the session timeout (in ms).
9770	<result name="E_NOTIMPL">
9771	The method is not implemented yet.
9772	</result>
9773	</desc>
9774	</attribute>
9775
9776	<attribute name="status" type="GuestSessionStatus" readonly="yes">
9777	<desc>Returns the current session status.</desc>
9778	</attribute>
9779
9780	<attribute name="environment" type="wstring" safearray="yes">
9781	<desc>
9782	Returns the current session environment.
9783	</desc>
9784	</attribute>
9785
9786	<attribute name="processes" type="IGuestProcess" readonly="yes" safearray="yes">
9787	<desc>
9788	Returns all current guest processes.
9789	</desc>
9790	</attribute>
9791
9792	<attribute name="directories" type="IGuestDirectory" readonly="yes" safearray="yes">
9793	<desc>
9794	Returns all currently opened guest directories.
9795	</desc>
9796	</attribute>
9797
9798	<attribute name="files" type="IGuestFile" readonly="yes" safearray="yes">
9799	<desc>
9800	Returns all currently opened guest files.
9801	</desc>
9802	</attribute>
9803
9804	<attribute name="eventSource" type="IEventSource" readonly="yes">
9805	<desc>
9806	Event source for guest session events.
9807	</desc>
9808	</attribute>
9809
9810	<method name="close">
9811	<desc>
9812	Closes this session. All opened guest directories, files and
9813	processes which are not referenced by clients anymore will be
9814	uninitialized.
9815	</desc>
9816	</method>
9817
9818	<method name="copyFrom">
9819	<desc>
9820	Copies a file from guest to the host.
9821
9822	<result name="VBOX_E_IPRT_ERROR">
9823	Error starting the copy operation.
9824	</result>
9825	</desc>
9826	<param name="source" type="wstring" dir="in">
9827	<desc>Source file on the guest to copy to the host.</desc>
9828	</param>
9829	<param name="dest" type="wstring" dir="in">
9830	<desc>Destination file name on the host.</desc>
9831	</param>
9832	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9833	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9834	</param>
9835	<param name="progress" type="IProgress" dir="return">
9836	<desc>Progress object to track the operation completion.</desc>
9837	</param>
9838	</method>
9839
9840	<method name="copyTo">
9841	<desc>
9842	Copies a file from host to the guest.
9843
9844	<result name="VBOX_E_IPRT_ERROR">
9845	Error starting the copy operation.
9846	</result>
9847	</desc>
9848	<param name="source" type="wstring" dir="in">
9849	<desc>Source file on the host to copy to the guest.</desc>
9850	</param>
9851	<param name="dest" type="wstring" dir="in">
9852	<desc>Destination file name on the guest.</desc>
9853	</param>
9854	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9855	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9856	</param>
9857	<param name="progress" type="IProgress" dir="return">
9858	<desc>Progress object to track the operation completion.</desc>
9859	</param>
9860	</method>
9861
9862	<method name="directoryCreate">
9863	<desc>
9864	Create a directory on the guest.
9865
9866	<result name="VBOX_E_IPRT_ERROR">
9867	Error while creating the directory.
9868	</result>
9869	</desc>
9870	<param name="path" type="wstring" dir="in">
9871	<desc>Full path of directory to create.</desc>
9872	</param>
9873	<param name="mode" type="unsigned long" dir="in">
9874	<desc>File creation mode.</desc>
9875	</param>
9876	<param name="flags" type="DirectoryCreateFlag" dir="in" safearray="yes">
9877	<desc>Creation flags; see <link to="DirectoryCreateFlag"/> for more information.</desc>
9878	</param>
9879	</method>
9880
9881	<method name="directoryCreateTemp">
9882	<desc>
9883	Create a temporary directory on the guest.
9884
9885	<result name="VBOX_E_NOT_SUPPORTED">
9886	The operation is not possible as requested on this particular
9887	guest type.
9888	</result>
9889	<result name="E_INVALIDARG">
9890	Invalid argument. This includes an incorrectly formatted template,
9891	or a non-absolute path.
9892	</result>
9893	<result name="VBOX_E_IPRT_ERROR">
9894	The temporary directory could not be created. Possible reasons
9895	include a non-existing path or an insecure path when the secure
9896	option was requested.
9897	</result>
9898	</desc>
9899	<param name="templateName" type="wstring" dir="in">
9900	<desc>Template for the name of the directory to create. This must
9901	contain at least one 'X' character. The first group of consecutive
9902	'X' characters in the template will be replaced by a random
9903	alphanumeric string to produce a unique name.</desc>
9904	</param>
9905	<param name="mode" type="unsigned long" dir="in">
9906	<desc>The mode of the directory to create. Use 0700 unless there are
9907	reasons not to. This parameter is ignored if "secure" is specified.
9908	</desc>
9909	</param>
9910	<param name="path" type="wstring" dir="in">
9911	<desc>The absolute path to create the temporary directory in.</desc>
9912	</param>
9913	<param name="secure" type="boolean" dir="in">
9914	<desc>Whether to fail if the directory can not be securely created.
9915	Currently this means that another unprivileged user cannot
9916	manipulate the path specified or remove the temporary directory
9917	after it has been created. Also causes the mode specified to be
9918	ignored. May not be supported on all guest types.</desc>
9919	</param>
9920	<param name="directory" type="wstring" dir="return">
9921	<desc>On success this will contain the name of the directory created
9922	with full path.</desc>
9923	</param>
9924	</method>
9925
9926	<method name="directoryExists">
9927	<desc>
9928	Checks whether a directory exists on the guest or not.
9929
9930	<result name="VBOX_E_IPRT_ERROR">
9931	Error while checking existence of the directory specified.
9932	</result>
9933	</desc>
9934	<param name="path" type="wstring" dir="in">
9935	<desc>Directory to check existence for.</desc>
9936	</param>
9937	<param name="exists" type="boolean" dir="return">
9938	<desc>Returns @c true if the directory exists, @c false if not.</desc>
9939	</param>
9940	</method>
9941
9942	<method name="directoryOpen">
9943	<desc>
9944	Opens a directory and creates a <link to="IGuestDirectory"/> object that
9945	can be used for further operations.
9946
9947	<result name="VBOX_E_OBJECT_NOT_FOUND">
9948	Directory to open was not found.
9949	</result>
9950	<result name="VBOX_E_IPRT_ERROR">
9951	Error while opening the directory.
9952	</result>
9953	</desc>
9954	<param name="path" type="wstring" dir="in">
9955	<desc>Full path to file to open.</desc>
9956	</param>
9957	<param name="filter" type="wstring" dir="in">
9958	<desc>Open filter to apply. This can include wildcards like ? and *.</desc>
9959	</param>
9960	<param name="flags" type="DirectoryOpenFlag" dir="in" safearray="yes">
9961	<desc>Open flags; see <link to="DirectoryOpenFlag"/> for more information.</desc>
9962	</param>
9963	<param name="directory" type="IGuestDirectory" dir="return">
9964	<desc><link to="IGuestDirectory"/> object containing the opened directory.</desc>
9965	</param>
9966	</method>
9967
9968	<method name="directoryQueryInfo">
9969	<desc>
9970	Queries information of a directory on the guest.
9971
9972	<result name="VBOX_E_OBJECT_NOT_FOUND">
9973	Directory to query information for was not found.
9974	</result>
9975	<result name="VBOX_E_IPRT_ERROR">
9976	Error querying information.
9977	</result>
9978	</desc>
9979	<param name="path" type="wstring" dir="in">
9980	<desc>Directory to query information for.</desc>
9981	</param>
9982	<param name="info" type="IGuestFsObjInfo" dir="return">
9983	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
9984	</param>
9985	</method>
9986
9987	<method name="directoryRemove">
9988	<desc>
9989	Removes a guest directory if not empty.
9990
9991	<result name="E_NOTIMPL">
9992	The method is not implemented yet.
9993	</result>
9994	</desc>
9995	<param name="path" type="wstring" dir="in">
9996	<desc>Full path of directory to remove.</desc>
9997	</param>
9998	</method>
9999
10000	<method name="directoryRemoveRecursive">
10001	<desc>
10002	Removes a guest directory recursively.
10003
10004	<result name="E_NOTIMPL">
10005	The method is not implemented yet.
10006	</result>
10007	</desc>
10008	<param name="path" type="wstring" dir="in">
10009	<desc>Full path of directory to remove recursively.</desc>
10010	</param>
10011	<param name="flags" type="DirectoryRemoveRecFlag" dir="in" safearray="yes">
10012	<desc>Remove flags; see <link to="DirectoryRemoveRecFlag"/> for more information.</desc>
10013	</param>
10014	<param name="progress" type="IProgress" dir="return">
10015	<desc>Progress object to track the operation completion.</desc>
10016	</param>
10017	</method>
10018
10019	<method name="directoryRename">
10020	<desc>
10021	Renames a directory on the guest.
10022
10023	<result name="E_NOTIMPL">
10024	The method is not implemented yet.
10025	</result>
10026	</desc>
10027	<param name="source" type="wstring" dir="in">
10028	<desc>Source directory to rename.</desc>
10029	</param>
10030	<param name="dest" type="wstring" dir="in">
10031	<desc>Destination directory to rename the source to.</desc>
10032	</param>
10033	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
10034	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
10035	</param>
10036	</method>
10037
10038	<method name="directorySetACL">
10039	<desc>
10040	Sets the ACL (Access Control List) of a guest directory.
10041
10042	<result name="E_NOTIMPL">
10043	The method is not implemented yet.
10044	</result>
10045	</desc>
10046	<param name="path" type="wstring" dir="in">
10047	<desc>Full path of directory to set the ACL for.</desc>
10048	</param>
10049	<param name="acl" type="wstring" dir="in">
10050	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
10051	</param>
10052	</method>
10053
10054	<method name="environmentClear">
10055	<desc>
10056	Clears (deletes) all session environment variables.
10057
10058	<result name="VBOX_E_IPRT_ERROR">
10059	Error while clearing the session environment variables.
10060	</result>
10061	</desc>
10062	</method>
10063
10064	<method name="environmentGet">
10065	<desc>
10066	Gets the value of a session environment variable.
10067
10068	<result name="VBOX_E_IPRT_ERROR">
10069	Error while getting the value of the session environment variable.
10070	</result>
10071	</desc>
10072	<param name="name" type="wstring" dir="in">
10073	<desc>Name of session environment variable to get the value for.</desc>
10074	</param>
10075	<param name="value" type="wstring" dir="return">
10076	<desc>
10077	Value of the session environment variable specified. If this variable
10078	does not exist and empty value will be returned.
10079	</desc>
10080	</param>
10081	</method>
10082
10083	<method name="environmentSet">
10084	<desc>
10085	Sets a session environment variable.
10086
10087	<result name="VBOX_E_IPRT_ERROR">
10088	Error while setting the session environment variable.
10089	</result>
10090	</desc>
10091	<param name="name" type="wstring" dir="in">
10092	<desc>Name of session environment variable to set.</desc>
10093	</param>
10094	<param name="value" type="wstring" dir="in">
10095	<desc>Value to set the session environment variable to.</desc>
10096	</param>
10097	</method>
10098
10099	<method name="environmentUnset">
10100	<desc>
10101	Unsets session environment variable.
10102
10103	<result name="VBOX_E_IPRT_ERROR">
10104	Error while unsetting the session environment variable.
10105	</result>
10106	</desc>
10107	<param name="name" type="wstring" dir="in">
10108	<desc>Name of session environment variable to unset (clear).</desc>
10109	</param>
10110	</method>
10111
10112	<method name="fileCreateTemp">
10113	<desc>
10114	Creates a temporary file on the guest.
10115
10116	<result name="VBOX_E_NOT_SUPPORTED">
10117	The operation is not possible as requested on this particular
10118	guest type.
10119	</result>
10120	<result name="E_INVALIDARG">
10121	Invalid argument. This includes an incorrectly formatted template,
10122	or a non-absolute path.
10123	</result>
10124	<result name="VBOX_E_IPRT_ERROR">
10125	The temporary file could not be created. Possible reasons include
10126	a non-existing path or an insecure path when the secure
10127	option was requested.
10128	</result>
10129	</desc>
10130	<param name="templateName" type="wstring" dir="in">
10131	<desc>Template for the name of the file to create. This must contain
10132	at least one 'X' character. The first group of consecutive 'X'
10133	characters in the template will be replaced by a random
10134	alphanumeric string to produce a unique name.
10135	</desc>
10136	</param>
10137	<param name="mode" type="unsigned long" dir="in">
10138	<desc>The mode of the file to create. Use 0700 unless there are
10139	reasons not to. This parameter is ignored if "secure" is specified.
10140	</desc>
10141	</param>
10142	<param name="path" type="wstring" dir="in">
10143	<desc>The absolute path to create the temporary file in.</desc>
10144	</param>
10145	<param name="secure" type="boolean" dir="in">
10146	<desc>Whether to fail if the file can not be securely created.
10147	Currently this means that another unprivileged user cannot
10148	manipulate the path specified or remove the temporary file after
10149	it has been created. Also causes the mode specified to be ignored.
10150	May not be supported on all guest types.</desc>
10151	</param>
10152	<param name="file" type="IGuestFile" dir="return">
10153	<desc>On success this will contain an open file object for the new
10154	temporary file.
10155	</desc>
10156	</param>
10157	</method>
10158
10159	<method name="fileExists">
10160	<desc>
10161	Checks whether a file exists on the guest or not.
10162
10163	<result name="VBOX_E_IPRT_ERROR">
10164	Error while checking existence of the file specified.
10165	</result>
10166	</desc>
10167	<param name="path" type="wstring" dir="in">
10168	<desc>File to check existence for.</desc>
10169	</param>
10170	<param name="exists" type="boolean" dir="return">
10171	<desc>Returns @c true if the file exists, @c false if not.</desc>
10172	</param>
10173	</method>
10174
10175	<method name="fileRemove">
10176	<desc>
10177	Removes a single file on the guest.
10178
10179	<result name="VBOX_E_OBJECT_NOT_FOUND">
10180	File to remove was not found.
10181	</result>
10182	<result name="VBOX_E_IPRT_ERROR">
10183	Error while removing the file.
10184	</result>
10185	</desc>
10186	<param name="path" type="wstring" dir="in">
10187	<desc>Path to the file to remove.</desc>
10188	</param>
10189	</method>
10190
10191	<method name="fileOpen">
10192	<desc>
10193	Opens a file and creates a <link to="IGuestFile"/> object that
10194	can be used for further operations.
10195
10196	<result name="VBOX_E_OBJECT_NOT_FOUND">
10197	File to open was not found.
10198	</result>
10199	<result name="VBOX_E_IPRT_ERROR">
10200	Error while opening the file.
10201	</result>
10202	</desc>
10203	<param name="path" type="wstring" dir="in">
10204	<desc>Full path to file to open.</desc>
10205	</param>
10206	<param name="openMode" type="wstring" dir="in">
10207	<desc>The file open mode.</desc>
10208	</param>
10209	<param name="disposition" type="wstring" dir="in">
10210	<desc>The file disposition.</desc>
10211	</param>
10212	<param name="creationMode" type="unsigned long" dir="in">
10213	<desc>The file creation mode.</desc>
10214	</param>
10215	<param name="offset" type="long long" dir="in">
10216	<desc>The initial read/write offset.</desc>
10217	</param>
10218	<param name="file" type="IGuestFile" dir="return">
10219	<desc><link to="IGuestFile"/> object representing the opened file.</desc>
10220	</param>
10221	</method>
10222
10223	<method name="fileQueryInfo">
10224	<desc>
10225	Queries information of a file on the guest.
10226
10227	<result name="VBOX_E_OBJECT_NOT_FOUND">
10228	File to query information for was not found.
10229	</result>
10230	<result name="VBOX_E_IPRT_ERROR">
10231	Error querying information.
10232	</result>
10233	</desc>
10234	<param name="path" type="wstring" dir="in">
10235	<desc>File to query information for.</desc>
10236	</param>
10237	<param name="info" type="IGuestFsObjInfo" dir="return">
10238	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
10239	</param>
10240	</method>
10241
10242	<method name="fileQuerySize">
10243	<desc>
10244	Queries the size of a file on the guest.
10245
10246	<result name="VBOX_E_OBJECT_NOT_FOUND">
10247	File to rename was not found.
10248	</result>
10249	<result name="VBOX_E_IPRT_ERROR">
10250	Error querying file size.
10251	</result>
10252	</desc>
10253	<param name="path" type="wstring" dir="in">
10254	<desc>File to query the size for.</desc>
10255	</param>
10256	<param name="size" type="long long" dir="return">
10257	<desc>Queried file size.</desc>
10258	</param>
10259	</method>
10260
10261	<method name="fileRename">
10262	<desc>
10263	Renames a file on the guest.
10264
10265	<result name="E_NOTIMPL">
10266	The method is not implemented yet.
10267	</result>
10268	</desc>
10269	<param name="source" type="wstring" dir="in">
10270	<desc>Source file to rename.</desc>
10271	</param>
10272	<param name="dest" type="wstring" dir="in">
10273	<desc>Destination file to rename the source to.</desc>
10274	</param>
10275	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
10276	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
10277	</param>
10278	</method>
10279
10280	<method name="fileSetACL">
10281	<desc>
10282	Sets the ACL (Access Control List) of a file on the guest.
10283
10284	<result name="E_NOTIMPL">
10285	The method is not implemented yet.
10286	</result>
10287	</desc>
10288	<param name="file" type="wstring" dir="in">
10289	<desc>Full path of file to set the ACL for.</desc>
10290	</param>
10291	<param name="acl" type="wstring" dir="in">
10292	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
10293	</param>
10294	</method>
10295
10296	<method name="processCreate">
10297	<desc>
10298	Executes an existing program inside the guest VM.
10299
10300	<note>
10301	Starting at VirtualBox 4.2 guest process execution by default is limited
10302	to serve up to 255 guest processes at a time. If all 255 guest processes
10303	are still active and running, starting a new guest process will result in an
10304	appropriate error message.
10305
10306	If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
10307	is / are set, the guest process will not exit until all data from the specified
10308	stream(s) is / are read out.
10309
10310	To raise or lower the guest process execution limit, either the guest property
10311	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
10312	command line by specifying "--control-procs-max-kept" needs to be modified.
10313	A restart of the guest OS is required afterwards. To serve unlimited guest
10314	processes, a value of "0" needs to be set (not recommended).
10315	</note>
10316
10317	<result name="VBOX_E_IPRT_ERROR">
10318	Could not create process.
10319	</result>
10320	</desc>
10321	<param name="command" type="wstring" dir="in">
10322	<desc>
10323	Full path name of the command to execute on the guest; the
10324	commands has to exists in the guest VM in order to be executed.
10325	</desc>
10326	</param>
10327	<param name="arguments" type="wstring" dir="in" safearray="yes">
10328	<desc>Array of arguments passed to the execution command.</desc>
10329	</param>
10330	<param name="environment" type="wstring" dir="in" safearray="yes">
10331	<desc>
10332	Environment variables that can be set while the command is being
10333	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10334	variable just set its name ("NAME") without a value.
10335
10336	This parameter can be used to override environment variables set by
10337	the guest session, which will be applied to the newly started process
10338	in any case.
10339	</desc>
10340	</param>
10341	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10342	<desc>
10343	Process creation flags;
10344	see <link to="ProcessCreateFlag"/> for more information.
10345	</desc>
10346	</param>
10347	<param name="timeoutMS" type="unsigned long" dir="in">
10348	<desc>
10349	Timeout (in ms) to wait for the operation to complete.
10350	Pass 0 for an infinite timeout.
10351	</desc>
10352	</param>
10353	<param name="guestProcess" type="IGuestProcess" dir="return">
10354	<desc>Guest process object of the newly created process.</desc>
10355	</param>
10356	</method>
10357
10358	<method name="processCreateEx">
10359	<desc>
10360	Executes an existing program inside the guest VM. Extended version for
10361	also setting the process priority and affinity.
10362
10363	<note>
10364	Starting at VirtualBox 4.2 guest process execution by default is limited
10365	to serve up to 255 guest processes at a time. If all 255 guest processes
10366	are still active and running, starting a new guest process will result in an
10367	appropriate error message.
10368
10369	If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
10370	is / are set, the guest process will not exit until all data from the specified
10371	stream(s) is / are read out.
10372
10373	To raise or lower the guest process execution limit, either the guest property
10374	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
10375	command line by specifying "--control-procs-max-kept" needs to be modified.
10376	A restart of the guest OS is required afterwards. To serve unlimited guest
10377	processes, a value of "0" needs to be set (not recommended).
10378	</note>
10379
10380	<result name="VBOX_E_IPRT_ERROR">
10381	Could not create process.
10382	</result>
10383	</desc>
10384	<param name="command" type="wstring" dir="in">
10385	<desc>
10386	Full path name of the command to execute on the guest; the
10387	commands has to exists in the guest VM in order to be executed.
10388	</desc>
10389	</param>
10390	<param name="arguments" type="wstring" dir="in" safearray="yes">
10391	<desc>Array of arguments passed to the execution command.</desc>
10392	</param>
10393	<param name="environment" type="wstring" dir="in" safearray="yes">
10394	<desc>
10395	Environment variables that can be set while the command is being
10396	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10397	variable just set its name ("NAME") without a value.
10398
10399	This parameter can be used to override environment variables set by
10400	the guest session, which will be applied to the newly started process
10401	in any case.
10402	</desc>
10403	</param>
10404	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10405	<desc>
10406	Process creation flags;
10407	see <link to="ProcessCreateFlag"/> for more information.
10408	</desc>
10409	</param>
10410	<param name="timeoutMS" type="unsigned long" dir="in">
10411	<desc>
10412	Timeout (in ms) to wait for the operation to complete.
10413	Pass 0 for an infinite timeout.
10414	</desc>
10415	</param>
10416	<param name="priority" type="ProcessPriority" dir="in">
10417	<desc>
10418	Process priority to use for execution;
10419	see see <link to="ProcessPriority"/> for more information.</desc>
10420	</param>
10421	<param name="affinity" type="long" dir="in" safearray="yes">
10422	<desc>
10423	Process affinity to use for execution. This parameter
10424	is not implemented yet.
10425	</desc>
10426	</param>
10427	<param name="guestProcess" type="IGuestProcess" dir="return">
10428	<desc>Guest process object of the newly created process.</desc>
10429	</param>
10430	</method>
10431
10432	<method name="processGet">
10433	<desc>
10434	Gets a certain guest process by its process ID (PID).
10435	</desc>
10436	<param name="pid" type="unsigned long" dir="in">
10437	<desc>Process ID (PID) to get guest process for.</desc>
10438	</param>
10439	<param name="guestProcess" type="IGuestProcess" dir="return">
10440	<desc>Guest process of specified process ID (PID).</desc>
10441	</param>
10442	</method>
10443
10444	<method name="symlinkCreate">
10445	<desc>
10446	Creates a symbolic link on the guest.
10447
10448	<result name="E_NOTIMPL">
10449	The method is not implemented yet.
10450	</result>
10451	</desc>
10452	<param name="source" type="wstring" dir="in">
10453	<desc>The name of the symbolic link.</desc>
10454	</param>
10455	<param name="target" type="wstring" dir="in">
10456	<desc>The path to the symbolic link target.</desc>
10457	</param>
10458	<param name="type" type="SymlinkType" dir="in">
10459	<desc>
10460	The symbolic link type;
10461	see <link to="SymlinkReadFlag"/> for more information.
10462	</desc>
10463	</param>
10464	</method>
10465
10466	<method name="symlinkExists">
10467	<desc>
10468	Checks whether a symbolic link exists on the guest or not.
10469
10470	<result name="E_NOTIMPL">
10471	The method is not implemented yet.
10472	</result>
10473	</desc>
10474	<param name="symlink" type="wstring" dir="in">
10475	<desc>Symbolic link to check existence for.</desc>
10476	</param>
10477	<param name="exists" type="boolean" dir="return">
10478	<desc>Returns @c true if the symbolic link exists, @c false if not.</desc>
10479	</param>
10480	</method>
10481
10482	<method name="symlinkRead">
10483	<desc>
10484	Reads a symbolic link on the guest.
10485
10486	<result name="E_NOTIMPL">
10487	The method is not implemented yet.
10488	</result>
10489	</desc>
10490	<param name="symlink" type="wstring" dir="in">
10491	<desc>Full path to symbolic link to read.</desc>
10492	</param>
10493	<param name="flags" type="SymlinkReadFlag" dir="in" safearray="yes">
10494	<desc>
10495	Read flags; see <link to="SymlinkReadFlag"/> for more information.
10496	</desc>
10497	</param>
10498	<param name="target" type="wstring" dir="return">
10499	<desc>
10500	Target of the symbolic link pointing to, if found.
10501	</desc>
10502	</param>
10503	</method>
10504
10505	<method name="symlinkRemoveDirectory">
10506	<desc>
10507	Removes a symbolic link on the guest if it's a directory.
10508
10509	<result name="E_NOTIMPL">
10510	The method is not implemented yet.
10511	</result>
10512	</desc>
10513	<param name="path" type="wstring" dir="in">
10514	<desc>Symbolic link to remove.</desc>
10515	</param>
10516	</method>
10517
10518	<method name="symlinkRemoveFile">
10519	<desc>
10520	Removes a symbolic link on the guest if it's a file.
10521
10522	<result name="E_NOTIMPL">
10523	The method is not implemented yet.
10524	</result>
10525	</desc>
10526	<param name="file" type="wstring" dir="in">
10527	<desc>Symbolic link to remove.</desc>
10528	</param>
10529	</method>
10530
10531	<method name="waitFor">
10532	<desc>
10533	Waits for one more events to happen.
10534	</desc>
10535	<param name="waitFor" type="unsigned long" dir="in">
10536	<desc>
10537	Specifies what to wait for;
10538	see <link to="GuestSessionWaitForFlag"/> for more information.
10539	</desc>
10540	</param>
10541	<param name="timeoutMS" type="unsigned long" dir="in">
10542	<desc>
10543	Timeout (in ms) to wait for the operation to complete.
10544	Pass 0 for an infinite timeout.
10545	</desc>
10546	</param>
10547	<param name="reason" type="GuestSessionWaitResult" dir="return">
10548	<desc>
10549	The overall wait result;
10550	see <link to="GuestSessionWaitResult"/> for more information.
10551	</desc>
10552	</param>
10553	</method>
10554
10555	<method name="waitForArray">
10556	<desc>
10557	Waits for one more events to happen.
10558	Scriptable version of <link to="#waitFor" />.
10559	</desc>
10560	<param name="waitFor" type="GuestSessionWaitForFlag" dir="in" safearray="yes">
10561	<desc>
10562	Specifies what to wait for;
10563	see <link to="GuestSessionWaitForFlag"/> for more information.
10564	</desc>
10565	</param>
10566	<param name="timeoutMS" type="unsigned long" dir="in">
10567	<desc>
10568	Timeout (in ms) to wait for the operation to complete.
10569	Pass 0 for an infinite timeout.
10570	</desc>
10571	</param>
10572	<param name="reason" type="GuestSessionWaitResult" dir="return">
10573	<desc>
10574	The overall wait result;
10575	see <link to="GuestSessionWaitResult"/> for more information.
10576	</desc>
10577	</param>
10578	</method>
10579
10580	</interface>
10581
10582	<interface
10583	name="IProcess" extends="$unknown"
10584	uuid="08864d56-96ab-418b-adbc-5a679532aeb0"
10585	wsmap="managed"
10586	>
10587	<desc>
10588	Abstract parent interface for processes handled by VirtualBox.
10589	</desc>
10590	<attribute name="PID" type="unsigned long" readonly="yes">
10591	<desc>
10592	The process ID (PID).
10593	</desc>
10594	</attribute>
10595	<attribute name="status" type="ProcessStatus" readonly="yes">
10596	<desc>
10597	The current process status; see <link to="ProcessStatus"/>
10598	for more information.
10599	</desc>
10600	</attribute>
10601	<attribute name="exitCode" type="long" readonly="yes">
10602	<desc>
10603	The exit code. Only available when the process has been
10604	terminated normally.
10605	</desc>
10606	</attribute>
10607	<attribute name="environment" type="wstring" readonly="yes" safearray="yes">
10608	<desc>
10609	The environment block this process is using during execution.
10610	</desc>
10611	</attribute>
10612	<attribute name="arguments" type="wstring" readonly="yes" safearray="yes">
10613	<desc>
10614	The arguments this process is using for execution.
10615	</desc>
10616	</attribute>
10617	<attribute name="executablePath" type="wstring" readonly="yes">
10618	<desc>Full path of the actual executable image.</desc>
10619	</attribute>
10620	<attribute name="name" type="wstring" readonly="yes">
10621	<desc>The friendly name of this process.</desc>
10622	</attribute>
10623
10624	<method name="waitFor">
10625	<desc>
10626	Waits for one more events to happen.
10627	</desc>
10628	<param name="waitFor" type="unsigned long" dir="in">
10629	<desc>
10630	Specifies what to wait for;
10631	see <link to="ProcessWaitForFlag"/> for more information.
10632	</desc>
10633	</param>
10634	<param name="timeoutMS" type="unsigned long" dir="in">
10635	<desc>
10636	Timeout (in ms) to wait for the operation to complete.
10637	Pass 0 for an infinite timeout.
10638	</desc>
10639	</param>
10640	<param name="reason" type="ProcessWaitResult" dir="return">
10641	<desc>
10642	The overall wait result;
10643	see <link to="ProcessWaitResult"/> for more information.
10644	</desc>
10645	</param>
10646	</method>
10647
10648	<method name="waitForArray">
10649	<desc>
10650	Waits for one more events to happen.
10651	Scriptable version of <link to="#waitFor" />.
10652	</desc>
10653	<param name="waitFor" type="ProcessWaitForFlag" dir="in" safearray="yes">
10654	<desc>
10655	Specifies what to wait for;
10656	see <link to="ProcessWaitForFlag"/> for more information.
10657	</desc>
10658	</param>
10659	<param name="timeoutMS" type="unsigned long" dir="in">
10660	<desc>
10661	Timeout (in ms) to wait for the operation to complete.
10662	Pass 0 for an infinite timeout.
10663	</desc>
10664	</param>
10665	<param name="reason" type="ProcessWaitResult" dir="return">
10666	<desc>
10667	The overall wait result;
10668	see <link to="ProcessWaitResult"/> for more information.
10669	</desc>
10670	</param>
10671	</method>
10672
10673	<method name="read">
10674	<desc>
10675	Reads data from a running process.
10676	</desc>
10677	<param name="handle" type="unsigned long" dir="in">
10678	<desc>Handle to read from. Usually 0 is stdin.</desc>
10679	</param>
10680	<param name="toRead" type="unsigned long" dir="in">
10681	<desc>Number of bytes to read.</desc>
10682	</param>
10683	<param name="timeoutMS" type="unsigned long" dir="in">
10684	<desc>
10685	Timeout (in ms) to wait for the operation to complete.
10686	Pass 0 for an infinite timeout.
10687	</desc>
10688	</param>
10689	<param name="data" type="octet" dir="return" safearray="yes">
10690	<desc>Array of data read.</desc>
10691	</param>
10692	</method>
10693
10694	<method name="write">
10695	<desc>
10696	Writes data to a running process.
10697	</desc>
10698	<param name="handle" type="unsigned long" dir="in">
10699	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10700	</param>
10701	<param name="flags" type="unsigned long" dir="in">
10702	<desc>
10703	A combination of <link to="ProcessInputFlag"/> flags.
10704	</desc>
10705	</param>
10706	<param name="data" type="octet" dir="in" safearray="yes">
10707	<desc>
10708	Array of bytes to write. The size of the array also specifies
10709	how much to write.
10710	</desc>
10711	</param>
10712	<param name="timeoutMS" type="unsigned long" dir="in">
10713	<desc>
10714	Timeout (in ms) to wait for the operation to complete.
10715	Pass 0 for an infinite timeout.
10716	</desc>
10717	</param>
10718	<param name="written" type="unsigned long" dir="return">
10719	<desc>How much bytes were written.</desc>
10720	</param>
10721	</method>
10722
10723	<method name="writeArray">
10724	<desc>
10725	Writes data to a running process.
10726	Scriptable version of <link to="#write" />.
10727	</desc>
10728	<param name="handle" type="unsigned long" dir="in">
10729	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10730	</param>
10731	<param name="flags" type="ProcessInputFlag" dir="in" safearray="yes">
10732	<desc>
10733	A combination of <link to="ProcessInputFlag"/> flags.
10734	</desc>
10735	</param>
10736	<param name="data" type="octet" dir="in" safearray="yes">
10737	<desc>
10738	Array of bytes to write. The size of the array also specifies
10739	how much to write.
10740	</desc>
10741	</param>
10742	<param name="timeoutMS" type="unsigned long" dir="in">
10743	<desc>
10744	Timeout (in ms) to wait for the operation to complete.
10745	Pass 0 for an infinite timeout.
10746	</desc>
10747	</param>
10748	<param name="written" type="unsigned long" dir="return">
10749	<desc>How much bytes were written.</desc>
10750	</param>
10751	</method>
10752
10753	<method name="terminate">
10754	<desc>
10755	Terminates (kills) a running process.
10756	</desc>
10757	</method>
10758	</interface>
10759
10760	<interface
10761	name="IGuestProcess" extends="IProcess"
10762	uuid="dfa39a36-5d43-4840-a025-67ea956b3111"
10763	wsmap="managed"
10764	>
10765	<desc>
10766	Implementation of the <link to="IProcess" /> object
10767	for processes on the guest.
10768	</desc>
10769	</interface>
10770
10771	<interface
10772	name="IDirectory" extends="$unknown"
10773	uuid="1b70dd03-26d7-483a-8877-89bbb0f87b70"
10774	wsmap="managed"
10775	>
10776	<desc>
10777	Abstract parent interface for directories handled by VirtualBox.
10778	</desc>
10779
10780	<attribute name="directoryName" type="wstring" readonly="yes">
10781	<desc>
10782	Full path of directory.
10783	</desc>
10784	</attribute>
10785
10786	<attribute name="filter" type="wstring" readonly="yes">
10787	<desc>
10788	The open filter.
10789	</desc>
10790	</attribute>
10791
10792	<method name="close">
10793	<desc>
10794	Closes this directory. After closing operations like reading the next
10795	directory entry will not be possible anymore.
10796	</desc>
10797	</method>
10798
10799	<method name="read">
10800	<desc>
10801	Reads the next directory entry of this directory.
10802	<result name="VBOX_E_OBJECT_NOT_FOUND">
10803	No more directory entries to read.
10804	</result>
10805	</desc>
10806	<param name="objInfo" type="IFsObjInfo" dir="return">
10807	<desc>Object information of the current directory entry read. Also see
10808	<link to="IFsObjInfo"/>.</desc>
10809	</param>
10810	</method>
10811	</interface>
10812
10813	<interface
10814	name="IGuestDirectory" extends="IDirectory"
10815	uuid="af4a8ce0-0725-42b7-8826-46e3c7ba7357"
10816	wsmap="managed"
10817	>
10818	<desc>
10819	Implementation of the <link to="IDirectory" /> object
10820	for directories on the guest.
10821	</desc>
10822	</interface>
10823
10824	<interface
10825	name="IFile" extends="$unknown"
10826	uuid="0b45a95f-6267-499e-a7f2-efa5f8e081f2"
10827	wsmap="managed"
10828	>
10829	<desc>
10830	Abstract parent interface for files handled by VirtualBox.
10831	</desc>
10832	<attribute name="status" type="FileStatus" readonly="yes">
10833	<desc>
10834	TODO
10835	</desc>
10836	</attribute>
10837	<attribute name="creationMode" type="unsigned long" readonly="yes">
10838	<desc>
10839	The creation mode.
10840	</desc>
10841	</attribute>
10842	<attribute name="disposition" type="unsigned long" readonly="yes">
10843	<desc>
10844	The disposition mode.
10845	</desc>
10846	</attribute>
10847	<attribute name="fileName" type="wstring" readonly="yes">
10848	<desc>
10849	Full path of the actual file name of this file.
10850	</desc>
10851	</attribute>
10852	<attribute name="initialSize" type="long long" readonly="yes">
10853	<desc>
10854	The initial size in bytes when opened.
10855	</desc>
10856	</attribute>
10857	<attribute name="openMode" type="unsigned long" readonly="yes">
10858	<desc>
10859	The open mode.
10860	</desc>
10861	</attribute>
10862	<attribute name="offset" type="long long" readonly="yes">
10863	<desc>
10864	Current read/write offset in bytes.
10865	</desc>
10866	</attribute>
10867
10868	<method name="close">
10869	<desc>
10870	Closes this file. After closing operations like reading data,
10871	writing data or querying information will not be possible anymore.
10872	</desc>
10873	</method>
10874
10875	<method name="queryInfo">
10876	<desc>
10877	Queries information about this file.
10878
10879	<result name="E_NOTIMPL">
10880	The method is not implemented yet.
10881	</result>
10882	</desc>
10883	<param name="objInfo" type="IFsObjInfo" dir="return">
10884	<desc>Object information of this file. Also see
10885	<link to="IFsObjInfo"/>.</desc>
10886	</param>
10887	</method>
10888
10889	<method name="read">
10890	<desc>
10891	Reads data from this file.
10892
10893	<result name="E_NOTIMPL">
10894	The method is not implemented yet.
10895	</result>
10896	</desc>
10897	<param name="toRead" type="unsigned long" dir="in">
10898	<desc>Number of bytes to read.</desc>
10899	</param>
10900	<param name="timeoutMS" type="unsigned long" dir="in">
10901	<desc>
10902	Timeout (in ms) to wait for the operation to complete.
10903	Pass 0 for an infinite timeout.
10904	</desc>
10905	</param>
10906	<param name="data" type="octet" dir="return" safearray="yes">
10907	<desc>Array of data read.</desc>
10908	</param>
10909	</method>
10910
10911	<method name="readAt">
10912	<desc>
10913	Reads data from an offset of this file.
10914
10915	<result name="E_NOTIMPL">
10916	The method is not implemented yet.
10917	</result>
10918	</desc>
10919	<param name="offset" type="long long" dir="in">
10920	<desc>Offset in bytes to start reading.</desc>
10921	</param>
10922	<param name="toRead" type="unsigned long" dir="in">
10923	<desc>Number of bytes to read.</desc>
10924	</param>
10925	<param name="timeoutMS" type="unsigned long" dir="in">
10926	<desc>
10927	Timeout (in ms) to wait for the operation to complete.
10928	Pass 0 for an infinite timeout.
10929	</desc>
10930	</param>
10931	<param name="data" type="octet" dir="return" safearray="yes">
10932	<desc>Array of data read.</desc>
10933	</param>
10934	</method>
10935
10936	<method name="seek">
10937	<desc>
10938	Changes the read and write position of this file.
10939
10940	<result name="E_NOTIMPL">
10941	The method is not implemented yet.
10942	</result>
10943	</desc>
10944	<param name="offset" type="long long" dir="in">
10945	<desc>Offset to seek.</desc>
10946	</param>
10947	<param name="whence" type="FileSeekType" dir="in">
10948	<desc>
10949	Seek mode; see <link to="FileSeekType"/> for more information.
10950	</desc>
10951	</param>
10952	</method>
10953
10954	<method name="setACL">
10955	<desc>
10956	Sets the ACL of this file.
10957
10958	<result name="E_NOTIMPL">
10959	The method is not implemented yet.
10960	</result>
10961	</desc>
10962	<param name="acl" type="wstring" dir="in">
10963	<desc>ACL string to set.</desc>
10964	</param>
10965	</method>
10966
10967	<method name="write">
10968	<desc>
10969	Writes bytes to this file.
10970	</desc>
10971	<param name="data" type="octet" dir="in" safearray="yes">
10972	<desc>
10973	Array of bytes to write. The size of the array also specifies
10974	how much to write.
10975	</desc>
10976	</param>
10977	<param name="timeoutMS" type="unsigned long" dir="in">
10978	<desc>
10979	Timeout (in ms) to wait for the operation to complete.
10980	Pass 0 for an infinite timeout.
10981	</desc>
10982	</param>
10983	<param name="written" type="unsigned long" dir="return">
10984	<desc>How much bytes were written.</desc>
10985	</param>
10986	</method>
10987
10988	<method name="writeAt">
10989	<desc>
10990	Writes bytes at a certain offset to this file.
10991
10992	<result name="E_NOTIMPL">
10993	The method is not implemented yet.
10994	</result>
10995	</desc>
10996	<param name="offset" type="long long" dir="in">
10997	<desc>Offset in bytes to start writing.</desc>
10998	</param>
10999	<param name="data" type="octet" dir="in" safearray="yes">
11000	<desc>
11001	Array of bytes to write. The size of the array also specifies
11002	how much to write.
11003	</desc>
11004	</param>
11005	<param name="timeoutMS" type="unsigned long" dir="in">
11006	<desc>
11007	Timeout (in ms) to wait for the operation to complete.
11008	Pass 0 for an infinite timeout.
11009	</desc>
11010	</param>
11011	<param name="written" type="unsigned long" dir="return">
11012	<desc>How much bytes were written.</desc>
11013	</param>
11014	</method>
11015
11016	</interface>
11017
11018	<interface
11019	name="IGuestFile" extends="IFile"
11020	uuid="60661aec-145f-4d11-b80e-8ea151598093"
11021	wsmap="managed"
11022	>
11023	<desc>
11024	Implementation of the <link to="IFile" /> object
11025	for files on the guest.
11026	</desc>
11027	</interface>
11028
11029	<interface
11030	name="IFsObjInfo" extends="$unknown"
11031	uuid="4047ba30-7006-4966-ae86-94164e5e20eb"
11032	wsmap="managed"
11033	>
11034	<desc>
11035	Abstract parent interface for VirtualBox file system object information.
11036	This can be information about a file or a directory, for example.
11037	</desc>
11038
11039	<attribute name="accessTime" type="long long" readonly="yes">
11040	<desc>
11041	Time of last access (st_atime).
11042	</desc>
11043	</attribute>
11044	<attribute name="allocatedSize" type="long long" readonly="yes">
11045	<desc>
11046	Disk allocation size (st_blocks * DEV_BSIZE).
11047	</desc>
11048	</attribute>
11049	<attribute name="birthTime" type="long long" readonly="yes">
11050	<desc>
11051	Time of file birth (st_birthtime).
11052	</desc>
11053	</attribute>
11054	<attribute name="changeTime" type="long long" readonly="yes">
11055	<desc>
11056	Time of last status change (st_ctime).
11057	</desc>
11058	</attribute>
11059	<attribute name="deviceNumber" type="unsigned long" readonly="yes">
11060	<desc>
11061	The device number of a character or block device type object (st_rdev).
11062	</desc>
11063	</attribute>
11064	<attribute name="fileAttributes" type="wstring" readonly="yes">
11065	<desc>
11066	File attributes. Not implemented yet.
11067	</desc>
11068	</attribute>
11069	<attribute name="generationId" type="unsigned long" readonly="yes">
11070	<desc>
11071	The current generation number (st_gen).
11072	</desc>
11073	</attribute>
11074	<attribute name="GID" type="unsigned long" readonly="yes">
11075	<desc>
11076	The group the filesystem object is assigned (st_gid).
11077	</desc>
11078	</attribute>
11079	<attribute name="groupName" type="wstring" readonly="yes">
11080	<desc>
11081	The group name.
11082	</desc>
11083	</attribute>
11084	<attribute name="hardLinks" type="unsigned long" readonly="yes">
11085	<desc>
11086	Number of hard links to this filesystem object (st_nlink).
11087	</desc>
11088	</attribute>
11089	<attribute name="modificationTime" type="long long" readonly="yes">
11090	<desc>
11091	Time of last data modification (st_mtime).
11092	</desc>
11093	</attribute>
11094	<attribute name="name" type="wstring" readonly="yes">
11095	<desc>
11096	The object's name.
11097	</desc>
11098	</attribute>
11099	<attribute name="nodeId" type="long long" readonly="yes">
11100	<desc>
11101	The unique identifier (within the filesystem) of this filesystem object (st_ino).
11102	</desc>
11103	</attribute>
11104	<attribute name="nodeIdDevice" type="unsigned long" readonly="yes">
11105	<desc>
11106	The device number of the device which this filesystem object resides on (st_dev).
11107	</desc>
11108	</attribute>
11109	<attribute name="objectSize" type="long long" readonly="yes">
11110	<desc>
11111	The logical size (st_size). For normal files this is the size of the file.
11112	For symbolic links, this is the length of the path name contained in the
11113	symbolic link. For other objects this fields needs to be specified.
11114	</desc>
11115	</attribute>
11116	<attribute name="type" type="FsObjType" readonly="yes">
11117	<desc>
11118	The object type. See <link to="FsObjType" /> for more.
11119	</desc>
11120	</attribute>
11121	<attribute name="UID" type="unsigned long" readonly="yes">
11122	<desc>
11123	The user owning the filesystem object (st_uid).
11124	</desc>
11125	</attribute>
11126	<attribute name="userFlags" type="unsigned long" readonly="yes">
11127	<desc>
11128	User flags (st_flags).
11129	</desc>
11130	</attribute>
11131	<attribute name="userName" type="wstring" readonly="yes">
11132	<desc>
11133	The user name.
11134	</desc>
11135	</attribute>
11136
11137	</interface>
11138
11139	<interface
11140	name="IGuestFsObjInfo" extends="IFsObjInfo"
11141	uuid="d5cf678e-3484-4e4a-ac55-329e15462e18"
11142	wsmap="managed"
11143	>
11144	<desc>
11145	Represents the guest implementation of the
11146	<link to="IFsObjInfo" /> object.
11147	</desc>
11148	</interface>
11149
11150	<interface
11151	name="IGuest" extends="$unknown"
11152	uuid="19c32350-0618-4ede-b0c3-2b4311bf0d9b"
11153	wsmap="managed"
11154	>
11155	<desc>
11156	The IGuest interface represents information about the operating system
11157	running inside the virtual machine. Used in
11158	<link to="IConsole::guest"/>.
11159
11160	IGuest provides information about the guest operating system, whether
11161	Guest Additions are installed and other OS-specific virtual machine
11162	properties.
11163	</desc>
11164
11165	<attribute name="OSTypeId" type="wstring" readonly="yes">
11166	<desc>
11167	Identifier of the Guest OS type as reported by the Guest
11168	Additions.
11169	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
11170	an IGuestOSType object representing details about the given
11171	Guest OS type.
11172	<note>
11173	If Guest Additions are not installed, this value will be
11174	the same as <link to="IMachine::OSTypeId"/>.
11175	</note>
11176	</desc>
11177	</attribute>
11178
11179	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
11180	<desc>
11181	Current run level of the Guest Additions.
11182	</desc>
11183	</attribute>
11184
11185	<attribute name="additionsVersion" type="wstring" readonly="yes">
11186	<desc>
11187	Version of the Guest Additions in the same format as
11188	<link to="IVirtualBox::version"/>.
11189	</desc>
11190	</attribute>
11191
11192	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
11193	<desc>
11194	The internal build revision number of the additions.
11195
11196	See also <link to="IVirtualBox::revision"/>.
11197	</desc>
11198	</attribute>
11199
11200	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
11201	<desc>
11202	Array of current known facilities. Only returns facilities where a status is known,
11203	e.g. facilities with an unknown status will not be returned.
11204	</desc>
11205	</attribute>
11206
11207	<attribute name="sessions" type="IGuestSession" readonly="yes" safearray="yes">
11208	<desc>Returns a collection of all opened guest sessions.</desc>
11209	</attribute>
11210
11211	<attribute name="memoryBalloonSize" type="unsigned long">
11212	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
11213	</attribute>
11214
11215	<attribute name="statisticsUpdateInterval" type="unsigned long">
11216	<desc>Interval to update guest statistics in seconds.</desc>
11217	</attribute>
11218
11219	<method name="internalGetStatistics">
11220	<desc>
11221	Internal method; do not use as it might change at any time.
11222	</desc>
11223	<param name="cpuUser" type="unsigned long" dir="out">
11224	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
11225	</param>
11226	<param name="cpuKernel" type="unsigned long" dir="out">
11227	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
11228	</param>
11229	<param name="cpuIdle" type="unsigned long" dir="out">
11230	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
11231	</param>
11232	<param name="memTotal" type="unsigned long" dir="out">
11233	<desc>Total amount of physical guest RAM.</desc>
11234	</param>
11235	<param name="memFree" type="unsigned long" dir="out">
11236	<desc>Free amount of physical guest RAM.</desc>
11237	</param>
11238	<param name="memBalloon" type="unsigned long" dir="out">
11239	<desc>Amount of ballooned physical guest RAM.</desc>
11240	</param>
11241	<param name="memShared" type="unsigned long" dir="out">
11242	<desc>Amount of shared physical guest RAM.</desc>
11243	</param>
11244	<param name="memCache" type="unsigned long" dir="out">
11245	<desc>Total amount of guest (disk) cache memory.</desc>
11246	</param>
11247	<param name="pagedTotal" type="unsigned long" dir="out">
11248	<desc>Total amount of space in the page file.</desc>
11249	</param>
11250	<param name="memAllocTotal" type="unsigned long" dir="out">
11251	<desc>Total amount of memory allocated by the hypervisor.</desc>
11252	</param>
11253	<param name="memFreeTotal" type="unsigned long" dir="out">
11254	<desc>Total amount of free memory available in the hypervisor.</desc>
11255	</param>
11256	<param name="memBalloonTotal" type="unsigned long" dir="out">
11257	<desc>Total amount of memory ballooned by the hypervisor.</desc>
11258	</param>
11259	<param name="memSharedTotal" type="unsigned long" dir="out">
11260	<desc>Total amount of shared memory in the hypervisor.</desc>
11261	</param>
11262	</method>
11263
11264	<method name="getFacilityStatus">
11265	<desc>
11266	Get the current status of a Guest Additions facility.
11267	</desc>
11268	<param name="facility" type="AdditionsFacilityType" dir="in">
11269	<desc>Facility to check status for.</desc>
11270	</param>
11271	<param name="timestamp" type="long long" dir="out">
11272	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
11273	</param>
11274	<param name="status" type="AdditionsFacilityStatus" dir="return">
11275	<desc>The current (latest) facility status.</desc>
11276	</param>
11277	</method>
11278
11279	<method name="getAdditionsStatus">
11280	<desc>
11281	Retrieve the current status of a certain Guest Additions run level.
11282
11283	<result name="VBOX_E_NOT_SUPPORTED">
11284	Wrong status level specified.
11285	</result>
11286
11287	</desc>
11288	<param name="level" type="AdditionsRunLevelType" dir="in">
11289	<desc>Status level to check</desc>
11290	</param>
11291	<param name="active" type="boolean" dir="return">
11292	<desc>Flag whether the status level has been reached or not</desc>
11293	</param>
11294	</method>
11295
11296	<method name="setCredentials">
11297	<desc>
11298	Store login credentials that can be queried by guest operating
11299	systems with Additions installed. The credentials are transient
11300	to the session and the guest may also choose to erase them. Note
11301	that the caller cannot determine whether the guest operating system
11302	has queried or made use of the credentials.
11303
11304	<result name="VBOX_E_VM_ERROR">
11305	VMM device is not available.
11306	</result>
11307
11308	</desc>
11309	<param name="userName" type="wstring" dir="in">
11310	<desc>User name string, can be empty</desc>
11311	</param>
11312	<param name="password" type="wstring" dir="in">
11313	<desc>Password string, can be empty</desc>
11314	</param>
11315	<param name="domain" type="wstring" dir="in">
11316	<desc>Domain name (guest logon scheme specific), can be empty</desc>
11317	</param>
11318	<param name="allowInteractiveLogon" type="boolean" dir="in">
11319	<desc>
11320	Flag whether the guest should alternatively allow the user to
11321	interactively specify different credentials. This flag might
11322	not be supported by all versions of the Additions.
11323	</desc>
11324	</param>
11325	</method>
11326
11327	<method name="dragHGEnter">
11328	<desc>
11329	Informs the guest about a Drag and Drop enter event.
11330
11331	This is used in Host - Guest direction.
11332
11333	<result name="VBOX_E_VM_ERROR">
11334	VMM device is not available.
11335	</result>
11336
11337	</desc>
11338	<param name="screenId" type="unsigned long" dir="in">
11339	<desc>The screen id where the Drag and Drop event occured.</desc>
11340	</param>
11341	<param name="y" type="unsigned long" dir="in">
11342	<desc>y-position of the event.</desc>
11343	</param>
11344	<param name="x" type="unsigned long" dir="in">
11345	<desc>x-position of the event.</desc>
11346	</param>
11347	<param name="defaultAction" type="DragAndDropAction" dir="in">
11348	<desc>The default action to use.</desc>
11349	</param>
11350	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11351	<desc>The actions which are allowed.</desc>
11352	</param>
11353	<param name="formats" type="wstring" dir="in" safearray="yes">
11354	<desc>The supported mime types.</desc>
11355	</param>
11356	<param name="resultAction" type="DragAndDropAction" dir="return">
11357	<desc>The resulting action of this event.</desc>
11358	</param>
11359	</method>
11360
11361	<method name="dragHGMove">
11362	<desc>
11363	Informs the guest about a Drag and Drop move event.
11364
11365	This is used in Host - Guest direction.
11366
11367	<result name="VBOX_E_VM_ERROR">
11368	VMM device is not available.
11369	</result>
11370
11371	</desc>
11372	<param name="screenId" type="unsigned long" dir="in">
11373	<desc>The screen id where the Drag and Drop event occured.</desc>
11374	</param>
11375	<param name="x" type="unsigned long" dir="in">
11376	<desc>x-position of the event.</desc>
11377	</param>
11378	<param name="y" type="unsigned long" dir="in">
11379	<desc>y-position of the event.</desc>
11380	</param>
11381	<param name="defaultAction" type="DragAndDropAction" dir="in">
11382	<desc>The default action to use.</desc>
11383	</param>
11384	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11385	<desc>The actions which are allowed.</desc>
11386	</param>
11387	<param name="formats" type="wstring" dir="in" safearray="yes">
11388	<desc>The supported mime types.</desc>
11389	</param>
11390	<param name="resultAction" type="DragAndDropAction" dir="return">
11391	<desc>The resulting action of this event.</desc>
11392	</param>
11393	</method>
11394
11395	<method name="dragHGLeave">
11396	<desc>
11397	Informs the guest about a Drag and Drop leave event.
11398
11399	This is used in Host - Guest direction.
11400
11401	<result name="VBOX_E_VM_ERROR">
11402	VMM device is not available.
11403	</result>
11404
11405	</desc>
11406	<param name="screenId" type="unsigned long" dir="in">
11407	<desc>The screen id where the Drag and Drop event occured.</desc>
11408	</param>
11409	</method>
11410
11411	<method name="dragHGDrop">
11412	<desc>
11413	Informs the guest about a drop event.
11414
11415	This is used in Host - Guest direction.
11416
11417	<result name="VBOX_E_VM_ERROR">
11418	VMM device is not available.
11419	</result>
11420
11421	</desc>
11422	<param name="screenId" type="unsigned long" dir="in">
11423	<desc>The screen id where the Drag and Drop event occured.</desc>
11424	</param>
11425	<param name="x" type="unsigned long" dir="in">
11426	<desc>x-position of the event.</desc>
11427	</param>
11428	<param name="y" type="unsigned long" dir="in">
11429	<desc>y-position of the event.</desc>
11430	</param>
11431	<param name="defaultAction" type="DragAndDropAction" dir="in">
11432	<desc>The default action to use.</desc>
11433	</param>
11434	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11435	<desc>The actions which are allowed.</desc>
11436	</param>
11437	<param name="formats" type="wstring" dir="in" safearray="yes">
11438	<desc>The supported mime types.</desc>
11439	</param>
11440	<param name="format" type="wstring" dir="out">
11441	<desc>The resulting format of this event.</desc>
11442	</param>
11443	<param name="resultAction" type="DragAndDropAction" dir="return">
11444	<desc>The resulting action of this event.</desc>
11445	</param>
11446	</method>
11447
11448	<method name="dragHGPutData">
11449	<desc>
11450	Informs the guest about a drop data event.
11451
11452	This is used in Host - Guest direction.
11453
11454	<result name="VBOX_E_VM_ERROR">
11455	VMM device is not available.
11456	</result>
11457
11458	</desc>
11459	<param name="screenId" type="unsigned long" dir="in">
11460	<desc>The screen id where the Drag and Drop event occured.</desc>
11461	</param>
11462	<param name="format" type="wstring" dir="in">
11463	<desc>The mime type the data is in.</desc>
11464	</param>
11465	<param name="data" type="octet" dir="in" safearray="yes">
11466	<desc>The actual data.</desc>
11467	</param>
11468	<param name="progress" type="IProgress" dir="return">
11469	<desc>Progress object to track the operation completion.</desc>
11470	</param>
11471	</method>
11472
11473	<method name="dragGHPending">
11474	<desc>
11475	Ask the guest if there is any Drag and Drop operation pending in the guest.
11476
11477	If no Drag and Drop operation is pending currently, Ignore is returned.
11478
11479	This is used in Guest - Host direction.
11480
11481	<result name="VBOX_E_VM_ERROR">
11482	VMM device is not available.
11483	</result>
11484
11485	</desc>
11486	<param name="screenId" type="unsigned long" dir="in">
11487	<desc>The screen id where the Drag and Drop event occured.</desc>
11488	</param>
11489	<param name="formats" type="wstring" dir="out" safearray="yes">
11490	<desc>On return the supported mime types.</desc>
11491	</param>
11492	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
11493	<desc>On return the actions which are allowed.</desc>
11494	</param>
11495	<param name="defaultAction" type="DragAndDropAction" dir="return">
11496	<desc>On return the default action to use.</desc>
11497	</param>
11498	</method>
11499
11500	<method name="dragGHDropped">
11501	<desc>
11502	Informs the guest that a drop event occured for a pending Drag and Drop event.
11503
11504	This is used in Guest - Host direction.
11505
11506	<result name="VBOX_E_VM_ERROR">
11507	VMM device is not available.
11508	</result>
11509
11510	</desc>
11511
11512	<param name="format" type="wstring" dir="in">
11513	<desc>The mime type the data must be in.</desc>
11514	</param>
11515	<param name="action" type="DragAndDropAction" dir="in">
11516	<desc>The action to use.</desc>
11517	</param>
11518	<param name="progress" type="IProgress" dir="return">
11519	<desc>Progress object to track the operation completion.</desc>
11520	</param>
11521	</method>
11522
11523	<method name="dragGHGetData">
11524	<desc>
11525	Fetch the data of a previously Drag and Drop event from the guest.
11526
11527	This is used in Guest - Host direction.
11528
11529	<result name="VBOX_E_VM_ERROR">
11530	VMM device is not available.
11531	</result>
11532
11533	</desc>
11534
11535	<param name="data" type="octet" safearray="yes" dir="return">
11536	<desc>The actual data.</desc>
11537	</param>
11538	</method>
11539
11540	<method name="createSession">
11541	<desc>
11542	Creates a new guest session for controlling the guest.
11543
11544	A guest session represents one impersonated user account on the guest, so
11545	every operation will use the same credentials specified when creating
11546	the session object via <link to="IGuest::createSession"/>. Anonymous
11547	sessions, that is, sessions without specifying a valid
11548	user account on the guest are not allowed due to security reasons.
11549
11550	There can be a maximum of 32 sessions at once per VM. Each session keeps
11551	track of its started guest processes, opened guest files or guest directories.
11552	To work on guest files or directories a guest session offers methods to open
11553	or create such objects (see <link to="IGuestSession::fileOpen"/> or
11554	<link to="IGuestSession::directoryOpen"/> for example).
11555
11556	When done with either of these objects, including the guest session itself,
11557	use the appropriate close() method to let the object do its cleanup work.
11558
11559	Every guest session has its own environment variable block which gets
11560	automatically applied when starting a new guest process via
11561	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
11562	To override (or unset) certain environment variables already set by the
11563	guest session, one can specify a per-process environment block when using
11564	one of the both above mentioned process creation calls.
11565
11566	Closing a session via <link to="IGuestSession::close" /> will try to close
11567	all the mentioned objects above unless these objects are still used by
11568	a client.
11569	</desc>
11570	<param name="user" type="wstring" dir="in">
11571	<desc>
11572	User name this session will be using to control the guest; has to exist
11573	and have the appropriate rights to execute programs in the VM. Must not
11574	be empty.
11575	</desc>
11576	</param>
11577	<param name="password" type="wstring" dir="in">
11578	<desc>
11579	Password of the user account to be used. Empty passwords are allowed.
11580	</desc>
11581	</param>
11582	<param name="domain" type="wstring" dir="in">
11583	<desc>
11584	Domain name of the user account to be used if the guest is part of
11585	a domain. Optional. This feature is not implemented yet.
11586	</desc>
11587	</param>
11588	<param name="sessionName" type="wstring" dir="in">
11589	<desc>
11590	The session's friendly name. Optional, can be empty.
11591	</desc>
11592	</param>
11593	<param name="guestSession" type="IGuestSession" dir="return">
11594	<desc>
11595	The newly created session object.
11596	</desc>
11597	</param>
11598	</method>
11599
11600	<method name="findSession">
11601	<desc>
11602	Finds guest sessions by their friendly name and returns an interface
11603	array with all found guest sessions.
11604	</desc>
11605	<param name="sessionName" type="wstring" dir="in">
11606	<desc>
11607	The session's friendly name to find. Wildcards like ? and * are allowed.
11608	</desc>
11609	</param>
11610	<param name="sessions" type="IGuestSession" safearray="yes" dir="return">
11611	<desc>
11612	Array with all guest sessions found matching the name specified.
11613	</desc>
11614	</param>
11615	</method>
11616
11617	<method name="updateGuestAdditions">
11618	<desc>
11619	Automatically updates already installed Guest Additions in a VM.
11620
11621	At the moment only Windows guests are supported.
11622
11623	Because the VirtualBox Guest Additions drivers are not WHQL-certified
11624	yet there might be warning dialogs during the actual Guest Additions
11625	update. These need to be confirmed manually in order to continue the
11626	installation process. This applies to Windows 2000 and Windows XP guests
11627	and therefore these guests can't be updated in a fully automated fashion
11628	without user interaction. However, to start a Guest Additions update for
11629	the mentioned Windows versions anyway, the flag
11630	AdditionsUpdateFlag_WaitForUpdateStartOnly can be specified. See
11631	<link to="AdditionsUpdateFlag"/> for more information.
11632
11633	<result name="VBOX_E_NOT_SUPPORTED">
11634	Guest OS is not supported for automated Guest Additions updates or the
11635	already installed Guest Additions are not ready yet.
11636	</result>
11637
11638	<result name="VBOX_E_IPRT_ERROR">
11639	Error while updating.
11640	</result>
11641
11642	</desc>
11643	<param name="source" type="wstring" dir="in">
11644	<desc>
11645	Path to the Guest Additions .ISO file to use for the upate.
11646	</desc>
11647	</param>
11648	<param name="flags" type="AdditionsUpdateFlag" dir="in" safearray="yes">
11649	<desc>
11650	<link to="AdditionsUpdateFlag"/> flags.
11651	</desc>
11652	</param>
11653	<param name="progress" type="IProgress" dir="return">
11654	<desc>Progress object to track the operation completion.</desc>
11655	</param>
11656	</method>
11657
11658	</interface>
11659
11660
11661	<!--
11662	// IProgress
11663	/////////////////////////////////////////////////////////////////////////
11664	-->
11665
11666	<interface
11667	name="IProgress" extends="$unknown"
11668	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
11669	wsmap="managed"
11670	>
11671	<desc>
11672	The IProgress interface is used to track and control
11673	asynchronous tasks within VirtualBox.
11674
11675	An instance of this is returned every time VirtualBox starts
11676	an asynchronous task (in other words, a separate thread) which
11677	continues to run after a method call returns. For example,
11678	<link to="IConsole::saveState" />, which saves the state of
11679	a running virtual machine, can take a long time to complete.
11680	To be able to display a progress bar, a user interface such as
11681	the VirtualBox graphical user interface can use the IProgress
11682	object returned by that method.
11683
11684	Note that IProgress is a "read-only" interface in the sense
11685	that only the VirtualBox internals behind the Main API can
11686	create and manipulate progress objects, whereas client code
11687	can only use the IProgress object to monitor a task's
11688	progress and, if <link to="#cancelable" /> is @c true,
11689	cancel the task by calling <link to="#cancel" />.
11690
11691	A task represented by IProgress consists of either one or
11692	several sub-operations that run sequentially, one by one (see
11693	<link to="#operation" /> and <link to="#operationCount" />).
11694	Every operation is identified by a number (starting from 0)
11695	and has a separate description.
11696
11697	You can find the individual percentage of completion of the current
11698	operation in <link to="#operationPercent" /> and the
11699	percentage of completion of the task as a whole
11700	in <link to="#percent" />.
11701
11702	Similarly, you can wait for the completion of a particular
11703	operation via <link to="#waitForOperationCompletion" /> or
11704	for the completion of the whole task via
11705	<link to="#waitForCompletion" />.
11706	</desc>
11707
11708	<attribute name="id" type="uuid" mod="string" readonly="yes">
11709	<desc>ID of the task.</desc>
11710	</attribute>
11711
11712	<attribute name="description" type="wstring" readonly="yes">
11713	<desc>Description of the task.</desc>
11714	</attribute>
11715
11716	<attribute name="initiator" type="$unknown" readonly="yes">
11717	<desc>Initiator of the task.</desc>
11718	</attribute>
11719
11720	<attribute name="cancelable" type="boolean" readonly="yes">
11721	<desc>Whether the task can be interrupted.</desc>
11722	</attribute>
11723
11724	<attribute name="percent" type="unsigned long" readonly="yes">
11725	<desc>
11726	Current progress value of the task as a whole, in percent.
11727	This value depends on how many operations are already complete.
11728	Returns 100 if <link to="#completed" /> is @c true.
11729	</desc>
11730	</attribute>
11731
11732	<attribute name="timeRemaining" type="long" readonly="yes">
11733	<desc>
11734	Estimated remaining time until the task completes, in
11735	seconds. Returns 0 once the task has completed; returns -1
11736	if the remaining time cannot be computed, in particular if
11737	the current progress is 0.
11738
11739	Even if a value is returned, the estimate will be unreliable
11740	for low progress values. It will become more reliable as the
11741	task progresses; it is not recommended to display an ETA
11742	before at least 20% of a task have completed.
11743	</desc>
11744	</attribute>
11745
11746	<attribute name="completed" type="boolean" readonly="yes">
11747	<desc>Whether the task has been completed.</desc>
11748	</attribute>
11749
11750	<attribute name="canceled" type="boolean" readonly="yes">
11751	<desc>Whether the task has been canceled.</desc>
11752	</attribute>
11753
11754	<attribute name="resultCode" type="long" readonly="yes">
11755	<desc>
11756	Result code of the progress task.
11757	Valid only if <link to="#completed"/> is @c true.
11758	</desc>
11759	</attribute>
11760
11761	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
11762	<desc>
11763	Extended information about the unsuccessful result of the
11764	progress operation. May be @c null if no extended information
11765	is available.
11766	Valid only if <link to="#completed"/> is @c true and
11767	<link to="#resultCode"/> indicates a failure.
11768	</desc>
11769	</attribute>
11770
11771	<attribute name="operationCount" type="unsigned long" readonly="yes">
11772	<desc>
11773	Number of sub-operations this task is divided into.
11774	Every task consists of at least one suboperation.
11775	</desc>
11776	</attribute>
11777
11778	<attribute name="operation" type="unsigned long" readonly="yes">
11779	<desc>Number of the sub-operation being currently executed.</desc>
11780	</attribute>
11781
11782	<attribute name="operationDescription" type="wstring" readonly="yes">
11783	<desc>
11784	Description of the sub-operation being currently executed.
11785	</desc>
11786	</attribute>
11787
11788	<attribute name="operationPercent" type="unsigned long" readonly="yes">
11789	<desc>Progress value of the current sub-operation only, in percent.</desc>
11790	</attribute>
11791
11792	<attribute name="operationWeight" type="unsigned long" readonly="yes">
11793	<desc>Weight value of the current sub-operation only.</desc>
11794	</attribute>
11795
11796	<attribute name="timeout" type="unsigned long">
11797	<desc>
11798	When non-zero, this specifies the number of milliseconds after which
11799	the operation will automatically be canceled. This can only be set on
11800	cancelable objects.
11801	</desc>
11802	</attribute>
11803
11804	<method name="setCurrentOperationProgress">
11805	<desc>Internal method, not to be called externally.</desc>
11806	<param name="percent" type="unsigned long" dir="in" />
11807	</method>
11808	<method name="setNextOperation">
11809	<desc>Internal method, not to be called externally.</desc>
11810	<param name="nextOperationDescription" type="wstring" dir="in" />
11811	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
11812	</method>
11813
11814	<method name="waitForCompletion">
11815	<desc>
11816	Waits until the task is done (including all sub-operations)
11817	with a given timeout in milliseconds; specify -1 for an indefinite wait.
11818
11819	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
11820	thread are not processed while waiting. Neglecting event queues may
11821	have dire consequences (degrade performance, resource hogs,
11822	deadlocks, etc.), this is specially so for the main thread on
11823	platforms using XPCOM. Callers are adviced wait for short periods
11824	and service their event queues between calls, or to create a worker
11825	thread to do the waiting.
11826
11827	<result name="VBOX_E_IPRT_ERROR">
11828	Failed to wait for task completion.
11829	</result>
11830	</desc>
11831
11832	<param name="timeout" type="long" dir="in">
11833	<desc>
11834	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11835	</desc>
11836	</param>
11837	</method>
11838
11839	<method name="waitForOperationCompletion">
11840	<desc>
11841	Waits until the given operation is done with a given timeout in
11842	milliseconds; specify -1 for an indefinite wait.
11843
11844	See <link to="#waitForCompletion"> for event queue considerations.</link>
11845
11846	<result name="VBOX_E_IPRT_ERROR">
11847	Failed to wait for operation completion.
11848	</result>
11849
11850	</desc>
11851	<param name="operation" type="unsigned long" dir="in">
11852	<desc>
11853	Number of the operation to wait for.
11854	Must be less than <link to="#operationCount"/>.
11855	</desc>
11856	</param>
11857	<param name="timeout" type="long" dir="in">
11858	<desc>
11859	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11860	</desc>
11861	</param>
11862	</method>
11863
11864	<method name="waitForAsyncProgressCompletion">
11865	<desc>
11866	Waits until the other task is completed (including all
11867	sub-operations) and forward all changes from the other progress to
11868	this progress. This means sub-operation number, description, percent
11869	and so on.
11870
11871	You have to take care on setting up at least the same count on
11872	sub-operations in this progress object like there are in the other
11873	progress object.
11874
11875	If the other progress object supports cancel and this object gets any
11876	cancel request (when here enabled as well), it will be forwarded to
11877	the other progress object.
11878
11879	If there is an error in the other progress, this error isn't
11880	automatically transfered to this progress object. So you have to
11881	check any operation error within the other progress object, after
11882	this method returns.
11883	</desc>
11884
11885	<param name="pProgressAsync" type="IProgress" dir="in">
11886	<desc>
11887	The progress object of the asynchrony process.
11888	</desc>
11889	</param>
11890	</method>
11891
11892	<method name="cancel">
11893	<desc>
11894	Cancels the task.
11895	<note>
11896	If <link to="#cancelable"/> is @c false, then this method will fail.
11897	</note>
11898
11899	<result name="VBOX_E_INVALID_OBJECT_STATE">
11900	Operation cannot be canceled.
11901	</result>
11902
11903	</desc>
11904	</method>
11905
11906	</interface>
11907
11908	<!--
11909	// ISnapshot
11910	/////////////////////////////////////////////////////////////////////////
11911	-->
11912
11913	<interface
11914	name="ISnapshot" extends="$unknown"
11915	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
11916	wsmap="managed"
11917	>
11918	<desc>
11919	The ISnapshot interface represents a snapshot of the virtual
11920	machine.
11921
11922	Together with the differencing media that are created
11923	when a snapshot is taken, a machine can be brought back to
11924	the exact state it was in when the snapshot was taken.
11925
11926	The ISnapshot interface has no methods, only attributes; snapshots
11927	are controlled through methods of the <link to="IConsole" /> interface
11928	which also manage the media associated with the snapshot.
11929	The following operations exist:
11930
11931	<ul>
11932	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
11933	by creating new, empty differencing images for the machine's
11934	media and saving the VM settings and (if the VM is running)
11935	the current VM state in the snapshot.
11936
11937	The differencing images will then receive all data written to
11938	the machine's media, while their parent (base) images
11939	remain unmodified after the snapshot has been taken (see
11940	<link to="IMedium" /> for details about differencing images).
11941	This simplifies restoring a machine to the state of a snapshot:
11942	only the differencing images need to be deleted.
11943
11944	The current machine state is not changed by taking a snapshot
11945	except that <link to="IMachine::currentSnapshot" /> is set to
11946	the newly created snapshot, which is also added to the machine's
11947	snapshots tree.
11948	</li>
11949
11950	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
11951	the state of a previous snapshot by deleting the differencing
11952	image of each of the machine's media and setting the machine's
11953	settings and state to the state that was saved in the snapshot (if any).
11954
11955	This destroys the machine's current state. After calling this,
11956	<link to="IMachine::currentSnapshot" /> points to the snapshot
11957	that was restored.
11958	</li>
11959
11960	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
11961	without affecting the current machine state.
11962
11963	This does not change the current machine state, but instead frees the
11964	resources allocated when the snapshot was taken: the settings and machine
11965	state file are deleted (if any), and the snapshot's differencing image for
11966	each of the machine's media gets merged with its parent image.
11967
11968	Neither the current machine state nor other snapshots are affected
11969	by this operation, except that parent media will be modified
11970	to contain the disk data associated with the snapshot being deleted.
11971
11972	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
11973	attribute is set to the current snapshot's parent or @c null if it
11974	has no parent. Otherwise the attribute is unchanged.
11975	</li>
11976	</ul>
11977
11978	Each snapshot contains a copy of virtual machine's settings (hardware
11979	configuration etc.). This copy is contained in an immutable (read-only)
11980	instance of <link to="IMachine" /> which is available from the snapshot's
11981	<link to="#machine" /> attribute. When restoring the snapshot, these
11982	settings are copied back to the original machine.
11983
11984	In addition, if the machine was running when the
11985	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
11986	the current VM state is saved in the snapshot (similarly to what happens
11987	when a VM's state is saved). The snapshot is then said to be <i>online</i>
11988	because when restoring it, the VM will be running.
11989
11990	If the machine was in <link to="MachineState_Saved">saved</link> saved,
11991	the snapshot receives a copy of the execution state file
11992	(<link to="IMachine::stateFilePath"/>).
11993
11994	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
11995	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
11996	it then contains a so-called "zero execution state", representing a
11997	machine that is powered off.
11998	</desc>
11999
12000	<attribute name="id" type="uuid" mod="string" readonly="yes">
12001	<desc>UUID of the snapshot.</desc>
12002	</attribute>
12003
12004	<attribute name="name" type="wstring">
12005	<desc>Short name of the snapshot.
12006	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
12007	be called implicitly.</note>
12008	</desc>
12009	</attribute>
12010
12011	<attribute name="description" type="wstring">
12012	<desc>Optional description of the snapshot.
12013	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
12014	be called implicitly.</note>
12015	</desc>
12016	</attribute>
12017
12018	<attribute name="timeStamp" type="long long" readonly="yes">
12019	<desc>
12020	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
12021	</desc>
12022	</attribute>
12023
12024	<attribute name="online" type="boolean" readonly="yes">
12025	<desc>
12026	@c true if this snapshot is an online snapshot and @c false otherwise.
12027
12028	When this attribute is @c true, the
12029	<link to="IMachine::stateFilePath"/> attribute of the
12030	<link to="#machine"/> object associated with this snapshot
12031	will point to the saved state file. Otherwise, it will be
12032	an empty string.
12033	</desc>
12034	</attribute>
12035
12036	<attribute name="machine" type="IMachine" readonly="yes">
12037	<desc>
12038	Virtual machine this snapshot is taken on. This object
12039	stores all settings the machine had when taking this snapshot.
12040	<note>
12041	The returned machine object is immutable, i.e. no
12042	any settings can be changed.
12043	</note>
12044	</desc>
12045	</attribute>
12046
12047	<attribute name="parent" type="ISnapshot" readonly="yes">
12048	<desc>
12049	Parent snapshot (a snapshot this one is based on), or
12050	@c null if the snapshot has no parent (i.e. is the first snapshot).
12051	</desc>
12052	</attribute>
12053
12054	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
12055	<desc>
12056	Child snapshots (all snapshots having this one as a parent).
12057	By inspecting this attribute starting with a machine's root snapshot
12058	(which can be obtained by calling <link to="IMachine::findSnapshot" />
12059	with a @c null UUID), a machine's snapshots tree can be iterated over.
12060	</desc>
12061	</attribute>
12062
12063	<method name="getChildrenCount" const="yes">
12064	<desc>
12065	Returns the number of direct childrens of this snapshot.
12066	</desc>
12067	<param name="childrenCount" type="unsigned long" dir="return">
12068	<desc>
12069	</desc>
12070	</param>
12071	</method>
12072
12073	</interface>
12074
12075
12076	<!--
12077	// IMedium
12078	/////////////////////////////////////////////////////////////////////////
12079	-->
12080
12081	<enum
12082	name="MediumState"
12083	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
12084	>
12085	<desc>
12086	Virtual medium state.
12087	<see><link to="IMedium"/></see>
12088	</desc>
12089
12090	<const name="NotCreated" value="0">
12091	<desc>
12092	Associated medium storage does not exist (either was not created yet or
12093	was deleted).
12094	</desc>
12095	</const>
12096	<const name="Created" value="1">
12097	<desc>
12098	Associated storage exists and accessible; this gets set if the
12099	accessibility check performed by <link to="IMedium::refreshState" />
12100	was successful.
12101	</desc>
12102	</const>
12103	<const name="LockedRead" value="2">
12104	<desc>
12105	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
12106	no data modification is possible.
12107	</desc>
12108	</const>
12109	<const name="LockedWrite" value="3">
12110	<desc>
12111	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
12112	no concurrent data reading or modification is possible.
12113	</desc>
12114	</const>
12115	<const name="Inaccessible" value="4">
12116	<desc>
12117	Medium accessibility check (see <link to="IMedium::refreshState" />) has
12118	not yet been performed, or else, associated medium storage is not
12119	accessible. In the first case, <link to="IMedium::lastAccessError"/>
12120	is empty, in the second case, it describes the error that occurred.
12121	</desc>
12122	</const>
12123	<const name="Creating" value="5">
12124	<desc>
12125	Associated medium storage is being created.
12126	</desc>
12127	</const>
12128	<const name="Deleting" value="6">
12129	<desc>
12130	Associated medium storage is being deleted.
12131	</desc>
12132	</const>
12133	</enum>
12134
12135	<enum
12136	name="MediumType"
12137	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
12138	>
12139	<desc>
12140	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
12141	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
12142	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
12143	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
12144	</desc>
12145
12146	<const name="Normal" value="0">
12147	<desc>
12148	Normal medium (attached directly or indirectly, preserved
12149	when taking snapshots).
12150	</desc>
12151	</const>
12152	<const name="Immutable" value="1">
12153	<desc>
12154	Immutable medium (attached indirectly, changes are wiped out
12155	the next time the virtual machine is started).
12156	</desc>
12157	</const>
12158	<const name="Writethrough" value="2">
12159	<desc>
12160	Write through medium (attached directly, ignored when
12161	taking snapshots).
12162	</desc>
12163	</const>
12164	<const name="Shareable" value="3">
12165	<desc>
12166	Allow using this medium concurrently by several machines.
12167	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
12168	</desc>
12169	</const>
12170	<const name="Readonly" value="4">
12171	<desc>
12172	A readonly medium, which can of course be used by several machines.
12173	<note>Present and accepted since VirtualBox 4.0.</note>
12174	</desc>
12175	</const>
12176	<const name="MultiAttach" value="5">
12177	<desc>
12178	A medium which is indirectly attached, so that one base medium can
12179	be used for several VMs which have their own differencing medium to
12180	store their modifications. In some sense a variant of Immutable
12181	with unset AutoReset flag in each differencing medium.
12182	<note>Present and accepted since VirtualBox 4.0.</note>
12183	</desc>
12184	</const>
12185	</enum>
12186
12187	<enum
12188	name="MediumVariant"
12189	uuid="80685b6b-e42f-497d-8271-e77bf3c61ada"
12190	>
12191	<desc>
12192	Virtual medium image variant. More than one flag may be set.
12193	<see><link to="IMedium"/></see>
12194	</desc>
12195
12196	<const name="Standard" value="0">
12197	<desc>
12198	No particular variant requested, results in using the backend default.
12199	</desc>
12200	</const>
12201	<const name="VmdkSplit2G" value="0x01">
12202	<desc>
12203	VMDK image split in chunks of less than 2GByte.
12204	</desc>
12205	</const>
12206	<const name="VmdkRawDisk" value="0x02">
12207	<desc>
12208	VMDK image representing a raw disk.
12209	</desc>
12210	</const>
12211	<const name="VmdkStreamOptimized" value="0x04">
12212	<desc>
12213	VMDK streamOptimized image. Special import/export format which is
12214	read-only/append-only.
12215	</desc>
12216	</const>
12217	<const name="VmdkESX" value="0x08">
12218	<desc>
12219	VMDK format variant used on ESX products.
12220	</desc>
12221	</const>
12222	<const name="Fixed" value="0x10000">
12223	<desc>
12224	Fixed image. Only allowed for base images.
12225	</desc>
12226	</const>
12227	<const name="Diff" value="0x20000">
12228	<desc>
12229	Differencing image. Only allowed for child images.
12230	</desc>
12231	</const>
12232	<const name="NoCreateDir" value="0x40000000">
12233	<desc>
12234	Special flag which suppresses automatic creation of the subdirectory.
12235	Only used when passing the medium variant as an input parameter.
12236	</desc>
12237	</const>
12238	</enum>
12239
12240	<interface
12241	name="IMediumAttachment" extends="$unknown"
12242	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
12243	wsmap="struct"
12244	>
12245	<desc>
12246	The IMediumAttachment interface links storage media to virtual machines.
12247	For each medium (<link to="IMedium"/>) which has been attached to a
12248	storage controller (<link to="IStorageController"/>) of a machine
12249	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
12250	method, one instance of IMediumAttachment is added to the machine's
12251	<link to="IMachine::mediumAttachments"/> array attribute.
12252
12253	Each medium attachment specifies the storage controller as well as a
12254	port and device number and the IMedium instance representing a virtual
12255	hard disk or floppy or DVD image.
12256
12257	For removable media (DVDs or floppies), there are two additional
12258	options. For one, the IMedium instance can be @c null to represent
12259	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
12260	secondly, the medium can be one of the pseudo-media for host drives
12261	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
12262
12263	<h3>Attaching Hard Disks</h3>
12264
12265	Hard disks are attached to virtual machines using the
12266	<link to="IMachine::attachDevice"/> method and detached using the
12267	<link to="IMachine::detachDevice"/> method. Depending on a medium's
12268	type (see <link to="IMedium::type" />), hard disks are attached either
12269	<i>directly</i> or <i>indirectly</i>.
12270
12271	When a hard disk is being attached directly, it is associated with the
12272	virtual machine and used for hard disk operations when the machine is
12273	running. When a hard disk is being attached indirectly, a new differencing
12274	hard disk linked to it is implicitly created and this differencing hard
12275	disk is associated with the machine and used for hard disk operations.
12276	This also means that if <link to="IMachine::attachDevice"/> performs
12277	a direct attachment then the same hard disk will be returned in response
12278	to the subsequent <link to="IMachine::getMedium"/> call; however if
12279	an indirect attachment is performed then
12280	<link to="IMachine::getMedium"/> will return the implicitly created
12281	differencing hard disk, not the original one passed to <link
12282	to="IMachine::attachDevice"/>. In detail:
12283
12284	<ul>
12285	<li><b>Normal base</b> hard disks that do not have children (i.e.
12286	differencing hard disks linked to them) and that are not already
12287	attached to virtual machines in snapshots are attached <b>directly</b>.
12288	Otherwise, they are attached <b>indirectly</b> because having
12289	dependent children or being part of the snapshot makes it impossible
12290	to modify hard disk contents without breaking the integrity of the
12291	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
12292	quickly determine the kind of the attachment for the given hard
12293	disk. Note that if a normal base hard disk is to be indirectly
12294	attached to a virtual machine with snapshots then a special
12295	procedure called <i>smart attachment</i> is performed (see below).</li>
12296	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
12297	they are attached <b>directly</b> if they do not have children and are
12298	not attached to virtual machines in snapshots, and <b>indirectly</b>
12299	otherwise. Note that the smart attachment procedure is never performed
12300	for differencing hard disks.</li>
12301	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
12302	they are designed to be non-writable. If an immutable hard disk is
12303	attached to a virtual machine with snapshots then a special
12304	procedure called smart attachment is performed (see below).</li>
12305	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
12306	also as designed. This also means that writethrough hard disks cannot
12307	have other hard disks linked to them at all.</li>
12308	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
12309	also as designed. This also means that shareable hard disks cannot
12310	have other hard disks linked to them at all. They behave almost
12311	like writethrough hard disks, except that shareable hard disks can
12312	be attached to several virtual machines which are running, allowing
12313	concurrent accesses. You need special cluster software running in
12314	the virtual machines to make use of such disks.</li>
12315	</ul>
12316
12317	Note that the same hard disk, regardless of its type, may be attached to
12318	more than one virtual machine at a time. In this case, the machine that is
12319	started first gains exclusive access to the hard disk and attempts to
12320	start other machines having this hard disk attached will fail until the
12321	first machine is powered down.
12322
12323	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
12324	that the given hard disk remains associated with the given machine after a
12325	successful <link to="IMachine::detachDevice"/> call until
12326	<link to="IMachine::saveSettings"/> is called to save all changes to
12327	machine settings to disk. This deferring is necessary to guarantee that
12328	the hard disk configuration may be restored at any time by a call to
12329	<link to="IMachine::discardSettings"/> before the settings
12330	are saved (committed).
12331
12332	Note that if <link to="IMachine::discardSettings"/> is called after
12333	indirectly attaching some hard disks to the machine but before a call to
12334	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
12335	all differencing hard disks implicitly created by
12336	<link to="IMachine::attachDevice"/> for these indirect attachments.
12337	Such implicitly created hard disks will also be immediately deleted when
12338	detached explicitly using the <link to="IMachine::detachDevice"/>
12339	call if it is made before <link to="IMachine::saveSettings"/>. This
12340	implicit deletion is safe because newly created differencing hard
12341	disks do not contain any user data.
12342
12343	However, keep in mind that detaching differencing hard disks that were
12344	implicitly created by <link to="IMachine::attachDevice"/>
12345	before the last <link to="IMachine::saveSettings"/> call will
12346	<b>not</b> implicitly delete them as they may already contain some data
12347	(for example, as a result of virtual machine execution). If these hard
12348	disks are no more necessary, the caller can always delete them explicitly
12349	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
12350	from this machine by the <link to="IMachine::saveSettings"/> call.
12351
12352	<h3>Smart Attachment</h3>
12353
12354	When normal base or immutable hard disks are indirectly attached to a
12355	virtual machine then some additional steps are performed to make sure the
12356	virtual machine will have the most recent "view" of the hard disk being
12357	attached. These steps include walking through the machine's snapshots
12358	starting from the current one and going through ancestors up to the first
12359	snapshot. Hard disks attached to the virtual machine in all
12360	of the encountered snapshots are checked whether they are descendants of
12361	the given normal base or immutable hard disk. The first found child (which
12362	is the differencing hard disk) will be used instead of the normal base or
12363	immutable hard disk as a parent for creating a new differencing hard disk
12364	that will be actually attached to the machine. And only if no descendants
12365	are found or if the virtual machine does not have any snapshots then the
12366	normal base or immutable hard disk will be used itself as a parent for
12367	this differencing hard disk.
12368
12369	It is easier to explain what smart attachment does using the
12370	following example:
12371	<pre>
12372	BEFORE attaching B.vdi: AFTER attaching B.vdi:
12373
12374	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
12375	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
12376	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
12377	Snapshot 4 (none) Snapshot 4 (none)
12378	CurState (none) CurState (D3->D2.vdi)
12379
12380	NOT
12381	...
12382	CurState (D3->B.vdi)
12383	</pre>
12384	The first column is the virtual machine configuration before the base hard
12385	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
12386	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
12387	mean that the hard disk that is actually attached to the machine is a
12388	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
12389	another hard disk, <tt>B.vdi</tt>.
12390
12391	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
12392	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
12393	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
12394	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
12395	it cannot be attached directly and needs an indirect attachment (i.e.
12396	implicit creation of a new differencing hard disk). Due to the smart
12397	attachment procedure, the new differencing hard disk
12398	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
12399	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
12400	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
12401	machine.
12402
12403	Note that if there is more than one descendant hard disk of the given base
12404	hard disk found in a snapshot, and there is an exact device, channel and
12405	bus match, then this exact match will be used. Otherwise, the youngest
12406	descendant will be picked up.
12407
12408	There is one more important aspect of the smart attachment procedure which
12409	is not related to snapshots at all. Before walking through the snapshots
12410	as described above, the backup copy of the current list of hard disk
12411	attachment is searched for descendants. This backup copy is created when
12412	the hard disk configuration is changed for the first time after the last
12413	<link to="IMachine::saveSettings"/> call and used by
12414	<link to="IMachine::discardSettings"/> to undo the recent hard disk
12415	changes. When such a descendant is found in this backup copy, it will be
12416	simply re-attached back, without creating a new differencing hard disk for
12417	it. This optimization is necessary to make it possible to re-attach the
12418	base or immutable hard disk to a different bus, channel or device slot
12419	without losing the contents of the differencing hard disk actually
12420	attached to the machine in place of it.
12421
12422	</desc>
12423
12424	<attribute name="medium" type="IMedium" readonly="yes">
12425	<desc>Medium object associated with this attachment; it
12426	can be @c null for removable devices.</desc>
12427	</attribute>
12428
12429	<attribute name="controller" type="wstring" readonly="yes">
12430	<desc>Name of the storage controller of this attachment; this
12431	refers to one of the controllers in <link to="IMachine::storageControllers" />
12432	by name.</desc>
12433	</attribute>
12434
12435	<attribute name="port" type="long" readonly="yes">
12436	<desc>Port number of this attachment.
12437	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12438	</desc>
12439	</attribute>
12440
12441	<attribute name="device" type="long" readonly="yes">
12442	<desc>Device slot number of this attachment.
12443	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12444	</desc>
12445	</attribute>
12446
12447	<attribute name="type" type="DeviceType" readonly="yes">
12448	<desc>Device type of this attachment.</desc>
12449	</attribute>
12450
12451	<attribute name="passthrough" type="boolean" readonly="yes">
12452	<desc>Pass I/O requests through to a device on the host.</desc>
12453	</attribute>
12454
12455	<attribute name="temporaryEject" type="boolean" readonly="yes">
12456	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
12457	</attribute>
12458
12459	<attribute name="isEjected" type="boolean" readonly="yes">
12460	<desc>Signals that the removable medium has been ejected. This is not
12461	necessarily equivalent to having a @c null medium association.</desc>
12462	</attribute>
12463
12464	<attribute name="nonRotational" type="boolean" readonly="yes">
12465	<desc>Whether the associated medium is non-rotational.</desc>
12466	</attribute>
12467
12468	<attribute name="discard" type="boolean" readonly="yes">
12469	<desc>Whether the associated medium supports discarding unused blocks.</desc>
12470	</attribute>
12471
12472	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
12473	<desc>The bandwidth group this medium attachment is assigned to.</desc>
12474	</attribute>
12475
12476	</interface>
12477
12478	<interface
12479	name="IMedium" extends="$unknown"
12480	uuid="86fd6208-4c8c-40c2-a4e3-f6b47ac6ef07"
12481	wsmap="managed"
12482	>
12483	<desc>
12484	The IMedium interface represents virtual storage for a machine's
12485	hard disks, CD/DVD or floppy drives. It will typically represent
12486	a disk image on the host, for example a VDI or VMDK file representing
12487	a virtual hard disk, or an ISO or RAW file representing virtual
12488	removable media, but can also point to a network location (e.g.
12489	for iSCSI targets).
12490
12491	Instances of IMedium are connected to virtual machines by way of medium
12492	attachments, which link the storage medium to a particular device slot
12493	of a storage controller of the virtual machine.
12494	In the VirtualBox API, virtual storage is therefore always represented
12495	by the following chain of object links:
12496
12497	<ul>
12498	<li><link to="IMachine::storageControllers"/> contains an array of
12499	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
12500	these are instances of <link to="IStorageController"/>).</li>
12501	<li><link to="IMachine::mediumAttachments"/> contains an array of
12502	medium attachments (instances of <link to="IMediumAttachment"/>
12503	created by <link to="IMachine::attachDevice" />),
12504	each containing a storage controller from the above array, a
12505	port/device specification, and an instance of IMedium representing
12506	the medium storage (image file).
12507
12508	For removable media, the storage medium is optional; a medium
12509	attachment with no medium represents a CD/DVD or floppy drive
12510	with no medium inserted. By contrast, hard disk attachments
12511	will always have an IMedium object attached.</li>
12512	<li>Each IMedium in turn points to a storage unit (such as a file
12513	on the host computer or a network resource) that holds actual
12514	data. This location is represented by the <link to="#location"/>
12515	attribute.</li>
12516	</ul>
12517
12518	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
12519	new hard disk media can be created with the VirtualBox API using the
12520	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
12521	disks (see below) are usually implicitly created by VirtualBox as
12522	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
12523	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
12524	should be created with external tools and then opened from within VirtualBox.
12525
12526	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
12527	drive. In that case the <link to="#id" /> attribute contains the UUID of
12528	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
12529
12530	<h3>Media registries</h3>
12531
12532	When a medium has been opened or created using one of the aforementioned
12533	APIs, it becomes "known" to VirtualBox. Known media can be attached
12534	to virtual machines and re-found through <link to="IVirtualBox::openMedium"/>.
12535	They also appear in the global
12536	<link to="IVirtualBox::hardDisks" />,
12537	<link to="IVirtualBox::DVDImages" /> and
12538	<link to="IVirtualBox::floppyImages" /> arrays.
12539
12540	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
12541	in the VirtualBox.xml file, which was shared between all machines and made
12542	transporting machines and their media from one host to another difficult.
12543
12544	Starting with VirtualBox 4.0, media are only added to a registry when they are
12545	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
12546	backwards compatibility, which registry a medium is added to depends on which
12547	VirtualBox version created a machine:
12548
12549	<ul>
12550	<li>If the medium has first been attached to a machine which was created by
12551	VirtualBox 4.0 or later, it is added to that machine's media registry in
12552	the machine XML settings file. This way all information about a machine's
12553	media attachments is contained in a single file and can be transported
12554	easily.</li>
12555	<li>For older media attachments (i.e. if the medium was first attached to a
12556	machine which was created with a VirtualBox version before 4.0), media
12557	continue to be registered in the global VirtualBox settings file, for
12558	backwards compatibility.</li>
12559	</ul>
12560
12561	See <link to="IVirtualBox::openMedium" /> for more information.
12562
12563	Media are removed from media registries by the <link to="IMedium::close"/>,
12564	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
12565
12566	<h3>Accessibility checks</h3>
12567
12568	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
12569	method is called explicitly on a medium. This is done to make the VirtualBox object
12570	ready for serving requests as fast as possible and let the end-user
12571	application decide if it needs to check media accessibility right away or not.
12572
12573	As a result, when VirtualBox starts up (e.g. the VirtualBox
12574	object gets created for the first time), all known media are in the
12575	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
12576	attribute is an empty string because no actual accessibility check has
12577	been made yet.
12578
12579	After calling <link to="#refreshState" />, a medium is considered
12580	<i>accessible</i> if its storage unit can be read. In that case, the
12581	<link to="#state"/> attribute has a value of "Created". If the storage
12582	unit cannot be read (for example, because it is located on a disconnected
12583	network resource, or was accidentally deleted outside VirtualBox),
12584	the medium is considered <i>inaccessible</i>, which is indicated by the
12585	"Inaccessible" state. The exact reason why the medium is inaccessible can be
12586	obtained by reading the <link to="#lastAccessError"/> attribute.
12587
12588	<h3>Medium types</h3>
12589
12590	There are five types of medium behavior which are stored in the
12591	<link to="#type"/> attribute (see <link to="MediumType" />) and
12592	which define the medium's behavior with attachments and snapshots.
12593
12594	All media can be also divided in two groups: <i>base</i> media and
12595	<i>differencing</i> media. A base medium contains all sectors of the
12596	medium data in its own storage and therefore can be used independently.
12597	In contrast, a differencing medium is a "delta" to some other medium and
12598	contains only those sectors which differ from that other medium, which is
12599	then called a <i>parent</i>. The differencing medium is said to be
12600	<i>linked to</i> that parent. The parent may be itself a differencing
12601	medium, thus forming a chain of linked media. The last element in that
12602	chain must always be a base medium. Note that several differencing
12603	media may be linked to the same parent medium.
12604
12605	Differencing media can be distinguished from base media by querying the
12606	<link to="#parent"/> attribute: base media do not have parents they would
12607	depend on, so the value of this attribute is always @c null for them.
12608	Using this attribute, it is possible to walk up the medium tree (from the
12609	child medium to its parent). It is also possible to walk down the tree
12610	using the <link to="#children"/> attribute.
12611
12612	Note that the type of all differencing media is "normal"; all other
12613	values are meaningless for them. Base media may be of any type.
12614
12615	<h3>Automatic composition of the file name part</h3>
12616
12617	Another extension to the <link to="IMedium::location"/> attribute is that
12618	there is a possibility to cause VirtualBox to compose a unique value for
12619	the file name part of the location using the UUID of the hard disk. This
12620	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
12621	e.g. before the storage unit is created, and works as follows. You set the
12622	value of the <link to="IMedium::location"/> attribute to a location
12623	specification which only contains the path specification but not the file
12624	name part and ends with either a forward slash or a backslash character.
12625	In response, VirtualBox will generate a new UUID for the hard disk and
12626	compose the file name using the following pattern:
12627	<pre>
12628	<path>/{<uuid>}.<ext>
12629	</pre>
12630	where <tt><path></tt> is the supplied path specification,
12631	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
12632	is the default extension for the storage format of this hard disk. After
12633	that, you may call any of the methods that create a new hard disk storage
12634	unit and they will use the generated UUID and file name.
12635	</desc>
12636
12637	<attribute name="id" type="uuid" mod="string" readonly="yes">
12638	<desc>
12639	UUID of the medium. For a newly created medium, this value is a randomly
12640	generated UUID.
12641
12642	<note>
12643	For media in one of MediumState_NotCreated, MediumState_Creating or
12644	MediumState_Deleting states, the value of this property is undefined
12645	and will most likely be an empty UUID.
12646	</note>
12647	</desc>
12648	</attribute>
12649
12650	<attribute name="description" type="wstring">
12651	<desc>
12652	Optional description of the medium. For a newly created medium the value
12653	of this attribute is an empty string.
12654
12655	Medium types that don't support this attribute will return E_NOTIMPL in
12656	attempt to get or set this attribute's value.
12657
12658	<note>
12659	For some storage types, reading this attribute may return an outdated
12660	(last known) value when <link to="#state"/> is <link
12661	to="MediumState_Inaccessible"/> or <link
12662	to="MediumState_LockedWrite"/> because the value of this attribute is
12663	stored within the storage unit itself. Also note that changing the
12664	attribute value is not possible in such case, as well as when the
12665	medium is the <link to="MediumState_LockedRead"/> state.
12666	</note>
12667	</desc>
12668	</attribute>
12669
12670	<attribute name="state" type="MediumState" readonly="yes">
12671	<desc>
12672	Returns the current medium state, which is the last state set by
12673	the accessibility check performed by <link to="#refreshState"/>.
12674	If that method has not yet been called on the medium, the state
12675	is "Inaccessible"; as opposed to truly inaccessible media, the
12676	value of <link to="#lastAccessError"/> will be an empty string in
12677	that case.
12678
12679	<note>As of version 3.1, this no longer performs an accessibility check
12680	automatically; call <link to="#refreshState"/> for that.
12681	</note>
12682	</desc>
12683	</attribute>
12684
12685	<attribute name="variant" type="MediumVariant" safearray="yes" readonly="yes">
12686	<desc>
12687	Returns the storage format variant information for this medium
12688	as an aaray of the flags described at <link to="MediumVariant" />.
12689	Before <link to="#refreshState"/> is called this method returns
12690	an undefined value.
12691	</desc>
12692	</attribute>
12693
12694	<attribute name="location" type="wstring">
12695	<desc>
12696	Location of the storage unit holding medium data.
12697
12698	The format of the location string is medium type specific. For medium
12699	types using regular files in a host's file system, the location
12700	string is the full file name.
12701
12702	Some medium types may support changing the storage unit location by
12703	simply changing the value of this property. If this operation is not
12704	supported, the implementation will return E_NOTIMPL in attempt to set
12705	this attribute's value.
12706
12707	When setting a value of the location attribute which is a regular file
12708	in the host's file system, the given file name may be either relative to
12709	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
12710	absolute. Note that if the given location specification does not contain
12711	the file extension part then a proper default extension will be
12712	automatically appended by the implementation depending on the medium type.
12713	</desc>
12714	</attribute>
12715
12716	<attribute name="name" type="wstring" readonly="yes">
12717	<desc>
12718	Name of the storage unit holding medium data.
12719
12720	The returned string is a short version of the <link to="#location"/>
12721	attribute that is suitable for representing the medium in situations
12722	where the full location specification is too long (such as lists
12723	and comboboxes in GUI frontends). This string is also used by frontends
12724	to sort the media list alphabetically when needed.
12725
12726	For example, for locations that are regular files in the host's file
12727	system, the value of this attribute is just the file name (+ extension),
12728	without the path specification.
12729
12730	Note that as opposed to the <link to="#location"/> attribute, the name
12731	attribute will not necessary be unique for a list of media of the
12732	given type and format.
12733	</desc>
12734	</attribute>
12735
12736	<attribute name="deviceType" type="DeviceType" readonly="yes">
12737	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
12738	medium.</desc>
12739	</attribute>
12740
12741	<attribute name="hostDrive" type="boolean" readonly="yes">
12742	<desc>True if this corresponds to a drive on the host.</desc>
12743	</attribute>
12744
12745	<attribute name="size" type="long long" readonly="yes">
12746	<desc>
12747	Physical size of the storage unit used to hold medium data (in bytes).
12748
12749	<note>
12750	For media whose <link to="#state"/> is <link
12751	to="MediumState_Inaccessible"/>, the value of this property is the
12752	last known size. For <link to="MediumState_NotCreated"/> media,
12753	the returned value is zero.
12754	</note>
12755	</desc>
12756	</attribute>
12757
12758	<attribute name="format" type="wstring" readonly="yes">
12759	<desc>
12760	Storage format of this medium.
12761
12762	The value of this attribute is a string that specifies a backend used
12763	to store medium data. The storage format is defined when you create a
12764	new medium or automatically detected when you open an existing medium,
12765	and cannot be changed later.
12766
12767	The list of all storage formats supported by this VirtualBox
12768	installation can be obtained using
12769	<link to="ISystemProperties::mediumFormats"/>.
12770	</desc>
12771	</attribute>
12772
12773	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
12774	<desc>
12775	Storage medium format object corresponding to this medium.
12776
12777	The value of this attribute is a reference to the medium format object
12778	that specifies the backend properties used to store medium data. The
12779	storage format is defined when you create a new medium or automatically
12780	detected when you open an existing medium, and cannot be changed later.
12781
12782	<note>@c null is returned if there is no associated medium format
12783	object. This can e.g. happen for medium objects representing host
12784	drives and other special medium objects.</note>
12785	</desc>
12786	</attribute>
12787
12788	<attribute name="type" type="MediumType">
12789	<desc>
12790	Type (role) of this medium.
12791
12792	The following constraints apply when changing the value of this
12793	attribute:
12794	<ul>
12795	<li>If a medium is attached to a virtual machine (either in the
12796	current state or in one of the snapshots), its type cannot be
12797	changed.
12798	</li>
12799	<li>As long as the medium has children, its type cannot be set
12800	to <link to="MediumType_Writethrough"/>.
12801	</li>
12802	<li>The type of all differencing media is
12803	<link to="MediumType_Normal"/> and cannot be changed.
12804	</li>
12805	</ul>
12806
12807	The type of a newly created or opened medium is set to
12808	<link to="MediumType_Normal"/>, except for DVD and floppy media,
12809	which have a type of <link to="MediumType_Writethrough"/>.
12810	</desc>
12811	</attribute>
12812
12813	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
12814	<desc>
12815	Returns which medium types can selected for this medium.
12816
12817	<result name="E_NOTIMPL">
12818	This attribute is not implemented at the moment.
12819	</result>
12820	</desc>
12821	</attribute>
12822
12823	<attribute name="parent" type="IMedium" readonly="yes">
12824	<desc>
12825	Parent of this medium (the medium this medium is directly based
12826	on).
12827
12828	Only differencing media have parents. For base (non-differencing)
12829	media, @c null is returned.
12830	</desc>
12831	</attribute>
12832
12833	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
12834	<desc>
12835	Children of this medium (all differencing media directly based
12836	on this medium). A @c null array is returned if this medium
12837	does not have any children.
12838	</desc>
12839	</attribute>
12840
12841	<attribute name="base" type="IMedium" readonly="yes">
12842	<desc>
12843	Base medium of this medium.
12844
12845	If this is a differencing medium, its base medium is the medium
12846	the given medium branch starts from. For all other types of media, this
12847	property returns the medium object itself (i.e. the same object this
12848	property is read on).
12849	</desc>
12850	</attribute>
12851
12852	<attribute name="readOnly" type="boolean" readonly="yes">
12853	<desc>
12854	Returns @c true if this medium is read-only and @c false otherwise.
12855
12856	A medium is considered to be read-only when its contents cannot be
12857	modified without breaking the integrity of other parties that depend on
12858	this medium such as its child media or snapshots of virtual machines
12859	where this medium is attached to these machines. If there are no
12860	children and no such snapshots then there is no dependency and the
12861	medium is not read-only.
12862
12863	The value of this attribute can be used to determine the kind of the
12864	attachment that will take place when attaching this medium to a
12865	virtual machine. If the value is @c false then the medium will
12866	be attached directly. If the value is @c true then the medium
12867	will be attached indirectly by creating a new differencing child
12868	medium for that. See the interface description for more information.
12869
12870	Note that all <link to="MediumType_Immutable">Immutable</link> media
12871	are always read-only while all
12872	<link to="MediumType_Writethrough">Writethrough</link> media are
12873	always not.
12874
12875	<note>
12876	The read-only condition represented by this attribute is related to
12877	the medium type and usage, not to the current
12878	<link to="IMedium::state">medium state</link> and not to the read-only
12879	state of the storage unit.
12880	</note>
12881	</desc>
12882	</attribute>
12883
12884	<attribute name="logicalSize" type="long long" readonly="yes">
12885	<desc>
12886	Logical size of this medium (in bytes), as reported to the
12887	guest OS running inside the virtual machine this medium is
12888	attached to. The logical size is defined when the medium is created
12889	and cannot be changed later.
12890
12891	<note>
12892	For media whose state is <link to="#state"/> is <link
12893	to="MediumState_Inaccessible"/>, the value of this property is the
12894	last known logical size. For <link to="MediumState_NotCreated"/>
12895	media, the returned value is zero.
12896	</note>
12897	</desc>
12898	</attribute>
12899
12900	<attribute name="autoReset" type="boolean">
12901	<desc>
12902	Whether this differencing medium will be automatically reset each
12903	time a virtual machine it is attached to is powered up. This
12904	attribute is automatically set to @c true for the last
12905	differencing image of an "immutable" medium (see
12906	<link to="MediumType" />).
12907
12908	See <link to="#reset"/> for more information about resetting
12909	differencing media.
12910
12911	<note>
12912	Reading this property on a base (non-differencing) medium will
12913	always @c false. Changing the value of this property in this
12914	case is not supported.
12915	</note>
12916
12917	<result name="VBOX_E_NOT_SUPPORTED">
12918	This is not a differencing medium (when changing the attribute
12919	value).
12920	</result>
12921	</desc>
12922	</attribute>
12923
12924	<attribute name="lastAccessError" type="wstring" readonly="yes">
12925	<desc>
12926	Text message that represents the result of the last accessibility
12927	check performed by <link to="#refreshState"/>.
12928
12929	An empty string is returned if the last accessibility check
12930	was successful or has not yet been called. As a result, if
12931	<link to="#state" /> is "Inaccessible" and this attribute is empty,
12932	then <link to="#refreshState"/> has yet to be called; this is the
12933	default value of media after VirtualBox initialization.
12934	A non-empty string indicates a failure and should normally describe
12935	a reason of the failure (for example, a file read error).
12936	</desc>
12937	</attribute>
12938
12939	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
12940	<desc>
12941	Array of UUIDs of all machines this medium is attached to.
12942
12943	A @c null array is returned if this medium is not attached to any
12944	machine or to any machine's snapshot.
12945
12946	<note>
12947	The returned array will include a machine even if this medium is not
12948	attached to that machine in the current state but attached to it in
12949	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
12950	details.
12951	</note>
12952	</desc>
12953	</attribute>
12954
12955	<method name="setIds">
12956	<desc>
12957	Changes the UUID and parent UUID for a hard disk medium.
12958	</desc>
12959	<param name="setImageId" type="boolean" dir="in">
12960	<desc>
12961	Select whether a new image UUID is set or not.
12962	</desc>
12963	</param>
12964	<param name="imageId" type="uuid" mod="string" dir="in">
12965	<desc>
12966	New UUID for the image. If an empty string is passed, then a new
12967	UUID is automatically created, provided that @a setImageId is @c true.
12968	Specifying a zero UUID is not allowed.
12969	</desc>
12970	</param>
12971	<param name="setParentId" type="boolean" dir="in">
12972	<desc>
12973	Select whether a new parent UUID is set or not.
12974	</desc>
12975	</param>
12976	<param name="parentId" type="uuid" mod="string" dir="in">
12977	<desc>
12978	New parent UUID for the image. If an empty string is passed, then a
12979	new UUID is automatically created, provided @a setParentId is
12980	@c true. A zero UUID is valid.
12981	</desc>
12982	</param>
12983	<result name="E_INVALIDARG">
12984	Invalid parameter combination.
12985	</result>
12986	<result name="VBOX_E_NOT_SUPPORTED">
12987	Medium is not a hard disk medium.
12988	</result>
12989	</method>
12990
12991	<method name="refreshState">
12992	<desc>
12993	If the current medium state (see <link to="MediumState"/>) is one of
12994	"Created", "Inaccessible" or "LockedRead", then this performs an
12995	accessibility check on the medium and sets the value of the <link to="#state"/>
12996	attribute accordingly; that value is also returned for convenience.
12997
12998	For all other state values, this does not perform a refresh but returns
12999	the state only.
13000
13001	The refresh, if performed, may take a long time (several seconds or even
13002	minutes, depending on the storage unit location and format) because it performs an
13003	accessibility check of the storage unit. This check may cause a significant
13004	delay if the storage unit of the given medium is, for example, a file located
13005	on a network share which is not currently accessible due to connectivity
13006	problems. In that case, the call will not return until a timeout
13007	interval defined by the host OS for this operation expires. For this reason,
13008	it is recommended to never read this attribute on the main UI thread to avoid
13009	making the UI unresponsive.
13010
13011	If the last known state of the medium is "Created" and the accessibility
13012	check fails, then the state would be set to "Inaccessible", and
13013	<link to="#lastAccessError"/> may be used to get more details about the
13014	failure. If the state of the medium is "LockedRead", then it remains the
13015	same, and a non-empty value of <link to="#lastAccessError"/> will
13016	indicate a failed accessibility check in this case.
13017
13018	Note that not all medium states are applicable to all medium types.
13019	</desc>
13020	<param name="state" type="MediumState" dir="return">
13021	<desc>
13022	New medium state.
13023	</desc>
13024	</param>
13025	</method>
13026
13027	<method name="getSnapshotIds">
13028	<desc>
13029	Returns an array of UUIDs of all snapshots of the given machine where
13030	this medium is attached to.
13031
13032	If the medium is attached to the machine in the current state, then the
13033	first element in the array will always be the ID of the queried machine
13034	(i.e. the value equal to the @c machineId argument), followed by
13035	snapshot IDs (if any).
13036
13037	If the medium is not attached to the machine in the current state, then
13038	the array will contain only snapshot IDs.
13039
13040	The returned array may be @c null if this medium is not attached
13041	to the given machine at all, neither in the current state nor in one of
13042	the snapshots.
13043	</desc>
13044	<param name="machineId" type="uuid" mod="string" dir="in">
13045	<desc>
13046	UUID of the machine to query.
13047	</desc>
13048	</param>
13049	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
13050	<desc>
13051	Array of snapshot UUIDs of the given machine using this medium.
13052	</desc>
13053	</param>
13054	</method>
13055
13056	<method name="lockRead">
13057	<desc>
13058	Locks this medium for reading.
13059
13060	A read lock is shared: many clients can simultaneously lock the
13061	same medium for reading unless it is already locked for writing (see
13062	<link to="#lockWrite"/>) in which case an error is returned.
13063
13064	When the medium is locked for reading, it cannot be modified
13065	from within VirtualBox. This means that any method that changes
13066	the properties of this medium or contents of the storage unit
13067	will return an error (unless explicitly stated otherwise). That
13068	includes an attempt to start a virtual machine that wants to
13069	write to the the medium.
13070
13071	When the virtual machine is started up, it locks for reading all
13072	media it uses in read-only mode. If some medium cannot be locked
13073	for reading, the startup procedure will fail.
13074	A medium is typically locked for reading while it is used by a running
13075	virtual machine but has a depending differencing image that receives
13076	the actual write operations. This way one base medium can have
13077	multiple child differencing images which can be written to
13078	simultaneously. Read-only media such as DVD and floppy images are
13079	also locked for reading only (so they can be in use by multiple
13080	machines simultaneously).
13081
13082	A medium is also locked for reading when it is the source of a
13083	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
13084
13085	The medium locked for reading must be unlocked using the <link
13086	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
13087	can be nested and must be followed by the same number of paired
13088	<link to="#unlockRead"/> calls.
13089
13090	This method sets the medium state (see <link to="#state"/>) to
13091	"LockedRead" on success. The medium's previous state must be
13092	one of "Created", "Inaccessible" or "LockedRead".
13093
13094	Locking an inaccessible medium is not an error; this method performs
13095	a logical lock that prevents modifications of this medium through
13096	the VirtualBox API, not a physical file-system lock of the underlying
13097	storage unit.
13098
13099	This method returns the current state of the medium
13100	<i>before</i> the operation.
13101
13102	<result name="VBOX_E_INVALID_OBJECT_STATE">
13103	Invalid medium state (e.g. not created, locked, inaccessible,
13104	creating, deleting).
13105	</result>
13106
13107	</desc>
13108	<param name="state" type="MediumState" dir="return">
13109	<desc>
13110	State of the medium after the operation.
13111	</desc>
13112	</param>
13113	</method>
13114
13115	<method name="unlockRead">
13116	<desc>
13117	Cancels the read lock previously set by <link to="#lockRead"/>.
13118
13119	For both success and failure, this method returns the current state
13120	of the medium <i>after</i> the operation.
13121
13122	See <link to="#lockRead"/> for more details.
13123
13124	<result name="VBOX_E_INVALID_OBJECT_STATE">
13125	Medium not locked for reading.
13126	</result>
13127
13128	</desc>
13129	<param name="state" type="MediumState" dir="return">
13130	<desc>
13131	State of the medium after the operation.
13132	</desc>
13133	</param>
13134	</method>
13135
13136	<method name="lockWrite">
13137	<desc>
13138	Locks this medium for writing.
13139
13140	A write lock, as opposed to <link to="#lockRead"/>, is
13141	exclusive: there may be only one client holding a write lock,
13142	and there may be no read locks while the write lock is held.
13143	As a result, read-locking fails if a write lock is held, and
13144	write-locking fails if either a read or another write lock is held.
13145
13146	When a medium is locked for writing, it cannot be modified
13147	from within VirtualBox, and it is not guaranteed that the values
13148	of its properties are up-to-date. Any method that changes the
13149	properties of this medium or contents of the storage unit will
13150	return an error (unless explicitly stated otherwise).
13151
13152	When a virtual machine is started up, it locks for writing all
13153	media it uses to write data to. If any medium could not be locked
13154	for writing, the startup procedure will fail. If a medium has
13155	differencing images, then while the machine is running, only
13156	the last ("leaf") differencing image is locked for writing,
13157	whereas its parents are locked for reading only.
13158
13159	A medium is also locked for writing when it is the target of a
13160	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
13161
13162	The medium locked for writing must be unlocked using the <link
13163	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
13164
13165	This method sets the medium state (see <link to="#state"/>) to
13166	"LockedWrite" on success. The medium's previous state must be
13167	either "Created" or "Inaccessible".
13168
13169	Locking an inaccessible medium is not an error; this method performs
13170	a logical lock that prevents modifications of this medium through
13171	the VirtualBox API, not a physical file-system lock of the underlying
13172	storage unit.
13173
13174	For both, success and failure, this method returns the current
13175	state of the medium <i>before</i> the operation.
13176
13177	<result name="VBOX_E_INVALID_OBJECT_STATE">
13178	Invalid medium state (e.g. not created, locked, inaccessible,
13179	creating, deleting).
13180	</result>
13181
13182	</desc>
13183	<param name="state" type="MediumState" dir="return">
13184	<desc>
13185	State of the medium after the operation.
13186	</desc>
13187	</param>
13188	</method>
13189
13190	<method name="unlockWrite">
13191	<desc>
13192	Cancels the write lock previously set by <link to="#lockWrite"/>.
13193
13194	For both success and failure, this method returns the current
13195	state of the medium <i>after</i> the operation.
13196
13197	See <link to="#lockWrite"/> for more details.
13198
13199	<result name="VBOX_E_INVALID_OBJECT_STATE">
13200	Medium not locked for writing.
13201	</result>
13202
13203	</desc>
13204	<param name="state" type="MediumState" dir="return">
13205	<desc>
13206	State of the medium after the operation.
13207	</desc>
13208	</param>
13209	</method>
13210
13211	<method name="close">
13212	<desc>
13213	Closes this medium.
13214
13215	The medium must not be attached to any known virtual machine
13216	and must not have any known child media, otherwise the
13217	operation will fail.
13218
13219	When the medium is successfully closed, it is removed from
13220	the list of registered media, but its storage unit is not
13221	deleted. In particular, this means that this medium can
13222	later be opened again using the <link to="IVirtualBox::openMedium"/>
13223	call.
13224
13225	Note that after this method successfully returns, the given medium
13226	object becomes uninitialized. This means that any attempt
13227	to call any of its methods or attributes will fail with the
13228	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
13229
13230	<result name="VBOX_E_INVALID_OBJECT_STATE">
13231	Invalid medium state (other than not created, created or
13232	inaccessible).
13233	</result>
13234	<result name="VBOX_E_OBJECT_IN_USE">
13235	Medium attached to virtual machine.
13236	</result>
13237	<result name="VBOX_E_FILE_ERROR">
13238	Settings file not accessible.
13239	</result>
13240	<result name="VBOX_E_XML_ERROR">
13241	Could not parse the settings file.
13242	</result>
13243
13244	</desc>
13245	</method>
13246
13247	<!-- property methods -->
13248
13249	<method name="getProperty" const="yes">
13250	<desc>
13251	Returns the value of the custom medium property with the given name.
13252
13253	The list of all properties supported by the given medium format can
13254	be obtained with <link to="IMediumFormat::describeProperties"/>.
13255
13256	<note>If this method returns an empty string in @a value, the requested
13257	property is supported but currently not assigned any value.</note>
13258
13259	<result name="VBOX_E_OBJECT_NOT_FOUND">
13260	Requested property does not exist (not supported by the format).
13261	</result>
13262	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13263	</desc>
13264	<param name="name" type="wstring" dir="in">
13265	<desc>Name of the property to get.</desc>
13266	</param>
13267	<param name="value" type="wstring" dir="return">
13268	<desc>Current property value.</desc>
13269	</param>
13270	</method>
13271
13272	<method name="setProperty">
13273	<desc>
13274	Sets the value of the custom medium property with the given name.
13275
13276	The list of all properties supported by the given medium format can
13277	be obtained with <link to="IMediumFormat::describeProperties"/>.
13278
13279	<note>Setting the property value to @c null or an empty string is
13280	equivalent to deleting the existing value. A default value (if it is
13281	defined for this property) will be used by the format backend in this
13282	case.</note>
13283
13284	<result name="VBOX_E_OBJECT_NOT_FOUND">
13285	Requested property does not exist (not supported by the format).
13286	</result>
13287	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13288	</desc>
13289	<param name="name" type="wstring" dir="in">
13290	<desc>Name of the property to set.</desc>
13291	</param>
13292	<param name="value" type="wstring" dir="in">
13293	<desc>Property value to set.</desc>
13294	</param>
13295	</method>
13296
13297	<method name="getProperties" const="yes">
13298	<desc>
13299	Returns values for a group of properties in one call.
13300
13301	The names of the properties to get are specified using the @a names
13302	argument which is a list of comma-separated property names or
13303	an empty string if all properties are to be returned.
13304	<note>Currently the value of this argument is ignored and the method
13305	always returns all existing properties.</note>
13306
13307	The list of all properties supported by the given medium format can
13308	be obtained with <link to="IMediumFormat::describeProperties"/>.
13309
13310	The method returns two arrays, the array of property names corresponding
13311	to the @a names argument and the current values of these properties.
13312	Both arrays have the same number of elements with each element at the
13313	given index in the first array corresponds to an element at the same
13314	index in the second array.
13315
13316	For properties that do not have assigned values, an empty string is
13317	returned at the appropriate index in the @a returnValues array.
13318
13319	</desc>
13320	<param name="names" type="wstring" dir="in">
13321	<desc>
13322	Names of properties to get.
13323	</desc>
13324	</param>
13325	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13326	<desc>Names of returned properties.</desc>
13327	</param>
13328	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13329	<desc>Values of returned properties.</desc>
13330	</param>
13331	</method>
13332
13333	<method name="setProperties">
13334	<desc>
13335	Sets values for a group of properties in one call.
13336
13337	The names of the properties to set are passed in the @a names
13338	array along with the new values for them in the @a values array. Both
13339	arrays have the same number of elements with each element at the given
13340	index in the first array corresponding to an element at the same index
13341	in the second array.
13342
13343	If there is at least one property name in @a names that is not valid,
13344	the method will fail before changing the values of any other properties
13345	from the @a names array.
13346
13347	Using this method over <link to="#setProperty"/> is preferred if you
13348	need to set several properties at once since it is more efficient.
13349
13350	The list of all properties supported by the given medium format can
13351	be obtained with <link to="IMediumFormat::describeProperties"/>.
13352
13353	Setting the property value to @c null or an empty string is equivalent
13354	to deleting the existing value. A default value (if it is defined for
13355	this property) will be used by the format backend in this case.
13356	</desc>
13357	<param name="names" type="wstring" safearray="yes" dir="in">
13358	<desc>Names of properties to set.</desc>
13359	</param>
13360	<param name="values" type="wstring" safearray="yes" dir="in">
13361	<desc>Values of properties to set.</desc>
13362	</param>
13363	</method>
13364
13365	<!-- storage methods -->
13366
13367	<method name="createBaseStorage">
13368	<desc>
13369	Starts creating a hard disk storage unit (fixed/dynamic, according
13370	to the variant flags) in in the background. The previous storage unit
13371	created for this object, if any, must first be deleted using
13372	<link to="#deleteStorage"/>, otherwise the operation will fail.
13373
13374	Before the operation starts, the medium is placed in
13375	<link to="MediumState_Creating"/> state. If the create operation
13376	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
13377	state.
13378
13379	After the returned progress object reports that the operation has
13380	successfully completed, the medium state will be set to <link
13381	to="MediumState_Created"/>, the medium will be remembered by this
13382	VirtualBox installation and may be attached to virtual machines.
13383
13384	<result name="VBOX_E_NOT_SUPPORTED">
13385	The variant of storage creation operation is not supported. See <link
13386	to="IMediumFormat::capabilities"/>.
13387	</result>
13388	</desc>
13389	<param name="logicalSize" type="long long" dir="in">
13390	<desc>Maximum logical size of the medium in bytes.</desc>
13391	</param>
13392	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13393	<desc>Exact image variant which should be created (as a combination of
13394	<link to="MediumVariant" /> flags).</desc>
13395	</param>
13396	<param name="progress" type="IProgress" dir="return">
13397	<desc>Progress object to track the operation completion.</desc>
13398	</param>
13399	</method>
13400
13401	<method name="deleteStorage">
13402	<desc>
13403	Starts deleting the storage unit of this medium.
13404
13405	The medium must not be attached to any known virtual machine and must
13406	not have any known child media, otherwise the operation will fail.
13407	It will also fail if there is no storage unit to delete or if deletion
13408	is already in progress, or if the medium is being in use (locked for
13409	read or for write) or inaccessible. Therefore, the only valid state for
13410	this operation to succeed is <link to="MediumState_Created"/>.
13411
13412	Before the operation starts, the medium is placed in
13413	<link to="MediumState_Deleting"/> state and gets removed from the list
13414	of remembered hard disks (media registry). If the delete operation
13415	fails, the medium will be remembered again and placed back to
13416	<link to="MediumState_Created"/> state.
13417
13418	After the returned progress object reports that the operation is
13419	complete, the medium state will be set to
13420	<link to="MediumState_NotCreated"/> and you will be able to use one of
13421	the storage creation methods to create it again.
13422
13423	<see><link to="#close"/></see>
13424
13425	<result name="VBOX_E_OBJECT_IN_USE">
13426	Medium is attached to a virtual machine.
13427	</result>
13428	<result name="VBOX_E_NOT_SUPPORTED">
13429	Storage deletion is not allowed because neither of storage creation
13430	operations are supported. See
13431	<link to="IMediumFormat::capabilities"/>.
13432	</result>
13433
13434	<note>
13435	If the deletion operation fails, it is not guaranteed that the storage
13436	unit still exists. You may check the <link to="IMedium::state"/> value
13437	to answer this question.
13438	</note>
13439	</desc>
13440	<param name="progress" type="IProgress" dir="return">
13441	<desc>Progress object to track the operation completion.</desc>
13442	</param>
13443	</method>
13444
13445	<!-- diff methods -->
13446
13447	<method name="createDiffStorage">
13448	<desc>
13449	Starts creating an empty differencing storage unit based on this
13450	medium in the format and at the location defined by the @a target
13451	argument.
13452
13453	The target medium must be in <link to="MediumState_NotCreated"/>
13454	state (i.e. must not have an existing storage unit). Upon successful
13455	completion, this operation will set the type of the target medium to
13456	<link to="MediumType_Normal"/> and create a storage unit necessary to
13457	represent the differencing medium data in the given format (according
13458	to the storage format of the target object).
13459
13460	After the returned progress object reports that the operation is
13461	successfully complete, the target medium gets remembered by this
13462	VirtualBox installation and may be attached to virtual machines.
13463
13464	<note>
13465	The medium will be set to <link to="MediumState_LockedRead"/>
13466	state for the duration of this operation.
13467	</note>
13468	<result name="VBOX_E_OBJECT_IN_USE">
13469	Medium not in @c NotCreated state.
13470	</result>
13471	</desc>
13472	<param name="target" type="IMedium" dir="in">
13473	<desc>Target medium.</desc>
13474	</param>
13475	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13476	<desc>Exact image variant which should be created (as a combination of
13477	<link to="MediumVariant" /> flags).</desc>
13478	</param>
13479	<param name="progress" type="IProgress" dir="return">
13480	<desc>Progress object to track the operation completion.</desc>
13481	</param>
13482	</method>
13483
13484	<method name="mergeTo">
13485	<desc>
13486	Starts merging the contents of this medium and all intermediate
13487	differencing media in the chain to the given target medium.
13488
13489	The target medium must be either a descendant of this medium or
13490	its ancestor (otherwise this method will immediately return a failure).
13491	It follows that there are two logical directions of the merge operation:
13492	from ancestor to descendant (<i>forward merge</i>) and from descendant to
13493	ancestor (<i>backward merge</i>). Let us consider the following medium
13494	chain:
13495
13496	<pre>Base <- Diff_1 <- Diff_2</pre>
13497
13498	Here, calling this method on the <tt>Base</tt> medium object with
13499	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
13500	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
13501	merge. Note that in both cases the contents of the resulting medium
13502	will be the same, the only difference is the medium object that takes
13503	the result of the merge operation. In case of the forward merge in the
13504	above example, the result will be written to <tt>Diff_2</tt>; in case of
13505	the backward merge, the result will be written to <tt>Base</tt>. In
13506	other words, the result of the operation is always stored in the target
13507	medium.
13508
13509	Upon successful operation completion, the storage units of all media in
13510	the chain between this (source) medium and the target medium, including
13511	the source medium itself, will be automatically deleted and the
13512	relevant medium objects (including this medium) will become
13513	uninitialized. This means that any attempt to call any of
13514	their methods or attributes will fail with the
13515	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
13516	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
13517	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
13518	Note that <tt>Diff_2</tt> in this case will become a base medium
13519	itself since it will no longer be based on any other medium.
13520
13521	Considering the above, all of the following conditions must be met in
13522	order for the merge operation to succeed:
13523	<ul>
13524	<li>
13525	Neither this (source) medium nor any intermediate
13526	differencing medium in the chain between it and the target
13527	medium is attached to any virtual machine.
13528	</li>
13529	<li>
13530	Neither the source medium nor the target medium is an
13531	<link to="MediumType_Immutable"/> medium.
13532	</li>
13533	<li>
13534	The part of the medium tree from the source medium to the
13535	target medium is a linear chain, i.e. all medium in this
13536	chain have exactly one child which is the next medium in this
13537	chain. The only exception from this rule is the target medium in
13538	the forward merge operation; it is allowed to have any number of
13539	child media because the merge operation will not change its
13540	logical contents (as it is seen by the guest OS or by children).
13541	</li>
13542	<li>
13543	None of the involved media are in
13544	<link to="MediumState_LockedRead"/> or
13545	<link to="MediumState_LockedWrite"/> state.
13546	</li>
13547	</ul>
13548
13549	<note>
13550	This (source) medium and all intermediates will be placed to <link
13551	to="MediumState_Deleting"/> state and the target medium will be
13552	placed to <link to="MediumState_LockedWrite"/> state and for the
13553	duration of this operation.
13554	</note>
13555	</desc>
13556	<param name="target" type="IMedium" dir="in">
13557	<desc>Target medium.</desc>
13558	</param>
13559	<param name="progress" type="IProgress" dir="return">
13560	<desc>Progress object to track the operation completion.</desc>
13561	</param>
13562	</method>
13563
13564	<!-- clone method -->
13565
13566	<method name="cloneTo">
13567	<desc>
13568	Starts creating a clone of this medium in the format and at the
13569	location defined by the @a target argument.
13570
13571	The target medium must be either in <link to="MediumState_NotCreated"/>
13572	state (i.e. must not have an existing storage unit) or in
13573	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13574	big enough to hold the data or else the copy will be partial). Upon
13575	successful completion, the cloned medium will contain exactly the
13576	same sector data as the medium being cloned, except that in the
13577	first case a new UUID for the clone will be randomly generated, and in
13578	the second case the UUID will remain unchanged.
13579
13580	The @a parent argument defines which medium will be the parent
13581	of the clone. Passing a @c null reference indicates that the clone will
13582	be a base image, i.e. completely independent. It is possible to specify
13583	an arbitrary medium for this parameter, including the parent of the
13584	medium which is being cloned. Even cloning to a child of the source
13585	medium is possible. Note that when cloning to an existing image, the
13586	@a parent argument is ignored.
13587
13588	After the returned progress object reports that the operation is
13589	successfully complete, the target medium gets remembered by this
13590	VirtualBox installation and may be attached to virtual machines.
13591
13592	<note>
13593	This medium will be placed to <link to="MediumState_LockedRead"/>
13594	state for the duration of this operation.
13595	</note>
13596	<result name="E_NOTIMPL">
13597	The specified cloning variant is not supported at the moment.
13598	</result>
13599	</desc>
13600	<param name="target" type="IMedium" dir="in">
13601	<desc>Target medium.</desc>
13602	</param>
13603	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13604	<desc>Exact image variant which should be created (as a combination of
13605	<link to="MediumVariant" /> flags).</desc>
13606	</param>
13607	<param name="parent" type="IMedium" dir="in">
13608	<desc>Parent of the cloned medium.</desc>
13609	</param>
13610	<param name="progress" type="IProgress" dir="return">
13611	<desc>Progress object to track the operation completion.</desc>
13612	</param>
13613	</method>
13614
13615	<method name="cloneToBase">
13616	<desc>
13617	Starts creating a clone of this medium in the format and at the
13618	location defined by the @a target argument.
13619
13620	The target medium must be either in <link to="MediumState_NotCreated"/>
13621	state (i.e. must not have an existing storage unit) or in
13622	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13623	big enough to hold the data or else the copy will be partial). Upon
13624	successful completion, the cloned medium will contain exactly the
13625	same sector data as the medium being cloned, except that in the
13626	first case a new UUID for the clone will be randomly generated, and in
13627	the second case the UUID will remain unchanged.
13628
13629	The @a parent argument defines which medium will be the parent
13630	of the clone. In this case the clone will be a base image, i.e.
13631	completely independent. It is possible to specify an arbitrary
13632	medium for this parameter, including the parent of the
13633	medium which is being cloned. Even cloning to a child of the source
13634	medium is possible. Note that when cloning to an existing image, the
13635	@a parent argument is ignored.
13636
13637	After the returned progress object reports that the operation is
13638	successfully complete, the target medium gets remembered by this
13639	VirtualBox installation and may be attached to virtual machines.
13640
13641	<note>
13642	This medium will be placed to <link to="MediumState_LockedRead"/>
13643	state for the duration of this operation.
13644	</note>
13645	<result name="E_NOTIMPL">
13646	The specified cloning variant is not supported at the moment.
13647	</result>
13648	</desc>
13649	<param name="target" type="IMedium" dir="in">
13650	<desc>Target medium.</desc>
13651	</param>
13652	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13653	<desc><link to="MediumVariant" /> flags).</desc>
13654	</param>
13655	<param name="progress" type="IProgress" dir="return">
13656	<desc>Progress object to track the operation completion.</desc>
13657	</param>
13658	</method>
13659
13660	<!-- other methods -->
13661
13662	<method name="compact">
13663	<desc>
13664	Starts compacting of this medium. This means that the medium is
13665	transformed into a possibly more compact storage representation.
13666	This potentially creates temporary images, which can require a
13667	substantial amount of additional disk space.
13668
13669	This medium will be placed to <link to="MediumState_LockedWrite"/>
13670	state and all its parent media (if any) will be placed to
13671	<link to="MediumState_LockedRead"/> state for the duration of this
13672	operation.
13673
13674	Please note that the results can be either returned straight away,
13675	or later as the result of the background operation via the object
13676	returned via the @a progress parameter.
13677
13678	<result name="VBOX_E_NOT_SUPPORTED">
13679	Medium format does not support compacting (but potentially
13680	needs it).
13681	</result>
13682	</desc>
13683	<param name="progress" type="IProgress" dir="return">
13684	<desc>Progress object to track the operation completion.</desc>
13685	</param>
13686	</method>
13687
13688	<method name="resize">
13689	<desc>
13690	Starts resizing this medium. This means that the nominal size of the
13691	medium is set to the new value. Both increasing and decreasing the
13692	size is possible, and there are no safety checks, since VirtualBox
13693	does not make any assumptions about the medium contents.
13694
13695	Resizing usually needs additional disk space, and possibly also
13696	some temporary disk space. Note that resize does not create a full
13697	temporary copy of the medium, so the additional disk space requirement
13698	is usually much lower than using the clone operation.
13699
13700	This medium will be placed to <link to="MediumState_LockedWrite"/>
13701	state for the duration of this operation.
13702
13703	Please note that the results can be either returned straight away,
13704	or later as the result of the background operation via the object
13705	returned via the @a progress parameter.
13706
13707	<result name="VBOX_E_NOT_SUPPORTED">
13708	Medium format does not support resizing.
13709	</result>
13710	</desc>
13711	<param name="logicalSize" type="long long" dir="in">
13712	<desc>New nominal capacity of the medium in bytes.</desc>
13713	</param>
13714	<param name="progress" type="IProgress" dir="return">
13715	<desc>Progress object to track the operation completion.</desc>
13716	</param>
13717	</method>
13718
13719	<method name="reset">
13720	<desc>
13721	Starts erasing the contents of this differencing medium.
13722
13723	This operation will reset the differencing medium to its initial
13724	state when it does not contain any sector data and any read operation is
13725	redirected to its parent medium. This automatically gets called
13726	during VM power-up for every medium whose <link to="#autoReset" />
13727	attribute is @c true.
13728
13729	The medium will be write-locked for the duration of this operation (see
13730	<link to="#lockWrite" />).
13731
13732	<result name="VBOX_E_NOT_SUPPORTED">
13733	This is not a differencing medium.
13734	</result>
13735	<result name="VBOX_E_INVALID_OBJECT_STATE">
13736	Medium is not in <link to="MediumState_Created"/> or
13737	<link to="MediumState_Inaccessible"/> state.
13738	</result>
13739	</desc>
13740	<param name="progress" type="IProgress" dir="return">
13741	<desc>Progress object to track the operation completion.</desc>
13742	</param>
13743	</method>
13744
13745	</interface>
13746
13747
13748	<!--
13749	// IMediumFormat
13750	/////////////////////////////////////////////////////////////////////////
13751	-->
13752
13753	<enum
13754	name="DataType"
13755	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
13756	>
13757	<const name="Int32" value="0"/>
13758	<const name="Int8" value="1"/>
13759	<const name="String" value="2"/>
13760	</enum>
13761
13762	<enum
13763	name="DataFlags"
13764	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
13765	>
13766	<const name="None" value="0x00"/>
13767	<const name="Mandatory" value="0x01"/>
13768	<const name="Expert" value="0x02"/>
13769	<const name="Array" value="0x04"/>
13770	<const name="FlagMask" value="0x07"/>
13771	</enum>
13772
13773	<enum
13774	name="MediumFormatCapabilities"
13775	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
13776	>
13777	<desc>
13778	Medium format capability flags.
13779	</desc>
13780
13781	<const name="Uuid" value="0x01">
13782	<desc>
13783	Supports UUIDs as expected by VirtualBox code.
13784	</desc>
13785	</const>
13786
13787	<const name="CreateFixed" value="0x02">
13788	<desc>
13789	Supports creating fixed size images, allocating all space instantly.
13790	</desc>
13791	</const>
13792
13793	<const name="CreateDynamic" value="0x04">
13794	<desc>
13795	Supports creating dynamically growing images, allocating space on
13796	demand.
13797	</desc>
13798	</const>
13799
13800	<const name="CreateSplit2G" value="0x08">
13801	<desc>
13802	Supports creating images split in chunks of a bit less than 2 GBytes.
13803	</desc>
13804	</const>
13805
13806	<const name="Differencing" value="0x10">
13807	<desc>
13808	Supports being used as a format for differencing media (see <link
13809	to="IMedium::createDiffStorage"/>).
13810	</desc>
13811	</const>
13812
13813	<const name="Asynchronous" value="0x20">
13814	<desc>
13815	Supports asynchronous I/O operations for at least some configurations.
13816	</desc>
13817	</const>
13818
13819	<const name="File" value="0x40">
13820	<desc>
13821	The format backend operates on files (the <link to="IMedium::location"/>
13822	attribute of the medium specifies a file used to store medium
13823	data; for a list of supported file extensions see
13824	<link to="IMediumFormat::describeFileExtensions"/>).
13825	</desc>
13826	</const>
13827
13828	<const name="Properties" value="0x80">
13829	<desc>
13830	The format backend uses the property interface to configure the storage
13831	location and properties (the <link to="IMediumFormat::describeProperties"/>
13832	method is used to get access to properties supported by the given medium format).
13833	</desc>
13834	</const>
13835
13836	<const name="TcpNetworking" value="0x100">
13837	<desc>
13838	The format backend uses the TCP networking interface for network access.
13839	</desc>
13840	</const>
13841
13842	<const name="VFS" value="0x200">
13843	<desc>
13844	The format backend supports virtual filesystem functionality.
13845	</desc>
13846	</const>
13847
13848	<const name="CapabilityMask" value="0x3FF"/>
13849	</enum>
13850
13851	<interface
13852	name="IMediumFormat" extends="$unknown"
13853	uuid="6238e1cf-a17d-4ec1-8172-418bfb22b93a"
13854	wsmap="managed"
13855	>
13856	<desc>
13857	The IMediumFormat interface represents a medium format.
13858
13859	Each medium format has an associated backend which is used to handle
13860	media stored in this format. This interface provides information
13861	about the properties of the associated backend.
13862
13863	Each medium format is identified by a string represented by the
13864	<link to="#id"/> attribute. This string is used in calls like
13865	<link to="IVirtualBox::createHardDisk"/> to specify the desired
13866	format.
13867
13868	The list of all supported medium formats can be obtained using
13869	<link to="ISystemProperties::mediumFormats"/>.
13870
13871	<see><link to="IMedium"/></see>
13872	</desc>
13873
13874	<attribute name="id" type="wstring" readonly="yes">
13875	<desc>
13876	Identifier of this format.
13877
13878	The format identifier is a non-@c null non-empty ASCII string. Note that
13879	this string is case-insensitive. This means that, for example, all of
13880	the following strings:
13881	<pre>
13882	"VDI"
13883	"vdi"
13884	"VdI"</pre>
13885	refer to the same medium format.
13886
13887	This string is used in methods of other interfaces where it is necessary
13888	to specify a medium format, such as
13889	<link to="IVirtualBox::createHardDisk"/>.
13890	</desc>
13891	</attribute>
13892
13893	<attribute name="name" type="wstring" readonly="yes">
13894	<desc>
13895	Human readable description of this format.
13896
13897	Mainly for use in file open dialogs.
13898	</desc>
13899	</attribute>
13900
13901	<attribute name="capabilities" type="MediumFormatCapabilities" safearray="yes" readonly="yes">
13902	<desc>
13903	Capabilities of the format as an array of the flags.
13904
13905	For the meaning of individual capability flags see
13906	<link to="MediumFormatCapabilities"/>.
13907	</desc>
13908	</attribute>
13909
13910	<method name="describeFileExtensions">
13911	<desc>
13912	Returns two arrays describing the supported file extensions.
13913
13914	The first array contains the supported extensions and the seconds one
13915	the type each extension supports. Both have the same size.
13916
13917	Note that some backends do not work on files, so this array may be
13918	empty.
13919
13920	<see><link to="IMediumFormat::capabilities"/></see>
13921	</desc>
13922	<param name="extensions" type="wstring" safearray="yes" dir="out">
13923	<desc>The array of supported extensions.</desc>
13924	</param>
13925	<param name="types" type="DeviceType" safearray="yes" dir="out">
13926	<desc>The array which indicates the device type for every given extension.</desc>
13927	</param>
13928	</method>
13929
13930	<method name="describeProperties" const="yes">
13931	<desc>
13932	Returns several arrays describing the properties supported by this
13933	format.
13934
13935	An element with the given index in each array describes one
13936	property. Thus, the number of elements in each returned array is the
13937	same and corresponds to the number of supported properties.
13938
13939	The returned arrays are filled in only if the
13940	<link to="MediumFormatCapabilities_Properties"/> flag is set.
13941	All arguments must be non-@c null.
13942
13943	<see><link to="DataType"/>, <link to="DataFlags"/></see>
13944	</desc>
13945
13946	<param name="names" type="wstring" safearray="yes" dir="out">
13947	<desc>Array of property names.</desc>
13948	</param>
13949	<param name="descriptions" type="wstring" safearray="yes" dir="out">
13950	<desc>Array of property descriptions.</desc>
13951	</param>
13952	<param name="types" type="DataType" safearray="yes" dir="out">
13953	<desc>Array of property types.</desc>
13954	</param>
13955	<param name="flags" type="unsigned long" safearray="yes" dir="out">
13956	<desc>Array of property flags.</desc>
13957	</param>
13958	<param name="defaults" type="wstring" safearray="yes" dir="out">
13959	<desc>Array of default property values.</desc>
13960	</param>
13961	</method>
13962
13963	</interface>
13964
13965
13966	<!--
13967	// IKeyboard
13968	/////////////////////////////////////////////////////////////////////////
13969	-->
13970
13971	<interface
13972	name="IKeyboard" extends="$unknown"
13973	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
13974	wsmap="managed"
13975	>
13976	<desc>
13977	The IKeyboard interface represents the virtual machine's keyboard. Used
13978	in <link to="IConsole::keyboard"/>.
13979
13980	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
13981	to the virtual machine.
13982
13983	</desc>
13984	<method name="putScancode">
13985	<desc>Sends a scancode to the keyboard.
13986
13987	<result name="VBOX_E_IPRT_ERROR">
13988	Could not send scan code to virtual keyboard.
13989	</result>
13990
13991	</desc>
13992	<param name="scancode" type="long" dir="in"/>
13993	</method>
13994
13995	<method name="putScancodes">
13996	<desc>Sends an array of scancodes to the keyboard.
13997
13998	<result name="VBOX_E_IPRT_ERROR">
13999	Could not send all scan codes to virtual keyboard.
14000	</result>
14001
14002	</desc>
14003	<param name="scancodes" type="long" dir="in" safearray="yes"/>
14004	<param name="codesStored" type="unsigned long" dir="return"/>
14005	</method>
14006
14007	<method name="putCAD">
14008	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
14009	function is nothing special, it is just a convenience function
14010	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
14011
14012	<result name="VBOX_E_IPRT_ERROR">
14013	Could not send all scan codes to virtual keyboard.
14014	</result>
14015
14016	</desc>
14017	</method>
14018
14019	<attribute name="eventSource" type="IEventSource" readonly="yes">
14020	<desc>
14021	Event source for keyboard events.
14022	</desc>
14023	</attribute>
14024
14025	</interface>
14026
14027
14028	<!--
14029	// IMouse
14030	/////////////////////////////////////////////////////////////////////////
14031	-->
14032
14033	<enum
14034	name="MouseButtonState"
14035	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
14036	>
14037	<desc>
14038	Mouse button state.
14039	</desc>
14040
14041	<const name="LeftButton" value="0x01"/>
14042	<const name="RightButton" value="0x02"/>
14043	<const name="MiddleButton" value="0x04"/>
14044	<const name="WheelUp" value="0x08"/>
14045	<const name="WheelDown" value="0x10"/>
14046	<const name="XButton1" value="0x20"/>
14047	<const name="XButton2" value="0x40"/>
14048	<const name="MouseStateMask" value="0x7F"/>
14049	</enum>
14050
14051	<interface
14052	name="IMouse" extends="$unknown"
14053	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
14054	wsmap="managed"
14055	>
14056	<desc>
14057	The IMouse interface represents the virtual machine's mouse. Used in
14058	<link to="IConsole::mouse"/>.
14059
14060	Through this interface, the virtual machine's virtual mouse can be
14061	controlled.
14062	</desc>
14063
14064	<attribute name="absoluteSupported" type="boolean" readonly="yes">
14065	<desc>
14066	Whether the guest OS supports absolute mouse pointer positioning
14067	or not.
14068	<note>
14069	You can use the <link to="IMouseCapabilityChangedEvent"/>
14070	event to be instantly informed about changes of this attribute
14071	during virtual machine execution.
14072	</note>
14073	<see><link to="#putMouseEventAbsolute"/></see>
14074	</desc>
14075	</attribute>
14076
14077	<attribute name="relativeSupported" type="boolean" readonly="yes">
14078	<desc>
14079	Whether the guest OS supports relative mouse pointer positioning
14080	or not.
14081	<note>
14082	You can use the <link to="IMouseCapabilityChangedEvent"/>
14083	event to be instantly informed about changes of this attribute
14084	during virtual machine execution.
14085	</note>
14086	<see><link to="#putMouseEvent"/></see>
14087	</desc>
14088	</attribute>
14089
14090	<attribute name="needsHostCursor" type="boolean" readonly="yes">
14091	<desc>
14092	Whether the guest OS can currently switch to drawing it's own mouse
14093	cursor on demand.
14094	<note>
14095	You can use the <link to="IMouseCapabilityChangedEvent"/>
14096	event to be instantly informed about changes of this attribute
14097	during virtual machine execution.
14098	</note>
14099	<see><link to="#putMouseEvent"/></see>
14100	</desc>
14101	</attribute>
14102
14103	<method name="putMouseEvent">
14104	<desc>
14105	Initiates a mouse event using relative pointer movements
14106	along x and y axis.
14107
14108	<result name="E_ACCESSDENIED">
14109	Console not powered up.
14110	</result>
14111	<result name="VBOX_E_IPRT_ERROR">
14112	Could not send mouse event to virtual mouse.
14113	</result>
14114
14115	</desc>
14116
14117	<param name="dx" type="long" dir="in">
14118	<desc>
14119	Amount of pixels the mouse should move to the right.
14120	Negative values move the mouse to the left.
14121	</desc>
14122	</param>
14123	<param name="dy" type="long" dir="in">
14124	<desc>
14125	Amount of pixels the mouse should move downwards.
14126	Negative values move the mouse upwards.
14127	</desc>
14128	</param>
14129	<param name="dz" type="long" dir="in">
14130	<desc>
14131	Amount of mouse wheel moves.
14132	Positive values describe clockwise wheel rotations,
14133	negative values describe counterclockwise rotations.
14134	</desc>
14135	</param>
14136	<param name="dw" type="long" dir="in">
14137	<desc>
14138	Amount of horizontal mouse wheel moves.
14139	Positive values describe a movement to the left,
14140	negative values describe a movement to the right.
14141	</desc>
14142	</param>
14143	<param name="buttonState" type="long" dir="in">
14144	<desc>
14145	The current state of mouse buttons. Every bit represents
14146	a mouse button as follows:
14147	<table>
14148	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14149	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14150	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14151	</table>
14152	A value of <tt>1</tt> means the corresponding button is pressed.
14153	otherwise it is released.
14154	</desc>
14155	</param>
14156	</method>
14157
14158	<method name="putMouseEventAbsolute">
14159	<desc>
14160	Positions the mouse pointer using absolute x and y coordinates.
14161	These coordinates are expressed in pixels and
14162	start from <tt>[1,1]</tt> which corresponds to the top left
14163	corner of the virtual display.
14164
14165	<result name="E_ACCESSDENIED">
14166	Console not powered up.
14167	</result>
14168	<result name="VBOX_E_IPRT_ERROR">
14169	Could not send mouse event to virtual mouse.
14170	</result>
14171
14172	<note>
14173	This method will have effect only if absolute mouse
14174	positioning is supported by the guest OS.
14175	</note>
14176
14177	<see><link to="#absoluteSupported"/></see>
14178	</desc>
14179
14180	<param name="x" type="long" dir="in">
14181	<desc>
14182	X coordinate of the pointer in pixels, starting from @c 1.
14183	</desc>
14184	</param>
14185	<param name="y" type="long" dir="in">
14186	<desc>
14187	Y coordinate of the pointer in pixels, starting from @c 1.
14188	</desc>
14189	</param>
14190	<param name="dz" type="long" dir="in">
14191	<desc>
14192	Amount of mouse wheel moves.
14193	Positive values describe clockwise wheel rotations,
14194	negative values describe counterclockwise rotations.
14195	</desc>
14196	</param>
14197	<param name="dw" type="long" dir="in">
14198	<desc>
14199	Amount of horizontal mouse wheel moves.
14200	Positive values describe a movement to the left,
14201	negative values describe a movement to the right.
14202	</desc>
14203	</param>
14204	<param name="buttonState" type="long" dir="in">
14205	<desc>
14206	The current state of mouse buttons. Every bit represents
14207	a mouse button as follows:
14208	<table>
14209	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14210	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14211	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14212	</table>
14213	A value of @c 1 means the corresponding button is pressed.
14214	otherwise it is released.
14215	</desc>
14216	</param>
14217	</method>
14218
14219	<attribute name="eventSource" type="IEventSource" readonly="yes">
14220	<desc>
14221	Event source for mouse events.
14222	</desc>
14223	</attribute>
14224
14225	</interface>
14226
14227	<!--
14228	// IDisplay
14229	/////////////////////////////////////////////////////////////////////////
14230	-->
14231
14232	<enum
14233	name="FramebufferPixelFormat"
14234	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
14235	>
14236	<desc>
14237	Format of the video memory buffer. Constants represented by this enum can
14238	be used to test for particular values of <link
14239	to="IFramebuffer::pixelFormat"/>. See also <link
14240	to="IFramebuffer::requestResize"/>.
14241
14242	See also www.fourcc.org for more information about FOURCC pixel formats.
14243	</desc>
14244
14245	<const name="Opaque" value="0">
14246	<desc>
14247	Unknown buffer format (the user may not assume any particular format of
14248	the buffer).
14249	</desc>
14250	</const>
14251	<const name="FOURCC_RGB" value="0x32424752">
14252	<desc>
14253	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
14254	bit layout).
14255	</desc>
14256	</const>
14257	</enum>
14258
14259	<interface
14260	name="IFramebuffer" extends="$unknown"
14261	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
14262	wsmap="suppress"
14263	>
14264	<attribute name="address" type="octet" mod="ptr" readonly="yes">
14265	<desc>Address of the start byte of the frame buffer.</desc>
14266	</attribute>
14267
14268	<attribute name="width" type="unsigned long" readonly="yes">
14269	<desc>Frame buffer width, in pixels.</desc>
14270	</attribute>
14271
14272	<attribute name="height" type="unsigned long" readonly="yes">
14273	<desc>Frame buffer height, in pixels.</desc>
14274	</attribute>
14275
14276	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
14277	<desc>
14278	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
14279	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
14280	are: 8, 15, 16, 24 and 32.
14281	</desc>
14282	</attribute>
14283
14284	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
14285	<desc>
14286	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
14287	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
14288	size of the scan line must be aligned to 32 bits.
14289	</desc>
14290	</attribute>
14291
14292	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
14293	<desc>
14294	Frame buffer pixel format. It's either one of the values defined by <link
14295	to="FramebufferPixelFormat"/> or a raw FOURCC code.
14296	<note>
14297	This attribute must never return <link
14298	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
14299	<link to="#address"/> points to must be always known.
14300	</note>
14301	</desc>
14302	</attribute>
14303
14304	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
14305	<desc>
14306	Defines whether this frame buffer uses the virtual video card's memory
14307	buffer (guest VRAM) directly or not. See <link
14308	to="IFramebuffer::requestResize"/> for more information.
14309	</desc>
14310	</attribute>
14311
14312	<attribute name="heightReduction" type="unsigned long" readonly="yes">
14313	<desc>
14314	Hint from the frame buffer about how much of the standard
14315	screen height it wants to use for itself. This information is
14316	exposed to the guest through the VESA BIOS and VMMDev interface
14317	so that it can use it for determining its video mode table. It
14318	is not guaranteed that the guest respects the value.
14319	</desc>
14320	</attribute>
14321
14322	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
14323	<desc>
14324	An alpha-blended overlay which is superposed over the frame buffer.
14325	The initial purpose is to allow the display of icons providing
14326	information about the VM state, including disk activity, in front
14327	ends which do not have other means of doing that. The overlay is
14328	designed to controlled exclusively by IDisplay. It has no locking
14329	of its own, and any changes made to it are not guaranteed to be
14330	visible until the affected portion of IFramebuffer is updated. The
14331	overlay can be created lazily the first time it is requested. This
14332	attribute can also return @c null to signal that the overlay is not
14333	implemented.
14334	</desc>
14335	</attribute>
14336
14337	<attribute name="winId" type="long long" readonly="yes">
14338	<desc>
14339	Platform-dependent identifier of the window where context of this
14340	frame buffer is drawn, or zero if there's no such window.
14341	</desc>
14342	</attribute>
14343
14344	<method name="lock">
14345	<desc>
14346	Locks the frame buffer.
14347	Gets called by the IDisplay object where this frame buffer is
14348	bound to.
14349	</desc>
14350	</method>
14351
14352	<method name="unlock">
14353	<desc>
14354	Unlocks the frame buffer.
14355	Gets called by the IDisplay object where this frame buffer is
14356	bound to.
14357	</desc>
14358	</method>
14359
14360	<method name="notifyUpdate">
14361	<desc>
14362	Informs about an update.
14363	Gets called by the display object where this buffer is
14364	registered.
14365	</desc>
14366	<param name="x" type="unsigned long" dir="in"/>
14367	<param name="y" type="unsigned long" dir="in"/>
14368	<param name="width" type="unsigned long" dir="in"/>
14369	<param name="height" type="unsigned long" dir="in"/>
14370	</method>
14371
14372	<method name="requestResize">
14373	<desc>
14374	Requests a size and pixel format change.
14375
14376	There are two modes of working with the video buffer of the virtual
14377	machine. The <i>indirect</i> mode implies that the IFramebuffer
14378	implementation allocates a memory buffer for the requested display mode
14379	and provides it to the virtual machine. In <i>direct</i> mode, the
14380	IFramebuffer implementation uses the memory buffer allocated and owned
14381	by the virtual machine. This buffer represents the video memory of the
14382	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
14383	usually faster because the implementation gets a raw pointer to the
14384	guest VRAM buffer which it can directly use for visualizing the contents
14385	of the virtual display, as opposed to the indirect mode where the
14386	contents of guest VRAM are copied to the memory buffer provided by
14387	the implementation every time a display update occurs.
14388
14389	It is important to note that the direct mode is really fast only when
14390	the implementation uses the given guest VRAM buffer directly, for
14391	example, by blitting it to the window representing the virtual machine's
14392	display, which saves at least one copy operation comparing to the
14393	indirect mode. However, using the guest VRAM buffer directly is not
14394	always possible: the format and the color depth of this buffer may be
14395	not supported by the target window, or it may be unknown (opaque) as in
14396	case of text or non-linear multi-plane VGA video modes. In this case,
14397	the indirect mode (that is always available) should be used as a
14398	fallback: when the guest VRAM contents are copied to the
14399	implementation-provided memory buffer, color and format conversion is
14400	done automatically by the underlying code.
14401
14402	The @a pixelFormat parameter defines whether the direct mode is
14403	available or not. If @a pixelFormat is <link
14404	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
14405	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
14406	@a bytesPerLine parameters must be ignored and the implementation must use
14407	the indirect mode (where it provides its own buffer in one of the
14408	supported formats). In all other cases, @a pixelFormat together with
14409	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
14410	buffer pointed to by the @a VRAM parameter and the implementation is
14411	free to choose which mode to use. To indicate that this frame buffer uses
14412	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
14413	attribute must return @c true and <link to="#address"/> must
14414	return exactly the same address that is passed in the @a VRAM parameter
14415	of this method; otherwise it is assumed that the indirect strategy is
14416	chosen.
14417
14418	The @a width and @a height parameters represent the size of the
14419	requested display mode in both modes. In case of indirect mode, the
14420	provided memory buffer should be big enough to store data of the given
14421	display mode. In case of direct mode, it is guaranteed that the given
14422	@a VRAM buffer contains enough space to represent the display mode of the
14423	given size. Note that this frame buffer's <link to="#width"/> and <link
14424	to="#height"/> attributes must return exactly the same values as
14425	passed to this method after the resize is completed (see below).
14426
14427	The @a finished output parameter determines if the implementation has
14428	finished resizing the frame buffer or not. If, for some reason, the
14429	resize cannot be finished immediately during this call, @a finished
14430	must be set to @c false, and the implementation must call
14431	<link to="IDisplay::resizeCompleted"/> after it has returned from
14432	this method as soon as possible. If @a finished is @c false, the
14433	machine will not call any frame buffer methods until
14434	<link to="IDisplay::resizeCompleted"/> is called.
14435
14436	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
14437	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
14438	this frame buffer must return exactly the same values as specified in the
14439	parameters of this method, after the resize is completed. If the
14440	indirect mode is chosen, these attributes must return values describing
14441	the format of the implementation's own memory buffer <link
14442	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
14443	value must always correlate with <link to="#pixelFormat"/>. Note that
14444	the <link to="#pixelFormat"/> attribute must never return <link
14445	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
14446
14447	<note>
14448	This method is called by the IDisplay object under the
14449	<link to="#lock"/> provided by this IFramebuffer
14450	implementation. If this method returns @c false in @a finished, then
14451	this lock is not released until
14452	<link to="IDisplay::resizeCompleted"/> is called.
14453	</note>
14454	</desc>
14455	<param name="screenId" type="unsigned long" dir="in">
14456	<desc>
14457	Logical screen number. Must be used in the corresponding call to
14458	<link to="IDisplay::resizeCompleted"/> if this call is made.
14459	</desc>
14460	</param>
14461	<param name="pixelFormat" type="unsigned long" dir="in">
14462	<desc>
14463	Pixel format of the memory buffer pointed to by @a VRAM.
14464	See also <link to="FramebufferPixelFormat"/>.
14465	</desc>
14466	</param>
14467	<param name="VRAM" type="octet" mod="ptr" dir="in">
14468	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
14469	</param>
14470	<param name="bitsPerPixel" type="unsigned long" dir="in">
14471	<desc>Color depth, bits per pixel.</desc>
14472	</param>
14473	<param name="bytesPerLine" type="unsigned long" dir="in">
14474	<desc>Size of one scan line, in bytes.</desc>
14475	</param>
14476	<param name="width" type="unsigned long" dir="in">
14477	<desc>Width of the guest display, in pixels.</desc>
14478	</param>
14479	<param name="height" type="unsigned long" dir="in">
14480	<desc>Height of the guest display, in pixels.</desc>
14481	</param>
14482	<param name="finished" type="boolean" dir="return">
14483	<desc>
14484	Can the VM start using the new frame buffer immediately
14485	after this method returns or it should wait for
14486	<link to="IDisplay::resizeCompleted"/>.
14487	</desc>
14488	</param>
14489	</method>
14490
14491	<method name="videoModeSupported">
14492	<desc>
14493	Returns whether the frame buffer implementation is willing to
14494	support a given video mode. In case it is not able to render
14495	the video mode (or for some reason not willing), it should
14496	return @c false. Usually this method is called when the guest
14497	asks the VMM device whether a given video mode is supported
14498	so the information returned is directly exposed to the guest.
14499	It is important that this method returns very quickly.
14500	</desc>
14501	<param name="width" type="unsigned long" dir="in"/>
14502	<param name="height" type="unsigned long" dir="in"/>
14503	<param name="bpp" type="unsigned long" dir="in"/>
14504	<param name="supported" type="boolean" dir="return"/>
14505	</method>
14506
14507	<method name="getVisibleRegion">
14508	<desc>
14509	Returns the visible region of this frame buffer.
14510
14511	If the @a rectangles parameter is @c null then the value of the
14512	@a count parameter is ignored and the number of elements necessary to
14513	describe the current visible region is returned in @a countCopied.
14514
14515	If @a rectangles is not @c null but @a count is less
14516	than the required number of elements to store region data, the method
14517	will report a failure. If @a count is equal or greater than the
14518	required number of elements, then the actual number of elements copied
14519	to the provided array will be returned in @a countCopied.
14520
14521	<note>
14522	The address of the provided array must be in the process space of
14523	this IFramebuffer object.
14524	</note>
14525	<note>
14526	Method not yet implemented.
14527	</note>
14528	</desc>
14529	<param name="rectangles" type="octet" mod="ptr" dir="in">
14530	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
14531	</param>
14532	<param name="count" type="unsigned long" dir="in">
14533	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14534	</param>
14535	<param name="countCopied" type="unsigned long" dir="return">
14536	<desc>Number of elements copied to the @a rectangles array.</desc>
14537	</param>
14538	</method>
14539
14540	<method name="setVisibleRegion">
14541	<desc>
14542	Suggests a new visible region to this frame buffer. This region
14543	represents the area of the VM display which is a union of regions of
14544	all top-level windows of the guest operating system running inside the
14545	VM (if the Guest Additions for this system support this
14546	functionality). This information may be used by the frontends to
14547	implement the seamless desktop integration feature.
14548
14549	<note>
14550	The address of the provided array must be in the process space of
14551	this IFramebuffer object.
14552	</note>
14553	<note>
14554	The IFramebuffer implementation must make a copy of the provided
14555	array of rectangles.
14556	</note>
14557	<note>
14558	Method not yet implemented.
14559	</note>
14560	</desc>
14561	<param name="rectangles" type="octet" mod="ptr" dir="in">
14562	<desc>Pointer to the @c RTRECT array.</desc>
14563	</param>
14564	<param name="count" type="unsigned long" dir="in">
14565	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14566	</param>
14567	</method>
14568
14569	<method name="processVHWACommand">
14570	<desc>
14571	Posts a Video HW Acceleration Command to the frame buffer for processing.
14572	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
14573	are posted from quest to the host to be processed by the host hardware.
14574
14575	<note>
14576	The address of the provided command must be in the process space of
14577	this IFramebuffer object.
14578	</note>
14579	</desc>
14580
14581	<param name="command" type="octet" mod="ptr" dir="in">
14582	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
14583	</param>
14584	</method>
14585
14586	</interface>
14587
14588	<interface
14589	name="IFramebufferOverlay" extends="IFramebuffer"
14590	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
14591	wsmap="suppress"
14592	>
14593	<desc>
14594	The IFramebufferOverlay interface represents an alpha blended overlay
14595	for displaying status icons above an IFramebuffer. It is always created
14596	not visible, so that it must be explicitly shown. It only covers a
14597	portion of the IFramebuffer, determined by its width, height and
14598	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
14599	that order) format, and may be written to directly. Do re-read the
14600	width though, after setting it, as it may be adjusted (increased) to
14601	make it more suitable for the front end.
14602	</desc>
14603	<attribute name="x" type="unsigned long" readonly="yes">
14604	<desc>X position of the overlay, relative to the frame buffer.</desc>
14605	</attribute>
14606
14607	<attribute name="y" type="unsigned long" readonly="yes">
14608	<desc>Y position of the overlay, relative to the frame buffer.</desc>
14609	</attribute>
14610
14611	<attribute name="visible" type="boolean">
14612	<desc>
14613	Whether the overlay is currently visible.
14614	</desc>
14615	</attribute>
14616
14617	<attribute name="alpha" type="unsigned long">
14618	<desc>
14619	The global alpha value for the overlay. This may or may not be
14620	supported by a given front end.
14621	</desc>
14622	</attribute>
14623
14624	<method name="move">
14625	<desc>
14626	Changes the overlay's position relative to the IFramebuffer.
14627	</desc>
14628	<param name="x" type="unsigned long" dir="in"/>
14629	<param name="y" type="unsigned long" dir="in"/>
14630	</method>
14631
14632	</interface>
14633
14634	<interface
14635	name="IDisplay" extends="$unknown"
14636	uuid="b83ee395-8679-40ca-8d60-1a0cbe724930"
14637	wsmap="managed"
14638	>
14639	<desc>
14640	The IDisplay interface represents the virtual machine's display.
14641
14642	The object implementing this interface is contained in each
14643	<link to="IConsole::display"/> attribute and represents the visual
14644	output of the virtual machine.
14645
14646	The virtual display supports pluggable output targets represented by the
14647	IFramebuffer interface. Examples of the output target are a window on
14648	the host computer or an RDP session's display on a remote computer.
14649	</desc>
14650	<method name="getScreenResolution">
14651	<desc>Queries display width, height and color depth for given screen.</desc>
14652	<param name="screenId" type="unsigned long" dir="in"/>
14653	<param name="width" type="unsigned long" dir="out"/>
14654	<param name="height" type="unsigned long" dir="out"/>
14655	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
14656	</method>
14657
14658	<method name="setFramebuffer">
14659	<desc>
14660	Sets the framebuffer for given screen.
14661	</desc>
14662	<param name="screenId" type="unsigned long" dir="in"/>
14663	<param name="framebuffer" type="IFramebuffer" dir="in"/>
14664	</method>
14665
14666	<method name="getFramebuffer">
14667	<desc>
14668	Queries the framebuffer for given screen.
14669	</desc>
14670	<param name="screenId" type="unsigned long" dir="in"/>
14671	<param name="framebuffer" type="IFramebuffer" dir="out"/>
14672	<param name="xOrigin" type="long" dir="out"/>
14673	<param name="yOrigin" type="long" dir="out"/>
14674	</method>
14675
14676	<method name="setVideoModeHint">
14677	<desc>
14678	Asks VirtualBox to request the given video mode from
14679	the guest. This is just a hint and it cannot be guaranteed
14680	that the requested resolution will be used. Guest Additions
14681	are required for the request to be seen by guests. The caller
14682	should issue the request and wait for a resolution change and
14683	after a timeout retry.
14684
14685	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
14686	parameters means that the corresponding values should be taken from the
14687	current video mode (i.e. left unchanged).
14688
14689	If the guest OS supports multi-monitor configuration then the @a display
14690	parameter specifies the number of the guest display to send the hint to:
14691	@c 0 is the primary display, @c 1 is the first secondary and
14692	so on. If the multi-monitor configuration is not supported, @a display
14693	must be @c 0.
14694
14695	<result name="E_INVALIDARG">
14696	The @a display is not associated with any monitor.
14697	</result>
14698
14699	</desc>
14700	<param name="display" type="unsigned long" dir="in">
14701	<desc>
14702	The number of the guest display to send the hint to.
14703	</desc>
14704	</param>
14705	<param name="enabled" type="boolean" dir="in">
14706	<desc>
14707	@c True, if this guest screen is enabled,
14708	@c False otherwise.
14709	</desc>
14710	</param>
14711	<param name="changeOrigin" type="boolean" dir="in">
14712	<desc>
14713	@c True, if the origin of the guest screen should be changed,
14714	@c False otherwise.
14715	</desc>
14716	</param>
14717	<param name="originX" type="long" dir="in">
14718	<desc>
14719	The X origin of the guest screen.
14720	</desc>
14721	</param>
14722	<param name="originY" type="long" dir="in">
14723	<desc>
14724	The Y origin of the guest screen.
14725	</desc>
14726	</param>
14727	<param name="width" type="unsigned long" dir="in"/>
14728	<param name="height" type="unsigned long" dir="in"/>
14729	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
14730	</method>
14731
14732	<method name="setSeamlessMode">
14733	<desc>
14734	Enables or disables seamless guest display rendering (seamless desktop
14735	integration) mode.
14736	<note>
14737	Calling this method has no effect if <link
14738	to="IGuest::getFacilityStatus"/> with facility @c Seamless
14739	does not return @c Active.
14740	</note>
14741	</desc>
14742	<param name="enabled" type="boolean" dir="in"/>
14743	</method>
14744
14745	<method name="takeScreenShot">
14746	<desc>
14747	Takes a screen shot of the requested size and copies it to the
14748	32-bpp buffer allocated by the caller and pointed to by @a address.
14749	A pixel consists of 4 bytes in order: B, G, R, 0.
14750
14751	<note>This API can be used only locally by a VM process through the
14752	COM/XPCOM C++ API as it requires pointer support. It is not
14753	available for scripting langages, Java or any webservice clients.
14754	Unless you are writing a new VM frontend use
14755	<link to="#takeScreenShotToArray" />.
14756	</note>
14757
14758	<result name="E_NOTIMPL">
14759	Feature not implemented.
14760	</result>
14761	<result name="VBOX_E_IPRT_ERROR">
14762	Could not take a screenshot.
14763	</result>
14764
14765	</desc>
14766	<param name="screenId" type="unsigned long" dir="in"/>
14767	<param name="address" type="octet" mod="ptr" dir="in"/>
14768	<param name="width" type="unsigned long" dir="in"/>
14769	<param name="height" type="unsigned long" dir="in"/>
14770	</method>
14771
14772	<method name="takeScreenShotToArray">
14773	<desc>
14774	Takes a guest screen shot of the requested size and returns it as
14775	an array of bytes in uncompressed 32-bit RGBA format.
14776	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
14777
14778	This API is slow, but could be the only option to get guest screenshot
14779	for scriptable languages not allowed to manipulate with addresses
14780	directly.
14781
14782	<result name="E_NOTIMPL">
14783	Feature not implemented.
14784	</result>
14785	<result name="VBOX_E_IPRT_ERROR">
14786	Could not take a screenshot.
14787	</result>
14788	</desc>
14789	<param name="screenId" type="unsigned long" dir="in">
14790	<desc>
14791	Monitor to take screenshot from.
14792	</desc>
14793	</param>
14794	<param name="width" type="unsigned long" dir="in">
14795	<desc>
14796	Desired image width.
14797	</desc>
14798	</param>
14799	<param name="height" type="unsigned long" dir="in">
14800	<desc>
14801	Desired image height.
14802	</desc>
14803	</param>
14804	<param name="screenData" type="octet" dir="return" safearray="yes">
14805	<desc>
14806	Array with resulting screen data.
14807	</desc>
14808	</param>
14809	</method>
14810
14811	<method name="takeScreenShotPNGToArray">
14812	<desc>
14813	Takes a guest screen shot of the requested size and returns it as
14814	PNG image in array.
14815
14816	<result name="E_NOTIMPL">
14817	Feature not implemented.
14818	</result>
14819	<result name="VBOX_E_IPRT_ERROR">
14820	Could not take a screenshot.
14821	</result>
14822	</desc>
14823	<param name="screenId" type="unsigned long" dir="in">
14824	<desc>
14825	Monitor to take the screenshot from.
14826	</desc>
14827	</param>
14828	<param name="width" type="unsigned long" dir="in">
14829	<desc>
14830	Desired image width.
14831	</desc>
14832	</param>
14833	<param name="height" type="unsigned long" dir="in">
14834	<desc>
14835	Desired image height.
14836	</desc>
14837	</param>
14838	<param name="screenData" type="octet" dir="return" safearray="yes">
14839	<desc>
14840	Array with resulting screen data.
14841	</desc>
14842	</param>
14843	</method>
14844
14845	<method name="drawToScreen">
14846	<desc>
14847	Draws a 32-bpp image of the specified size from the given buffer
14848	to the given point on the VM display.
14849
14850	<result name="E_NOTIMPL">
14851	Feature not implemented.
14852	</result>
14853	<result name="VBOX_E_IPRT_ERROR">
14854	Could not draw to screen.
14855	</result>
14856
14857	</desc>
14858	<param name="screenId" type="unsigned long" dir="in">
14859	<desc>
14860	Monitor to take the screenshot from.
14861	</desc>
14862	</param>
14863	<param name="address" type="octet" mod="ptr" dir="in">
14864	<desc>
14865	Address to store the screenshot to
14866	</desc>
14867	</param>
14868	<param name="x" type="unsigned long" dir="in">
14869	<desc>
14870	Relative to the screen top left corner.
14871	</desc>
14872	</param>
14873	<param name="y" type="unsigned long" dir="in">
14874	<desc>
14875	Relative to the screen top left corner.
14876	</desc>
14877	</param>
14878	<param name="width" type="unsigned long" dir="in">
14879	<desc>
14880	Desired image width.
14881	</desc>
14882	</param>
14883	<param name="height" type="unsigned long" dir="in">
14884	<desc>
14885	Desired image height.
14886	</desc>
14887	</param>
14888	</method>
14889
14890	<method name="invalidateAndUpdate">
14891	<desc>
14892	Does a full invalidation of the VM display and instructs the VM
14893	to update it.
14894
14895	<result name="VBOX_E_IPRT_ERROR">
14896	Could not invalidate and update screen.
14897	</result>
14898
14899	</desc>
14900	</method>
14901
14902	<method name="resizeCompleted">
14903	<desc>
14904	Signals that a framebuffer has completed the resize operation.
14905
14906	<result name="VBOX_E_NOT_SUPPORTED">
14907	Operation only valid for external frame buffers.
14908	</result>
14909
14910	</desc>
14911	<param name="screenId" type="unsigned long" dir="in"/>
14912	</method>
14913
14914	<method name="completeVHWACommand">
14915	<desc>
14916	Signals that the Video HW Acceleration command has completed.
14917	</desc>
14918
14919	<param name="command" type="octet" mod="ptr" dir="in">
14920	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
14921	</param>
14922	</method>
14923
14924	<method name="viewportChanged">
14925	<desc>
14926	Signals that framebuffer window viewport has changed.
14927
14928	<result name="E_INVALIDARG">
14929	The specified viewport data is invalid.
14930	</result>
14931
14932	</desc>
14933
14934	<param name="screenId" type="unsigned long" dir="in">
14935	<desc>
14936	Monitor to take the screenshot from.
14937	</desc>
14938	</param>
14939	<param name="x" type="unsigned long" dir="in">
14940	<desc>
14941	Framebuffer x offset.
14942	</desc>
14943	</param>
14944	<param name="y" type="unsigned long" dir="in">
14945	<desc>
14946	Framebuffer y offset.
14947	</desc>
14948	</param>
14949	<param name="width" type="unsigned long" dir="in">
14950	<desc>
14951	Viewport width.
14952	</desc>
14953	</param>
14954	<param name="height" type="unsigned long" dir="in">
14955	<desc>
14956	Viewport height.
14957	</desc>
14958	</param>
14959	</method>
14960	</interface>
14961
14962	<!--
14963	// INetworkAdapter
14964	/////////////////////////////////////////////////////////////////////////
14965	-->
14966
14967	<enum
14968	name="NetworkAttachmentType"
14969	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
14970	>
14971	<desc>
14972	Network attachment type.
14973	</desc>
14974
14975	<const name="Null" value="0">
14976	<desc>Null value, also means "not attached".</desc>
14977	</const>
14978	<const name="NAT" value="1"/>
14979	<const name="Bridged" value="2"/>
14980	<const name="Internal" value="3"/>
14981	<const name="HostOnly" value="4"/>
14982	<const name="Generic" value="5"/>
14983	</enum>
14984
14985	<enum
14986	name="NetworkAdapterType"
14987	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
14988	>
14989	<desc>
14990	Network adapter type.
14991	</desc>
14992
14993	<const name="Null" value="0">
14994	<desc>Null value (never used by the API).</desc>
14995	</const>
14996	<const name="Am79C970A" value="1">
14997	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
14998	</const>
14999	<const name="Am79C973" value="2">
15000	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
15001	</const>
15002	<const name="I82540EM" value="3">
15003	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
15004	</const>
15005	<const name="I82543GC" value="4">
15006	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
15007	</const>
15008	<const name="I82545EM" value="5">
15009	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
15010	</const>
15011	<const name="Virtio" value="6">
15012	<desc>Virtio network device.</desc>
15013	</const>
15014	</enum>
15015
15016	<enum
15017	name="NetworkAdapterPromiscModePolicy"
15018	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
15019	>
15020	<desc>
15021	The promiscuous mode policy of an interface.
15022	</desc>
15023
15024	<const name="Deny" value="1">
15025	<desc>Deny promiscuous mode requests.</desc>
15026	</const>
15027	<const name="AllowNetwork" value="2">
15028	<desc>
15029	Allow promicuous mode, but restrict the scope it to the internal
15030	network so that it only applies to other VMs.
15031	</desc>
15032	</const>
15033	<const name="AllowAll" value="3">
15034	<desc>
15035	Allow promicuous mode, include unrelated traffic going over the wire
15036	and internally on the host.
15037	</desc>
15038	</const>
15039	</enum>
15040
15041	<interface
15042	name="INetworkAdapter" extends="$unknown"
15043	uuid="efa0f965-63c7-4c60-afdf-b1cc9943b9c0"
15044	wsmap="managed"
15045	>
15046	<desc>
15047	Represents a virtual network adapter that is attached to a virtual machine.
15048	Each virtual machine has a fixed number of network adapter slots with one
15049	instance of this attached to each of them. Call
15050	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
15051	is attached to a given slot in a given machine.
15052
15053	Each network adapter can be in one of five attachment modes, which are
15054	represented by the <link to="NetworkAttachmentType" /> enumeration;
15055	see the <link to="#attachmentType" /> attribute.
15056	</desc>
15057
15058	<attribute name="adapterType" type="NetworkAdapterType">
15059	<desc>
15060	Type of the virtual network adapter. Depending on this value,
15061	VirtualBox will provide a different virtual network hardware
15062	to the guest.
15063	</desc>
15064	</attribute>
15065
15066	<attribute name="slot" type="unsigned long" readonly="yes">
15067	<desc>
15068	Slot number this adapter is plugged into. Corresponds to
15069	the value you pass to <link to="IMachine::getNetworkAdapter"/>
15070	to obtain this instance.
15071	</desc>
15072	</attribute>
15073
15074	<attribute name="enabled" type="boolean">
15075	<desc>
15076	Flag whether the network adapter is present in the
15077	guest system. If disabled, the virtual guest hardware will
15078	not contain this network adapter. Can only be changed when
15079	the VM is not running.
15080	</desc>
15081	</attribute>
15082
15083	<attribute name="MACAddress" type="wstring">
15084	<desc>
15085	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
15086	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
15087	</desc>
15088	</attribute>
15089
15090	<attribute name="attachmentType" type="NetworkAttachmentType">
15091	<desc>
15092	Sets/Gets network attachment type of this network adapter.
15093	</desc>
15094	</attribute>
15095
15096	<attribute name="bridgedInterface" type="wstring">
15097	<desc>
15098	Name of the network interface the VM should be bridged to.
15099	</desc>
15100	</attribute>
15101
15102	<attribute name="hostOnlyInterface" type="wstring">
15103	<desc>
15104	Name of the host only network interface the VM is attached to.
15105	</desc>
15106	</attribute>
15107
15108	<attribute name="internalNetwork" type="wstring">
15109	<desc>
15110	Name of the internal network the VM is attached to.
15111	</desc>
15112	</attribute>
15113
15114	<attribute name="NATNetwork" type="wstring">
15115	<desc>
15116	Name of the NAT network the VM is attached to.
15117	</desc>
15118	</attribute>
15119
15120	<attribute name="genericDriver" type="wstring">
15121	<desc>
15122	Name of the driver to use for the "Generic" network attachment type.
15123	</desc>
15124	</attribute>
15125
15126	<attribute name="cableConnected" type="boolean">
15127	<desc>
15128	Flag whether the adapter reports the cable as connected or not.
15129	It can be used to report offline situations to a VM.
15130	</desc>
15131	</attribute>
15132
15133	<attribute name="lineSpeed" type="unsigned long">
15134	<desc>
15135	Line speed reported by custom drivers, in units of 1 kbps.
15136	</desc>
15137	</attribute>
15138
15139	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
15140	<desc>
15141	The promiscuous mode policy of the network adapter when attached to an
15142	internal network, host only network or a bridge.
15143	</desc>
15144	</attribute>
15145
15146	<attribute name="traceEnabled" type="boolean">
15147	<desc>
15148	Flag whether network traffic from/to the network card should be traced.
15149	Can only be toggled when the VM is turned off.
15150	</desc>
15151	</attribute>
15152
15153	<attribute name="traceFile" type="wstring">
15154	<desc>
15155	Filename where a network trace will be stored. If not set, VBox-pid.pcap
15156	will be used.
15157	</desc>
15158	</attribute>
15159
15160	<attribute name="NATEngine" type="INATEngine" readonly="yes">
15161	<desc>
15162	Points to the NAT engine which handles the network address translation
15163	for this interface. This is active only when the interface actually uses
15164	NAT.
15165	</desc>
15166	</attribute>
15167
15168	<attribute name="bootPriority" type="unsigned long">
15169	<desc>
15170	Network boot priority of the adapter. Priority 1 is highest. If not set,
15171	the priority is considered to be at the lowest possible setting.
15172	</desc>
15173	</attribute>
15174
15175	<attribute name="bandwidthGroup" type="IBandwidthGroup">
15176	<desc>The bandwidth group this network adapter is assigned to.</desc>
15177	</attribute>
15178
15179	<!-- property methods -->
15180
15181	<method name="getProperty" const="yes">
15182	<desc>
15183	Returns the value of the network attachment property with the given name.
15184
15185	If the requested data @a key does not exist, this function will
15186	succeed and return an empty string in the @a value argument.
15187
15188	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
15189	</desc>
15190	<param name="key" type="wstring" dir="in">
15191	<desc>Name of the property to get.</desc>
15192	</param>
15193	<param name="value" type="wstring" dir="return">
15194	<desc>Current property value.</desc>
15195	</param>
15196	</method>
15197
15198	<method name="setProperty">
15199	<desc>
15200	Sets the value of the network attachment property with the given name.
15201
15202	Setting the property value to @c null or an empty string is equivalent
15203	to deleting the existing value.
15204
15205	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
15206	</desc>
15207	<param name="key" type="wstring" dir="in">
15208	<desc>Name of the property to set.</desc>
15209	</param>
15210	<param name="value" type="wstring" dir="in">
15211	<desc>Property value to set.</desc>
15212	</param>
15213	</method>
15214
15215	<method name="getProperties" const="yes">
15216	<desc>
15217	Returns values for a group of properties in one call.
15218
15219	The names of the properties to get are specified using the @a names
15220	argument which is a list of comma-separated property names or
15221	an empty string if all properties are to be returned.
15222	<note>Currently the value of this argument is ignored and the method
15223	always returns all existing properties.</note>
15224
15225	The method returns two arrays, the array of property names corresponding
15226	to the @a names argument and the current values of these properties.
15227	Both arrays have the same number of elements with each element at the
15228	given index in the first array corresponds to an element at the same
15229	index in the second array.
15230	</desc>
15231	<param name="names" type="wstring" dir="in">
15232	<desc>
15233	Names of properties to get.
15234	</desc>
15235	</param>
15236	<param name="returnNames" type="wstring" safearray="yes" dir="out">
15237	<desc>Names of returned properties.</desc>
15238	</param>
15239	<param name="returnValues" type="wstring" safearray="yes" dir="return">
15240	<desc>Values of returned properties.</desc>
15241	</param>
15242	</method>
15243
15244	</interface>
15245
15246
15247	<!--
15248	// ISerialPort
15249	/////////////////////////////////////////////////////////////////////////
15250	-->
15251
15252	<enum
15253	name="PortMode"
15254	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
15255	>
15256	<desc>
15257	The PortMode enumeration represents possible communication modes for
15258	the virtual serial port device.
15259	</desc>
15260
15261	<const name="Disconnected" value="0">
15262	<desc>Virtual device is not attached to any real host device.</desc>
15263	</const>
15264	<const name="HostPipe" value="1">
15265	<desc>Virtual device is attached to a host pipe.</desc>
15266	</const>
15267	<const name="HostDevice" value="2">
15268	<desc>Virtual device is attached to a host device.</desc>
15269	</const>
15270	<const name="RawFile" value="3">
15271	<desc>Virtual device is attached to a raw file.</desc>
15272	</const>
15273	</enum>
15274
15275	<interface
15276	name="ISerialPort" extends="$unknown"
15277	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
15278	wsmap="managed"
15279	>
15280
15281	<desc>
15282	The ISerialPort interface represents the virtual serial port device.
15283
15284	The virtual serial port device acts like an ordinary serial port
15285	inside the virtual machine. This device communicates to the real
15286	serial port hardware in one of two modes: host pipe or host device.
15287
15288	In host pipe mode, the #path attribute specifies the path to the pipe on
15289	the host computer that represents a serial port. The #server attribute
15290	determines if this pipe is created by the virtual machine process at
15291	machine startup or it must already exist before starting machine
15292	execution.
15293
15294	In host device mode, the #path attribute specifies the name of the
15295	serial port device on the host computer.
15296
15297	There is also a third communication mode: the disconnected mode. In this
15298	mode, the guest OS running inside the virtual machine will be able to
15299	detect the serial port, but all port write operations will be discarded
15300	and all port read operations will return no data.
15301
15302	<see><link to="IMachine::getSerialPort"/></see>
15303	</desc>
15304
15305	<attribute name="slot" type="unsigned long" readonly="yes">
15306	<desc>
15307	Slot number this serial port is plugged into. Corresponds to
15308	the value you pass to <link to="IMachine::getSerialPort"/>
15309	to obtain this instance.
15310	</desc>
15311	</attribute>
15312
15313	<attribute name="enabled" type="boolean">
15314	<desc>
15315	Flag whether the serial port is enabled. If disabled,
15316	the serial port will not be reported to the guest OS.
15317	</desc>
15318	</attribute>
15319
15320	<attribute name="IOBase" type="unsigned long">
15321	<desc>Base I/O address of the serial port.</desc>
15322	</attribute>
15323
15324	<attribute name="IRQ" type="unsigned long">
15325	<desc>IRQ number of the serial port.</desc>
15326	</attribute>
15327
15328	<attribute name="hostMode" type="PortMode">
15329	<desc>
15330	How is this port connected to the host.
15331	<note>
15332	Changing this attribute may fail if the conditions for
15333	<link to="#path"/> are not met.
15334	</note>
15335	</desc>
15336	</attribute>
15337
15338	<attribute name="server" type="boolean">
15339	<desc>
15340	Flag whether this serial port acts as a server (creates a new pipe on
15341	the host) or as a client (uses the existing pipe). This attribute is
15342	used only when <link to="#hostMode"/> is PortMode_HostPipe.
15343	</desc>
15344	</attribute>
15345
15346	<attribute name="path" type="wstring">
15347	<desc>
15348	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
15349	PortMode_HostPipe, or the host serial device name when
15350	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
15351	cases, setting a @c null or empty string as the attribute's value
15352	is an error. Otherwise, the value of this property is ignored.
15353	</desc>
15354	</attribute>
15355
15356	</interface>
15357
15358	<!--
15359	// IParallelPort
15360	/////////////////////////////////////////////////////////////////////////
15361	-->
15362
15363	<interface
15364	name="IParallelPort" extends="$unknown"
15365	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
15366	wsmap="managed"
15367	>
15368
15369	<desc>
15370	The IParallelPort interface represents the virtual parallel port device.
15371
15372	The virtual parallel port device acts like an ordinary parallel port
15373	inside the virtual machine. This device communicates to the real
15374	parallel port hardware using the name of the parallel device on the host
15375	computer specified in the #path attribute.
15376
15377	Each virtual parallel port device is assigned a base I/O address and an
15378	IRQ number that will be reported to the guest operating system and used
15379	to operate the given parallel port from within the virtual machine.
15380
15381	<see><link to="IMachine::getParallelPort"/></see>
15382	</desc>
15383
15384	<attribute name="slot" type="unsigned long" readonly="yes">
15385	<desc>
15386	Slot number this parallel port is plugged into. Corresponds to
15387	the value you pass to <link to="IMachine::getParallelPort"/>
15388	to obtain this instance.
15389	</desc>
15390	</attribute>
15391
15392	<attribute name="enabled" type="boolean">
15393	<desc>
15394	Flag whether the parallel port is enabled. If disabled,
15395	the parallel port will not be reported to the guest OS.
15396	</desc>
15397	</attribute>
15398
15399	<attribute name="IOBase" type="unsigned long">
15400	<desc>Base I/O address of the parallel port.</desc>
15401	</attribute>
15402
15403	<attribute name="IRQ" type="unsigned long">
15404	<desc>IRQ number of the parallel port.</desc>
15405	</attribute>
15406
15407	<attribute name="path" type="wstring">
15408	<desc>
15409	Host parallel device name. If this parallel port is enabled, setting a
15410	@c null or an empty string as this attribute's value will result in
15411	an error.
15412	</desc>
15413	</attribute>
15414
15415	</interface>
15416
15417
15418	<!--
15419	// IMachineDebugger
15420	/////////////////////////////////////////////////////////////////////////
15421	-->
15422
15423	<interface
15424	name="IMachineDebugger" extends="$unknown"
15425	uuid="a80bb82c-37c5-4155-a524-9c1d0a1689ba"
15426	wsmap="managed"
15427	>
15428	<method name="dumpGuestCore">
15429	<desc>
15430	Takes a core dump of the guest.
15431
15432	See include/VBox/dbgfcorefmt.h for details on the file format.
15433	</desc>
15434	<param name="filename" type="wstring" dir="in">
15435	<desc>
15436	The name of the output file. The file must not exist.
15437	</desc>
15438	</param>
15439	<param name="compression" type="wstring" dir="in">
15440	<desc>
15441	Reserved for future compression method indicator.
15442	</desc>
15443	</param>
15444	</method>
15445
15446	<method name="dumpHostProcessCore">
15447	<desc>
15448	Takes a core dump of the VM process on the host.
15449
15450	This feature is not implemented in the 4.0.0 release but it may show up
15451	in a dot release.
15452	</desc>
15453	<param name="filename" type="wstring" dir="in">
15454	<desc>
15455	The name of the output file. The file must not exist.
15456	</desc>
15457	</param>
15458	<param name="compression" type="wstring" dir="in">
15459	<desc>
15460	Reserved for future compression method indicator.
15461	</desc>
15462	</param>
15463	</method>
15464
15465	<method name="info">
15466	<desc>
15467	Interfaces with the info dumpers (DBGFInfo).
15468
15469	This feature is not implemented in the 4.0.0 release but it may show up
15470	in a dot release.
15471	</desc>
15472	<param name="name" type="wstring" dir="in">
15473	<desc>
15474	The name of the info item.
15475	</desc>
15476	</param>
15477	<param name="args" type="wstring" dir="in">
15478	<desc>
15479	Arguments to the info dumper.
15480	</desc>
15481	</param>
15482	<param name="info" type="wstring" dir="return">
15483	<desc>
15484	The into string.
15485	</desc>
15486	</param>
15487	</method>
15488
15489	<method name="injectNMI">
15490	<desc>
15491	Inject an NMI into a running VT-x/AMD-V VM.
15492	</desc>
15493	</method>
15494
15495	<method name="modifyLogGroups">
15496	<desc>
15497	Modifies the group settings of the debug or release logger.
15498	</desc>
15499	<param name="settings" type="wstring" dir="in">
15500	<desc>
15501	The group settings string. See iprt/log.h for details. To target the
15502	release logger, prefix the string with "release:".
15503	</desc>
15504	</param>
15505	</method>
15506
15507	<method name="modifyLogFlags">
15508	<desc>
15509	Modifies the debug or release logger flags.
15510	</desc>
15511	<param name="settings" type="wstring" dir="in">
15512	<desc>
15513	The flags settings string. See iprt/log.h for details. To target the
15514	release logger, prefix the string with "release:".
15515	</desc>
15516	</param>
15517	</method>
15518
15519	<method name="modifyLogDestinations">
15520	<desc>
15521	Modifies the debug or release logger destinations.
15522	</desc>
15523	<param name="settings" type="wstring" dir="in">
15524	<desc>
15525	The destination settings string. See iprt/log.h for details. To target the
15526	release logger, prefix the string with "release:".
15527	</desc>
15528	</param>
15529	</method>
15530
15531	<method name="readPhysicalMemory">
15532	<desc>
15533	Reads guest physical memory, no side effects (MMIO++).
15534
15535	This feature is not implemented in the 4.0.0 release but may show up
15536	in a dot release.
15537	</desc>
15538	<param name="address" type="long long" dir="in">
15539	<desc>The guest physical address.</desc>
15540	</param>
15541	<param name="size" type="unsigned long" dir="in">
15542	<desc>The number of bytes to read.</desc>
15543	</param>
15544	<param name="bytes" type="octet" safearray="yes" dir="return">
15545	<desc>The bytes read.</desc>
15546	</param>
15547	</method>
15548
15549	<method name="writePhysicalMemory">
15550	<desc>
15551	Writes guest physical memory, access handles (MMIO++) are ignored.
15552
15553	This feature is not implemented in the 4.0.0 release but may show up
15554	in a dot release.
15555	</desc>
15556	<param name="address" type="long long" dir="in">
15557	<desc>The guest physical address.</desc>
15558	</param>
15559	<param name="size" type="unsigned long" dir="in">
15560	<desc>The number of bytes to read.</desc>
15561	</param>
15562	<param name="bytes" type="octet" safearray="yes" dir="in">
15563	<desc>The bytes to write.</desc>
15564	</param>
15565	</method>
15566
15567	<method name="readVirtualMemory">
15568	<desc>
15569	Reads guest virtual memory, no side effects (MMIO++).
15570
15571	This feature is not implemented in the 4.0.0 release but may show up
15572	in a dot release.
15573	</desc>
15574	<param name="cpuId" type="unsigned long" dir="in">
15575	<desc>The identifier of the Virtual CPU.</desc>
15576	</param>
15577	<param name="address" type="long long" dir="in">
15578	<desc>The guest virtual address.</desc>
15579	</param>
15580	<param name="size" type="unsigned long" dir="in">
15581	<desc>The number of bytes to read.</desc>
15582	</param>
15583	<param name="bytes" type="octet" safearray="yes" dir="return">
15584	<desc>The bytes read.</desc>
15585	</param>
15586	</method>
15587
15588	<method name="writeVirtualMemory">
15589	<desc>
15590	Writes guest virtual memory, access handles (MMIO++) are ignored.
15591
15592	This feature is not implemented in the 4.0.0 release but may show up
15593	in a dot release.
15594	</desc>
15595	<param name="cpuId" type="unsigned long" dir="in">
15596	<desc>The identifier of the Virtual CPU.</desc>
15597	</param>
15598	<param name="address" type="long long" dir="in">
15599	<desc>The guest virtual address.</desc>
15600	</param>
15601	<param name="size" type="unsigned long" dir="in">
15602	<desc>The number of bytes to read.</desc>
15603	</param>
15604	<param name="bytes" type="octet" safearray="yes" dir="in">
15605	<desc>The bytes to write.</desc>
15606	</param>
15607	</method>
15608
15609	<method name="detectOS">
15610	<desc>
15611	Tries to (re-)detect the guest OS kernel.
15612
15613	This feature is not implemented in the 4.0.0 release but may show up
15614	in a dot release.
15615	</desc>
15616	<param name="os" type="wstring" dir="return">
15617	<desc>
15618	The detected OS kernel on success.
15619	</desc>
15620	</param>
15621	</method>
15622
15623	<method name="getRegister">
15624	<desc>
15625	Gets one register.
15626
15627	This feature is not implemented in the 4.0.0 release but may show up
15628	in a dot release.
15629	</desc>
15630	<param name="cpuId" type="unsigned long" dir="in">
15631	<desc>The identifier of the Virtual CPU.</desc>
15632	</param>
15633	<param name="name" type="wstring" dir="in">
15634	<desc>The register name, case is ignored.</desc>
15635	</param>
15636	<param name="value" type="wstring" dir="return">
15637	<desc>
15638	The register value. This is usually a hex value (always 0x prefixed)
15639	but other format may be used for floating point registers (TBD).
15640	</desc>
15641	</param>
15642	</method>
15643
15644	<method name="getRegisters">
15645	<desc>
15646	Gets all the registers for the given CPU.
15647
15648	This feature is not implemented in the 4.0.0 release but may show up
15649	in a dot release.
15650	</desc>
15651	<param name="cpuId" type="unsigned long" dir="in">
15652	<desc>The identifier of the Virtual CPU.</desc>
15653	</param>
15654	<param name="names" type="wstring" dir="out" safearray="yes">
15655	<desc>Array containing the lowercase register names.</desc>
15656	</param>
15657	<param name="values" type="wstring" dir="out" safearray="yes">
15658	<desc>
15659	Array paralell to the names holding the register values as if the
15660	register was returned by <link to="IMachineDebugger::getRegister"/>.
15661	</desc>
15662	</param>
15663	</method>
15664
15665	<method name="setRegister">
15666	<desc>
15667	Gets one register.
15668
15669	This feature is not implemented in the 4.0.0 release but may show up
15670	in a dot release.
15671	</desc>
15672	<param name="cpuId" type="unsigned long" dir="in">
15673	<desc>The identifier of the Virtual CPU.</desc>
15674	</param>
15675	<param name="name" type="wstring" dir="in">
15676	<desc>The register name, case is ignored.</desc>
15677	</param>
15678	<param name="value" type="wstring" dir="in">
15679	<desc>
15680	The new register value. Hexadecimal, decimal and octal formattings
15681	are supported in addition to any special formattings returned by
15682	the getters.
15683	</desc>
15684	</param>
15685	</method>
15686
15687	<method name="setRegisters">
15688	<desc>
15689	Sets zero or more registers atomically.
15690
15691	This feature is not implemented in the 4.0.0 release but may show up
15692	in a dot release.
15693	</desc>
15694	<param name="cpuId" type="unsigned long" dir="in">
15695	<desc>The identifier of the Virtual CPU.</desc>
15696	</param>
15697	<param name="names" type="wstring" dir="in" safearray="yes">
15698	<desc>Array containing the register names, case ignored.</desc>
15699	</param>
15700	<param name="values" type="wstring" dir="in" safearray="yes">
15701	<desc>
15702	Array paralell to the names holding the register values. See
15703	<link to="IMachineDebugger::setRegister"/> for formatting
15704	guidelines.
15705	</desc>
15706	</param>
15707	</method>
15708
15709	<method name="dumpGuestStack">
15710	<desc>
15711	Produce a simple stack dump using the current guest state.
15712
15713	This feature is not implemented in the 4.0.0 release but may show up
15714	in a dot release.
15715	</desc>
15716	<param name="cpuId" type="unsigned long" dir="in">
15717	<desc>The identifier of the Virtual CPU.</desc>
15718	</param>
15719	<param name="stack" type="wstring" dir="return">
15720	<desc>String containing the formatted stack dump.</desc>
15721	</param>
15722	</method>
15723
15724	<method name="resetStats">
15725	<desc>
15726	Reset VM statistics.
15727	</desc>
15728	<param name="pattern" type="wstring" dir="in">
15729	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15730	</param>
15731	</method>
15732
15733	<method name="dumpStats">
15734	<desc>
15735	Dumps VM statistics.
15736	</desc>
15737	<param name="pattern" type="wstring" dir="in">
15738	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15739	</param>
15740	</method>
15741
15742	<method name="getStats">
15743	<desc>
15744	Get the VM statistics in a XMLish format.
15745	</desc>
15746	<param name="pattern" type="wstring" dir="in">
15747	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15748	</param>
15749	<param name="withDescriptions" type="boolean" dir="in">
15750	<desc>Whether to include the descriptions.</desc>
15751	</param>
15752	<param name="stats" type="wstring" dir="return">
15753	<desc>The XML document containing the statistics.</desc>
15754	</param>
15755	</method>
15756
15757	<attribute name="singleStep" type="boolean">
15758	<desc>Switch for enabling single-stepping.</desc>
15759	</attribute>
15760
15761	<attribute name="recompileUser" type="boolean">
15762	<desc>Switch for forcing code recompilation for user mode code.</desc>
15763	</attribute>
15764
15765	<attribute name="recompileSupervisor" type="boolean">
15766	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
15767	</attribute>
15768
15769	<attribute name="PATMEnabled" type="boolean">
15770	<desc>Switch for enabling and disabling the PATM component.</desc>
15771	</attribute>
15772
15773	<attribute name="CSAMEnabled" type="boolean">
15774	<desc>Switch for enabling and disabling the CSAM component.</desc>
15775	</attribute>
15776
15777	<attribute name="logEnabled" type="boolean">
15778	<desc>Switch for enabling and disabling the debug logger.</desc>
15779	</attribute>
15780
15781	<attribute name="logDbgFlags" type="wstring" readonly="yes">
15782	<desc>The debug logger flags.</desc>
15783	</attribute>
15784
15785	<attribute name="logDbgGroups" type="wstring" readonly="yes">
15786	<desc>The debug logger's group settings.</desc>
15787	</attribute>
15788
15789	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
15790	<desc>The debug logger's destination settings.</desc>
15791	</attribute>
15792
15793	<attribute name="logRelFlags" type="wstring" readonly="yes">
15794	<desc>The release logger flags.</desc>
15795	</attribute>
15796
15797	<attribute name="logRelGroups" type="wstring" readonly="yes">
15798	<desc>The release logger's group settings.</desc>
15799	</attribute>
15800
15801	<attribute name="logRelDestinations" type="wstring" readonly="yes">
15802	<desc>The relase logger's destination settings.</desc>
15803	</attribute>
15804
15805	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
15806	<desc>
15807	Flag indicating whether the VM is currently making use of CPU hardware
15808	virtualization extensions.
15809	</desc>
15810	</attribute>
15811
15812	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
15813	<desc>
15814	Flag indicating whether the VM is currently making use of the nested paging
15815	CPU hardware virtualization extension.
15816	</desc>
15817	</attribute>
15818
15819	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
15820	<desc>
15821	Flag indicating whether the VM is currently making use of the VPID
15822	VT-x extension.
15823	</desc>
15824	</attribute>
15825
15826	<attribute name="OSName" type="wstring" readonly="yes">
15827	<desc>
15828	Query the guest OS kernel name as detected by the DBGF.
15829
15830	This feature is not implemented in the 4.0.0 release but may show up
15831	in a dot release.
15832	</desc>
15833	</attribute>
15834
15835	<attribute name="OSVersion" type="wstring" readonly="yes">
15836	<desc>
15837	Query the guest OS kernel version string as detected by the DBGF.
15838
15839	This feature is not implemented in the 4.0.0 release but may show up
15840	in a dot release.
15841	</desc>
15842	</attribute>
15843
15844	<attribute name="PAEEnabled" type="boolean" readonly="yes">
15845	<desc>
15846	Flag indicating whether the VM is currently making use of the Physical
15847	Address Extension CPU feature.
15848	</desc>
15849	</attribute>
15850
15851	<attribute name="virtualTimeRate" type="unsigned long">
15852	<desc>
15853	The rate at which the virtual time runs expressed as a percentage.
15854	The accepted range is 2% to 20000%.
15855	</desc>
15856	</attribute>
15857
15858	<attribute name="VM" type="long long" readonly="yes" wsmap="suppress">
15859	<desc>
15860	Gets the user-mode VM handle, with a reference. Must be passed to
15861	VMR3ReleaseUVM when done. This is only for internal use while we carve
15862	the details of this interface.
15863	</desc>
15864	</attribute>
15865
15866	</interface>
15867
15868	<!--
15869	// IUSBController
15870	/////////////////////////////////////////////////////////////////////////
15871	-->
15872
15873	<interface
15874	name="IUSBController" extends="$unknown"
15875	uuid="01e6f13a-0580-452f-a40f-74e32a5e4921"
15876	wsmap="managed"
15877	>
15878	<attribute name="enabled" type="boolean">
15879	<desc>
15880	Flag whether the USB controller is present in the
15881	guest system. If disabled, the virtual guest hardware will
15882	not contain any USB controller. Can only be changed when
15883	the VM is powered off.
15884	</desc>
15885	</attribute>
15886
15887	<attribute name="enabledEHCI" type="boolean">
15888	<desc>
15889	Flag whether the USB EHCI controller is present in the
15890	guest system. If disabled, the virtual guest hardware will
15891	not contain a USB EHCI controller. Can only be changed when
15892	the VM is powered off.
15893	</desc>
15894	</attribute>
15895
15896	<attribute name="proxyAvailable" type="boolean" readonly="yes">
15897	<desc>
15898	Flag whether there is an USB proxy available.
15899	</desc>
15900	</attribute>
15901
15902	<attribute name="USBStandard" type="unsigned short" readonly="yes">
15903	<desc>
15904	USB standard version which the controller implements.
15905	This is a BCD which means that the major version is in the
15906	high byte and minor version is in the low byte.
15907	</desc>
15908	</attribute>
15909
15910	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
15911	<desc>
15912	List of USB device filters associated with the machine.
15913
15914	If the machine is currently running, these filters are activated
15915	every time a new (supported) USB device is attached to the host
15916	computer that was not ignored by global filters
15917	(<link to="IHost::USBDeviceFilters"/>).
15918
15919	These filters are also activated when the machine is powered up.
15920	They are run against a list of all currently available USB
15921	devices (in states
15922	<link to="USBDeviceState_Available"/>,
15923	<link to="USBDeviceState_Busy"/>,
15924	<link to="USBDeviceState_Held"/>) that were not previously
15925	ignored by global filters.
15926
15927	If at least one filter matches the USB device in question, this
15928	device is automatically captured (attached to) the virtual USB
15929	controller of this machine.
15930
15931	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
15932	</desc>
15933	</attribute>
15934
15935	<method name="createDeviceFilter">
15936	<desc>
15937	Creates a new USB device filter. All attributes except
15938	the filter name are set to empty (any match),
15939	<i>active</i> is @c false (the filter is not active).
15940
15941	The created filter can then be added to the list of filters using
15942	<link to="#insertDeviceFilter"/>.
15943
15944	<result name="VBOX_E_INVALID_VM_STATE">
15945	The virtual machine is not mutable.
15946	</result>
15947
15948	<see><link to="#deviceFilters"/></see>
15949	</desc>
15950	<param name="name" type="wstring" dir="in">
15951	<desc>
15952	Filter name. See <link to="IUSBDeviceFilter::name"/>
15953	for more info.
15954	</desc>
15955	</param>
15956	<param name="filter" type="IUSBDeviceFilter" dir="return">
15957	<desc>Created filter object.</desc>
15958	</param>
15959	</method>
15960
15961	<method name="insertDeviceFilter">
15962	<desc>
15963	Inserts the given USB device to the specified position
15964	in the list of filters.
15965
15966	Positions are numbered starting from <tt>0</tt>. If the specified
15967	position is equal to or greater than the number of elements in
15968	the list, the filter is added to the end of the collection.
15969
15970	<note>
15971	Duplicates are not allowed, so an attempt to insert a
15972	filter that is already in the collection, will return an
15973	error.
15974	</note>
15975
15976	<result name="VBOX_E_INVALID_VM_STATE">
15977	Virtual machine is not mutable.
15978	</result>
15979	<result name="E_INVALIDARG">
15980	USB device filter not created within this VirtualBox instance.
15981	</result>
15982	<result name="VBOX_E_INVALID_OBJECT_STATE">
15983	USB device filter already in list.
15984	</result>
15985
15986	<see><link to="#deviceFilters"/></see>
15987	</desc>
15988	<param name="position" type="unsigned long" dir="in">
15989	<desc>Position to insert the filter to.</desc>
15990	</param>
15991	<param name="filter" type="IUSBDeviceFilter" dir="in">
15992	<desc>USB device filter to insert.</desc>
15993	</param>
15994	</method>
15995
15996	<method name="removeDeviceFilter">
15997	<desc>
15998	Removes a USB device filter from the specified position in the
15999	list of filters.
16000
16001	Positions are numbered starting from <tt>0</tt>. Specifying a
16002	position equal to or greater than the number of elements in
16003	the list will produce an error.
16004
16005	<see><link to="#deviceFilters"/></see>
16006
16007	<result name="VBOX_E_INVALID_VM_STATE">
16008	Virtual machine is not mutable.
16009	</result>
16010	<result name="E_INVALIDARG">
16011	USB device filter list empty or invalid @a position.
16012	</result>
16013
16014	</desc>
16015	<param name="position" type="unsigned long" dir="in">
16016	<desc>Position to remove the filter from.</desc>
16017	</param>
16018	<param name="filter" type="IUSBDeviceFilter" dir="return">
16019	<desc>Removed USB device filter.</desc>
16020	</param>
16021	</method>
16022
16023	</interface>
16024
16025
16026	<!--
16027	// IUSBDevice
16028	/////////////////////////////////////////////////////////////////////////
16029	-->
16030
16031	<interface
16032	name="IUSBDevice" extends="$unknown"
16033	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
16034	wsmap="managed"
16035	>
16036	<desc>
16037	The IUSBDevice interface represents a virtual USB device attached to the
16038	virtual machine.
16039
16040	A collection of objects implementing this interface is stored in the
16041	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
16042	attached to a running virtual machine's USB controller.
16043	</desc>
16044
16045	<attribute name="id" type="uuid" mod="string" readonly="yes">
16046	<desc>
16047	Unique USB device ID. This ID is built from #vendorId,
16048	#productId, #revision and #serialNumber.
16049	</desc>
16050	</attribute>
16051
16052	<attribute name="vendorId" type="unsigned short" readonly="yes">
16053	<desc>Vendor ID.</desc>
16054	</attribute>
16055
16056	<attribute name="productId" type="unsigned short" readonly="yes">
16057	<desc>Product ID.</desc>
16058	</attribute>
16059
16060	<attribute name="revision" type="unsigned short" readonly="yes">
16061	<desc>
16062	Product revision number. This is a packed BCD represented as
16063	unsigned short. The high byte is the integer part and the low
16064	byte is the decimal.
16065	</desc>
16066	</attribute>
16067
16068	<attribute name="manufacturer" type="wstring" readonly="yes">
16069	<desc>Manufacturer string.</desc>
16070	</attribute>
16071
16072	<attribute name="product" type="wstring" readonly="yes">
16073	<desc>Product string.</desc>
16074	</attribute>
16075
16076	<attribute name="serialNumber" type="wstring" readonly="yes">
16077	<desc>Serial number string.</desc>
16078	</attribute>
16079
16080	<attribute name="address" type="wstring" readonly="yes">
16081	<desc>Host specific address of the device.</desc>
16082	</attribute>
16083
16084	<attribute name="port" type="unsigned short" readonly="yes">
16085	<desc>
16086	Host USB port number the device is physically
16087	connected to.
16088	</desc>
16089	</attribute>
16090
16091	<attribute name="version" type="unsigned short" readonly="yes">
16092	<desc>
16093	The major USB version of the device - 1 or 2.
16094	</desc>
16095	</attribute>
16096
16097	<attribute name="portVersion" type="unsigned short" readonly="yes">
16098	<desc>
16099	The major USB version of the host USB port the device is
16100	physically connected to - 1 or 2. For devices not connected to
16101	anything this will have the same value as the version attribute.
16102	</desc>
16103	</attribute>
16104
16105	<attribute name="remote" type="boolean" readonly="yes">
16106	<desc>
16107	Whether the device is physically connected to a remote VRDE
16108	client or to a local host machine.
16109	</desc>
16110	</attribute>
16111
16112	</interface>
16113
16114
16115	<!--
16116	// IUSBDeviceFilter
16117	/////////////////////////////////////////////////////////////////////////
16118	-->
16119
16120	<interface
16121	name="IUSBDeviceFilter" extends="$unknown"
16122	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
16123	wsmap="managed"
16124	>
16125	<desc>
16126	The IUSBDeviceFilter interface represents an USB device filter used
16127	to perform actions on a group of USB devices.
16128
16129	This type of filters is used by running virtual machines to
16130	automatically capture selected USB devices once they are physically
16131	attached to the host computer.
16132
16133	A USB device is matched to the given device filter if and only if all
16134	attributes of the device match the corresponding attributes of the
16135	filter (that is, attributes are joined together using the logical AND
16136	operation). On the other hand, all together, filters in the list of
16137	filters carry the semantics of the logical OR operation. So if it is
16138	desirable to create a match like "this vendor id OR this product id",
16139	one needs to create two filters and specify "any match" (see below)
16140	for unused attributes.
16141
16142	All filter attributes used for matching are strings. Each string
16143	is an expression representing a set of values of the corresponding
16144	device attribute, that will match the given filter. Currently, the
16145	following filtering expressions are supported:
16146
16147	<ul>
16148	<li><i>Interval filters</i>. Used to specify valid intervals for
16149	integer device attributes (Vendor ID, Product ID and Revision).
16150	The format of the string is:
16151
16152	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
16153
16154	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
16155	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
16156	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
16157	is omitted before a dash (<tt>-</tt>), the minimum possible integer
16158	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
16159	possible integer is assumed.
16160	</li>
16161	<li><i>Boolean filters</i>. Used to specify acceptable values for
16162	boolean device attributes. The format of the string is:
16163
16164	<tt>true\|false\|yes\|no\|0\|1</tt>
16165
16166	</li>
16167	<li><i>Exact match</i>. Used to specify a single value for the given
16168	device attribute. Any string that doesn't start with <tt>int:</tt>
16169	represents the exact match. String device attributes are compared to
16170	this string including case of symbols. Integer attributes are first
16171	converted to a string (see individual filter attributes) and then
16172	compared ignoring case.
16173
16174	</li>
16175	<li><i>Any match</i>. Any value of the corresponding device attribute
16176	will match the given filter. An empty or @c null string is
16177	used to construct this type of filtering expressions.
16178
16179	</li>
16180	</ul>
16181
16182	<note>
16183	On the Windows host platform, interval filters are not currently
16184	available. Also all string filter attributes
16185	(<link to="#manufacturer"/>, <link to="#product"/>,
16186	<link to="#serialNumber"/>) are ignored, so they behave as
16187	<i>any match</i> no matter what string expression is specified.
16188	</note>
16189
16190	<see><link to="IUSBController::deviceFilters"/>,
16191	<link to="IHostUSBDeviceFilter"/></see>
16192	</desc>
16193
16194	<attribute name="name" type="wstring">
16195	<desc>
16196	Visible name for this filter.
16197	This name is used to visually distinguish one filter from another,
16198	so it can neither be @c null nor an empty string.
16199	</desc>
16200	</attribute>
16201
16202	<attribute name="active" type="boolean">
16203	<desc>Whether this filter active or has been temporarily disabled.</desc>
16204	</attribute>
16205
16206	<attribute name="vendorId" type="wstring">
16207	<desc>
16208	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
16209	The string representation for the <i>exact matching</i>
16210	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16211	(including leading zeroes).
16212	</desc>
16213	</attribute>
16214
16215	<attribute name="productId" type="wstring">
16216	<desc>
16217	<link to="IUSBDevice::productId">Product ID</link> filter.
16218	The string representation for the <i>exact matching</i>
16219	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16220	(including leading zeroes).
16221	</desc>
16222	</attribute>
16223
16224	<attribute name="revision" type="wstring">
16225	<desc>
16226	<link to="IUSBDevice::productId">Product revision number</link>
16227	filter. The string representation for the <i>exact matching</i>
16228	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
16229	of the integer part of the revision, and <tt>F</tt> is the
16230	decimal digit of its fractional part (including leading and
16231	trailing zeros).
16232	Note that for interval filters, it's best to use the hexadecimal
16233	form, because the revision is stored as a 16 bit packed BCD value;
16234	so the expression <tt>int:0x0100-0x0199</tt> will match any
16235	revision from <tt>1.0</tt> to <tt>1.99</tt>.
16236	</desc>
16237	</attribute>
16238
16239	<attribute name="manufacturer" type="wstring">
16240	<desc>
16241	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
16242	</desc>
16243	</attribute>
16244
16245	<attribute name="product" type="wstring">
16246	<desc>
16247	<link to="IUSBDevice::product">Product</link> filter.
16248	</desc>
16249	</attribute>
16250
16251	<attribute name="serialNumber" type="wstring">
16252	<desc>
16253	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
16254	</desc>
16255	</attribute>
16256
16257	<attribute name="port" type="wstring">
16258	<desc>
16259	<link to="IUSBDevice::port">Host USB port</link> filter.
16260	</desc>
16261	</attribute>
16262
16263	<attribute name="remote" type="wstring">
16264	<desc>
16265	<link to="IUSBDevice::remote">Remote state</link> filter.
16266	<note>
16267	This filter makes sense only for machine USB filters,
16268	i.e. it is ignored by IHostUSBDeviceFilter objects.
16269	</note>
16270	</desc>
16271	</attribute>
16272
16273	<attribute name="maskedInterfaces" type="unsigned long">
16274	<desc>
16275	This is an advanced option for hiding one or more USB interfaces
16276	from the guest. The value is a bit mask where the bits that are set
16277	means the corresponding USB interface should be hidden, masked off
16278	if you like.
16279	This feature only works on Linux hosts.
16280	</desc>
16281	</attribute>
16282
16283	</interface>
16284
16285
16286	<!--
16287	// IHostUSBDevice
16288	/////////////////////////////////////////////////////////////////////////
16289	-->
16290
16291	<enum
16292	name="USBDeviceState"
16293	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
16294	>
16295	<desc>
16296	USB device state. This enumeration represents all possible states
16297	of the USB device physically attached to the host computer regarding
16298	its state on the host computer and availability to guest computers
16299	(all currently running virtual machines).
16300
16301	Once a supported USB device is attached to the host, global USB
16302	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
16303	either ignore the device, or put it to USBDeviceState_Held state, or do
16304	nothing. Unless the device is ignored by global filters, filters of all
16305	currently running guests (<link to="IUSBController::deviceFilters"/>) are
16306	activated that can put it to USBDeviceState_Captured state.
16307
16308	If the device was ignored by global filters, or didn't match
16309	any filters at all (including guest ones), it is handled by the host
16310	in a normal way. In this case, the device state is determined by
16311	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
16312	or USBDeviceState_Available, depending on the current device usage.
16313
16314	Besides auto-capturing based on filters, the device can be manually
16315	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
16316	state is USBDeviceState_Busy, USBDeviceState_Available or
16317	USBDeviceState_Held.
16318
16319	<note>
16320	Due to differences in USB stack implementations in Linux and Win32,
16321	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
16322	only to the Linux version of the product. This also means that (<link
16323	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
16324	device state is USBDeviceState_Held.
16325	</note>
16326
16327	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
16328	</desc>
16329
16330	<const name="NotSupported" value="0">
16331	<desc>
16332	Not supported by the VirtualBox server, not available to guests.
16333	</desc>
16334	</const>
16335	<const name="Unavailable" value="1">
16336	<desc>
16337	Being used by the host computer exclusively,
16338	not available to guests.
16339	</desc>
16340	</const>
16341	<const name="Busy" value="2">
16342	<desc>
16343	Being used by the host computer, potentially available to guests.
16344	</desc>
16345	</const>
16346	<const name="Available" value="3">
16347	<desc>
16348	Not used by the host computer, available to guests (the host computer
16349	can also start using the device at any time).
16350	</desc>
16351	</const>
16352	<const name="Held" value="4">
16353	<desc>
16354	Held by the VirtualBox server (ignored by the host computer),
16355	available to guests.
16356	</desc>
16357	</const>
16358	<const name="Captured" value="5">
16359	<desc>
16360	Captured by one of the guest computers, not available
16361	to anybody else.
16362	</desc>
16363	</const>
16364	</enum>
16365
16366	<interface
16367	name="IHostUSBDevice" extends="IUSBDevice"
16368	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
16369	wsmap="managed"
16370	>
16371	<desc>
16372	The IHostUSBDevice interface represents a physical USB device attached
16373	to the host computer.
16374
16375	Besides properties inherited from IUSBDevice, this interface adds the
16376	<link to="#state"/> property that holds the current state of the USB
16377	device.
16378
16379	<see><link to="IHost::USBDevices"/>,
16380	<link to="IHost::USBDeviceFilters"/></see>
16381	</desc>
16382
16383	<attribute name="state" type="USBDeviceState" readonly="yes">
16384	<desc>
16385	Current state of the device.
16386	</desc>
16387	</attribute>
16388
16389	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
16390
16391	</interface>
16392
16393
16394	<!--
16395	// IHostUSBDeviceFilter
16396	/////////////////////////////////////////////////////////////////////////
16397	-->
16398
16399	<enum
16400	name="USBDeviceFilterAction"
16401	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
16402	>
16403	<desc>
16404	Actions for host USB device filters.
16405	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
16406	</desc>
16407
16408	<const name="Null" value="0">
16409	<desc>Null value (never used by the API).</desc>
16410	</const>
16411	<const name="Ignore" value="1">
16412	<desc>Ignore the matched USB device.</desc>
16413	</const>
16414	<const name="Hold" value="2">
16415	<desc>Hold the matched USB device.</desc>
16416	</const>
16417	</enum>
16418
16419	<interface
16420	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
16421	uuid="4cc70246-d74a-400f-8222-3900489c0374"
16422	wsmap="managed"
16423	>
16424	<desc>
16425	The IHostUSBDeviceFilter interface represents a global filter for a
16426	physical USB device used by the host computer. Used indirectly in
16427	<link to="IHost::USBDeviceFilters"/>.
16428
16429	Using filters of this type, the host computer determines the initial
16430	state of the USB device after it is physically attached to the
16431	host's USB controller.
16432
16433	<note>
16434	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
16435	filters, because it makes sense only for
16436	<link to="IUSBController::deviceFilters">machine USB filters</link>.
16437	</note>
16438
16439	<see><link to="IHost::USBDeviceFilters"/></see>
16440	</desc>
16441
16442	<attribute name="action" type="USBDeviceFilterAction">
16443	<desc>
16444	Action performed by the host when an attached USB device
16445	matches this filter.
16446	</desc>
16447	</attribute>
16448
16449	</interface>
16450
16451	<!--
16452	// IAudioAdapter
16453	/////////////////////////////////////////////////////////////////////////
16454	-->
16455
16456	<enum
16457	name="AudioDriverType"
16458	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
16459	>
16460	<desc>
16461	Host audio driver type.
16462	</desc>
16463
16464	<const name="Null" value="0">
16465	<desc>Null value, also means "dummy audio driver".</desc>
16466	</const>
16467	<const name="WinMM" value="1">
16468	<desc>Windows multimedia (Windows hosts only).</desc>
16469	</const>
16470	<const name="OSS" value="2">
16471	<desc>Open Sound System (Linux hosts only).</desc>
16472	</const>
16473	<const name="ALSA" value="3">
16474	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
16475	</const>
16476	<const name="DirectSound" value="4">
16477	<desc>DirectSound (Windows hosts only).</desc>
16478	</const>
16479	<const name="CoreAudio" value="5">
16480	<desc>CoreAudio (Mac hosts only).</desc>
16481	</const>
16482	<const name="MMPM" value="6">
16483	<desc>Reserved for historical reasons.</desc>
16484	</const>
16485	<const name="Pulse" value="7">
16486	<desc>PulseAudio (Linux hosts only).</desc>
16487	</const>
16488	<const name="SolAudio" value="8">
16489	<desc>Solaris audio (Solaris hosts only).</desc>
16490	</const>
16491	</enum>
16492
16493	<enum
16494	name="AudioControllerType"
16495	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
16496	>
16497	<desc>
16498	Virtual audio controller type.
16499	</desc>
16500
16501	<const name="AC97" value="0"/>
16502	<const name="SB16" value="1"/>
16503	<const name="HDA" value="2"/>
16504	</enum>
16505
16506	<interface
16507	name="IAudioAdapter" extends="$unknown"
16508	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
16509	wsmap="managed"
16510	>
16511	<desc>
16512	The IAudioAdapter interface represents the virtual audio adapter of
16513	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
16514	</desc>
16515	<attribute name="enabled" type="boolean">
16516	<desc>
16517	Flag whether the audio adapter is present in the
16518	guest system. If disabled, the virtual guest hardware will
16519	not contain any audio adapter. Can only be changed when
16520	the VM is not running.
16521	</desc>
16522	</attribute>
16523	<attribute name="audioController" type="AudioControllerType">
16524	<desc>
16525	The audio hardware we emulate.
16526	</desc>
16527	</attribute>
16528	<attribute name="audioDriver" type="AudioDriverType">
16529	<desc>
16530	Audio driver the adapter is connected to. This setting
16531	can only be changed when the VM is not running.
16532	</desc>
16533	</attribute>
16534	</interface>
16535
16536	<enum
16537	name="AuthType"
16538	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
16539	>
16540	<desc>
16541	VirtualBox authentication type.
16542	</desc>
16543
16544	<const name="Null" value="0">
16545	<desc>Null value, also means "no authentication".</desc>
16546	</const>
16547	<const name="External" value="1"/>
16548	<const name="Guest" value="2"/>
16549	</enum>
16550
16551	<!--
16552	// IVRDEServer
16553	/////////////////////////////////////////////////////////////////////////
16554	-->
16555
16556	<interface
16557	name="IVRDEServer" extends="$unknown"
16558	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
16559	wsmap="managed"
16560	>
16561	<attribute name="enabled" type="boolean">
16562	<desc>VRDE server status.</desc>
16563	</attribute>
16564
16565	<attribute name="authType" type="AuthType">
16566	<desc>VRDE authentication method.</desc>
16567	</attribute>
16568
16569	<attribute name="authTimeout" type="unsigned long">
16570	<desc>Timeout for guest authentication. Milliseconds.</desc>
16571	</attribute>
16572
16573	<attribute name="allowMultiConnection" type="boolean">
16574	<desc>
16575	Flag whether multiple simultaneous connections to the VM are permitted.
16576	Note that this will be replaced by a more powerful mechanism in the future.
16577	</desc>
16578	</attribute>
16579
16580	<attribute name="reuseSingleConnection" type="boolean">
16581	<desc>
16582	Flag whether the existing connection must be dropped and a new connection
16583	must be established by the VRDE server, when a new client connects in single
16584	connection mode.
16585	</desc>
16586	</attribute>
16587
16588	<attribute name="VRDEExtPack" type="wstring">
16589	<desc>
16590	The name of Extension Pack providing VRDE for this VM. Overrides
16591	<link to="ISystemProperties::defaultVRDEExtPack"/>.
16592	</desc>
16593	</attribute>
16594
16595	<attribute name="authLibrary" type="wstring">
16596	<desc>
16597	Library used for authentication of RDP clients by this VM. Overrides
16598	<link to="ISystemProperties::VRDEAuthLibrary"/>.
16599	</desc>
16600	</attribute>
16601
16602	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
16603	<desc>
16604	Array of names of properties, which are supported by this VRDE server.
16605	</desc>
16606	</attribute>
16607
16608	<method name="setVRDEProperty">
16609	<desc>
16610	Sets a VRDE specific property string.
16611
16612	If you pass @c null or empty string as a key @a value, the given @a key
16613	will be deleted.
16614
16615	</desc>
16616	<param name="key" type="wstring" dir="in">
16617	<desc>Name of the key to set.</desc>
16618	</param>
16619	<param name="value" type="wstring" dir="in">
16620	<desc>Value to assign to the key.</desc>
16621	</param>
16622	</method>
16623
16624	<method name="getVRDEProperty" const="yes">
16625	<desc>
16626	Returns a VRDE specific property string.
16627
16628	If the requested data @a key does not exist, this function will
16629	succeed and return an empty string in the @a value argument.
16630
16631	</desc>
16632	<param name="key" type="wstring" dir="in">
16633	<desc>Name of the key to get.</desc>
16634	</param>
16635	<param name="value" type="wstring" dir="return">
16636	<desc>Value of the requested key.</desc>
16637	</param>
16638	</method>
16639
16640	</interface>
16641
16642
16643	<!--
16644	// ISharedFolder
16645	/////////////////////////////////////////////////////////////////////////
16646	-->
16647
16648	<interface
16649	name="ISharedFolder" extends="$unknown"
16650	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
16651	wsmap="struct"
16652	>
16653	<desc>
16654	The ISharedFolder interface represents a folder in the host computer's
16655	file system accessible from the guest OS running inside a virtual
16656	machine using an associated logical name.
16657
16658	There are three types of shared folders:
16659	<ul>
16660	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
16661	folders available to all virtual machines.</li>
16662	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
16663	VM-specific shared folders available to the given virtual machine at
16664	startup.</li>
16665	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
16666	VM-specific shared folders created in the session context (for
16667	example, when the virtual machine is running) and automatically
16668	discarded when the session is closed (the VM is powered off).</li>
16669	</ul>
16670
16671	Logical names of shared folders must be unique within the given scope
16672	(global, permanent or transient). However, they do not need to be unique
16673	across scopes. In this case, the definition of the shared folder in a
16674	more specific scope takes precedence over definitions in all other
16675	scopes. The order of precedence is (more specific to more general):
16676	<ol>
16677	<li>Transient definitions</li>
16678	<li>Permanent definitions</li>
16679	<li>Global definitions</li>
16680	</ol>
16681
16682	For example, if MyMachine has a shared folder named
16683	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
16684	transient shared folder named <tt>C_DRIVE</tt> (that points
16685	to <tt>C:\\\\WINDOWS</tt>) will change the definition
16686	of <tt>C_DRIVE</tt> in the guest OS so
16687	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
16688	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
16689	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
16690	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
16691	to <tt>C:\\</tt> if it still exists.
16692
16693	Note that permanent and transient shared folders of different machines
16694	are in different name spaces, so they don't overlap and don't need to
16695	have unique logical names.
16696
16697	<note>
16698	Global shared folders are not implemented in the current version of the
16699	product.
16700	</note>
16701	</desc>
16702
16703	<attribute name="name" type="wstring" readonly="yes">
16704	<desc>Logical name of the shared folder.</desc>
16705	</attribute>
16706
16707	<attribute name="hostPath" type="wstring" readonly="yes">
16708	<desc>Full path to the shared folder in the host file system.</desc>
16709	</attribute>
16710
16711	<attribute name="accessible" type="boolean" readonly="yes">
16712	<desc>
16713	Whether the folder defined by the host path is currently
16714	accessible or not.
16715	For example, the folder can be inaccessible if it is placed
16716	on the network share that is not available by the time
16717	this property is read.
16718	</desc>
16719	</attribute>
16720
16721	<attribute name="writable" type="boolean" readonly="yes">
16722	<desc>
16723	Whether the folder defined by the host path is writable or
16724	not.
16725	</desc>
16726	</attribute>
16727
16728	<attribute name="autoMount" type="boolean" readonly="yes">
16729	<desc>
16730	Whether the folder gets automatically mounted by the guest or not.
16731	</desc>
16732	</attribute>
16733
16734	<attribute name="lastAccessError" type="wstring" readonly="yes">
16735	<desc>
16736	Text message that represents the result of the last accessibility
16737	check.
16738
16739	Accessibility checks are performed each time the <link to="#accessible"/>
16740	attribute is read. An empty string is returned if the last
16741	accessibility check was successful. A non-empty string indicates a
16742	failure and should normally describe a reason of the failure (for
16743	example, a file read error).
16744	</desc>
16745	</attribute>
16746
16747	</interface>
16748
16749	<!--
16750	// ISession
16751	/////////////////////////////////////////////////////////////////////////
16752	-->
16753
16754	<interface
16755	name="IInternalSessionControl" extends="$unknown"
16756	uuid="3e83963a-1c3b-400d-8c5f-f2d077b0a597"
16757	internal="yes"
16758	wsmap="suppress"
16759	>
16760	<method name="getPID">
16761	<desc>PID of the process that has created this Session object.
16762	</desc>
16763	<param name="pid" type="unsigned long" dir="return"/>
16764	</method>
16765
16766	<method name="getRemoteConsole">
16767	<desc>
16768	Returns the console object suitable for remote control.
16769
16770	<result name="VBOX_E_INVALID_VM_STATE">
16771	Session state prevents operation.
16772	</result>
16773	<result name="VBOX_E_INVALID_OBJECT_STATE">
16774	Session type prevents operation.
16775	</result>
16776
16777	</desc>
16778	<param name="console" type="IConsole" dir="return"/>
16779	</method>
16780
16781	<method name="assignMachine">
16782	<desc>
16783	Assigns the machine object associated with this direct-type
16784	session or informs the session that it will be a remote one
16785	(if @a machine == @c null).
16786
16787	<result name="VBOX_E_INVALID_VM_STATE">
16788	Session state prevents operation.
16789	</result>
16790	<result name="VBOX_E_INVALID_OBJECT_STATE">
16791	Session type prevents operation.
16792	</result>
16793
16794	</desc>
16795	<param name="machine" type="IMachine" dir="in"/>
16796	<param name="lockType" type="LockType" dir="in"/>
16797	</method>
16798
16799	<method name="assignRemoteMachine">
16800	<desc>
16801	Assigns the machine and the (remote) console object associated with
16802	this remote-type session.
16803
16804	<result name="VBOX_E_INVALID_VM_STATE">
16805	Session state prevents operation.
16806	</result>
16807
16808	</desc>
16809	<param name="machine" type="IMachine" dir="in"/>
16810	<param name="console" type="IConsole" dir="in"/>
16811	</method>
16812
16813	<method name="updateMachineState">
16814	<desc>
16815	Updates the machine state in the VM process.
16816	Must be called only in certain cases
16817	(see the method implementation).
16818
16819	<result name="VBOX_E_INVALID_VM_STATE">
16820	Session state prevents operation.
16821	</result>
16822	<result name="VBOX_E_INVALID_OBJECT_STATE">
16823	Session type prevents operation.
16824	</result>
16825
16826	</desc>
16827	<param name="machineState" type="MachineState" dir="in"/>
16828	</method>
16829
16830	<method name="uninitialize">
16831	<desc>
16832	Uninitializes (closes) this session. Used by VirtualBox to close
16833	the corresponding remote session when the direct session dies
16834	or gets closed.
16835
16836	<result name="VBOX_E_INVALID_VM_STATE">
16837	Session state prevents operation.
16838	</result>
16839
16840	</desc>
16841	</method>
16842
16843	<method name="onNetworkAdapterChange">
16844	<desc>
16845	Triggered when settings of a network adapter of the
16846	associated virtual machine have changed.
16847
16848	<result name="VBOX_E_INVALID_VM_STATE">
16849	Session state prevents operation.
16850	</result>
16851	<result name="VBOX_E_INVALID_OBJECT_STATE">
16852	Session type prevents operation.
16853	</result>
16854
16855	</desc>
16856	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
16857	<param name="changeAdapter" type="boolean" dir="in"/>
16858	</method>
16859
16860	<method name="onSerialPortChange">
16861	<desc>
16862	Triggered when settings of a serial port of the
16863	associated virtual machine have changed.
16864
16865	<result name="VBOX_E_INVALID_VM_STATE">
16866	Session state prevents operation.
16867	</result>
16868	<result name="VBOX_E_INVALID_OBJECT_STATE">
16869	Session type prevents operation.
16870	</result>
16871
16872	</desc>
16873	<param name="serialPort" type="ISerialPort" dir="in"/>
16874	</method>
16875
16876	<method name="onParallelPortChange">
16877	<desc>
16878	Triggered when settings of a parallel port of the
16879	associated virtual machine have changed.
16880
16881	<result name="VBOX_E_INVALID_VM_STATE">
16882	Session state prevents operation.
16883	</result>
16884	<result name="VBOX_E_INVALID_OBJECT_STATE">
16885	Session type prevents operation.
16886	</result>
16887
16888	</desc>
16889	<param name="parallelPort" type="IParallelPort" dir="in"/>
16890	</method>
16891
16892	<method name="onStorageControllerChange">
16893	<desc>
16894	Triggered when settings of a storage controller of the
16895	associated virtual machine have changed.
16896
16897	<result name="VBOX_E_INVALID_VM_STATE">
16898	Session state prevents operation.
16899	</result>
16900	<result name="VBOX_E_INVALID_OBJECT_STATE">
16901	Session type prevents operation.
16902	</result>
16903
16904	</desc>
16905	</method>
16906
16907	<method name="onMediumChange">
16908	<desc>
16909	Triggered when attached media of the
16910	associated virtual machine have changed.
16911
16912	<result name="VBOX_E_INVALID_VM_STATE">
16913	Session state prevents operation.
16914	</result>
16915	<result name="VBOX_E_INVALID_OBJECT_STATE">
16916	Session type prevents operation.
16917	</result>
16918
16919	</desc>
16920
16921	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16922	<desc>The medium attachment which changed.</desc>
16923	</param>
16924	<param name="force" type="boolean" dir="in">
16925	<desc>If the medium change was forced.</desc>
16926	</param>
16927	</method>
16928
16929	<method name="onStorageDeviceChange">
16930	<desc>
16931	Triggered when attached storage devices of the
16932	associated virtual machine have changed.
16933
16934	<result name="VBOX_E_INVALID_VM_STATE">
16935	Session state prevents operation.
16936	</result>
16937	<result name="VBOX_E_INVALID_OBJECT_STATE">
16938	Session type prevents operation.
16939	</result>
16940
16941	</desc>
16942
16943	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16944	<desc>The medium attachment which changed.</desc>
16945	</param>
16946	<param name="remove" type="boolean" dir="in">
16947	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
16948	</param>
16949	<param name="silent" type="boolean" dir="in">
16950	<desc>TRUE if the device is is silently reconfigured without
16951	notifying the guest about it.</desc>
16952	</param>
16953	</method>
16954
16955	<method name="onClipboardModeChange">
16956	<desc>
16957	Notification when the shared clipboard mode changes.
16958	</desc>
16959	<param name="clipboardMode" type="ClipboardMode" dir="in">
16960	<desc>The new shared clipboard mode.</desc>
16961	</param>
16962	</method>
16963
16964	<method name="onDragAndDropModeChange">
16965	<desc>
16966	Notification when the drag'n'drop mode changes.
16967	</desc>
16968	<param name="dragAndDropMode" type="DragAndDropMode" dir="in">
16969	<desc>The new mode for drag'n'drop.</desc>
16970	</param>
16971	</method>
16972
16973	<method name="onCPUChange">
16974	<desc>
16975	Notification when a CPU changes.
16976	</desc>
16977	<param name="cpu" type="unsigned long" dir="in">
16978	<desc>The CPU which changed</desc>
16979	</param>
16980	<param name="add" type="boolean" dir="in">
16981	<desc>Flag whether the CPU was added or removed</desc>
16982	</param>
16983	</method>
16984
16985	<method name="onCPUExecutionCapChange">
16986	<desc>
16987	Notification when the CPU execution cap changes.
16988	</desc>
16989	<param name="executionCap" type="unsigned long" dir="in">
16990	<desc>The new CPU execution cap value. (1-100)</desc>
16991	</param>
16992	</method>
16993
16994	<method name="onVRDEServerChange">
16995	<desc>
16996	Triggered when settings of the VRDE server object of the
16997	associated virtual machine have changed.
16998
16999	<result name="VBOX_E_INVALID_VM_STATE">
17000	Session state prevents operation.
17001	</result>
17002	<result name="VBOX_E_INVALID_OBJECT_STATE">
17003	Session type prevents operation.
17004	</result>
17005
17006	</desc>
17007	<param name="restart" type="boolean" dir="in">
17008	<desc>Flag whether the server must be restarted</desc>
17009	</param>
17010	</method>
17011
17012	<method name="onUSBControllerChange">
17013	<desc>
17014	Triggered when settings of the USB controller object of the
17015	associated virtual machine have changed.
17016
17017	<result name="VBOX_E_INVALID_VM_STATE">
17018	Session state prevents operation.
17019	</result>
17020	<result name="VBOX_E_INVALID_OBJECT_STATE">
17021	Session type prevents operation.
17022	</result>
17023
17024	</desc>
17025	</method>
17026
17027	<method name="onSharedFolderChange">
17028	<desc>
17029	Triggered when a permanent (global or machine) shared folder has been
17030	created or removed.
17031	<note>
17032	We don't pass shared folder parameters in this notification because
17033	the order in which parallel notifications are delivered is not defined,
17034	therefore it could happen that these parameters were outdated by the
17035	time of processing this notification.
17036	</note>
17037
17038	<result name="VBOX_E_INVALID_VM_STATE">
17039	Session state prevents operation.
17040	</result>
17041	<result name="VBOX_E_INVALID_OBJECT_STATE">
17042	Session type prevents operation.
17043	</result>
17044
17045	</desc>
17046	<param name="global" type="boolean" dir="in"/>
17047	</method>
17048
17049	<method name="onUSBDeviceAttach">
17050	<desc>
17051	Triggered when a request to capture a USB device (as a result
17052	of matched USB filters or direct call to
17053	<link to="IConsole::attachUSBDevice"/>) has completed.
17054	A @c null @a error object means success, otherwise it
17055	describes a failure.
17056
17057	<result name="VBOX_E_INVALID_VM_STATE">
17058	Session state prevents operation.
17059	</result>
17060	<result name="VBOX_E_INVALID_OBJECT_STATE">
17061	Session type prevents operation.
17062	</result>
17063
17064	</desc>
17065	<param name="device" type="IUSBDevice" dir="in"/>
17066	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
17067	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
17068	</method>
17069
17070	<method name="onUSBDeviceDetach">
17071	<desc>
17072	Triggered when a request to release the USB device (as a result
17073	of machine termination or direct call to
17074	<link to="IConsole::detachUSBDevice"/>) has completed.
17075	A @c null @a error object means success, otherwise it
17076	describes a failure.
17077
17078	<result name="VBOX_E_INVALID_VM_STATE">
17079	Session state prevents operation.
17080	</result>
17081	<result name="VBOX_E_INVALID_OBJECT_STATE">
17082	Session type prevents operation.
17083	</result>
17084
17085	</desc>
17086	<param name="id" type="uuid" mod="string" dir="in"/>
17087	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
17088	</method>
17089
17090	<method name="onShowWindow">
17091	<desc>
17092	Called by <link to="IMachine::canShowConsoleWindow"/> and by
17093	<link to="IMachine::showConsoleWindow"/> in order to notify
17094	console listeners
17095	<link to="ICanShowWindowEvent"/>
17096	and <link to="IShowWindowEvent"/>.
17097
17098	<result name="VBOX_E_INVALID_OBJECT_STATE">
17099	Session type prevents operation.
17100	</result>
17101
17102	</desc>
17103	<param name="check" type="boolean" dir="in"/>
17104	<param name="canShow" type="boolean" dir="out"/>
17105	<param name="winId" type="long long" dir="out"/>
17106	</method>
17107
17108	<method name="onBandwidthGroupChange">
17109	<desc>
17110	Notification when one of the bandwidth groups change.
17111	</desc>
17112	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
17113	<desc>The bandwidth group which changed.</desc>
17114	</param>
17115	</method>
17116
17117	<method name="accessGuestProperty">
17118	<desc>
17119	Called by <link to="IMachine::getGuestProperty"/> and by
17120	<link to="IMachine::setGuestProperty"/> in order to read and
17121	modify guest properties.
17122
17123	<result name="VBOX_E_INVALID_VM_STATE">
17124	Machine session is not open.
17125	</result>
17126	<result name="VBOX_E_INVALID_OBJECT_STATE">
17127	Session type is not direct.
17128	</result>
17129
17130	</desc>
17131	<param name="name" type="wstring" dir="in"/>
17132	<param name="value" type="wstring" dir="in"/>
17133	<param name="flags" type="wstring" dir="in"/>
17134	<param name="isSetter" type="boolean" dir="in"/>
17135	<param name="retValue" type="wstring" dir="out"/>
17136	<param name="retTimestamp" type="long long" dir="out"/>
17137	<param name="retFlags" type="wstring" dir="out"/>
17138	</method>
17139
17140	<method name="enumerateGuestProperties" const="yes">
17141	<desc>
17142	Return a list of the guest properties matching a set of patterns along
17143	with their values, time stamps and flags.
17144
17145	<result name="VBOX_E_INVALID_VM_STATE">
17146	Machine session is not open.
17147	</result>
17148	<result name="VBOX_E_INVALID_OBJECT_STATE">
17149	Session type is not direct.
17150	</result>
17151
17152	</desc>
17153	<param name="patterns" type="wstring" dir="in">
17154	<desc>
17155	The patterns to match the properties against as a comma-separated
17156	string. If this is empty, all properties currently set will be
17157	returned.
17158	</desc>
17159	</param>
17160	<param name="keys" type="wstring" dir="out" safearray="yes">
17161	<desc>
17162	The key names of the properties returned.
17163	</desc>
17164	</param>
17165	<param name="values" type="wstring" dir="out" safearray="yes">
17166	<desc>
17167	The values of the properties returned. The array entries match the
17168	corresponding entries in the @a key array.
17169	</desc>
17170	</param>
17171	<param name="timestamps" type="long long" dir="out" safearray="yes">
17172	<desc>
17173	The time stamps of the properties returned. The array entries match
17174	the corresponding entries in the @a key array.
17175	</desc>
17176	</param>
17177	<param name="flags" type="wstring" dir="out" safearray="yes">
17178	<desc>
17179	The flags of the properties returned. The array entries match the
17180	corresponding entries in the @a key array.
17181	</desc>
17182	</param>
17183	</method>
17184
17185	<method name="onlineMergeMedium">
17186	<desc>
17187	Triggers online merging of a hard disk. Used internally when deleting
17188	a snapshot while a VM referring to the same hard disk chain is running.
17189
17190	<result name="VBOX_E_INVALID_VM_STATE">
17191	Machine session is not open.
17192	</result>
17193	<result name="VBOX_E_INVALID_OBJECT_STATE">
17194	Session type is not direct.
17195	</result>
17196
17197	</desc>
17198	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
17199	<desc>The medium attachment to identify the medium chain.</desc>
17200	</param>
17201	<param name="sourceIdx" type="unsigned long" dir="in">
17202	<desc>The index of the source image in the chain.
17203	Redundant, but drastically reduces IPC.</desc>
17204	</param>
17205	<param name="targetIdx" type="unsigned long" dir="in">
17206	<desc>The index of the target image in the chain.
17207	Redundant, but drastically reduces IPC.</desc>
17208	</param>
17209	<param name="source" type="IMedium" dir="in">
17210	<desc>Merge source medium.</desc>
17211	</param>
17212	<param name="target" type="IMedium" dir="in">
17213	<desc>Merge target medium.</desc>
17214	</param>
17215	<param name="mergeForward" type="boolean" dir="in">
17216	<desc>Merge direction.</desc>
17217	</param>
17218	<param name="parentForTarget" type="IMedium" dir="in">
17219	<desc>For forward merges: new parent for target medium.</desc>
17220	</param>
17221	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
17222	<desc>For backward merges: list of media which need their parent UUID
17223	updated.</desc>
17224	</param>
17225	<param name="progress" type="IProgress" dir="in">
17226	<desc>
17227	Progress object for this operation.
17228	</desc>
17229	</param>
17230	</method>
17231
17232	<method name="enableVMMStatistics">
17233	<desc>
17234	Enables or disables collection of VMM RAM statistics.
17235
17236	<result name="VBOX_E_INVALID_VM_STATE">
17237	Machine session is not open.
17238	</result>
17239	<result name="VBOX_E_INVALID_OBJECT_STATE">
17240	Session type is not direct.
17241	</result>
17242
17243	</desc>
17244	<param name="enable" type="boolean" dir="in">
17245	<desc>True enables statistics collection.</desc>
17246	</param>
17247	</method>
17248
17249	</interface>
17250
17251	<interface
17252	name="ISession" extends="$unknown"
17253	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
17254	wsmap="managed"
17255	>
17256	<desc>
17257	The ISession interface represents a client process and allows for locking
17258	virtual machines (represented by IMachine objects) to prevent conflicting
17259	changes to the machine.
17260
17261	Any caller wishing to manipulate a virtual machine needs to create a session
17262	object first, which lives in its own process space. Such session objects are
17263	then associated with <link to="IMachine" /> objects living in the VirtualBox
17264	server process to coordinate such changes.
17265
17266	There are two typical scenarios in which sessions are used:
17267
17268	<ul>
17269	<li>To alter machine settings or control a running virtual machine, one
17270	needs to lock a machine for a given session (client process) by calling
17271	<link to="IMachine::lockMachine"/>.
17272
17273	Whereas multiple sessions may control a running virtual machine, only
17274	one process can obtain a write lock on the machine to prevent conflicting
17275	changes. A write lock is also needed if a process wants to actually run a
17276	virtual machine in its own context, such as the VirtualBox GUI or
17277	VBoxHeadless front-ends. They must also lock a machine for their own
17278	sessions before they are allowed to power up the virtual machine.
17279
17280	As a result, no machine settings can be altered while another process is
17281	already using it, either because that process is modifying machine settings
17282	or because the machine is running.
17283	</li>
17284	<li>
17285	To start a VM using one of the existing VirtualBox front-ends (e.g. the
17286	VirtualBox GUI or VBoxHeadless), one would use
17287	<link to="IMachine::launchVMProcess"/>, which also takes a session object
17288	as its first parameter. This session then identifies the caller and lets the
17289	caller control the started machine (for example, pause machine execution or
17290	power it down) as well as be notified about machine execution state changes.
17291	</li>
17292	</ul>
17293
17294	How sessions objects are created in a client process depends on whether you use
17295	the Main API via COM or via the webservice:
17296
17297	<ul>
17298	<li>When using the COM API directly, an object of the Session class from the
17299	VirtualBox type library needs to be created. In regular COM C++ client code,
17300	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
17301	This object will then act as a local session object in further calls to open
17302	a session.
17303	</li>
17304
17305	<li>In the webservice, the session manager (IWebsessionManager) instead creates
17306	a session object automatically whenever <link to="IWebsessionManager::logon" />
17307	is called. A managed object reference to that session object can be retrieved by
17308	calling <link to="IWebsessionManager::getSessionObject" />.
17309	</li>
17310	</ul>
17311	</desc>
17312
17313	<attribute name="state" type="SessionState" readonly="yes">
17314	<desc>Current state of this session.</desc>
17315	</attribute>
17316
17317	<attribute name="type" type="SessionType" readonly="yes">
17318	<desc>
17319	Type of this session. The value of this attribute is valid only
17320	if the session currently has a machine locked (i.e. its
17321	<link to="#state" /> is Locked), otherwise an error will be returned.
17322	</desc>
17323	</attribute>
17324
17325	<attribute name="machine" type="IMachine" readonly="yes">
17326	<desc>Machine object associated with this session.</desc>
17327	</attribute>
17328
17329	<attribute name="console" type="IConsole" readonly="yes">
17330	<desc>Console object associated with this session.</desc>
17331	</attribute>
17332
17333	<method name="unlockMachine">
17334	<desc>
17335	Unlocks a machine that was previously locked for the current session.
17336
17337	Calling this method is required every time a machine has been locked
17338	for a particular session using the <link to="IMachine::launchVMProcess" />
17339	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
17340	the machine will be set to <link to="MachineState_Aborted" /> on the
17341	server, and changes made to the machine settings will be lost.
17342
17343	Generally, it is recommended to unlock all machines explicitly
17344	before terminating the application (regardless of the reason for
17345	the termination).
17346
17347	<note>
17348	Do not expect the session state (<link to="ISession::state" />
17349	to return to "Unlocked" immediately after you invoke this method,
17350	particularly if you have started a new VM process. The session
17351	state will automatically return to "Unlocked" once the VM is no
17352	longer executing, which can of course take a very long time.
17353	</note>
17354
17355	<result name="E_UNEXPECTED">
17356	Session is not locked.
17357	</result>
17358
17359	</desc>
17360	</method>
17361
17362	</interface>
17363
17364	<!--
17365	// IStorageController
17366	/////////////////////////////////////////////////////////////////////////
17367	-->
17368
17369	<enum
17370	name="StorageBus"
17371	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
17372	>
17373	<desc>
17374	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
17375	see <link to="IStorageController::bus" />.
17376	</desc>
17377	<const name="Null" value="0">
17378	<desc>@c null value. Never used by the API.</desc>
17379	</const>
17380	<const name="IDE" value="1"/>
17381	<const name="SATA" value="2"/>
17382	<const name="SCSI" value="3"/>
17383	<const name="Floppy" value="4"/>
17384	<const name="SAS" value="5"/>
17385	</enum>
17386
17387	<enum
17388	name="StorageControllerType"
17389	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
17390	>
17391	<desc>
17392	The exact variant of storage controller hardware presented
17393	to the guest; see <link to="IStorageController::controllerType" />.
17394	</desc>
17395
17396	<const name="Null" value="0">
17397	<desc>@c null value. Never used by the API.</desc>
17398	</const>
17399	<const name="LsiLogic" value="1">
17400	<desc>A SCSI controller of the LsiLogic variant.</desc>
17401	</const>
17402	<const name="BusLogic" value="2">
17403	<desc>A SCSI controller of the BusLogic variant.</desc>
17404	</const>
17405	<const name="IntelAhci" value="3">
17406	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
17407	</const>
17408	<const name="PIIX3" value="4">
17409	<desc>An IDE controller of the PIIX3 variant.</desc>
17410	</const>
17411	<const name="PIIX4" value="5">
17412	<desc>An IDE controller of the PIIX4 variant.</desc>
17413	</const>
17414	<const name="ICH6" value="6">
17415	<desc>An IDE controller of the ICH6 variant.</desc>
17416	</const>
17417	<const name="I82078" value="7">
17418	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
17419	</const>
17420	<const name="LsiLogicSas" value="8">
17421	<desc>A variant of the LsiLogic controller using SAS.</desc>
17422	</const>
17423	</enum>
17424
17425	<enum
17426	name="ChipsetType"
17427	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
17428	>
17429	<desc>
17430	Type of emulated chipset (mostly southbridge).
17431	</desc>
17432
17433	<const name="Null" value="0">
17434	<desc>@c null value. Never used by the API.</desc>
17435	</const>
17436	<const name="PIIX3" value="1">
17437	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
17438	</const>
17439	<const name="ICH9" value="2">
17440	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
17441	</const>
17442	</enum>
17443
17444	<interface
17445	name="IStorageController" extends="$unknown"
17446	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
17447	wsmap="managed"
17448	>
17449	<desc>
17450	Represents a storage controller that is attached to a virtual machine
17451	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
17452	attached to storage controllers in a real computer, virtual drives
17453	(represented by <link to="IMediumAttachment" />) are attached to virtual
17454	storage controllers, represented by this interface.
17455
17456	As opposed to physical hardware, VirtualBox has a very generic concept
17457	of a storage controller, and for purposes of the Main API, all virtual
17458	storage is attached to virtual machines via instances of this interface.
17459	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
17460	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
17461	is used, certain sub-types may be available and can be selected in
17462	<link to="#controllerType" />.
17463
17464	Depending on these settings, the guest operating system might see
17465	significantly different virtual hardware.
17466	</desc>
17467
17468	<attribute name="name" type="wstring" readonly="yes">
17469	<desc>
17470	Name of the storage controller, as originally specified with
17471	<link to="IMachine::addStorageController" />. This then uniquely
17472	identifies this controller with other method calls such as
17473	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
17474	</desc>
17475	</attribute>
17476
17477	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
17478	<desc>
17479	Maximum number of devices which can be attached to one port.
17480	</desc>
17481	</attribute>
17482
17483	<attribute name="minPortCount" type="unsigned long" readonly="yes">
17484	<desc>
17485	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
17486	</desc>
17487	</attribute>
17488
17489	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
17490	<desc>
17491	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
17492	</desc>
17493	</attribute>
17494
17495	<attribute name="instance" type="unsigned long">
17496	<desc>
17497	The instance number of the device in the running VM.
17498	</desc>
17499	</attribute>
17500
17501	<attribute name="portCount" type="unsigned long">
17502	<desc>
17503	The number of currently usable ports on the controller.
17504	The minimum and maximum number of ports for one controller are
17505	stored in <link to="IStorageController::minPortCount"/>
17506	and <link to="IStorageController::maxPortCount"/>.
17507	</desc>
17508	</attribute>
17509
17510	<attribute name="bus" type="StorageBus" readonly="yes">
17511	<desc>
17512	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
17513	</desc>
17514	</attribute>
17515
17516	<attribute name="controllerType" type="StorageControllerType">
17517	<desc>
17518	The exact variant of storage controller hardware presented
17519	to the guest.
17520	Depending on this value, VirtualBox will provide a different
17521	virtual storage controller hardware to the guest.
17522	For SATA, SAS and floppy controllers, only one variant is
17523	available, but for IDE and SCSI, there are several.
17524
17525	For SCSI controllers, the default type is LsiLogic.
17526	</desc>
17527	</attribute>
17528
17529	<attribute name="useHostIOCache" type="boolean">
17530	<desc>
17531	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
17532	caches and use synchronous file APIs on the host. This was the only option in the API before
17533	VirtualBox 3.2 and is still the default for IDE controllers.
17534
17535	If false, the host I/O cache will be disabled for image files attached to this storage controller.
17536	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
17537	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
17538	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
17539	virtual machines are running at the same time to prevent I/O cache related hangs.
17540	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
17541	</desc>
17542	</attribute>
17543
17544	<attribute name="bootable" type="boolean" readonly="yes">
17545	<desc>
17546	Returns whether it is possible to boot from disks attached to this controller.
17547	</desc>
17548	</attribute>
17549	</interface>
17550
17551	<if target="wsdl">
17552
17553	<!--
17554	// IManagedObjectRef
17555	/////////////////////////////////////////////////////////////////////////
17556	-->
17557
17558	<interface
17559	name="IManagedObjectRef" extends="$unknown"
17560	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
17561	internal="yes"
17562	wsmap="managed"
17563	wscpp="hardcoded"
17564	>
17565	<desc>
17566	Managed object reference.
17567
17568	Only within the webservice, a managed object reference (which is really
17569	an opaque number) allows a webservice client to address an object
17570	that lives in the address space of the webservice server.
17571
17572	Behind each managed object reference, there is a COM object that lives
17573	in the webservice server's address space. The COM object is not freed
17574	until the managed object reference is released, either by an explicit
17575	call to <link to="IManagedObjectRef::release" /> or by logging off from
17576	the webservice (<link to="IWebsessionManager::logoff" />), which releases
17577	all objects created during the webservice session.
17578
17579	Whenever a method call of the VirtualBox API returns a COM object, the
17580	webservice representation of that method will instead return a
17581	managed object reference, which can then be used to invoke methods
17582	on that object.
17583	</desc>
17584
17585	<method name="getInterfaceName">
17586	<desc>
17587	Returns the name of the interface that this managed object represents,
17588	for example, "IMachine", as a string.
17589	</desc>
17590	<param name="return" type="wstring" dir="return"/>
17591	</method>
17592
17593	<method name="release">
17594	<desc>
17595	Releases this managed object reference and frees the resources that
17596	were allocated for it in the webservice server process. After calling
17597	this method, the identifier of the reference can no longer be used.
17598	</desc>
17599	</method>
17600
17601	</interface>
17602
17603	<!--
17604	// IWebsessionManager
17605	/////////////////////////////////////////////////////////////////////////
17606	-->
17607
17608	<interface
17609	name="IWebsessionManager" extends="$unknown"
17610	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
17611	internal="yes"
17612	wsmap="global"
17613	wscpp="hardcoded"
17614	>
17615	<desc>
17616	Websession manager. This provides essential services
17617	to webservice clients.
17618	</desc>
17619	<method name="logon">
17620	<desc>
17621	Logs a new client onto the webservice and returns a managed object reference to
17622	the IVirtualBox instance, which the client can then use as a basis to further
17623	queries, since all calls to the VirtualBox API are based on the IVirtualBox
17624	interface, in one way or the other.
17625	</desc>
17626	<param name="username" type="wstring" dir="in"/>
17627	<param name="password" type="wstring" dir="in"/>
17628	<param name="return" type="IVirtualBox" dir="return"/>
17629	</method>
17630
17631	<method name="getSessionObject">
17632	<desc>
17633	Returns a managed object reference to the internal ISession object that was created
17634	for this web service session when the client logged on.
17635
17636	<see><link to="ISession"/></see>
17637	</desc>
17638	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17639	<param name="return" type="ISession" dir="return"/>
17640	</method>
17641
17642	<method name="logoff">
17643	<desc>
17644	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
17645	and destroys all resources associated with the session (most importantly, all
17646	managed objects created in the server while the session was active).
17647	</desc>
17648	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17649	</method>
17650
17651	</interface>
17652
17653	</if>
17654
17655	<!--
17656	// IPerformanceCollector & friends
17657	/////////////////////////////////////////////////////////////////////////
17658	-->
17659
17660	<interface
17661	name="IPerformanceMetric" extends="$unknown"
17662	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
17663	>
17664	<desc>
17665	The IPerformanceMetric interface represents parameters of the given
17666	performance metric.
17667	</desc>
17668
17669	<attribute name="metricName" type="wstring" readonly="yes">
17670	<desc>
17671	Name of the metric.
17672	</desc>
17673	</attribute>
17674
17675	<attribute name="object" type="$unknown" readonly="yes">
17676	<desc>
17677	Object this metric belongs to.
17678	</desc>
17679	</attribute>
17680
17681	<attribute name="description" type="wstring" readonly="yes">
17682	<desc>
17683	Textual description of the metric.
17684	</desc>
17685	</attribute>
17686
17687	<attribute name="period" type="unsigned long" readonly="yes">
17688	<desc>
17689	Time interval between samples, measured in seconds.
17690	</desc>
17691	</attribute>
17692
17693	<attribute name="count" type="unsigned long" readonly="yes">
17694	<desc>
17695	Number of recent samples retained by the performance collector for this
17696	metric.
17697
17698	When the collected sample count exceeds this number, older samples
17699	are discarded.
17700	</desc>
17701	</attribute>
17702
17703	<attribute name="unit" type="wstring" readonly="yes">
17704	<desc>
17705	Unit of measurement.
17706	</desc>
17707	</attribute>
17708
17709	<attribute name="minimumValue" type="long" readonly="yes">
17710	<desc>
17711	Minimum possible value of this metric.
17712	</desc>
17713	</attribute>
17714
17715	<attribute name="maximumValue" type="long" readonly="yes">
17716	<desc>
17717	Maximum possible value of this metric.
17718	</desc>
17719	</attribute>
17720	</interface>
17721
17722	<interface
17723	name="IPerformanceCollector" extends="$unknown"
17724	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
17725	wsmap="managed"
17726	>
17727	<desc>
17728	The IPerformanceCollector interface represents a service that collects
17729	and stores performance metrics data.
17730
17731	Performance metrics are associated with objects of interfaces like IHost
17732	and IMachine. Each object has a distinct set of performance metrics. The
17733	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
17734
17735	Metric data is collected at the specified intervals and is retained
17736	internally. The interval and the number of retained samples can be set
17737	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
17738	and collection settings are not persistent, they are discarded as soon as
17739	VBoxSVC process terminates. Moreover, metric settings and data associated
17740	with a particular VM only exist while VM is running. They disappear as
17741	soon as VM shuts down. It is not possible to set up metrics for machines
17742	that are powered off. One needs to start VM first, then set up metric
17743	collection parameters.
17744
17745	Metrics are organized hierarchically, with each level separated by a
17746	slash (/) character. Generally, the scheme for metric names is like this:
17747
17748	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
17749
17750	"Category/Metric" together form the base metric name. A base metric is
17751	the smallest unit for which a sampling interval and the number of
17752	retained samples can be set. Only base metrics can be enabled and
17753	disabled. All sub-metrics are collected when their base metric is
17754	collected. Collected values for any set of sub-metrics can be queried
17755	with <link to="IPerformanceCollector::queryMetricsData" />.
17756
17757	For example "CPU/Load/User:avg" metric name stands for the "CPU"
17758	category, "Load" metric, "User" submetric, "average" aggregate. An
17759	aggregate function is computed over all retained data. Valid aggregate
17760	functions are:
17761
17762	<ul>
17763	<li>avg -- average</li>
17764	<li>min -- minimum</li>
17765	<li>max -- maximum</li>
17766	</ul>
17767
17768	When setting up metric parameters, querying metric data, enabling or
17769	disabling metrics wildcards can be used in metric names to specify a
17770	subset of metrics. For example, to select all CPU-related metrics
17771	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
17772	so on. To query metric values without aggregates <tt>*:</tt> can be used.
17773
17774	The valid names for base metrics are:
17775
17776	<ul>
17777	<li>CPU/Load</li>
17778	<li>CPU/MHz</li>
17779	<li>RAM/Usage</li>
17780	<li>RAM/VMM</li>
17781	</ul>
17782
17783	The general sequence for collecting and retrieving the metrics is:
17784	<ul>
17785	<li>
17786	Obtain an instance of IPerformanceCollector with
17787	<link to="IVirtualBox::performanceCollector" />
17788	</li>
17789	<li>
17790	Allocate and populate an array with references to objects the metrics
17791	will be collected for. Use references to IHost and IMachine objects.
17792	</li>
17793	<li>
17794	Allocate and populate an array with base metric names the data will
17795	be collected for.
17796	</li>
17797	<li>
17798	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
17799	the metric data will be collected and stored.
17800	</li>
17801	<li>
17802	Wait for the data to get collected.
17803	</li>
17804	<li>
17805	Allocate and populate an array with references to objects the metric
17806	values will be queried for. You can re-use the object array used for
17807	setting base metrics.
17808	</li>
17809	<li>
17810	Allocate and populate an array with metric names the data will be
17811	collected for. Note that metric names differ from base metric names.
17812	</li>
17813	<li>
17814	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
17815	that have been collected so far are returned. Note that the values
17816	are still retained internally and data collection continues.
17817	</li>
17818	</ul>
17819
17820	For an example of usage refer to the following files in VirtualBox SDK:
17821	<ul>
17822	<li>
17823	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
17824	</li>
17825	<li>
17826	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
17827	</li>
17828	</ul>
17829	</desc>
17830
17831	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
17832	<desc>
17833	Array of unique names of metrics.
17834
17835	This array represents all metrics supported by the performance
17836	collector. Individual objects do not necessarily support all of them.
17837	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
17838	list of supported metrics for a particular object.
17839	</desc>
17840	</attribute>
17841
17842	<method name="getMetrics">
17843	<desc>
17844	Returns parameters of specified metrics for a set of objects.
17845	<note>
17846	@c Null metrics array means all metrics. @c Null object array means
17847	all existing objects.
17848	</note>
17849	</desc>
17850	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17851	<desc>
17852	Metric name filter. Currently, only a comma-separated list of metrics
17853	is supported.
17854	</desc>
17855	</param>
17856	<param name="objects" type="$unknown" dir="in" safearray="yes">
17857	<desc>
17858	Set of objects to return metric parameters for.
17859	</desc>
17860	</param>
17861	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
17862	<desc>
17863	Array of returned metric parameters.
17864	</desc>
17865	</param>
17866	</method>
17867
17868	<method name="setupMetrics">
17869	<desc>
17870	Sets parameters of specified base metrics for a set of objects. Returns
17871	an array of <link to="IPerformanceMetric" /> describing the metrics
17872	have been affected.
17873	<note>
17874	@c Null or empty metric name array means all metrics. @c Null or
17875	empty object array means all existing objects. If metric name array
17876	contains a single element and object array contains many, the single
17877	metric name array element is applied to each object array element to
17878	form metric/object pairs.
17879	</note>
17880	</desc>
17881	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17882	<desc>
17883	Metric name filter. Comma-separated list of metrics with wildcard
17884	support.
17885	</desc>
17886	</param>
17887	<param name="objects" type="$unknown" dir="in" safearray="yes">
17888	<desc>
17889	Set of objects to setup metric parameters for.
17890	</desc>
17891	</param>
17892	<param name="period" type="unsigned long" dir="in">
17893	<desc>
17894	Time interval in seconds between two consecutive samples of
17895	performance data.
17896	</desc>
17897	</param>
17898	<param name="count" type="unsigned long" dir="in">
17899	<desc>
17900	Number of samples to retain in performance data history. Older
17901	samples get discarded.
17902	</desc>
17903	</param>
17904	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17905	<desc>
17906	Array of metrics that have been modified by the call to this method.
17907	</desc>
17908	</param>
17909	</method>
17910
17911	<method name="enableMetrics">
17912	<desc>
17913	Turns on collecting specified base metrics. Returns an array of
17914	<link to="IPerformanceMetric" /> describing the metrics have been
17915	affected.
17916	<note>
17917	@c Null or empty metric name array means all metrics. @c Null or
17918	empty object array means all existing objects. If metric name array
17919	contains a single element and object array contains many, the single
17920	metric name array element is applied to each object array element to
17921	form metric/object pairs.
17922	</note>
17923	</desc>
17924	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17925	<desc>
17926	Metric name filter. Comma-separated list of metrics with wildcard
17927	support.
17928	</desc>
17929	</param>
17930	<param name="objects" type="$unknown" dir="in" safearray="yes">
17931	<desc>
17932	Set of objects to enable metrics for.
17933	</desc>
17934	</param>
17935	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17936	<desc>
17937	Array of metrics that have been modified by the call to this method.
17938	</desc>
17939	</param>
17940	</method>
17941
17942	<method name="disableMetrics">
17943	<desc>
17944	Turns off collecting specified base metrics. Returns an array of
17945	<link to="IPerformanceMetric" /> describing the metrics have been
17946	affected.
17947	<note>
17948	@c Null or empty metric name array means all metrics. @c Null or
17949	empty object array means all existing objects. If metric name array
17950	contains a single element and object array contains many, the single
17951	metric name array element is applied to each object array element to
17952	form metric/object pairs.
17953	</note>
17954	</desc>
17955	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17956	<desc>
17957	Metric name filter. Comma-separated list of metrics with wildcard
17958	support.
17959	</desc>
17960	</param>
17961	<param name="objects" type="$unknown" dir="in" safearray="yes">
17962	<desc>
17963	Set of objects to disable metrics for.
17964	</desc>
17965	</param>
17966	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17967	<desc>
17968	Array of metrics that have been modified by the call to this method.
17969	</desc>
17970	</param>
17971	</method>
17972
17973	<method name="queryMetricsData">
17974	<desc>
17975	Queries collected metrics data for a set of objects.
17976
17977	The data itself and related metric information are returned in seven
17978	parallel and one flattened array of arrays. Elements of
17979	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
17980	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
17981	the same index describe one set of values corresponding to a single
17982	metric.
17983
17984	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
17985	start and length of a sub-array is indicated by
17986	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
17987	value for metric <tt>metricNames[i]</tt> is at
17988	<tt>returnData[returnIndices[i]]</tt>.
17989
17990	<note>
17991	@c Null or empty metric name array means all metrics. @c Null or
17992	empty object array means all existing objects. If metric name array
17993	contains a single element and object array contains many, the single
17994	metric name array element is applied to each object array element to
17995	form metric/object pairs.
17996	</note>
17997	<note>
17998	Data collection continues behind the scenes after call to @c
17999	queryMetricsData. The return data can be seen as the snapshot of the
18000	current state at the time of @c queryMetricsData call. The internally
18001	kept metric values are not cleared by the call. This makes possible
18002	querying different subsets of metrics or aggregates with subsequent
18003	calls. If periodic querying is needed it is highly suggested to query
18004	the values with @c interval*count period to avoid confusion. This way
18005	a completely new set of data values will be provided by each query.
18006	</note>
18007	</desc>
18008	<param name="metricNames" type="wstring" dir="in" safearray="yes">
18009	<desc>
18010	Metric name filter. Comma-separated list of metrics with wildcard
18011	support.
18012	</desc>
18013	</param>
18014	<param name="objects" type="$unknown" dir="in" safearray="yes">
18015	<desc>
18016	Set of objects to query metrics for.
18017	</desc>
18018	</param>
18019	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
18020	<desc>
18021	Names of metrics returned in @c returnData.
18022	</desc>
18023	</param>
18024	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
18025	<desc>
18026	Objects associated with metrics returned in @c returnData.
18027	</desc>
18028	</param>
18029	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
18030	<desc>
18031	Units of measurement for each returned metric.
18032	</desc>
18033	</param>
18034	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
18035	<desc>
18036	Divisor that should be applied to return values in order to get
18037	floating point values. For example:
18038	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
18039	will retrieve the floating point value of i-th sample of the first
18040	metric.
18041	</desc>
18042	</param>
18043	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
18044	<desc>
18045	Sequence numbers of the first elements of value sequences of
18046	particular metrics returned in @c returnData. For aggregate metrics
18047	it is the sequence number of the sample the aggregate started
18048	calculation from.
18049	</desc>
18050	</param>
18051	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
18052	<desc>
18053	Indices of the first elements of value sequences of particular
18054	metrics returned in @c returnData.
18055	</desc>
18056	</param>
18057	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
18058	<desc>
18059	Lengths of value sequences of particular metrics.
18060	</desc>
18061	</param>
18062	<param name="returnData" type="long" dir="return" safearray="yes">
18063	<desc>
18064	Flattened array of all metric data containing sequences of values for
18065	each metric.
18066	</desc>
18067	</param>
18068	</method>
18069
18070	</interface>
18071
18072	<enum
18073	name="NATAliasMode"
18074	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
18075	>
18076	<desc></desc>
18077	<const name="AliasLog" value="0x1">
18078	<desc></desc>
18079	</const>
18080	<const name="AliasProxyOnly" value="0x02">
18081	<desc></desc>
18082	</const>
18083	<const name="AliasUseSamePorts" value="0x04">
18084	<desc></desc>
18085	</const>
18086	</enum>
18087
18088	<enum
18089	name="NATProtocol"
18090	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
18091	>
18092	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
18093	<const name="UDP" value="0">
18094	<desc>Port-forwarding uses UDP protocol.</desc>
18095	</const>
18096	<const name="TCP" value="1">
18097	<desc>Port-forwarding uses TCP protocol.</desc>
18098	</const>
18099	</enum>
18100
18101	<interface
18102	name="INATEngine" extends="$unknown"
18103	uuid="26451b99-3b2d-4dcb-8e4b-d63654218175"
18104	wsmap="managed"
18105	>
18106	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
18107	allows for changing NAT behavior such as port-forwarding rules. This interface is
18108	used in the <link to="INetworkAdapter::NATEngine" /> attribute.</desc>
18109	<attribute name="network" type="wstring">
18110	<desc>The network attribute of the NAT engine (the same value is used with built-in
18111	DHCP server to fill corresponding fields of DHCP leases).</desc>
18112	</attribute>
18113	<attribute name="hostIP" type="wstring">
18114	<desc>IP of host interface to bind all opened sockets to.
18115	<note>Changing this does not change binding of port forwarding.</note>
18116	</desc>
18117	</attribute>
18118	<attribute name="TFTPPrefix" type="wstring">
18119	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
18120	the corresponding fields of DHCP leases.</desc>
18121	</attribute>
18122	<attribute name="TFTPBootFile" type="wstring">
18123	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
18124	the corresponding fields of DHCP leases.</desc>
18125	</attribute>
18126	<attribute name="TFTPNextServer" type="wstring">
18127	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
18128	the corresponding fields of DHCP leases.
18129	<note>The preferred form is IPv4 addresses.</note>
18130	</desc>
18131	</attribute>
18132	<attribute name="aliasMode" type="unsigned long">
18133	<desc></desc>
18134	</attribute>
18135	<attribute name="DNSPassDomain" type="boolean">
18136	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
18137	</attribute>
18138	<attribute name="DNSProxy" type="boolean">
18139	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18140	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
18141	</attribute>
18142	<attribute name="DNSUseHostResolver" type="boolean">
18143	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18144	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
18145	</attribute>
18146	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
18147	<desc>Array of NAT port-forwarding rules in string representation, in the following
18148	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
18149	</attribute>
18150	<method name="setNetworkSettings">
18151	<desc>Sets network configuration of the NAT engine.</desc>
18152	<param name="mtu" type="unsigned long" dir="in">
18153	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
18154	</param>
18155	<param name="sockSnd" type="unsigned long" dir="in">
18156	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
18157	</param>
18158	<param name="sockRcv" type="unsigned long" dir="in">
18159	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
18160	</param>
18161	<param name="TcpWndSnd" type="unsigned long" dir="in">
18162	<desc>Initial size of the NAT engine's sending TCP window in bytes when
18163	establishing a new TCP connection.</desc>
18164	</param>
18165	<param name="TcpWndRcv" type="unsigned long" dir="in">
18166	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
18167	establishing a new TCP connection.</desc>
18168	</param>
18169	</method>
18170	<method name="getNetworkSettings">
18171	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
18172	for parameter descriptions.</desc>
18173	<param name="mtu" type="unsigned long" dir="out" />
18174	<param name="sockSnd" type="unsigned long" dir="out" />
18175	<param name="sockRcv" type="unsigned long" dir="out" />
18176	<param name="TcpWndSnd" type="unsigned long" dir="out" />
18177	<param name="TcpWndRcv" type="unsigned long" dir="out" />
18178	</method>
18179	<method name="addRedirect">
18180	<desc>Adds a new NAT port-forwarding rule.</desc>
18181	<param name="name" type="wstring" dir="in">
18182	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
18183	auto-generates one using the other parameters.</desc>
18184	</param>
18185	<param name="proto" type="NATProtocol" dir="in">
18186	<desc>Protocol handled with the rule.</desc>
18187	</param>
18188	<param name="hostIP" type="wstring" dir="in">
18189	<desc>IP of the host interface to which the rule should apply. An empty ip address is
18190	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
18191	</param>
18192	<param name="hostPort" type="unsigned short" dir="in">
18193	<desc>The port number to listen on.</desc>
18194	</param>
18195	<param name="guestIP" type="wstring" dir="in">
18196	<desc>The IP address of the guest which the NAT engine will forward matching packets
18197	to. An empty IP address is acceptable, in which case the NAT engine will forward
18198	packets to the first DHCP lease (x.x.x.15).</desc>
18199	</param>
18200	<param name="guestPort" type="unsigned short" dir="in">
18201	<desc>The port number to forward.</desc>
18202	</param>
18203	</method>
18204	<method name="removeRedirect">
18205	<desc>Removes a port-forwarding rule that was previously registered.</desc>
18206	<param name="name" type="wstring" dir="in">
18207	<desc>The name of the rule to delete.</desc>
18208	</param>
18209	</method>
18210	</interface>
18211
18212	<!--
18213	// IExtPackManager
18214	/////////////////////////////////////////////////////////////////////////
18215	-->
18216
18217	<interface
18218	name="IExtPackPlugIn" extends="$unknown"
18219	uuid="58000040-e718-4746-bbce-4b86d96da461"
18220	wsmap="suppress"
18221	>
18222	<desc>
18223	Interface for keeping information about a plug-in that ships with an
18224	extension pack.
18225	</desc>
18226	<attribute name="name" type="wstring" readonly="yes">
18227	<desc>The plug-in name.</desc>
18228	</attribute>
18229	<attribute name="description" type="wstring" readonly="yes">
18230	<desc>The plug-in description.</desc>
18231	</attribute>
18232	<attribute name="frontend" type="wstring" readonly="yes">
18233	<desc>
18234	The name of the frontend or component name this plug-in plugs into.
18235	</desc>
18236	</attribute>
18237	<attribute name="modulePath" type="wstring" readonly="yes">
18238	<desc> The module path. </desc>
18239	</attribute>
18240	</interface>
18241
18242	<interface
18243	name="IExtPackBase" extends="$unknown"
18244	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
18245	wsmap="suppress"
18246	>
18247	<desc>
18248	Interface for querying information about an extension pack as well as
18249	accessing COM objects within it.
18250	</desc>
18251	<attribute name="name" type="wstring" readonly="yes">
18252	<desc>The extension pack name. This is unique.</desc>
18253	</attribute>
18254	<attribute name="description" type="wstring" readonly="yes">
18255	<desc>The extension pack description.</desc>
18256	</attribute>
18257	<attribute name="version" type="wstring" readonly="yes">
18258	<desc>
18259	The extension pack version string. This is restricted to the dotted
18260	version number and optionally a build indicator. No tree revision or
18261	tag will be included in the string as those things are available as
18262	separate properties. An optional publisher tag may be present like for
18263	<link to="IVirtualBox::version"/>.
18264
18265	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
18266	</desc>
18267	</attribute>
18268	<attribute name="revision" type="unsigned long" readonly="yes">
18269	<desc>The extension pack internal revision number.</desc>
18270	</attribute>
18271	<attribute name="edition" type="wstring" readonly="yes">
18272	<desc>
18273	Edition indicator. This is usually empty.
18274
18275	Can for instance be used to help distinguishing between two editions
18276	of the same extension pack where only the license, service contract or
18277	something differs.
18278	</desc>
18279	</attribute>
18280	<attribute name="VRDEModule" type="wstring" readonly="yes">
18281	<desc>The name of the VRDE module if the extension pack sports one.</desc>
18282	</attribute>
18283	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
18284	<desc>Plug-ins provided by this extension pack.</desc>
18285	</attribute>
18286	<attribute name="usable" type="boolean" readonly="yes">
18287	<desc>
18288	Indicates whether the extension pack is usable or not.
18289
18290	There are a number of reasons why an extension pack might be unusable,
18291	typical examples would be broken installation/file or that it is
18292	incompatible with the current VirtualBox version.
18293	</desc>
18294	</attribute>
18295	<attribute name="whyUnusable" type="wstring" readonly="yes">
18296	<desc>
18297	String indicating why the extension pack is not usable. This is an
18298	empty string if usable and always a non-empty string if not usable.
18299	</desc>
18300	</attribute>
18301	<attribute name="showLicense" type="boolean" readonly="yes">
18302	<desc>Whether to show the license before installation</desc>
18303	</attribute>
18304	<attribute name="license" type="wstring" readonly="yes">
18305	<desc>
18306	The default HTML license text for the extension pack. Same as
18307	calling <link to="#queryLicense">queryLicense</link> with
18308	preferredLocale and preferredLanguage as empty strings and format set
18309	to html.
18310	</desc>
18311	</attribute>
18312
18313	<method name="queryLicense">
18314	<desc>
18315	Full feature version of the license attribute.
18316	</desc>
18317	<param name="preferredLocale" type="wstring" dir="in">
18318	<desc>
18319	The preferred license locale. Pass an empty string to get the default
18320	license.
18321	</desc>
18322	</param>
18323	<param name="preferredLanguage" type="wstring" dir="in">
18324	<desc>
18325	The preferred license language. Pass an empty string to get the
18326	default language for the locale.
18327	</desc>
18328	</param>
18329	<param name="format" type="wstring" dir="in">
18330	<desc>
18331	The license format: html, rtf or txt. If a license is present there
18332	will always be an HTML of it, the rich text format (RTF) and plain
18333	text (txt) versions are optional. If
18334	</desc>
18335	</param>
18336	<param name="licenseText" type="wstring" dir="return">
18337	<desc>The license text.</desc>
18338	</param>
18339	</method>
18340
18341	</interface>
18342
18343	<interface
18344	name="IExtPack" extends="IExtPackBase"
18345	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
18346	wsmap="suppress"
18347	>
18348	<desc>
18349	Interface for querying information about an extension pack as well as
18350	accessing COM objects within it.
18351	</desc>
18352	<method name="queryObject">
18353	<desc>
18354	Queries the IUnknown interface to an object in the extension pack
18355	main module. This allows plug-ins and others to talk directly to an
18356	extension pack.
18357	</desc>
18358	<param name="objUuid" type="wstring" dir="in">
18359	<desc>The object ID. What exactly this is </desc>
18360	</param>
18361	<param name="returnInterface" type="$unknown" dir="return">
18362	<desc>The queried interface.</desc>
18363	</param>
18364	</method>
18365	</interface>
18366
18367	<interface
18368	name="IExtPackFile" extends="IExtPackBase"
18369	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
18370	wsmap="suppress"
18371	>
18372	<desc>
18373	Extension pack file (aka tarball, .vbox-extpack) representation returned
18374	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
18375	extension pack information with the addition of the file name.
18376	</desc>
18377	<attribute name="filePath" type="wstring" readonly="yes">
18378	<desc>
18379	The path to the extension pack file.
18380	</desc>
18381	</attribute>
18382
18383	<method name="install">
18384	<desc>
18385	Install the extension pack.
18386	</desc>
18387	<param name="replace" type="boolean" dir="in">
18388	<desc>
18389	Set this to automatically uninstall any existing extension pack with
18390	the same name as the one being installed.
18391	</desc>
18392	</param>
18393	<param name="displayInfo" type="wstring" dir="in">
18394	<desc>
18395	Platform specific display information. Reserved for future hacks.
18396	</desc>
18397	</param>
18398	<param name="progess" type="IProgress" dir="return">
18399	<desc>
18400	Progress object for the operation.
18401	</desc>
18402	</param>
18403	</method>
18404	</interface>
18405
18406	<interface
18407	name="IExtPackManager" extends="$unknown"
18408	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
18409	wsmap="suppress"
18410	>
18411	<desc>
18412	Interface for managing VirtualBox Extension Packs.
18413
18414	TODO: Describe extension packs, how they are managed and how to create
18415	one.
18416	</desc>
18417
18418	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
18419	<desc>
18420	List of the installed extension packs.
18421	</desc>
18422	</attribute>
18423
18424	<method name="find">
18425	<desc>
18426	Returns the extension pack with the specified name if found.
18427
18428	<result name="VBOX_E_OBJECT_NOT_FOUND">
18429	No extension pack matching @a name was found.
18430	</result>
18431	</desc>
18432	<param name="name" type="wstring" dir="in">
18433	<desc>The name of the extension pack to locate.</desc>
18434	</param>
18435	<param name="returnData" type="IExtPack" dir="return">
18436	<desc>The extension pack if found.</desc>
18437	</param>
18438	</method>
18439
18440	<method name="openExtPackFile">
18441	<desc>
18442	Attempts to open an extension pack file in preparation for
18443	installation.
18444	</desc>
18445	<param name="path" type="wstring" dir="in">
18446	<desc>The path of the extension pack tarball. This can optionally be
18447	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
18448	</param>
18449	<param name="file" type="IExtPackFile" dir="return">
18450	<desc>The interface of the extension pack file object.</desc>
18451	</param>
18452	</method>
18453
18454	<method name="uninstall">
18455	<desc>Uninstalls an extension pack, removing all related files.</desc>
18456	<param name="name" type="wstring" dir="in">
18457	<desc>The name of the extension pack to uninstall.</desc>
18458	</param>
18459	<param name="forcedRemoval" type="boolean" dir="in">
18460	<desc>
18461	Forced removal of the extension pack. This means that the uninstall
18462	hook will not be called.
18463	</desc>
18464	</param>
18465	<param name="displayInfo" type="wstring" dir="in">
18466	<desc>
18467	Platform specific display information. Reserved for future hacks.
18468	</desc>
18469	</param>
18470	<param name="progess" type="IProgress" dir="return">
18471	<desc>
18472	Progress object for the operation.
18473	</desc>
18474	</param>
18475	</method>
18476
18477	<method name="cleanup">
18478	<desc>Cleans up failed installs and uninstalls</desc>
18479	</method>
18480
18481	<method name="queryAllPlugInsForFrontend">
18482	<desc>
18483	Gets the path to all the plug-in modules for a given frontend.
18484
18485	This is a convenience method that is intended to simplify the plug-in
18486	loading process for a frontend.
18487	</desc>
18488	<param name="frontendName" type="wstring" dir="in">
18489	<desc>The name of the frontend or component.</desc>
18490	</param>
18491	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
18492	<desc>Array containing the plug-in modules (full paths).</desc>
18493	</param>
18494	</method>
18495
18496	<method name="isExtPackUsable">
18497	<desc>Check if the given extension pack is loaded and usable.</desc>
18498	<param name="name" type="wstring" dir="in">
18499	<desc>The name of the extension pack to check for.</desc>
18500	</param>
18501	<param name="usable" type="boolean" dir="return">
18502	<desc>Is the given extension pack loaded and usable.</desc>
18503	</param>
18504	</method>
18505
18506	</interface>
18507
18508	<!--
18509	// BandwidthGroupType
18510	/////////////////////////////////////////////////////////////////////////
18511	-->
18512	<enum
18513	name="BandwidthGroupType"
18514	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
18515
18516	<desc>
18517	Type of a bandwidth control group.
18518	</desc>
18519
18520	<const name="Null" value="0">
18521	<desc>
18522	Null type, must be first.
18523	</desc>
18524	</const>
18525
18526	<const name="Disk" value="1">
18527	<desc>
18528	The bandwidth group controls disk I/O.
18529	</desc>
18530	</const>
18531
18532	<const name="Network" value="2">
18533	<desc>
18534	The bandwidth group controls network I/O.
18535	</desc>
18536	</const>
18537
18538	</enum>
18539
18540	<!--
18541	// IBandwidthGroup
18542	/////////////////////////////////////////////////////////////////////////
18543	-->
18544	<interface
18545	name="IBandwidthGroup" extends="$unknown"
18546	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
18547	wsmap="managed"
18548	>
18549	<desc>Represents one bandwidth group.</desc>
18550
18551	<attribute name="name" type="wstring" readonly="yes">
18552	<desc>Name of the group.</desc>
18553	</attribute>
18554
18555	<attribute name="type" type="BandwidthGroupType" readonly="yes">
18556	<desc>Type of the group.</desc>
18557	</attribute>
18558
18559	<attribute name="reference" type="unsigned long" readonly="yes">
18560	<desc>How many devices/medium attachements use this group.</desc>
18561	</attribute>
18562
18563	<attribute name="maxBytesPerSec" type="long long">
18564	<desc>The maximum number of bytes which can be transfered by all
18565	entities attached to this group during one second.</desc>
18566	</attribute>
18567
18568	</interface>
18569
18570	<!--
18571	// IBandwidthControl
18572	/////////////////////////////////////////////////////////////////////////
18573	-->
18574	<interface
18575	name="IBandwidthControl" extends="$unknown"
18576	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
18577	wsmap="managed"
18578	>
18579	<desc>
18580	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
18581	This includes network and disk I/O.
18582	</desc>
18583
18584	<attribute name="numGroups" type="unsigned long" readonly="yes">
18585	<desc>
18586	The current number of existing bandwidth groups managed.
18587	</desc>
18588	</attribute>
18589
18590	<method name="createBandwidthGroup">
18591	<desc>
18592	Creates a new bandwidth group.
18593	</desc>
18594
18595	<param name="name" type="wstring" dir="in">
18596	<desc>Name of the bandwidth group.</desc>
18597	</param>
18598	<param name="type" type="BandwidthGroupType" dir="in">
18599	<desc>The type of the bandwidth group (network or disk).</desc>
18600	</param>
18601	<param name="maxBytesPerSec" type="long long" dir="in">
18602	<desc>The maximum number of bytes which can be transfered by all
18603	entities attached to this group during one second.</desc>
18604	</param>
18605	</method>
18606
18607	<method name="deleteBandwidthGroup">
18608	<desc>
18609	Deletes a new bandwidth group.
18610	</desc>
18611
18612	<param name="name" type="wstring" dir="in">
18613	<desc>Name of the bandwidth group to delete.</desc>
18614	</param>
18615	</method>
18616
18617	<method name="getBandwidthGroup" const="yes">
18618	<desc>
18619	Get a bandwidth group by name.
18620	</desc>
18621
18622	<param name="name" type="wstring" dir="in">
18623	<desc>Name of the bandwidth group to get.</desc>
18624	</param>
18625	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
18626	<desc>Where to store the bandwidth group on success.</desc>
18627	</param>
18628	</method>
18629
18630	<method name="getAllBandwidthGroups" const="yes">
18631	<desc>
18632	Get all managed bandwidth groups.
18633	</desc>
18634
18635	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
18636	<desc>The array of managed bandwidth groups.</desc>
18637	</param>
18638	</method>
18639	</interface>
18640
18641	<!--
18642	// IVirtualBoxClient
18643	/////////////////////////////////////////////////////////////////////////
18644	-->
18645
18646	<interface
18647	name="IVirtualBoxClient" extends="$unknown"
18648	uuid="d191281f-b0cb-4d83-a8fa-0d9fd6ba234c"
18649	wsmap="suppress"
18650	>
18651	<desc>
18652	Convenience interface for client applications. Treat this as a
18653	singleton, i.e. never create more than one instance of this interface.
18654
18655	At the moment only available for clients of the local API (not usable
18656	via the webservice). Once the session logic is redesigned this might
18657	change.
18658	</desc>
18659
18660	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
18661	<desc>
18662	Reference to the server-side API root object.
18663	</desc>
18664	</attribute>
18665
18666	<attribute name="session" type="ISession" readonly="yes">
18667	<desc>
18668	Create a new session object and return the reference to it.
18669	</desc>
18670	</attribute>
18671
18672	<attribute name="eventSource" type="IEventSource" readonly="yes">
18673	<desc>
18674	Event source for VirtualBoxClient events.
18675	</desc>
18676	</attribute>
18677
18678	<method name="checkMachineError">
18679	<desc>
18680	Perform error checking before using an <link to="IMachine"/> object.
18681	Generally useful before starting a VM and all other uses. If anything
18682	is not as it should be then this method will return an appropriate
18683	error.
18684	</desc>
18685
18686	<param name="machine" type="IMachine" dir="in">
18687	<desc>The machine object to check.</desc>
18688	</param>
18689	</method>
18690	</interface>
18691
18692	<!--
18693	// Events
18694	/////////////////////////////////////////////////////////////////////////
18695	-->
18696	<enum
18697	name="VBoxEventType"
18698	uuid="83c03e4b-ffe5-421c-a0fb-0b27b2d56753"
18699	>
18700
18701	<desc>
18702	Type of an event.
18703	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18704	</desc>
18705
18706	<const name="Invalid" value="0">
18707	<desc>
18708	Invalid event, must be first.
18709	</desc>
18710	</const>
18711
18712	<const name="Any" value="1">
18713	<desc>
18714	Wildcard for all events.
18715	Events of this type are never delivered, and only used in
18716	<link to="IEventSource::registerListener"/> call to simplify registration.
18717	</desc>
18718	</const>
18719
18720	<const name="Vetoable" value="2">
18721	<desc>
18722	Wildcard for all vetoable events. Events of this type are never delivered, and only
18723	used in <link to="IEventSource::registerListener"/> call to simplify registration.
18724	</desc>
18725	</const>
18726
18727	<const name="MachineEvent" value="3">
18728	<desc>
18729	Wildcard for all machine events. Events of this type are never delivered, and only used in
18730	<link to="IEventSource::registerListener"/> call to simplify registration.
18731	</desc>
18732	</const>
18733
18734	<const name="SnapshotEvent" value="4">
18735	<desc>
18736	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
18737	<link to="IEventSource::registerListener"/> call to simplify registration.
18738	</desc>
18739	</const>
18740
18741	<const name="InputEvent" value="5">
18742	<desc>
18743	Wildcard for all input device (keyboard, mouse) events.
18744	Events of this type are never delivered, and only used in
18745	<link to="IEventSource::registerListener"/> call to simplify registration.
18746	</desc>
18747	</const>
18748
18749	<const name="LastWildcard" value="31">
18750	<desc>
18751	Last wildcard.
18752	</desc>
18753	</const>
18754
18755	<const name="OnMachineStateChanged" value="32">
18756	<desc>
18757	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
18758	</desc>
18759	</const>
18760	<const name="OnMachineDataChanged" value="33">
18761	<desc>
18762	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
18763	</desc>
18764	</const>
18765	<const name="OnExtraDataChanged" value="34">
18766	<desc>
18767	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
18768	</desc>
18769	</const>
18770	<const name="OnExtraDataCanChange" value="35">
18771	<desc>
18772	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
18773	</desc>
18774	</const>
18775	<const name="OnMediumRegistered" value="36">
18776	<desc>
18777	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
18778	</desc>
18779	</const>
18780	<const name="OnMachineRegistered" value="37">
18781	<desc>
18782	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
18783	</desc>
18784	</const>
18785	<const name="OnSessionStateChanged" value="38">
18786	<desc>
18787	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
18788	</desc>
18789	</const>
18790	<const name="OnSnapshotTaken" value="39">
18791	<desc>
18792	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
18793	</desc>
18794	</const>
18795	<const name="OnSnapshotDeleted" value="40">
18796	<desc>
18797	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
18798	</desc>
18799	</const>
18800	<const name="OnSnapshotChanged" value="41">
18801	<desc>
18802	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
18803	</desc>
18804	</const>
18805	<const name="OnGuestPropertyChanged" value="42">
18806	<desc>
18807	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
18808	</desc>
18809	</const>
18810	<!-- Console events -->
18811	<const name="OnMousePointerShapeChanged" value="43">
18812	<desc>
18813	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
18814	</desc>
18815	</const>
18816	<const name="OnMouseCapabilityChanged" value="44">
18817	<desc>
18818	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
18819	</desc>
18820	</const>
18821	<const name="OnKeyboardLedsChanged" value="45">
18822	<desc>
18823	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
18824	</desc>
18825	</const>
18826	<const name="OnStateChanged" value="46">
18827	<desc>
18828	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
18829	</desc>
18830	</const>
18831	<const name="OnAdditionsStateChanged" value="47">
18832	<desc>
18833	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
18834	</desc>
18835	</const>
18836	<const name="OnNetworkAdapterChanged" value="48">
18837	<desc>
18838	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
18839	</desc>
18840	</const>
18841	<const name="OnSerialPortChanged" value="49">
18842	<desc>
18843	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
18844	</desc>
18845	</const>
18846	<const name="OnParallelPortChanged" value="50">
18847	<desc>
18848	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
18849	</desc>
18850	</const>
18851	<const name="OnStorageControllerChanged" value="51">
18852	<desc>
18853	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
18854	</desc>
18855	</const>
18856	<const name="OnMediumChanged" value="52">
18857	<desc>
18858	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
18859	</desc>
18860	</const>
18861	<const name="OnVRDEServerChanged" value="53">
18862	<desc>
18863	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
18864	</desc>
18865	</const>
18866	<const name="OnUSBControllerChanged" value="54">
18867	<desc>
18868	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
18869	</desc>
18870	</const>
18871	<const name="OnUSBDeviceStateChanged" value="55">
18872	<desc>
18873	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
18874	</desc>
18875	</const>
18876	<const name="OnSharedFolderChanged" value="56">
18877	<desc>
18878	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
18879	</desc>
18880	</const>
18881	<const name="OnRuntimeError" value="57">
18882	<desc>
18883	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
18884	</desc>
18885	</const>
18886	<const name="OnCanShowWindow" value="58">
18887	<desc>
18888	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
18889	</desc>
18890	</const>
18891	<const name="OnShowWindow" value="59">
18892	<desc>
18893	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
18894	</desc>
18895	</const>
18896	<const name="OnCPUChanged" value="60">
18897	<desc>
18898	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
18899	</desc>
18900	</const>
18901	<const name="OnVRDEServerInfoChanged" value="61">
18902	<desc>
18903	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
18904	</desc>
18905	</const>
18906	<const name="OnEventSourceChanged" value="62">
18907	<desc>
18908	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
18909	</desc>
18910	</const>
18911	<const name="OnCPUExecutionCapChanged" value="63">
18912	<desc>
18913	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
18914	</desc>
18915	</const>
18916	<const name="OnGuestKeyboard" value="64">
18917	<desc>
18918	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
18919	</desc>
18920	</const>
18921	<const name="OnGuestMouse" value="65">
18922	<desc>
18923	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
18924	</desc>
18925	</const>
18926	<const name="OnNATRedirect" value="66">
18927	<desc>
18928	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
18929	</desc>
18930	</const>
18931	<const name="OnHostPCIDevicePlug" value="67">
18932	<desc>
18933	See <link to="IHostPCIDevicePlugEvent">IHostPCIDevicePlugEvent</link>.
18934	</desc>
18935	</const>
18936	<const name="OnVBoxSVCAvailabilityChanged" value="68">
18937	<desc>
18938	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
18939	</desc>
18940	</const>
18941	<const name="OnBandwidthGroupChanged" value="69">
18942	<desc>
18943	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
18944	</desc>
18945	</const>
18946	<const name="OnGuestMonitorChanged" value="70">
18947	<desc>
18948	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
18949	</desc>
18950	</const>
18951	<const name="OnStorageDeviceChanged" value="71">
18952	<desc>
18953	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
18954	</desc>
18955	</const>
18956	<const name="OnClipboardModeChanged" value="72">
18957	<desc>
18958	See <link to="IClipboardModeChangedEvent">IClipboardModeChangedEvent</link>.
18959	</desc>
18960	</const>
18961	<const name="OnDragAndDropModeChanged" value="73">
18962	<desc>
18963	See <link to="IDragAndDropModeChangedEvent">IDragAndDropModeChangedEvent</link>.
18964	</desc>
18965	</const>
18966	<const name="OnNATNetworkChanged" value="74">
18967	<desc>
18968	See <link to="INATNetworkChangedEvent">INATNetworkChangedEvent</link>.
18969	</desc>
18970	</const>
18971	<const name="OnNATNetworkStartStop" value="75">
18972	<desc>
18973	See <link to="INATNetworkStartStopEvent">INATNetworkStartStopEvent</link>.
18974	</desc>
18975	</const>
18976	<const name="OnNATNetworkAlter" value="76">
18977	<desc>
18978	See <link to="INATNetworkAlterEvent">INATNetworkAlterEvent</link>.
18979	</desc>
18980	</const>
18981	<const name="OnNATNetworkCreationDeletion" value="77">
18982	<desc>
18983	See <link to="INATNetworkCreationDeletionEvent">INATNetworkCreationDeletionEvent</link>.
18984	</desc>
18985	</const>
18986	<const name="OnNATNetworkSetting" value="78">
18987	<desc>
18988	See <link to="INATNetworkSettingEvent">INATNetworkSettingEvent</link>.
18989	</desc>
18990	</const>
18991	<const name="OnNATNetworkPortForward" value="79">
18992	<desc>
18993	See <link to="INATNetworkPortForwardEvent">INATNetworkPortForwardEvent</link>.
18994	</desc>
18995	</const>
18996	<const name="OnGuestSessionStateChanged" value="80">
18997	<desc>
18998	TODO
18999	</desc>
19000	</const>
19001	<const name="OnGuestSessionRegistered" value="81">
19002	<desc>
19003	TODO
19004	</desc>
19005	</const>
19006	<const name="OnGuestProcessRegistered" value="82">
19007	<desc>
19008	TODO
19009	</desc>
19010	</const>
19011	<const name="OnGuestProcessStateChanged" value="83">
19012	<desc>
19013	TODO
19014	</desc>
19015	</const>
19016	<const name="OnGuestProcessInputNotify" value="84">
19017	<desc>
19018	TODO
19019	</desc>
19020	</const>
19021	<const name="OnGuestProcessOutput" value="85">
19022	<desc>
19023	TODO
19024	</desc>
19025	</const>
19026	<const name="OnGuestFileStateChanged" value="86">
19027	<desc>
19028	TODO
19029	</desc>
19030	</const>
19031	<const name="OnGuestFileOffsetChanged" value="87">
19032	<desc>
19033	TODO
19034	</desc>
19035	</const>
19036	<const name="OnGuestFileRead" value="88">
19037	<desc>
19038	For performance reasons ... TODO
19039	</desc>
19040	</const>
19041	<const name="OnGuestFileWrite" value="89">
19042	<desc>
19043	For performance reasons ... TODO
19044	</desc>
19045	</const>
19046	<!-- Last event marker -->
19047	<const name="Last" value="90">
19048	<desc>
19049	Must be last event, used for iterations and structures relying on numerical event values.
19050	</desc>
19051	</const>
19052
19053	</enum>
19054
19055	<interface
19056	name="IEventSource" extends="$unknown"
19057	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
19058	wsmap="managed"
19059	>
19060	<desc>
19061	Event source. Generally, any object which could generate events can be an event source,
19062	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
19063	an event source can work with listeners in either active or passive mode. In active mode it is up to
19064	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
19065	event source keeps track of pending events for each listener and returns available events on demand.
19066
19067	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
19068	</desc>
19069
19070	<method name="createListener">
19071	<desc>
19072	Creates a new listener object, useful for passive mode.
19073	</desc>
19074	<param name="listener" type="IEventListener" dir="return"/>
19075	</method>
19076
19077	<method name="createAggregator">
19078	<desc>
19079	Creates an aggregator event source, collecting events from multiple sources.
19080	This way a single listener can listen for events coming from multiple sources,
19081	using a single blocking <link to="#getEvent"/> on the returned aggregator.
19082	</desc>
19083	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
19084	<desc>
19085	Subordinate event source this one aggregatres.
19086	</desc>
19087	</param>
19088	<param name="result" type="IEventSource" dir="return">
19089	<desc>
19090	Event source aggregating passed sources.
19091	</desc>
19092	</param>
19093	</method>
19094
19095	<method name="registerListener">
19096	<desc>
19097	Register an event listener.
19098
19099	<note>
19100	To avoid system overload, the VirtualBox server process checks if passive event
19101	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
19102	current implementation, if more than 500 pending events are detected for a passive
19103	event listener, it is forcefully unregistered by the system, and further
19104	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
19105	</note>
19106	</desc>
19107	<param name="listener" type="IEventListener" dir="in">
19108	<desc>Listener to register.</desc>
19109	</param>
19110	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
19111	<desc>
19112	Event types listener is interested in. One can use wildcards like -
19113	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
19114	than one event.
19115	</desc>
19116	</param>
19117	<param name="active" type="boolean" dir="in">
19118	<desc>
19119	Which mode this listener is operating in.
19120	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
19121	In passive mode, an internal event queue is created for this this IEventListener.
19122	For each event coming in, it is added to queues for all interested registered passive
19123	listeners. It is then up to the external code to call the listener's
19124	<link to="IEventListener::handleEvent" /> method. When done with an event, the
19125	external code must call <link to="#eventProcessed" />.
19126	</desc>
19127	</param>
19128	</method>
19129
19130	<method name="unregisterListener">
19131	<desc>
19132	Unregister an event listener. If listener is passive, and some waitable events are still
19133	in queue they are marked as processed automatically.
19134	</desc>
19135	<param name="listener" type="IEventListener" dir="in">
19136	<desc>Listener to unregister.</desc>
19137	</param>
19138	</method>
19139
19140	<method name="fireEvent">
19141	<desc>
19142	Fire an event for this source.
19143	</desc>
19144	<param name="event" type="IEvent" dir="in">
19145	<desc>Event to deliver.</desc>
19146	</param>
19147	<param name="timeout" type="long" dir="in">
19148	<desc>
19149	Maximum time to wait for event processing (if event is waitable), in ms;
19150	0 = no wait, -1 = indefinite wait.
19151	</desc>
19152	</param>
19153	<param name="result" type="boolean" dir="return">
19154	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
19155	</param>
19156	</method>
19157
19158	<method name="getEvent">
19159	<desc>
19160	Get events from this peer's event queue (for passive mode). Calling this method
19161	regularly is required for passive event listeners to avoid system overload;
19162	see <link to="IEventSource::registerListener" /> for details.
19163
19164	<result name="VBOX_E_OBJECT_NOT_FOUND">
19165	Listener is not registered, or autounregistered.
19166	</result>
19167	</desc>
19168	<param name="listener" type="IEventListener" dir="in">
19169	<desc>Which listener to get data for.</desc>
19170	</param>
19171	<param name="timeout" type="long" dir="in">
19172	<desc>
19173	Maximum time to wait for events, in ms;
19174	0 = no wait, -1 = indefinite wait.
19175	</desc>
19176	</param>
19177	<param name="event" type="IEvent" dir="return">
19178	<desc>Event retrieved, or null if none available.</desc>
19179	</param>
19180	</method>
19181
19182	<method name="eventProcessed">
19183	<desc>
19184	Must be called for waitable events after a particular listener finished its
19185	event processing. When all listeners of a particular event have called this
19186	method, the system will then call <link to="IEvent::setProcessed" />.
19187	</desc>
19188	<param name="listener" type="IEventListener" dir="in">
19189	<desc>Which listener processed event.</desc>
19190	</param>
19191	<param name="event" type="IEvent" dir="in">
19192	<desc>Which event.</desc>
19193	</param>
19194	</method>
19195
19196	</interface>
19197
19198	<interface
19199	name="IEventListener" extends="$unknown"
19200	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
19201	wsmap="managed"
19202	>
19203	<desc>
19204	Event listener. An event listener can work in either active or passive mode, depending on the way
19205	it was registered.
19206	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
19207	</desc>
19208
19209	<method name="handleEvent">
19210	<desc>
19211	Handle event callback for active listeners. It is not called for
19212	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
19213	and having received acknowledgement from all passive listeners via
19214	<link to="IEventSource::eventProcessed"/>, the event is marked as
19215	processed and <link to="IEvent::waitProcessed"/> will return
19216	immediately.
19217	</desc>
19218	<param name="event" type="IEvent" dir="in">
19219	<desc>Event available.</desc>
19220	</param>
19221	</method>
19222
19223	</interface>
19224
19225	<interface
19226	name="IEvent" extends="$unknown"
19227	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
19228	wsmap="managed"
19229	>
19230	<desc>
19231	Abstract parent interface for VirtualBox events. Actual events will typically implement
19232	a more specific interface which derives from this (see below).
19233
19234	<b>Introduction to VirtualBox events</b>
19235
19236	Generally speaking, an event (represented by this interface) signals that something
19237	happened, while an event listener (see <link to="IEventListener" />) represents an
19238	entity that is interested in certain events. In order for this to work with
19239	unidirectional protocols (i.e. web services), the concepts of passive and active
19240	listener are used.
19241
19242	Event consumers can register themselves as listeners, providing an array of
19243	events they are interested in (see <link to="IEventSource::registerListener" />).
19244	When an event triggers, the listener is notified about the event. The exact
19245	mechanism of the notification depends on whether the listener was registered as
19246	an active or passive listener:
19247
19248	<ul>
19249	<li>An active listener is very similar to a callback: it is a function invoked
19250	by the API. As opposed to the callbacks that were used in the API before
19251	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
19252	</li>
19253
19254	<li>Passive listeners are somewhat trickier to implement, but do not require
19255	a client function to be callable, which is not an option with scripting
19256	languages or web service clients. Internally the <link to="IEventSource" />
19257	implementation maintains an event queue for each passive listener, and
19258	newly arrived events are put in this queue. When the listener calls
19259	<link to="IEventSource::getEvent"/>, first element from its internal event
19260	queue is returned. When the client completes processing of an event,
19261	the <link to="IEventSource::eventProcessed" /> function must be called,
19262	acknowledging that the event was processed. It supports implementing
19263	waitable events. On passive listener unregistration, all events from its
19264	queue are auto-acknowledged.
19265	</li>
19266	</ul>
19267
19268	Waitable events are useful in situations where the event generator wants to track
19269	delivery or a party wants to wait until all listeners have completed the event. A
19270	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
19271	listeners might veto a certain action, and thus the event producer has to make
19272	sure that all listeners have processed the event and not vetoed before taking
19273	the action.
19274
19275	A given event may have both passive and active listeners at the same time.
19276
19277	<b>Using events</b>
19278
19279	Any VirtualBox object capable of producing externally visible events provides an
19280	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
19281	This event source object is notified by VirtualBox once something has happened, so
19282	consumers may register event listeners with this event source. To register a listener,
19283	an object implementing the <link to="IEventListener" /> interface must be provided.
19284	For active listeners, such an object is typically created by the consumer, while for
19285	passive listeners <link to="IEventSource::createListener" /> should be used. Please
19286	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
19287
19288	Once created, the listener must be registered to listen for the desired events
19289	(see <link to="IEventSource::registerListener" />), providing an array of
19290	<link to="VBoxEventType" /> enums. Those elements can either be the individual
19291	event IDs or wildcards matching multiple event IDs.
19292
19293	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
19294	called automatically when the event is triggered, while passive listeners have to call
19295	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
19296	an event processing loop.
19297
19298	The IEvent interface is an abstract parent interface for all such VirtualBox events
19299	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
19300	or the event processing loop is to check the <link to="#type" /> attribute of the event and
19301	then cast to the appropriate specific interface using @c QueryInterface().
19302	</desc>
19303
19304	<attribute name="type" readonly="yes" type="VBoxEventType">
19305	<desc>
19306	Event type.
19307	</desc>
19308	</attribute>
19309
19310	<attribute name="source" readonly="yes" type="IEventSource">
19311	<desc>
19312	Source of this event.
19313	</desc>
19314	</attribute>
19315
19316	<attribute name="waitable" readonly="yes" type="boolean">
19317	<desc>
19318	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
19319	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
19320	as no additional overhead associated with waitability imposed.
19321	Waitable events are needed when one need to be able to wait for particular event processed,
19322	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
19323	until all consumers confirmed events.
19324	</desc>
19325	</attribute>
19326
19327	<method name="setProcessed">
19328	<desc>
19329	Internal method called by the system when all listeners of a particular event have called
19330	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
19331	</desc>
19332	</method>
19333
19334	<method name="waitProcessed">
19335	<desc>
19336	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
19337	described semantics, for non-waitable returns true immediately.
19338	</desc>
19339	<param name="timeout" type="long" dir="in">
19340	<desc>
19341	Maximum time to wait for event processeing, in ms;
19342	0 = no wait, -1 = indefinite wait.
19343	</desc>
19344	</param>
19345	<param name="result" type="boolean" dir="return">
19346	<desc>If this event was processed before timeout.</desc>
19347	</param>
19348	</method>
19349	</interface>
19350
19351
19352	<interface
19353	name="IReusableEvent" extends="IEvent"
19354	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
19355	wsmap="managed"
19356	>
19357	<desc>Base abstract interface for all reusable events.</desc>
19358
19359	<attribute name="generation" readonly="yes" type="unsigned long">
19360	<desc>Current generation of event, incremented on reuse.</desc>
19361	</attribute>
19362
19363	<method name="reuse">
19364	<desc>
19365	Marks an event as reused, increments 'generation', fields shall no
19366	longer be considered valid.
19367	</desc>
19368	</method>
19369	</interface>
19370
19371	<interface
19372	name="IMachineEvent" extends="IEvent"
19373	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
19374	wsmap="managed" id="MachineEvent"
19375	>
19376	<desc>Base abstract interface for all machine events.</desc>
19377
19378	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
19379	<desc>ID of the machine this event relates to.</desc>
19380	</attribute>
19381
19382	</interface>
19383
19384	<interface
19385	name="IMachineStateChangedEvent" extends="IMachineEvent"
19386	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
19387	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
19388	>
19389	<desc>Machine state change event.</desc>
19390
19391	<attribute name="state" readonly="yes" type="MachineState">
19392	<desc>New execution state.</desc>
19393	</attribute>
19394	</interface>
19395
19396	<interface
19397	name="IMachineDataChangedEvent" extends="IMachineEvent"
19398	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
19399	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
19400	>
19401	<desc>
19402	Any of the settings of the given machine has changed.
19403	</desc>
19404
19405	<attribute name="temporary" readonly="yes" type="boolean">
19406	<desc>@c true if the settings change is temporary. All permanent
19407	settings changes will trigger an event, and only temporary settings
19408	changes for running VMs will trigger an event. Note: sending events
19409	for temporary changes is NOT IMPLEMENTED.</desc>
19410	</attribute>
19411	</interface>
19412
19413	<interface
19414	name="IMediumRegisteredEvent" extends="IEvent"
19415	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
19416	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
19417	>
19418	<desc>
19419	The given medium was registered or unregistered
19420	within this VirtualBox installation.
19421	</desc>
19422
19423	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
19424	<desc>ID of the medium this event relates to.</desc>
19425	</attribute>
19426
19427	<attribute name="mediumType" readonly="yes" type="DeviceType">
19428	<desc>Type of the medium this event relates to.</desc>
19429	</attribute>
19430
19431	<attribute name="registered" type="boolean" readonly="yes">
19432	<desc>
19433	If @c true, the medium was registered, otherwise it was
19434	unregistered.
19435	</desc>
19436	</attribute>
19437	</interface>
19438
19439	<interface
19440	name="IMachineRegisteredEvent" extends="IMachineEvent"
19441	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
19442	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
19443	>
19444	<desc>
19445	The given machine was registered or unregistered
19446	within this VirtualBox installation.
19447	</desc>
19448
19449	<attribute name="registered" type="boolean" readonly="yes">
19450	<desc>
19451	If @c true, the machine was registered, otherwise it was
19452	unregistered.
19453	</desc>
19454	</attribute>
19455	</interface>
19456
19457	<interface
19458	name="ISessionStateChangedEvent" extends="IMachineEvent"
19459	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
19460	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
19461	>
19462	<desc>
19463	The state of the session for the given machine was changed.
19464	<see><link to="IMachine::sessionState"/></see>
19465	</desc>
19466
19467	<attribute name="state" type="SessionState" readonly="yes">
19468	<desc>
19469	New session state.
19470	</desc>
19471	</attribute>
19472	</interface>
19473
19474	<interface
19475	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
19476	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
19477	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
19478	>
19479	<desc>
19480	Notification when a guest property has changed.
19481	</desc>
19482
19483	<attribute name="name" readonly="yes" type="wstring">
19484	<desc>
19485	The name of the property that has changed.
19486	</desc>
19487	</attribute>
19488
19489	<attribute name="value" readonly="yes" type="wstring">
19490	<desc>
19491	The new property value.
19492	</desc>
19493	</attribute>
19494
19495	<attribute name="flags" readonly="yes" type="wstring">
19496	<desc>
19497	The new property flags.
19498	</desc>
19499	</attribute>
19500
19501	</interface>
19502
19503	<interface
19504	name="ISnapshotEvent" extends="IMachineEvent"
19505	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
19506	wsmap="managed" id="SnapshotEvent"
19507	>
19508	<desc>Base interface for all snapshot events.</desc>
19509
19510	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
19511	<desc>ID of the snapshot this event relates to.</desc>
19512	</attribute>
19513
19514	</interface>
19515
19516	<interface
19517	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
19518	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
19519	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
19520	>
19521	<desc>
19522	A new snapshot of the machine has been taken.
19523	<see><link to="ISnapshot"/></see>
19524	</desc>
19525	</interface>
19526
19527	<interface
19528	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
19529	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
19530	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
19531	>
19532	<desc>
19533	Snapshot of the given machine has been deleted.
19534
19535	<note>
19536	This notification is delivered <b>after</b> the snapshot
19537	object has been uninitialized on the server (so that any
19538	attempt to call its methods will return an error).
19539	</note>
19540
19541	<see><link to="ISnapshot"/></see>
19542	</desc>
19543	</interface>
19544
19545	<interface
19546	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
19547	uuid="07541941-8079-447a-a33e-47a69c7980db"
19548	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
19549	>
19550	<desc>
19551	Snapshot properties (name and/or description) have been changed.
19552	<see><link to="ISnapshot"/></see>
19553	</desc>
19554	</interface>
19555
19556	<interface
19557	name="IMousePointerShapeChangedEvent" extends="IEvent"
19558	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
19559	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
19560	>
19561	<desc>
19562	Notification when the guest mouse pointer shape has
19563	changed. The new shape data is given.
19564	</desc>
19565
19566	<attribute name="visible" type="boolean" readonly="yes">
19567	<desc>
19568	Flag whether the pointer is visible.
19569	</desc>
19570	</attribute>
19571	<attribute name="alpha" type="boolean" readonly="yes">
19572	<desc>
19573	Flag whether the pointer has an alpha channel.
19574	</desc>
19575	</attribute>
19576	<attribute name="xhot" type="unsigned long" readonly="yes">
19577	<desc>
19578	The pointer hot spot X coordinate.
19579	</desc>
19580	</attribute>
19581	<attribute name="yhot" type="unsigned long" readonly="yes">
19582	<desc>
19583	The pointer hot spot Y coordinate.
19584	</desc>
19585	</attribute>
19586	<attribute name="width" type="unsigned long" readonly="yes">
19587	<desc>
19588	Width of the pointer shape in pixels.
19589	</desc>
19590	</attribute>
19591	<attribute name="height" type="unsigned long" readonly="yes">
19592	<desc>
19593	Height of the pointer shape in pixels.
19594	</desc>
19595	</attribute>
19596	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
19597	<desc>
19598	Shape buffer arrays.
19599
19600	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
19601	followed by a 32-bpp XOR (color) mask.
19602
19603	For pointers without alpha channel the XOR mask pixels are 32
19604	bit values: (lsb)BGR0(msb). For pointers with alpha channel
19605	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
19606
19607	An AND mask is used for pointers with alpha channel, so if the
19608	callback does not support alpha, the pointer could be
19609	displayed as a normal color pointer.
19610
19611	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
19612	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
19613	height</tt>. The padding bits at the end of each scanline are
19614	undefined.
19615
19616	The XOR mask follows the AND mask on the next 4-byte aligned
19617	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
19618	Bytes in the gap between the AND and the XOR mask are undefined.
19619	The XOR mask scanlines have no gap between them and the size of
19620	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
19621
19622	<note>
19623	If @a shape is 0, only the pointer visibility is changed.
19624	</note>
19625	</desc>
19626	</attribute>
19627	</interface>
19628
19629	<interface
19630	name="IMouseCapabilityChangedEvent" extends="IEvent"
19631	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
19632	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
19633	>
19634	<desc>
19635	Notification when the mouse capabilities reported by the
19636	guest have changed. The new capabilities are passed.
19637	</desc>
19638	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
19639	<desc>
19640	Supports absolute coordinates.
19641	</desc>
19642	</attribute>
19643	<attribute name="supportsRelative" type="boolean" readonly="yes">
19644	<desc>
19645	Supports relative coordinates.
19646	</desc>
19647	</attribute>
19648	<attribute name="needsHostCursor" type="boolean" readonly="yes">
19649	<desc>
19650	If host cursor is needed.
19651	</desc>
19652	</attribute>
19653	</interface>
19654
19655	<interface
19656	name="IKeyboardLedsChangedEvent" extends="IEvent"
19657	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
19658	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
19659	>
19660	<desc>
19661	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
19662	to alter the state of the keyboard LEDs.
19663	</desc>
19664	<attribute name="numLock" type="boolean" readonly="yes">
19665	<desc>
19666	NumLock status.
19667	</desc>
19668	</attribute>
19669	<attribute name="capsLock" type="boolean" readonly="yes">
19670	<desc>
19671	CapsLock status.
19672	</desc>
19673	</attribute>
19674	<attribute name="scrollLock" type="boolean" readonly="yes">
19675	<desc>
19676	ScrollLock status.
19677	</desc>
19678	</attribute>
19679	</interface>
19680
19681	<interface
19682	name="IStateChangedEvent" extends="IEvent"
19683	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
19684	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
19685	>
19686	<desc>
19687	Notification when the execution state of the machine has changed.
19688	The new state is given.
19689	</desc>
19690	<attribute name="state" type="MachineState" readonly="yes">
19691	<desc>
19692	New machine state.
19693	</desc>
19694	</attribute>
19695	</interface>
19696
19697	<interface
19698	name="IAdditionsStateChangedEvent" extends="IEvent"
19699	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
19700	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
19701	>
19702	<desc>
19703	Notification when a Guest Additions property changes.
19704	Interested callees should query IGuest attributes to
19705	find out what has changed.
19706	</desc>
19707	</interface>
19708
19709	<interface
19710	name="INetworkAdapterChangedEvent" extends="IEvent"
19711	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
19712	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
19713	>
19714	<desc>
19715	Notification when a property of one of the
19716	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
19717	changes. Interested callees should use INetworkAdapter methods and
19718	attributes to find out what has changed.
19719	</desc>
19720	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
19721	<desc>
19722	Network adapter that is subject to change.
19723	</desc>
19724	</attribute>
19725	</interface>
19726
19727	<interface
19728	name="ISerialPortChangedEvent" extends="IEvent"
19729	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
19730	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
19731	>
19732	<desc>
19733	Notification when a property of one of the
19734	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
19735	Interested callees should use ISerialPort methods and attributes
19736	to find out what has changed.
19737	</desc>
19738	<attribute name="serialPort" type="ISerialPort" readonly="yes">
19739	<desc>
19740	Serial port that is subject to change.
19741	</desc>
19742	</attribute>
19743	</interface>
19744
19745	<interface
19746	name="IParallelPortChangedEvent" extends="IEvent"
19747	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
19748	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
19749	>
19750	<desc>
19751	Notification when a property of one of the
19752	virtual <link to="IMachine::getParallelPort">parallel ports</link>
19753	changes. Interested callees should use ISerialPort methods and
19754	attributes to find out what has changed.
19755	</desc>
19756	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
19757	<desc>
19758	Parallel port that is subject to change.
19759	</desc>
19760	</attribute>
19761	</interface>
19762
19763	<interface
19764	name="IStorageControllerChangedEvent" extends="IEvent"
19765	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
19766	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
19767	>
19768	<desc>
19769	Notification when a
19770	<link to="IMachine::mediumAttachments">medium attachment</link>
19771	changes.
19772	</desc>
19773	</interface>
19774
19775	<interface
19776	name="IMediumChangedEvent" extends="IEvent"
19777	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
19778	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
19779	>
19780	<desc>
19781	Notification when a
19782	<link to="IMachine::mediumAttachments">medium attachment</link>
19783	changes.
19784	</desc>
19785	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
19786	<desc>
19787	Medium attachment that is subject to change.
19788	</desc>
19789	</attribute>
19790	</interface>
19791
19792	<interface
19793	name="IClipboardModeChangedEvent" extends="IEvent"
19794	uuid="cac21692-7997-4595-a731-3a509db604e5"
19795	wsmap="managed" autogen="VBoxEvent" id="OnClipboardModeChanged"
19796	>
19797	<desc>
19798	Notification when the shared clipboard mode changes.
19799	</desc>
19800	<attribute name="clipboardMode" type="ClipboardMode" readonly="yes">
19801	<desc>
19802	The new clipboard mode.
19803	</desc>
19804	</attribute>
19805	</interface>
19806
19807	<interface
19808	name="IDragAndDropModeChangedEvent" extends="IEvent"
19809	uuid="e90b8850-ac8e-4dff-8059-4100ae2c3c3d"
19810	wsmap="managed" autogen="VBoxEvent" id="OnDragAndDropModeChanged"
19811	>
19812	<desc>
19813	Notification when the drag'n'drop mode changes.
19814	</desc>
19815	<attribute name="dragAndDropMode" type="DragAndDropMode" readonly="yes">
19816	<desc>
19817	The new drag'n'drop mode.
19818	</desc>
19819	</attribute>
19820	</interface>
19821
19822	<interface
19823	name="ICPUChangedEvent" extends="IEvent"
19824	uuid="4da2dec7-71b2-4817-9a64-4ed12c17388e"
19825	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
19826	>
19827	<desc>
19828	Notification when a CPU changes.
19829	</desc>
19830	<attribute name="CPU" type="unsigned long" readonly="yes">
19831	<desc>
19832	The CPU which changed.
19833	</desc>
19834	</attribute>
19835	<attribute name="add" type="boolean" readonly="yes">
19836	<desc>
19837	Flag whether the CPU was added or removed.
19838	</desc>
19839	</attribute>
19840	</interface>
19841
19842	<interface
19843	name="ICPUExecutionCapChangedEvent" extends="IEvent"
19844	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
19845	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
19846	>
19847	<desc>
19848	Notification when the CPU execution cap changes.
19849	</desc>
19850	<attribute name="executionCap" type="unsigned long" readonly="yes">
19851	<desc>
19852	The new CPU execution cap value. (1-100)
19853	</desc>
19854	</attribute>
19855	</interface>
19856
19857	<interface
19858	name="IGuestKeyboardEvent" extends="IEvent"
19859	uuid="88394258-7006-40d4-b339-472ee3801844"
19860	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
19861	>
19862	<desc>
19863	Notification when guest keyboard event happens.
19864	</desc>
19865	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
19866	<desc>
19867	Array of scancodes.
19868	</desc>
19869	</attribute>
19870	</interface>
19871
19872	<interface
19873	name="IGuestMouseEvent" extends="IReusableEvent"
19874	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
19875	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
19876	>
19877	<desc>
19878	Notification when guest mouse event happens.
19879	</desc>
19880
19881	<attribute name="absolute" type="boolean" readonly="yes">
19882	<desc>
19883	If this event is relative or absolute.
19884	</desc>
19885	</attribute>
19886
19887	<attribute name="x" type="long" readonly="yes">
19888	<desc>
19889	New X position, or X delta.
19890	</desc>
19891	</attribute>
19892
19893	<attribute name="y" type="long" readonly="yes">
19894	<desc>
19895	New Y position, or Y delta.
19896	</desc>
19897	</attribute>
19898
19899	<attribute name="z" type="long" readonly="yes">
19900	<desc>
19901	Z delta.
19902	</desc>
19903	</attribute>
19904
19905	<attribute name="w" type="long" readonly="yes">
19906	<desc>
19907	W delta.
19908	</desc>
19909	</attribute>
19910
19911	<attribute name="buttons" type="long" readonly="yes">
19912	<desc>
19913	Button state bitmask.
19914	</desc>
19915	</attribute>
19916
19917	</interface>
19918
19919	<interface
19920	name="IGuestSessionEvent" extends="IEvent"
19921	uuid="b9acd33f-647d-45ac-8fe9-f49b3183ba37"
19922	wsmap="managed" id="GuestSessionEvent"
19923	>
19924	<desc>Base abstract interface for all guest session events.</desc>
19925
19926	<attribute name="session" type="IGuestSession" readonly="yes">
19927	<desc>Guest session that is subject to change.</desc>
19928	</attribute>
19929
19930	</interface>
19931
19932	<interface
19933	name="IGuestSessionStateChangedEvent" extends="IGuestSessionEvent"
19934	uuid="9c288479-6564-451d-9574-7e7ac0b7e443"
19935	wsmap="managed" autogen="VBoxEvent" id="OnGuestSessionStateChanged"
19936	>
19937	<desc>
19938	TODO
19939	</desc>
19940
19941	<attribute name="id" type="unsigned long" readonly="yes">
19942	<desc>
19943	TODO
19944	</desc>
19945	</attribute>
19946	<attribute name="status" type="GuestSessionStatus" readonly="yes">
19947	<desc>
19948	TODO
19949	</desc>
19950	</attribute>
19951	<attribute name="error" type="IGuestErrorInfo" readonly="yes">
19952	<desc>
19953	TODO
19954	</desc>
19955	</attribute>
19956
19957	</interface>
19958
19959	<interface
19960	name="IGuestSessionRegisteredEvent" extends="IGuestSessionEvent"
19961	uuid="b79de686-eabd-4fa6-960a-f1756c99ea1c"
19962	wsmap="managed" autogen="VBoxEvent" id="OnGuestSessionRegistered"
19963	>
19964	<desc>
19965	TODO
19966	</desc>
19967
19968	<attribute name="registered" type="boolean" readonly="yes">
19969	<desc>
19970	TODO
19971	</desc>
19972	</attribute>
19973
19974	</interface>
19975
19976	<interface
19977	name="IGuestProcessEvent" extends="IGuestSessionEvent"
19978	uuid="ee4be6e7-76c5-4517-a623-d4b1957d4ea4"
19979	wsmap="managed" id="GuestProcessEvent"
19980	>
19981	<desc>Base abstract interface for all guest process events.</desc>
19982
19983	<attribute name="process" type="IGuestProcess" readonly="yes">
19984	<desc>
19985	TODO
19986	</desc>
19987	</attribute>
19988	<attribute name="pid" type="unsigned long" readonly="yes">
19989	<desc>
19990	TODO
19991	</desc>
19992	</attribute>
19993
19994	</interface>
19995
19996	<interface
19997	name="IGuestProcessRegisteredEvent" extends="IGuestProcessEvent"
19998	uuid="1d89e2b3-c6ea-45b6-9d43-dc6f70cc9f02"
19999	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessRegistered"
20000	>
20001	<desc>
20002	TODO
20003	</desc>
20004
20005	<attribute name="registered" type="boolean" readonly="yes">
20006	<desc>
20007	TODO
20008	</desc>
20009	</attribute>
20010
20011	</interface>
20012
20013	<interface
20014	name="IGuestProcessStateChangedEvent" extends="IGuestProcessEvent"
20015	uuid="9360d372-d4d9-4948-8e67-e0a0e603acf9"
20016	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessStateChanged"
20017	>
20018	<desc>
20019	TODO
20020	</desc>
20021
20022	<attribute name="status" type="ProcessStatus" readonly="yes">
20023	<desc>
20024	TODO
20025	</desc>
20026	</attribute>
20027	<attribute name="error" type="IGuestErrorInfo" readonly="yes">
20028	<desc>
20029	TODO
20030	</desc>
20031	</attribute>
20032
20033	</interface>
20034
20035	<interface
20036	name="IGuestProcessInputNotifyEvent" extends="IGuestProcessEvent"
20037	uuid="b3d6bb71-0392-4971-a908-f71c931995fd"
20038	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessInputNotify"
20039	>
20040	<desc>
20041	TODO
20042	</desc>
20043
20044	<attribute name="status" type="ProcessInputStatus" readonly="yes">
20045	<desc>
20046	TODO
20047	</desc>
20048	</attribute>
20049
20050	<attribute name="handle" type="unsigned long" readonly="yes">
20051	<desc>
20052	TODO
20053	</desc>
20054	</attribute>
20055
20056	<attribute name="processed" type="unsigned long" readonly="yes">
20057	<desc>
20058	TODO
20059	</desc>
20060	</attribute>
20061
20062	</interface>
20063
20064	<interface
20065	name="IGuestProcessOutputEvent" extends="IGuestProcessEvent"
20066	uuid="a13533b9-4aba-4937-836e-81325859c9d8"
20067	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessOutput"
20068	>
20069	<desc>
20070	TODO
20071	</desc>
20072
20073	<attribute name="handle" type="unsigned long" readonly="yes">
20074	<desc>
20075	TODO
20076	</desc>
20077	</attribute>
20078
20079	<attribute name="data" type="octet" safearray="yes" readonly="yes">
20080	<desc>
20081	TODO
20082	</desc>
20083	</attribute>
20084
20085	</interface>
20086
20087	<interface
20088	name="IGuestFileEvent" extends="IGuestSessionEvent"
20089	uuid="912f748f-d2f9-4fea-84d2-d36a017cc5f8"
20090	wsmap="managed" id="GuestFileEvent"
20091	>
20092	<desc>Base abstract interface for all guest file events.</desc>
20093
20094	<attribute name="file" type="IGuestFile" readonly="yes">
20095	<desc>
20096	TODO
20097	</desc>
20098	</attribute>
20099
20100	</interface>
20101
20102	<interface
20103	name="IGuestFileStateChangedEvent" extends="IGuestFileEvent"
20104	uuid="841951c4-4df3-4ee1-bb99-91e5761c18ff"
20105	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileStateChanged"
20106	>
20107	<desc>
20108	TODO
20109	</desc>
20110
20111	<attribute name="status" type="FileStatus" readonly="yes">
20112	<desc>
20113	TODO
20114	</desc>
20115	</attribute>
20116	<attribute name="error" type="IGuestErrorInfo" readonly="yes">
20117	<desc>
20118	TODO
20119	</desc>
20120	</attribute>
20121	<!-- Note: No events for reads/writes for performance reasons.
20122	See dedidcated events IGuestFileReadEvent and
20123	IGuestFileWriteEvent. -->
20124
20125	</interface>
20126
20127	<interface
20128	name="IGuestFileIOEvent" extends="IGuestFileEvent"
20129	uuid="b5191a7c-9536-4ef8-820e-3b0e17e5bbc8"
20130	wsmap="managed" id="OnGuestFileIO"
20131	>
20132	<desc>
20133	TODO
20134	</desc>
20135
20136	<attribute name="offset" type="long long" readonly="yes">
20137	<desc>
20138	TODO
20139	</desc>
20140	</attribute>
20141	<attribute name="processed" type="unsigned long" readonly="yes">
20142	<desc>
20143	TODO
20144	</desc>
20145
20146	</attribute>
20147
20148	</interface>
20149
20150	<interface
20151	name="IGuestFileOffsetChangedEvent" extends="IGuestFileIOEvent"
20152	uuid="e8f79a21-1207-4179-94cf-ca250036308f"
20153	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileOffsetChanged"
20154	>
20155	<desc>
20156	TODO
20157	</desc>
20158
20159	</interface>
20160
20161	<interface
20162	name="IGuestFileReadEvent" extends="IGuestFileIOEvent"
20163	uuid="4ee3cbcb-486f-40db-9150-deee3fd24189"
20164	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileRead"
20165	>
20166	<desc>
20167	TODO
20168	</desc>
20169
20170	<attribute name="data" type="octet" safearray="yes" readonly="yes">
20171	<desc>
20172	TODO
20173	</desc>
20174	</attribute>
20175
20176	</interface>
20177
20178	<interface
20179	name="IGuestFileWriteEvent" extends="IGuestFileIOEvent"
20180	uuid="e062a915-3cf5-4c0a-bc90-9b8d4cc94d89"
20181	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileWrite"
20182	>
20183	<desc>
20184	TODO
20185	</desc>
20186
20187	</interface>
20188
20189	<interface
20190	name="IVRDEServerChangedEvent" extends="IEvent"
20191	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
20192	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
20193	>
20194	<desc>
20195	Notification when a property of the
20196	<link to="IMachine::VRDEServer">VRDE server</link> changes.
20197	Interested callees should use IVRDEServer methods and attributes to
20198	find out what has changed.
20199	</desc>
20200	</interface>
20201
20202	<interface
20203	name="IVRDEServerInfoChangedEvent" extends="IEvent"
20204	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
20205	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
20206	>
20207	<desc>
20208	Notification when the status of the VRDE server changes. Interested callees
20209	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
20210	attributes to find out what is the current status.
20211	</desc>
20212	</interface>
20213
20214	<interface
20215	name="IUSBControllerChangedEvent" extends="IEvent"
20216	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
20217	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
20218	>
20219	<desc>
20220	Notification when a property of the virtual
20221	<link to="IMachine::USBController">USB controller</link> changes.
20222	Interested callees should use IUSBController methods and attributes to
20223	find out what has changed.
20224	</desc>
20225	</interface>
20226
20227	<interface
20228	name="IUSBDeviceStateChangedEvent" extends="IEvent"
20229	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
20230	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
20231	>
20232	<desc>
20233	Notification when a USB device is attached to or detached from
20234	the virtual USB controller.
20235
20236	This notification is sent as a result of the indirect
20237	request to attach the device because it matches one of the
20238	machine USB filters, or as a result of the direct request
20239	issued by <link to="IConsole::attachUSBDevice"/> or
20240	<link to="IConsole::detachUSBDevice"/>.
20241
20242	This notification is sent in case of both a succeeded and a
20243	failed request completion. When the request succeeds, the
20244	@a error parameter is @c null, and the given device has been
20245	already added to (when @a attached is @c true) or removed from
20246	(when @a attached is @c false) the collection represented by
20247	<link to="IConsole::USBDevices"/>. On failure, the collection
20248	doesn't change and the @a error parameter represents the error
20249	message describing the failure.
20250	</desc>
20251	<attribute name="device" type="IUSBDevice" readonly="yes">
20252	<desc>
20253	Device that is subject to state change.
20254	</desc>
20255	</attribute>
20256	<attribute name="attached" type="boolean" readonly="yes">
20257	<desc>
20258	@c true if the device was attached and @c false otherwise.
20259	</desc>
20260	</attribute>
20261	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
20262	<desc>
20263	@c null on success or an error message object on failure.
20264	</desc>
20265	</attribute>
20266	</interface>
20267
20268	<interface
20269	name="ISharedFolderChangedEvent" extends="IEvent"
20270	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
20271	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
20272	>
20273	<desc>
20274	Notification when a shared folder is added or removed.
20275	The @a scope argument defines one of three scopes:
20276	<link to="IVirtualBox::sharedFolders">global shared folders</link>
20277	(<link to="Scope_Global">Global</link>),
20278	<link to="IMachine::sharedFolders">permanent shared folders</link> of
20279	the machine (<link to="Scope_Machine">Machine</link>) or <link
20280	to="IConsole::sharedFolders">transient shared folders</link> of the
20281	machine (<link to="Scope_Session">Session</link>). Interested callees
20282	should use query the corresponding collections to find out what has
20283	changed.
20284	</desc>
20285	<attribute name="scope" type="Scope" readonly="yes">
20286	<desc>
20287	Scope of the notification.
20288	</desc>
20289	</attribute>
20290	</interface>
20291
20292	<interface
20293	name="IRuntimeErrorEvent" extends="IEvent"
20294	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
20295	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
20296	>
20297	<desc>
20298	Notification when an error happens during the virtual
20299	machine execution.
20300
20301	There are three kinds of runtime errors:
20302	<ul>
20303	<li><i>fatal</i></li>
20304	<li><i>non-fatal with retry</i></li>
20305	<li><i>non-fatal warnings</i></li>
20306	</ul>
20307
20308	<b>Fatal</b> errors are indicated by the @a fatal parameter set
20309	to @c true. In case of fatal errors, the virtual machine
20310	execution is always paused before calling this notification, and
20311	the notification handler is supposed either to immediately save
20312	the virtual machine state using <link to="IConsole::saveState"/>
20313	or power it off using <link to="IConsole::powerDown"/>.
20314	Resuming the execution can lead to unpredictable results.
20315
20316	<b>Non-fatal</b> errors and warnings are indicated by the
20317	@a fatal parameter set to @c false. If the virtual machine
20318	is in the Paused state by the time the error notification is
20319	received, it means that the user can <i>try to resume</i> the machine
20320	execution after attempting to solve the problem that caused the
20321	error. In this case, the notification handler is supposed
20322	to show an appropriate message to the user (depending on the
20323	value of the @a id parameter) that offers several actions such
20324	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
20325	wants to retry, the notification handler should continue
20326	the machine execution using the <link to="IConsole::resume"/>
20327	call. If the machine execution is not Paused during this
20328	notification, then it means this notification is a <i>warning</i>
20329	(for example, about a fatal condition that can happen very soon);
20330	no immediate action is required from the user, the machine
20331	continues its normal execution.
20332
20333	Note that in either case the notification handler
20334	<b>must not</b> perform any action directly on a thread
20335	where this notification is called. Everything it is allowed to
20336	do is to post a message to another thread that will then talk
20337	to the user and take the corresponding action.
20338
20339	Currently, the following error identifiers are known:
20340	<ul>
20341	<li><tt>"HostMemoryLow"</tt></li>
20342	<li><tt>"HostAudioNotResponding"</tt></li>
20343	<li><tt>"VDIStorageFull"</tt></li>
20344	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
20345	</ul>
20346	</desc>
20347	<attribute name="fatal" type="boolean" readonly="yes">
20348	<desc>
20349	Whether the error is fatal or not.
20350	</desc>
20351	</attribute>
20352	<attribute name="id" type="wstring" readonly="yes">
20353	<desc>
20354	Error identifier.
20355	</desc>
20356	</attribute>
20357	<attribute name="message" type="wstring" readonly="yes">
20358	<desc>
20359	Optional error message.
20360	</desc>
20361	</attribute>
20362	</interface>
20363
20364
20365	<interface
20366	name="IEventSourceChangedEvent" extends="IEvent"
20367	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
20368	waitable="yes"
20369	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
20370	>
20371	<desc>
20372	Notification when an event source state changes (listener added or removed).
20373	</desc>
20374
20375	<attribute name="listener" type="IEventListener" readonly="yes">
20376	<desc>
20377	Event listener which has changed.
20378	</desc>
20379	</attribute>
20380
20381	<attribute name="add" type="boolean" readonly="yes">
20382	<desc>
20383	Flag whether listener was added or removed.
20384	</desc>
20385	</attribute>
20386	</interface>
20387
20388	<interface
20389	name="IExtraDataChangedEvent" extends="IEvent"
20390	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
20391	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
20392	>
20393	<desc>
20394	Notification when machine specific or global extra data
20395	has changed.
20396	</desc>
20397	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
20398	<desc>
20399	ID of the machine this event relates to.
20400	Null for global extra data changes.
20401	</desc>
20402	</attribute>
20403	<attribute name="key" type="wstring" readonly="yes">
20404	<desc>
20405	Extra data key that has changed.
20406	</desc>
20407	</attribute>
20408	<attribute name="value" type="wstring" readonly="yes">
20409	<desc>
20410	Extra data value for the given key.
20411	</desc>
20412	</attribute>
20413	</interface>
20414
20415	<interface
20416	name="IVetoEvent" extends="IEvent"
20417	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
20418	wsmap="managed"
20419	>
20420	<desc>Base abstract interface for veto events.</desc>
20421
20422	<method name="addVeto">
20423	<desc>
20424	Adds a veto on this event.
20425	</desc>
20426	<param name="reason" type="wstring" dir="in">
20427	<desc>
20428	Reason for veto, could be null or empty string.
20429	</desc>
20430	</param>
20431	</method>
20432
20433	<method name="isVetoed">
20434	<desc>
20435	If this event was vetoed.
20436	</desc>
20437	<param name="result" type="boolean" dir="return">
20438	<desc>
20439	Reason for veto.
20440	</desc>
20441	</param>
20442	</method>
20443
20444	<method name="getVetos">
20445	<desc>
20446	Current veto reason list, if size is 0 - no veto.
20447	</desc>
20448	<param name="result" type="wstring" dir="return" safearray="yes">
20449	<desc>
20450	Array of reasons for veto provided by different event handlers.
20451	</desc>
20452	</param>
20453	</method>
20454
20455	</interface>
20456
20457	<interface
20458	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
20459	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
20460	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
20461	waitable="true"
20462	>
20463	<desc>
20464	Notification when someone tries to change extra data for
20465	either the given machine or (if @c null) global extra data.
20466	This gives the chance to veto against changes.
20467	</desc>
20468	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
20469	<desc>
20470	ID of the machine this event relates to.
20471	Null for global extra data changes.
20472	</desc>
20473	</attribute>
20474	<attribute name="key" type="wstring" readonly="yes">
20475	<desc>
20476	Extra data key that has changed.
20477	</desc>
20478	</attribute>
20479	<attribute name="value" type="wstring" readonly="yes">
20480	<desc>
20481	Extra data value for the given key.
20482	</desc>
20483	</attribute>
20484	</interface>
20485
20486	<interface
20487	name="ICanShowWindowEvent" extends="IVetoEvent"
20488	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
20489	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
20490	waitable="true"
20491	>
20492	<desc>
20493	Notification when a call to
20494	<link to="IMachine::canShowConsoleWindow"/> is made by a
20495	front-end to check if a subsequent call to
20496	<link to="IMachine::showConsoleWindow"/> can succeed.
20497
20498	The callee should give an answer appropriate to the current
20499	machine state using event veto. This answer must
20500	remain valid at least until the next
20501	<link to="IConsole::state">machine state</link> change.
20502	</desc>
20503	</interface>
20504
20505	<interface
20506	name="IShowWindowEvent" extends="IEvent"
20507	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
20508	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
20509	waitable="true"
20510	>
20511	<desc>
20512	Notification when a call to
20513	<link to="IMachine::showConsoleWindow"/>
20514	requests the console window to be activated and brought to
20515	foreground on the desktop of the host PC.
20516
20517	This notification should cause the VM console process to
20518	perform the requested action as described above. If it is
20519	impossible to do it at a time of this notification, this
20520	method should return a failure.
20521
20522	Note that many modern window managers on many platforms
20523	implement some sort of focus stealing prevention logic, so
20524	that it may be impossible to activate a window without the
20525	help of the currently active application (which is supposedly
20526	an initiator of this notification). In this case, this method
20527	must return a non-zero identifier that represents the
20528	top-level window of the VM console process. The caller, if it
20529	represents a currently active process, is responsible to use
20530	this identifier (in a platform-dependent manner) to perform
20531	actual window activation.
20532
20533	This method must set @a winId to zero if it has performed all
20534	actions necessary to complete the request and the console
20535	window is now active and in foreground, to indicate that no
20536	further action is required on the caller's side.
20537	</desc>
20538	<attribute name="winId" type="long long">
20539	<desc>
20540	Platform-dependent identifier of the top-level VM console
20541	window, or zero if this method has performed all actions
20542	necessary to implement the <i>show window</i> semantics for
20543	the given platform and/or this VirtualBox front-end.
20544	</desc>
20545	</attribute>
20546	</interface>
20547
20548	<interface
20549	name="INATRedirectEvent" extends="IMachineEvent"
20550	uuid="24eef068-c380-4510-bc7c-19314a7352f1"
20551	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
20552	>
20553	<desc>
20554	Notification when NAT redirect rule added or removed.
20555	</desc>
20556	<attribute name="slot" type="unsigned long" readonly="yes">
20557	<desc>
20558	Adapter which NAT attached to.
20559	</desc>
20560	</attribute>
20561	<attribute name="remove" type="boolean" readonly="yes">
20562	<desc>
20563	Whether rule remove or add.
20564	</desc>
20565	</attribute>
20566	<attribute name="name" type="wstring" readonly="yes">
20567	<desc>
20568	Name of the rule.
20569	</desc>
20570	</attribute>
20571	<attribute name="proto" type="NATProtocol" readonly="yes">
20572	<desc>
20573	Protocol (TCP or UDP) of the redirect rule.
20574	</desc>
20575	</attribute>
20576	<attribute name="hostIP" type="wstring" readonly="yes">
20577	<desc>
20578	Host ip address to bind socket on.
20579	</desc>
20580	</attribute>
20581	<attribute name="hostPort" type="long" readonly="yes">
20582	<desc>
20583	Host port to bind socket on.
20584	</desc>
20585	</attribute>
20586	<attribute name="guestIP" type="wstring" readonly="yes">
20587	<desc>
20588	Guest ip address to redirect to.
20589	</desc>
20590	</attribute>
20591	<attribute name="guestPort" type="long" readonly="yes">
20592	<desc>
20593	Guest port to redirect to.
20594	</desc>
20595	</attribute>
20596	</interface>
20597
20598	<interface
20599	name="IHostPCIDevicePlugEvent" extends="IMachineEvent"
20600	waitable="yes"
20601	uuid="a0bad6df-d612-47d3-89d4-db3992533948"
20602	wsmap="managed" autogen="VBoxEvent" id="OnHostPCIDevicePlug"
20603	>
20604	<desc>
20605	Notification when host PCI device is plugged/unplugged. Plugging
20606	usually takes place on VM startup, unplug - when
20607	<link to="IMachine::detachHostPCIDevice"/> is called.
20608
20609	<see><link to="IMachine::detachHostPCIDevice"/></see>
20610
20611	</desc>
20612
20613	<attribute name="plugged" type="boolean" readonly="yes">
20614	<desc>
20615	If device successfully plugged or unplugged.
20616	</desc>
20617	</attribute>
20618
20619	<attribute name="success" type="boolean" readonly="yes">
20620	<desc>
20621	If operation was successful, if false - 'message' attribute
20622	may be of interest.
20623	</desc>
20624	</attribute>
20625
20626	<attribute name="attachment" type="IPCIDeviceAttachment" readonly="yes">
20627	<desc>
20628	Attachment info for this device.
20629	</desc>
20630	</attribute>
20631
20632	<attribute name="message" type="wstring" readonly="yes">
20633	<desc>
20634	Optional error message.
20635	</desc>
20636	</attribute>
20637
20638	</interface>
20639
20640	<interface
20641	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
20642	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
20643	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
20644	>
20645	<desc>
20646	Notification when VBoxSVC becomes unavailable (due to a crash or similar
20647	unexpected circumstances) or available again.
20648	</desc>
20649
20650	<attribute name="available" type="boolean" readonly="yes">
20651	<desc>
20652	Whether VBoxSVC is available now.
20653	</desc>
20654	</attribute>
20655	</interface>
20656
20657	<interface
20658	name="IBandwidthGroupChangedEvent" extends="IEvent"
20659	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
20660	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
20661	>
20662	<desc>
20663	Notification when one of the bandwidth groups changed
20664	</desc>
20665	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
20666	<desc>
20667	The changed bandwidth group.
20668	</desc>
20669	</attribute>
20670	</interface>
20671
20672	<enum
20673	name="GuestMonitorChangedEventType"
20674	uuid="ef172985-7e36-4297-95be-e46396968d66"
20675	>
20676
20677	<desc>
20678	How the guest monitor has been changed.
20679	</desc>
20680
20681	<const name="Enabled" value="0">
20682	<desc>
20683	The guest monitor has been enabled by the guest.
20684	</desc>
20685	</const>
20686
20687	<const name="Disabled" value="1">
20688	<desc>
20689	The guest monitor has been disabled by the guest.
20690	</desc>
20691	</const>
20692
20693	<const name="NewOrigin" value="2">
20694	<desc>
20695	The guest monitor origin has changed in the guest.
20696	</desc>
20697	</const>
20698	</enum>
20699
20700	<interface
20701	name="IGuestMonitorChangedEvent" extends="IEvent"
20702	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
20703	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
20704	>
20705	<desc>
20706	Notification when the guest enables one of its monitors.
20707	</desc>
20708
20709	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
20710	<desc>
20711	What was changed for this guest monitor.
20712	</desc>
20713	</attribute>
20714
20715	<attribute name="screenId" type="unsigned long" readonly="yes">
20716	<desc>
20717	The monitor which was changed.
20718	</desc>
20719	</attribute>
20720
20721	<attribute name="originX" type="unsigned long" readonly="yes">
20722	<desc>
20723	Physical X origin relative to the primary screen.
20724	Valid for Enabled and NewOrigin.
20725	</desc>
20726	</attribute>
20727
20728	<attribute name="originY" type="unsigned long" readonly="yes">
20729	<desc>
20730	Physical Y origin relative to the primary screen.
20731	Valid for Enabled and NewOrigin.
20732	</desc>
20733	</attribute>
20734
20735	<attribute name="width" type="unsigned long" readonly="yes">
20736	<desc>
20737	Width of the screen.
20738	Valid for Enabled.
20739	</desc>
20740	</attribute>
20741
20742	<attribute name="height" type="unsigned long" readonly="yes">
20743	<desc>
20744	Height of the screen.
20745	Valid for Enabled.
20746	</desc>
20747	</attribute>
20748
20749	</interface>
20750
20751	<interface
20752	name="IStorageDeviceChangedEvent" extends="IEvent"
20753	uuid="232e9151-ae84-4b8e-b0f3-5c20c35caac9"
20754	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
20755	>
20756	<desc>
20757	Notification when a
20758	<link to="IMachine::mediumAttachments">storage device</link>
20759	is attached or removed.
20760	</desc>
20761	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
20762	<desc>
20763	Storage device that is subject to change.
20764	</desc>
20765	</attribute>
20766	<attribute name="removed" type="boolean" readonly="yes">
20767	<desc>
20768	Flag whether the device was removed or added to the VM.
20769	</desc>
20770	</attribute>
20771	<attribute name="silent" type="boolean" readonly="yes">
20772	<desc>
20773	Flag whether the guest should be notified about the change.
20774	</desc>
20775	</attribute>
20776	</interface>
20777	<interface
20778	name="INATNetworkChangedEvent" extends="IEvent"
20779	uuid="101ae042-1a29-4a19-92cf-02285773f3b5"
20780	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkChanged"
20781	>
20782	<!-- network name is common setting for all event types -->
20783	<attribute name="NetworkName" type="wstring" readonly="yes"/>
20784	</interface>
20785	<!-- base class for start/stop events -->
20786	<interface name="INATNetworkStartStopEvent" extends="INATNetworkChangedEvent"
20787	uuid="269d8f6b-fa1e-4cee-91c7-6d8496bea3c1"
20788	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkStartStop">
20789	<attribute name="startEvent" type="boolean" readonly="yes">
20790	<desc>
20791	IsStartEvent is true when NAT network is started and false on stopping.
20792	</desc>
20793	</attribute>
20794	</interface>
20795
20796	<!-- base class for modification events -->
20797	<interface name="INATNetworkAlterEvent" extends="INATNetworkChangedEvent"
20798	uuid="3f5a0822-163a-43b1-ad16-8d58b0ef6e75"
20799	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkAlter"/>
20800
20801	<interface name="INATNetworkCreationDeletionEvent" extends="INATNetworkAlterEvent"
20802	uuid="8d984a7e-b855-40b8-ab0c-44d3515b4528"
20803	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkCreationDeletion">
20804	<attribute name="creationEvent" type="boolean" readonly="yes"/>
20805	</interface>
20806	<interface name="INATNetworkSettingEvent" extends="INATNetworkAlterEvent"
20807	uuid="9db3a9e6-7f29-4aae-a627-5a282c83092c"
20808	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkSetting">
20809	<attribute name="enabled" type="boolean" readonly="yes"/>
20810	<attribute name="network" type="wstring" readonly="yes"/>
20811	<attribute name="gateway" type="wstring" readonly="yes"/>
20812	<attribute name="advertiseDefaultIPv6RouteEnabled" type="boolean" readonly="yes"/>
20813	<attribute name="needDhcpServer" type="boolean" readonly="yes"/>
20814	</interface>
20815	<interface name="INATNetworkPortForwardEvent" extends="INATNetworkAlterEvent"
20816	uuid="2514881b-23d0-430a-a7ff-7ed7f05534bc"
20817	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkPortForward">
20818	<attribute name="create" type="boolean" readonly="yes"/>
20819	<attribute name="ipv6" type="boolean" readonly="yes"/>
20820	<attribute name="name" type="wstring" readonly="yes"/>
20821	<attribute name="proto" type="NATProtocol" readonly="yes"/>
20822	<attribute name="hostIp" type="wstring" readonly="yes"/>
20823	<attribute name="hostPort" type="long" readonly="yes"/>
20824	<attribute name="guestIp" type="wstring" readonly="yes"/>
20825	<attribute name="guestPort" type="long" readonly="yes"/>
20826	</interface>
20827
20828	<module name="VBoxSVC" context="LocalServer">
20829	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
20830	namespace="virtualbox.org">
20831	<interface name="IVirtualBox" default="yes"/>
20832	</class>
20833	</module>
20834
20835	<module name="VBoxC" context="InprocServer" threadingModel="Free">
20836	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
20837	namespace="virtualbox.org">
20838	<interface name="IVirtualBoxClient" default="yes"/>
20839	</class>
20840
20841	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
20842	namespace="virtualbox.org">
20843	<interface name="ISession" default="yes"/>
20844	</class>
20845	</module>
20846
20847	</library>
20848
20849	</idl>
20850
20851	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format