VirtualBox.xidl@ 45884

Last change on this file since 45884 was 45840, checked in by vboxsync, 12 years ago
idl: uuid change for r85412
Property svn:eol-style set to `native`
File size: 756.1 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	<const name="LongMode" value="3">
942	<desc>
943	This setting determines whether VirtualBox will advertice long mode
944	(i.e. 64-bit guest support) and let the guest enter it.
945	</desc>
946	</const>
947	</enum>
948
949
950	<enum
951	name="HWVirtExPropertyType"
952	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
953	>
954	<desc>
955	Hardware virtualization property type. This enumeration represents possible values
956	for the <link to="IMachine::getHWVirtExProperty"/> and
957	<link to="IMachine::setHWVirtExProperty"/> methods.
958	</desc>
959	<const name="Null" value="0">
960	<desc>Null value (never used by the API).</desc>
961	</const>
962	<const name="Enabled" value="1">
963	<desc>
964	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
965	such extensions are not available, they will not be used.
966	</desc>
967	</const>
968	<const name="Exclusive" value="2">
969	<desc>
970	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
971	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
972	feature of the host. To share these with other hypervisors, you must disable this property.
973	</desc>
974	</const>
975	<const name="VPID" value="3">
976	<desc>
977	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
978	</desc>
979	</const>
980	<const name="NestedPaging" value="4">
981	<desc>
982	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
983	</desc>
984	</const>
985	<const name="LargePages" value="5">
986	<desc>
987	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
988	</desc>
989	</const>
990	<const name="Force" value="6">
991	<desc>
992	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
993	not set, there will be an automatic fallback to software virtualization.
994	</desc>
995	</const>
996	</enum>
997
998	<enum
999	name="FaultToleranceState"
1000	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
1001	>
1002	<desc>
1003	Used with <link to="IMachine::faultToleranceState" />.
1004	</desc>
1005	<const name="Inactive" value="1">
1006	<desc>No fault tolerance enabled.</desc>
1007	</const>
1008	<const name="Master" value="2">
1009	<desc>Fault tolerant master VM.</desc>
1010	</const>
1011	<const name="Standby" value="3">
1012	<desc>Fault tolerant standby VM.</desc>
1013	</const>
1014	</enum>
1015
1016	<enum
1017	name="LockType"
1018	uuid="168a6a8e-12fd-4878-a1f9-38a750a56089"
1019	>
1020	<desc>
1021	Used with <link to="IMachine::lockMachine" />.
1022	</desc>
1023	<const name="Write" value="2">
1024	<desc>Lock the machine for writing.</desc>
1025	</const>
1026	<const name="Shared" value="1">
1027	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
1028	</const>
1029	<const name="VM" value="3">
1030	<desc>Lock the machine for writing, and create objects necessary for
1031	running a VM in this process.</desc>
1032	</const>
1033	</enum>
1034
1035	<enum
1036	name="SessionType"
1037	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
1038	>
1039	<desc>
1040	Session type. This enumeration represents possible values of the
1041	<link to="ISession::type"/> attribute.
1042	</desc>
1043
1044	<const name="Null" value="0">
1045	<desc>Null value (never used by the API).</desc>
1046	</const>
1047	<const name="WriteLock" value="1">
1048	<desc>
1049	Session has acquired an exclusive write lock on a machine
1050	using <link to="IMachine::lockMachine"/>.
1051	</desc>
1052	</const>
1053	<const name="Remote" value="2">
1054	<desc>
1055	Session has launched a VM process using
1056	<link to="IMachine::launchVMProcess"/>
1057	</desc>
1058	</const>
1059	<const name="Shared" value="3">
1060	<desc>
1061	Session has obtained a link to another session using
1062	<link to="IMachine::lockMachine"/>
1063	</desc>
1064	</const>
1065	</enum>
1066
1067	<enum
1068	name="DeviceType"
1069	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1070	>
1071	<desc>
1072	Device type.
1073	</desc>
1074	<const name="Null" value="0">
1075	<desc>
1076	Null value, may also mean "no device" (not allowed for
1077	<link to="IConsole::getDeviceActivity"/>).
1078	</desc>
1079	</const>
1080	<const name="Floppy" value="1">
1081	<desc>Floppy device.</desc>
1082	</const>
1083	<const name="DVD" value="2">
1084	<desc>CD/DVD-ROM device.</desc>
1085	</const>
1086	<const name="HardDisk" value="3">
1087	<desc>Hard disk device.</desc>
1088	</const>
1089	<const name="Network" value="4">
1090	<desc>Network device.</desc>
1091	</const>
1092	<const name="USB" value="5">
1093	<desc>USB device.</desc>
1094	</const>
1095	<const name="SharedFolder" value="6">
1096	<desc>Shared folder device.</desc>
1097	</const>
1098	</enum>
1099
1100	<enum
1101	name="DeviceActivity"
1102	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1103	>
1104	<desc>
1105	Device activity for <link to="IConsole::getDeviceActivity"/>.
1106	</desc>
1107
1108	<const name="Null" value="0"/>
1109	<const name="Idle" value="1"/>
1110	<const name="Reading" value="2"/>
1111	<const name="Writing" value="3"/>
1112	</enum>
1113
1114	<enum
1115	name="ClipboardMode"
1116	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1117	>
1118	<desc>
1119	Host-Guest clipboard interchange mode.
1120	</desc>
1121
1122	<const name="Disabled" value="0"/>
1123	<const name="HostToGuest" value="1"/>
1124	<const name="GuestToHost" value="2"/>
1125	<const name="Bidirectional" value="3"/>
1126	</enum>
1127
1128	<enum
1129	name="DragAndDropMode"
1130	uuid="b618ea0e-b6fb-4f8d-97f7-5e237e49b547"
1131	>
1132	<desc>
1133	Drag'n'Drop interchange mode.
1134	</desc>
1135
1136	<const name="Disabled" value="0"/>
1137	<const name="HostToGuest" value="1"/>
1138	<const name="GuestToHost" value="2"/>
1139	<const name="Bidirectional" value="3"/>
1140	</enum>
1141
1142	<enum
1143	name="Scope"
1144	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1145	>
1146	<desc>
1147	Scope of the operation.
1148
1149	A generic enumeration used in various methods to define the action or
1150	argument scope.
1151	</desc>
1152
1153	<const name="Global" value="0"/>
1154	<const name="Machine" value="1"/>
1155	<const name="Session" value="2"/>
1156	</enum>
1157
1158	<enum
1159	name="BIOSBootMenuMode"
1160	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1161	>
1162	<desc>
1163	BIOS boot menu mode.
1164	</desc>
1165
1166	<const name="Disabled" value="0"/>
1167	<const name="MenuOnly" value="1"/>
1168	<const name="MessageAndMenu" value="2"/>
1169	</enum>
1170
1171	<enum
1172	name="ProcessorFeature"
1173	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1174	>
1175	<desc>
1176	CPU features.
1177	</desc>
1178
1179	<const name="HWVirtEx" value="0"/>
1180	<const name="PAE" value="1"/>
1181	<const name="LongMode" value="2"/>
1182	<const name="NestedPaging" value="3"/>
1183	</enum>
1184
1185	<enum
1186	name="FirmwareType"
1187	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1188	>
1189	<desc>
1190	Firmware type.
1191	</desc>
1192	<const name="BIOS" value="1">
1193	<desc>BIOS Firmware.</desc>
1194	</const>
1195	<const name="EFI" value="2">
1196	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1197	</const>
1198	<const name="EFI32" value="3">
1199	<desc>Efi firmware, 32-bit.</desc>
1200	</const>
1201	<const name="EFI64" value="4">
1202	<desc>Efi firmware, 64-bit.</desc>
1203	</const>
1204	<const name="EFIDUAL" value="5">
1205	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1206	</const>
1207	</enum>
1208
1209	<enum
1210	name="PointingHIDType"
1211	uuid="e44b2f7b-72ba-44fb-9e53-2186014f0d17"
1212	>
1213	<desc>
1214	Type of pointing device used in a virtual machine.
1215	</desc>
1216	<const name="None" value="1">
1217	<desc>No mouse.</desc>
1218	</const>
1219	<const name="PS2Mouse" value="2">
1220	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1221	</const>
1222	<const name="USBMouse" value="3">
1223	<desc>USB mouse (relative pointer).</desc>
1224	</const>
1225	<const name="USBTablet" value="4">
1226	<desc>USB tablet (absolute pointer).</desc>
1227	</const>
1228	<const name="ComboMouse" value="5">
1229	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1230	Using of such device can have negative performance implications. </desc>
1231	</const>
1232	</enum>
1233
1234	<enum
1235	name="KeyboardHIDType"
1236	uuid="383e43d7-5c7c-4ec8-9cb8-eda1bccd6699"
1237	>
1238	<desc>
1239	Type of keyboard device used in a virtual machine.
1240	</desc>
1241	<const name="None" value="1">
1242	<desc>No keyboard.</desc>
1243	</const>
1244	<const name="PS2Keyboard" value="2">
1245	<desc>PS/2 keyboard.</desc>
1246	</const>
1247	<const name="USBKeyboard" value="3">
1248	<desc>USB keyboard.</desc>
1249	</const>
1250	<const name="ComboKeyboard" value="4">
1251	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1252	Using of such device can have negative performance implications. </desc>
1253	</const>
1254	</enum>
1255
1256	<!--
1257	// IVirtualBoxErrorInfo
1258	/////////////////////////////////////////////////////////////////////////
1259	-->
1260
1261	<interface
1262	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1263	uuid="c1bcc6d5-7966-481d-ab0b-d0ed73e28135"
1264	supportsErrorInfo="no"
1265	wsmap="managed"
1266	>
1267	<desc>
1268	The IVirtualBoxErrorInfo interface represents extended error information.
1269
1270	Extended error information can be set by VirtualBox components after
1271	unsuccessful or partially successful method invocation. This information
1272	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1273	and then shown to the client in addition to the plain 32-bit result code.
1274
1275	In MS COM, this interface extends the IErrorInfo interface,
1276	in XPCOM, it extends the nsIException interface. In both cases,
1277	it provides a set of common attributes to retrieve error
1278	information.
1279
1280	Sometimes invocation of some component's method may involve methods of
1281	other components that may also fail (independently of this method's
1282	failure), or a series of non-fatal errors may precede a fatal error that
1283	causes method failure. In cases like that, it may be desirable to preserve
1284	information about all errors happened during method invocation and deliver
1285	it to the caller. The <link to="#next"/> attribute is intended
1286	specifically for this purpose and allows to represent a chain of errors
1287	through a single IVirtualBoxErrorInfo object set after method invocation.
1288
1289	<note>errors are stored to a chain in the reverse order, i.e. the
1290	initial error object you query right after method invocation is the last
1291	error set by the callee, the object it points to in the @a next attribute
1292	is the previous error and so on, up to the first error (which is the last
1293	in the chain).</note>
1294	</desc>
1295
1296	<attribute name="resultCode" type="long" readonly="yes">
1297	<desc>
1298	Result code of the error.
1299	Usually, it will be the same as the result code returned
1300	by the method that provided this error information, but not
1301	always. For example, on Win32, CoCreateInstance() will most
1302	likely return E_NOINTERFACE upon unsuccessful component
1303	instantiation attempt, but not the value the component factory
1304	returned. Value is typed 'long', not 'result',
1305	to make interface usable from scripting languages.
1306	<note>
1307	In MS COM, there is no equivalent.
1308	In XPCOM, it is the same as nsIException::result.
1309	</note>
1310	</desc>
1311	</attribute>
1312
1313	<attribute name="resultDetail" type="long" readonly="yes">
1314	<desc>
1315	Optional result data of this error. This will vary depending on the
1316	actual error usage. By default this attribute is not being used.
1317	</desc>
1318	</attribute>
1319
1320	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1321	<desc>
1322	UUID of the interface that defined the error.
1323	<note>
1324	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1325	data type.
1326	In XPCOM, there is no equivalent.
1327	</note>
1328	</desc>
1329	</attribute>
1330
1331	<attribute name="component" type="wstring" readonly="yes">
1332	<desc>
1333	Name of the component that generated the error.
1334	<note>
1335	In MS COM, it is the same as IErrorInfo::GetSource.
1336	In XPCOM, there is no equivalent.
1337	</note>
1338	</desc>
1339	</attribute>
1340
1341	<attribute name="text" type="wstring" readonly="yes">
1342	<desc>
1343	Text description of the error.
1344	<note>
1345	In MS COM, it is the same as IErrorInfo::GetDescription.
1346	In XPCOM, it is the same as nsIException::message.
1347	</note>
1348	</desc>
1349	</attribute>
1350
1351	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1352	<desc>
1353	Next error object if there is any, or @c null otherwise.
1354	<note>
1355	In MS COM, there is no equivalent.
1356	In XPCOM, it is the same as nsIException::inner.
1357	</note>
1358	</desc>
1359	</attribute>
1360
1361	</interface>
1362
1363	<!--
1364	// IVirtualBox
1365	/////////////////////////////////////////////////////////////////////////
1366	-->
1367	<!-- This is experimental interface to LWIP based NAT server -->
1368	<interface name="INATNetwork" extends="$unknown"
1369	uuid="03DFD6F7-1B78-48A3-8345-C785281E9523"
1370	wsmap="managed">
1371	<attribute name="NetworkName" type="wstring">
1372	<desc>
1373	TBD: the idea, technically we can start any number of the NAT networks,
1374	but we should expect that at some point we will get collisions because of
1375	port-forwanding rules. so perhaps we should support only single instance of NAT
1376	network.
1377	</desc>
1378	</attribute>
1379	<attribute name="enabled" type="boolean"/>
1380	<attribute name="network" type="wstring">
1381	<desc>
1382	This is CIDR IPv4 string. Specifiying it user defines IPv4 addresses
1383	of gateway (low address + 1) and dhcp server (= low address + 2).
1384	Note: if there're defined IPv4 port-forward rules update of network
1385	will be ignored (because new assignment could break existing rules).
1386	</desc>
1387	</attribute>
1388	<attribute name="gateway" type="wstring" readonly="yes">
1389	<desc>
1390	This attribute is read-only. It's recalculated on changing
1391	network attribute (low address of network + 1).
1392	</desc>
1393	</attribute>
1394	<attribute name="IPv6Enabled" type="boolean">
1395	<desc>
1396	This attribute define whether gateway will support IPv6 or not.
1397	</desc>
1398	</attribute>
1399	<attribute name="IPv6Prefix" type="wstring">
1400	<desc>
1401	This a CIDR IPv6 defining prefix for link-local addresses autoconfiguration within network. Note: ignored if attribute ipv6enabled is false.
1402	</desc>
1403	</attribute>
1404	<attribute name="advertiseDefaultIPv6RouteEnabled" type="boolean"/>
1405	<attribute name="needDhcpServer" type="boolean"/>
1406	<attribute name="eventSource" type="IEventSource" readonly="yes"/>
1407	<attribute name="portForwardRules4" type="wstring" readonly="yes" safearray="yes">
1408	<desc>Array of NAT port-forwarding rules in string representation,
1409	in the following format:
1410	"name:protocolid:[host ip]:host port:[guest ip]:guest port".
1411	</desc>
1412	</attribute>
1413	<attribute name="portForwardRules6" type="wstring" readonly="yes" safearray="yes">
1414	<desc>Array of NAT port-forwarding rules in string representation, in the
1415	following format: "name:protocolid:[host ip]:host port:[guest ip]:guest port".
1416	</desc>
1417	</attribute>
1418	<method name="addPortForwardRule">
1419	<param name="isIpv6" type="boolean" dir="in"/>
1420	<param name="ruleName" type="wstring" dir="in"/>
1421	<param name="proto" type="NATProtocol" dir="in">
1422	<desc>Protocol handled with the rule.</desc>
1423	</param>
1424	<param name="hostIP" type="wstring" dir="in">
1425	<desc>IP of the host interface to which the rule should apply.
1426	An empty ip address is acceptable, in which case the NAT engine
1427	binds the handling socket to any interface.
1428	</desc>
1429	</param>
1430	<param name="hostPort" type="unsigned short" dir="in">
1431	<desc>The port number to listen on.</desc>
1432	</param>
1433	<param name="guestIP" type="wstring" dir="in">
1434	<desc>The IP address of the guest which the NAT engine will forward
1435	matching packets to. An empty IP address is not acceptable.</desc>
1436	</param>
1437	<param name="guestPort" type="unsigned short" dir="in">
1438	<desc>The port number to forward.</desc>
1439	</param>
1440	</method>
1441	<method name="removePortForwardRule">
1442	<param name="iSipv6" type="boolean" dir="in"/>
1443	<param name="ruleName" type="wstring" dir="in"/>
1444	</method>
1445	<method name="start">
1446	<param name="trunkType" type="wstring" dir="in">
1447	<desc>
1448	Type of internal network trunk.
1449	</desc>
1450	</param>
1451	</method>
1452	<method name="stop"/>
1453	</interface>
1454
1455	<interface
1456	name="IDHCPServer" extends="$unknown"
1457	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1458	wsmap="managed"
1459	>
1460	<desc>
1461	The IDHCPServer interface represents the vbox DHCP server configuration.
1462
1463	To enumerate all the DHCP servers on the host, use the
1464	<link to="IVirtualBox::DHCPServers"/> attribute.
1465	</desc>
1466
1467	<attribute name="enabled" type="boolean">
1468	<desc>
1469	specifies if the DHCP server is enabled
1470	</desc>
1471	</attribute>
1472
1473	<attribute name="IPAddress" type="wstring" readonly="yes">
1474	<desc>
1475	specifies server IP
1476	</desc>
1477	</attribute>
1478
1479	<attribute name="networkMask" type="wstring" readonly="yes">
1480	<desc>
1481	specifies server network mask
1482	</desc>
1483	</attribute>
1484
1485	<attribute name="networkName" type="wstring" readonly="yes">
1486	<desc>
1487	specifies internal network name the server is used for
1488	</desc>
1489	</attribute>
1490
1491	<attribute name="lowerIP" type="wstring" readonly="yes">
1492	<desc>
1493	specifies from IP address in server address range
1494	</desc>
1495	</attribute>
1496
1497	<attribute name="upperIP" type="wstring" readonly="yes">
1498	<desc>
1499	specifies to IP address in server address range
1500	</desc>
1501	</attribute>
1502
1503	<method name="setConfiguration">
1504	<desc>
1505	configures the server
1506	<result name="E_INVALIDARG">
1507	invalid configuration supplied
1508	</result>
1509	</desc>
1510	<param name="IPAddress" type="wstring" dir="in">
1511	<desc>
1512	server IP address
1513	</desc>
1514	</param>
1515	<param name="networkMask" type="wstring" dir="in">
1516	<desc>
1517	server network mask
1518	</desc>
1519	</param>
1520	<param name="FromIPAddress" type="wstring" dir="in">
1521	<desc>
1522	server From IP address for address range
1523	</desc>
1524	</param>
1525	<param name="ToIPAddress" type="wstring" dir="in">
1526	<desc>
1527	server To IP address for address range
1528	</desc>
1529	</param>
1530	</method>
1531
1532	<method name="start">
1533	<desc>
1534	Starts DHCP server process.
1535	<result name="E_FAIL">
1536	Failed to start the process.
1537	</result>
1538	</desc>
1539	<param name="networkName" type="wstring" dir="in">
1540	<desc>
1541	Name of internal network DHCP server should attach to.
1542	</desc>
1543	</param>
1544	<param name="trunkName" type="wstring" dir="in">
1545	<desc>
1546	Name of internal network trunk.
1547	</desc>
1548	</param>
1549	<param name="trunkType" type="wstring" dir="in">
1550	<desc>
1551	Type of internal network trunk.
1552	</desc>
1553	</param>
1554	</method>
1555
1556	<method name="stop">
1557	<desc>
1558	Stops DHCP server process.
1559	<result name="E_FAIL">
1560	Failed to stop the process.
1561	</result>
1562	</desc>
1563	</method>
1564	</interface>
1565
1566	<interface
1567	name="IVirtualBox" extends="$unknown"
1568	uuid="fafa4e17-1ee2-4905-a10e-fe7c18bf5554"
1569	wsmap="managed"
1570	>
1571	<desc>
1572	The IVirtualBox interface represents the main interface exposed by the
1573	product that provides virtual machine management.
1574
1575	An instance of IVirtualBox is required for the product to do anything
1576	useful. Even though the interface does not expose this, internally,
1577	IVirtualBox is implemented as a singleton and actually lives in the
1578	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1579	IVirtualBox can track the state of all virtual machines on a particular
1580	host, regardless of which frontend started them.
1581
1582	To enumerate all the virtual machines on the host, use the
1583	<link to="IVirtualBox::machines"/> attribute.
1584	</desc>
1585
1586	<attribute name="version" type="wstring" readonly="yes">
1587	<desc>
1588	A string representing the version number of the product. The
1589	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1590	last number represents the build number and will frequently change.
1591
1592	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1593	in prerelease builds. Non-Oracle builds may (/shall) also have a
1594	publisher tag, at the end. The publisher tag starts with an underscore
1595	just like the prerelease build type tag.
1596	</desc>
1597	</attribute>
1598
1599	<attribute name="versionNormalized" type="wstring" readonly="yes">
1600	<desc>
1601	A string representing the version number of the product,
1602	without the publisher information (but still with other tags).
1603	See <link to="#version" />.
1604	</desc>
1605	</attribute>
1606
1607	<attribute name="revision" type="unsigned long" readonly="yes">
1608	<desc>
1609	The internal build revision number of the product.
1610	</desc>
1611	</attribute>
1612
1613	<attribute name="packageType" type="wstring" readonly="yes">
1614	<desc>
1615	A string representing the package type of this product. The
1616	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1617	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1618	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1619	this.
1620	</desc>
1621	</attribute>
1622
1623	<attribute name="APIVersion" type="wstring" readonly="yes">
1624	<desc>
1625	A string representing the VirtualBox API version number. The format is
1626	2 integer numbers divided by an underscore (e.g. 1_0). After the
1627	first public release of packages with a particular API version the
1628	API will not be changed in an incompatible way. Note that this
1629	guarantee does not apply to development builds, and also there is no
1630	guarantee that this version is identical to the first two integer
1631	numbers of the package version.
1632	</desc>
1633	</attribute>
1634
1635	<attribute name="homeFolder" type="wstring" readonly="yes">
1636	<desc>
1637	Full path to the directory where the global settings file,
1638	<tt>VirtualBox.xml</tt>, is stored.
1639
1640	In this version of VirtualBox, the value of this property is
1641	always <tt><user_dir>/.VirtualBox</tt> (where
1642	<tt><user_dir></tt> is the path to the user directory,
1643	as determined by the host OS), and cannot be changed.
1644
1645	This path is also used as the base to resolve relative paths in
1646	places where relative paths are allowed (unless otherwise
1647	expressly indicated).
1648	</desc>
1649	</attribute>
1650
1651	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1652	<desc>
1653	Full name of the global settings file.
1654	The value of this property corresponds to the value of
1655	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1656	</desc>
1657	</attribute>
1658
1659	<attribute name="host" type="IHost" readonly="yes">
1660	<desc>Associated host object.</desc>
1661	</attribute>
1662
1663	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1664	<desc>Associated system information object.</desc>
1665	</attribute>
1666
1667	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1668	<desc>
1669	Array of machine objects registered within this VirtualBox instance.
1670	</desc>
1671	</attribute>
1672
1673	<attribute name="machineGroups" type="wstring" readonly="yes" safearray="yes">
1674	<desc>
1675	Array of all machine group names which are used by the machines which
1676	are accessible. Each group is only listed once, however they are listed
1677	in no particular order and there is no guarantee that there are no gaps
1678	in the group hierarchy (i.e. <tt>"/"</tt>, <tt>"/group/subgroup"</tt>
1679	is a valid result).
1680	</desc>
1681	</attribute>
1682
1683	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1684	<desc>
1685	Array of medium objects known to this VirtualBox installation.
1686
1687	This array contains only base media. All differencing
1688	media of the given base medium can be enumerated using
1689	<link to="IMedium::children"/>.
1690	</desc>
1691	</attribute>
1692
1693	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1694	<desc>
1695	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1696	</desc>
1697	</attribute>
1698
1699	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1700	<desc>
1701	Array of floppy image objects currently in use by this VirtualBox instance.
1702	</desc>
1703	</attribute>
1704
1705	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1706
1707	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1708
1709	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1710	<desc>
1711	Collection of global shared folders. Global shared folders are
1712	available to all virtual machines.
1713
1714	New shared folders are added to the collection using
1715	<link to="#createSharedFolder"/>. Existing shared folders can be
1716	removed using <link to="#removeSharedFolder"/>.
1717
1718	<note>
1719	In the current version of the product, global shared folders are not
1720	implemented and therefore this collection is always empty.
1721	</note>
1722	</desc>
1723	</attribute>
1724
1725	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1726	<desc>
1727	Associated performance collector object.
1728	</desc>
1729	</attribute>
1730
1731	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1732	<desc>
1733	DHCP servers.
1734	</desc>
1735	</attribute>
1736	<!-- Array of NAT networks -->
1737	<attribute name="NATNetworks" type="INATNetwork" safearray="yes" readonly="yes"/>
1738
1739	<attribute name="eventSource" type="IEventSource" readonly="yes">
1740	<desc>
1741	Event source for VirtualBox events.
1742	</desc>
1743	</attribute>
1744
1745	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1746	<desc>
1747	The extension pack manager.
1748	</desc>
1749	</attribute>
1750
1751
1752	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1753	<desc>
1754	Names of all internal networks.
1755	</desc>
1756	</attribute>
1757
1758	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1759	<desc>
1760	Names of all generic network drivers.
1761	</desc>
1762	</attribute>
1763
1764	<method name="composeMachineFilename">
1765	<desc>
1766	Returns a recommended full path of the settings file name for a new virtual
1767	machine.
1768
1769	This API serves two purposes:
1770
1771	<ul>
1772	<li>It gets called by <link to="#createMachine" /> if @c null or
1773	empty string (which is recommended) is specified for the
1774	@a settingsFile argument there, which means that API should use
1775	a recommended default file name.</li>
1776
1777	<li>It can be called manually by a client software before creating a machine,
1778	e.g. if that client wants to pre-create the machine directory to create
1779	virtual hard disks in that directory together with the new machine
1780	settings file. In that case, the file name should be stripped from the
1781	full settings file path returned by this function to obtain the
1782	machine directory.</li>
1783	</ul>
1784
1785	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1786	details about the machine name.
1787
1788	@a groupName defines which additional subdirectory levels should be
1789	included. It must be either a valid group name or @c null or empty
1790	string which designates that the machine will not be related to a
1791	machine group.
1792
1793	If @a baseFolder is a @c null or empty string (which is recommended), the
1794	default machine settings folder
1795	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1796	a base folder for the created machine, resulting in a file name like
1797	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1798	will be used.
1799
1800	This method does not access the host disks. In particular, it does not check
1801	for whether a machine with this name already exists.
1802	</desc>
1803	<param name="name" type="wstring" dir="in">
1804	<desc>Suggested machine name.</desc>
1805	</param>
1806	<param name="group" type="wstring" dir="in">
1807	<desc>Machine group name for the new machine or machine group. It is
1808	used to determine the right subdirectory.</desc>
1809	</param>
1810	<param name="createFlags" type="wstring" dir="in">
1811	<desc>Machine creation flags, see <link to="#createMachine" /> (optional).</desc>
1812	</param>
1813	<param name="baseFolder" type="wstring" dir="in">
1814	<desc>Base machine folder (optional).</desc>
1815	</param>
1816	<param name="file" type="wstring" dir="return">
1817	<desc>Fully qualified path where the machine would be created.</desc>
1818	</param>
1819	</method>
1820
1821	<method name="createMachine">
1822	<desc>
1823	Creates a new virtual machine by creating a machine settings file at
1824	the given location.
1825
1826	VirtualBox machine settings files use a custom XML dialect. Starting
1827	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1828	and machine files can be created at arbitrary locations.
1829
1830	However, it is recommended that machines are created in the default
1831	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1832	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1833	@c null or empty string (which is recommended) for the @a settingsFile
1834	argument, <link to="#composeMachineFilename" /> is called automatically
1835	to have such a recommended name composed based on the machine name
1836	given in the @a name argument and the primary group.
1837
1838	If the resulting settings file already exists, this method will fail,
1839	unless the forceOverwrite flag is set.
1840
1841	The new machine is created unregistered, with the initial configuration
1842	set according to the specified guest OS type. A typical sequence of
1843	actions to create a new virtual machine is as follows:
1844
1845	<ol>
1846	<li>
1847	Call this method to have a new machine created. The returned machine
1848	object will be "mutable" allowing to change any machine property.
1849	</li>
1850
1851	<li>
1852	Configure the machine using the appropriate attributes and methods.
1853	</li>
1854
1855	<li>
1856	Call <link to="IMachine::saveSettings" /> to write the settings
1857	to the machine's XML settings file. The configuration of the newly
1858	created machine will not be saved to disk until this method is
1859	called.
1860	</li>
1861
1862	<li>
1863	Call <link to="#registerMachine" /> to add the machine to the list
1864	of machines known to VirtualBox.
1865	</li>
1866	</ol>
1867
1868	The specified guest OS type identifier must match an ID of one of known
1869	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1870	array.
1871
1872	<note>
1873	There is no way to change the name of the settings file or
1874	subfolder of the created machine directly.
1875	</note>
1876
1877	<result name="VBOX_E_OBJECT_NOT_FOUND">
1878	@a osTypeId is invalid.
1879	</result>
1880	<result name="VBOX_E_FILE_ERROR">
1881	Resulting settings file name is invalid or the settings file already
1882	exists or could not be created due to an I/O error.
1883	</result>
1884	<result name="E_INVALIDARG">
1885	@a name is empty or @c null.
1886	</result>
1887	</desc>
1888
1889	<param name="settingsFile" type="wstring" dir="in">
1890	<desc>Fully qualified path where the settings file should be created,
1891	empty string or @c null for a default folder and file based on the
1892	@a name argument and the primary group.
1893	(see <link to="#composeMachineFilename" />).</desc>
1894	</param>
1895	<param name="name" type="wstring" dir="in">
1896	<desc>Machine name.</desc>
1897	</param>
1898	<param name="groups" type="wstring" safearray="yes" dir="in">
1899	<desc>Array of group names. @c null or an empty array have the same
1900	meaning as an array with just the empty string or <tt>"/"</tt>, i.e.
1901	create a machine without group association.</desc>
1902	</param>
1903	<param name="osTypeId" type="wstring" dir="in">
1904	<desc>Guest OS Type ID.</desc>
1905	</param>
1906	<param name="flags" type="wstring" dir="in">
1907	<desc>
1908	Additional property parameters, passed as a comma-separated list of
1909	"name=value" type entries. The following ones are recognized:
1910	<tt>forceOverwrite=1</tt> to overwrite an existing machine settings
1911	file, <tt>UUID=<uuid></tt> to specify a machine UUID and
1912	<tt>directoryIncludesUUID=1</tt> to switch to a special VM directory
1913	naming scheme which should not be used unless necessary.
1914	</desc>
1915	</param>
1916	<param name="machine" type="IMachine" dir="return">
1917	<desc>Created machine object.</desc>
1918	</param>
1919	</method>
1920
1921	<method name="openMachine">
1922	<desc>
1923	Opens a virtual machine from the existing settings file.
1924	The opened machine remains unregistered until you call
1925	<link to="#registerMachine"/>.
1926
1927	The specified settings file name must be fully qualified.
1928	The file must exist and be a valid machine XML settings file
1929	whose contents will be used to construct the machine object.
1930
1931	<result name="VBOX_E_FILE_ERROR">
1932	Settings file name invalid, not found or sharing violation.
1933	</result>
1934	</desc>
1935	<param name="settingsFile" type="wstring" dir="in">
1936	<desc>
1937	Name of the machine settings file.
1938	</desc>
1939	</param>
1940	<param name="machine" type="IMachine" dir="return">
1941	<desc>Opened machine object.</desc>
1942	</param>
1943	<note>
1944	<link to="IMachine::settingsModified"/> will return
1945	@c false for the created machine, until any of machine settings
1946	are changed.
1947	</note>
1948	</method>
1949
1950	<method name="registerMachine">
1951	<desc>
1952
1953	Registers the machine previously created using
1954	<link to="#createMachine"/> or opened using
1955	<link to="#openMachine"/> within this VirtualBox installation. After
1956	successful method invocation, the
1957	<link to="IMachineRegisteredEvent"/> event is fired.
1958
1959	<note>
1960	This method implicitly calls <link to="IMachine::saveSettings"/>
1961	to save all current machine settings before registering it.
1962	</note>
1963
1964	<result name="VBOX_E_OBJECT_NOT_FOUND">
1965	No matching virtual machine found.
1966	</result>
1967	<result name="VBOX_E_INVALID_OBJECT_STATE">
1968	Virtual machine was not created within this VirtualBox instance.
1969	</result>
1970
1971	</desc>
1972	<param name="machine" type="IMachine" dir="in"/>
1973	</method>
1974
1975	<method name="findMachine">
1976	<desc>
1977	Attempts to find a virtual machine given its name or UUID.
1978
1979	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1980	cannot safely be determined.</note>
1981
1982	<result name="VBOX_E_OBJECT_NOT_FOUND">
1983	Could not find registered machine matching @a nameOrId.
1984	</result>
1985
1986	</desc>
1987	<param name="nameOrId" type="wstring" dir="in">
1988	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1989	</param>
1990	<param name="machine" type="IMachine" dir="return">
1991	<desc>Machine object, if found.</desc>
1992	</param>
1993	</method>
1994
1995	<method name="getMachinesByGroups">
1996	<desc>
1997	Gets all machine references which are in one of the specified groups.
1998	</desc>
1999	<param name="groups" type="wstring" dir="in" safearray="yes">
2000	<desc>What groups to match. The usual group list rules apply, i.e.
2001	passing an empty list will match VMs in the toplevel group, likewise
2002	the empty string.</desc>
2003	</param>
2004	<param name="machines" type="IMachine" dir="return" safearray="yes">
2005	<desc>All machines which matched.</desc>
2006	</param>
2007	</method>
2008
2009	<method name="getMachineStates">
2010	<desc>
2011	Gets the state of several machines in a single operation.
2012	</desc>
2013	<param name="machines" type="IMachine" dir="in" safearray="yes">
2014	<desc>Array with the machine references.</desc>
2015	</param>
2016	<param name="states" type="MachineState" dir="return" safearray="yes">
2017	<desc>Machine states, corresponding to the machines.</desc>
2018	</param>
2019	</method>
2020
2021	<method name="createAppliance">
2022	<desc>
2023	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
2024	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
2025	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
2026	</desc>
2027	<param name="appliance" type="IAppliance" dir="return">
2028	<desc>New appliance.</desc>
2029	</param>
2030	</method>
2031
2032	<method name="createHardDisk">
2033	<desc>
2034	Creates a new base medium object that will use the given storage
2035	format and location for medium data.
2036
2037	The actual storage unit is not created by this method. In order to
2038	do it, and before you are able to attach the created medium to
2039	virtual machines, you must call one of the following methods to
2040	allocate a format-specific storage unit at the specified location:
2041	<ul>
2042	<li><link to="IMedium::createBaseStorage"/></li>
2043	<li><link to="IMedium::createDiffStorage"/></li>
2044	</ul>
2045
2046	Some medium attributes, such as <link to="IMedium::id"/>, may
2047	remain uninitialized until the medium storage unit is successfully
2048	created by one of the above methods.
2049
2050	After the storage unit is successfully created, it will be
2051	accessible through the <link to="#openMedium"/> method and can
2052	be found in the <link to="#hardDisks"/> array.
2053
2054	The list of all storage formats supported by this VirtualBox
2055	installation can be obtained using
2056	<link to="ISystemProperties::mediumFormats"/>. If the @a format
2057	attribute is empty or @c null then the default storage format
2058	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
2059	be used for creating a storage unit of the medium.
2060
2061	Note that the format of the location string is storage format specific.
2062	See <link to="IMedium::location"/> and IMedium for more details.
2063
2064	<result name="VBOX_E_OBJECT_NOT_FOUND">
2065	@a format identifier is invalid. See
2066	<link to="ISystemProperties::mediumFormats"/>.
2067	</result>
2068	<result name="VBOX_E_FILE_ERROR">
2069	@a location is a not valid file name (for file-based formats only).
2070	</result>
2071	</desc>
2072	<param name="format" type="wstring" dir="in">
2073	<desc>
2074	Identifier of the storage format to use for the new medium.
2075	</desc>
2076	</param>
2077	<param name="location" type="wstring" dir="in">
2078	<desc>
2079	Location of the storage unit for the new medium.
2080	</desc>
2081	</param>
2082	<param name="medium" type="IMedium" dir="return">
2083	<desc>Created medium object.</desc>
2084	</param>
2085	</method>
2086
2087	<method name="openMedium">
2088	<desc>
2089	Finds existing media or opens a medium from an existing storage location.
2090
2091	Once a medium has been opened, it can be passed to other VirtualBox
2092	methods, in particular to <link to="IMachine::attachDevice" />.
2093
2094	Depending on the given device type, the file at the storage location
2095	must be in one of the media formats understood by VirtualBox:
2096
2097	<ul>
2098	<li>With a "HardDisk" device type, the file must be a hard disk image
2099	in one of the formats supported by VirtualBox (see
2100	<link to="ISystemProperties::mediumFormats" />).
2101	After this method succeeds, if the medium is a base medium, it
2102	will be added to the <link to="#hardDisks"/> array attribute. </li>
2103	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
2104	After this method succeeds, the medium will be added to the
2105	<link to="#DVDImages"/> array attribute.</li>
2106	<li>With a "Floppy" device type, the file must be an RAW floppy image.
2107	After this method succeeds, the medium will be added to the
2108	<link to="#floppyImages"/> array attribute.</li>
2109	</ul>
2110
2111	After having been opened, the medium can be re-found by this method
2112	and can be attached to virtual machines. See <link to="IMedium" /> for
2113	more details.
2114
2115	The UUID of the newly opened medium will either be retrieved from the
2116	storage location, if the format supports it (e.g. for hard disk images),
2117	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
2118	If for some reason you need to change the medium's UUID, use
2119	<link to="IMedium::setIds" />.
2120
2121	If a differencing hard disk medium is to be opened by this method, the
2122	operation will succeed only if its parent medium and all ancestors,
2123	if any, are already known to this VirtualBox installation (for example,
2124	were opened by this method before).
2125
2126	This method attempts to guess the storage format of the specified medium
2127	by reading medium data at the specified location.
2128
2129	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
2130	the image is opened for read/write access and must have according permissions,
2131	as VirtualBox may actually write status information into the disk's metadata
2132	sections.
2133
2134	Note that write access is required for all typical hard disk usage in VirtualBox,
2135	since VirtualBox may need to write metadata such as a UUID into the image.
2136	The only exception is opening a source image temporarily for copying and
2137	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
2138	again soon.
2139
2140	The format of the location string is storage format specific. See
2141	<link to="IMedium::location"/> and IMedium for more details.
2142
2143	<result name="VBOX_E_FILE_ERROR">
2144	Invalid medium storage file location or could not find the medium
2145	at the specified location.
2146	</result>
2147	<result name="VBOX_E_IPRT_ERROR">
2148	Could not get medium storage format.
2149	</result>
2150	<result name="E_INVALIDARG">
2151	Invalid medium storage format.
2152	</result>
2153	<result name="VBOX_E_INVALID_OBJECT_STATE">
2154	Medium has already been added to a media registry.
2155	</result>
2156	</desc>
2157	<param name="location" type="wstring" dir="in">
2158	<desc>
2159	Location of the storage unit that contains medium data in one of
2160	the supported storage formats.
2161	</desc>
2162	</param>
2163	<param name="deviceType" type="DeviceType" dir="in">
2164	<desc>
2165	Must be one of "HardDisk", "DVD" or "Floppy".
2166	</desc>
2167	</param>
2168	<param name="accessMode" type="AccessMode" dir="in">
2169	<desc>Whether to open the image in read/write or read-only mode. For
2170	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
2171	</param>
2172	<param name="forceNewUuid" type="boolean" dir="in">
2173	<desc>Allows the caller to request a completely new medium UUID for
2174	the image which is to be opened. Useful if one intends to open an exact
2175	copy of a previously opened image, as this would normally fail due to
2176	the duplicate UUID.</desc>
2177	</param>
2178	<param name="medium" type="IMedium" dir="return">
2179	<desc>Opened medium object.</desc>
2180	</param>
2181	</method>
2182
2183	<method name="getGuestOSType">
2184	<desc>
2185	Returns an object describing the specified guest OS type.
2186
2187	The requested guest OS type is specified using a string which is a
2188	mnemonic identifier of the guest operating system, such as
2189	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2190	particular virtual machine can be read or set using the
2191	<link to="IMachine::OSTypeId"/> attribute.
2192
2193	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2194	available guest OS type objects. Each object has an
2195	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2196	the guest OS this object describes.
2197
2198	<result name="E_INVALIDARG">
2199	@a id is not a valid Guest OS type.
2200	</result>
2201
2202	</desc>
2203	<param name="id" type="uuid" mod="string" dir="in">
2204	<desc>Guest OS type ID string.</desc>
2205	</param>
2206	<param name="type" type="IGuestOSType" dir="return">
2207	<desc>Guest OS type object.</desc>
2208	</param>
2209	</method>
2210
2211	<method name="createSharedFolder">
2212	<desc>
2213	Creates a new global shared folder by associating the given logical
2214	name with the given host path, adds it to the collection of shared
2215	folders and starts sharing it. Refer to the description of
2216	<link to="ISharedFolder"/> to read more about logical names.
2217	<note>
2218	In the current implementation, this operation is not
2219	implemented.
2220	</note>
2221	</desc>
2222	<param name="name" type="wstring" dir="in">
2223	<desc>Unique logical name of the shared folder.</desc>
2224	</param>
2225	<param name="hostPath" type="wstring" dir="in">
2226	<desc>Full path to the shared folder in the host file system.</desc>
2227	</param>
2228	<param name="writable" type="boolean" dir="in">
2229	<desc>Whether the share is writable or readonly</desc>
2230	</param>
2231	<param name="automount" type="boolean" dir="in">
2232	<desc>Whether the share gets automatically mounted by the guest
2233	or not.</desc>
2234	</param>
2235	</method>
2236
2237	<method name="removeSharedFolder">
2238	<desc>
2239	Removes the global shared folder with the given name previously
2240	created by <link to="#createSharedFolder"/> from the collection of
2241	shared folders and stops sharing it.
2242	<note>
2243	In the current implementation, this operation is not
2244	implemented.
2245	</note>
2246	</desc>
2247	<param name="name" type="wstring" dir="in">
2248	<desc>Logical name of the shared folder to remove.</desc>
2249	</param>
2250	</method>
2251
2252	<method name="getExtraDataKeys">
2253	<desc>
2254	Returns an array representing the global extra data keys which currently
2255	have values defined.
2256	</desc>
2257	<param name="keys" type="wstring" dir="return" safearray="yes">
2258	<desc>Array of extra data keys.</desc>
2259	</param>
2260	</method>
2261
2262	<method name="getExtraData">
2263	<desc>
2264	Returns associated global extra data.
2265
2266	If the requested data @a key does not exist, this function will
2267	succeed and return an empty string in the @a value argument.
2268
2269	<result name="VBOX_E_FILE_ERROR">
2270	Settings file not accessible.
2271	</result>
2272	<result name="VBOX_E_XML_ERROR">
2273	Could not parse the settings file.
2274	</result>
2275
2276	</desc>
2277	<param name="key" type="wstring" dir="in">
2278	<desc>Name of the data key to get.</desc>
2279	</param>
2280	<param name="value" type="wstring" dir="return">
2281	<desc>Value of the requested data key.</desc>
2282	</param>
2283	</method>
2284
2285	<method name="setExtraData">
2286	<desc>
2287	Sets associated global extra data.
2288
2289	If you pass @c null or empty string as a key @a value, the given @a key
2290	will be deleted.
2291
2292	<note>
2293	Before performing the actual data change, this method will ask all
2294	registered event listener using the
2295	<link to="IExtraDataCanChangeEvent"/>
2296	notification for a permission. If one of the listeners refuses the
2297	new value, the change will not be performed.
2298	</note>
2299	<note>
2300	On success, the
2301	<link to="IExtraDataChangedEvent"/> notification
2302	is called to inform all registered listeners about a successful data
2303	change.
2304	</note>
2305
2306	<result name="VBOX_E_FILE_ERROR">
2307	Settings file not accessible.
2308	</result>
2309	<result name="VBOX_E_XML_ERROR">
2310	Could not parse the settings file.
2311	</result>
2312	<result name="E_ACCESSDENIED">
2313	Modification request refused.
2314	</result>
2315
2316	</desc>
2317	<param name="key" type="wstring" dir="in">
2318	<desc>Name of the data key to set.</desc>
2319	</param>
2320	<param name="value" type="wstring" dir="in">
2321	<desc>Value to assign to the key.</desc>
2322	</param>
2323	</method>
2324
2325	<method name="setSettingsSecret">
2326	<desc>
2327	Unlocks the secret data by passing the unlock password to the
2328	server. The server will cache the password for that machine.
2329
2330	<result name="VBOX_E_INVALID_VM_STATE">
2331	Virtual machine is not mutable.
2332	</result>
2333
2334	</desc>
2335	<param name="password" type="wstring" dir="in">
2336	<desc>
2337	The cipher key.
2338	</desc>
2339	</param>
2340	</method>
2341
2342	<!--method name="createDHCPServerForInterface">
2343	<desc>
2344	Creates a DHCP server settings to be used for the given interface
2345	<result name="E_INVALIDARG">
2346	Host network interface @a name already exists.
2347	</result>
2348	</desc>
2349	<param name="interface" type="IHostNetworkInterface" dir="in">
2350	<desc>Network Interface</desc>
2351	</param>
2352	<param name="server" type="IDHCPServer" dir="out">
2353	<desc>DHCP server settings</desc>
2354	</param>
2355	</method-->
2356
2357	<method name="createDHCPServer">
2358	<desc>
2359	Creates a DHCP server settings to be used for the given internal network name
2360	<result name="E_INVALIDARG">
2361	Host network interface @a name already exists.
2362	</result>
2363	</desc>
2364	<param name="name" type="wstring" dir="in">
2365	<desc>server name</desc>
2366	</param>
2367	<param name="server" type="IDHCPServer" dir="return">
2368	<desc>DHCP server settings</desc>
2369	</param>
2370	</method>
2371
2372	<method name="findDHCPServerByNetworkName">
2373	<desc>
2374	Searches a DHCP server settings to be used for the given internal network name
2375	<result name="E_INVALIDARG">
2376	Host network interface @a name already exists.
2377	</result>
2378
2379	</desc>
2380	<param name="name" type="wstring" dir="in">
2381	<desc>server name</desc>
2382	</param>
2383	<param name="server" type="IDHCPServer" dir="return">
2384	<desc>DHCP server settings</desc>
2385	</param>
2386	</method>
2387
2388	<!--method name="findDHCPServerForInterface">
2389	<desc>
2390	Searches a DHCP server settings to be used for the given interface
2391	<result name="E_INVALIDARG">
2392	Host network interface @a name already exists.
2393	</result>
2394	</desc>
2395	<param name="interface" type="IHostNetworkInterface" dir="in">
2396	<desc>Network Interface</desc>
2397	</param>
2398	<param name="server" type="IDHCPServer" dir="out">
2399	<desc>DHCP server settings</desc>
2400	</param>
2401	</method-->
2402
2403	<method name="removeDHCPServer">
2404	<desc>
2405	Removes the DHCP server settings
2406	<result name="E_INVALIDARG">
2407	Host network interface @a name already exists.
2408	</result>
2409	</desc>
2410	<param name="server" type="IDHCPServer" dir="in">
2411	<desc>DHCP server settings to be removed</desc>
2412	</param>
2413	</method>
2414
2415	<!-- bunch of metods to create NAT -->
2416	<method name="createNATNetwork">
2417	<!-- Here we create a record in NAT network array with name
2418	and gateway/network parameters this information should
2419	be enough for VBoxNet[Lwip]NAT and VBoxNetDHCP for
2420	servicing the guests.
2421	-->
2422	<param name="networkName" type="wstring" dir="in"/>
2423	<param name="network" type="INATNetwork" dir="return"/>
2424	</method>
2425
2426	<!--
2427	Returns the NATNetwork by name, e.g. for adding porforward rule or delition.
2428	-->
2429	<method name="findNATNetworkByName">
2430	<param name="networkName" type="wstring" dir="in"/>
2431	<param name="network" type="INATNetwork" dir="return"/>
2432	</method>
2433	<!--
2434	Deletes given NAT network.
2435	-->
2436	<method name="removeNATNetwork">
2437	<param name="network" type="INATNetwork" dir="in"/>
2438	</method>
2439
2440	<method name="checkFirmwarePresent">
2441	<desc>
2442	Check if this VirtualBox installation has a firmware
2443	of the given type available, either system-wide or per-user.
2444	Optionally, this may return a hint where this firmware can be
2445	downloaded from.
2446	</desc>
2447	<param name="firmwareType" type="FirmwareType" dir="in">
2448	<desc>
2449	Type of firmware to check.
2450	</desc>
2451	</param>
2452	<param name="version" type="wstring" dir="in">
2453	<desc>Expected version number, usually empty string (presently ignored).</desc>
2454	</param>
2455
2456	<param name="url" type="wstring" dir="out">
2457	<desc>
2458	Suggested URL to download this firmware from.
2459	</desc>
2460	</param>
2461
2462	<param name="file" type="wstring" dir="out">
2463	<desc>
2464	Filename of firmware, only valid if result == TRUE.
2465	</desc>
2466	</param>
2467
2468	<param name="result" type="boolean" dir="return">
2469	<desc>If firmware of this type and version is available.</desc>
2470	</param>
2471	</method>
2472
2473	</interface>
2474
2475	<!--
2476	// IVFSExplorer
2477	/////////////////////////////////////////////////////////////////////////
2478	-->
2479
2480	<enum
2481	name="VFSType"
2482	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2483	>
2484	<desc>
2485	Virtual file systems supported by VFSExplorer.
2486	</desc>
2487
2488	<const name="File" value="1" />
2489	<const name="Cloud" value="2" />
2490	<const name="S3" value="3" />
2491	<const name="WebDav" value="4" />
2492	</enum>
2493
2494	<enum
2495	name="VFSFileType"
2496	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2497	>
2498	<desc>
2499	File types known by VFSExplorer.
2500	</desc>
2501
2502	<const name="Unknown" value="1" />
2503	<const name="Fifo" value="2" />
2504	<const name="DevChar" value="3" />
2505	<const name="Directory" value="4" />
2506	<const name="DevBlock" value="5" />
2507	<const name="File" value="6" />
2508	<const name="SymLink" value="7" />
2509	<const name="Socket" value="8" />
2510	<const name="WhiteOut" value="9" />
2511	</enum>
2512
2513	<interface
2514	name="IVFSExplorer" extends="$unknown"
2515	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2516	wsmap="managed"
2517	>
2518	<desc>
2519	The VFSExplorer interface unifies access to different file system
2520	types. This includes local file systems as well remote file systems like
2521	S3. For a list of supported types see <link to="VFSType" />.
2522	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2523	</desc>
2524
2525	<attribute name="path" type="wstring" readonly="yes">
2526	<desc>Returns the current path in the virtual file system.</desc>
2527	</attribute>
2528
2529	<attribute name="type" type="VFSType" readonly="yes">
2530	<desc>Returns the file system type which is currently in use.</desc>
2531	</attribute>
2532
2533	<method name="update">
2534	<desc>Updates the internal list of files/directories from the
2535	current directory level. Use <link to="#entryList" /> to get the full list
2536	after a call to this method.</desc>
2537
2538	<param name="progress" type="IProgress" dir="return">
2539	<desc>Progress object to track the operation completion.</desc>
2540	</param>
2541	</method>
2542
2543	<method name="cd">
2544	<desc>Change the current directory level.</desc>
2545
2546	<param name="dir" type="wstring" dir="in">
2547	<desc>The name of the directory to go in.</desc>
2548	</param>
2549
2550	<param name="progress" type="IProgress" dir="return">
2551	<desc>Progress object to track the operation completion.</desc>
2552	</param>
2553	</method>
2554
2555	<method name="cdUp">
2556	<desc>Go one directory upwards from the current directory level.</desc>
2557
2558	<param name="progress" type="IProgress" dir="return">
2559	<desc>Progress object to track the operation completion.</desc>
2560	</param>
2561	</method>
2562
2563	<method name="entryList">
2564	<desc>Returns a list of files/directories after a call to <link
2565	to="#update" />. The user is responsible for keeping this internal
2566	list up do date.</desc>
2567
2568	<param name="names" type="wstring" safearray="yes" dir="out">
2569	<desc>The list of names for the entries.</desc>
2570	</param>
2571
2572	<param name="types" type="unsigned long" safearray="yes" dir="out">
2573	<desc>The list of types for the entries.</desc>
2574	</param>
2575
2576	<param name="sizes" type="unsigned long" safearray="yes" dir="out">
2577	<desc>The list of sizes (in bytes) for the entries.</desc>
2578	</param>
2579
2580	<param name="modes" type="unsigned long" safearray="yes" dir="out">
2581	<desc>The list of file modes (in octal form) for the entries.</desc>
2582	</param>
2583	</method>
2584
2585	<method name="exists">
2586	<desc>Checks if the given file list exists in the current directory
2587	level.</desc>
2588
2589	<param name="names" type="wstring" safearray="yes" dir="in">
2590	<desc>The names to check.</desc>
2591	</param>
2592
2593	<param name="exists" type="wstring" safearray="yes" dir="return">
2594	<desc>The names which exist.</desc>
2595	</param>
2596	</method>
2597
2598	<method name="remove">
2599	<desc>Deletes the given files in the current directory level.</desc>
2600
2601	<param name="names" type="wstring" safearray="yes" dir="in">
2602	<desc>The names to remove.</desc>
2603	</param>
2604
2605	<param name="progress" type="IProgress" dir="return">
2606	<desc>Progress object to track the operation completion.</desc>
2607	</param>
2608	</method>
2609
2610	</interface>
2611
2612	<enum
2613	name="ImportOptions" extends="$unknown"
2614	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2615	>
2616
2617	<desc>
2618	Import options, used with <link to="IAppliance::importMachines" />.
2619	</desc>
2620
2621	<const name="KeepAllMACs" value="1">
2622	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2623	</const>
2624	<const name="KeepNATMACs" value="2">
2625	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2626	</const>
2627
2628	</enum>
2629
2630
2631	<!--
2632	// IAppliance
2633	/////////////////////////////////////////////////////////////////////////
2634	-->
2635
2636	<interface
2637	name="IAppliance" extends="$unknown"
2638	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2639	wsmap="managed"
2640	>
2641	<desc>
2642	Represents a platform-independent appliance in OVF format. An instance of this is returned
2643	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2644	virtual machines within an appliance with VirtualBox.
2645
2646	The OVF standard suggests two different physical file formats:
2647
2648	<ol>
2649	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2650	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2651	this descriptor file references other files such as disk images, as OVF appliances typically
2652	do, those additional files must be in the same directory as the descriptor file.</li>
2653
2654	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2655	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2656	files and optionally other files.
2657
2658	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2659	be added with a later version.</li>
2660	</ol>
2661
2662	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2663	<link to="IMachine" /> involves the following sequence of API calls:
2664
2665	<ol>
2666	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2667	</li>
2668
2669	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2670	would like to import. So long as this file is syntactically valid, this will succeed
2671	and fill the appliance object with the parsed data from the OVF file.
2672	</li>
2673
2674	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2675	contents of the IAppliance attributes accordingly. These can be inspected by a
2676	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2677	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2678	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2679	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2680	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2681	The GUI can then give the user the option to confirm and/or change these suggestions.
2682	</li>
2683
2684	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2685	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2686	</li>
2687
2688	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2689	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2690	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2691	can be found in the <link to="#machines" /> array attribute.
2692	</li>
2693	</ol>
2694
2695	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2696
2697	<ol>
2698	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2699	an empty IAppliance object.
2700	</li>
2701
2702	<li>For each machine you would like to export, call <link to="IMachine::exportTo" />
2703	with the IAppliance object you just created. Each such call creates one instance of
2704	<link to="IVirtualSystemDescription" /> inside the appliance.
2705	</li>
2706
2707	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2708	virtual system (machine) to override the suggestions made by the <link to="IMachine::exportTo"/> routine.
2709	</li>
2710
2711	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2712	file written.</li>
2713	</ol>
2714
2715	</desc>
2716
2717	<attribute name="path" type="wstring" readonly="yes">
2718	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2719	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2720	<link to="#write" /> (for export).
2721	This attribute is empty until one of these methods has been called.
2722	</desc>
2723	</attribute>
2724
2725	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2726	<desc>
2727	Array of virtual disk definitions. One such description exists for each
2728	disk definition in the OVF; each string array item represents one such piece of
2729	disk information, with the information fields separated by tab (\\t) characters.
2730
2731	The caller should be prepared for additional fields being appended to
2732	this string in future versions of VirtualBox and therefore check for
2733	the number of tabs in the strings returned.
2734
2735	In the current version, the following eight fields are returned per string
2736	in the array:
2737
2738	<ol>
2739	<li>Disk ID (unique string identifier given to disk)</li>
2740
2741	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2742
2743	<li>Populated size (optional unsigned integer indicating the current size of the
2744	disk; can be approximate; -1 if unspecified)</li>
2745
2746	<li>Format (string identifying the disk format, typically
2747	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2748
2749	<li>Reference (where to find the disk image, typically a file name; if empty,
2750	then the disk should be created on import)</li>
2751
2752	<li>Image size (optional unsigned integer indicating the size of the image,
2753	which need not necessarily be the same as the values specified above, since
2754	the image may be compressed or sparse; -1 if not specified)</li>
2755
2756	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2757	presently unsupported and always -1)</li>
2758
2759	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2760	</ol>
2761	</desc>
2762	</attribute>
2763
2764	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2765	<desc> Array of virtual system descriptions. One such description is created
2766	for each virtual system (machine) found in the OVF.
2767	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::exportTo" />
2768	(for export) has been called.
2769	</desc>
2770	</attribute>
2771
2772	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2773	<desc>
2774	Contains the UUIDs of the machines created from the information in this appliances. This is only
2775	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2776	succeeded.
2777	</desc>
2778	</attribute>
2779
2780	<method name="read">
2781	<desc>
2782	Reads an OVF file into the appliance object.
2783
2784	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2785	mere fact that this method returns successfully does not mean that VirtualBox supports all
2786	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2787	</desc>
2788	<param name="file" type="wstring" dir="in">
2789	<desc>
2790	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2791	on whether the appliance is distributed as a set of files or as a single file, respectively).
2792	</desc>
2793	</param>
2794	<param name="progress" type="IProgress" dir="return">
2795	<desc>Progress object to track the operation completion.</desc>
2796	</param>
2797	</method>
2798
2799	<method name="interpret">
2800	<desc>
2801	Interprets the OVF data that was read when the appliance was constructed. After
2802	calling this method, one can inspect the
2803	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2804	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2805	the appliance.
2806
2807	Calling this method is the second step of importing an appliance into VirtualBox;
2808	see <link to="IAppliance" /> for an overview.
2809
2810	After calling this method, one should call <link to="#getWarnings" /> to find out
2811	if problems were encountered during the processing which might later lead to
2812	errors.
2813	</desc>
2814	</method>
2815
2816	<method name="importMachines">
2817	<desc>
2818	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2819	and other interfaces that match the information contained in the appliance as
2820	closely as possible, as represented by the import instructions in the
2821	<link to="#virtualSystemDescriptions" /> array.
2822
2823	Calling this method is the final step of importing an appliance into VirtualBox;
2824	see <link to="IAppliance" /> for an overview.
2825
2826	Since importing the appliance will most probably involve copying and converting
2827	disk images, which can take a long time, this method operates asynchronously and
2828	returns an IProgress object to allow the caller to monitor the progress.
2829
2830	After the import succeeded, the UUIDs of the IMachine instances created can be
2831	retrieved from the <link to="#machines" /> array attribute.
2832	</desc>
2833
2834	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2835	<desc>Options for the importing operation.</desc>
2836	</param>
2837
2838	<param name="progress" type="IProgress" dir="return">
2839	<desc>Progress object to track the operation completion.</desc>
2840	</param>
2841	</method>
2842
2843	<method name="createVFSExplorer">
2844	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2845
2846	<param name="URI" type="wstring" dir="in">
2847	<desc>The URI describing the file system to use.</desc>
2848	</param>
2849
2850	<param name="explorer" type="IVFSExplorer" dir="return">
2851	<desc></desc>
2852	</param>
2853	</method>
2854
2855	<method name="write">
2856	<desc>
2857	Writes the contents of the appliance exports into a new OVF file.
2858
2859	Calling this method is the final step of exporting an appliance from VirtualBox;
2860	see <link to="IAppliance" /> for an overview.
2861
2862	Since exporting the appliance will most probably involve copying and converting
2863	disk images, which can take a long time, this method operates asynchronously and
2864	returns an IProgress object to allow the caller to monitor the progress.
2865	</desc>
2866	<param name="format" type="wstring" dir="in">
2867	<desc>
2868	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2869	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2870	</desc>
2871	</param>
2872	<param name="manifest" type="boolean" dir="in">
2873	<desc>
2874	Indicate if the optional manifest file (.mf) should be written. The manifest file
2875	is used for integrity checks prior import.
2876	</desc>
2877	</param>
2878	<param name="path" type="wstring" dir="in">
2879	<desc>
2880	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2881	on whether the appliance is distributed as a set of files or as a single file, respectively).
2882	</desc>
2883	</param>
2884	<param name="progress" type="IProgress" dir="return">
2885	<desc>Progress object to track the operation completion.</desc>
2886	</param>
2887	</method>
2888
2889	<method name="getWarnings">
2890	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2891
2892	<param name="warnings" type="wstring" dir="return" safearray="yes">
2893	<desc></desc>
2894	</param>
2895	</method>
2896
2897	</interface>
2898
2899	<enum
2900	name="VirtualSystemDescriptionType"
2901	uuid="303c0900-a746-4612-8c67-79003e91f459"
2902	>
2903	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2904	a configuration value.</desc>
2905
2906	<const name="Ignore" value="1" />
2907	<const name="OS" value="2" />
2908	<const name="Name" value="3" />
2909	<const name="Product" value="4" />
2910	<const name="Vendor" value="5" />
2911	<const name="Version" value="6" />
2912	<const name="ProductUrl" value="7" />
2913	<const name="VendorUrl" value="8" />
2914	<const name="Description" value="9" />
2915	<const name="License" value="10" />
2916	<const name="Miscellaneous" value="11" />
2917	<const name="CPU" value="12" />
2918	<const name="Memory" value="13" />
2919	<const name="HardDiskControllerIDE" value="14" />
2920	<const name="HardDiskControllerSATA" value="15" />
2921	<const name="HardDiskControllerSCSI" value="16" />
2922	<const name="HardDiskControllerSAS" value="17" />
2923	<const name="HardDiskImage" value="18" />
2924	<const name="Floppy" value="19" />
2925	<const name="CDROM" value="20" />
2926	<const name="NetworkAdapter" value="21" />
2927	<const name="USBController" value="22" />
2928	<const name="SoundCard" value="23" />
2929	<const name="SettingsFile" value="24">
2930	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2931	</const>
2932	</enum>
2933
2934	<enum
2935	name="VirtualSystemDescriptionValueType"
2936	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2937	>
2938	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2939	type to fetch.</desc>
2940
2941	<const name="Reference" value="1" />
2942	<const name="Original" value="2" />
2943	<const name="Auto" value="3" />
2944	<const name="ExtraConfig" value="4" />
2945
2946	</enum>
2947
2948	<interface
2949	name="IVirtualSystemDescription" extends="$unknown"
2950	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2951	wsmap="managed"
2952	>
2953
2954	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2955	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2956	<link to="IAppliance::interpret" /> has been called, that array contains information
2957	about how the virtual systems described in the OVF should best be imported into
2958	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2959	import an OVF into VirtualBox.
2960	</desc>
2961
2962	<attribute name="count" type="unsigned long" readonly="yes">
2963	<desc>Return the number of virtual system description entries.</desc>
2964	</attribute>
2965
2966	<method name="getDescription">
2967	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2968	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2969
2970	The list below identifies the value sets that are possible depending on the
2971	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2972	the array item with the same index in @a OVFValues[] will contain the original value as contained
2973	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2974	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2975	the @a aExtraConfigValues[] array item may also be used.
2976
2977	<ul>
2978	<li>
2979	"OS": the guest operating system type. There must be exactly one such array item on import. The
2980	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2981	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2982	item in @a OVFValues[] will contain a numerical value that described the operating system in the OVF.
2983	</li>
2984	<li>
2985	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2986	if none is present on import, then an automatic name will be created from the operating system
2987	type. The corresponding item im @a OVFValues[] will contain the suggested virtual machine name
2988	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2989	<link to="IMachine" /> name that does not exist yet.
2990	</li>
2991	<li>
2992	"Description": an arbitrary description.
2993	</li>
2994	<li>
2995	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2996	code to display such a license for agreement; the Main API does not enforce any such policy.
2997	</li>
2998	<li>
2999	Miscellaneous: reserved for future use.
3000	</li>
3001	<li>
3002	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3003	</li>
3004	<li>
3005	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3006	is present on import, then VirtualBox will set a meaningful default based on the operating system
3007	type.
3008	</li>
3009	<li>
3010	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
3011	An optional value in @a OVFValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
3012	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
3013	writes into the OVF.
3014	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
3015	type can use to specify which hard disk controller a virtual disk should be connected to.
3016	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
3017	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
3018	its virtual machines supports four channels (primary master, primary slave, secondary master,
3019	secondary slave) and thus maps to two IDE controllers in the OVF sense.
3020	</li>
3021	<li>
3022	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3023	has no value in @a OVFValues[] or @a aVBoxValues[].
3024	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3025	</li>
3026	<li>
3027	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3028	The items in @a OVFValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
3029	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
3030	whereas VirtualBox considers it a class of storage controllers of its own; see
3031	<link to="StorageControllerType" />).
3032	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3033	</li>
3034	<li>
3035	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3036	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3037
3038	The array item in @a OVFValues[] will contain the file specification from the OVF file (without
3039	a path since the image file should be in the same location as the OVF file itself), whereas the
3040	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3041	hard disk image. This means that on import the image will be copied and converted from the
3042	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3043
3044	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
3045	format: "controller=<index>;channel=<c>"
3046	In this string, <index> must be an integer specifying the hard disk controller to connect
3047	the image to. That number must be the index of an array item with one of the hard disk controller
3048	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
3049	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3050	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
3051	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
3052	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
3053	</li>
3054	<li>
3055	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
3056	attachment information as with "HardDiskImage" items.
3057	</li>
3058	<li>
3059	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
3060	attachment information as with "HardDiskImage" items.
3061	</li>
3062	<li>
3063	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
3064	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
3065	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3066	</li>
3067	<li>
3068	"USBController": a USB controller. There can be at most one such item. If and only if such an
3069	item ispresent, USB support will be enabled for the new virtual machine.
3070	</li>
3071	<li>
3072	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3073	present, sound support will be enabled for the new virtual machine. Note that the virtual
3074	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3075	may be different from the virtual soundcard expected by the appliance.
3076	</li>
3077	</ul>
3078
3079	</desc>
3080
3081	<param name="types" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3082	<desc></desc>
3083	</param>
3084
3085	<param name="refs" type="wstring" dir="out" safearray="yes">
3086	<desc></desc>
3087	</param>
3088
3089	<param name="OVFValues" type="wstring" dir="out" safearray="yes">
3090	<desc></desc>
3091	</param>
3092
3093	<param name="VBoxValues" type="wstring" dir="out" safearray="yes">
3094	<desc></desc>
3095	</param>
3096
3097	<param name="extraConfigValues" type="wstring" dir="out" safearray="yes">
3098	<desc></desc>
3099	</param>
3100
3101	</method>
3102
3103	<method name="getDescriptionByType">
3104	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3105	should be returned.</desc>
3106
3107	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3108	<desc></desc>
3109	</param>
3110
3111	<param name="types" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3112	<desc></desc>
3113	</param>
3114
3115	<param name="refs" type="wstring" dir="out" safearray="yes">
3116	<desc></desc>
3117	</param>
3118
3119	<param name="OVFValues" type="wstring" dir="out" safearray="yes">
3120	<desc></desc>
3121	</param>
3122
3123	<param name="VBoxValues" type="wstring" dir="out" safearray="yes">
3124	<desc></desc>
3125	</param>
3126
3127	<param name="extraConfigValues" type="wstring" dir="out" safearray="yes">
3128	<desc></desc>
3129	</param>
3130
3131	</method>
3132
3133	<method name="getValuesByType">
3134	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3135	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3136	values.</desc>
3137
3138	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3139	<desc></desc>
3140	</param>
3141
3142	<param name="which" type="VirtualSystemDescriptionValueType" dir="in">
3143	<desc></desc>
3144	</param>
3145
3146	<param name="values" type="wstring" dir="return" safearray="yes">
3147	<desc></desc>
3148	</param>
3149
3150	</method>
3151
3152	<method name="setFinalValues">
3153	<desc>
3154	This method allows the appliance's user to change the configuration for the virtual
3155	system descriptions. For each array item returned from <link to="#getDescription" />,
3156	you must pass in one boolean value and one configuration value.
3157
3158	Each item in the boolean array determines whether the particular configuration item
3159	should be enabled.
3160	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3161	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3162	and SoundCard.
3163
3164	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3165	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
3166	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
3167	for valid configuration values for the individual array item types. If the
3168	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3169	</desc>
3170
3171	<param name="enabled" type="boolean" dir="in" safearray="yes">
3172	<desc></desc>
3173	</param>
3174
3175	<param name="VBoxValues" type="wstring" dir="in" safearray="yes">
3176	<desc></desc>
3177	</param>
3178
3179	<param name="extraConfigValues" type="wstring" dir="in" safearray="yes">
3180	<desc></desc>
3181	</param>
3182	</method>
3183
3184	<method name="addDescription">
3185	<desc>
3186	This method adds an additional description entry to the stack of already
3187	available descriptions for this virtual system. This is handy for writing
3188	values which aren't directly supported by VirtualBox. One example would
3189	be the License type of <link to="VirtualSystemDescriptionType" />.
3190	</desc>
3191
3192	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3193	<desc></desc>
3194	</param>
3195
3196	<param name="VBoxValue" type="wstring" dir="in">
3197	<desc></desc>
3198	</param>
3199
3200	<param name="extraConfigValue" type="wstring" dir="in">
3201	<desc></desc>
3202	</param>
3203	</method>
3204	</interface>
3205
3206
3207	<!--
3208	// IMachine
3209	/////////////////////////////////////////////////////////////////////////
3210	-->
3211
3212	<interface
3213	name="IInternalMachineControl" extends="$unknown"
3214	uuid="dca36a92-703c-4649-98a4-f40c1ef0c336"
3215	internal="yes"
3216	wsmap="suppress"
3217	>
3218	<method name="setRemoveSavedStateFile">
3219	<desc>
3220	Updates the flag whether the saved state file is removed on a
3221	machine state change from Saved to PoweredOff.
3222	</desc>
3223	<param name="remove" type="boolean" dir="in"/>
3224	</method>
3225
3226	<method name="updateState">
3227	<desc>
3228	Updates the VM state.
3229	<note>
3230	This operation will also update the settings file with the correct
3231	information about the saved state file and delete this file from disk
3232	when appropriate.
3233	</note>
3234	</desc>
3235	<param name="state" type="MachineState" dir="in"/>
3236	</method>
3237
3238	<method name="getIPCId">
3239	<param name="id" type="wstring" dir="return"/>
3240	</method>
3241
3242	<method name="beginPowerUp">
3243	<desc>
3244	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3245	gives it the progress object that should be part of any pending
3246	<link to="IMachine::launchVMProcess"/> operations. The progress
3247	object may be called back to reflect an early cancelation, so some care
3248	have to be taken with respect to any cancelation callbacks. The console
3249	object will call <link to="IInternalMachineControl::endPowerUp"/>
3250	to signal the completion of the progress object.
3251	</desc>
3252	<param name="progress" type="IProgress" dir="in" />
3253	</method>
3254
3255	<method name="endPowerUp">
3256	<desc>
3257	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3258	This method may query status information from the progress object it
3259	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3260	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3261	call in order to complete that progress object.
3262	</desc>
3263	<param name="result" type="long" dir="in"/>
3264	</method>
3265
3266	<method name="beginPoweringDown">
3267	<desc>
3268	Called by the VM process to inform the server it wants to
3269	stop the VM execution and power down.
3270	</desc>
3271	<param name="progress" type="IProgress" dir="out">
3272	<desc>
3273	Progress object created by VBoxSVC to wait until
3274	the VM is powered down.
3275	</desc>
3276	</param>
3277	</method>
3278
3279	<method name="endPoweringDown">
3280	<desc>
3281	Called by the VM process to inform the server that powering
3282	down previously requested by #beginPoweringDown is either
3283	successfully finished or there was a failure.
3284
3285	<result name="VBOX_E_FILE_ERROR">
3286	Settings file not accessible.
3287	</result>
3288	<result name="VBOX_E_XML_ERROR">
3289	Could not parse the settings file.
3290	</result>
3291
3292	</desc>
3293
3294	<param name="result" type="long" dir="in">
3295	<desc>@c S_OK to indicate success.
3296	</desc>
3297	</param>
3298	<param name="errMsg" type="wstring" dir="in">
3299	<desc>@c human readable error message in case of failure.
3300	</desc>
3301	</param>
3302	</method>
3303
3304	<method name="runUSBDeviceFilters">
3305	<desc>
3306	Asks the server to run USB devices filters of the associated
3307	machine against the given USB device and tell if there is
3308	a match.
3309	<note>
3310	Intended to be used only for remote USB devices. Local
3311	ones don't require to call this method (this is done
3312	implicitly by the Host and USBProxyService).
3313	</note>
3314	</desc>
3315	<param name="device" type="IUSBDevice" dir="in"/>
3316	<param name="matched" type="boolean" dir="out"/>
3317	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3318	</method>
3319
3320	<method name="captureUSBDevice">
3321	<desc>
3322	Requests a capture of the given host USB device.
3323	When the request is completed, the VM process will
3324	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3325	notification.
3326	</desc>
3327	<param name="id" type="uuid" mod="string" dir="in"/>
3328	</method>
3329
3330	<method name="detachUSBDevice">
3331	<desc>
3332	Notification that a VM is going to detach (@a done = @c false) or has
3333	already detached (@a done = @c true) the given USB device.
3334	When the @a done = @c true request is completed, the VM process will
3335	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3336	notification.
3337	<note>
3338	In the @a done = @c true case, the server must run its own filters
3339	and filters of all VMs but this one on the detached device
3340	as if it were just attached to the host computer.
3341	</note>
3342	</desc>
3343	<param name="id" type="uuid" mod="string" dir="in"/>
3344	<param name="done" type="boolean" dir="in"/>
3345	</method>
3346
3347	<method name="autoCaptureUSBDevices">
3348	<desc>
3349	Requests a capture all matching USB devices attached to the host.
3350	When the request is completed, the VM process will
3351	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3352	notification per every captured device.
3353	</desc>
3354	</method>
3355
3356	<method name="detachAllUSBDevices">
3357	<desc>
3358	Notification that a VM that is being powered down. The done
3359	parameter indicates whether which stage of the power down
3360	we're at. When @a done = @c false the VM is announcing its
3361	intentions, while when @a done = @c true the VM is reporting
3362	what it has done.
3363	<note>
3364	In the @a done = @c true case, the server must run its own filters
3365	and filters of all VMs but this one on all detach devices as
3366	if they were just attached to the host computer.
3367	</note>
3368	</desc>
3369	<param name="done" type="boolean" dir="in"/>
3370	</method>
3371
3372	<method name="onSessionEnd">
3373	<desc>
3374	Triggered by the given session object when the session is about
3375	to close normally.
3376	</desc>
3377	<param name="session" type="ISession" dir="in">
3378	<desc>Session that is being closed</desc>
3379	</param>
3380	<param name="progress" type="IProgress" dir="return">
3381	<desc>
3382	Used to wait until the corresponding machine is actually
3383	dissociated from the given session on the server.
3384	Returned only when this session is a direct one.
3385	</desc>
3386	</param>
3387	</method>
3388
3389	<method name="beginSavingState">
3390	<desc>
3391	Called by the VM process to inform the server it wants to
3392	save the current state and stop the VM execution.
3393	</desc>
3394	<param name="progress" type="IProgress" dir="out">
3395	<desc>
3396	Progress object created by VBoxSVC to wait until
3397	the state is saved.
3398	</desc>
3399	</param>
3400	<param name="stateFilePath" type="wstring" dir="out">
3401	<desc>
3402	File path the VM process must save the execution state to.
3403	</desc>
3404	</param>
3405	</method>
3406
3407	<method name="endSavingState">
3408	<desc>
3409	Called by the VM process to inform the server that saving
3410	the state previously requested by #beginSavingState is either
3411	successfully finished or there was a failure.
3412
3413	<result name="VBOX_E_FILE_ERROR">
3414	Settings file not accessible.
3415	</result>
3416	<result name="VBOX_E_XML_ERROR">
3417	Could not parse the settings file.
3418	</result>
3419
3420	</desc>
3421
3422	<param name="result" type="long" dir="in">
3423	<desc>@c S_OK to indicate success.
3424	</desc>
3425	</param>
3426	<param name="errMsg" type="wstring" dir="in">
3427	<desc>@c human readable error message in case of failure.
3428	</desc>
3429	</param>
3430	</method>
3431
3432	<method name="adoptSavedState">
3433	<desc>
3434	Gets called by <link to="IConsole::adoptSavedState"/>.
3435	<result name="VBOX_E_FILE_ERROR">
3436	Invalid saved state file path.
3437	</result>
3438	</desc>
3439	<param name="savedStateFile" type="wstring" dir="in">
3440	<desc>Path to the saved state file to adopt.</desc>
3441	</param>
3442	</method>
3443
3444	<method name="beginTakingSnapshot">
3445	<desc>
3446	Called from the VM process to request from the server to perform the
3447	server-side actions of creating a snapshot (creating differencing images
3448	and the snapshot object).
3449
3450	<result name="VBOX_E_FILE_ERROR">
3451	Settings file not accessible.
3452	</result>
3453	<result name="VBOX_E_XML_ERROR">
3454	Could not parse the settings file.
3455	</result>
3456	</desc>
3457	<param name="initiator" type="IConsole" dir="in">
3458	<desc>The console object that initiated this call.</desc>
3459	</param>
3460	<param name="name" type="wstring" dir="in">
3461	<desc>Snapshot name.</desc>
3462	</param>
3463	<param name="description" type="wstring" dir="in">
3464	<desc>Snapshot description.</desc>
3465	</param>
3466	<param name="consoleProgress" type="IProgress" dir="in">
3467	<desc>
3468	Progress object created by the VM process tracking the
3469	snapshot's progress. This has the following sub-operations:
3470	<ul>
3471	<li>setting up (weight 1);</li>
3472	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3473	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3474	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3475	<li>finishing up (weight 1)</li>
3476	</ul>
3477	</desc>
3478	</param>
3479	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3480	<desc>
3481	Whether this is an online snapshot (i.e. the machine is running).
3482	</desc>
3483	</param>
3484	<param name="stateFilePath" type="wstring" dir="out">
3485	<desc>
3486	File path the VM process must save the execution state to.
3487	</desc>
3488	</param>
3489	</method>
3490
3491	<method name="endTakingSnapshot">
3492	<desc>
3493	Called by the VM process to inform the server that the snapshot
3494	previously requested by #beginTakingSnapshot is either
3495	successfully taken or there was a failure.
3496	</desc>
3497
3498	<param name="success" type="boolean" dir="in">
3499	<desc>@c true to indicate success and @c false otherwise</desc>
3500	</param>
3501	</method>
3502
3503	<method name="deleteSnapshot">
3504	<desc>
3505	Gets called by <link to="IConsole::deleteSnapshot"/>,
3506	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3507	<link to="IConsole::deleteSnapshotRange"/>.
3508	<result name="VBOX_E_INVALID_OBJECT_STATE">
3509	Snapshot has more than one child snapshot. Only possible if the
3510	delete operation does not delete all children or the range does
3511	not meet the linearity condition.
3512	</result>
3513	</desc>
3514	<param name="initiator" type="IConsole" dir="in">
3515	<desc>The console object that initiated this call.</desc>
3516	</param>
3517	<param name="startId" type="uuid" mod="string" dir="in">
3518	<desc>UUID of the first snapshot to delete.</desc>
3519	</param>
3520	<param name="endId" type="uuid" mod="string" dir="in">
3521	<desc>UUID of the last snapshot to delete.</desc>
3522	</param>
3523	<param name="deleteAllChildren" type="boolean" dir="in">
3524	<desc>Whether all children should be deleted.</desc>
3525	</param>
3526	<param name="machineState" type="MachineState" dir="out">
3527	<desc>New machine state after this operation is started.</desc>
3528	</param>
3529	<param name="progress" type="IProgress" dir="return">
3530	<desc>Progress object to track the operation completion.</desc>
3531	</param>
3532	</method>
3533
3534	<method name="finishOnlineMergeMedium">
3535	<desc>
3536	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3537	</desc>
3538	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3539	<desc>The medium attachment which needs to be cleaned up.</desc>
3540	</param>
3541	<param name="source" type="IMedium" dir="in">
3542	<desc>Merge source medium.</desc>
3543	</param>
3544	<param name="target" type="IMedium" dir="in">
3545	<desc>Merge target medium.</desc>
3546	</param>
3547	<param name="mergeForward" type="boolean" dir="in">
3548	<desc>Merge direction.</desc>
3549	</param>
3550	<param name="parentForTarget" type="IMedium" dir="in">
3551	<desc>For forward merges: new parent for target medium.</desc>
3552	</param>
3553	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3554	<desc>For backward merges: list of media which need their parent UUID
3555	updated.</desc>
3556	</param>
3557	</method>
3558
3559	<method name="restoreSnapshot">
3560	<desc>
3561	Gets called by <link to="IConsole::restoreSnapshot"/>.
3562	</desc>
3563	<param name="initiator" type="IConsole" dir="in">
3564	<desc>The console object that initiated this call.</desc>
3565	</param>
3566	<param name="snapshot" type="ISnapshot" dir="in">
3567	<desc>The snapshot to restore the VM state from.</desc>
3568	</param>
3569	<param name="machineState" type="MachineState" dir="out">
3570	<desc>New machine state after this operation is started.</desc>
3571	</param>
3572	<param name="progress" type="IProgress" dir="return">
3573	<desc>Progress object to track the operation completion.</desc>
3574	</param>
3575	</method>
3576
3577	<method name="pullGuestProperties">
3578	<desc>
3579	Get the list of the guest properties matching a set of patterns along
3580	with their values, time stamps and flags and give responsibility for
3581	managing properties to the console.
3582	</desc>
3583	<param name="names" type="wstring" dir="out" safearray="yes">
3584	<desc>
3585	The names of the properties returned.
3586	</desc>
3587	</param>
3588	<param name="values" type="wstring" dir="out" safearray="yes">
3589	<desc>
3590	The values of the properties returned. The array entries match the
3591	corresponding entries in the @a name array.
3592	</desc>
3593	</param>
3594	<param name="timestamps" type="long long" dir="out" safearray="yes">
3595	<desc>
3596	The time stamps of the properties returned. The array entries match
3597	the corresponding entries in the @a name array.
3598	</desc>
3599	</param>
3600	<param name="flags" type="wstring" dir="out" safearray="yes">
3601	<desc>
3602	The flags of the properties returned. The array entries match the
3603	corresponding entries in the @a name array.
3604	</desc>
3605	</param>
3606	</method>
3607
3608	<method name="pushGuestProperty">
3609	<desc>
3610	Update a single guest property in IMachine.
3611	</desc>
3612	<param name="name" type="wstring" dir="in">
3613	<desc>
3614	The name of the property to be updated.
3615	</desc>
3616	</param>
3617	<param name="value" type="wstring" dir="in">
3618	<desc>
3619	The value of the property.
3620	</desc>
3621	</param>
3622	<param name="timestamp" type="long long" dir="in">
3623	<desc>
3624	The timestamp of the property.
3625	</desc>
3626	</param>
3627	<param name="flags" type="wstring" dir="in">
3628	<desc>
3629	The flags of the property.
3630	</desc>
3631	</param>
3632	</method>
3633
3634	<method name="lockMedia">
3635	<desc>
3636	Locks all media attached to the machine for writing and parents of
3637	attached differencing media (if any) for reading. This operation is
3638	atomic so that if it fails no media is actually locked.
3639
3640	This method is intended to be called when the machine is in Starting or
3641	Restoring state. The locked media will be automatically unlocked when
3642	the machine is powered off or crashed.
3643	</desc>
3644	</method>
3645	<method name="unlockMedia">
3646	<desc>
3647	Unlocks all media previously locked using
3648	<link to="IInternalMachineControl::lockMedia"/>.
3649
3650	This method is intended to be used with teleportation so that it is
3651	possible to teleport between processes on the same machine.
3652	</desc>
3653	</method>
3654
3655	<method name="ejectMedium">
3656	<desc>
3657	Tells VBoxSVC that the guest has ejected the medium associated with
3658	the medium attachment.
3659	</desc>
3660	<param name="attachment" type="IMediumAttachment" dir="in">
3661	<desc>
3662	The medium attachment where the eject happened.
3663	</desc>
3664	</param>
3665	<param name="newAttachment" type="IMediumAttachment" dir="return">
3666	<desc>
3667	A new reference to the medium attachment, as the config change can
3668	result in the creation of a new instance.
3669	</desc>
3670	</param>
3671	</method>
3672
3673	<method name="reportVmStatistics">
3674	<desc>
3675	Passes statistics collected by VM (including guest statistics) to VBoxSVC.
3676	</desc>
3677	<param name="validStats" type="unsigned long" dir="in">
3678	<desc>
3679	Mask defining which parameters are valid. For example: 0x11 means
3680	that cpuIdle and XXX are valid. Other parameters should be ignored.
3681	</desc>
3682	</param>
3683	<param name="cpuUser" type="unsigned long" dir="in">
3684	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3685	</param>
3686	<param name="cpuKernel" type="unsigned long" dir="in">
3687	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3688	</param>
3689	<param name="cpuIdle" type="unsigned long" dir="in">
3690	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3691	</param>
3692	<param name="memTotal" type="unsigned long" dir="in">
3693	<desc>Total amount of physical guest RAM.</desc>
3694	</param>
3695	<param name="memFree" type="unsigned long" dir="in">
3696	<desc>Free amount of physical guest RAM.</desc>
3697	</param>
3698	<param name="memBalloon" type="unsigned long" dir="in">
3699	<desc>Amount of ballooned physical guest RAM.</desc>
3700	</param>
3701	<param name="memShared" type="unsigned long" dir="in">
3702	<desc>Amount of shared physical guest RAM.</desc>
3703	</param>
3704	<param name="memCache" type="unsigned long" dir="in">
3705	<desc>Total amount of guest (disk) cache memory.</desc>
3706	</param>
3707	<param name="pagedTotal" type="unsigned long" dir="in">
3708	<desc>Total amount of space in the page file.</desc>
3709	</param>
3710	<param name="memAllocTotal" type="unsigned long" dir="in">
3711	<desc>Total amount of memory allocated by the hypervisor.</desc>
3712	</param>
3713	<param name="memFreeTotal" type="unsigned long" dir="in">
3714	<desc>Total amount of free memory available in the hypervisor.</desc>
3715	</param>
3716	<param name="memBalloonTotal" type="unsigned long" dir="in">
3717	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3718	</param>
3719	<param name="memSharedTotal" type="unsigned long" dir="in">
3720	<desc>Total amount of shared memory in the hypervisor.</desc>
3721	</param>
3722	<param name="vmNetRx" type="unsigned long" dir="in">
3723	<desc>Network receive rate for VM.</desc>
3724	</param>
3725	<param name="vmNetTx" type="unsigned long" dir="in">
3726	<desc>Network transmit rate for VM.</desc>
3727	</param>
3728	</method>
3729	</interface>
3730
3731	<interface
3732	name="IBIOSSettings" extends="$unknown"
3733	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3734	wsmap="managed"
3735	>
3736	<desc>
3737	The IBIOSSettings interface represents BIOS settings of the virtual
3738	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3739	</desc>
3740	<attribute name="logoFadeIn" type="boolean">
3741	<desc>Fade in flag for BIOS logo animation.</desc>
3742	</attribute>
3743
3744	<attribute name="logoFadeOut" type="boolean">
3745	<desc>Fade out flag for BIOS logo animation.</desc>
3746	</attribute>
3747
3748	<attribute name="logoDisplayTime" type="unsigned long">
3749	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3750	</attribute>
3751
3752	<attribute name="logoImagePath" type="wstring">
3753	<desc>
3754	Local file system path for external BIOS splash image. Empty string
3755	means the default image is shown on boot.
3756	</desc>
3757	</attribute>
3758
3759	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3760	<desc>Mode of the BIOS boot device menu.</desc>
3761	</attribute>
3762
3763	<attribute name="ACPIEnabled" type="boolean">
3764	<desc>ACPI support flag.</desc>
3765	</attribute>
3766
3767	<attribute name="IOAPICEnabled" type="boolean">
3768	<desc>
3769	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3770	and support IRQs above 15.
3771	</desc>
3772	</attribute>
3773
3774	<attribute name="timeOffset" type="long long">
3775	<desc>
3776	Offset in milliseconds from the host system time. This allows for
3777	guests running with a different system date/time than the host.
3778	It is equivalent to setting the system date/time in the BIOS except
3779	it is not an absolute value but a relative one. Guest Additions
3780	time synchronization honors this offset.
3781	</desc>
3782	</attribute>
3783
3784	<attribute name="PXEDebugEnabled" type="boolean">
3785	<desc>
3786	PXE debug logging flag. If set, VirtualBox will write extensive
3787	PXE trace information to the release log.
3788	</desc>
3789	</attribute>
3790	</interface>
3791
3792	<interface
3793	name="IPCIAddress" extends="$unknown"
3794	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3795	wsmap="struct"
3796	>
3797
3798	<desc>
3799	Address on the PCI bus.
3800	</desc>
3801
3802	<attribute name="bus" type="short">
3803	<desc>
3804	Bus number.
3805	</desc>
3806	</attribute>
3807
3808	<attribute name="device" type="short">
3809	<desc>
3810	Device number.
3811	</desc>
3812	</attribute>
3813
3814	<attribute name="devFunction" type="short">
3815	<desc>
3816	Device function number.
3817	</desc>
3818	</attribute>
3819
3820	<method name="asLong">
3821	<desc>
3822	Convert PCI address into long.
3823	</desc>
3824	<param name="result" type="long" dir="return" />
3825	</method>
3826
3827	<method name="fromLong">
3828	<desc>
3829	Make PCI address from long.
3830	</desc>
3831	<param name="number" type="long" dir="in" />
3832	</method>
3833	</interface>
3834
3835	<interface
3836	name="IPCIDeviceAttachment" extends="$unknown"
3837	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3838	wsmap="struct"
3839	>
3840
3841	<desc>
3842	Information about PCI attachments.
3843	</desc>
3844
3845	<attribute name="name" type="wstring" readonly="yes">
3846	<desc>
3847	Device name.
3848	</desc>
3849	</attribute>
3850
3851	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3852	<desc>
3853	If this is physical or virtual device.
3854	</desc>
3855	</attribute>
3856
3857	<attribute name="hostAddress" type="long" readonly="yes">
3858	<desc>
3859	Address of device on the host, applicable only to host devices.
3860	</desc>
3861	</attribute>
3862
3863	<attribute name="guestAddress" type="long" readonly="yes">
3864	<desc>
3865	Address of device on the guest.
3866	</desc>
3867	</attribute>
3868
3869	</interface>
3870
3871	<enum
3872	name="GraphicsControllerType"
3873	uuid="79c96ca0-9f39-4900-948e-68c41cbe127a"
3874	>
3875	<desc>Graphics controller type, used with <link to="IMachine::unregister" />.
3876	</desc>
3877	<const name="Null" value="0">
3878	<desc>Reserved value, invalid.</desc>
3879	</const>
3880	<const name="VBoxVGA" value="1">
3881	<desc>Default VirtualBox VGA device.</desc>
3882	</const>
3883	</enum>
3884
3885	<enum
3886	name="CleanupMode"
3887	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3888	>
3889	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3890	</desc>
3891	<const name="UnregisterOnly" value="1">
3892	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3893	</const>
3894	<const name="DetachAllReturnNone" value="2">
3895	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3896	</const>
3897	<const name="DetachAllReturnHardDisksOnly" value="3">
3898	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3899	</const>
3900	<const name="Full" value="4">
3901	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3902	</const>
3903	</enum>
3904
3905	<enum
3906	name="CloneMode" extends="$unknown"
3907	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3908	>
3909
3910	<desc>
3911	Clone mode, used with <link to="IMachine::cloneTo" />.
3912	</desc>
3913
3914	<const name="MachineState" value="1">
3915	<desc>Clone the state of the selected machine.</desc>
3916	</const>
3917	<const name="MachineAndChildStates" value="2">
3918	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3919	</const>
3920	<const name="AllStates" value="3">
3921	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3922	</const>
3923
3924	</enum>
3925
3926	<enum
3927	name="CloneOptions" extends="$unknown"
3928	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3929	>
3930
3931	<desc>
3932	Clone options, used with <link to="IMachine::cloneTo" />.
3933	</desc>
3934
3935	<const name="Link" value="1">
3936	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3937	</const>
3938	<const name="KeepAllMACs" value="2">
3939	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3940	</const>
3941	<const name="KeepNATMACs" value="3">
3942	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3943	</const>
3944	<const name="KeepDiskNames" value="4">
3945	<desc>Don't change the disk names.</desc>
3946	</const>
3947
3948	</enum>
3949
3950	<enum
3951	name="AutostopType" extends="$unknown"
3952	uuid="6bb96740-cf34-470d-aab2-2cd48ea2e10e"
3953	>
3954
3955	<desc>
3956	Autostop types, used with <link to="IMachine::autostopType" />.
3957	</desc>
3958
3959	<const name="Disabled" value="1">
3960	<desc>Stopping the VM during system shutdown is disabled.</desc>
3961	</const>
3962	<const name="SaveState" value="2">
3963	<desc>The state of the VM will be saved when the system shuts down.</desc>
3964	</const>
3965	<const name="PowerOff" value="3">
3966	<desc>The VM is powered off when the system shuts down.</desc>
3967	</const>
3968	<const name="AcpiShutdown" value="4">
3969	<desc>An ACPI shutdown event is generated.</desc>
3970	</const>
3971
3972	</enum>
3973
3974
3975	<interface
3976	name="IMachine" extends="$unknown"
3977	uuid="d8b9ebbe-3f76-4844-af2c-accb462e64b0"
3978	wsmap="managed"
3979	>
3980	<desc>
3981	The IMachine interface represents a virtual machine, or guest, created
3982	in VirtualBox.
3983
3984	This interface is used in two contexts. First of all, a collection of
3985	objects implementing this interface is stored in the
3986	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3987	machines that are currently registered with this VirtualBox
3988	installation. Also, once a session has been opened for the given virtual
3989	machine (e.g. the virtual machine is running), the machine object
3990	associated with the open session can be queried from the session object;
3991	see <link to="ISession"/> for details.
3992
3993	The main role of this interface is to expose the settings of the virtual
3994	machine and provide methods to change various aspects of the virtual
3995	machine's configuration. For machine objects stored in the
3996	<link to="IVirtualBox::machines"/> collection, all attributes are
3997	read-only unless explicitly stated otherwise in individual attribute
3998	and method descriptions.
3999
4000	In order to change a machine setting, a session for this machine must be
4001	opened using one of the <link to="IMachine::lockMachine" /> or
4002	<link to="IMachine::launchVMProcess"/> methods. After the
4003	machine has been successfully locked for a session, a mutable machine object
4004	needs to be queried from the session object and then the desired settings
4005	changes can be applied to the returned object using IMachine attributes and
4006	methods. See the <link to="ISession"/> interface description for more
4007	information about sessions.
4008
4009	Note that IMachine does not provide methods to control virtual machine
4010	execution (such as start the machine, or power it down) -- these methods
4011	are grouped in a separate interface called <link to="IConsole" />.
4012
4013	<see><link to="ISession"/>, <link to="IConsole"/></see>
4014	</desc>
4015
4016	<attribute name="parent" type="IVirtualBox" readonly="yes">
4017	<desc>Associated parent object.</desc>
4018	</attribute>
4019
4020	<attribute name="accessible" type="boolean" readonly="yes">
4021	<desc>
4022	Whether this virtual machine is currently accessible or not.
4023
4024	A machine is always deemed accessible unless it is registered <i>and</i>
4025	its settings file cannot be read or parsed (either because the file itself
4026	is unavailable or has invalid XML contents).
4027
4028	Every time this property is read, the accessibility state of
4029	this machine is re-evaluated. If the returned value is @c false,
4030	the <link to="#accessError"/> property may be used to get the
4031	detailed error information describing the reason of
4032	inaccessibility, including XML error messages.
4033
4034	When the machine is inaccessible, only the following properties
4035	can be used on it:
4036	<ul>
4037	<li><link to="#parent"/></li>
4038	<li><link to="#id"/></li>
4039	<li><link to="#settingsFilePath"/></li>
4040	<li><link to="#accessible"/></li>
4041	<li><link to="#accessError"/></li>
4042	</ul>
4043
4044	An attempt to access any other property or method will return
4045	an error.
4046
4047	The only possible action you can perform on an inaccessible
4048	machine is to unregister it using the
4049	<link to="IMachine::unregister"/> call (or, to check
4050	for the accessibility state once more by querying this
4051	property).
4052
4053	<note>
4054	In the current implementation, once this property returns
4055	@c true, the machine will never become inaccessible
4056	later, even if its settings file cannot be successfully
4057	read/written any more (at least, until the VirtualBox
4058	server is restarted). This limitation may be removed in
4059	future releases.
4060	</note>
4061	</desc>
4062	</attribute>
4063
4064	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4065	<desc>
4066	Error information describing the reason of machine
4067	inaccessibility.
4068
4069	Reading this property is only valid after the last call to
4070	<link to="#accessible"/> returned @c false (i.e. the
4071	machine is currently inaccessible). Otherwise, a @c null
4072	IVirtualBoxErrorInfo object will be returned.
4073	</desc>
4074	</attribute>
4075
4076	<attribute name="name" type="wstring">
4077	<desc>
4078	Name of the virtual machine.
4079
4080	Besides being used for human-readable identification purposes
4081	everywhere in VirtualBox, the virtual machine name is also used
4082	as a name of the machine's settings file and as a name of the
4083	subdirectory this settings file resides in. Thus, every time you
4084	change the value of this property, the settings file will be
4085	renamed once you call <link to="#saveSettings"/> to confirm the
4086	change. The containing subdirectory will be also renamed, but
4087	only if it has exactly the same name as the settings file
4088	itself prior to changing this property (for backward compatibility
4089	with previous API releases). The above implies the following
4090	limitations:
4091	<ul>
4092	<li>The machine name cannot be empty.</li>
4093	<li>The machine name can contain only characters that are valid
4094	file name characters according to the rules of the file
4095	system used to store VirtualBox configuration.</li>
4096	<li>You cannot have two or more machines with the same name
4097	if they use the same subdirectory for storing the machine
4098	settings files.</li>
4099	<li>You cannot change the name of the machine if it is running,
4100	or if any file in the directory containing the settings file
4101	is being used by another running machine or by any other
4102	process in the host operating system at a time when
4103	<link to="#saveSettings"/> is called.
4104	</li>
4105	</ul>
4106	If any of the above limitations are hit, <link to="#saveSettings"/>
4107	will return an appropriate error message explaining the exact
4108	reason and the changes you made to this machine will not be saved.
4109
4110	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
4111	file is recommended, but not enforced. (Previous versions always
4112	used a generic ".xml" extension.)
4113	</desc>
4114	</attribute>
4115
4116	<attribute name="description" type="wstring">
4117	<desc>
4118	Description of the virtual machine.
4119
4120	The description attribute can contain any text and is
4121	typically used to describe the hardware and software
4122	configuration of the virtual machine in detail (i.e. network
4123	settings, versions of the installed software and so on).
4124	</desc>
4125	</attribute>
4126
4127	<attribute name="id" type="uuid" mod="string" readonly="yes">
4128	<desc>UUID of the virtual machine.</desc>
4129	</attribute>
4130
4131	<attribute name="groups" type="wstring" safearray="yes">
4132	<desc>
4133	Array of machine group names of which this machine is a member.
4134	<tt>""</tt> and <tt>"/"</tt> are synonyms for the toplevel group. Each
4135	group is only listed once, however they are listed in no particular
4136	order and there is no guarantee that there are no gaps in the group
4137	hierarchy (i.e. <tt>"/group"</tt>,
4138	<tt>"/group/subgroup/subsubgroup"</tt> is a valid result).
4139	</desc>
4140	</attribute>
4141
4142	<attribute name="OSTypeId" type="wstring">
4143	<desc>
4144	User-defined identifier of the Guest OS type.
4145	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4146	an IGuestOSType object representing details about the given
4147	Guest OS type.
4148	<note>
4149	This value may differ from the value returned by
4150	<link to="IGuest::OSTypeId"/> if Guest Additions are
4151	installed to the guest OS.
4152	</note>
4153	</desc>
4154	</attribute>
4155
4156	<attribute name="hardwareVersion" type="wstring">
4157	<desc>Hardware version identifier. Internal use only for now.</desc>
4158	</attribute>
4159
4160	<attribute name="hardwareUUID" type="uuid" mod="string">
4161	<desc>
4162	The UUID presented to the guest via memory tables, hardware and guest
4163	properties. For most VMs this is the same as the @a id, but for VMs
4164	which have been cloned or teleported it may be the same as the source
4165	VM. The latter is because the guest shouldn't notice that it was
4166	cloned or teleported.
4167	</desc>
4168	</attribute>
4169
4170	<attribute name="CPUCount" type="unsigned long">
4171	<desc>Number of virtual CPUs in the VM.</desc>
4172	</attribute>
4173
4174	<attribute name="CPUHotPlugEnabled" type="boolean">
4175	<desc>
4176	This setting determines whether VirtualBox allows CPU
4177	hotplugging for this machine.</desc>
4178	</attribute>
4179
4180	<attribute name="CPUExecutionCap" type="unsigned long">
4181	<desc>
4182	Means to limit the number of CPU cycles a guest can use. The unit
4183	is percentage of host CPU cycles per second. The valid range
4184	is 1 - 100. 100 (the default) implies no limit.
4185	</desc>
4186	</attribute>
4187
4188	<attribute name="memorySize" type="unsigned long">
4189	<desc>System memory size in megabytes.</desc>
4190	</attribute>
4191
4192	<attribute name="memoryBalloonSize" type="unsigned long">
4193	<desc>Memory balloon size in megabytes.</desc>
4194	</attribute>
4195
4196	<attribute name="pageFusionEnabled" type="boolean">
4197	<desc>
4198	This setting determines whether VirtualBox allows page
4199	fusion for this machine (64 bits host only).
4200	</desc>
4201	</attribute>
4202
4203	<attribute name="graphicsControllerType" type="GraphicsControllerType">
4204	<desc>Graphics controller type.</desc>
4205	</attribute>
4206
4207	<attribute name="VRAMSize" type="unsigned long">
4208	<desc>Video memory size in megabytes.</desc>
4209	</attribute>
4210
4211	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4212	<desc>
4213	This setting determines whether VirtualBox allows this machine to make
4214	use of the 3D graphics support available on the host.</desc>
4215	</attribute>
4216
4217	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4218	<desc>
4219	This setting determines whether VirtualBox allows this machine to make
4220	use of the 2D video acceleration support available on the host.</desc>
4221	</attribute>
4222
4223	<attribute name="monitorCount" type="unsigned long">
4224	<desc>
4225	Number of virtual monitors.
4226	<note>
4227	Only effective on Windows XP and later guests with
4228	Guest Additions installed.
4229	</note>
4230	</desc>
4231	</attribute>
4232
4233	<attribute name="VideoCaptureEnabled" type="boolean" default="false">
4234	<desc>
4235	This setting determines whether VirtualBox uses video recording to
4236	record VM session.</desc>
4237	</attribute>
4238
4239	<attribute name="VideoCaptureFile" type="wstring" default="Test.webm">
4240	<desc>
4241	This setting determines the filename VirtualBox uses to save
4242	the recorded content.</desc>
4243	</attribute>
4244
4245	<attribute name="VideoCaptureWidth" type="unsigned long" default="640">
4246	<desc>
4247	This setting determines the horizontal resolution of the recorded video.</desc>
4248	</attribute>
4249
4250	<attribute name="VideoCaptureHeight" type="unsigned long" default="480">
4251	<desc>
4252	This setting determines the vertical resolution of the recorded video.</desc>
4253	</attribute>
4254
4255	<attribute name="VideoCaptureRate" type="unsigned long" default="512">
4256	<desc>
4257	This setting determines the bitrate in kilobits per second
4258	</desc>
4259	</attribute>
4260
4261	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4262	<desc>Object containing all BIOS settings.</desc>
4263	</attribute>
4264
4265	<attribute name="firmwareType" type="FirmwareType">
4266	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4267	bootstrap in this VM.</desc>
4268	</attribute>
4269
4270	<attribute name="pointingHIDType" type="PointingHIDType">
4271	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4272	The default is typically "PS2Mouse" but can vary depending on the
4273	requirements of the guest operating system.</desc>
4274	</attribute>
4275
4276	<attribute name="keyboardHIDType" type="KeyboardHIDType">
4277	<desc>Type of keyboard HID used in this VM.
4278	The default is typically "PS2Keyboard" but can vary depending on the
4279	requirements of the guest operating system.</desc>
4280	</attribute>
4281
4282	<attribute name="HPETEnabled" type="boolean">
4283	<desc>This attribute controls if High Precision Event Timer (HPET) is
4284	enabled in this VM. Use this property if you want to provide guests
4285	with additional time source, or if guest requires HPET to function correctly.
4286	Default is false.</desc>
4287	</attribute>
4288
4289	<attribute name="chipsetType" type="ChipsetType">
4290	<desc>Chipset type used in this VM.</desc>
4291	</attribute>
4292
4293	<attribute name="snapshotFolder" type="wstring">
4294	<desc>
4295	Full path to the directory used to store snapshot data
4296	(differencing media and saved state files) of this machine.
4297
4298	The initial value of this property is
4299	<tt><</tt><link to="#settingsFilePath">
4300	path_to_settings_file</link><tt>>/<</tt>
4301	<link to="#id">machine_uuid</link>
4302	<tt>></tt>.
4303
4304	Currently, it is an error to try to change this property on
4305	a machine that has snapshots (because this would require to
4306	move possibly large files to a different location).
4307	A separate method will be available for this purpose later.
4308
4309	<note>
4310	Setting this property to @c null or to an empty string will restore
4311	the initial value.
4312	</note>
4313	<note>
4314	When setting this property, the specified path can be
4315	absolute (full path) or relative to the directory where the
4316	<link to="#settingsFilePath">machine settings file</link>
4317	is located. When reading this property, a full path is
4318	always returned.
4319	</note>
4320	<note>
4321	The specified path may not exist, it will be created
4322	when necessary.
4323	</note>
4324	</desc>
4325	</attribute>
4326
4327	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4328	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4329	</attribute>
4330
4331	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4332	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4333
4334	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4335	<desc>Array of media attached to this machine.</desc>
4336	</attribute>
4337
4338	<attribute name="USBController" type="IUSBController" readonly="yes">
4339	<desc>
4340	Associated USB controller object.
4341
4342	<note>
4343	If USB functionality is not available in the given edition of
4344	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4345	</note>
4346	</desc>
4347	</attribute>
4348
4349	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4350	<desc>Associated audio adapter, always present.</desc>
4351	</attribute>
4352
4353	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4354	<desc>Array of storage controllers attached to this machine.</desc>
4355	</attribute>
4356
4357	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4358	<desc>
4359	Full name of the file containing machine settings data.
4360	</desc>
4361	</attribute>
4362
4363	<attribute name="settingsModified" type="boolean" readonly="yes">
4364	<desc>
4365	Whether the settings of this machine have been modified
4366	(but neither yet saved nor discarded).
4367	<note>
4368	Reading this property is only valid on instances returned
4369	by <link to="ISession::machine"/> and on new machines
4370	created by <link to="IVirtualBox::createMachine"/> or opened
4371	by <link to="IVirtualBox::openMachine"/> but not
4372	yet registered, or on unregistered machines after calling
4373	<link to="IMachine::unregister"/>. For all other
4374	cases, the settings can never be modified.
4375	</note>
4376	<note>
4377	For newly created unregistered machines, the value of this
4378	property is always @c true until <link to="#saveSettings"/>
4379	is called (no matter if any machine settings have been
4380	changed after the creation or not). For opened machines
4381	the value is set to @c false (and then follows to normal rules).
4382	</note>
4383	</desc>
4384	</attribute>
4385
4386	<attribute name="sessionState" type="SessionState" readonly="yes">
4387	<desc>Current session state for this machine.</desc>
4388	</attribute>
4389
4390	<attribute name="sessionType" type="wstring" readonly="yes">
4391	<desc>
4392	Type of the session. If <link to="#sessionState"/> is
4393	Spawning or Locked, this attribute contains the
4394	same value as passed to the
4395	<link to="IMachine::launchVMProcess"/> method in the
4396	@a type parameter. If the session was used with
4397	<link to="IMachine::lockMachine" />, or if
4398	<link to="#sessionState"/> is SessionClosed, the value of this
4399	attribute is an empty string.
4400	</desc>
4401	</attribute>
4402
4403	<attribute name="sessionPID" type="unsigned long" readonly="yes">
4404	<desc>
4405	Identifier of the session process. This attribute contains the
4406	platform-dependent identifier of the process whose session was
4407	used with <link to="IMachine::lockMachine" /> call. The returned
4408	value is only valid if <link to="#sessionState"/> is Locked or
4409	Unlocking by the time this property is read.
4410	</desc>
4411	</attribute>
4412
4413	<attribute name="state" type="MachineState" readonly="yes">
4414	<desc>Current execution state of this machine.</desc>
4415	</attribute>
4416
4417	<attribute name="lastStateChange" type="long long" readonly="yes">
4418	<desc>
4419	Time stamp of the last execution state change,
4420	in milliseconds since 1970-01-01 UTC.
4421	</desc>
4422	</attribute>
4423
4424	<attribute name="stateFilePath" type="wstring" readonly="yes">
4425	<desc>
4426	Full path to the file that stores the execution state of
4427	the machine when it is in the <link to="MachineState_Saved"/> state.
4428	<note>
4429	When the machine is not in the Saved state, this attribute is
4430	an empty string.
4431	</note>
4432	</desc>
4433	</attribute>
4434
4435	<attribute name="logFolder" type="wstring" readonly="yes">
4436	<desc>
4437	Full path to the folder that stores a set of rotated log files
4438	recorded during machine execution. The most recent log file is
4439	named <tt>VBox.log</tt>, the previous log file is
4440	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4441	in the current version).
4442	</desc>
4443	</attribute>
4444
4445	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4446	<desc>
4447	Current snapshot of this machine. This is @c null if the machine
4448	currently has no snapshots. If it is not @c null, then it was
4449	set by one of <link to="IConsole::takeSnapshot" />,
4450	<link to="IConsole::deleteSnapshot" />
4451	or <link to="IConsole::restoreSnapshot" />, depending on which
4452	was called last. See <link to="ISnapshot"/> for details.
4453	</desc>
4454	</attribute>
4455
4456	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4457	<desc>
4458	Number of snapshots taken on this machine. Zero means the
4459	machine doesn't have any snapshots.
4460	</desc>
4461	</attribute>
4462
4463	<attribute name="currentStateModified" type="boolean" readonly="yes">
4464	<desc>
4465	Returns @c true if the current state of the machine is not
4466	identical to the state stored in the current snapshot.
4467
4468	The current state is identical to the current snapshot only
4469	directly after one of the following calls are made:
4470
4471	<ul>
4472	<li><link to="IConsole::restoreSnapshot"/>
4473	</li>
4474	<li><link to="IConsole::takeSnapshot"/> (issued on a
4475	"powered off" or "saved" machine, for which
4476	<link to="#settingsModified"/> returns @c false)
4477	</li>
4478	</ul>
4479
4480	The current state remains identical until one of the following
4481	happens:
4482	<ul>
4483	<li>settings of the machine are changed</li>
4484	<li>the saved state is deleted</li>
4485	<li>the current snapshot is deleted</li>
4486	<li>an attempt to execute the machine is made</li>
4487	</ul>
4488
4489	<note>
4490	For machines that don't have snapshots, this property is
4491	always @c false.
4492	</note>
4493	</desc>
4494	</attribute>
4495
4496	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4497	<desc>
4498	Collection of shared folders for this machine (permanent shared
4499	folders). These folders are shared automatically at machine startup
4500	and available only to the guest OS installed within this machine.
4501
4502	New shared folders are added to the collection using
4503	<link to="#createSharedFolder"/>. Existing shared folders can be
4504	removed using <link to="#removeSharedFolder"/>.
4505	</desc>
4506	</attribute>
4507
4508	<attribute name="clipboardMode" type="ClipboardMode">
4509	<desc>
4510	Synchronization mode between the host OS clipboard
4511	and the guest OS clipboard.
4512	</desc>
4513	</attribute>
4514
4515	<attribute name="dragAndDropMode" type="DragAndDropMode">
4516	<desc>
4517	Which mode is allowed for drag'n'drop.
4518	</desc>
4519	</attribute>
4520
4521	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4522	<desc>
4523	A comma-separated list of simple glob patterns. Changes to guest
4524	properties whose name matches one of the patterns will generate an
4525	<link to="IGuestPropertyChangedEvent"/> signal.
4526	</desc>
4527	</attribute>
4528
4529	<attribute name="teleporterEnabled" type="boolean">
4530	<desc>
4531	When set to @a true, the virtual machine becomes a target teleporter
4532	the next time it is powered on. This can only set to @a true when the
4533	VM is in the @a PoweredOff or @a Aborted state.
4534
4535	<!-- This property is automatically set to @a false when the VM is powered
4536	on. (bird: This doesn't work yet ) -->
4537	</desc>
4538	</attribute>
4539
4540	<attribute name="teleporterPort" type="unsigned long">
4541	<desc>
4542	The TCP port the target teleporter will listen for incoming
4543	teleportations on.
4544
4545	0 means the port is automatically selected upon power on. The actual
4546	value can be read from this property while the machine is waiting for
4547	incoming teleportations.
4548	</desc>
4549	</attribute>
4550
4551	<attribute name="teleporterAddress" type="wstring">
4552	<desc>
4553	The address the target teleporter will listen on. If set to an empty
4554	string, it will listen on all addresses.
4555	</desc>
4556	</attribute>
4557
4558	<attribute name="teleporterPassword" type="wstring">
4559	<desc>
4560	The password to check for on the target teleporter. This is just a
4561	very basic measure to prevent simple hacks and operators accidentally
4562	beaming a virtual machine to the wrong place.
4563
4564	Note that you SET a plain text password while reading back a HASHED
4565	password. Setting a hashed password is currently not supported.
4566	</desc>
4567	</attribute>
4568
4569	<attribute name="faultToleranceState" type="FaultToleranceState">
4570	<desc>
4571	Fault tolerance state; disabled, source or target.
4572	This property can be changed at any time. If you change it for a running
4573	VM, then the fault tolerance address and port must be set beforehand.
4574	</desc>
4575	</attribute>
4576
4577	<attribute name="faultTolerancePort" type="unsigned long">
4578	<desc>
4579	The TCP port the fault tolerance source or target will use for
4580	communication.
4581	</desc>
4582	</attribute>
4583
4584	<attribute name="faultToleranceAddress" type="wstring">
4585	<desc>
4586	The address the fault tolerance source or target.
4587	</desc>
4588	</attribute>
4589
4590	<attribute name="faultTolerancePassword" type="wstring">
4591	<desc>
4592	The password to check for on the standby VM. This is just a
4593	very basic measure to prevent simple hacks and operators accidentally
4594	choosing the wrong standby VM.
4595	</desc>
4596	</attribute>
4597
4598	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4599	<desc>
4600	The interval in ms used for syncing the state between source and target.
4601	</desc>
4602	</attribute>
4603
4604	<attribute name="RTCUseUTC" type="boolean">
4605	<desc>
4606	When set to @a true, the RTC device of the virtual machine will run
4607	in UTC time, otherwise in local time. Especially Unix guests prefer
4608	the time in UTC.
4609	</desc>
4610	</attribute>
4611
4612	<attribute name="IOCacheEnabled" type="boolean">
4613	<desc>
4614	When set to @a true, the builtin I/O cache of the virtual machine
4615	will be enabled.
4616	</desc>
4617	</attribute>
4618
4619	<attribute name="IOCacheSize" type="unsigned long">
4620	<desc>
4621	Maximum size of the I/O cache in MB.
4622	</desc>
4623	</attribute>
4624
4625	<attribute name="PCIDeviceAssignments" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
4626	<desc>Array of PCI devices assigned to this machine, to get list of all
4627	PCI devices attached to the machine use
4628	<link to="IConsole::attachedPCIDevices"/> attribute, as this attribute
4629	is intended to list only devices additional to what described in
4630	virtual hardware config. Usually, this list keeps host's physical
4631	devices assigned to the particular machine.
4632	</desc>
4633	</attribute>
4634
4635	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4636	<desc>
4637	Bandwidth control manager.
4638	</desc>
4639	</attribute>
4640
4641	<attribute name="tracingEnabled" type="boolean">
4642	<desc>
4643	Enables the tracing facility in the VMM (including PDM devices +
4644	drivers). The VMM will consume about 0.5MB of more memory when
4645	enabled and there may be some extra overhead from tracepoints that are
4646	always enabled.
4647	</desc>
4648	</attribute>
4649
4650	<attribute name="tracingConfig" type="wstring">
4651	<desc>
4652	Tracepoint configuration to apply at startup when
4653	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4654	a space separated of tracepoint group names to enable. The special
4655	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4656	more details on available tracepoint groups and such.
4657
4658	Note that on hosts supporting DTrace (or similar), a lot of the
4659	tracepoints may be implemented exclusivly as DTrace probes. So, the
4660	effect of the same config may differ between Solaris and Windows for
4661	example.
4662	</desc>
4663	</attribute>
4664
4665	<attribute name="allowTracingToAccessVM" type="boolean">
4666	<desc>
4667	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4668	structures when firing off trace points. This is especially useful
4669	with DTrace tracepoints, as it allows you to use the VMCPU or VM
4670	pointer to obtain useful information such as guest register state.
4671
4672	This is disabled by default because devices and drivers normally has no
4673	business accessing the VMCPU or VM structures, and are therefore unable
4674	to get any pointers to these.
4675	</desc>
4676	</attribute>
4677
4678	<attribute name="autostartEnabled" type="boolean">
4679	<desc>
4680	Enables autostart of the VM during system boot.
4681	</desc>
4682	</attribute>
4683
4684	<attribute name="autostartDelay" type="unsigned long">
4685	<desc>
4686	Number of seconds to wait until the VM should be started during system boot.
4687	</desc>
4688	</attribute>
4689
4690	<attribute name="autostopType" type="AutostopType">
4691	<desc>
4692	Action type to do when the system is shutting down.
4693	</desc>
4694	</attribute>
4695
4696	<attribute name="defaultFrontend" type="wstring">
4697	<desc>
4698	Selects which VM frontend should be used by default when launching
4699	this VM through the <link to="IMachine::launchVMProcess" /> method.
4700	Empty or @c null strings do not define a particular default, it is up
4701	to <link to="IMachine::launchVMProcess" /> to select one. See the
4702	description of <link to="IMachine::launchVMProcess" /> for the valid
4703	frontend types.
4704
4705	This per-VM setting overrides the default defined by
4706	<link to="ISystemProperties::defaultFrontend" /> attribute, and is
4707	overridden by a frontend type passed to
4708	<link to="IMachine::launchVMProcess" />.
4709	</desc>
4710	</attribute>
4711
4712	<method name="lockMachine">
4713	<desc>
4714	Locks the machine for the given session to enable the caller
4715	to make changes to the machine or start the VM or control
4716	VM execution.
4717
4718	There are two ways to lock a machine for such uses:
4719
4720	<ul>
4721	<li>If you want to make changes to the machine settings,
4722	you must obtain an exclusive write lock on the machine
4723	by setting @a lockType to @c Write.
4724
4725	This will only succeed if no other process has locked
4726	the machine to prevent conflicting changes. Only after
4727	an exclusive write lock has been obtained using this method, one
4728	can change all VM settings or execute the VM in the process
4729	space of the session object. (Note that the latter is only of
4730	interest if you actually want to write a new front-end for
4731	virtual machines; but this API gets called internally by
4732	the existing front-ends such as VBoxHeadless and the VirtualBox
4733	GUI to acquire a write lock on the machine that they are running.)
4734
4735	On success, write-locking the machine for a session creates
4736	a second copy of the IMachine object. It is this second object
4737	upon which changes can be made; in VirtualBox terminology, the
4738	second copy is "mutable". It is only this second, mutable machine
4739	object upon which you can call methods that change the
4740	machine state. After having called this method, you can
4741	obtain this second, mutable machine object using the
4742	<link to="ISession::machine" /> attribute.
4743	</li>
4744	<li>If you only want to check the machine state or control
4745	machine execution without actually changing machine
4746	settings (e.g. to get access to VM statistics or take
4747	a snapshot or save the machine state), then set the
4748	@a lockType argument to @c Shared.
4749
4750	If no other session has obtained a lock, you will obtain an
4751	exclusive write lock as described above. However, if another
4752	session has already obtained such a lock, then a link to that
4753	existing session will be established which allows you
4754	to control that existing session.
4755
4756	To find out which type of lock was obtained, you can
4757	inspect <link to="ISession::type" />, which will have been
4758	set to either @c WriteLock or @c Shared.
4759	</li>
4760	</ul>
4761
4762	In either case, you can get access to the <link to="IConsole" />
4763	object which controls VM execution.
4764
4765	Also in all of the above cases, one must always call
4766	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4767	the machine's state will eventually be set to "Aborted".
4768
4769	To change settings on a machine, the following sequence is typically
4770	performed:
4771
4772	<ol>
4773	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4774
4775	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4776
4777	<li>Change the settings of the machine by invoking IMachine methods.</li>
4778
4779	<li>Call <link to="IMachine::saveSettings" />.</li>
4780
4781	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4782	</ol>
4783
4784	<result name="E_UNEXPECTED">
4785	Virtual machine not registered.
4786	</result>
4787	<result name="E_ACCESSDENIED">
4788	Process not started by OpenRemoteSession.
4789	</result>
4790	<result name="VBOX_E_INVALID_OBJECT_STATE">
4791	Session already open or being opened.
4792	</result>
4793	<result name="VBOX_E_VM_ERROR">
4794	Failed to assign machine to session.
4795	</result>
4796	</desc>
4797	<param name="session" type="ISession" dir="in">
4798	<desc>
4799	Session object for which the machine will be locked.
4800	</desc>
4801	</param>
4802	<param name="lockType" type="LockType" dir="in">
4803	<desc>
4804	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4805	If set to @c Shared, then either acquire an exclusive write lock or establish
4806	a link to an existing session.
4807	</desc>
4808	</param>
4809	</method>
4810
4811	<method name="launchVMProcess">
4812	<desc>
4813	Spawns a new process that will execute the virtual machine and obtains a shared
4814	lock on the machine for the calling session.
4815
4816	If launching the VM succeeds, the new VM process will create its own session
4817	and write-lock the machine for it, preventing conflicting changes from other
4818	processes. If the machine is already locked (because it is already running or
4819	because another session has a write lock), launching the VM process will therefore
4820	fail. Reversely, future attempts to obtain a write lock will also fail while the
4821	machine is running.
4822
4823	The caller's session object remains separate from the session opened by the new
4824	VM process. It receives its own <link to="IConsole" /> object which can be used
4825	to control machine execution, but it cannot be used to change all VM settings
4826	which would be available after a <link to="#lockMachine" /> call.
4827
4828	The caller must eventually release the session's shared lock by calling
4829	<link to="ISession::unlockMachine" /> on the local session object once this call
4830	has returned. However, the session's state (see <link to="ISession::state" />)
4831	will not return to "Unlocked" until the remote session has also unlocked
4832	the machine (i.e. the machine has stopped running).
4833
4834	Launching a VM process can take some time (a new VM is started in a new process,
4835	for which memory and other resources need to be set up). Because of this,
4836	an <link to="IProgress" /> object is returned to allow the caller to wait
4837	for this asynchronous operation to be completed. Until then, the caller's
4838	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4839	and <link to="ISession::console" /> attributes cannot be accessed.
4840	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4841	similar calls to wait for completion. Completion is signalled when the VM
4842	is powered on. If launching the VM fails, error messages can be queried
4843	via the progress object, if available.
4844
4845	The progress object will have at least 2 sub-operations. The first
4846	operation covers the period up to the new VM process calls powerUp.
4847	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4848	progress object. Because <link to="IConsole::powerUp"/> may require
4849	some extra sub-operations, the <link to="IProgress::operationCount"/>
4850	may change at the completion of operation.
4851
4852	For details on the teleportation progress operation, see
4853	<link to="IConsole::powerUp"/>.
4854
4855	The @a environment argument is a string containing definitions of
4856	environment variables in the following format:
4857	<pre>
4858	NAME[=VALUE]\n
4859	NAME[=VALUE]\n
4860	...
4861	</pre>
4862	where <tt>\\n</tt> is the new line character. These environment
4863	variables will be appended to the environment of the VirtualBox server
4864	process. If an environment variable exists both in the server process
4865	and in this list, the value from this list takes precedence over the
4866	server's variable. If the value of the environment variable is
4867	omitted, this variable will be removed from the resulting environment.
4868	If the environment string is @c null or empty, the server environment
4869	is inherited by the started process as is.
4870
4871	<result name="E_UNEXPECTED">
4872	Virtual machine not registered.
4873	</result>
4874	<result name="E_INVALIDARG">
4875	Invalid session type @a type.
4876	</result>
4877	<result name="VBOX_E_OBJECT_NOT_FOUND">
4878	No machine matching @a machineId found.
4879	</result>
4880	<result name="VBOX_E_INVALID_OBJECT_STATE">
4881	Session already open or being opened.
4882	</result>
4883	<result name="VBOX_E_IPRT_ERROR">
4884	Launching process for machine failed.
4885	</result>
4886	<result name="VBOX_E_VM_ERROR">
4887	Failed to assign machine to session.
4888	</result>
4889	</desc>
4890	<param name="session" type="ISession" dir="in">
4891	<desc>
4892	Client session object to which the VM process will be connected (this
4893	must be in "Unlocked" state).
4894	</desc>
4895	</param>
4896	<param name="type" type="wstring" dir="in">
4897	<desc>
4898	Front-end to use for the new VM process. The following are currently supported:
4899	<ul>
4900	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4901	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4902	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4903	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4904	the currently running VM or session owner. In this case the
4905	@a session parameter may be @c null (if it is non-null it isn't
4906	used in any way), and the @a progress return value will be always
4907	@c null. The operation completes immediately.</li>
4908	<li><tt>""</tt>: use the per-VM default frontend if set, otherwise
4909	the global default defined in the system properties. If neither
4910	are set, the API will launch a <tt>"gui"</tt> session, which may
4911	fail if there is no windowing environment available. See
4912	<link to="IMachine::defaultFrontend"/> and
4913	<link to="ISystemProperties::defaultFrontend"/>.</li>
4914	</ul>
4915	</desc>
4916	</param>
4917	<param name="environment" type="wstring" dir="in">
4918	<desc>
4919	Environment to pass to the VM process.
4920	</desc>
4921	</param>
4922	<param name="progress" type="IProgress" dir="return">
4923	<desc>Progress object to track the operation completion.</desc>
4924	</param>
4925	</method>
4926
4927	<method name="setBootOrder">
4928	<desc>
4929	Puts the given device to the specified position in
4930	the boot order.
4931
4932	To indicate that no device is associated with the given position,
4933	<link to="DeviceType_Null"/> should be used.
4934
4935	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4936
4937	<result name="E_INVALIDARG">
4938	Boot @a position out of range.
4939	</result>
4940	<result name="E_NOTIMPL">
4941	Booting from USB @a device currently not supported.
4942	</result>
4943
4944	</desc>
4945	<param name="position" type="unsigned long" dir="in">
4946	<desc>
4947	Position in the boot order (@c 1 to the total number of
4948	devices the machine can boot from, as returned by
4949	<link to="ISystemProperties::maxBootPosition"/>).
4950	</desc>
4951	</param>
4952	<param name="device" type="DeviceType" dir="in">
4953	<desc>
4954	The type of the device used to boot at the given position.
4955	</desc>
4956	</param>
4957	</method>
4958
4959	<method name="getBootOrder" const="yes">
4960	<desc>
4961	Returns the device type that occupies the specified
4962	position in the boot order.
4963
4964	@todo [remove?]
4965	If the machine can have more than one device of the returned type
4966	(such as hard disks), then a separate method should be used to
4967	retrieve the individual device that occupies the given position.
4968
4969	If here are no devices at the given position, then
4970	<link to="DeviceType_Null"/> is returned.
4971
4972	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4973
4974	<result name="E_INVALIDARG">
4975	Boot @a position out of range.
4976	</result>
4977
4978	</desc>
4979	<param name="position" type="unsigned long" dir="in">
4980	<desc>
4981	Position in the boot order (@c 1 to the total number of
4982	devices the machine can boot from, as returned by
4983	<link to="ISystemProperties::maxBootPosition"/>).
4984	</desc>
4985	</param>
4986	<param name="device" type="DeviceType" dir="return">
4987	<desc>
4988	Device at the given position.
4989	</desc>
4990	</param>
4991	</method>
4992
4993	<method name="attachDevice">
4994	<desc>
4995	Attaches a device and optionally mounts a medium to the given storage
4996	controller (<link to="IStorageController" />, identified by @a name),
4997	at the indicated port and device.
4998
4999	This method is intended for managing storage devices in general while a
5000	machine is powered off. It can be used to attach and detach fixed
5001	and removable media. The following kind of media can be attached
5002	to a machine:
5003
5004	<ul>
5005	<li>For fixed and removable media, you can pass in a medium that was
5006	previously opened using <link to="IVirtualBox::openMedium" />.
5007	</li>
5008
5009	<li>Only for storage devices supporting removable media (such as
5010	DVDs and floppies), you can also specify a null pointer to
5011	indicate an empty drive or one of the medium objects listed
5012	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
5013	arrays to indicate a host drive.
5014	For removable devices, you can also use <link to="IMachine::mountMedium"/>
5015	to change the media while the machine is running.
5016	</li>
5017	</ul>
5018
5019	In a VM's default configuration of virtual machines, the secondary
5020	master of the IDE controller is used for a CD/DVD drive.
5021
5022	After calling this returns successfully, a new instance of
5023	<link to="IMediumAttachment"/> will appear in the machine's list of medium
5024	attachments (see <link to="IMachine::mediumAttachments"/>).
5025
5026	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
5027	information about attaching media.
5028
5029	The specified device slot must not have a device attached to it,
5030	or this method will fail.
5031
5032	<note>
5033	You cannot attach a device to a newly created machine until
5034	this machine's settings are saved to disk using
5035	<link to="#saveSettings"/>.
5036	</note>
5037	<note>
5038	If the medium is being attached indirectly, a new differencing medium
5039	will implicitly be created for it and attached instead. If the
5040	changes made to the machine settings (including this indirect
5041	attachment) are later cancelled using <link to="#discardSettings"/>,
5042	this implicitly created differencing medium will implicitly
5043	be deleted.
5044	</note>
5045
5046	<result name="E_INVALIDARG">
5047	SATA device, SATA port, IDE port or IDE slot out of range, or
5048	file or UUID not found.
5049	</result>
5050	<result name="VBOX_E_INVALID_OBJECT_STATE">
5051	Machine must be registered before media can be attached.
5052	</result>
5053	<result name="VBOX_E_INVALID_VM_STATE">
5054	Invalid machine state.
5055	</result>
5056	<result name="VBOX_E_OBJECT_IN_USE">
5057	A medium is already attached to this or another virtual machine.
5058	</result>
5059
5060	</desc>
5061	<param name="name" type="wstring" dir="in">
5062	<desc>Name of the storage controller to attach the device to.</desc>
5063	</param>
5064	<param name="controllerPort" type="long" dir="in">
5065	<desc>Port to attach the device to. For an IDE controller, 0 specifies
5066	the primary controller and 1 specifies the secondary controller.
5067	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
5068	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
5069	</param>
5070	<param name="device" type="long" dir="in">
5071	<desc>Device slot in the given port to attach the device to. This is only
5072	relevant for IDE controllers, for which 0 specifies the master device and
5073	1 specifies the slave device. For all other controller types, this must
5074	be 0.</desc>
5075	</param>
5076	<param name="type" type="DeviceType" dir="in">
5077	<desc>Device type of the attached device. For media opened by
5078	<link to="IVirtualBox::openMedium" />, this must match the device type
5079	specified there.</desc>
5080	</param>
5081	<param name="medium" type="IMedium" dir="in">
5082	<desc>Medium to mount or @c null for an empty drive.</desc>
5083	</param>
5084	</method>
5085
5086	<method name="attachDeviceWithoutMedium">
5087	<desc>
5088	Attaches a device and optionally mounts a medium to the given storage
5089	controller (<link to="IStorageController" />, identified by @a name),
5090	at the indicated port and device.
5091
5092	This method is intended for managing storage devices in general while a
5093	machine is powered off. It can be used to attach and detach fixed
5094	and removable media. The following kind of media can be attached
5095	to a machine:
5096	<ul>
5097	<li>
5098	For fixed and removable media, you can pass in a medium that was
5099	previously opened using <link to="IVirtualBox::openMedium" />.
5100	</li>
5101
5102	<li>Only for storage devices supporting removable media (such as
5103	DVDs and floppies) with an empty drive or one of the medium objects listed
5104	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
5105	arrays to indicate a host drive.
5106	For removable devices, you can also use <link to="IMachine::mountMedium"/>
5107	to change the media while the machine is running.
5108	</li>
5109	</ul>
5110
5111	In a VM's default configuration of virtual machines, the secondary
5112	master of the IDE controller is used for a CD/DVD drive.
5113	<link to="IMediumAttachment"/> will appear in the machine's list of medium
5114	attachments (see <link to="IMachine::mediumAttachments"/>).
5115
5116	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
5117	information about attaching media.
5118
5119	The specified device slot must not have a device attached to it,
5120	or this method will fail.
5121	<note>
5122	You cannot attach a device to a newly created machine until
5123	this machine's settings are saved to disk using
5124	<link to="#saveSettings"/>.
5125	</note>
5126	<note>
5127	If the medium is being attached indirectly, a new differencing medium
5128	will implicitly be created for it and attached instead. If the
5129	changes made to the machine settings (including this indirect
5130	attachment) are later cancelled using <link to="#discardSettings"/>,
5131	this implicitly created differencing medium will implicitly
5132	be deleted.
5133	</note>
5134
5135	<result name="E_INVALIDARG">
5136	SATA device, SATA port, IDE port or IDE slot out of range, or
5137	file or UUID not found.
5138	</result>
5139	<result name="VBOX_E_INVALID_OBJECT_STATE">
5140	Machine must be registered before media can be attached.
5141	</result>
5142	<result name="VBOX_E_INVALID_VM_STATE">
5143	Invalid machine state.
5144	</result>
5145	<result name="VBOX_E_OBJECT_IN_USE">
5146	A medium is already attached to this or another virtual machine.
5147	</result>
5148	</desc>
5149	<param name="name" type="wstring" dir="in">
5150	<desc>Name of the storage controller to attach the device to.</desc>
5151	</param>
5152	<param name="controllerPort" type="long" dir="in">
5153	<desc>Port to attach the device to. For an IDE controller, 0 specifies
5154	the primary controller and 1 specifies the secondary controller.
5155	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
5156	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
5157	</param>
5158	<param name="device" type="long" dir="in">
5159	<desc>Device slot in the given port to attach the device to. This is only
5160	relevant for IDE controllers, for which 0 specifies the master device and
5161	1 specifies the slave device. For all other controller types, this must
5162	be 0.</desc>
5163	</param>
5164	<param name="type" type="DeviceType" dir="in">
5165	<desc>Device type of the attached device. For media opened by
5166	<link to="IVirtualBox::openMedium" />, this must match the device type
5167	specified there.</desc>
5168	</param>
5169	</method>
5170
5171	<method name="detachDevice">
5172	<desc>
5173	Detaches the device attached to a device slot of the specified bus.
5174
5175	Detaching the device from the virtual machine is deferred. This means
5176	that the medium remains associated with the machine when this method
5177	returns and gets actually de-associated only after a successful
5178	<link to="#saveSettings"/> call. See <link to="IMedium"/>
5179	for more detailed information about attaching media.
5180
5181	<note>
5182	You cannot detach a device from a running machine.
5183	</note>
5184	<note>
5185	Detaching differencing media implicitly created by <link
5186	to="#attachDevice"/> for the indirect attachment using this
5187	method will <b>not</b> implicitly delete them. The
5188	<link to="IMedium::deleteStorage"/> operation should be
5189	explicitly performed by the caller after the medium is successfully
5190	detached and the settings are saved with
5191	<link to="#saveSettings"/>, if it is the desired action.
5192	</note>
5193
5194	<result name="VBOX_E_INVALID_VM_STATE">
5195	Attempt to detach medium from a running virtual machine.
5196	</result>
5197	<result name="VBOX_E_OBJECT_NOT_FOUND">
5198	No medium attached to given slot/bus.
5199	</result>
5200	<result name="VBOX_E_NOT_SUPPORTED">
5201	Medium format does not support storage deletion (only for implicitly
5202	created differencing media, should not happen).
5203	</result>
5204
5205	</desc>
5206	<param name="name" type="wstring" dir="in">
5207	<desc>Name of the storage controller to detach the medium from.</desc>
5208	</param>
5209	<param name="controllerPort" type="long" dir="in">
5210	<desc>Port number to detach the medium from.</desc>
5211	</param>
5212	<param name="device" type="long" dir="in">
5213	<desc>Device slot number to detach the medium from.</desc>
5214	</param>
5215	</method>
5216
5217	<method name="passthroughDevice">
5218	<desc>
5219	Sets the passthrough mode of an existing DVD device. Changing the
5220	setting while the VM is running is forbidden. The setting is only used
5221	if at VM start the device is configured as a host DVD drive, in all
5222	other cases it is ignored. The device must already exist; see
5223	<link to="IMachine::attachDevice"/> for how to attach a new device.
5224
5225	The @a controllerPort and @a device parameters specify the device slot and
5226	have have the same meaning as with <link to="IMachine::attachDevice" />.
5227
5228	<result name="E_INVALIDARG">
5229	SATA device, SATA port, IDE port or IDE slot out of range.
5230	</result>
5231	<result name="VBOX_E_INVALID_OBJECT_STATE">
5232	Attempt to modify an unregistered virtual machine.
5233	</result>
5234	<result name="VBOX_E_INVALID_VM_STATE">
5235	Invalid machine state.
5236	</result>
5237
5238	</desc>
5239	<param name="name" type="wstring" dir="in">
5240	<desc>Name of the storage controller.</desc>
5241	</param>
5242	<param name="controllerPort" type="long" dir="in">
5243	<desc>Storage controller port.</desc>
5244	</param>
5245	<param name="device" type="long" dir="in">
5246	<desc>Device slot in the given port.</desc>
5247	</param>
5248	<param name="passthrough" type="boolean" dir="in">
5249	<desc>New value for the passthrough setting.</desc>
5250	</param>
5251	</method>
5252
5253	<method name="temporaryEjectDevice">
5254	<desc>
5255	Sets the behavior for guest-triggered medium eject. In some situations
5256	it is desirable that such ejects update the VM configuration, and in
5257	others the eject should keep the VM configuration. The device must
5258	already exist; see <link to="IMachine::attachDevice"/> for how to
5259	attach a new device.
5260
5261	The @a controllerPort and @a device parameters specify the device slot and
5262	have have the same meaning as with <link to="IMachine::attachDevice" />.
5263
5264	<result name="E_INVALIDARG">
5265	SATA device, SATA port, IDE port or IDE slot out of range.
5266	</result>
5267	<result name="VBOX_E_INVALID_OBJECT_STATE">
5268	Attempt to modify an unregistered virtual machine.
5269	</result>
5270	<result name="VBOX_E_INVALID_VM_STATE">
5271	Invalid machine state.
5272	</result>
5273
5274	</desc>
5275	<param name="name" type="wstring" dir="in">
5276	<desc>Name of the storage controller.</desc>
5277	</param>
5278	<param name="controllerPort" type="long" dir="in">
5279	<desc>Storage controller port.</desc>
5280	</param>
5281	<param name="device" type="long" dir="in">
5282	<desc>Device slot in the given port.</desc>
5283	</param>
5284	<param name="temporaryEject" type="boolean" dir="in">
5285	<desc>New value for the eject behavior.</desc>
5286	</param>
5287	</method>
5288
5289	<method name="nonRotationalDevice">
5290	<desc>
5291	Sets a flag in the device information which indicates that the medium
5292	is not based on rotational technology, i.e. that the access times are
5293	more or less independent of the position on the medium. This may or may
5294	not be supported by a particular drive, and is silently ignored in the
5295	latter case. At the moment only hard disks (which is a misnomer in this
5296	context) accept this setting. Changing the setting while the VM is
5297	running is forbidden. The device must already exist; see
5298	<link to="IMachine::attachDevice"/> for how to attach a new device.
5299
5300	The @a controllerPort and @a device parameters specify the device slot and
5301	have have the same meaning as with <link to="IMachine::attachDevice" />.
5302
5303	<result name="E_INVALIDARG">
5304	SATA device, SATA port, IDE port or IDE slot out of range.
5305	</result>
5306	<result name="VBOX_E_INVALID_OBJECT_STATE">
5307	Attempt to modify an unregistered virtual machine.
5308	</result>
5309	<result name="VBOX_E_INVALID_VM_STATE">
5310	Invalid machine state.
5311	</result>
5312
5313	</desc>
5314	<param name="name" type="wstring" dir="in">
5315	<desc>Name of the storage controller.</desc>
5316	</param>
5317	<param name="controllerPort" type="long" dir="in">
5318	<desc>Storage controller port.</desc>
5319	</param>
5320	<param name="device" type="long" dir="in">
5321	<desc>Device slot in the given port.</desc>
5322	</param>
5323	<param name="nonRotational" type="boolean" dir="in">
5324	<desc>New value for the non-rotational device flag.</desc>
5325	</param>
5326	</method>
5327
5328	<method name="setAutoDiscardForDevice">
5329	<desc>
5330	Sets a flag in the device information which indicates that the medium
5331	supports discarding unsused blocks (called trimming for SATA or unmap
5332	for SCSI devices) .This may or may not be supported by a particular drive,
5333	and is silently ignored in the latter case. At the moment only hard disks
5334	(which is a misnomer in this context) accept this setting. Changing the
5335	setting while the VM is running is forbidden. The device must already
5336	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
5337	device.
5338
5339	The @a controllerPort and @a device parameters specify the device slot and
5340	have have the same meaning as with <link to="IMachine::attachDevice" />.
5341
5342	<result name="E_INVALIDARG">
5343	SATA device, SATA port, SCSI port out of range.
5344	</result>
5345	<result name="VBOX_E_INVALID_OBJECT_STATE">
5346	Attempt to modify an unregistered virtual machine.
5347	</result>
5348	<result name="VBOX_E_INVALID_VM_STATE">
5349	Invalid machine state.
5350	</result>
5351
5352	</desc>
5353	<param name="name" type="wstring" dir="in">
5354	<desc>Name of the storage controller.</desc>
5355	</param>
5356	<param name="controllerPort" type="long" dir="in">
5357	<desc>Storage controller port.</desc>
5358	</param>
5359	<param name="device" type="long" dir="in">
5360	<desc>Device slot in the given port.</desc>
5361	</param>
5362	<param name="discard" type="boolean" dir="in">
5363	<desc>New value for the discard device flag.</desc>
5364	</param>
5365	</method>
5366
5367	<method name="setBandwidthGroupForDevice">
5368	<desc>
5369	Sets the bandwidth group of an existing storage device.
5370	The device must already exist; see <link to="IMachine::attachDevice"/>
5371	for how to attach a new device.
5372
5373	The @a controllerPort and @a device parameters specify the device slot and
5374	have have the same meaning as with <link to="IMachine::attachDevice" />.
5375
5376	<result name="E_INVALIDARG">
5377	SATA device, SATA port, IDE port or IDE slot out of range.
5378	</result>
5379	<result name="VBOX_E_INVALID_OBJECT_STATE">
5380	Attempt to modify an unregistered virtual machine.
5381	</result>
5382	<result name="VBOX_E_INVALID_VM_STATE">
5383	Invalid machine state.
5384	</result>
5385
5386	</desc>
5387	<param name="name" type="wstring" dir="in">
5388	<desc>Name of the storage controller.</desc>
5389	</param>
5390	<param name="controllerPort" type="long" dir="in">
5391	<desc>Storage controller port.</desc>
5392	</param>
5393	<param name="device" type="long" dir="in">
5394	<desc>Device slot in the given port.</desc>
5395	</param>
5396	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
5397	<desc>New value for the bandwidth group or @c null for no group.</desc>
5398	</param>
5399	</method>
5400
5401	<method name="setNoBandwidthGroupForDevice">
5402	<desc>
5403	Sets no bandwidth group for an existing storage device.
5404	The device must already exist; see <link to="IMachine::attachDevice"/>
5405	for how to attach a new device.
5406	The @a controllerPort and @a device parameters specify the device slot and
5407	have have the same meaning as with <link to="IMachine::attachDevice" />.
5408	<result name="E_INVALIDARG">
5409	SATA device, SATA port, IDE port or IDE slot out of range.
5410	</result>
5411	<result name="VBOX_E_INVALID_OBJECT_STATE">
5412	Attempt to modify an unregistered virtual machine.
5413	</result>
5414	<result name="VBOX_E_INVALID_VM_STATE">
5415	Invalid machine state.
5416	</result>
5417
5418	</desc>
5419	<param name="name" type="wstring" dir="in">
5420	<desc>Name of the storage controller.</desc>
5421	</param>
5422	<param name="controllerPort" type="long" dir="in">
5423	<desc>Storage controller port.</desc>
5424	</param>
5425	<param name="device" type="long" dir="in">
5426	<desc>Device slot in the given port.</desc>
5427	</param>
5428	</method>
5429
5430
5431	<method name="unmountMedium">
5432	<desc>
5433	Unmounts any currently mounted medium (<link to="IMedium" />,
5434	identified by the given UUID @a id) to the given storage controller
5435	(<link to="IStorageController" />, identified by @a name),
5436	at the indicated port and device. The device must already exist;
5437
5438	This method is intended only for managing removable media, where the
5439	device is fixed but media is changeable at runtime (such as DVDs
5440	and floppies). It cannot be used for fixed media such as hard disks.
5441
5442	The @a controllerPort and @a device parameters specify the device slot
5443	and have have the same meaning as with
5444	<link to="IMachine::attachDevice" />.
5445
5446	The specified device slot must have a medium mounted, which will be
5447	unmounted. If there is no mounted medium it will do nothing.
5448	See <link to="IMedium"/> for more detailed information about
5449	attaching/unmounting media.
5450
5451	<result name="E_INVALIDARG">
5452	SATA device, SATA port, IDE port or IDE slot out of range.
5453	</result>
5454	<result name="VBOX_E_INVALID_OBJECT_STATE">
5455	Attempt to unmount medium that is not removeable - not dvd or floppy.
5456	</result>
5457	<result name="VBOX_E_INVALID_VM_STATE">
5458	Invalid machine state.
5459	</result>
5460	<result name="VBOX_E_OBJECT_IN_USE">
5461	Medium already attached to this or another virtual machine.
5462	</result>
5463	<result name="VBOX_E_OBJECT_NOT_FOUND">
5464	Medium not attached to specified port, device, controller.
5465	</result>
5466
5467	</desc>
5468	<param name="name" type="wstring" dir="in">
5469	<desc>Name of the storage controller to unmount the medium from.</desc>
5470	</param>
5471	<param name="controllerPort" type="long" dir="in">
5472	<desc>Port to unmount the medium from.</desc>
5473	</param>
5474	<param name="device" type="long" dir="in">
5475	<desc>Device slot in the given port to unmount the medium from.</desc>
5476	</param>
5477	<param name="force" type="boolean" dir="in">
5478	<desc>Allows to force unmount of a medium which is locked by
5479	the device slot in the given port medium is attached to.</desc>
5480	</param>
5481	</method>
5482
5483	<method name="mountMedium">
5484	<desc>
5485	Mounts a medium (<link to="IMedium" />, identified
5486	by the given UUID @a id) to the given storage controller
5487	(<link to="IStorageController" />, identified by @a name),
5488	at the indicated port and device. The device must already exist;
5489	see <link to="IMachine::attachDevice"/> for how to attach a new device.
5490
5491	This method is intended only for managing removable media, where the
5492	device is fixed but media is changeable at runtime (such as DVDs
5493	and floppies). It cannot be used for fixed media such as hard disks.
5494
5495	The @a controllerPort and @a device parameters specify the device slot and
5496	have have the same meaning as with <link to="IMachine::attachDevice" />.
5497
5498	The specified device slot can have a medium mounted, which will be
5499	unmounted first. Specifying a zero UUID (or an empty string) for
5500	@a medium does just an unmount.
5501
5502	See <link to="IMedium"/> for more detailed information about
5503	attaching media.
5504
5505	<result name="E_INVALIDARG">
5506	SATA device, SATA port, IDE port or IDE slot out of range.
5507	</result>
5508	<result name="VBOX_E_INVALID_OBJECT_STATE">
5509	Attempt to attach medium to an unregistered virtual machine.
5510	</result>
5511	<result name="VBOX_E_INVALID_VM_STATE">
5512	Invalid machine state.
5513	</result>
5514	<result name="VBOX_E_OBJECT_IN_USE">
5515	Medium already attached to this or another virtual machine.
5516	</result>
5517
5518	</desc>
5519	<param name="name" type="wstring" dir="in">
5520	<desc>Name of the storage controller to attach the medium to.</desc>
5521	</param>
5522	<param name="controllerPort" type="long" dir="in">
5523	<desc>Port to attach the medium to.</desc>
5524	</param>
5525	<param name="device" type="long" dir="in">
5526	<desc>Device slot in the given port to attach the medium to.</desc>
5527	</param>
5528	<param name="medium" type="IMedium" dir="in">
5529	<desc>Medium to mount or @c null for an empty drive.</desc>
5530	</param>
5531	<param name="force" type="boolean" dir="in">
5532	<desc>Allows to force unmount/mount of a medium which is locked by
5533	the device slot in the given port to attach the medium to.</desc>
5534	</param>
5535	</method>
5536
5537	<method name="getMedium" const="yes">
5538	<desc>
5539	Returns the virtual medium attached to a device slot of the specified
5540	bus.
5541
5542	Note that if the medium was indirectly attached by
5543	<link to="#mountMedium"/> to the given device slot then this
5544	method will return not the same object as passed to the
5545	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5546	more detailed information about mounting a medium.
5547
5548	<result name="VBOX_E_OBJECT_NOT_FOUND">
5549	No medium attached to given slot/bus.
5550	</result>
5551
5552	</desc>
5553	<param name="name" type="wstring" dir="in">
5554	<desc>Name of the storage controller the medium is attached to.</desc>
5555	</param>
5556	<param name="controllerPort" type="long" dir="in">
5557	<desc>Port to query.</desc>
5558	</param>
5559	<param name="device" type="long" dir="in">
5560	<desc>Device slot in the given port to query.</desc>
5561	</param>
5562	<param name="medium" type="IMedium" dir="return">
5563	<desc>Attached medium object.</desc>
5564	</param>
5565	</method>
5566
5567	<method name="getMediumAttachmentsOfController" const="yes">
5568	<desc>
5569	Returns an array of medium attachments which are attached to the
5570	the controller with the given name.
5571
5572	<result name="VBOX_E_OBJECT_NOT_FOUND">
5573	A storage controller with given name doesn't exist.
5574	</result>
5575	</desc>
5576	<param name="name" type="wstring" dir="in"/>
5577	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5578	</method>
5579
5580	<method name="getMediumAttachment" const="yes">
5581	<desc>
5582	Returns a medium attachment which corresponds to the controller with
5583	the given name, on the given port and device slot.
5584
5585	<result name="VBOX_E_OBJECT_NOT_FOUND">
5586	No attachment exists for the given controller/port/device combination.
5587	</result>
5588	</desc>
5589	<param name="name" type="wstring" dir="in"/>
5590	<param name="controllerPort" type="long" dir="in"/>
5591	<param name="device" type="long" dir="in"/>
5592	<param name="attachment" type="IMediumAttachment" dir="return"/>
5593	</method>
5594
5595	<method name="attachHostPCIDevice">
5596	<desc>
5597	Attaches host PCI device with the given (host) PCI address to the
5598	PCI bus of the virtual machine. Please note, that this operation
5599	is two phase, as real attachment will happen when VM will start,
5600	and most information will be delivered as IHostPCIDevicePlugEvent
5601	on IVirtualBox event source.
5602
5603	<see><link to="IHostPCIDevicePlugEvent"/></see>
5604
5605	<result name="VBOX_E_INVALID_VM_STATE">
5606	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5607	</result>
5608	<result name="VBOX_E_PDM_ERROR">
5609	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5610	</result>
5611	<result name="VBOX_E_NOT_SUPPORTED">
5612	Hardware or host OS doesn't allow PCI device passthrought.
5613	</result>
5614	</desc>
5615	<param name="hostAddress" type="long" dir="in">
5616	<desc>Address of the host PCI device.</desc>
5617	</param>
5618	<param name="desiredGuestAddress" type="long" dir="in">
5619	<desc>Desired position of this device on guest PCI bus.</desc>
5620	</param>
5621	<param name="tryToUnbind" type="boolean" dir="in">
5622	<desc>If VMM shall try to unbind existing drivers from the
5623	device before attaching it to the guest.</desc>
5624	</param>
5625	</method>
5626
5627	<method name="detachHostPCIDevice">
5628	<desc>
5629	Detach host PCI device from the virtual machine.
5630	Also HostPCIDevicePlugEvent on IVirtualBox event source
5631	will be delivered. As currently we don't support hot device
5632	unplug, IHostPCIDevicePlugEvent event is delivered immediately.
5633
5634	<see><link to="IHostPCIDevicePlugEvent"/></see>
5635
5636	<result name="VBOX_E_INVALID_VM_STATE">
5637	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5638	</result>
5639	<result name="VBOX_E_OBJECT_NOT_FOUND">
5640	This host device is not attached to this machine.
5641	</result>
5642	<result name="VBOX_E_PDM_ERROR">
5643	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5644	</result>
5645	<result name="VBOX_E_NOT_SUPPORTED">
5646	Hardware or host OS doesn't allow PCI device passthrought.
5647	</result>
5648	</desc>
5649	<param name="hostAddress" type="long" dir="in">
5650	<desc>Address of the host PCI device.</desc>
5651	</param>
5652	</method>
5653
5654	<method name="getNetworkAdapter" const="yes">
5655	<desc>
5656	Returns the network adapter associated with the given slot.
5657	Slots are numbered sequentially, starting with zero. The total
5658	number of adapters per machine is defined by the
5659	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5660	so the maximum slot number is one less than that property's value.
5661
5662	<result name="E_INVALIDARG">
5663	Invalid @a slot number.
5664	</result>
5665
5666	</desc>
5667	<param name="slot" type="unsigned long" dir="in"/>
5668	<param name="adapter" type="INetworkAdapter" dir="return"/>
5669	</method>
5670
5671	<method name="addStorageController">
5672	<desc>
5673	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5674	machine and returns it as an instance of
5675	<link to="IStorageController" />.
5676
5677	@a name identifies the controller for subsequent calls such as
5678	<link to="#getStorageControllerByName" />,
5679	<link to="#getStorageControllerByInstance" />,
5680	<link to="#removeStorageController" />,
5681	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5682
5683	After the controller has been added, you can set its exact
5684	type by setting the <link to="IStorageController::controllerType" />.
5685
5686	<result name="VBOX_E_OBJECT_IN_USE">
5687	A storage controller with given name exists already.
5688	</result>
5689	<result name="E_INVALIDARG">
5690	Invalid @a controllerType.
5691	</result>
5692	</desc>
5693	<param name="name" type="wstring" dir="in"/>
5694	<param name="connectionType" type="StorageBus" dir="in"/>
5695	<param name="controller" type="IStorageController" dir="return"/>
5696	</method>
5697
5698	<method name="getStorageControllerByName" const="yes">
5699	<desc>
5700	Returns a storage controller with the given name.
5701
5702	<result name="VBOX_E_OBJECT_NOT_FOUND">
5703	A storage controller with given name doesn't exist.
5704	</result>
5705	</desc>
5706	<param name="name" type="wstring" dir="in"/>
5707	<param name="storageController" type="IStorageController" dir="return"/>
5708	</method>
5709
5710	<method name="getStorageControllerByInstance" const="yes">
5711	<desc>
5712	Returns a storage controller with the given instance number.
5713
5714	<result name="VBOX_E_OBJECT_NOT_FOUND">
5715	A storage controller with given instance number doesn't exist.
5716	</result>
5717	</desc>
5718	<param name="instance" type="unsigned long" dir="in"/>
5719	<param name="storageController" type="IStorageController" dir="return"/>
5720	</method>
5721
5722	<method name="removeStorageController">
5723	<desc>
5724	Removes a storage controller from the machine with all devices attached to it.
5725
5726	<result name="VBOX_E_OBJECT_NOT_FOUND">
5727	A storage controller with given name doesn't exist.
5728	</result>
5729	<result name="VBOX_E_NOT_SUPPORTED">
5730	Medium format does not support storage deletion (only for implicitly
5731	created differencing media, should not happen).
5732	</result>
5733	</desc>
5734	<param name="name" type="wstring" dir="in"/>
5735	</method>
5736
5737	<method name="setStorageControllerBootable">
5738	<desc>
5739	Sets the bootable flag of the storage controller with the given name.
5740
5741	<result name="VBOX_E_OBJECT_NOT_FOUND">
5742	A storage controller with given name doesn't exist.
5743	</result>
5744	<result name="VBOX_E_OBJECT_IN_USE">
5745	Another storage controller is marked as bootable already.
5746	</result>
5747	</desc>
5748	<param name="name" type="wstring" dir="in"/>
5749	<param name="bootable" type="boolean" dir="in"/>
5750	</method>
5751
5752	<method name="getSerialPort" const="yes">
5753	<desc>
5754	Returns the serial port associated with the given slot.
5755	Slots are numbered sequentially, starting with zero. The total
5756	number of serial ports per machine is defined by the
5757	<link to="ISystemProperties::serialPortCount"/> property,
5758	so the maximum slot number is one less than that property's value.
5759
5760	<result name="E_INVALIDARG">
5761	Invalid @a slot number.
5762	</result>
5763
5764	</desc>
5765	<param name="slot" type="unsigned long" dir="in"/>
5766	<param name="port" type="ISerialPort" dir="return"/>
5767	</method>
5768
5769	<method name="getParallelPort" const="yes">
5770	<desc>
5771	Returns the parallel port associated with the given slot.
5772	Slots are numbered sequentially, starting with zero. The total
5773	number of parallel ports per machine is defined by the
5774	<link to="ISystemProperties::parallelPortCount"/> property,
5775	so the maximum slot number is one less than that property's value.
5776
5777	<result name="E_INVALIDARG">
5778	Invalid @a slot number.
5779	</result>
5780
5781	</desc>
5782	<param name="slot" type="unsigned long" dir="in"/>
5783	<param name="port" type="IParallelPort" dir="return"/>
5784	</method>
5785
5786	<method name="getExtraDataKeys">
5787	<desc>
5788	Returns an array representing the machine-specific extra data keys
5789	which currently have values defined.
5790	</desc>
5791	<param name="keys" type="wstring" dir="return" safearray="yes">
5792	<desc>Array of extra data keys.</desc>
5793	</param>
5794	</method>
5795
5796	<method name="getExtraData">
5797	<desc>
5798	Returns associated machine-specific extra data.
5799
5800	If the requested data @a key does not exist, this function will
5801	succeed and return an empty string in the @a value argument.
5802
5803	<result name="VBOX_E_FILE_ERROR">
5804	Settings file not accessible.
5805	</result>
5806	<result name="VBOX_E_XML_ERROR">
5807	Could not parse the settings file.
5808	</result>
5809
5810	</desc>
5811	<param name="key" type="wstring" dir="in">
5812	<desc>Name of the data key to get.</desc>
5813	</param>
5814	<param name="value" type="wstring" dir="return">
5815	<desc>Value of the requested data key.</desc>
5816	</param>
5817	</method>
5818
5819	<method name="setExtraData">
5820	<desc>
5821	Sets associated machine-specific extra data.
5822
5823	If you pass @c null or an empty string as a key @a value, the given
5824	@a key will be deleted.
5825
5826	<note>
5827	Before performing the actual data change, this method will ask all
5828	registered listeners using the
5829	<link to="IExtraDataCanChangeEvent"/>
5830	notification for a permission. If one of the listeners refuses the
5831	new value, the change will not be performed.
5832	</note>
5833	<note>
5834	On success, the
5835	<link to="IExtraDataChangedEvent"/> notification
5836	is called to inform all registered listeners about a successful data
5837	change.
5838	</note>
5839	<note>
5840	This method can be called outside the machine session and therefore
5841	it's a caller's responsibility to handle possible race conditions
5842	when several clients change the same key at the same time.
5843	</note>
5844
5845	<result name="VBOX_E_FILE_ERROR">
5846	Settings file not accessible.
5847	</result>
5848	<result name="VBOX_E_XML_ERROR">
5849	Could not parse the settings file.
5850	</result>
5851
5852	</desc>
5853	<param name="key" type="wstring" dir="in">
5854	<desc>Name of the data key to set.</desc>
5855	</param>
5856	<param name="value" type="wstring" dir="in">
5857	<desc>Value to assign to the key.</desc>
5858	</param>
5859	</method>
5860
5861	<method name="getCPUProperty" const="yes">
5862	<desc>
5863	Returns the virtual CPU boolean value of the specified property.
5864
5865	<result name="E_INVALIDARG">
5866	Invalid property.
5867	</result>
5868
5869	</desc>
5870	<param name="property" type="CPUPropertyType" dir="in">
5871	<desc>
5872	Property type to query.
5873	</desc>
5874	</param>
5875	<param name="value" type="boolean" dir="return">
5876	<desc>
5877	Property value.
5878	</desc>
5879	</param>
5880	</method>
5881
5882	<method name="setCPUProperty">
5883	<desc>
5884	Sets the virtual CPU boolean value of the specified property.
5885
5886	<result name="E_INVALIDARG">
5887	Invalid property.
5888	</result>
5889
5890	</desc>
5891	<param name="property" type="CPUPropertyType" dir="in">
5892	<desc>
5893	Property type to query.
5894	</desc>
5895	</param>
5896	<param name="value" type="boolean" dir="in">
5897	<desc>
5898	Property value.
5899	</desc>
5900	</param>
5901	</method>
5902
5903	<method name="getCPUIDLeaf" const="yes">
5904	<desc>
5905	Returns the virtual CPU cpuid information for the specified leaf.
5906
5907	Currently supported index values for cpuid:
5908	Standard CPUID leafs: 0 - 0xA
5909	Extended CPUID leafs: 0x80000000 - 0x8000000A
5910
5911	See the Intel and AMD programmer's manuals for detailed information
5912	about the cpuid instruction and its leafs.
5913	<result name="E_INVALIDARG">
5914	Invalid id.
5915	</result>
5916
5917	</desc>
5918	<param name="id" type="unsigned long" dir="in">
5919	<desc>
5920	CPUID leaf index.
5921	</desc>
5922	</param>
5923	<param name="valEax" type="unsigned long" dir="out">
5924	<desc>
5925	CPUID leaf value for register eax.
5926	</desc>
5927	</param>
5928	<param name="valEbx" type="unsigned long" dir="out">
5929	<desc>
5930	CPUID leaf value for register ebx.
5931	</desc>
5932	</param>
5933	<param name="valEcx" type="unsigned long" dir="out">
5934	<desc>
5935	CPUID leaf value for register ecx.
5936	</desc>
5937	</param>
5938	<param name="valEdx" type="unsigned long" dir="out">
5939	<desc>
5940	CPUID leaf value for register edx.
5941	</desc>
5942	</param>
5943	</method>
5944
5945	<method name="setCPUIDLeaf">
5946	<desc>
5947	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5948	are not passed unmodified. VirtualBox clears features that it doesn't support.
5949
5950	Currently supported index values for cpuid:
5951	Standard CPUID leafs: 0 - 0xA
5952	Extended CPUID leafs: 0x80000000 - 0x8000000A
5953
5954	See the Intel and AMD programmer's manuals for detailed information
5955	about the cpuid instruction and its leafs.
5956
5957	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5958	random crashes inside VMs.
5959	<result name="E_INVALIDARG">
5960	Invalid id.
5961	</result>
5962
5963	</desc>
5964	<param name="id" type="unsigned long" dir="in">
5965	<desc>
5966	CPUID leaf index.
5967	</desc>
5968	</param>
5969	<param name="valEax" type="unsigned long" dir="in">
5970	<desc>
5971	CPUID leaf value for register eax.
5972	</desc>
5973	</param>
5974	<param name="valEbx" type="unsigned long" dir="in">
5975	<desc>
5976	CPUID leaf value for register ebx.
5977	</desc>
5978	</param>
5979	<param name="valEcx" type="unsigned long" dir="in">
5980	<desc>
5981	CPUID leaf value for register ecx.
5982	</desc>
5983	</param>
5984	<param name="valEdx" type="unsigned long" dir="in">
5985	<desc>
5986	CPUID leaf value for register edx.
5987	</desc>
5988	</param>
5989	</method>
5990
5991	<method name="removeCPUIDLeaf">
5992	<desc>
5993	Removes the virtual CPU cpuid leaf for the specified index
5994
5995	<result name="E_INVALIDARG">
5996	Invalid id.
5997	</result>
5998
5999	</desc>
6000	<param name="id" type="unsigned long" dir="in">
6001	<desc>
6002	CPUID leaf index.
6003	</desc>
6004	</param>
6005	</method>
6006
6007	<method name="removeAllCPUIDLeaves">
6008	<desc>
6009	Removes all the virtual CPU cpuid leaves
6010	</desc>
6011	</method>
6012
6013	<method name="getHWVirtExProperty" const="yes">
6014	<desc>
6015	Returns the value of the specified hardware virtualization boolean property.
6016
6017	<result name="E_INVALIDARG">
6018	Invalid property.
6019	</result>
6020
6021	</desc>
6022	<param name="property" type="HWVirtExPropertyType" dir="in">
6023	<desc>
6024	Property type to query.
6025	</desc>
6026	</param>
6027	<param name="value" type="boolean" dir="return">
6028	<desc>
6029	Property value.
6030	</desc>
6031	</param>
6032	</method>
6033
6034	<method name="setHWVirtExProperty">
6035	<desc>
6036	Sets a new value for the specified hardware virtualization boolean property.
6037
6038	<result name="E_INVALIDARG">
6039	Invalid property.
6040	</result>
6041
6042	</desc>
6043	<param name="property" type="HWVirtExPropertyType" dir="in">
6044	<desc>
6045	Property type to set.
6046	</desc>
6047	</param>
6048	<param name="value" type="boolean" dir="in">
6049	<desc>
6050	New property value.
6051	</desc>
6052	</param>
6053	</method>
6054
6055	<method name="saveSettings">
6056	<desc>
6057	Saves any changes to machine settings made since the session
6058	has been opened or a new machine has been created, or since the
6059	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
6060	For registered machines, new settings become visible to all
6061	other VirtualBox clients after successful invocation of this
6062	method.
6063	<note>
6064	The method sends <link to="IMachineDataChangedEvent"/>
6065	notification event after the configuration has been successfully
6066	saved (only for registered machines).
6067	</note>
6068	<note>
6069	Calling this method is only valid on instances returned
6070	by <link to="ISession::machine"/> and on new machines
6071	created by <link to="IVirtualBox::createMachine"/> but not
6072	yet registered, or on unregistered machines after calling
6073	<link to="IMachine::unregister"/>.
6074	</note>
6075
6076	<result name="VBOX_E_FILE_ERROR">
6077	Settings file not accessible.
6078	</result>
6079	<result name="VBOX_E_XML_ERROR">
6080	Could not parse the settings file.
6081	</result>
6082	<result name="E_ACCESSDENIED">
6083	Modification request refused.
6084	</result>
6085
6086	</desc>
6087	</method>
6088
6089	<method name="discardSettings">
6090	<desc>
6091	Discards any changes to the machine settings made since the session
6092	has been opened or since the last call to <link to="#saveSettings"/>
6093	or <link to="#discardSettings"/>.
6094	<note>
6095	Calling this method is only valid on instances returned
6096	by <link to="ISession::machine"/> and on new machines
6097	created by <link to="IVirtualBox::createMachine"/> or
6098	opened by <link to="IVirtualBox::openMachine"/> but not
6099	yet registered, or on unregistered machines after calling
6100	<link to="IMachine::unregister"/>.
6101	</note>
6102
6103	<result name="VBOX_E_INVALID_VM_STATE">
6104	Virtual machine is not mutable.
6105	</result>
6106
6107	</desc>
6108	</method>
6109
6110	<method name="unregister">
6111	<desc>
6112	Unregisters a machine previously registered with
6113	<link to="IVirtualBox::registerMachine"/> and optionally do additional
6114	cleanup before the machine is unregistered.
6115
6116	This method does not delete any files. It only changes the machine configuration and
6117	the list of registered machines in the VirtualBox object. To delete the files which
6118	belonged to the machine, including the XML file of the machine itself, call
6119	<link to="#deleteConfig"/>, optionally with the array of IMedium objects which was returned
6120	from this method.
6121
6122	How thoroughly this method cleans up the machine configuration before unregistering
6123	the machine depends on the @a cleanupMode argument.
6124
6125	<ul>
6126	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
6127	cleanup will be performed. The call will fail if the machine is in "Saved" state
6128	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
6129	It is the responsibility of the caller to delete all such configuration in this mode.
6130	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
6131	which it replaces.</li>
6132	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
6133	state or if it has snapshots or media attached. All media attached to the current machine
6134	state or in snapshots will be detached. No medium objects will be returned;
6135	all of the machine's media will remain open.</li>
6136	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
6137	except that all the hard disk medium objects which were detached from the machine will
6138	be returned as an array. This allows for quickly passing them to the <link to="#deleteConfig" />
6139	API for closing and deletion.</li>
6140	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
6141	that all media will be returned in the array, including removable media like DVDs and
6142	floppies. This might be useful if the user wants to inspect in detail which media were
6143	attached to the machine. Be careful when passing the media array to <link to="#deleteConfig" />
6144	in that case because users will typically want to preserve ISO and RAW image files.</li>
6145	</ul>
6146
6147	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
6148	resulting IMedium array to <link to="#deleteConfig"/>. This way, the machine is completely
6149	deleted with all its saved states and hard disk images, but images for removable
6150	drives (such as ISO and RAW files) will remain on disk.
6151
6152	This API does not verify whether the media files returned in the array are still
6153	attached to other machines (i.e. shared between several machines). If such a shared
6154	image is passed to <link to="#deleteConfig" /> however, closing the image will fail there
6155	and the image will be silently skipped.
6156
6157	This API may, however, move media from this machine's media registry to other media
6158	registries (see <link to="IMedium" /> for details on media registries). For machines
6159	created with VirtualBox 4.0 or later, if media from this machine's media registry
6160	are also attached to another machine (shared attachments), each such medium will be
6161	moved to another machine's registry. This is because without this machine's media
6162	registry, the other machine cannot find its media any more and would become inaccessible.
6163
6164	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
6165	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
6166	if media are moved to other machines' media registries.
6167
6168	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
6169	is fired.
6170
6171	The call will fail if the machine is currently locked (see <link to="ISession" />).
6172
6173	<note>
6174	If the given machine is inaccessible (see <link to="#accessible"/>), it
6175	will be unregistered and fully uninitialized right afterwards. As a result,
6176	the returned machine object will be unusable and an attempt to call
6177	<b>any</b> method will return the "Object not ready" error.
6178	</note>
6179
6180	<result name="VBOX_E_INVALID_OBJECT_STATE">
6181	Machine is currently locked for a session.
6182	</result>
6183	</desc>
6184
6185	<param name="cleanupMode" type="CleanupMode" dir="in">
6186	<desc>How to clean up after the machine has been unregistered.</desc>
6187	</param>
6188	<param name="media" type="IMedium" safearray="yes" dir="return">
6189	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
6190	</param>
6191	</method>
6192
6193	<method name="deleteConfig">
6194	<desc>
6195	Deletes the files associated with this machine from disk. If medium objects are passed
6196	in with the @a aMedia argument, they are closed and, if closing was successful, their
6197	storage files are deleted as well. For convenience, this array of media files can be
6198	the same as the one returned from a previous <link to="#unregister" /> call.
6199
6200	This method must only be called on machines which are either write-locked (i.e. on instances
6201	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
6202	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
6203	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
6204
6205	The following files will be deleted by this method:
6206	<ul>
6207	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
6208	argument other than "UnregisterOnly", this will delete all saved state files that
6209	the machine had in use; possibly one if the machine was in "Saved" state and one
6210	for each online snapshot that the machine had.</li>
6211	<li>On each medium object passed in the @a aMedia array, this will call
6212	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
6213	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
6214	in use, e.g. because it is still attached to a second machine; in that case the
6215	storage will not be deleted.</li>
6216	<li>Finally, the machine's own XML file will be deleted.</li>
6217	</ul>
6218
6219	Since deleting large disk image files can be a time-consuming I/O operation, this
6220	method operates asynchronously and returns an IProgress object to allow the caller
6221	to monitor the progress. There will be one sub-operation for each file that is
6222	being deleted (saved state or medium storage file).
6223
6224	<note>
6225	<link to="#settingsModified"/> will return @c true after this
6226	method successfully returns.
6227	</note>
6228
6229	<result name="VBOX_E_INVALID_VM_STATE">
6230	Machine is registered but not write-locked.
6231	</result>
6232	<result name="VBOX_E_IPRT_ERROR">
6233	Could not delete the settings file.
6234	</result>
6235	</desc>
6236	<param name="media" type="IMedium" safearray="yes" dir="in">
6237	<desc>List of media to be closed and whose storage files will be deleted.</desc>
6238	</param>
6239	<param name="progress" type="IProgress" dir="return">
6240	<desc>Progress object to track the operation completion.</desc>
6241	</param>
6242	</method>
6243
6244	<method name="exportTo">
6245	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
6246	steps required to export VirtualBox machines to OVF.
6247	</desc>
6248
6249	<param name="appliance" type="IAppliance" dir="in">
6250	<desc>Appliance to export this machine to.</desc>
6251	</param>
6252	<param name="location" type="wstring" dir="in">
6253	<desc>The target location.</desc>
6254	</param>
6255	<param name="description" type="IVirtualSystemDescription" dir="return">
6256	<desc>VirtualSystemDescription object which is created for this machine.</desc>
6257	</param>
6258	</method >
6259
6260	<method name="findSnapshot">
6261	<desc>
6262	Returns a snapshot of this machine with the given name or UUID.
6263
6264	Returns a snapshot of this machine with the given UUID.
6265	A @c null argument can be used to obtain the first snapshot
6266	taken on this machine. To traverse the whole tree of snapshots
6267	starting from the root, inspect the root snapshot's
6268	<link to="ISnapshot::children" /> attribute and recurse over those children.
6269
6270	<result name="VBOX_E_OBJECT_NOT_FOUND">
6271	Virtual machine has no snapshots or snapshot not found.
6272	</result>
6273
6274	</desc>
6275	<param name="nameOrId" type="wstring" dir="in">
6276	<desc>What to search for. Name or UUID of the snapshot to find</desc>
6277	</param>
6278	<param name="snapshot" type="ISnapshot" dir="return">
6279	<desc>Snapshot object with the given name.</desc>
6280	</param>
6281	</method>
6282
6283	<method name="createSharedFolder">
6284	<desc>
6285	Creates a new permanent shared folder by associating the given logical
6286	name with the given host path, adds it to the collection of shared
6287	folders and starts sharing it. Refer to the description of
6288	<link to="ISharedFolder"/> to read more about logical names.
6289
6290	<result name="VBOX_E_OBJECT_IN_USE">
6291	Shared folder already exists.
6292	</result>
6293	<result name="VBOX_E_FILE_ERROR">
6294	Shared folder @a hostPath not accessible.
6295	</result>
6296
6297	</desc>
6298	<param name="name" type="wstring" dir="in">
6299	<desc>Unique logical name of the shared folder.</desc>
6300	</param>
6301	<param name="hostPath" type="wstring" dir="in">
6302	<desc>Full path to the shared folder in the host file system.</desc>
6303	</param>
6304	<param name="writable" type="boolean" dir="in">
6305	<desc>Whether the share is writable or readonly.</desc>
6306	</param>
6307	<param name="automount" type="boolean" dir="in">
6308	<desc>Whether the share gets automatically mounted by the guest
6309	or not.</desc>
6310	</param>
6311	</method>
6312
6313	<method name="removeSharedFolder">
6314	<desc>
6315	Removes the permanent shared folder with the given name previously
6316	created by <link to="#createSharedFolder"/> from the collection of
6317	shared folders and stops sharing it.
6318
6319	<result name="VBOX_E_INVALID_VM_STATE">
6320	Virtual machine is not mutable.
6321	</result>
6322	<result name="VBOX_E_OBJECT_NOT_FOUND">
6323	Shared folder @a name does not exist.
6324	</result>
6325
6326	</desc>
6327	<param name="name" type="wstring" dir="in">
6328	<desc>Logical name of the shared folder to remove.</desc>
6329	</param>
6330	</method>
6331
6332	<method name="canShowConsoleWindow">
6333	<desc>
6334	Returns @c true if the VM console process can activate the
6335	console window and bring it to foreground on the desktop of
6336	the host PC.
6337	<note>
6338	This method will fail if a session for this machine is not
6339	currently open.
6340	</note>
6341
6342	<result name="VBOX_E_INVALID_VM_STATE">
6343	Machine session is not open.
6344	</result>
6345
6346	</desc>
6347	<param name="canShow" type="boolean" dir="return">
6348	<desc>
6349	@c true if the console window can be shown and @c false otherwise.
6350	</desc>
6351	</param>
6352	</method>
6353
6354	<method name="showConsoleWindow">
6355	<desc>
6356	Activates the console window and brings it to foreground on
6357	the desktop of the host PC. Many modern window managers on
6358	many platforms implement some sort of focus stealing
6359	prevention logic, so that it may be impossible to activate
6360	a window without the help of the currently active
6361	application. In this case, this method will return a non-zero
6362	identifier that represents the top-level window of the VM
6363	console process. The caller, if it represents a currently
6364	active process, is responsible to use this identifier (in a
6365	platform-dependent manner) to perform actual window
6366	activation.
6367	<note>
6368	This method will fail if a session for this machine is not
6369	currently open.
6370	</note>
6371
6372	<result name="VBOX_E_INVALID_VM_STATE">
6373	Machine session is not open.
6374	</result>
6375
6376	</desc>
6377	<param name="winId" type="long long" dir="return">
6378	<desc>
6379	Platform-dependent identifier of the top-level VM console
6380	window, or zero if this method has performed all actions
6381	necessary to implement the <i>show window</i> semantics for
6382	the given platform and/or VirtualBox front-end.
6383	</desc>
6384	</param>
6385	</method>
6386
6387	<method name="getGuestProperty" const="yes">
6388	<desc>
6389	Reads an entry from the machine's guest property store.
6390
6391	<result name="VBOX_E_INVALID_VM_STATE">
6392	Machine session is not open.
6393	</result>
6394
6395	</desc>
6396	<param name="name" type="wstring" dir="in">
6397	<desc>
6398	The name of the property to read.
6399	</desc>
6400	</param>
6401	<param name="value" type="wstring" dir="out">
6402	<desc>
6403	The value of the property. If the property does not exist then this
6404	will be empty.
6405	</desc>
6406	</param>
6407	<param name="timestamp" type="long long" dir="out">
6408	<desc>
6409	The time at which the property was last modified, as seen by the
6410	server process.
6411	</desc>
6412	</param>
6413	<param name="flags" type="wstring" dir="out">
6414	<desc>
6415	Additional property parameters, passed as a comma-separated list of
6416	"name=value" type entries.
6417	</desc>
6418	</param>
6419	</method>
6420
6421	<method name="getGuestPropertyValue" const="yes">
6422	<desc>
6423	Reads a value from the machine's guest property store.
6424
6425	<result name="VBOX_E_INVALID_VM_STATE">
6426	Machine session is not open.
6427	</result>
6428
6429	</desc>
6430	<param name="property" type="wstring" dir="in">
6431	<desc>
6432	The name of the property to read.
6433	</desc>
6434	</param>
6435	<param name="value" type="wstring" dir="return">
6436	<desc>
6437	The value of the property. If the property does not exist then this
6438	will be empty.
6439	</desc>
6440	</param>
6441	</method>
6442
6443	<method name="getGuestPropertyTimestamp" const="yes">
6444	<desc>
6445	Reads a property timestamp from the machine's guest property store.
6446
6447	<result name="VBOX_E_INVALID_VM_STATE">
6448	Machine session is not open.
6449	</result>
6450
6451	</desc>
6452	<param name="property" type="wstring" dir="in">
6453	<desc>
6454	The name of the property to read.
6455	</desc>
6456	</param>
6457	<param name="value" type="long long" dir="return">
6458	<desc>
6459	The timestamp. If the property does not exist then this will be
6460	empty.
6461	</desc>
6462	</param>
6463	</method>
6464
6465	<method name="setGuestProperty">
6466	<desc>
6467	Sets, changes or deletes an entry in the machine's guest property
6468	store.
6469
6470	<result name="E_ACCESSDENIED">
6471	Property cannot be changed.
6472	</result>
6473	<result name="E_INVALIDARG">
6474	Invalid @a flags.
6475	</result>
6476	<result name="VBOX_E_INVALID_VM_STATE">
6477	Virtual machine is not mutable or session not open.
6478	</result>
6479	<result name="VBOX_E_INVALID_OBJECT_STATE">
6480	Cannot set transient property when machine not running.
6481	</result>
6482
6483	</desc>
6484	<param name="property" type="wstring" dir="in">
6485	<desc>
6486	The name of the property to set, change or delete.
6487	</desc>
6488	</param>
6489	<param name="value" type="wstring" dir="in">
6490	<desc>
6491	The new value of the property to set, change or delete. If the
6492	property does not yet exist and value is non-empty, it will be
6493	created. If the value is @c null or empty, the property will be
6494	deleted if it exists.
6495	</desc>
6496	</param>
6497	<param name="flags" type="wstring" dir="in">
6498	<desc>
6499	Additional property parameters, passed as a comma-separated list of
6500	"name=value" type entries.
6501	</desc>
6502	</param>
6503	</method>
6504
6505	<method name="setGuestPropertyValue">
6506	<desc>
6507	Sets or changes a value in the machine's guest property
6508	store. The flags field will be left unchanged or created empty for a
6509	new property.
6510
6511	<result name="E_ACCESSDENIED">
6512	Property cannot be changed.
6513	</result>
6514	<result name="VBOX_E_INVALID_VM_STATE">
6515	Virtual machine is not mutable or session not open.
6516	</result>
6517	<result name="VBOX_E_INVALID_OBJECT_STATE">
6518	Cannot set transient property when machine not running.
6519	</result>
6520	</desc>
6521
6522	<param name="property" type="wstring" dir="in">
6523	<desc>
6524	The name of the property to set or change.
6525	</desc>
6526	</param>
6527	<param name="value" type="wstring" dir="in">
6528	<desc>
6529	The new value of the property to set or change. If the
6530	property does not yet exist and value is non-empty, it will be
6531	created.
6532	</desc>
6533	</param>
6534	</method>
6535
6536	<method name="deleteGuestProperty" const="yes">
6537	<desc>
6538	Deletes an entry from the machine's guest property store.
6539
6540	<result name="VBOX_E_INVALID_VM_STATE">
6541	Machine session is not open.
6542	</result>
6543
6544	</desc>
6545	<param name="name" type="wstring" dir="in">
6546	<desc>
6547	The name of the property to delete.
6548	</desc>
6549	</param>
6550	</method>
6551
6552	<method name="enumerateGuestProperties" const="yes">
6553	<desc>
6554	Return a list of the guest properties matching a set of patterns along
6555	with their values, time stamps and flags.
6556	</desc>
6557	<param name="patterns" type="wstring" dir="in">
6558	<desc>
6559	The patterns to match the properties against, separated by '\|'
6560	characters. If this is empty or @c null, all properties will match.
6561	</desc>
6562	</param>
6563	<param name="names" type="wstring" dir="out" safearray="yes">
6564	<desc>
6565	The names of the properties returned.
6566	</desc>
6567	</param>
6568	<param name="values" type="wstring" dir="out" safearray="yes">
6569	<desc>
6570	The values of the properties returned. The array entries match the
6571	corresponding entries in the @a name array.
6572	</desc>
6573	</param>
6574	<param name="timestamps" type="long long" dir="out" safearray="yes">
6575	<desc>
6576	The time stamps of the properties returned. The array entries match
6577	the corresponding entries in the @a name array.
6578	</desc>
6579	</param>
6580	<param name="flags" type="wstring" dir="out" safearray="yes">
6581	<desc>
6582	The flags of the properties returned. The array entries match the
6583	corresponding entries in the @a name array.
6584	</desc>
6585	</param>
6586	</method>
6587
6588	<method name="querySavedGuestScreenInfo" const="yes">
6589	<desc>
6590	Returns the guest dimensions from the saved state.
6591	</desc>
6592	<param name="screenId" type="unsigned long" dir="in">
6593	<desc>
6594	Saved guest screen to query info from.
6595	</desc>
6596	</param>
6597	<param name="originX" type="unsigned long" dir="out">
6598	<desc>
6599	The X position of the guest monitor top left corner.
6600	</desc>
6601	</param>
6602	<param name="originY" type="unsigned long" dir="out">
6603	<desc>
6604	The Y position of the guest monitor top left corner.
6605	</desc>
6606	</param>
6607	<param name="width" type="unsigned long" dir="out">
6608	<desc>
6609	Guest width at the time of the saved state was taken.
6610	</desc>
6611	</param>
6612	<param name="height" type="unsigned long" dir="out">
6613	<desc>
6614	Guest height at the time of the saved state was taken.
6615	</desc>
6616	</param>
6617	<param name="enabled" type="boolean" dir="out">
6618	<desc>
6619	Whether the monitor is enabled in the guest.
6620	</desc>
6621	</param>
6622	</method>
6623
6624	<method name="querySavedThumbnailSize">
6625	<desc>
6626	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6627	</desc>
6628	<param name="screenId" type="unsigned long" dir="in">
6629	<desc>
6630	Saved guest screen to query info from.
6631	</desc>
6632	</param>
6633	<param name="size" type="unsigned long" dir="out">
6634	<desc>
6635	Size of buffer required to store the bitmap.
6636	</desc>
6637	</param>
6638	<param name="width" type="unsigned long" dir="out">
6639	<desc>
6640	Bitmap width.
6641	</desc>
6642	</param>
6643	<param name="height" type="unsigned long" dir="out">
6644	<desc>
6645	Bitmap height.
6646	</desc>
6647	</param>
6648	</method>
6649
6650	<method name="readSavedThumbnailToArray">
6651	<desc>
6652	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6653	</desc>
6654	<param name="screenId" type="unsigned long" dir="in">
6655	<desc>
6656	Saved guest screen to read from.
6657	</desc>
6658	</param>
6659	<param name="BGR" type="boolean" dir="in">
6660	<desc>
6661	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6662	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6663	</desc>
6664	</param>
6665	<param name="width" type="unsigned long" dir="out">
6666	<desc>
6667	Bitmap width.
6668	</desc>
6669	</param>
6670	<param name="height" type="unsigned long" dir="out">
6671	<desc>
6672	Bitmap height.
6673	</desc>
6674	</param>
6675	<param name="data" type="octet" safearray="yes" dir="return">
6676	<desc>
6677	Array with resulting bitmap data.
6678	</desc>
6679	</param>
6680	</method>
6681
6682	<method name="readSavedThumbnailPNGToArray">
6683	<desc>
6684	Thumbnail in PNG format is retrieved to an array of bytes.
6685	</desc>
6686	<param name="screenId" type="unsigned long" dir="in">
6687	<desc>
6688	Saved guest screen to read from.
6689	</desc>
6690	</param>
6691	<param name="width" type="unsigned long" dir="out">
6692	<desc>
6693	Image width.
6694	</desc>
6695	</param>
6696	<param name="height" type="unsigned long" dir="out">
6697	<desc>
6698	Image height.
6699	</desc>
6700	</param>
6701	<param name="data" type="octet" dir="return" safearray="yes">
6702	<desc>
6703	Array with resulting PNG data.
6704	</desc>
6705	</param>
6706	</method>
6707
6708	<method name="querySavedScreenshotPNGSize">
6709	<desc>
6710	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6711	</desc>
6712	<param name="screenId" type="unsigned long" dir="in">
6713	<desc>
6714	Saved guest screen to query info from.
6715	</desc>
6716	</param>
6717	<param name="size" type="unsigned long" dir="out">
6718	<desc>
6719	Size of buffer required to store the PNG binary data.
6720	</desc>
6721	</param>
6722	<param name="width" type="unsigned long" dir="out">
6723	<desc>
6724	Image width.
6725	</desc>
6726	</param>
6727	<param name="height" type="unsigned long" dir="out">
6728	<desc>
6729	Image height.
6730	</desc>
6731	</param>
6732	</method>
6733
6734	<method name="readSavedScreenshotPNGToArray">
6735	<desc>
6736	Screenshot in PNG format is retrieved to an array of bytes.
6737	</desc>
6738	<param name="screenId" type="unsigned long" dir="in">
6739	<desc>
6740	Saved guest screen to read from.
6741	</desc>
6742	</param>
6743	<param name="width" type="unsigned long" dir="out">
6744	<desc>
6745	Image width.
6746	</desc>
6747	</param>
6748	<param name="height" type="unsigned long" dir="out">
6749	<desc>
6750	Image height.
6751	</desc>
6752	</param>
6753	<param name="data" type="octet" dir="return" safearray="yes">
6754	<desc>
6755	Array with resulting PNG data.
6756	</desc>
6757	</param>
6758	</method>
6759
6760	<method name="hotPlugCPU">
6761	<desc>
6762	Plugs a CPU into the machine.
6763	</desc>
6764	<param name="cpu" type="unsigned long" dir="in">
6765	<desc>
6766	The CPU id to insert.
6767	</desc>
6768	</param>
6769	</method>
6770
6771	<method name="hotUnplugCPU">
6772	<desc>
6773	Removes a CPU from the machine.
6774	</desc>
6775	<param name="cpu" type="unsigned long" dir="in">
6776	<desc>
6777	The CPU id to remove.
6778	</desc>
6779	</param>
6780	</method>
6781
6782	<method name="getCPUStatus">
6783	<desc>
6784	Returns the current status of the given CPU.
6785	</desc>
6786	<param name="cpu" type="unsigned long" dir="in">
6787	<desc>
6788	The CPU id to check for.
6789	</desc>
6790	</param>
6791	<param name="attached" type="boolean" dir="return">
6792	<desc>
6793	Status of the CPU.
6794	</desc>
6795	</param>
6796	</method>
6797
6798	<method name="queryLogFilename">
6799	<desc>
6800	Queries for the VM log file name of an given index. Returns an empty
6801	string if a log file with that index doesn't exists.
6802	</desc>
6803	<param name="idx" type="unsigned long" dir="in">
6804	<desc>
6805	Which log file name to query. 0=current log file.
6806	</desc>
6807	</param>
6808	<param name="filename" type="wstring" dir="return">
6809	<desc>
6810	On return the full path to the log file or an empty string on error.
6811	</desc>
6812	</param>
6813	</method>
6814
6815	<method name="readLog">
6816	<desc>
6817	Reads the VM log file. The chunk size is limited, so even if you
6818	ask for a big piece there might be less data returned.
6819	</desc>
6820	<param name="idx" type="unsigned long" dir="in">
6821	<desc>
6822	Which log file to read. 0=current log file.
6823	</desc>
6824	</param>
6825	<param name="offset" type="long long" dir="in">
6826	<desc>
6827	Offset in the log file.
6828	</desc>
6829	</param>
6830	<param name="size" type="long long" dir="in">
6831	<desc>
6832	Chunk size to read in the log file.
6833	</desc>
6834	</param>
6835	<param name="data" type="octet" dir="return" safearray="yes">
6836	<desc>
6837	Data read from the log file. A data size of 0 means end of file
6838	if the requested chunk size was not 0. This is the unprocessed
6839	file data, i.e. the line ending style depends on the platform of
6840	the system the server is running on.
6841	</desc>
6842	</param>
6843	</method>
6844
6845	<method name="cloneTo">
6846	<desc>
6847	Creates a clone of this machine, either as a full clone (which means
6848	creating independent copies of the hard disk media, save states and so
6849	on), or as a linked clone (which uses its own differencing media,
6850	sharing the parent media with the source machine).
6851
6852	The target machine object must have been created previously with <link
6853	to="IVirtualBox::createMachine"/>, and all the settings will be
6854	transferred except the VM name and the hardware UUID. You can set the
6855	VM name and the new hardware UUID when creating the target machine. The
6856	network MAC addresses are newly created for all newtwork adapters. You
6857	can change that behaviour with the options parameter. The operation is
6858	performed asynchronously, so the machine object will be not be usable
6859	until the @a progress object signals completion.
6860
6861	<result name="E_INVALIDARG">
6862	@a target is @c null.
6863	</result>
6864	</desc>
6865
6866	<param name="target" type="IMachine" dir="in">
6867	<desc>Target machine object.</desc>
6868	</param>
6869	<param name="mode" type="CloneMode" dir="in">
6870	<desc>Which states should be cloned.</desc>
6871	</param>
6872	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6873	<desc>Options for the cloning operation.</desc>
6874	</param>
6875	<param name="progress" type="IProgress" dir="return">
6876	<desc>Progress object to track the operation completion.</desc>
6877	</param>
6878	</method>
6879
6880	</interface>
6881
6882	<!--
6883	// IConsole
6884	/////////////////////////////////////////////////////////////////////////
6885	-->
6886
6887	<interface
6888	name="IVRDEServerInfo" extends="$unknown"
6889	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6890	wsmap="struct"
6891	>
6892	<desc>
6893	Contains information about the remote desktop (VRDE) server capabilities and status.
6894	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6895	</desc>
6896
6897	<attribute name="active" type="boolean" readonly="yes">
6898	<desc>
6899	Whether the remote desktop connection is active.
6900	</desc>
6901	</attribute>
6902
6903	<attribute name="port" type="long" readonly="yes">
6904	<desc>
6905	VRDE server port number. If this property is equal to <tt>0</tt>, then
6906	the VRDE server failed to start, usually because there are no free IP
6907	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6908	server has not yet been started.
6909	</desc>
6910	</attribute>
6911
6912	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6913	<desc>
6914	How many times a client connected.
6915	</desc>
6916	</attribute>
6917
6918	<attribute name="beginTime" type="long long" readonly="yes">
6919	<desc>
6920	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6921	</desc>
6922	</attribute>
6923
6924	<attribute name="endTime" type="long long" readonly="yes">
6925	<desc>
6926	When the last connection was terminated or the current time, if
6927	connection is still active, in milliseconds since 1970-01-01 UTC.
6928	</desc>
6929	</attribute>
6930
6931	<attribute name="bytesSent" type="long long" readonly="yes">
6932	<desc>
6933	How many bytes were sent in last or current, if still active, connection.
6934	</desc>
6935	</attribute>
6936
6937	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6938	<desc>
6939	How many bytes were sent in all connections.
6940	</desc>
6941	</attribute>
6942
6943	<attribute name="bytesReceived" type="long long" readonly="yes">
6944	<desc>
6945	How many bytes were received in last or current, if still active, connection.
6946	</desc>
6947	</attribute>
6948
6949	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6950	<desc>
6951	How many bytes were received in all connections.
6952	</desc>
6953	</attribute>
6954
6955	<attribute name="user" type="wstring" readonly="yes">
6956	<desc>
6957	Login user name supplied by the client.
6958	</desc>
6959	</attribute>
6960
6961	<attribute name="domain" type="wstring" readonly="yes">
6962	<desc>
6963	Login domain name supplied by the client.
6964	</desc>
6965	</attribute>
6966
6967	<attribute name="clientName" type="wstring" readonly="yes">
6968	<desc>
6969	The client name supplied by the client.
6970	</desc>
6971	</attribute>
6972
6973	<attribute name="clientIP" type="wstring" readonly="yes">
6974	<desc>
6975	The IP address of the client.
6976	</desc>
6977	</attribute>
6978
6979	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6980	<desc>
6981	The client software version number.
6982	</desc>
6983	</attribute>
6984
6985	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6986	<desc>
6987	Public key exchange method used when connection was established.
6988	Values: 0 - RDP4 public key exchange scheme.
6989	1 - X509 certificates were sent to client.
6990	</desc>
6991	</attribute>
6992
6993	</interface>
6994
6995	<interface
6996	name="IConsole" extends="$unknown"
6997	uuid="db7ab4ca-2a3f-4183-9243-c1208da92392"
6998	wsmap="managed"
6999	>
7000	<desc>
7001	The IConsole interface represents an interface to control virtual
7002	machine execution.
7003
7004	A console object gets created when a machine has been locked for a
7005	particular session (client process) using <link to="IMachine::lockMachine" />
7006	or <link to="IMachine::launchVMProcess"/>. The console object can
7007	then be found in the session's <link to="ISession::console" /> attribute.
7008
7009	Methods of the IConsole interface allow the caller to query the current
7010	virtual machine execution state, pause the machine or power it down, save
7011	the machine state or take a snapshot, attach and detach removable media
7012	and so on.
7013
7014	<see><link to="ISession"/></see>
7015	</desc>
7016
7017	<attribute name="machine" type="IMachine" readonly="yes">
7018	<desc>
7019	Machine object for this console session.
7020	<note>
7021	This is a convenience property, it has the same value as
7022	<link to="ISession::machine"/> of the corresponding session
7023	object.
7024	</note>
7025	</desc>
7026	</attribute>
7027
7028	<attribute name="state" type="MachineState" readonly="yes">
7029	<desc>
7030	Current execution state of the machine.
7031	<note>
7032	This property always returns the same value as the corresponding
7033	property of the IMachine object for this console session.
7034	For the process that owns (executes) the VM, this is the
7035	preferable way of querying the VM state, because no IPC
7036	calls are made.
7037	</note>
7038	</desc>
7039	</attribute>
7040
7041	<attribute name="guest" type="IGuest" readonly="yes">
7042	<desc>Guest object.</desc>
7043	</attribute>
7044
7045	<attribute name="keyboard" type="IKeyboard" readonly="yes">
7046	<desc>
7047	Virtual keyboard object.
7048	<note>
7049	If the machine is not running, any attempt to use
7050	the returned object will result in an error.
7051	</note>
7052	</desc>
7053	</attribute>
7054
7055	<attribute name="mouse" type="IMouse" readonly="yes">
7056	<desc>
7057	Virtual mouse object.
7058	<note>
7059	If the machine is not running, any attempt to use
7060	the returned object will result in an error.
7061	</note>
7062	</desc>
7063	</attribute>
7064
7065	<attribute name="display" type="IDisplay" readonly="yes">
7066	<desc>Virtual display object.
7067	<note>
7068	If the machine is not running, any attempt to use
7069	the returned object will result in an error.
7070	</note>
7071	</desc>
7072	</attribute>
7073
7074	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
7075	<desc>Debugging interface.</desc>
7076	</attribute>
7077
7078	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
7079	<desc>
7080	Collection of USB devices currently attached to the virtual
7081	USB controller.
7082	<note>
7083	The collection is empty if the machine is not running.
7084	</note>
7085	</desc>
7086	</attribute>
7087
7088	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7089	<desc>
7090	List of USB devices currently attached to the remote VRDE client.
7091	Once a new device is physically attached to the remote host computer,
7092	it appears in this list and remains there until detached.
7093	</desc>
7094	</attribute>
7095
7096	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
7097	<desc>
7098	Collection of shared folders for the current session. These folders
7099	are called transient shared folders because they are available to the
7100	guest OS running inside the associated virtual machine only for the
7101	duration of the session (as opposed to
7102	<link to="IMachine::sharedFolders"/> which represent permanent shared
7103	folders). When the session is closed (e.g. the machine is powered down),
7104	these folders are automatically discarded.
7105
7106	New shared folders are added to the collection using
7107	<link to="#createSharedFolder"/>. Existing shared folders can be
7108	removed using <link to="#removeSharedFolder"/>.
7109	</desc>
7110	</attribute>
7111
7112	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
7113	<desc>
7114	Interface that provides information on Remote Desktop Extension (VRDE) connection.
7115	</desc>
7116	</attribute>
7117
7118	<attribute name="eventSource" type="IEventSource" readonly="yes">
7119	<desc>
7120	Event source for console events.
7121	</desc>
7122	</attribute>
7123
7124	<attribute name="attachedPCIDevices" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
7125	<desc>Array of PCI devices attached to this machine.</desc>
7126	</attribute>
7127
7128	<attribute name="useHostClipboard" type="boolean">
7129	<desc>
7130	Whether the guest clipboard should be connected to the host one or
7131	whether it should only be allowed access to the VRDE clipboard. This
7132	setting may not affect existing guest clipboard connections which
7133	are already connected to the host clipboard.
7134	</desc>
7135	</attribute>
7136
7137	<method name="powerUp">
7138	<desc>
7139	Starts the virtual machine execution using the current machine
7140	state (that is, its current execution state, current settings and
7141	current storage devices).
7142
7143	<note>
7144	This method is only useful for front-ends that want to actually
7145	execute virtual machines in their own process (like the VirtualBox
7146	or VBoxSDL front-ends). Unless you are intending to write such a
7147	front-end, do not call this method. If you simply want to
7148	start virtual machine execution using one of the existing front-ends
7149	(for example the VirtualBox GUI or headless server), use
7150	<link to="IMachine::launchVMProcess"/> instead; these
7151	front-ends will power up the machine automatically for you.
7152	</note>
7153
7154	If the machine is powered off or aborted, the execution will
7155	start from the beginning (as if the real hardware were just
7156	powered on).
7157
7158	If the machine is in the <link to="MachineState_Saved"/> state,
7159	it will continue its execution the point where the state has
7160	been saved.
7161
7162	If the machine <link to="IMachine::teleporterEnabled"/> property is
7163	enabled on the machine being powered up, the machine will wait for an
7164	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
7165	state. The returned progress object will have at least three
7166	operations where the last three are defined as: (1) powering up and
7167	starting TCP server, (2) waiting for incoming teleportations, and
7168	(3) perform teleportation. These operations will be reflected as the
7169	last three operations of the progress objected returned by
7170	<link to="IMachine::launchVMProcess"/> as well.
7171
7172	<see><link to="#saveState"/></see>
7173
7174	<result name="VBOX_E_INVALID_VM_STATE">
7175	Virtual machine already running.
7176	</result>
7177	<result name="VBOX_E_HOST_ERROR">
7178	Host interface does not exist or name not set.
7179	</result>
7180	<result name="VBOX_E_FILE_ERROR">
7181	Invalid saved state file.
7182	</result>
7183	</desc>
7184	<param name="progress" type="IProgress" dir="return">
7185	<desc>Progress object to track the operation completion.</desc>
7186	</param>
7187	</method>
7188
7189	<method name="powerUpPaused">
7190	<desc>
7191	Identical to powerUp except that the VM will enter the
7192	<link to="MachineState_Paused"/> state, instead of
7193	<link to="MachineState_Running"/>.
7194
7195	<see><link to="#powerUp"/></see>
7196	<result name="VBOX_E_INVALID_VM_STATE">
7197	Virtual machine already running.
7198	</result>
7199	<result name="VBOX_E_HOST_ERROR">
7200	Host interface does not exist or name not set.
7201	</result>
7202	<result name="VBOX_E_FILE_ERROR">
7203	Invalid saved state file.
7204	</result>
7205	</desc>
7206	<param name="progress" type="IProgress" dir="return">
7207	<desc>Progress object to track the operation completion.</desc>
7208	</param>
7209	</method>
7210
7211	<method name="powerDown">
7212	<desc>
7213	Initiates the power down procedure to stop the virtual machine
7214	execution.
7215
7216	The completion of the power down procedure is tracked using the returned
7217	IProgress object. After the operation is complete, the machine will go
7218	to the PoweredOff state.
7219	<result name="VBOX_E_INVALID_VM_STATE">
7220	Virtual machine must be Running, Paused or Stuck to be powered down.
7221	</result>
7222	</desc>
7223	<param name="progress" type="IProgress" dir="return">
7224	<desc>Progress object to track the operation completion.</desc>
7225	</param>
7226	</method>
7227
7228	<method name="reset">
7229	<desc>Resets the virtual machine.
7230	<result name="VBOX_E_INVALID_VM_STATE">
7231	Virtual machine not in Running state.
7232	</result>
7233	<result name="VBOX_E_VM_ERROR">
7234	Virtual machine error in reset operation.
7235	</result>
7236	</desc>
7237	</method>
7238
7239	<method name="pause">
7240	<desc>Pauses the virtual machine execution.
7241	<result name="VBOX_E_INVALID_VM_STATE">
7242	Virtual machine not in Running state.
7243	</result>
7244	<result name="VBOX_E_VM_ERROR">
7245	Virtual machine error in suspend operation.
7246	</result>
7247	</desc>
7248	</method>
7249
7250	<method name="resume">
7251	<desc>Resumes the virtual machine execution.
7252	<result name="VBOX_E_INVALID_VM_STATE">
7253	Virtual machine not in Paused state.
7254	</result>
7255	<result name="VBOX_E_VM_ERROR">
7256	Virtual machine error in resume operation.
7257	</result>
7258	</desc>
7259	</method>
7260
7261	<method name="powerButton">
7262	<desc>Sends the ACPI power button event to the guest.
7263	<result name="VBOX_E_INVALID_VM_STATE">
7264	Virtual machine not in Running state.
7265	</result>
7266	<result name="VBOX_E_PDM_ERROR">
7267	Controlled power off failed.
7268	</result>
7269	</desc>
7270	</method>
7271
7272	<method name="sleepButton">
7273	<desc>Sends the ACPI sleep button event to the guest.
7274	<result name="VBOX_E_INVALID_VM_STATE">
7275	Virtual machine not in Running state.
7276	</result>
7277	<result name="VBOX_E_PDM_ERROR">
7278	Sending sleep button event failed.
7279	</result>
7280	</desc>
7281	</method>
7282
7283	<method name="getPowerButtonHandled">
7284	<desc>Checks if the last power button event was handled by guest.
7285	<result name="VBOX_E_PDM_ERROR">
7286	Checking if the event was handled by the guest OS failed.
7287	</result>
7288	</desc>
7289	<param name="handled" type="boolean" dir="return"/>
7290	</method>
7291
7292	<method name="getGuestEnteredACPIMode">
7293	<desc>Checks if the guest entered the ACPI mode G0 (working) or
7294	G1 (sleeping). If this method returns @c false, the guest will
7295	most likely not respond to external ACPI events.
7296	<result name="VBOX_E_INVALID_VM_STATE">
7297	Virtual machine not in Running state.
7298	</result>
7299	</desc>
7300	<param name="entered" type="boolean" dir="return"/>
7301	</method>
7302
7303	<method name="saveState">
7304	<desc>
7305	Saves the current execution state of a running virtual machine
7306	and stops its execution.
7307
7308	After this operation completes, the machine will go to the
7309	Saved state. Next time it is powered up, this state will
7310	be restored and the machine will continue its execution from
7311	the place where it was saved.
7312
7313	This operation differs from taking a snapshot to the effect
7314	that it doesn't create new differencing media. Also, once
7315	the machine is powered up from the state saved using this method,
7316	the saved state is deleted, so it will be impossible to return
7317	to this state later.
7318
7319	<note>
7320	On success, this method implicitly calls
7321	<link to="IMachine::saveSettings"/> to save all current machine
7322	settings (including runtime changes to the DVD medium, etc.).
7323	Together with the impossibility to change any VM settings when it is
7324	in the Saved state, this guarantees adequate hardware
7325	configuration of the machine when it is restored from the saved
7326	state file.
7327	</note>
7328
7329	<note>
7330	The machine must be in the Running or Paused state, otherwise
7331	the operation will fail.
7332	</note>
7333	<result name="VBOX_E_INVALID_VM_STATE">
7334	Virtual machine state neither Running nor Paused.
7335	</result>
7336	<result name="VBOX_E_FILE_ERROR">
7337	Failed to create directory for saved state file.
7338	</result>
7339
7340	<see><link to="#takeSnapshot"/></see>
7341	</desc>
7342	<param name="progress" type="IProgress" dir="return">
7343	<desc>Progress object to track the operation completion.</desc>
7344	</param>
7345	</method>
7346
7347	<method name="adoptSavedState">
7348	<desc>
7349	Associates the given saved state file to the virtual machine.
7350
7351	On success, the machine will go to the Saved state. Next time it is
7352	powered up, it will be restored from the adopted saved state and
7353	continue execution from the place where the saved state file was
7354	created.
7355
7356	The specified saved state file path may be absolute or relative to the
7357	folder the VM normally saves the state to (usually,
7358	<link to="IMachine::snapshotFolder"/>).
7359
7360	<note>
7361	It's a caller's responsibility to make sure the given saved state
7362	file is compatible with the settings of this virtual machine that
7363	represent its virtual hardware (memory size, storage disk configuration
7364	etc.). If there is a mismatch, the behavior of the virtual machine
7365	is undefined.
7366	</note>
7367	<result name="VBOX_E_INVALID_VM_STATE">
7368	Virtual machine state neither PoweredOff nor Aborted.
7369	</result>
7370	</desc>
7371	<param name="savedStateFile" type="wstring" dir="in">
7372	<desc>Path to the saved state file to adopt.</desc>
7373	</param>
7374	</method>
7375
7376	<method name="discardSavedState">
7377	<desc>
7378	Forcibly resets the machine to "Powered Off" state if it is
7379	currently in the "Saved" state (previously created by <link to="#saveState"/>).
7380	Next time the machine is powered up, a clean boot will occur.
7381	<note>
7382	This operation is equivalent to resetting or powering off
7383	the machine without doing a proper shutdown of the guest
7384	operating system; as with resetting a running phyiscal
7385	computer, it can can lead to data loss.
7386	</note>
7387	If @a fRemoveFile is @c true, the file in the machine directory
7388	into which the machine state was saved is also deleted. If
7389	this is @c false, then the state can be recovered and later
7390	re-inserted into a machine using <link to="#adoptSavedState" />.
7391	The location of the file can be found in the
7392	<link to="IMachine::stateFilePath" /> attribute.
7393	<result name="VBOX_E_INVALID_VM_STATE">
7394	Virtual machine not in state Saved.
7395	</result>
7396	</desc>
7397	<param name="fRemoveFile" type="boolean" dir="in" >
7398	<desc>Whether to also remove the saved state file.</desc>
7399	</param>
7400	</method>
7401
7402	<method name="getDeviceActivity">
7403	<desc>
7404	Gets the current activity type of a given device or device group.
7405	<result name="E_INVALIDARG">
7406	Invalid device type.
7407	</result>
7408	</desc>
7409	<param name="type" type="DeviceType" dir="in"/>
7410	<param name="activity" type="DeviceActivity" dir="return"/>
7411	</method>
7412
7413	<method name="attachUSBDevice">
7414	<desc>
7415	Attaches a host USB device with the given UUID to the
7416	USB controller of the virtual machine.
7417
7418	The device needs to be in one of the following states:
7419	<link to="USBDeviceState_Busy"/>,
7420	<link to="USBDeviceState_Available"/> or
7421	<link to="USBDeviceState_Held"/>,
7422	otherwise an error is immediately returned.
7423
7424	When the device state is
7425	<link to="USBDeviceState_Busy">Busy</link>, an error may also
7426	be returned if the host computer refuses to release it for some reason.
7427
7428	<see><link to="IUSBController::deviceFilters"/>,
7429	<link to="USBDeviceState"/></see>
7430	<result name="VBOX_E_INVALID_VM_STATE">
7431	Virtual machine state neither Running nor Paused.
7432	</result>
7433	<result name="VBOX_E_PDM_ERROR">
7434	Virtual machine does not have a USB controller.
7435	</result>
7436	</desc>
7437	<param name="id" type="uuid" mod="string" dir="in">
7438	<desc>UUID of the host USB device to attach.</desc>
7439	</param>
7440	</method>
7441
7442	<method name="detachUSBDevice">
7443	<desc>
7444	Detaches an USB device with the given UUID from the USB controller
7445	of the virtual machine.
7446
7447	After this method succeeds, the VirtualBox server re-initiates
7448	all USB filters as if the device were just physically attached
7449	to the host, but filters of this machine are ignored to avoid
7450	a possible automatic re-attachment.
7451
7452	<see><link to="IUSBController::deviceFilters"/>,
7453	<link to="USBDeviceState"/></see>
7454
7455	<result name="VBOX_E_PDM_ERROR">
7456	Virtual machine does not have a USB controller.
7457	</result>
7458	<result name="E_INVALIDARG">
7459	USB device not attached to this virtual machine.
7460	</result>
7461	</desc>
7462	<param name="id" type="uuid" mod="string" dir="in">
7463	<desc>UUID of the USB device to detach.</desc>
7464	</param>
7465	<param name="device" type="IUSBDevice" dir="return">
7466	<desc>Detached USB device.</desc>
7467	</param>
7468	</method>
7469
7470	<method name="findUSBDeviceByAddress">
7471	<desc>
7472	Searches for a USB device with the given host address.
7473
7474	<result name="VBOX_E_OBJECT_NOT_FOUND">
7475	Given @c name does not correspond to any USB device.
7476	</result>
7477
7478	<see><link to="IUSBDevice::address"/></see>
7479	</desc>
7480	<param name="name" type="wstring" dir="in">
7481	<desc>
7482	Address of the USB device (as assigned by the host) to
7483	search for.
7484	</desc>
7485	</param>
7486	<param name="device" type="IUSBDevice" dir="return">
7487	<desc>Found USB device object.</desc>
7488	</param>
7489	</method>
7490
7491	<method name="findUSBDeviceById">
7492	<desc>
7493	Searches for a USB device with the given UUID.
7494
7495	<result name="VBOX_E_OBJECT_NOT_FOUND">
7496	Given @c id does not correspond to any USB device.
7497	</result>
7498
7499	<see><link to="IUSBDevice::id"/></see>
7500	</desc>
7501	<param name="id" type="uuid" mod="string" dir="in">
7502	<desc>UUID of the USB device to search for.</desc>
7503	</param>
7504	<param name="device" type="IUSBDevice" dir="return">
7505	<desc>Found USB device object.</desc>
7506	</param>
7507	</method>
7508
7509	<method name="createSharedFolder">
7510	<desc>
7511	Creates a transient new shared folder by associating the given logical
7512	name with the given host path, adds it to the collection of shared
7513	folders and starts sharing it. Refer to the description of
7514	<link to="ISharedFolder"/> to read more about logical names.
7515
7516	<result name="VBOX_E_INVALID_VM_STATE">
7517	Virtual machine in Saved state or currently changing state.
7518	</result>
7519	<result name="VBOX_E_FILE_ERROR">
7520	Shared folder already exists or not accessible.
7521	</result>
7522	</desc>
7523	<param name="name" type="wstring" dir="in">
7524	<desc>Unique logical name of the shared folder.</desc>
7525	</param>
7526	<param name="hostPath" type="wstring" dir="in">
7527	<desc>Full path to the shared folder in the host file system.</desc>
7528	</param>
7529	<param name="writable" type="boolean" dir="in">
7530	<desc>Whether the share is writable or readonly</desc>
7531	</param>
7532	<param name="automount" type="boolean" dir="in">
7533	<desc>Whether the share gets automatically mounted by the guest
7534	or not.</desc>
7535	</param>
7536	</method>
7537
7538	<method name="removeSharedFolder">
7539	<desc>
7540	Removes a transient shared folder with the given name previously
7541	created by <link to="#createSharedFolder"/> from the collection of
7542	shared folders and stops sharing it.
7543	<result name="VBOX_E_INVALID_VM_STATE">
7544	Virtual machine in Saved state or currently changing state.
7545	</result>
7546	<result name="VBOX_E_FILE_ERROR">
7547	Shared folder does not exists.
7548	</result>
7549	</desc>
7550	<param name="name" type="wstring" dir="in">
7551	<desc>Logical name of the shared folder to remove.</desc>
7552	</param>
7553	</method>
7554
7555	<method name="takeSnapshot">
7556	<desc>
7557	Saves the current execution state
7558	and all settings of the machine and creates differencing images
7559	for all normal (non-independent) media.
7560	See <link to="ISnapshot" /> for an introduction to snapshots.
7561
7562	This method can be called for a PoweredOff, Saved (see
7563	<link to="#saveState"/>), Running or
7564	Paused virtual machine. When the machine is PoweredOff, an
7565	offline snapshot is created. When the machine is Running a live
7566	snapshot is created, and an online snapshot is created when Paused.
7567
7568	The taken snapshot is always based on the
7569	<link to="IMachine::currentSnapshot">current snapshot</link>
7570	of the associated virtual machine and becomes a new current snapshot.
7571
7572	<note>
7573	This method implicitly calls <link to="IMachine::saveSettings"/> to
7574	save all current machine settings before taking an offline snapshot.
7575	</note>
7576
7577	<result name="VBOX_E_INVALID_VM_STATE">
7578	Virtual machine currently changing state.
7579	</result>
7580	</desc>
7581	<param name="name" type="wstring" dir="in">
7582	<desc>Short name for the snapshot.</desc>
7583	</param>
7584	<param name="description" type="wstring" dir="in">
7585	<desc>Optional description of the snapshot.</desc>
7586	</param>
7587	<param name="progress" type="IProgress" dir="return">
7588	<desc>Progress object to track the operation completion.</desc>
7589	</param>
7590	</method>
7591
7592	<method name="deleteSnapshot">
7593	<desc>
7594	Starts deleting the specified snapshot asynchronously.
7595	See <link to="ISnapshot" /> for an introduction to snapshots.
7596
7597	The execution state and settings of the associated machine stored in
7598	the snapshot will be deleted. The contents of all differencing media of
7599	this snapshot will be merged with the contents of their dependent child
7600	media to keep the medium chain valid (in other words, all changes
7601	represented by media being deleted will be propagated to their child
7602	medium). After that, this snapshot's differencing medium will be
7603	deleted. The parent of this snapshot will become a new parent for all
7604	its child snapshots.
7605
7606	If the deleted snapshot is the current one, its parent snapshot will
7607	become a new current snapshot. The current machine state is not directly
7608	affected in this case, except that currently attached differencing
7609	media based on media of the deleted snapshot will be also merged as
7610	described above.
7611
7612	If the deleted snapshot is the first or current snapshot, then the
7613	respective IMachine attributes will be adjusted. Deleting the current
7614	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7615	to make all current machine settings permanent.
7616
7617	Deleting a snapshot has the following preconditions:
7618
7619	<ul>
7620	<li>Child media of all normal media of the deleted snapshot
7621	must be accessible (see <link to="IMedium::state"/>) for this
7622	operation to succeed. If only one running VM refers to all images
7623	which participates in merging the operation can be performed while
7624	the VM is running. Otherwise all virtual machines whose media are
7625	directly or indirectly based on the media of deleted snapshot must
7626	be powered off. In any case, online snapshot deleting usually is
7627	slower than the same operation without any running VM.</li>
7628
7629	<li>You cannot delete the snapshot if a medium attached to it has
7630	more than one child medium (differencing images) because otherwise
7631	merging would be impossible. This might be the case if there is
7632	more than one child snapshot or differencing images were created
7633	for other reason (e.g. implicitly because of multiple machine
7634	attachments).</li>
7635	</ul>
7636
7637	The virtual machine's <link to="IMachine::state">state</link> is
7638	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7639	"DeletingSnapshotPaused" while this operation is in progress.
7640
7641	<note>
7642	Merging medium contents can be very time and disk space
7643	consuming, if these media are big in size and have many
7644	children. However, if the snapshot being deleted is the last
7645	(head) snapshot on the branch, the operation will be rather
7646	quick.
7647	</note>
7648	<result name="VBOX_E_INVALID_VM_STATE">
7649	The running virtual machine prevents deleting this snapshot. This
7650	happens only in very specific situations, usually snapshots can be
7651	deleted without trouble while a VM is running. The error message
7652	text explains the reason for the failure.
7653	</result>
7654	</desc>
7655	<param name="id" type="uuid" mod="string" dir="in">
7656	<desc>UUID of the snapshot to delete.</desc>
7657	</param>
7658	<param name="progress" type="IProgress" dir="return">
7659	<desc>Progress object to track the operation completion.</desc>
7660	</param>
7661	</method>
7662
7663	<method name="deleteSnapshotAndAllChildren">
7664	<desc>
7665	Starts deleting the specified snapshot and all its children
7666	asynchronously. See <link to="ISnapshot" /> for an introduction to
7667	snapshots. The conditions and many details are the same as with
7668	<link to="#deleteSnapshot"/>.
7669
7670	This operation is very fast if the snapshot subtree does not include
7671	the current state. It is still significantly faster than deleting the
7672	snapshots one by one if the current state is in the subtree and there
7673	are more than one snapshots from current state to the snapshot which
7674	marks the subtree, since it eliminates the incremental image merging.
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="id" type="uuid" mod="string" dir="in">
7689	<desc>UUID of the snapshot to delete, including all its children.</desc>
7690	</param>
7691	<param name="progress" type="IProgress" dir="return">
7692	<desc>Progress object to track the operation completion.</desc>
7693	</param>
7694	</method>
7695
7696	<method name="deleteSnapshotRange">
7697	<desc>
7698	Starts deleting the specified snapshot range. This is limited to
7699	linear snapshot lists, which means there may not be any other child
7700	snapshots other than the direct sequence between the start and end
7701	snapshot. If the start and end snapshot point to the same snapshot this
7702	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7703	<link to="ISnapshot" /> for an introduction to snapshots. The
7704	conditions and many details are the same as with
7705	<link to="#deleteSnapshot"/>.
7706
7707	This operation is generally faster than deleting snapshots one by one
7708	and often also needs less extra disk space before freeing up disk space
7709	by deleting the removed disk images corresponding to the snapshot.
7710
7711	<note>This API method is right now not implemented!</note>
7712
7713	<result name="VBOX_E_INVALID_VM_STATE">
7714	The running virtual machine prevents deleting this snapshot. This
7715	happens only in very specific situations, usually snapshots can be
7716	deleted without trouble while a VM is running. The error message
7717	text explains the reason for the failure.
7718	</result>
7719	<result name="E_NOTIMPL">
7720	The method is not implemented yet.
7721	</result>
7722	</desc>
7723	<param name="startId" type="uuid" mod="string" dir="in">
7724	<desc>UUID of the first snapshot to delete.</desc>
7725	</param>
7726	<param name="endId" type="uuid" mod="string" dir="in">
7727	<desc>UUID of the last snapshot to delete.</desc>
7728	</param>
7729	<param name="progress" type="IProgress" dir="return">
7730	<desc>Progress object to track the operation completion.</desc>
7731	</param>
7732	</method>
7733
7734	<method name="restoreSnapshot">
7735	<desc>
7736	Starts resetting the machine's current state to the state contained
7737	in the given snapshot, asynchronously. All current settings of the
7738	machine will be reset and changes stored in differencing media
7739	will be lost.
7740	See <link to="ISnapshot" /> for an introduction to snapshots.
7741
7742	After this operation is successfully completed, new empty differencing
7743	media are created for all normal media of the machine.
7744
7745	If the given snapshot is an online snapshot, the machine will go to
7746	the <link to="MachineState_Saved"> saved state</link>, so that the
7747	next time it is powered on, the execution state will be restored
7748	from the state of the snapshot.
7749
7750	<note>
7751	The machine must not be running, otherwise the operation will fail.
7752	</note>
7753
7754	<note>
7755	If the machine state is <link to="MachineState_Saved">Saved</link>
7756	prior to this operation, the saved state file will be implicitly
7757	deleted (as if <link to="IConsole::discardSavedState"/> were
7758	called).
7759	</note>
7760
7761	<result name="VBOX_E_INVALID_VM_STATE">
7762	Virtual machine is running.
7763	</result>
7764	</desc>
7765	<param name="snapshot" type="ISnapshot" dir="in">
7766	<desc>The snapshot to restore the VM state from.</desc>
7767	</param>
7768	<param name="progress" type="IProgress" dir="return">
7769	<desc>Progress object to track the operation completion.</desc>
7770	</param>
7771	</method>
7772
7773	<method name="teleport">
7774	<desc>
7775	Teleport the VM to a different host machine or process.
7776
7777	TODO explain the details.
7778
7779	<result name="VBOX_E_INVALID_VM_STATE">
7780	Virtual machine not running or paused.
7781	</result>
7782	</desc>
7783	<param name="hostname" type="wstring" dir="in">
7784	<desc>The name or IP of the host to teleport to.</desc>
7785	</param>
7786	<param name="tcpport" type="unsigned long" dir="in">
7787	<desc>The TCP port to connect to (1..65535).</desc>
7788	</param>
7789	<param name="password" type="wstring" dir="in">
7790	<desc>The password.</desc>
7791	</param>
7792	<param name="maxDowntime" type="unsigned long" dir="in">
7793	<desc>
7794	The maximum allowed downtime given as milliseconds. 0 is not a valid
7795	value. Recommended value: 250 ms.
7796
7797	The higher the value is, the greater the chance for a successful
7798	teleportation. A small value may easily result in the teleportation
7799	process taking hours and eventually fail.
7800
7801	<note>
7802	The current implementation treats this a guideline, not as an
7803	absolute rule.
7804	</note>
7805	</desc>
7806	</param>
7807	<param name="progress" type="IProgress" dir="return">
7808	<desc>Progress object to track the operation completion.</desc>
7809	</param>
7810	</method>
7811
7812	</interface>
7813
7814	<!--
7815	// IHost
7816	/////////////////////////////////////////////////////////////////////////
7817	-->
7818
7819	<enum
7820	name="HostNetworkInterfaceMediumType"
7821	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7822	>
7823	<desc>
7824	Type of encapsulation. Ethernet encapsulation includes both wired and
7825	wireless Ethernet connections.
7826	<see><link to="IHostNetworkInterface"/></see>
7827	</desc>
7828
7829	<const name="Unknown" value="0">
7830	<desc>
7831	The type of interface cannot be determined.
7832	</desc>
7833	</const>
7834	<const name="Ethernet" value="1">
7835	<desc>
7836	Ethernet frame encapsulation.
7837	</desc>
7838	</const>
7839	<const name="PPP" value="2">
7840	<desc>
7841	Point-to-point protocol encapsulation.
7842	</desc>
7843	</const>
7844	<const name="SLIP" value="3">
7845	<desc>
7846	Serial line IP encapsulation.
7847	</desc>
7848	</const>
7849	</enum>
7850
7851	<enum
7852	name="HostNetworkInterfaceStatus"
7853	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7854	>
7855	<desc>
7856	Current status of the interface.
7857	<see><link to="IHostNetworkInterface"/></see>
7858	</desc>
7859
7860	<const name="Unknown" value="0">
7861	<desc>
7862	The state of interface cannot be determined.
7863	</desc>
7864	</const>
7865	<const name="Up" value="1">
7866	<desc>
7867	The interface is fully operational.
7868	</desc>
7869	</const>
7870	<const name="Down" value="2">
7871	<desc>
7872	The interface is not functioning.
7873	</desc>
7874	</const>
7875	</enum>
7876
7877	<enum
7878	name="HostNetworkInterfaceType"
7879	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7880	>
7881	<desc>
7882	Network interface type.
7883	</desc>
7884	<const name="Bridged" value="1"/>
7885	<const name="HostOnly" value="2"/>
7886	</enum>
7887
7888	<interface
7889	name="IHostNetworkInterface" extends="$unknown"
7890	uuid="87a4153d-6889-4dd6-9654-2e9ff0ae8dec"
7891	wsmap="managed"
7892	>
7893	<desc>
7894	Represents one of host's network interfaces. IP V6 address and network
7895	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7896	separated by colons.
7897	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7898	</desc>
7899	<attribute name="name" type="wstring" readonly="yes">
7900	<desc>Returns the host network interface name.</desc>
7901	</attribute>
7902
7903	<attribute name="id" type="uuid" mod="string" readonly="yes">
7904	<desc>Returns the interface UUID.</desc>
7905	</attribute>
7906
7907	<attribute name="networkName" type="wstring" readonly="yes">
7908	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7909	</attribute>
7910
7911	<attribute name="DHCPEnabled" type="boolean" readonly="yes">
7912	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7913	</attribute>
7914
7915	<attribute name="IPAddress" type="wstring" readonly="yes">
7916	<desc>Returns the IP V4 address of the interface.</desc>
7917	</attribute>
7918
7919	<attribute name="networkMask" type="wstring" readonly="yes">
7920	<desc>Returns the network mask of the interface.</desc>
7921	</attribute>
7922
7923	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7924	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7925	</attribute>
7926
7927	<attribute name="IPV6Address" type="wstring" readonly="yes">
7928	<desc>Returns the IP V6 address of the interface.</desc>
7929	</attribute>
7930
7931	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7932	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7933	</attribute>
7934
7935	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7936	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7937	</attribute>
7938
7939	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7940	<desc>Type of protocol encapsulation used.</desc>
7941	</attribute>
7942
7943	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7944	<desc>Status of the interface.</desc>
7945	</attribute>
7946
7947	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7948	<desc>specifies the host interface type.</desc>
7949	</attribute>
7950
7951	<method name="enableStaticIPConfig">
7952	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7953	<param name="IPAddress" type="wstring" dir="in">
7954	<desc>
7955	IP address.
7956	</desc>
7957	</param>
7958	<param name="networkMask" type="wstring" dir="in">
7959	<desc>
7960	network mask.
7961	</desc>
7962	</param>
7963	</method>
7964
7965	<method name="enableStaticIPConfigV6">
7966	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7967	<param name="IPV6Address" type="wstring" dir="in">
7968	<desc>
7969	IP address.
7970	</desc>
7971	</param>
7972	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7973	<desc>
7974	network mask.
7975	</desc>
7976	</param>
7977	</method>
7978
7979	<method name="enableDynamicIPConfig">
7980	<desc>enables the dynamic IP configuration.</desc>
7981	</method>
7982
7983	<method name="DHCPRediscover">
7984	<desc>refreshes the IP configuration for DHCP-enabled interface.</desc>
7985	</method>
7986
7987	</interface>
7988
7989	<interface
7990	name="IHost" extends="$unknown"
7991	uuid="30678943-32df-4830-b413-931b25ac86a0"
7992	wsmap="managed"
7993	>
7994	<desc>
7995	The IHost interface represents the physical machine that this VirtualBox
7996	installation runs on.
7997
7998	An object implementing this interface is returned by the
7999	<link to="IVirtualBox::host" /> attribute. This interface contains
8000	read-only information about the host's physical hardware (such as what
8001	processors and disks are available, what the host operating system is,
8002	and so on) and also allows for manipulating some of the host's hardware,
8003	such as global USB device filters and host interface networking.
8004
8005	</desc>
8006	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
8007	<desc>List of DVD drives available on the host.</desc>
8008	</attribute>
8009
8010	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
8011	<desc>List of floppy drives available on the host.</desc>
8012	</attribute>
8013
8014	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
8015	<desc>
8016	List of USB devices currently attached to the host.
8017	Once a new device is physically attached to the host computer,
8018	it appears in this list and remains there until detached.
8019
8020	<note>
8021	If USB functionality is not available in the given edition of
8022	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8023	</note>
8024	</desc>
8025	</attribute>
8026
8027	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
8028	<desc>
8029	List of USB device filters in action.
8030	When a new device is physically attached to the host computer,
8031	filters from this list are applied to it (in order they are stored
8032	in the list). The first matched filter will determine the
8033	<link to="IHostUSBDeviceFilter::action">action</link>
8034	performed on the device.
8035
8036	Unless the device is ignored by these filters, filters of all
8037	currently running virtual machines
8038	(<link to="IUSBController::deviceFilters"/>) are applied to it.
8039
8040	<note>
8041	If USB functionality is not available in the given edition of
8042	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8043	</note>
8044
8045	<see><link to="IHostUSBDeviceFilter"/>,
8046	<link to="USBDeviceState"/></see>
8047	</desc>
8048	</attribute>
8049
8050	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
8051	<desc>List of host network interfaces currently defined on the host.</desc>
8052	</attribute>
8053
8054	<attribute name="processorCount" type="unsigned long" readonly="yes">
8055	<desc>Number of (logical) CPUs installed in the host system.</desc>
8056	</attribute>
8057
8058	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
8059	<desc>Number of (logical) CPUs online in the host system.</desc>
8060	</attribute>
8061
8062	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
8063	<desc>Number of physical processor cores installed in the host system.</desc>
8064	</attribute>
8065
8066	<method name="getProcessorSpeed">
8067	<desc>Query the (approximate) maximum speed of a specified host CPU in
8068	Megahertz.
8069	</desc>
8070	<param name="cpuId" type="unsigned long" dir="in">
8071	<desc>
8072	Identifier of the CPU.
8073	</desc>
8074	</param>
8075	<param name="speed" type="unsigned long" dir="return">
8076	<desc>
8077	Speed value. 0 is returned if value is not known or @a cpuId is
8078	invalid.
8079	</desc>
8080	</param>
8081	</method>
8082
8083	<method name="getProcessorFeature">
8084	<desc>Query whether a CPU feature is supported or not.</desc>
8085	<param name="feature" type="ProcessorFeature" dir="in">
8086	<desc>
8087	CPU Feature identifier.
8088	</desc>
8089	</param>
8090	<param name="supported" type="boolean" dir="return">
8091	<desc>
8092	Feature is supported or not.
8093	</desc>
8094	</param>
8095	</method>
8096
8097	<method name="getProcessorDescription">
8098	<desc>Query the model string of a specified host CPU.
8099	</desc>
8100	<param name="cpuId" type="unsigned long" dir="in">
8101	<desc>
8102	Identifier of the CPU.
8103	<note>
8104	The current implementation might not necessarily return the
8105	description for this exact CPU.
8106	</note>
8107	</desc>
8108	</param>
8109	<param name="description" type="wstring" dir="return">
8110	<desc>
8111	Model string. An empty string is returned if value is not known or
8112	@a cpuId is invalid.
8113	</desc>
8114	</param>
8115	</method>
8116
8117	<method name="getProcessorCPUIDLeaf">
8118	<desc>
8119	Returns the CPU cpuid information for the specified leaf.
8120	</desc>
8121	<param name="cpuId" type="unsigned long" dir="in">
8122	<desc>
8123	Identifier of the CPU. The CPU most be online.
8124	<note>
8125	The current implementation might not necessarily return the
8126	description for this exact CPU.
8127	</note>
8128	</desc>
8129	</param>
8130	<param name="leaf" type="unsigned long" dir="in">
8131	<desc>
8132	CPUID leaf index (eax).
8133	</desc>
8134	</param>
8135	<param name="subLeaf" type="unsigned long" dir="in">
8136	<desc>
8137	CPUID leaf sub index (ecx). This currently only applies to cache
8138	information on Intel CPUs. Use 0 if retrieving values for
8139	<link to="IMachine::setCPUIDLeaf"/>.
8140	</desc>
8141	</param>
8142	<param name="valEax" type="unsigned long" dir="out">
8143	<desc>
8144	CPUID leaf value for register eax.
8145	</desc>
8146	</param>
8147	<param name="valEbx" type="unsigned long" dir="out">
8148	<desc>
8149	CPUID leaf value for register ebx.
8150	</desc>
8151	</param>
8152	<param name="valEcx" type="unsigned long" dir="out">
8153	<desc>
8154	CPUID leaf value for register ecx.
8155	</desc>
8156	</param>
8157	<param name="valEdx" type="unsigned long" dir="out">
8158	<desc>
8159	CPUID leaf value for register edx.
8160	</desc>
8161	</param>
8162	</method>
8163
8164	<attribute name="memorySize" type="unsigned long" readonly="yes">
8165	<desc>Amount of system memory in megabytes installed in the host system.</desc>
8166	</attribute>
8167
8168	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
8169	<desc>Available system memory in the host system.</desc>
8170	</attribute>
8171
8172	<attribute name="operatingSystem" type="wstring" readonly="yes">
8173	<desc>Name of the host system's operating system.</desc>
8174	</attribute>
8175
8176	<attribute name="OSVersion" type="wstring" readonly="yes">
8177	<desc>Host operating system's version string.</desc>
8178	</attribute>
8179
8180	<attribute name="UTCTime" type="long long" readonly="yes">
8181	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
8182	</attribute>
8183
8184	<attribute name="acceleration3DAvailable" type="boolean" readonly="yes">
8185	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
8186	</attribute>
8187
8188	<method name="createHostOnlyNetworkInterface">
8189	<desc>
8190	Creates a new adapter for Host Only Networking.
8191	<result name="E_INVALIDARG">
8192	Host network interface @a name already exists.
8193	</result>
8194	</desc>
8195	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
8196	<desc>
8197	Created host interface object.
8198	</desc>
8199	</param>
8200	<param name="progress" type="IProgress" dir="return">
8201	<desc>
8202	Progress object to track the operation completion.
8203	</desc>
8204	</param>
8205	</method>
8206
8207	<method name="removeHostOnlyNetworkInterface">
8208	<desc>
8209	Removes the given Host Only Networking interface.
8210	<result name="VBOX_E_OBJECT_NOT_FOUND">
8211	No host network interface matching @a id found.
8212	</result>
8213	</desc>
8214	<param name="id" type="uuid" mod="string" dir="in">
8215	<desc>
8216	Adapter GUID.
8217	</desc>
8218	</param>
8219	<param name="progress" type="IProgress" dir="return">
8220	<desc>
8221	Progress object to track the operation completion.
8222	</desc>
8223	</param>
8224	</method>
8225
8226	<method name="createUSBDeviceFilter">
8227	<desc>
8228	Creates a new USB device filter. All attributes except
8229	the filter name are set to empty (any match),
8230	<i>active</i> is @c false (the filter is not active).
8231
8232	The created filter can be added to the list of filters using
8233	<link to="#insertUSBDeviceFilter"/>.
8234
8235	<see><link to="#USBDeviceFilters"/></see>
8236	</desc>
8237	<param name="name" type="wstring" dir="in">
8238	<desc>
8239	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
8240	</desc>
8241	</param>
8242	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
8243	<desc>Created filter object.</desc>
8244	</param>
8245	</method>
8246
8247	<method name="insertUSBDeviceFilter">
8248	<desc>
8249	Inserts the given USB device to the specified position
8250	in the list of filters.
8251
8252	Positions are numbered starting from @c 0. If the specified
8253	position is equal to or greater than the number of elements in
8254	the list, the filter is added at the end of the collection.
8255
8256	<note>
8257	Duplicates are not allowed, so an attempt to insert a
8258	filter already in the list is an error.
8259	</note>
8260	<note>
8261	If USB functionality is not available in the given edition of
8262	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8263	</note>
8264
8265	<see><link to="#USBDeviceFilters"/></see>
8266
8267	<result name="VBOX_E_INVALID_OBJECT_STATE">
8268	USB device filter is not created within this VirtualBox instance.
8269	</result>
8270	<result name="E_INVALIDARG">
8271	USB device filter already in list.
8272	</result>
8273
8274	</desc>
8275	<param name="position" type="unsigned long" dir="in">
8276	<desc>Position to insert the filter to.</desc>
8277	</param>
8278	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
8279	<desc>USB device filter to insert.</desc>
8280	</param>
8281	</method>
8282
8283	<method name="removeUSBDeviceFilter">
8284	<desc>
8285	Removes a USB device filter from the specified position in the
8286	list of filters.
8287
8288	Positions are numbered starting from @c 0. Specifying a
8289	position equal to or greater than the number of elements in
8290	the list will produce an error.
8291
8292	<note>
8293	If USB functionality is not available in the given edition of
8294	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8295	</note>
8296
8297	<see><link to="#USBDeviceFilters"/></see>
8298
8299	<result name="E_INVALIDARG">
8300	USB device filter list empty or invalid @a position.
8301	</result>
8302
8303	</desc>
8304	<param name="position" type="unsigned long" dir="in">
8305	<desc>Position to remove the filter from.</desc>
8306	</param>
8307	</method>
8308
8309	<method name="findHostDVDDrive">
8310	<desc>
8311	Searches for a host DVD drive with the given @c name.
8312
8313	<result name="VBOX_E_OBJECT_NOT_FOUND">
8314	Given @c name does not correspond to any host drive.
8315	</result>
8316
8317	</desc>
8318	<param name="name" type="wstring" dir="in">
8319	<desc>Name of the host drive to search for</desc>
8320	</param>
8321	<param name="drive" type="IMedium" dir="return">
8322	<desc>Found host drive object</desc>
8323	</param>
8324	</method>
8325
8326	<method name="findHostFloppyDrive">
8327	<desc>
8328	Searches for a host floppy drive with the given @c name.
8329
8330	<result name="VBOX_E_OBJECT_NOT_FOUND">
8331	Given @c name does not correspond to any host floppy drive.
8332	</result>
8333
8334	</desc>
8335	<param name="name" type="wstring" dir="in">
8336	<desc>Name of the host floppy drive to search for</desc>
8337	</param>
8338	<param name="drive" type="IMedium" dir="return">
8339	<desc>Found host floppy drive object</desc>
8340	</param>
8341	</method>
8342
8343	<method name="findHostNetworkInterfaceByName">
8344	<desc>
8345	Searches through all host network interfaces for an interface with
8346	the given @c name.
8347	<note>
8348	The method returns an error if the given @c name does not
8349	correspond to any host network interface.
8350	</note>
8351	</desc>
8352	<param name="name" type="wstring" dir="in">
8353	<desc>Name of the host network interface to search for.</desc>
8354	</param>
8355	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8356	<desc>Found host network interface object.</desc>
8357	</param>
8358	</method>
8359	<method name="findHostNetworkInterfaceById">
8360	<desc>
8361	Searches through all host network interfaces for an interface with
8362	the given GUID.
8363	<note>
8364	The method returns an error if the given GUID does not
8365	correspond to any host network interface.
8366	</note>
8367	</desc>
8368	<param name="id" type="uuid" mod="string" dir="in">
8369	<desc>GUID of the host network interface to search for.</desc>
8370	</param>
8371	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8372	<desc>Found host network interface object.</desc>
8373	</param>
8374	</method>
8375	<method name="findHostNetworkInterfacesOfType">
8376	<desc>
8377	Searches through all host network interfaces and returns a list of interfaces of the specified type
8378	</desc>
8379	<param name="type" type="HostNetworkInterfaceType" dir="in">
8380	<desc>type of the host network interfaces to search for.</desc>
8381	</param>
8382	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
8383	<desc>Found host network interface objects.</desc>
8384	</param>
8385	</method>
8386
8387	<method name="findUSBDeviceById">
8388	<desc>
8389	Searches for a USB device with the given UUID.
8390
8391	<result name="VBOX_E_OBJECT_NOT_FOUND">
8392	Given @c id does not correspond to any USB device.
8393	</result>
8394
8395	<see><link to="IUSBDevice::id"/></see>
8396	</desc>
8397	<param name="id" type="uuid" mod="string" dir="in">
8398	<desc>UUID of the USB device to search for.</desc>
8399	</param>
8400	<param name="device" type="IHostUSBDevice" dir="return">
8401	<desc>Found USB device object.</desc>
8402	</param>
8403	</method>
8404
8405	<method name="findUSBDeviceByAddress">
8406	<desc>
8407	Searches for a USB device with the given host address.
8408
8409	<result name="VBOX_E_OBJECT_NOT_FOUND">
8410	Given @c name does not correspond to any USB device.
8411	</result>
8412
8413	<see><link to="IUSBDevice::address"/></see>
8414	</desc>
8415	<param name="name" type="wstring" dir="in">
8416	<desc>
8417	Address of the USB device (as assigned by the host) to
8418	search for.
8419	</desc>
8420	</param>
8421	<param name="device" type="IHostUSBDevice" dir="return">
8422	<desc>Found USB device object.</desc>
8423	</param>
8424	</method>
8425
8426	<method name="generateMACAddress">
8427	<desc>
8428	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
8429	</desc>
8430	<param name="address" type="wstring" dir="return">
8431	<desc>New Ethernet MAC address.</desc>
8432	</param>
8433	</method>
8434
8435	</interface>
8436
8437	<!--
8438	// ISystemProperties
8439	/////////////////////////////////////////////////////////////////////////
8440	-->
8441
8442	<interface
8443	name="ISystemProperties"
8444	extends="$unknown"
8445	uuid="413ea94c-efd9-491e-81fc-5df0c4d864bb"
8446	wsmap="managed"
8447	>
8448	<desc>
8449	The ISystemProperties interface represents global properties of the given
8450	VirtualBox installation.
8451
8452	These properties define limits and default values for various attributes
8453	and parameters. Most of the properties are read-only, but some can be
8454	changed by a user.
8455	</desc>
8456
8457	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
8458	<desc>Minimum guest system memory in Megabytes.</desc>
8459	</attribute>
8460
8461	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
8462	<desc>Maximum guest system memory in Megabytes.</desc>
8463	</attribute>
8464
8465	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
8466	<desc>Minimum guest video memory in Megabytes.</desc>
8467	</attribute>
8468
8469	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
8470	<desc>Maximum guest video memory in Megabytes.</desc>
8471	</attribute>
8472
8473	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
8474	<desc>Minimum CPU count.</desc>
8475	</attribute>
8476
8477	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
8478	<desc>Maximum CPU count.</desc>
8479	</attribute>
8480
8481	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
8482	<desc>Maximum of monitors which could be connected.</desc>
8483	</attribute>
8484
8485	<attribute name="infoVDSize" type="long long" readonly="yes">
8486	<desc>Maximum size of a virtual disk image in bytes. Informational value,
8487	does not reflect the limits of any virtual disk image format.</desc>
8488	</attribute>
8489
8490	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
8491	<desc>
8492	Maximum number of serial ports associated with every
8493	<link to="IMachine"/> instance.
8494	</desc>
8495	</attribute>
8496
8497	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
8498	<desc>
8499	Maximum number of parallel ports associated with every
8500	<link to="IMachine"/> instance.
8501	</desc>
8502	</attribute>
8503
8504	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
8505	<desc>
8506	Maximum device position in the boot order. This value corresponds
8507	to the total number of devices a machine can boot from, to make it
8508	possible to include all possible devices to the boot list.
8509	<see><link to="IMachine::setBootOrder"/></see>
8510	</desc>
8511	</attribute>
8512
8513	<attribute name="defaultMachineFolder" type="wstring">
8514	<desc>
8515	Full path to the default directory used to create new or open
8516	existing machines when a machine settings file name contains no
8517	path.
8518
8519	Starting with VirtualBox 4.0, by default, this attribute contains
8520	the full path of folder named "VirtualBox VMs" in the user's
8521	home directory, which depends on the host platform.
8522
8523	When setting this attribute, a full path must be specified.
8524	Setting this property to @c null or an empty string or the
8525	special value "Machines" (for compatibility reasons) will restore
8526	that default value.
8527
8528	If the folder specified herein does not exist, it will be created
8529	automatically as needed.
8530
8531	<see>
8532	<link to="IVirtualBox::createMachine"/>,
8533	<link to="IVirtualBox::openMachine"/>
8534	</see>
8535	</desc>
8536	</attribute>
8537
8538	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8539	<desc>
8540	List of all medium storage formats supported by this VirtualBox
8541	installation.
8542
8543	Keep in mind that the medium format identifier
8544	(<link to="IMediumFormat::id"/>) used in other API calls like
8545	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8546	medium format is a case-insensitive string. This means that, for
8547	example, all of the following strings:
8548	<pre>
8549	"VDI"
8550	"vdi"
8551	"VdI"</pre>
8552	refer to the same medium format.
8553
8554	Note that the virtual medium framework is backend-based, therefore
8555	the list of supported formats depends on what backends are currently
8556	installed.
8557
8558	<see><link to="IMediumFormat"/></see>
8559	</desc>
8560	</attribute>
8561
8562	<attribute name="defaultHardDiskFormat" type="wstring">
8563	<desc>
8564	Identifier of the default medium format used by VirtualBox.
8565
8566	The medium format set by this attribute is used by VirtualBox
8567	when the medium format was not specified explicitly. One example is
8568	<link to="IVirtualBox::createHardDisk"/> with the empty
8569	format argument. A more complex example is implicit creation of
8570	differencing media when taking a snapshot of a virtual machine:
8571	this operation will try to use a format of the parent medium first
8572	and if this format does not support differencing media the default
8573	format specified by this argument will be used.
8574
8575	The list of supported medium formats may be obtained by the
8576	<link to="#mediumFormats"/> call. Note that the default medium
8577	format must have a capability to create differencing media;
8578	otherwise operations that create media implicitly may fail
8579	unexpectedly.
8580
8581	The initial value of this property is <tt>"VDI"</tt> in the current
8582	version of the VirtualBox product, but may change in the future.
8583
8584	<note>
8585	Setting this property to @c null or empty string will restore the
8586	initial value.
8587	</note>
8588
8589	<see>
8590	<link to="#mediumFormats"/>,
8591	<link to="IMediumFormat::id"/>,
8592	<link to="IVirtualBox::createHardDisk"/>
8593	</see>
8594	</desc>
8595	</attribute>
8596
8597	<attribute name="freeDiskSpaceWarning" type="long long">
8598	<desc>Issue a warning if the free disk space is below (or in some disk
8599	intensive operation is expected to go below) the given size in
8600	bytes.</desc>
8601	</attribute>
8602
8603	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8604	<desc>Issue a warning if the free disk space is below (or in some disk
8605	intensive operation is expected to go below) the given percentage.</desc>
8606	</attribute>
8607
8608	<attribute name="freeDiskSpaceError" type="long long">
8609	<desc>Issue an error if the free disk space is below (or in some disk
8610	intensive operation is expected to go below) the given size in
8611	bytes.</desc>
8612	</attribute>
8613
8614	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8615	<desc>Issue an error if the free disk space is below (or in some disk
8616	intensive operation is expected to go below) the given percentage.</desc>
8617	</attribute>
8618
8619	<attribute name="VRDEAuthLibrary" type="wstring">
8620	<desc>
8621	Library that provides authentication for Remote Desktop clients. The library
8622	is used if a virtual machine's authentication type is set to "external"
8623	in the VM RemoteDisplay configuration.
8624
8625	The system library extension (".DLL" or ".so") must be omitted.
8626	A full path can be specified; if not, then the library must reside on the
8627	system's default library path.
8628
8629	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8630	of that name in one of the default VirtualBox library directories.
8631
8632	For details about VirtualBox authentication libraries and how to implement
8633	them, please refer to the VirtualBox manual.
8634
8635	<note>
8636	Setting this property to @c null or empty string will restore the
8637	initial value.
8638	</note>
8639	</desc>
8640	</attribute>
8641
8642	<attribute name="webServiceAuthLibrary" type="wstring">
8643	<desc>
8644	Library that provides authentication for webservice clients. The library
8645	is used if a virtual machine's authentication type is set to "external"
8646	in the VM RemoteDisplay configuration and will be called from
8647	within the <link to="IWebsessionManager::logon" /> implementation.
8648
8649	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8650	there is no per-VM setting for this, as the webservice is a global
8651	resource (if it is running). Only for this setting (for the webservice),
8652	setting this value to a literal <tt>"null"</tt> string disables authentication,
8653	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8654	no matter what user name and password are supplied.
8655
8656	The initial value of this property is <tt>"VBoxAuth"</tt>,
8657	meaning that the webservice will use the same authentication
8658	library that is used by default for VRDE (again, see
8659	<link to="ISystemProperties::VRDEAuthLibrary" />).
8660	The format and calling convention of authentication libraries
8661	is the same for the webservice as it is for VRDE.
8662
8663	<note>
8664	Setting this property to @c null or empty string will restore the
8665	initial value.
8666	</note>
8667	</desc>
8668	</attribute>
8669
8670	<attribute name="defaultVRDEExtPack" type="wstring">
8671	<desc>
8672	The name of the extension pack providing the default VRDE.
8673
8674	This attribute is for choosing between multiple extension packs
8675	providing VRDE. If only one is installed, it will automatically be the
8676	default one. The attribute value can be empty if no VRDE extension
8677	pack is installed.
8678
8679	For details about VirtualBox Remote Desktop Extension and how to
8680	implement one, please refer to the VirtualBox SDK.
8681	</desc>
8682	</attribute>
8683
8684	<attribute name="logHistoryCount" type="unsigned long">
8685	<desc>
8686	This value specifies how many old release log files are kept.
8687	</desc>
8688	</attribute>
8689
8690	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8691	<desc>This value hold the default audio driver for the current
8692	system.</desc>
8693	</attribute>
8694
8695	<attribute name="autostartDatabasePath" type="wstring">
8696	<desc>
8697	The path to the autostart database. Depending on the host this might
8698	be a filesystem path or something else.
8699	</desc>
8700	</attribute>
8701
8702	<attribute name="defaultAdditionsISO" type="wstring">
8703	<desc>
8704	The path to the default Guest Additions ISO image. Can be empty if
8705	the location is not known in this installation.
8706	</desc>
8707	</attribute>
8708
8709	<attribute name="defaultFrontend" type="wstring">
8710	<desc>
8711	Selects which VM frontend should be used by default when launching
8712	a VM through the <link to="IMachine::launchVMProcess" /> method.
8713	Empty or @c null strings do not define a particular default, it is up
8714	to <link to="IMachine::launchVMProcess" /> to select one. See the
8715	description of <link to="IMachine::launchVMProcess" /> for the valid
8716	frontend types.
8717
8718	This global setting is overridden by the per-VM attribute
8719	<link to="IMachine::defaultFrontend" /> or a frontend type
8720	passed to <link to="IMachine::launchVMProcess" />.
8721	</desc>
8722	</attribute>
8723
8724	<method name="getMaxNetworkAdapters">
8725	<desc>
8726	Maximum total number of network adapters associated with every
8727	<link to="IMachine"/> instance.
8728	</desc>
8729
8730	<param name="chipset" type="ChipsetType" dir="in">
8731	<desc>The chipset type to get the value for.</desc>
8732	</param>
8733
8734
8735	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8736	<desc>The maximum total number of network adapters allowed.</desc>
8737	</param>
8738
8739	</method>
8740
8741	<method name="getMaxNetworkAdaptersOfType">
8742	<desc>
8743	Maximum number of network adapters of a given attachment type,
8744	associated with every <link to="IMachine"/> instance.
8745	</desc>
8746
8747	<param name="chipset" type="ChipsetType" dir="in">
8748	<desc>The chipset type to get the value for.</desc>
8749	</param>
8750
8751	<param name="type" type="NetworkAttachmentType" dir="in">
8752	<desc>Type of attachment.</desc>
8753	</param>
8754
8755	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8756	<desc>The maximum number of network adapters allowed for
8757	particular chipset and attachment type.</desc>
8758	</param>
8759
8760	</method>
8761
8762
8763	<method name="getMaxDevicesPerPortForStorageBus">
8764	<desc>Returns the maximum number of devices which can be attached to a port
8765	for the given storage bus.</desc>
8766
8767	<param name="bus" type="StorageBus" dir="in">
8768	<desc>The storage bus type to get the value for.</desc>
8769	</param>
8770
8771	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8772	<desc>The maximum number of devices which can be attached to the port for the given
8773	storage bus.</desc>
8774	</param>
8775	</method>
8776
8777	<method name="getMinPortCountForStorageBus">
8778	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8779
8780	<param name="bus" type="StorageBus" dir="in">
8781	<desc>The storage bus type to get the value for.</desc>
8782	</param>
8783
8784	<param name="minPortCount" type="unsigned long" dir="return">
8785	<desc>The minimum number of ports for the given storage bus.</desc>
8786	</param>
8787	</method>
8788
8789	<method name="getMaxPortCountForStorageBus">
8790	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8791
8792	<param name="bus" type="StorageBus" dir="in">
8793	<desc>The storage bus type to get the value for.</desc>
8794	</param>
8795
8796	<param name="maxPortCount" type="unsigned long" dir="return">
8797	<desc>The maximum number of ports for the given storage bus.</desc>
8798	</param>
8799	</method>
8800
8801	<method name="getMaxInstancesOfStorageBus">
8802	<desc>Returns the maximum number of storage bus instances which
8803	can be configured for each VM. This corresponds to the number of
8804	storage controllers one can have. Value may depend on chipset type
8805	used.</desc>
8806
8807	<param name="chipset" type="ChipsetType" dir="in">
8808	<desc>The chipset type to get the value for.</desc>
8809	</param>
8810
8811	<param name="bus" type="StorageBus" dir="in">
8812	<desc>The storage bus type to get the value for.</desc>
8813	</param>
8814
8815	<param name="maxInstances" type="unsigned long" dir="return">
8816	<desc>The maximum number of instances for the given storage bus.</desc>
8817	</param>
8818	</method>
8819
8820	<method name="getDeviceTypesForStorageBus">
8821	<desc>Returns list of all the supported device types
8822	(<link to="DeviceType"/>) for the given type of storage
8823	bus.</desc>
8824
8825	<param name="bus" type="StorageBus" dir="in">
8826	<desc>The storage bus type to get the value for.</desc>
8827	</param>
8828
8829	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8830	<desc>The list of all supported device types for the given storage bus.</desc>
8831	</param>
8832	</method>
8833
8834	<method name="getDefaultIoCacheSettingForStorageController">
8835	<desc>Returns the default I/O cache setting for the
8836	given storage controller</desc>
8837
8838	<param name="controllerType" type="StorageControllerType" dir="in">
8839	<desc>The storage controller to the setting for.</desc>
8840	</param>
8841
8842	<param name="enabled" type="boolean" dir="return">
8843	<desc>Returned flag indicating the default value</desc>
8844	</param>
8845	</method>
8846	</interface>
8847
8848	<!--
8849	// IGuest
8850	/////////////////////////////////////////////////////////////////////////
8851	-->
8852
8853	<interface
8854	name="IGuestOSType" extends="$unknown"
8855	uuid="6d968f9a-858b-4c50-bf17-241f069e94c2"
8856	wsmap="struct"
8857	>
8858	<desc>
8859	</desc>
8860
8861	<attribute name="familyId" type="wstring" readonly="yes">
8862	<desc>Guest OS family identifier string.</desc>
8863	</attribute>
8864
8865	<attribute name="familyDescription" type="wstring" readonly="yes">
8866	<desc>Human readable description of the guest OS family.</desc>
8867	</attribute>
8868
8869	<attribute name="id" type="wstring" readonly="yes">
8870	<desc>Guest OS identifier string.</desc>
8871	</attribute>
8872
8873	<attribute name="description" type="wstring" readonly="yes">
8874	<desc>Human readable description of the guest OS.</desc>
8875	</attribute>
8876
8877	<attribute name="is64Bit" type="boolean" readonly="yes">
8878	<desc>Returns @c true if the given OS is 64-bit</desc>
8879	</attribute>
8880
8881	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8882	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8883	</attribute>
8884
8885	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8886	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8887	</attribute>
8888
8889	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8890	<desc>Recommended RAM size in Megabytes.</desc>
8891	</attribute>
8892
8893	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8894	<desc>Recommended video RAM size in Megabytes.</desc>
8895	</attribute>
8896
8897	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8898	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8899	</attribute>
8900
8901	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8902	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8903	</attribute>
8904
8905	<attribute name="recommendedHDD" type="long long" readonly="yes">
8906	<desc>Recommended hard disk size in bytes.</desc>
8907	</attribute>
8908
8909	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8910	<desc>Returns recommended network adapter for this OS type.</desc>
8911	</attribute>
8912
8913	<attribute name="recommendedPAE" type="boolean" readonly="yes">
8914	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8915	</attribute>
8916
8917	<attribute name="recommendedDVDStorageController" type="StorageControllerType" readonly="yes">
8918	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8919	</attribute>
8920
8921	<attribute name="recommendedDVDStorageBus" type="StorageBus" readonly="yes">
8922	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8923	</attribute>
8924
8925	<attribute name="recommendedHDStorageController" type="StorageControllerType" readonly="yes">
8926	<desc>Recommended storage controller type for HD drives.</desc>
8927	</attribute>
8928
8929	<attribute name="recommendedHDStorageBus" type="StorageBus" readonly="yes">
8930	<desc>Recommended storage bus type for HD drives.</desc>
8931	</attribute>
8932
8933	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8934	<desc>Recommended firmware type.</desc>
8935	</attribute>
8936
8937	<attribute name="recommendedUSBHID" type="boolean" readonly="yes">
8938	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8939	</attribute>
8940
8941	<attribute name="recommendedHPET" type="boolean" readonly="yes">
8942	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8943	</attribute>
8944
8945	<attribute name="recommendedUSBTablet" type="boolean" readonly="yes">
8946	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8947	</attribute>
8948
8949	<attribute name="recommendedRTCUseUTC" type="boolean" readonly="yes">
8950	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8951	</attribute>
8952
8953	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8954	<desc>Recommended chipset type.</desc>
8955	</attribute>
8956
8957	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8958	<desc>Recommended audio type.</desc>
8959	</attribute>
8960
8961	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8962	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8963	</attribute>
8964
8965	<attribute name="recommendedUSB" type="boolean" readonly="yes">
8966	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8967	</attribute>
8968
8969	</interface>
8970
8971	<enum
8972	name="AdditionsFacilityType"
8973	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8974	>
8975	<desc>
8976	Guest Additions facility IDs.
8977	</desc>
8978
8979	<const name="None" value="0">
8980	<desc>No/invalid facility.</desc>
8981	</const>
8982	<const name="VBoxGuestDriver" value="20">
8983	<desc>VirtualBox base driver (VBoxGuest).</desc>
8984	</const>
8985	<const name="AutoLogon" value="90">
8986	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8987	</const>
8988	<const name="VBoxService" value="100">
8989	<desc>VirtualBox system service (VBoxService).</desc>
8990	</const>
8991	<const name="VBoxTrayClient" value="101">
8992	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8993	</const>
8994	<const name="Seamless" value="1000">
8995	<desc>Seamless guest desktop integration.</desc>
8996	</const>
8997	<const name="Graphics" value="1100">
8998	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8999	are not immediately acted on and guest display resizes are probably not initiated by
9000	the guest additions.
9001	</desc>
9002	</const>
9003	<const name="All" value="2147483646">
9004	<desc>All facilities selected.</desc>
9005	</const>
9006	</enum>
9007
9008	<enum
9009	name="AdditionsFacilityClass"
9010	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
9011	>
9012	<desc>
9013	Guest Additions facility classes.
9014	</desc>
9015
9016	<const name="None" value="0">
9017	<desc>No/invalid class.</desc>
9018	</const>
9019	<const name="Driver" value="10">
9020	<desc>Driver.</desc>
9021	</const>
9022	<const name="Service" value="30">
9023	<desc>System service.</desc>
9024	</const>
9025	<const name="Program" value="50">
9026	<desc>Program.</desc>
9027	</const>
9028	<const name="Feature" value="100">
9029	<desc>Feature.</desc>
9030	</const>
9031	<const name="ThirdParty" value="999">
9032	<desc>Third party.</desc>
9033	</const>
9034	<const name="All" value="2147483646">
9035	<desc>All facility classes selected.</desc>
9036	</const>
9037	</enum>
9038
9039	<enum
9040	name="AdditionsFacilityStatus"
9041	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
9042	>
9043	<desc>
9044	Guest Additions facility states.
9045	</desc>
9046
9047	<const name="Inactive" value="0">
9048	<desc>Facility is not active.</desc>
9049	</const>
9050	<const name="Paused" value="1">
9051	<desc>Facility has been paused.</desc>
9052	</const>
9053	<const name="PreInit" value="20">
9054	<desc>Facility is preparing to initialize.</desc>
9055	</const>
9056	<const name="Init" value="30">
9057	<desc>Facility is initializing.</desc>
9058	</const>
9059	<const name="Active" value="50">
9060	<desc>Facility is up and running.</desc>
9061	</const>
9062	<const name="Terminating" value="100">
9063	<desc>Facility is shutting down.</desc>
9064	</const>
9065	<const name="Terminated" value="101">
9066	<desc>Facility successfully shut down.</desc>
9067	</const>
9068	<const name="Failed" value="800">
9069	<desc>Facility failed to start.</desc>
9070	</const>
9071	<const name="Unknown" value="999">
9072	<desc>Facility status is unknown.</desc>
9073	</const>
9074	</enum>
9075
9076	<interface
9077	name="IAdditionsFacility" extends="$unknown"
9078	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
9079	wsmap="struct"
9080	>
9081	<desc>
9082	Structure representing a Guest Additions facility.
9083	</desc>
9084
9085	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
9086	<desc>The class this facility is part of.</desc>
9087	</attribute>
9088
9089	<attribute name="lastUpdated" type="long long" readonly="yes">
9090	<desc>
9091	Time stamp of the last status update,
9092	in milliseconds since 1970-01-01 UTC.
9093	</desc>
9094	</attribute>
9095
9096	<attribute name="name" type="wstring" readonly="yes">
9097	<desc>The facility's friendly name.</desc>
9098	</attribute>
9099
9100	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
9101	<desc>The current status.</desc>
9102	</attribute>
9103
9104	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
9105	<desc>The facility's type ID.</desc>
9106	</attribute>
9107	</interface>
9108
9109	<enum
9110	name="AdditionsRunLevelType"
9111	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
9112	>
9113	<desc>
9114	Guest Additions run level type.
9115	</desc>
9116
9117	<const name="None" value="0">
9118	<desc>Guest Additions are not loaded.</desc>
9119	</const>
9120	<const name="System" value="1">
9121	<desc>Guest drivers are loaded.</desc>
9122	</const>
9123	<const name="Userland" value="2">
9124	<desc>Common components (such as application services) are loaded.</desc>
9125	</const>
9126	<const name="Desktop" value="3">
9127	<desc>Per-user desktop components are loaded.</desc>
9128	</const>
9129	</enum>
9130
9131	<enum
9132	name="AdditionsUpdateFlag"
9133	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
9134	>
9135	<desc>
9136	Guest Additions update flags.
9137	</desc>
9138
9139	<const name="None" value="0">
9140	<desc>No flag set.</desc>
9141	</const>
9142	<const name="WaitForUpdateStartOnly" value="1">
9143	<desc>Starts the regular updating process and waits until the
9144	actual Guest Additions update inside the guest was started.
9145	This can be necessary due to needed interaction with the guest
9146	OS during the installation phase.</desc>
9147	</const>
9148	</enum>
9149
9150	<enum
9151	name="GuestSessionStatus"
9152	uuid="ac2669da-4624-44f2-85b5-0b0bfb8d8673"
9153	>
9154	<desc>
9155	Guest session status. This enumeration represents possible values of
9156	the <link to="IGuestSession::status"/> attribute.
9157	</desc>
9158	<const name="Undefined" value="0">
9159	<desc>Guest session is in an undefined state.</desc>
9160	</const>
9161	<const name="Starting" value="10">
9162	<desc>Guest session is being started.</desc>
9163	</const>
9164	<const name="Started" value="100">
9165	<desc>Guest session has been started.</desc>
9166	</const>
9167	<const name="Terminating" value="480">
9168	<desc>Guest session is being terminated.</desc>
9169	</const>
9170	<const name="Terminated" value="500">
9171	<desc>Guest session terminated normally.</desc>
9172	</const>
9173	<const name="TimedOutKilled" value="512">
9174	<desc>Guest session timed out and was killed.</desc>
9175	</const>
9176	<const name="TimedOutAbnormally" value="513">
9177	<desc>Guest session timed out and was not killed successfully.</desc>
9178	</const>
9179	<const name="Down" value="600">
9180	<desc>Service/OS is stopping, guest session was killed.</desc>
9181	</const>
9182	<const name="Error" value="800">
9183	<desc>Something went wrong.</desc>
9184	</const>
9185	</enum>
9186
9187	<enum
9188	name="GuestSessionWaitForFlag"
9189	uuid="bb7a372a-f635-4e11-a81a-e707f3a52ef5"
9190	>
9191	<desc>
9192	Guest session waiting flags. Multiple flags can be combined.
9193	</desc>
9194
9195	<const name="None" value="0">
9196	<desc>No waiting flags specified. Do not use this.</desc>
9197	</const>
9198	<const name="Start" value="1">
9199	<desc>Wait for the guest session being started.</desc>
9200	</const>
9201	<const name="Terminate" value="2">
9202	<desc>Wait for the guest session being terminated.</desc>
9203	</const>
9204	<const name="Status" value="4">
9205	<desc>Wait for the next guest session status change.</desc>
9206	</const>
9207	</enum>
9208
9209	<enum
9210	name="GuestSessionWaitResult"
9211	uuid="c0f6a8a5-fdb6-42bf-a582-56c6f82bcd2d"
9212	>
9213	<desc>
9214	Guest session waiting results. Depending on the session waiting flags (for
9215	more information see <link to="GuestSessionWaitForFlag"/>) the waiting result
9216	can vary based on the session's current status.
9217
9218	To wait for a guest session to terminate after it has been
9219	created by <link to="IGuest::createSession"/> one would specify
9220	GuestSessionWaitResult_Terminate.
9221	</desc>
9222
9223	<const name="None" value="0">
9224	<desc>No result was returned. Not being used.</desc>
9225	</const>
9226	<const name="Start" value="1">
9227	<desc>The guest session has been started.</desc>
9228	</const>
9229	<const name="Terminate" value="2">
9230	<desc>The guest session has been terminated.</desc>
9231	</const>
9232	<const name="Status" value="3">
9233	<desc>
9234	The guest session has changed its status. The status then can
9235	be retrieved via <link to="IGuestSession::status"/>.
9236	</desc>
9237	</const>
9238	<const name="Error" value="4">
9239	<desc>Error while executing the process.</desc>
9240	</const>
9241	<const name="Timeout" value="5">
9242	<desc>
9243	The waiting operation timed out. This also will happen
9244	when no event has been occured matching the
9245	current waiting flags in a <link to="IGuestSession::waitFor"/> call.
9246	</desc>
9247	</const>
9248	<const name="WaitFlagNotSupported" value="6">
9249	<desc>
9250	A waiting flag specified in the <link to="IGuestSession::waitFor"/> call
9251	is not supported by the guest.
9252	</desc>
9253	</const>
9254	</enum>
9255
9256	<enum
9257	name="FileSeekType"
9258	uuid="1b73f4f3-3515-4073-a506-76878d9e2541"
9259	>
9260	<desc>
9261	File seeking types.
9262	</desc>
9263
9264	<const name="Set" value="0">
9265	<desc>Seek from the start of the file.</desc>
9266	</const>
9267	<const name="Current" value="1">
9268	<desc>Seek from the current file position.</desc>
9269	</const>
9270	</enum>
9271
9272	<enum
9273	name="ProcessInputFlag"
9274	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
9275	>
9276	<desc>
9277	Guest process input flags.
9278	</desc>
9279	<const name="None" value="0">
9280	<desc>No flag set.</desc>
9281	</const>
9282	<const name="EndOfFile" value="1">
9283	<desc>End of file (input) reached.</desc>
9284	</const>
9285	</enum>
9286
9287	<enum
9288	name="ProcessOutputFlag"
9289	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
9290	>
9291	<desc>
9292	Guest process output flags for specifying which
9293	type of output to retrieve.
9294	</desc>
9295	<const name="None" value="0">
9296	<desc>No flags set. Get output from stdout.</desc>
9297	</const>
9298	<const name="StdErr" value="1">
9299	<desc>Get output from stderr.</desc>
9300	</const>
9301	</enum>
9302
9303	<enum
9304	name="ProcessWaitForFlag"
9305	uuid="23b550c7-78e1-437e-98f0-65fd9757bcd2"
9306	>
9307	<desc>
9308	Process waiting flags. Multiple flags can be combined.
9309	</desc>
9310
9311	<const name="None" value="0">
9312	<desc>No waiting flags specified. Do not use this.</desc>
9313	</const>
9314	<const name="Start" value="1">
9315	<desc>Wait for the process being started.</desc>
9316	</const>
9317	<const name="Terminate" value="2">
9318	<desc>Wait for the process being terminated.</desc>
9319	</const>
9320	<const name="StdIn" value="4">
9321	<desc>Wait for stdin becoming available.</desc>
9322	</const>
9323	<const name="StdOut" value="8">
9324	<desc>Wait for data becoming available on stdout.</desc>
9325	</const>
9326	<const name="StdErr" value="16">
9327	<desc>Wait for data becoming available on stderr.</desc>
9328	</const>
9329	</enum>
9330
9331	<enum
9332	name="ProcessWaitResult"
9333	uuid="40719cbe-f192-4fe9-a231-6697b3c8e2b4"
9334	>
9335	<desc>
9336	Process waiting results. Depending on the process waiting flags (for
9337	more information see <link to="ProcessWaitForFlag"/>) the waiting result
9338	can vary based on the processes' current status.
9339
9340	To wait for a guest process to terminate after it has been
9341	created by <link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>
9342	one would specify ProcessWaitResult_Terminate.
9343
9344	If a guest process has been started with ProcessCreateFlag_WaitForStdOut
9345	a client can wait with ProcessWaitResult_StdOut for new data to arrive on
9346	stdout; same applies for ProcessCreateFlag_WaitForStdErr and
9347	ProcessWaitResult_StdErr.
9348	</desc>
9349
9350	<const name="None" value="0">
9351	<desc>No result was returned. Not being used.</desc>
9352	</const>
9353	<const name="Start" value="1">
9354	<desc>The process has been started.</desc>
9355	</const>
9356	<const name="Terminate" value="2">
9357	<desc>The process has been terminated.</desc>
9358	</const>
9359	<const name="Status" value="3">
9360	<desc>
9361	The process has changed its status. The status then can
9362	be retrieved via <link to="IProcess::status"/>.
9363	</desc>
9364	</const>
9365	<const name="Error" value="4">
9366	<desc>Error while executing the process.</desc>
9367	</const>
9368	<const name="Timeout" value="5">
9369	<desc>
9370	The waiting operation timed out. This also will happen
9371	when no event has been occured matching the
9372	current waiting flags in a <link to="IProcess::waitFor"/> call.
9373	</desc>
9374	</const>
9375	<const name="StdIn" value="6">
9376	<desc>
9377	The process signalled that stdin became available for writing
9378	and that the process awaits input now.</desc>
9379	</const>
9380	<const name="StdOut" value="7">
9381	<desc>Data on stdout became available for reading.</desc>
9382	</const>
9383	<const name="StdErr" value="8">
9384	<desc>Data on stderr became available for reading.</desc>
9385	</const>
9386	<const name="WaitFlagNotSupported" value="9">
9387	<desc>
9388	A waiting flag specified in the <link to="IProcess::waitFor"/> call
9389	is not supported by the guest.
9390	</desc>
9391	</const>
9392	</enum>
9393
9394	<enum
9395	name="CopyFileFlag"
9396	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
9397	>
9398	<desc>
9399	File copying flags.
9400	</desc>
9401	<const name="None" value="0">
9402	<desc>No flag set.</desc>
9403	</const>
9404	<const name="Recursive" value="1">
9405	<desc>Copy directories recursively.</desc>
9406	</const>
9407	<const name="Update" value="2">
9408	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
9409	</const>
9410	<const name="FollowLinks" value="4">
9411	<desc>Follow symbolic links.</desc>
9412	</const>
9413	</enum>
9414
9415	<enum
9416	name="DirectoryCreateFlag"
9417	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
9418	>
9419	<desc>
9420	Directory creation flags.
9421	</desc>
9422	<const name="None" value="0">
9423	<desc>No flag set.</desc>
9424	</const>
9425	<const name="Parents" value="1">
9426	<desc>No error if existing, make parent directories as needed.</desc>
9427	</const>
9428	</enum>
9429
9430	<enum
9431	name="DirectoryRemoveRecFlag"
9432	uuid="455aabf0-7692-48f6-9061-f21579b65769"
9433	>
9434	<desc>
9435	Directory recursive removement flags.
9436	</desc>
9437
9438	<const name="None" value="0">
9439	<desc>No flag set.</desc>
9440	</const>
9441	<const name="ContentAndDir" value="1">
9442	<desc>Delete the content of the directory and the directory itself.</desc>
9443	</const>
9444	<const name="ContentOnly" value="2">
9445	<desc>Only delete the content of the directory, omit the directory it self.</desc>
9446	</const>
9447	</enum>
9448
9449	<enum
9450	name="PathRenameFlag"
9451	uuid="f3baa09f-c758-453d-b91c-c7787d76351d"
9452	>
9453	<desc>
9454	Path renaming flags.
9455	</desc>
9456
9457	<const name="None" value="0">
9458	<desc>No flag set.</desc>
9459	</const>
9460	<const name="NoReplace" value="1">
9461	<desc>Do not replace anything.</desc>
9462	</const>
9463	<const name="Replace" value="2">
9464	<desc>This will replace attempt any target which isn't a directory.</desc>
9465	</const>
9466	<const name="NoSymlinks" value="4">
9467	<desc>Don't allow symbolic links as part of the path.</desc>
9468	</const>
9469	</enum>
9470
9471	<enum
9472	name="ProcessCreateFlag"
9473	uuid="35192799-bfde-405d-9bea-c735ab9998e4"
9474	>
9475	<desc>
9476	Guest process execution flags.
9477	</desc>
9478
9479	<const name="None" value="0">
9480	<desc>No flag set.</desc>
9481	</const>
9482	<const name="WaitForProcessStartOnly" value="1">
9483	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
9484	process itself then uses an infinite timeout.</desc>
9485	</const>
9486	<const name="IgnoreOrphanedProcesses" value="2">
9487	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
9488	</const>
9489	<const name="Hidden" value="4">
9490	<desc>Do not show the started process according to the guest OS guidelines.</desc>
9491	</const>
9492	<const name="NoProfile" value="8">
9493	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
9494	</const>
9495	<const name="WaitForStdOut" value="16">
9496	<desc>The guest process waits until all data from stdout is read out.</desc>
9497	</const>
9498	<const name="WaitForStdErr" value="32">
9499	<desc>The guest process waits until all data from stderr is read out.</desc>
9500	</const>
9501	<const name="ExpandArguments" value="64">
9502	<desc>Expands environment variables in process arguments.</desc>
9503	</const>
9504	</enum>
9505
9506	<enum
9507	name="ProcessPriority"
9508	uuid="ee8cac50-e232-49fe-806b-d1214d9c2e49"
9509	>
9510	<desc>
9511	Process priorities.
9512	</desc>
9513
9514	<const name="Invalid" value="0">
9515	<desc>Invalid priority, do not use.</desc>
9516	</const>
9517	<const name="Default" value="1">
9518	<desc>Default process priority determined by the OS.</desc>
9519	</const>
9520	</enum>
9521
9522	<enum
9523	name="SymlinkType"
9524	uuid="37794668-f8f1-4714-98a5-6f8fa2ed0118"
9525	>
9526	<desc>
9527	Symbolic link types.
9528	</desc>
9529
9530	<const name="Unknown" value="0">
9531	<desc>It is not known what is being targeted.</desc>
9532	</const>
9533	<const name="Directory" value="1">
9534	<desc>The link targets a directory.</desc>
9535	</const>
9536	<const name="File" value="2">
9537	<desc>The link targets a file (or whatever else).</desc>
9538	</const>
9539	</enum>
9540
9541	<enum
9542	name="SymlinkReadFlag"
9543	uuid="b7fe2b9d-790e-4b25-8adf-1ca33026931f"
9544	>
9545	<desc>
9546	Symbolic link reading flags.
9547	</desc>
9548
9549	<const name="None" value="0">
9550	<desc>No flags set.</desc>
9551	</const>
9552	<const name="NoSymlinks" value="1">
9553	<desc>Don't allow symbolic links as part of the path.</desc>
9554	</const>
9555	</enum>
9556
9557	<enum
9558	name="ProcessStatus"
9559	uuid="4d52368f-5b48-4bfe-b486-acf89139b52f"
9560	>
9561	<desc>
9562	Process execution statuses.
9563	</desc>
9564
9565	<const name="Undefined" value="0">
9566	<desc>Process is in an undefined state.</desc>
9567	</const>
9568	<const name="Starting" value="10">
9569	<desc>Process is being started.</desc>
9570	</const>
9571	<const name="Started" value="100">
9572	<desc>Process has been started.</desc>
9573	</const>
9574	<const name="Paused" value="110">
9575	<desc>Process has been paused.</desc>
9576	</const>
9577	<const name="Terminating" value="480">
9578	<desc>Process is being terminated.</desc>
9579	</const>
9580	<const name="TerminatedNormally" value="500">
9581	<desc>Process terminated normally.</desc>
9582	</const>
9583	<const name="TerminatedSignal" value="510">
9584	<desc>Process terminated via signal.</desc>
9585	</const>
9586	<const name="TerminatedAbnormally" value="511">
9587	<desc>Process terminated abnormally.</desc>
9588	</const>
9589	<const name="TimedOutKilled" value="512">
9590	<desc>Process timed out and was killed.</desc>
9591	</const>
9592	<const name="TimedOutAbnormally" value="513">
9593	<desc>Process timed out and was not killed successfully.</desc>
9594	</const>
9595	<const name="Down" value="600">
9596	<desc>Service/OS is stopping, process was killed.</desc>
9597	</const>
9598	<const name="Error" value="800">
9599	<desc>Something went wrong.</desc>
9600	</const>
9601	</enum>
9602
9603	<enum
9604	name="ProcessInputStatus"
9605	uuid="a4a0ef9c-29cc-4805-9803-c8215ae9da6c"
9606	>
9607	<desc>
9608	Process input statuses.
9609	</desc>
9610
9611	<const name="Undefined" value="0">
9612	<desc>Undefined state.</desc>
9613	</const>
9614	<const name="Broken" value="1">
9615	<desc>Input pipe is broken.</desc>
9616	</const>
9617	<const name="Available" value="10">
9618	<desc>Input pipe became available for writing.</desc>
9619	</const>
9620	<const name="Written" value="50">
9621	<desc>Data has been successfully written.</desc>
9622	</const>
9623	<const name="Overflow" value="100">
9624	<desc>Too much input data supplied, data overflow.</desc>
9625	</const>
9626	</enum>
9627
9628	<enum
9629	name="FileStatus"
9630	uuid="8c86468b-b97b-4080-8914-e29f5b0abd2c"
9631	>
9632	<desc>
9633	File statuses.
9634	</desc>
9635
9636	<const name="Undefined" value="0">
9637	<desc>File is in an undefined state.</desc>
9638	</const>
9639	<const name="Opening" value="10">
9640	<desc>Guest file is opening.</desc>
9641	</const>
9642	<const name="Open" value="100">
9643	<desc>Guest file has been successfully opened.</desc>
9644	</const>
9645	<const name="Closing" value="150">
9646	<desc>Guest file closing.</desc>
9647	</const>
9648	<const name="Closed" value="200">
9649	<desc>Guest file has been closed.</desc>
9650	</const>
9651	<const name="Down" value="600">
9652	<desc>Service/OS is stopping, guest file was closed.</desc>
9653	</const>
9654	<const name="Error" value="800">
9655	<desc>Something went wrong.</desc>
9656	</const>
9657	</enum>
9658
9659	<enum
9660	name="FsObjType"
9661	uuid="a1ed437c-b3c3-4ca2-b19c-4239d658d5e8"
9662	>
9663	<desc>
9664	File system object type.
9665	</desc>
9666
9667	<const name="Undefined" value="0">
9668	<desc>Type is undefined / unknown.</desc>
9669	</const>
9670	<const name="FIFO" value="1">
9671	<desc>Named pipe.</desc>
9672	</const>
9673	<const name="DevChar" value="10">
9674	<desc>Character device.</desc>
9675	</const>
9676	<const name="DevBlock" value="11">
9677	<desc>Block device.</desc>
9678	</const>
9679	<const name="Directory" value="50">
9680	<desc>Directory.</desc>
9681	</const>
9682	<const name="File" value="80">
9683	<desc>File.</desc>
9684	</const>
9685	<const name="Symlink" value="100">
9686	<desc>Symlink.</desc>
9687	</const>
9688	<const name="Socket" value="200">
9689	<desc>Socket.</desc>
9690	</const>
9691	<const name="Whiteout" value="400">
9692	<desc>Whiteout.</desc>
9693	</const>
9694	</enum>
9695
9696	<enum
9697	name="DragAndDropAction"
9698	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
9699	>
9700	<desc>
9701	Possible actions within an Drag and Drop operation.
9702	</desc>
9703
9704	<const name="Ignore" value="0">
9705	<desc>Do nothing.</desc>
9706	</const>
9707
9708	<const name="Copy" value="1">
9709	<desc>Copy the item to the target.</desc>
9710	</const>
9711
9712	<const name="Move" value="2">
9713	<desc>Move the item to the target.</desc>
9714	</const>
9715
9716	<const name="Link" value="3">
9717	<desc>Link the item from within the target.</desc>
9718	</const>
9719	</enum>
9720
9721	<enum
9722	name="DirectoryOpenFlag"
9723	uuid="5138837a-8fd2-4194-a1b0-08f7bc3949d0"
9724	>
9725	<desc>
9726	Directory open flags.
9727	</desc>
9728	<const name="None" value="0">
9729	<desc>No flag set.</desc>
9730	</const>
9731	<const name="NoSymlinks" value="1">
9732	<desc>Don't allow symbolic links as part of the path.</desc>
9733	</const>
9734	</enum>
9735
9736	<interface
9737	name="IGuestSession" extends="$unknown"
9738	uuid="c8e8607b-5e67-4073-8f14-146515d0c1ff"
9739	wsmap="managed"
9740	>
9741	<desc>
9742	A guest session represents one impersonated user account on the guest, so
9743	every operation will use the same credentials specified when creating
9744	the session object via <link to="IGuest::createSession"/>.
9745
9746	There can be a maximum of 32 sessions at once per VM. Each session keeps
9747	track of its started guest processes, opened guest files or guest directories.
9748	To work on guest files or directories a guest session offers methods to open
9749	or create such objects (see <link to="IGuestSession::fileOpen"/> or
9750	<link to="IGuestSession::directoryOpen"/> for example).
9751
9752	When done with either of these objects, including the guest session itself,
9753	use the appropriate close() method to let the object do its cleanup work.
9754
9755	Every guest session has its own environment variable block which gets
9756	automatically applied when starting a new guest process via
9757	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
9758	To override (or unset) certain environment variables already set by the
9759	guest session, one can specify a per-process environment block when using
9760	one of the both above mentioned process creation calls.
9761	</desc>
9762
9763	<attribute name="user" type="wstring" readonly="yes">
9764	<desc>Returns the user name used by this session to impersonate
9765	users on the guest.
9766	</desc>
9767	</attribute>
9768	<attribute name="domain" type="wstring" readonly="yes">
9769	<desc>Returns the domain name used by this session to impersonate
9770	users on the guest.
9771	</desc>
9772	</attribute>
9773	<attribute name="name" type="wstring" readonly="yes">
9774	<desc>Returns the session's friendly name.</desc>
9775	</attribute>
9776	<attribute name="id" type="unsigned long" readonly="yes">
9777	<desc>Returns the internal session ID.</desc>
9778	</attribute>
9779	<attribute name="timeout" type="unsigned long">
9780	<desc>
9781	Returns the session timeout (in ms).
9782	<result name="E_NOTIMPL">
9783	The method is not implemented yet.
9784	</result>
9785	</desc>
9786	</attribute>
9787	<attribute name="status" type="GuestSessionStatus" readonly="yes">
9788	<desc>Returns the current session status.</desc>
9789	</attribute>
9790	<attribute name="environment" type="wstring" safearray="yes">
9791	<desc>
9792	Returns the current session environment.
9793	</desc>
9794	</attribute>
9795	<attribute name="processes" type="IGuestProcess" readonly="yes" safearray="yes">
9796	<desc>
9797	Returns all current guest processes.
9798	</desc>
9799	</attribute>
9800	<attribute name="directories" type="IGuestDirectory" readonly="yes" safearray="yes">
9801	<desc>
9802	Returns all currently opened guest directories.
9803	</desc>
9804	</attribute>
9805	<attribute name="files" type="IGuestFile" readonly="yes" safearray="yes">
9806	<desc>
9807	Returns all currently opened guest files.
9808	</desc>
9809	</attribute>
9810	<attribute name="eventSource" type="IEventSource" readonly="yes">
9811	<desc>
9812	Event source for guest session events.
9813	</desc>
9814	</attribute>
9815
9816	<method name="close">
9817	<desc>
9818	Closes this session. All opened guest directories, files and
9819	processes which are not referenced by clients anymore will be
9820	uninitialized.
9821	</desc>
9822	</method>
9823
9824	<method name="copyFrom">
9825	<desc>
9826	Copies a file from guest to the host.
9827
9828	<result name="VBOX_E_IPRT_ERROR">
9829	Error starting the copy operation.
9830	</result>
9831	</desc>
9832	<param name="source" type="wstring" dir="in">
9833	<desc>Source file on the guest to copy to the host.</desc>
9834	</param>
9835	<param name="dest" type="wstring" dir="in">
9836	<desc>Destination file name on the host.</desc>
9837	</param>
9838	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9839	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9840	</param>
9841	<param name="progress" type="IProgress" dir="return">
9842	<desc>Progress object to track the operation completion.</desc>
9843	</param>
9844	</method>
9845
9846	<method name="copyTo">
9847	<desc>
9848	Copies a file from host to the guest.
9849
9850	<result name="VBOX_E_IPRT_ERROR">
9851	Error starting the copy operation.
9852	</result>
9853	</desc>
9854	<param name="source" type="wstring" dir="in">
9855	<desc>Source file on the host to copy to the guest.</desc>
9856	</param>
9857	<param name="dest" type="wstring" dir="in">
9858	<desc>Destination file name on the guest.</desc>
9859	</param>
9860	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9861	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9862	</param>
9863	<param name="progress" type="IProgress" dir="return">
9864	<desc>Progress object to track the operation completion.</desc>
9865	</param>
9866	</method>
9867
9868	<method name="directoryCreate">
9869	<desc>
9870	Create a directory on the guest.
9871
9872	<result name="VBOX_E_IPRT_ERROR">
9873	Error while creating the directory.
9874	</result>
9875	</desc>
9876	<param name="path" type="wstring" dir="in">
9877	<desc>Full path of directory to create.</desc>
9878	</param>
9879	<param name="mode" type="unsigned long" dir="in">
9880	<desc>File creation mode.</desc>
9881	</param>
9882	<param name="flags" type="DirectoryCreateFlag" dir="in" safearray="yes">
9883	<desc>Creation flags; see <link to="DirectoryCreateFlag"/> for more information.</desc>
9884	</param>
9885	</method>
9886
9887	<method name="directoryCreateTemp">
9888	<desc>
9889	Create a temporary directory on the guest.
9890
9891	<result name="VBOX_E_NOT_SUPPORTED">
9892	The operation is not possible as requested on this particular
9893	guest type.
9894	</result>
9895	<result name="E_INVALIDARG">
9896	Invalid argument. This includes an incorrectly formatted template,
9897	or a non-absolute path.
9898	</result>
9899	<result name="VBOX_E_IPRT_ERROR">
9900	The temporary directory could not be created. Possible reasons
9901	include a non-existing path or an insecure path when the secure
9902	option was requested.
9903	</result>
9904	</desc>
9905	<param name="templateName" type="wstring" dir="in">
9906	<desc>Template for the name of the directory to create. This must
9907	contain at least one 'X' character. The first group of consecutive
9908	'X' characters in the template will be replaced by a random
9909	alphanumeric string to produce a unique name.</desc>
9910	</param>
9911	<param name="mode" type="unsigned long" dir="in">
9912	<desc>The mode of the directory to create. Use 0700 unless there are
9913	reasons not to. This parameter is ignored if "secure" is specified.
9914	</desc>
9915	</param>
9916	<param name="path" type="wstring" dir="in">
9917	<desc>The absolute path to create the temporary directory in.</desc>
9918	</param>
9919	<param name="secure" type="boolean" dir="in">
9920	<desc>Whether to fail if the directory can not be securely created.
9921	Currently this means that another unprivileged user cannot
9922	manipulate the path specified or remove the temporary directory
9923	after it has been created. Also causes the mode specified to be
9924	ignored. May not be supported on all guest types.</desc>
9925	</param>
9926	<param name="directory" type="wstring" dir="return">
9927	<desc>On success this will contain the name of the directory created
9928	with full path.</desc>
9929	</param>
9930	</method>
9931
9932	<method name="directoryExists">
9933	<desc>
9934	Checks whether a directory exists on the guest or not.
9935
9936	<result name="VBOX_E_IPRT_ERROR">
9937	Error while checking existence of the directory specified.
9938	</result>
9939	</desc>
9940	<param name="path" type="wstring" dir="in">
9941	<desc>Directory to check existence for.</desc>
9942	</param>
9943	<param name="exists" type="boolean" dir="return">
9944	<desc>Returns @c true if the directory exists, @c false if not.</desc>
9945	</param>
9946	</method>
9947
9948	<method name="directoryOpen">
9949	<desc>
9950	Opens a directory and creates a <link to="IGuestDirectory"/> object that
9951	can be used for further operations.
9952
9953	<result name="VBOX_E_OBJECT_NOT_FOUND">
9954	Directory to open was not found.
9955	</result>
9956	<result name="VBOX_E_IPRT_ERROR">
9957	Error while opening the directory.
9958	</result>
9959	</desc>
9960	<param name="path" type="wstring" dir="in">
9961	<desc>Full path to file to open.</desc>
9962	</param>
9963	<param name="filter" type="wstring" dir="in">
9964	<desc>Open filter to apply. This can include wildcards like ? and *.</desc>
9965	</param>
9966	<param name="flags" type="DirectoryOpenFlag" dir="in" safearray="yes">
9967	<desc>Open flags; see <link to="DirectoryOpenFlag"/> for more information.</desc>
9968	</param>
9969	<param name="directory" type="IGuestDirectory" dir="return">
9970	<desc><link to="IGuestDirectory"/> object containing the opened directory.</desc>
9971	</param>
9972	</method>
9973
9974	<method name="directoryQueryInfo">
9975	<desc>
9976	Queries information of a directory on the guest.
9977
9978	<result name="VBOX_E_OBJECT_NOT_FOUND">
9979	Directory to query information for was not found.
9980	</result>
9981	<result name="VBOX_E_IPRT_ERROR">
9982	Error querying information.
9983	</result>
9984	</desc>
9985	<param name="path" type="wstring" dir="in">
9986	<desc>Directory to query information for.</desc>
9987	</param>
9988	<param name="info" type="IGuestFsObjInfo" dir="return">
9989	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
9990	</param>
9991	</method>
9992
9993	<method name="directoryRemove">
9994	<desc>
9995	Removes a guest directory if not empty.
9996
9997	<result name="E_NOTIMPL">
9998	The method is not implemented yet.
9999	</result>
10000	</desc>
10001	<param name="path" type="wstring" dir="in">
10002	<desc>Full path of directory to remove.</desc>
10003	</param>
10004	</method>
10005
10006	<method name="directoryRemoveRecursive">
10007	<desc>
10008	Removes a guest directory recursively.
10009
10010	<result name="E_NOTIMPL">
10011	The method is not implemented yet.
10012	</result>
10013	</desc>
10014	<param name="path" type="wstring" dir="in">
10015	<desc>Full path of directory to remove recursively.</desc>
10016	</param>
10017	<param name="flags" type="DirectoryRemoveRecFlag" dir="in" safearray="yes">
10018	<desc>Remove flags; see <link to="DirectoryRemoveRecFlag"/> for more information.</desc>
10019	</param>
10020	<param name="progress" type="IProgress" dir="return">
10021	<desc>Progress object to track the operation completion.</desc>
10022	</param>
10023	</method>
10024
10025	<method name="directoryRename">
10026	<desc>
10027	Renames a directory on the guest.
10028
10029	<result name="E_NOTIMPL">
10030	The method is not implemented yet.
10031	</result>
10032	</desc>
10033	<param name="source" type="wstring" dir="in">
10034	<desc>Source directory to rename.</desc>
10035	</param>
10036	<param name="dest" type="wstring" dir="in">
10037	<desc>Destination directory to rename the source to.</desc>
10038	</param>
10039	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
10040	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
10041	</param>
10042	</method>
10043
10044	<method name="directorySetACL">
10045	<desc>
10046	Sets the ACL (Access Control List) of a guest directory.
10047
10048	<result name="E_NOTIMPL">
10049	The method is not implemented yet.
10050	</result>
10051	</desc>
10052	<param name="path" type="wstring" dir="in">
10053	<desc>Full path of directory to set the ACL for.</desc>
10054	</param>
10055	<param name="acl" type="wstring" dir="in">
10056	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
10057	</param>
10058	</method>
10059
10060	<method name="environmentClear">
10061	<desc>
10062	Clears (deletes) all session environment variables.
10063
10064	<result name="VBOX_E_IPRT_ERROR">
10065	Error while clearing the session environment variables.
10066	</result>
10067	</desc>
10068	</method>
10069
10070	<method name="environmentGet">
10071	<desc>
10072	Gets the value of a session environment variable.
10073
10074	<result name="VBOX_E_IPRT_ERROR">
10075	Error while getting the value of the session environment variable.
10076	</result>
10077	</desc>
10078	<param name="name" type="wstring" dir="in">
10079	<desc>Name of session environment variable to get the value for.</desc>
10080	</param>
10081	<param name="value" type="wstring" dir="return">
10082	<desc>
10083	Value of the session environment variable specified. If this variable
10084	does not exist and empty value will be returned.
10085	</desc>
10086	</param>
10087	</method>
10088
10089	<method name="environmentSet">
10090	<desc>
10091	Sets a session environment variable.
10092
10093	<result name="VBOX_E_IPRT_ERROR">
10094	Error while setting the session environment variable.
10095	</result>
10096	</desc>
10097	<param name="name" type="wstring" dir="in">
10098	<desc>Name of session environment variable to set.</desc>
10099	</param>
10100	<param name="value" type="wstring" dir="in">
10101	<desc>Value to set the session environment variable to.</desc>
10102	</param>
10103	</method>
10104
10105	<method name="environmentUnset">
10106	<desc>
10107	Unsets session environment variable.
10108
10109	<result name="VBOX_E_IPRT_ERROR">
10110	Error while unsetting the session environment variable.
10111	</result>
10112	</desc>
10113	<param name="name" type="wstring" dir="in">
10114	<desc>Name of session environment variable to unset (clear).</desc>
10115	</param>
10116	</method>
10117
10118	<method name="fileCreateTemp">
10119	<desc>
10120	Creates a temporary file on the guest.
10121
10122	<result name="VBOX_E_NOT_SUPPORTED">
10123	The operation is not possible as requested on this particular
10124	guest type.
10125	</result>
10126	<result name="E_INVALIDARG">
10127	Invalid argument. This includes an incorrectly formatted template,
10128	or a non-absolute path.
10129	</result>
10130	<result name="VBOX_E_IPRT_ERROR">
10131	The temporary file could not be created. Possible reasons include
10132	a non-existing path or an insecure path when the secure
10133	option was requested.
10134	</result>
10135	</desc>
10136	<param name="templateName" type="wstring" dir="in">
10137	<desc>Template for the name of the file to create. This must contain
10138	at least one 'X' character. The first group of consecutive 'X'
10139	characters in the template will be replaced by a random
10140	alphanumeric string to produce a unique name.
10141	</desc>
10142	</param>
10143	<param name="mode" type="unsigned long" dir="in">
10144	<desc>The mode of the file to create. Use 0700 unless there are
10145	reasons not to. This parameter is ignored if "secure" is specified.
10146	</desc>
10147	</param>
10148	<param name="path" type="wstring" dir="in">
10149	<desc>The absolute path to create the temporary file in.</desc>
10150	</param>
10151	<param name="secure" type="boolean" dir="in">
10152	<desc>Whether to fail if the file can not be securely created.
10153	Currently this means that another unprivileged user cannot
10154	manipulate the path specified or remove the temporary file after
10155	it has been created. Also causes the mode specified to be ignored.
10156	May not be supported on all guest types.</desc>
10157	</param>
10158	<param name="file" type="IGuestFile" dir="return">
10159	<desc>On success this will contain an open file object for the new
10160	temporary file.
10161	</desc>
10162	</param>
10163	</method>
10164
10165	<method name="fileExists">
10166	<desc>
10167	Checks whether a file exists on the guest or not.
10168
10169	<result name="VBOX_E_IPRT_ERROR">
10170	Error while checking existence of the file specified.
10171	</result>
10172	</desc>
10173	<param name="path" type="wstring" dir="in">
10174	<desc>File to check existence for.</desc>
10175	</param>
10176	<param name="exists" type="boolean" dir="return">
10177	<desc>Returns @c true if the file exists, @c false if not.</desc>
10178	</param>
10179	</method>
10180
10181	<method name="fileRemove">
10182	<desc>
10183	Removes a single file on the guest.
10184
10185	<result name="VBOX_E_OBJECT_NOT_FOUND">
10186	File to remove was not found.
10187	</result>
10188	<result name="VBOX_E_IPRT_ERROR">
10189	Error while removing the file.
10190	</result>
10191	</desc>
10192	<param name="path" type="wstring" dir="in">
10193	<desc>Path to the file to remove.</desc>
10194	</param>
10195	</method>
10196
10197	<method name="fileOpen">
10198	<desc>
10199	Opens a file and creates a <link to="IGuestFile"/> object that
10200	can be used for further operations.
10201
10202	<result name="VBOX_E_OBJECT_NOT_FOUND">
10203	File to open was not found.
10204	</result>
10205	<result name="VBOX_E_IPRT_ERROR">
10206	Error while opening the file.
10207	</result>
10208	</desc>
10209	<param name="path" type="wstring" dir="in">
10210	<desc>Full path to file to open.</desc>
10211	</param>
10212	<param name="openMode" type="wstring" dir="in">
10213	<desc>The file open mode.</desc>
10214	</param>
10215	<param name="disposition" type="wstring" dir="in">
10216	<desc>The file disposition.</desc>
10217	</param>
10218	<param name="creationMode" type="unsigned long" dir="in">
10219	<desc>The file creation mode.</desc>
10220	</param>
10221	<param name="offset" type="long long" dir="in">
10222	<desc>The initial read/write offset.</desc>
10223	</param>
10224	<param name="file" type="IGuestFile" dir="return">
10225	<desc><link to="IGuestFile"/> object representing the opened file.</desc>
10226	</param>
10227	</method>
10228
10229	<method name="fileQueryInfo">
10230	<desc>
10231	Queries information of a file on the guest.
10232
10233	<result name="VBOX_E_OBJECT_NOT_FOUND">
10234	File to query information for was not found.
10235	</result>
10236	<result name="VBOX_E_IPRT_ERROR">
10237	Error querying information.
10238	</result>
10239	</desc>
10240	<param name="path" type="wstring" dir="in">
10241	<desc>File to query information for.</desc>
10242	</param>
10243	<param name="info" type="IGuestFsObjInfo" dir="return">
10244	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
10245	</param>
10246	</method>
10247
10248	<method name="fileQuerySize">
10249	<desc>
10250	Queries the size of a file on the guest.
10251
10252	<result name="VBOX_E_OBJECT_NOT_FOUND">
10253	File to rename was not found.
10254	</result>
10255	<result name="VBOX_E_IPRT_ERROR">
10256	Error querying file size.
10257	</result>
10258	</desc>
10259	<param name="path" type="wstring" dir="in">
10260	<desc>File to query the size for.</desc>
10261	</param>
10262	<param name="size" type="long long" dir="return">
10263	<desc>Queried file size.</desc>
10264	</param>
10265	</method>
10266
10267	<method name="fileRename">
10268	<desc>
10269	Renames a file on the guest.
10270
10271	<result name="E_NOTIMPL">
10272	The method is not implemented yet.
10273	</result>
10274	</desc>
10275	<param name="source" type="wstring" dir="in">
10276	<desc>Source file to rename.</desc>
10277	</param>
10278	<param name="dest" type="wstring" dir="in">
10279	<desc>Destination file to rename the source to.</desc>
10280	</param>
10281	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
10282	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
10283	</param>
10284	</method>
10285
10286	<method name="fileSetACL">
10287	<desc>
10288	Sets the ACL (Access Control List) of a file on the guest.
10289
10290	<result name="E_NOTIMPL">
10291	The method is not implemented yet.
10292	</result>
10293	</desc>
10294	<param name="file" type="wstring" dir="in">
10295	<desc>Full path of file to set the ACL for.</desc>
10296	</param>
10297	<param name="acl" type="wstring" dir="in">
10298	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
10299	</param>
10300	</method>
10301
10302	<method name="processCreate">
10303	<desc>
10304	Creates a new process running on the guest. The new process will be
10305	started asynchronously, meaning on return of this function it is not
10306	guaranteed that the guest process is in a started state. To wait for
10307	successful startup, use the <link to="IProcess::waitFor"/> call.
10308
10309	<note>
10310	Starting at VirtualBox 4.2 guest process execution by default is limited
10311	to serve up to 255 guest processes at a time. If all 255 guest processes
10312	are still active and running, creating a new guest process will result in an
10313	appropriate error message.
10314
10315	If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
10316	is / are set, the guest process will not exit until all data from the specified
10317	stream(s) is / are read out.
10318
10319	To raise or lower the guest process execution limit, either the guest property
10320	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
10321	command line by specifying "--control-procs-max-kept" needs to be modified.
10322	A restart of the guest OS is required afterwards. To serve unlimited guest
10323	processes, a value of "0" needs to be set (not recommended).
10324	</note>
10325
10326	<result name="VBOX_E_IPRT_ERROR">
10327	Error creating guest process.
10328	</result>
10329	</desc>
10330	<param name="command" type="wstring" dir="in">
10331	<desc>
10332	Full path name of the command to execute on the guest; the
10333	commands has to exists in the guest VM in order to be executed.
10334	</desc>
10335	</param>
10336	<param name="arguments" type="wstring" dir="in" safearray="yes">
10337	<desc>Array of arguments passed to the execution command.</desc>
10338	</param>
10339	<param name="environment" type="wstring" dir="in" safearray="yes">
10340	<desc>
10341	<para>Environment variables that can be set while the command is being
10342	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10343	variable just set its name ("NAME") without a value.</para>
10344	<para>This parameter can be used to override environment variables set by
10345	the guest session, which will be applied to the newly started process
10346	in any case.</para>
10347	</desc>
10348	</param>
10349	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10350	<desc>
10351	Process creation flags;
10352	see <link to="ProcessCreateFlag"/> for more information.
10353	</desc>
10354	</param>
10355	<param name="timeoutMS" type="unsigned long" dir="in">
10356	<desc>
10357	Timeout (in ms) for limiting the guest process' running time.
10358	Pass 0 for an infinite timeout. On timeout the guest process will be
10359	killed and its status will be put to an appropriate value. See
10360	<link to="ProcessStatus"/> for more information.
10361	</desc>
10362	</param>
10363	<param name="guestProcess" type="IGuestProcess" dir="return">
10364	<desc>Guest process object of the newly created process.</desc>
10365	</param>
10366	</method>
10367
10368	<method name="processCreateEx">
10369	<desc>
10370	<para>Creates a new process running on the guest. Extended version for
10371	also setting the process priority and affinity.</para>
10372
10373	<para>See <link to="IGuestSession::processCreate"/> for more
10374	information.</para>
10375	</desc>
10376	<param name="command" type="wstring" dir="in">
10377	<desc>
10378	Full path name of the command to execute on the guest; the
10379	commands has to exists in the guest VM in order to be executed.
10380	</desc>
10381	</param>
10382	<param name="arguments" type="wstring" dir="in" safearray="yes">
10383	<desc>Array of arguments passed to the execution command.</desc>
10384	</param>
10385	<param name="environment" type="wstring" dir="in" safearray="yes">
10386	<desc>
10387	<para>Environment variables that can be set while the command is being
10388	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10389	variable just set its name ("NAME") without a value.</para>
10390	<para>This parameter can be used to override environment variables set by
10391	the guest session, which will be applied to the newly started process
10392	in any case.</para>
10393	</desc>
10394	</param>
10395	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10396	<desc>
10397	Process creation flags;
10398	see <link to="ProcessCreateFlag"/> for more information.
10399	</desc>
10400	</param>
10401	<param name="timeoutMS" type="unsigned long" dir="in">
10402	<desc>
10403	Timeout (in ms) for limiting the guest process' running time.
10404	Pass 0 for an infinite timeout. On timeout the guest process will be
10405	killed and its status will be put to an appropriate value. See
10406	<link to="ProcessStatus"/> for more information.
10407	</desc>
10408	</param>
10409	<param name="priority" type="ProcessPriority" dir="in">
10410	<desc>
10411	Process priority to use for execution;
10412	see see <link to="ProcessPriority"/> for more information.</desc>
10413	</param>
10414	<param name="affinity" type="long" dir="in" safearray="yes">
10415	<desc>
10416	Process affinity to use for execution. This parameter
10417	is not implemented yet.
10418	</desc>
10419	</param>
10420	<param name="guestProcess" type="IGuestProcess" dir="return">
10421	<desc>Guest process object of the newly created process.</desc>
10422	</param>
10423	</method>
10424
10425	<method name="processGet">
10426	<desc>
10427	Gets a certain guest process by its process ID (PID).
10428	</desc>
10429	<param name="pid" type="unsigned long" dir="in">
10430	<desc>Process ID (PID) to get guest process for.</desc>
10431	</param>
10432	<param name="guestProcess" type="IGuestProcess" dir="return">
10433	<desc>Guest process of specified process ID (PID).</desc>
10434	</param>
10435	</method>
10436
10437	<method name="symlinkCreate">
10438	<desc>
10439	Creates a symbolic link on the guest.
10440
10441	<result name="E_NOTIMPL">
10442	The method is not implemented yet.
10443	</result>
10444	</desc>
10445	<param name="source" type="wstring" dir="in">
10446	<desc>The name of the symbolic link.</desc>
10447	</param>
10448	<param name="target" type="wstring" dir="in">
10449	<desc>The path to the symbolic link target.</desc>
10450	</param>
10451	<param name="type" type="SymlinkType" dir="in">
10452	<desc>
10453	The symbolic link type;
10454	see <link to="SymlinkReadFlag"/> for more information.
10455	</desc>
10456	</param>
10457	</method>
10458
10459	<method name="symlinkExists">
10460	<desc>
10461	Checks whether a symbolic link exists on the guest or not.
10462
10463	<result name="E_NOTIMPL">
10464	The method is not implemented yet.
10465	</result>
10466	</desc>
10467	<param name="symlink" type="wstring" dir="in">
10468	<desc>Symbolic link to check existence for.</desc>
10469	</param>
10470	<param name="exists" type="boolean" dir="return">
10471	<desc>Returns @c true if the symbolic link exists, @c false if not.</desc>
10472	</param>
10473	</method>
10474
10475	<method name="symlinkRead">
10476	<desc>
10477	Reads a symbolic link on the guest.
10478
10479	<result name="E_NOTIMPL">
10480	The method is not implemented yet.
10481	</result>
10482	</desc>
10483	<param name="symlink" type="wstring" dir="in">
10484	<desc>Full path to symbolic link to read.</desc>
10485	</param>
10486	<param name="flags" type="SymlinkReadFlag" dir="in" safearray="yes">
10487	<desc>
10488	Read flags; see <link to="SymlinkReadFlag"/> for more information.
10489	</desc>
10490	</param>
10491	<param name="target" type="wstring" dir="return">
10492	<desc>
10493	Target of the symbolic link pointing to, if found.
10494	</desc>
10495	</param>
10496	</method>
10497
10498	<method name="symlinkRemoveDirectory">
10499	<desc>
10500	Removes a symbolic link on the guest if it's a directory.
10501
10502	<result name="E_NOTIMPL">
10503	The method is not implemented yet.
10504	</result>
10505	</desc>
10506	<param name="path" type="wstring" dir="in">
10507	<desc>Symbolic link to remove.</desc>
10508	</param>
10509	</method>
10510
10511	<method name="symlinkRemoveFile">
10512	<desc>
10513	Removes a symbolic link on the guest if it's a file.
10514
10515	<result name="E_NOTIMPL">
10516	The method is not implemented yet.
10517	</result>
10518	</desc>
10519	<param name="file" type="wstring" dir="in">
10520	<desc>Symbolic link to remove.</desc>
10521	</param>
10522	</method>
10523
10524	<method name="waitFor">
10525	<desc>
10526	Waits for one more events to happen.
10527	</desc>
10528	<param name="waitFor" type="unsigned long" dir="in">
10529	<desc>
10530	Specifies what to wait for;
10531	see <link to="GuestSessionWaitForFlag"/> for more information.
10532	</desc>
10533	</param>
10534	<param name="timeoutMS" type="unsigned long" dir="in">
10535	<desc>
10536	Timeout (in ms) to wait for the operation to complete.
10537	Pass 0 for an infinite timeout.
10538	</desc>
10539	</param>
10540	<param name="reason" type="GuestSessionWaitResult" dir="return">
10541	<desc>
10542	The overall wait result;
10543	see <link to="GuestSessionWaitResult"/> for more information.
10544	</desc>
10545	</param>
10546	</method>
10547
10548	<method name="waitForArray">
10549	<desc>
10550	Waits for one more events to happen.
10551	Scriptable version of <link to="#waitFor" />.
10552	</desc>
10553	<param name="waitFor" type="GuestSessionWaitForFlag" dir="in" safearray="yes">
10554	<desc>
10555	Specifies what to wait for;
10556	see <link to="GuestSessionWaitForFlag"/> for more information.
10557	</desc>
10558	</param>
10559	<param name="timeoutMS" type="unsigned long" dir="in">
10560	<desc>
10561	Timeout (in ms) to wait for the operation to complete.
10562	Pass 0 for an infinite timeout.
10563	</desc>
10564	</param>
10565	<param name="reason" type="GuestSessionWaitResult" dir="return">
10566	<desc>
10567	The overall wait result;
10568	see <link to="GuestSessionWaitResult"/> for more information.
10569	</desc>
10570	</param>
10571	</method>
10572
10573	</interface>
10574
10575	<interface
10576	name="IProcess" extends="$unknown"
10577	uuid="5a4fe06d-8cb1-40ff-ac9e-9676e32f706e"
10578	wsmap="managed"
10579	>
10580	<desc>
10581	Abstract parent interface for processes handled by VirtualBox.
10582	</desc>
10583
10584	<attribute name="arguments" type="wstring" readonly="yes" safearray="yes">
10585	<desc>
10586	The arguments this process is using for execution.
10587	</desc>
10588	</attribute>
10589	<attribute name="environment" type="wstring" readonly="yes" safearray="yes">
10590	<desc>
10591	The environment block this process is using during execution.
10592	</desc>
10593	</attribute>
10594	<attribute name="eventSource" type="IEventSource" readonly="yes">
10595	<desc>
10596	Event source for VirtualBox events.
10597	</desc>
10598	</attribute>
10599	<attribute name="executablePath" type="wstring" readonly="yes">
10600	<desc>Full path of the actual executable image.</desc>
10601	</attribute>
10602	<attribute name="exitCode" type="long" readonly="yes">
10603	<desc>
10604	The exit code. Only available when the process has been
10605	terminated normally.
10606	</desc>
10607	</attribute>
10608	<attribute name="name" type="wstring" readonly="yes">
10609	<desc>
10610	The friendly name of this process.
10611	</desc>
10612	</attribute>
10613	<attribute name="PID" type="unsigned long" readonly="yes">
10614	<desc>
10615	The process ID (PID).
10616	</desc>
10617	</attribute>
10618	<attribute name="status" type="ProcessStatus" readonly="yes">
10619	<desc>
10620	The current process status; see <link to="ProcessStatus"/>
10621	for more information.
10622	</desc>
10623	</attribute>
10624
10625	<method name="waitFor">
10626	<desc>
10627	Waits for one more events to happen.
10628	</desc>
10629	<param name="waitFor" type="unsigned long" dir="in">
10630	<desc>
10631	Specifies what to wait for;
10632	see <link to="ProcessWaitForFlag"/> for more information.
10633	</desc>
10634	</param>
10635	<param name="timeoutMS" type="unsigned long" dir="in">
10636	<desc>
10637	Timeout (in ms) to wait for the operation to complete.
10638	Pass 0 for an infinite timeout.
10639	</desc>
10640	</param>
10641	<param name="reason" type="ProcessWaitResult" dir="return">
10642	<desc>
10643	The overall wait result;
10644	see <link to="ProcessWaitResult"/> for more information.
10645	</desc>
10646	</param>
10647	</method>
10648
10649	<method name="waitForArray">
10650	<desc>
10651	Waits for one more events to happen.
10652	Scriptable version of <link to="#waitFor" />.
10653	</desc>
10654	<param name="waitFor" type="ProcessWaitForFlag" dir="in" safearray="yes">
10655	<desc>
10656	Specifies what to wait for;
10657	see <link to="ProcessWaitForFlag"/> for more information.
10658	</desc>
10659	</param>
10660	<param name="timeoutMS" type="unsigned long" dir="in">
10661	<desc>
10662	Timeout (in ms) to wait for the operation to complete.
10663	Pass 0 for an infinite timeout.
10664	</desc>
10665	</param>
10666	<param name="reason" type="ProcessWaitResult" dir="return">
10667	<desc>
10668	The overall wait result;
10669	see <link to="ProcessWaitResult"/> for more information.
10670	</desc>
10671	</param>
10672	</method>
10673
10674	<method name="read">
10675	<desc>
10676	Reads data from a running process.
10677	</desc>
10678	<param name="handle" type="unsigned long" dir="in">
10679	<desc>Handle to read from. Usually 0 is stdin.</desc>
10680	</param>
10681	<param name="toRead" type="unsigned long" dir="in">
10682	<desc>Number of bytes to read.</desc>
10683	</param>
10684	<param name="timeoutMS" type="unsigned long" dir="in">
10685	<desc>
10686	Timeout (in ms) to wait for the operation to complete.
10687	Pass 0 for an infinite timeout.
10688	</desc>
10689	</param>
10690	<param name="data" type="octet" dir="return" safearray="yes">
10691	<desc>Array of data read.</desc>
10692	</param>
10693	</method>
10694
10695	<method name="write">
10696	<desc>
10697	Writes data to a running process.
10698	</desc>
10699	<param name="handle" type="unsigned long" dir="in">
10700	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10701	</param>
10702	<param name="flags" type="unsigned long" dir="in">
10703	<desc>
10704	A combination of <link to="ProcessInputFlag"/> flags.
10705	</desc>
10706	</param>
10707	<param name="data" type="octet" dir="in" safearray="yes">
10708	<desc>
10709	Array of bytes to write. The size of the array also specifies
10710	how much to write.
10711	</desc>
10712	</param>
10713	<param name="timeoutMS" type="unsigned long" dir="in">
10714	<desc>
10715	Timeout (in ms) to wait for the operation to complete.
10716	Pass 0 for an infinite timeout.
10717	</desc>
10718	</param>
10719	<param name="written" type="unsigned long" dir="return">
10720	<desc>How much bytes were written.</desc>
10721	</param>
10722	</method>
10723
10724	<method name="writeArray">
10725	<desc>
10726	Writes data to a running process.
10727	Scriptable version of <link to="#write" />.
10728	</desc>
10729	<param name="handle" type="unsigned long" dir="in">
10730	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10731	</param>
10732	<param name="flags" type="ProcessInputFlag" dir="in" safearray="yes">
10733	<desc>
10734	A combination of <link to="ProcessInputFlag"/> flags.
10735	</desc>
10736	</param>
10737	<param name="data" type="octet" dir="in" safearray="yes">
10738	<desc>
10739	Array of bytes to write. The size of the array also specifies
10740	how much to write.
10741	</desc>
10742	</param>
10743	<param name="timeoutMS" type="unsigned long" dir="in">
10744	<desc>
10745	Timeout (in ms) to wait for the operation to complete.
10746	Pass 0 for an infinite timeout.
10747	</desc>
10748	</param>
10749	<param name="written" type="unsigned long" dir="return">
10750	<desc>How much bytes were written.</desc>
10751	</param>
10752	</method>
10753
10754	<method name="terminate">
10755	<desc>
10756	Terminates (kills) a running process.
10757	</desc>
10758	</method>
10759	</interface>
10760
10761	<interface
10762	name="IGuestProcess" extends="IProcess"
10763	uuid="dfa39a36-5d43-4840-a025-67ea956b3111"
10764	wsmap="managed"
10765	>
10766	<desc>
10767	Implementation of the <link to="IProcess" /> object
10768	for processes on the guest.
10769	</desc>
10770	</interface>
10771
10772	<interface
10773	name="IDirectory" extends="$unknown"
10774	uuid="1b70dd03-26d7-483a-8877-89bbb0f87b70"
10775	wsmap="managed"
10776	>
10777	<desc>
10778	Abstract parent interface for directories handled by VirtualBox.
10779	</desc>
10780
10781	<attribute name="directoryName" type="wstring" readonly="yes">
10782	<desc>
10783	Full path of directory.
10784	</desc>
10785	</attribute>
10786
10787	<attribute name="filter" type="wstring" readonly="yes">
10788	<desc>
10789	The open filter.
10790	</desc>
10791	</attribute>
10792
10793	<method name="close">
10794	<desc>
10795	Closes this directory. After closing operations like reading the next
10796	directory entry will not be possible anymore.
10797	</desc>
10798	</method>
10799
10800	<method name="read">
10801	<desc>
10802	Reads the next directory entry of this directory.
10803	<result name="VBOX_E_OBJECT_NOT_FOUND">
10804	No more directory entries to read.
10805	</result>
10806	</desc>
10807	<param name="objInfo" type="IFsObjInfo" dir="return">
10808	<desc>Object information of the current directory entry read. Also see
10809	<link to="IFsObjInfo"/>.</desc>
10810	</param>
10811	</method>
10812	</interface>
10813
10814	<interface
10815	name="IGuestDirectory" extends="IDirectory"
10816	uuid="af4a8ce0-0725-42b7-8826-46e3c7ba7357"
10817	wsmap="managed"
10818	>
10819	<desc>
10820	Implementation of the <link to="IDirectory" /> object
10821	for directories on the guest.
10822	</desc>
10823	</interface>
10824
10825	<interface
10826	name="IFile" extends="$unknown"
10827	uuid="ceb895d7-8b2d-4a39-8f7c-7d2270f341d5"
10828	wsmap="managed"
10829	>
10830	<desc>
10831	Abstract parent interface for files handled by VirtualBox.
10832	</desc>
10833	<attribute name="creationMode" type="unsigned long" readonly="yes">
10834	<desc>
10835	The creation mode.
10836	</desc>
10837	</attribute>
10838	<attribute name="disposition" type="unsigned long" readonly="yes">
10839	<desc>
10840	The disposition mode.
10841	</desc>
10842	</attribute>
10843	<attribute name="eventSource" type="IEventSource" readonly="yes">
10844	<desc>
10845	Event source for guest session events.
10846	</desc>
10847	</attribute>
10848	<attribute name="fileName" type="wstring" readonly="yes">
10849	<desc>
10850	Full path of the actual file name of this file.
10851	</desc>
10852	</attribute>
10853	<attribute name="initialSize" type="long long" readonly="yes">
10854	<desc>
10855	The initial size in bytes when opened.
10856	</desc>
10857	</attribute>
10858	<attribute name="openMode" type="unsigned long" readonly="yes">
10859	<desc>
10860	The open mode.
10861	</desc>
10862	</attribute>
10863	<attribute name="offset" type="long long" readonly="yes">
10864	<desc>
10865	Current read/write offset in bytes.
10866	</desc>
10867	</attribute>
10868	<attribute name="status" type="FileStatus" readonly="yes">
10869	<desc>
10870	Current file status.
10871	</desc>
10872	</attribute>
10873
10874	<method name="close">
10875	<desc>
10876	Closes this file. After closing operations like reading data,
10877	writing data or querying information will not be possible anymore.
10878	</desc>
10879	</method>
10880
10881	<method name="queryInfo">
10882	<desc>
10883	Queries information about this file.
10884
10885	<result name="E_NOTIMPL">
10886	The method is not implemented yet.
10887	</result>
10888	</desc>
10889	<param name="objInfo" type="IFsObjInfo" dir="return">
10890	<desc>Object information of this file. Also see
10891	<link to="IFsObjInfo"/>.</desc>
10892	</param>
10893	</method>
10894
10895	<method name="read">
10896	<desc>
10897	Reads data from this file.
10898
10899	<result name="E_NOTIMPL">
10900	The method is not implemented yet.
10901	</result>
10902	</desc>
10903	<param name="toRead" type="unsigned long" dir="in">
10904	<desc>Number of bytes to read.</desc>
10905	</param>
10906	<param name="timeoutMS" type="unsigned long" dir="in">
10907	<desc>
10908	Timeout (in ms) to wait for the operation to complete.
10909	Pass 0 for an infinite timeout.
10910	</desc>
10911	</param>
10912	<param name="data" type="octet" dir="return" safearray="yes">
10913	<desc>Array of data read.</desc>
10914	</param>
10915	</method>
10916
10917	<method name="readAt">
10918	<desc>
10919	Reads data from an offset of this file.
10920
10921	<result name="E_NOTIMPL">
10922	The method is not implemented yet.
10923	</result>
10924	</desc>
10925	<param name="offset" type="long long" dir="in">
10926	<desc>Offset in bytes to start reading.</desc>
10927	</param>
10928	<param name="toRead" type="unsigned long" dir="in">
10929	<desc>Number of bytes to read.</desc>
10930	</param>
10931	<param name="timeoutMS" type="unsigned long" dir="in">
10932	<desc>
10933	Timeout (in ms) to wait for the operation to complete.
10934	Pass 0 for an infinite timeout.
10935	</desc>
10936	</param>
10937	<param name="data" type="octet" dir="return" safearray="yes">
10938	<desc>Array of data read.</desc>
10939	</param>
10940	</method>
10941
10942	<method name="seek">
10943	<desc>
10944	Changes the read and write position of this file.
10945
10946	<result name="E_NOTIMPL">
10947	The method is not implemented yet.
10948	</result>
10949	</desc>
10950	<param name="offset" type="long long" dir="in">
10951	<desc>Offset to seek.</desc>
10952	</param>
10953	<param name="whence" type="FileSeekType" dir="in">
10954	<desc>
10955	Seek mode; see <link to="FileSeekType"/> for more information.
10956	</desc>
10957	</param>
10958	</method>
10959
10960	<method name="setACL">
10961	<desc>
10962	Sets the ACL of this file.
10963
10964	<result name="E_NOTIMPL">
10965	The method is not implemented yet.
10966	</result>
10967	</desc>
10968	<param name="acl" type="wstring" dir="in">
10969	<desc>ACL string to set.</desc>
10970	</param>
10971	</method>
10972
10973	<method name="write">
10974	<desc>
10975	Writes bytes to this file.
10976	</desc>
10977	<param name="data" type="octet" dir="in" safearray="yes">
10978	<desc>
10979	Array of bytes to write. The size of the array also specifies
10980	how much to write.
10981	</desc>
10982	</param>
10983	<param name="timeoutMS" type="unsigned long" dir="in">
10984	<desc>
10985	Timeout (in ms) to wait for the operation to complete.
10986	Pass 0 for an infinite timeout.
10987	</desc>
10988	</param>
10989	<param name="written" type="unsigned long" dir="return">
10990	<desc>How much bytes were written.</desc>
10991	</param>
10992	</method>
10993
10994	<method name="writeAt">
10995	<desc>
10996	Writes bytes at a certain offset to this file.
10997
10998	<result name="E_NOTIMPL">
10999	The method is not implemented yet.
11000	</result>
11001	</desc>
11002	<param name="offset" type="long long" dir="in">
11003	<desc>Offset in bytes to start writing.</desc>
11004	</param>
11005	<param name="data" type="octet" dir="in" safearray="yes">
11006	<desc>
11007	Array of bytes to write. The size of the array also specifies
11008	how much to write.
11009	</desc>
11010	</param>
11011	<param name="timeoutMS" type="unsigned long" dir="in">
11012	<desc>
11013	Timeout (in ms) to wait for the operation to complete.
11014	Pass 0 for an infinite timeout.
11015	</desc>
11016	</param>
11017	<param name="written" type="unsigned long" dir="return">
11018	<desc>How much bytes were written.</desc>
11019	</param>
11020	</method>
11021
11022	</interface>
11023
11024	<interface
11025	name="IGuestFile" extends="IFile"
11026	uuid="60661aec-145f-4d11-b80e-8ea151598093"
11027	wsmap="managed"
11028	>
11029	<desc>
11030	Implementation of the <link to="IFile" /> object
11031	for files on the guest.
11032	</desc>
11033	</interface>
11034
11035	<interface
11036	name="IFsObjInfo" extends="$unknown"
11037	uuid="4047ba30-7006-4966-ae86-94164e5e20eb"
11038	wsmap="managed"
11039	>
11040	<desc>
11041	Abstract parent interface for VirtualBox file system object information.
11042	This can be information about a file or a directory, for example.
11043	</desc>
11044
11045	<attribute name="accessTime" type="long long" readonly="yes">
11046	<desc>
11047	Time of last access (st_atime).
11048	</desc>
11049	</attribute>
11050	<attribute name="allocatedSize" type="long long" readonly="yes">
11051	<desc>
11052	Disk allocation size (st_blocks * DEV_BSIZE).
11053	</desc>
11054	</attribute>
11055	<attribute name="birthTime" type="long long" readonly="yes">
11056	<desc>
11057	Time of file birth (st_birthtime).
11058	</desc>
11059	</attribute>
11060	<attribute name="changeTime" type="long long" readonly="yes">
11061	<desc>
11062	Time of last status change (st_ctime).
11063	</desc>
11064	</attribute>
11065	<attribute name="deviceNumber" type="unsigned long" readonly="yes">
11066	<desc>
11067	The device number of a character or block device type object (st_rdev).
11068	</desc>
11069	</attribute>
11070	<attribute name="fileAttributes" type="wstring" readonly="yes">
11071	<desc>
11072	File attributes. Not implemented yet.
11073	</desc>
11074	</attribute>
11075	<attribute name="generationId" type="unsigned long" readonly="yes">
11076	<desc>
11077	The current generation number (st_gen).
11078	</desc>
11079	</attribute>
11080	<attribute name="GID" type="unsigned long" readonly="yes">
11081	<desc>
11082	The group the filesystem object is assigned (st_gid).
11083	</desc>
11084	</attribute>
11085	<attribute name="groupName" type="wstring" readonly="yes">
11086	<desc>
11087	The group name.
11088	</desc>
11089	</attribute>
11090	<attribute name="hardLinks" type="unsigned long" readonly="yes">
11091	<desc>
11092	Number of hard links to this filesystem object (st_nlink).
11093	</desc>
11094	</attribute>
11095	<attribute name="modificationTime" type="long long" readonly="yes">
11096	<desc>
11097	Time of last data modification (st_mtime).
11098	</desc>
11099	</attribute>
11100	<attribute name="name" type="wstring" readonly="yes">
11101	<desc>
11102	The object's name.
11103	</desc>
11104	</attribute>
11105	<attribute name="nodeId" type="long long" readonly="yes">
11106	<desc>
11107	The unique identifier (within the filesystem) of this filesystem object (st_ino).
11108	</desc>
11109	</attribute>
11110	<attribute name="nodeIdDevice" type="unsigned long" readonly="yes">
11111	<desc>
11112	The device number of the device which this filesystem object resides on (st_dev).
11113	</desc>
11114	</attribute>
11115	<attribute name="objectSize" type="long long" readonly="yes">
11116	<desc>
11117	The logical size (st_size). For normal files this is the size of the file.
11118	For symbolic links, this is the length of the path name contained in the
11119	symbolic link. For other objects this fields needs to be specified.
11120	</desc>
11121	</attribute>
11122	<attribute name="type" type="FsObjType" readonly="yes">
11123	<desc>
11124	The object type. See <link to="FsObjType" /> for more.
11125	</desc>
11126	</attribute>
11127	<attribute name="UID" type="unsigned long" readonly="yes">
11128	<desc>
11129	The user owning the filesystem object (st_uid).
11130	</desc>
11131	</attribute>
11132	<attribute name="userFlags" type="unsigned long" readonly="yes">
11133	<desc>
11134	User flags (st_flags).
11135	</desc>
11136	</attribute>
11137	<attribute name="userName" type="wstring" readonly="yes">
11138	<desc>
11139	The user name.
11140	</desc>
11141	</attribute>
11142
11143	</interface>
11144
11145	<interface
11146	name="IGuestFsObjInfo" extends="IFsObjInfo"
11147	uuid="d5cf678e-3484-4e4a-ac55-329e15462e18"
11148	wsmap="managed"
11149	>
11150	<desc>
11151	Represents the guest implementation of the
11152	<link to="IFsObjInfo" /> object.
11153	</desc>
11154	</interface>
11155
11156	<interface
11157	name="IGuest" extends="$unknown"
11158	uuid="19c32350-0618-4ede-b0c3-2b4311bf0d9b"
11159	wsmap="managed"
11160	>
11161	<desc>
11162	The IGuest interface represents information about the operating system
11163	running inside the virtual machine. Used in
11164	<link to="IConsole::guest"/>.
11165
11166	IGuest provides information about the guest operating system, whether
11167	Guest Additions are installed and other OS-specific virtual machine
11168	properties.
11169	</desc>
11170
11171	<attribute name="OSTypeId" type="wstring" readonly="yes">
11172	<desc>
11173	Identifier of the Guest OS type as reported by the Guest
11174	Additions.
11175	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
11176	an IGuestOSType object representing details about the given
11177	Guest OS type.
11178	<note>
11179	If Guest Additions are not installed, this value will be
11180	the same as <link to="IMachine::OSTypeId"/>.
11181	</note>
11182	</desc>
11183	</attribute>
11184
11185	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
11186	<desc>
11187	Current run level of the Guest Additions.
11188	</desc>
11189	</attribute>
11190
11191	<attribute name="additionsVersion" type="wstring" readonly="yes">
11192	<desc>
11193	Version of the Guest Additions in the same format as
11194	<link to="IVirtualBox::version"/>.
11195	</desc>
11196	</attribute>
11197
11198	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
11199	<desc>
11200	The internal build revision number of the additions.
11201
11202	See also <link to="IVirtualBox::revision"/>.
11203	</desc>
11204	</attribute>
11205
11206	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
11207	<desc>
11208	Array of current known facilities. Only returns facilities where a status is known,
11209	e.g. facilities with an unknown status will not be returned.
11210	</desc>
11211	</attribute>
11212
11213	<attribute name="sessions" type="IGuestSession" readonly="yes" safearray="yes">
11214	<desc>Returns a collection of all opened guest sessions.</desc>
11215	</attribute>
11216
11217	<attribute name="memoryBalloonSize" type="unsigned long">
11218	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
11219	</attribute>
11220
11221	<attribute name="statisticsUpdateInterval" type="unsigned long">
11222	<desc>Interval to update guest statistics in seconds.</desc>
11223	</attribute>
11224
11225	<method name="internalGetStatistics">
11226	<desc>
11227	Internal method; do not use as it might change at any time.
11228	</desc>
11229	<param name="cpuUser" type="unsigned long" dir="out">
11230	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
11231	</param>
11232	<param name="cpuKernel" type="unsigned long" dir="out">
11233	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
11234	</param>
11235	<param name="cpuIdle" type="unsigned long" dir="out">
11236	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
11237	</param>
11238	<param name="memTotal" type="unsigned long" dir="out">
11239	<desc>Total amount of physical guest RAM.</desc>
11240	</param>
11241	<param name="memFree" type="unsigned long" dir="out">
11242	<desc>Free amount of physical guest RAM.</desc>
11243	</param>
11244	<param name="memBalloon" type="unsigned long" dir="out">
11245	<desc>Amount of ballooned physical guest RAM.</desc>
11246	</param>
11247	<param name="memShared" type="unsigned long" dir="out">
11248	<desc>Amount of shared physical guest RAM.</desc>
11249	</param>
11250	<param name="memCache" type="unsigned long" dir="out">
11251	<desc>Total amount of guest (disk) cache memory.</desc>
11252	</param>
11253	<param name="pagedTotal" type="unsigned long" dir="out">
11254	<desc>Total amount of space in the page file.</desc>
11255	</param>
11256	<param name="memAllocTotal" type="unsigned long" dir="out">
11257	<desc>Total amount of memory allocated by the hypervisor.</desc>
11258	</param>
11259	<param name="memFreeTotal" type="unsigned long" dir="out">
11260	<desc>Total amount of free memory available in the hypervisor.</desc>
11261	</param>
11262	<param name="memBalloonTotal" type="unsigned long" dir="out">
11263	<desc>Total amount of memory ballooned by the hypervisor.</desc>
11264	</param>
11265	<param name="memSharedTotal" type="unsigned long" dir="out">
11266	<desc>Total amount of shared memory in the hypervisor.</desc>
11267	</param>
11268	</method>
11269
11270	<method name="getFacilityStatus">
11271	<desc>
11272	Get the current status of a Guest Additions facility.
11273	</desc>
11274	<param name="facility" type="AdditionsFacilityType" dir="in">
11275	<desc>Facility to check status for.</desc>
11276	</param>
11277	<param name="timestamp" type="long long" dir="out">
11278	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
11279	</param>
11280	<param name="status" type="AdditionsFacilityStatus" dir="return">
11281	<desc>The current (latest) facility status.</desc>
11282	</param>
11283	</method>
11284
11285	<method name="getAdditionsStatus">
11286	<desc>
11287	Retrieve the current status of a certain Guest Additions run level.
11288
11289	<result name="VBOX_E_NOT_SUPPORTED">
11290	Wrong status level specified.
11291	</result>
11292
11293	</desc>
11294	<param name="level" type="AdditionsRunLevelType" dir="in">
11295	<desc>Status level to check</desc>
11296	</param>
11297	<param name="active" type="boolean" dir="return">
11298	<desc>Flag whether the status level has been reached or not</desc>
11299	</param>
11300	</method>
11301
11302	<method name="setCredentials">
11303	<desc>
11304	Store login credentials that can be queried by guest operating
11305	systems with Additions installed. The credentials are transient
11306	to the session and the guest may also choose to erase them. Note
11307	that the caller cannot determine whether the guest operating system
11308	has queried or made use of the credentials.
11309
11310	<result name="VBOX_E_VM_ERROR">
11311	VMM device is not available.
11312	</result>
11313
11314	</desc>
11315	<param name="userName" type="wstring" dir="in">
11316	<desc>User name string, can be empty</desc>
11317	</param>
11318	<param name="password" type="wstring" dir="in">
11319	<desc>Password string, can be empty</desc>
11320	</param>
11321	<param name="domain" type="wstring" dir="in">
11322	<desc>Domain name (guest logon scheme specific), can be empty</desc>
11323	</param>
11324	<param name="allowInteractiveLogon" type="boolean" dir="in">
11325	<desc>
11326	Flag whether the guest should alternatively allow the user to
11327	interactively specify different credentials. This flag might
11328	not be supported by all versions of the Additions.
11329	</desc>
11330	</param>
11331	</method>
11332
11333	<method name="dragHGEnter">
11334	<desc>
11335	Informs the guest about a Drag and Drop enter event.
11336
11337	This is used in Host - Guest direction.
11338
11339	<result name="VBOX_E_VM_ERROR">
11340	VMM device is not available.
11341	</result>
11342
11343	</desc>
11344	<param name="screenId" type="unsigned long" dir="in">
11345	<desc>The screen id where the Drag and Drop event occured.</desc>
11346	</param>
11347	<param name="y" type="unsigned long" dir="in">
11348	<desc>y-position of the event.</desc>
11349	</param>
11350	<param name="x" type="unsigned long" dir="in">
11351	<desc>x-position of the event.</desc>
11352	</param>
11353	<param name="defaultAction" type="DragAndDropAction" dir="in">
11354	<desc>The default action to use.</desc>
11355	</param>
11356	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11357	<desc>The actions which are allowed.</desc>
11358	</param>
11359	<param name="formats" type="wstring" dir="in" safearray="yes">
11360	<desc>The supported mime types.</desc>
11361	</param>
11362	<param name="resultAction" type="DragAndDropAction" dir="return">
11363	<desc>The resulting action of this event.</desc>
11364	</param>
11365	</method>
11366
11367	<method name="dragHGMove">
11368	<desc>
11369	Informs the guest about a Drag and Drop move event.
11370
11371	This is used in Host - Guest direction.
11372
11373	<result name="VBOX_E_VM_ERROR">
11374	VMM device is not available.
11375	</result>
11376
11377	</desc>
11378	<param name="screenId" type="unsigned long" dir="in">
11379	<desc>The screen id where the Drag and Drop event occured.</desc>
11380	</param>
11381	<param name="x" type="unsigned long" dir="in">
11382	<desc>x-position of the event.</desc>
11383	</param>
11384	<param name="y" type="unsigned long" dir="in">
11385	<desc>y-position of the event.</desc>
11386	</param>
11387	<param name="defaultAction" type="DragAndDropAction" dir="in">
11388	<desc>The default action to use.</desc>
11389	</param>
11390	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11391	<desc>The actions which are allowed.</desc>
11392	</param>
11393	<param name="formats" type="wstring" dir="in" safearray="yes">
11394	<desc>The supported mime types.</desc>
11395	</param>
11396	<param name="resultAction" type="DragAndDropAction" dir="return">
11397	<desc>The resulting action of this event.</desc>
11398	</param>
11399	</method>
11400
11401	<method name="dragHGLeave">
11402	<desc>
11403	Informs the guest about a Drag and Drop leave event.
11404
11405	This is used in Host - Guest direction.
11406
11407	<result name="VBOX_E_VM_ERROR">
11408	VMM device is not available.
11409	</result>
11410
11411	</desc>
11412	<param name="screenId" type="unsigned long" dir="in">
11413	<desc>The screen id where the Drag and Drop event occured.</desc>
11414	</param>
11415	</method>
11416
11417	<method name="dragHGDrop">
11418	<desc>
11419	Informs the guest about a drop event.
11420
11421	This is used in Host - Guest direction.
11422
11423	<result name="VBOX_E_VM_ERROR">
11424	VMM device is not available.
11425	</result>
11426
11427	</desc>
11428	<param name="screenId" type="unsigned long" dir="in">
11429	<desc>The screen id where the Drag and Drop event occured.</desc>
11430	</param>
11431	<param name="x" type="unsigned long" dir="in">
11432	<desc>x-position of the event.</desc>
11433	</param>
11434	<param name="y" type="unsigned long" dir="in">
11435	<desc>y-position of the event.</desc>
11436	</param>
11437	<param name="defaultAction" type="DragAndDropAction" dir="in">
11438	<desc>The default action to use.</desc>
11439	</param>
11440	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11441	<desc>The actions which are allowed.</desc>
11442	</param>
11443	<param name="formats" type="wstring" dir="in" safearray="yes">
11444	<desc>The supported mime types.</desc>
11445	</param>
11446	<param name="format" type="wstring" dir="out">
11447	<desc>The resulting format of this event.</desc>
11448	</param>
11449	<param name="resultAction" type="DragAndDropAction" dir="return">
11450	<desc>The resulting action of this event.</desc>
11451	</param>
11452	</method>
11453
11454	<method name="dragHGPutData">
11455	<desc>
11456	Informs the guest about a drop data event.
11457
11458	This is used in Host - Guest direction.
11459
11460	<result name="VBOX_E_VM_ERROR">
11461	VMM device is not available.
11462	</result>
11463
11464	</desc>
11465	<param name="screenId" type="unsigned long" dir="in">
11466	<desc>The screen id where the Drag and Drop event occured.</desc>
11467	</param>
11468	<param name="format" type="wstring" dir="in">
11469	<desc>The mime type the data is in.</desc>
11470	</param>
11471	<param name="data" type="octet" dir="in" safearray="yes">
11472	<desc>The actual data.</desc>
11473	</param>
11474	<param name="progress" type="IProgress" dir="return">
11475	<desc>Progress object to track the operation completion.</desc>
11476	</param>
11477	</method>
11478
11479	<method name="dragGHPending">
11480	<desc>
11481	Ask the guest if there is any Drag and Drop operation pending in the guest.
11482
11483	If no Drag and Drop operation is pending currently, Ignore is returned.
11484
11485	This is used in Guest - Host direction.
11486
11487	<result name="VBOX_E_VM_ERROR">
11488	VMM device is not available.
11489	</result>
11490
11491	</desc>
11492	<param name="screenId" type="unsigned long" dir="in">
11493	<desc>The screen id where the Drag and Drop event occured.</desc>
11494	</param>
11495	<param name="formats" type="wstring" dir="out" safearray="yes">
11496	<desc>On return the supported mime types.</desc>
11497	</param>
11498	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
11499	<desc>On return the actions which are allowed.</desc>
11500	</param>
11501	<param name="defaultAction" type="DragAndDropAction" dir="return">
11502	<desc>On return the default action to use.</desc>
11503	</param>
11504	</method>
11505
11506	<method name="dragGHDropped">
11507	<desc>
11508	Informs the guest that a drop event occured for a pending Drag and Drop event.
11509
11510	This is used in Guest - Host direction.
11511
11512	<result name="VBOX_E_VM_ERROR">
11513	VMM device is not available.
11514	</result>
11515
11516	</desc>
11517
11518	<param name="format" type="wstring" dir="in">
11519	<desc>The mime type the data must be in.</desc>
11520	</param>
11521	<param name="action" type="DragAndDropAction" dir="in">
11522	<desc>The action to use.</desc>
11523	</param>
11524	<param name="progress" type="IProgress" dir="return">
11525	<desc>Progress object to track the operation completion.</desc>
11526	</param>
11527	</method>
11528
11529	<method name="dragGHGetData">
11530	<desc>
11531	Fetch the data of a previously Drag and Drop event from the guest.
11532
11533	This is used in Guest - Host direction.
11534
11535	<result name="VBOX_E_VM_ERROR">
11536	VMM device is not available.
11537	</result>
11538
11539	</desc>
11540
11541	<param name="data" type="octet" safearray="yes" dir="return">
11542	<desc>The actual data.</desc>
11543	</param>
11544	</method>
11545
11546	<method name="createSession">
11547	<desc>
11548	Creates a new guest session for controlling the guest.
11549
11550	A guest session represents one impersonated user account on the guest, so
11551	every operation will use the same credentials specified when creating
11552	the session object via <link to="IGuest::createSession"/>. Anonymous
11553	sessions, that is, sessions without specifying a valid
11554	user account on the guest are not allowed due to security reasons.
11555
11556	There can be a maximum of 32 sessions at once per VM. Each session keeps
11557	track of its started guest processes, opened guest files or guest directories.
11558	To work on guest files or directories a guest session offers methods to open
11559	or create such objects (see <link to="IGuestSession::fileOpen"/> or
11560	<link to="IGuestSession::directoryOpen"/> for example).
11561
11562	When done with either of these objects, including the guest session itself,
11563	use the appropriate close() method to let the object do its cleanup work.
11564
11565	Every guest session has its own environment variable block which gets
11566	automatically applied when starting a new guest process via
11567	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
11568	To override (or unset) certain environment variables already set by the
11569	guest session, one can specify a per-process environment block when using
11570	one of the both above mentioned process creation calls.
11571
11572	Closing a session via <link to="IGuestSession::close" /> will try to close
11573	all the mentioned objects above unless these objects are still used by
11574	a client.
11575	</desc>
11576	<param name="user" type="wstring" dir="in">
11577	<desc>
11578	User name this session will be using to control the guest; has to exist
11579	and have the appropriate rights to execute programs in the VM. Must not
11580	be empty.
11581	</desc>
11582	</param>
11583	<param name="password" type="wstring" dir="in">
11584	<desc>
11585	Password of the user account to be used. Empty passwords are allowed.
11586	</desc>
11587	</param>
11588	<param name="domain" type="wstring" dir="in">
11589	<desc>
11590	Domain name of the user account to be used if the guest is part of
11591	a domain. Optional. This feature is not implemented yet.
11592	</desc>
11593	</param>
11594	<param name="sessionName" type="wstring" dir="in">
11595	<desc>
11596	The session's friendly name. Optional, can be empty.
11597	</desc>
11598	</param>
11599	<param name="guestSession" type="IGuestSession" dir="return">
11600	<desc>
11601	The newly created session object.
11602	</desc>
11603	</param>
11604	</method>
11605
11606	<method name="findSession">
11607	<desc>
11608	Finds guest sessions by their friendly name and returns an interface
11609	array with all found guest sessions.
11610	</desc>
11611	<param name="sessionName" type="wstring" dir="in">
11612	<desc>
11613	The session's friendly name to find. Wildcards like ? and * are allowed.
11614	</desc>
11615	</param>
11616	<param name="sessions" type="IGuestSession" safearray="yes" dir="return">
11617	<desc>
11618	Array with all guest sessions found matching the name specified.
11619	</desc>
11620	</param>
11621	</method>
11622
11623	<method name="updateGuestAdditions">
11624	<desc>
11625	Automatically updates already installed Guest Additions in a VM.
11626
11627	At the moment only Windows guests are supported.
11628
11629	Because the VirtualBox Guest Additions drivers are not WHQL-certified
11630	yet there might be warning dialogs during the actual Guest Additions
11631	update. These need to be confirmed manually in order to continue the
11632	installation process. This applies to Windows 2000 and Windows XP guests
11633	and therefore these guests can't be updated in a fully automated fashion
11634	without user interaction. However, to start a Guest Additions update for
11635	the mentioned Windows versions anyway, the flag
11636	AdditionsUpdateFlag_WaitForUpdateStartOnly can be specified. See
11637	<link to="AdditionsUpdateFlag"/> for more information.
11638
11639	<result name="VBOX_E_NOT_SUPPORTED">
11640	Guest OS is not supported for automated Guest Additions updates or the
11641	already installed Guest Additions are not ready yet.
11642	</result>
11643
11644	<result name="VBOX_E_IPRT_ERROR">
11645	Error while updating.
11646	</result>
11647
11648	</desc>
11649	<param name="source" type="wstring" dir="in">
11650	<desc>
11651	Path to the Guest Additions .ISO file to use for the upate.
11652	</desc>
11653	</param>
11654	<param name="flags" type="AdditionsUpdateFlag" dir="in" safearray="yes">
11655	<desc>
11656	<link to="AdditionsUpdateFlag"/> flags.
11657	</desc>
11658	</param>
11659	<param name="progress" type="IProgress" dir="return">
11660	<desc>Progress object to track the operation completion.</desc>
11661	</param>
11662	</method>
11663
11664	</interface>
11665
11666
11667	<!--
11668	// IProgress
11669	/////////////////////////////////////////////////////////////////////////
11670	-->
11671
11672	<interface
11673	name="IProgress" extends="$unknown"
11674	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
11675	wsmap="managed"
11676	>
11677	<desc>
11678	The IProgress interface is used to track and control
11679	asynchronous tasks within VirtualBox.
11680
11681	An instance of this is returned every time VirtualBox starts
11682	an asynchronous task (in other words, a separate thread) which
11683	continues to run after a method call returns. For example,
11684	<link to="IConsole::saveState" />, which saves the state of
11685	a running virtual machine, can take a long time to complete.
11686	To be able to display a progress bar, a user interface such as
11687	the VirtualBox graphical user interface can use the IProgress
11688	object returned by that method.
11689
11690	Note that IProgress is a "read-only" interface in the sense
11691	that only the VirtualBox internals behind the Main API can
11692	create and manipulate progress objects, whereas client code
11693	can only use the IProgress object to monitor a task's
11694	progress and, if <link to="#cancelable" /> is @c true,
11695	cancel the task by calling <link to="#cancel" />.
11696
11697	A task represented by IProgress consists of either one or
11698	several sub-operations that run sequentially, one by one (see
11699	<link to="#operation" /> and <link to="#operationCount" />).
11700	Every operation is identified by a number (starting from 0)
11701	and has a separate description.
11702
11703	You can find the individual percentage of completion of the current
11704	operation in <link to="#operationPercent" /> and the
11705	percentage of completion of the task as a whole
11706	in <link to="#percent" />.
11707
11708	Similarly, you can wait for the completion of a particular
11709	operation via <link to="#waitForOperationCompletion" /> or
11710	for the completion of the whole task via
11711	<link to="#waitForCompletion" />.
11712	</desc>
11713
11714	<attribute name="id" type="uuid" mod="string" readonly="yes">
11715	<desc>ID of the task.</desc>
11716	</attribute>
11717
11718	<attribute name="description" type="wstring" readonly="yes">
11719	<desc>Description of the task.</desc>
11720	</attribute>
11721
11722	<attribute name="initiator" type="$unknown" readonly="yes">
11723	<desc>Initiator of the task.</desc>
11724	</attribute>
11725
11726	<attribute name="cancelable" type="boolean" readonly="yes">
11727	<desc>Whether the task can be interrupted.</desc>
11728	</attribute>
11729
11730	<attribute name="percent" type="unsigned long" readonly="yes">
11731	<desc>
11732	Current progress value of the task as a whole, in percent.
11733	This value depends on how many operations are already complete.
11734	Returns 100 if <link to="#completed" /> is @c true.
11735	</desc>
11736	</attribute>
11737
11738	<attribute name="timeRemaining" type="long" readonly="yes">
11739	<desc>
11740	Estimated remaining time until the task completes, in
11741	seconds. Returns 0 once the task has completed; returns -1
11742	if the remaining time cannot be computed, in particular if
11743	the current progress is 0.
11744
11745	Even if a value is returned, the estimate will be unreliable
11746	for low progress values. It will become more reliable as the
11747	task progresses; it is not recommended to display an ETA
11748	before at least 20% of a task have completed.
11749	</desc>
11750	</attribute>
11751
11752	<attribute name="completed" type="boolean" readonly="yes">
11753	<desc>Whether the task has been completed.</desc>
11754	</attribute>
11755
11756	<attribute name="canceled" type="boolean" readonly="yes">
11757	<desc>Whether the task has been canceled.</desc>
11758	</attribute>
11759
11760	<attribute name="resultCode" type="long" readonly="yes">
11761	<desc>
11762	Result code of the progress task.
11763	Valid only if <link to="#completed"/> is @c true.
11764	</desc>
11765	</attribute>
11766
11767	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
11768	<desc>
11769	Extended information about the unsuccessful result of the
11770	progress operation. May be @c null if no extended information
11771	is available.
11772	Valid only if <link to="#completed"/> is @c true and
11773	<link to="#resultCode"/> indicates a failure.
11774	</desc>
11775	</attribute>
11776
11777	<attribute name="operationCount" type="unsigned long" readonly="yes">
11778	<desc>
11779	Number of sub-operations this task is divided into.
11780	Every task consists of at least one suboperation.
11781	</desc>
11782	</attribute>
11783
11784	<attribute name="operation" type="unsigned long" readonly="yes">
11785	<desc>Number of the sub-operation being currently executed.</desc>
11786	</attribute>
11787
11788	<attribute name="operationDescription" type="wstring" readonly="yes">
11789	<desc>
11790	Description of the sub-operation being currently executed.
11791	</desc>
11792	</attribute>
11793
11794	<attribute name="operationPercent" type="unsigned long" readonly="yes">
11795	<desc>Progress value of the current sub-operation only, in percent.</desc>
11796	</attribute>
11797
11798	<attribute name="operationWeight" type="unsigned long" readonly="yes">
11799	<desc>Weight value of the current sub-operation only.</desc>
11800	</attribute>
11801
11802	<attribute name="timeout" type="unsigned long">
11803	<desc>
11804	When non-zero, this specifies the number of milliseconds after which
11805	the operation will automatically be canceled. This can only be set on
11806	cancelable objects.
11807	</desc>
11808	</attribute>
11809
11810	<method name="setCurrentOperationProgress">
11811	<desc>Internal method, not to be called externally.</desc>
11812	<param name="percent" type="unsigned long" dir="in" />
11813	</method>
11814	<method name="setNextOperation">
11815	<desc>Internal method, not to be called externally.</desc>
11816	<param name="nextOperationDescription" type="wstring" dir="in" />
11817	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
11818	</method>
11819
11820	<method name="waitForCompletion">
11821	<desc>
11822	Waits until the task is done (including all sub-operations)
11823	with a given timeout in milliseconds; specify -1 for an indefinite wait.
11824
11825	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
11826	thread are not processed while waiting. Neglecting event queues may
11827	have dire consequences (degrade performance, resource hogs,
11828	deadlocks, etc.), this is specially so for the main thread on
11829	platforms using XPCOM. Callers are adviced wait for short periods
11830	and service their event queues between calls, or to create a worker
11831	thread to do the waiting.
11832
11833	<result name="VBOX_E_IPRT_ERROR">
11834	Failed to wait for task completion.
11835	</result>
11836	</desc>
11837
11838	<param name="timeout" type="long" dir="in">
11839	<desc>
11840	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11841	</desc>
11842	</param>
11843	</method>
11844
11845	<method name="waitForOperationCompletion">
11846	<desc>
11847	Waits until the given operation is done with a given timeout in
11848	milliseconds; specify -1 for an indefinite wait.
11849
11850	See <link to="#waitForCompletion"> for event queue considerations.</link>
11851
11852	<result name="VBOX_E_IPRT_ERROR">
11853	Failed to wait for operation completion.
11854	</result>
11855
11856	</desc>
11857	<param name="operation" type="unsigned long" dir="in">
11858	<desc>
11859	Number of the operation to wait for.
11860	Must be less than <link to="#operationCount"/>.
11861	</desc>
11862	</param>
11863	<param name="timeout" type="long" dir="in">
11864	<desc>
11865	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11866	</desc>
11867	</param>
11868	</method>
11869
11870	<method name="waitForAsyncProgressCompletion">
11871	<desc>
11872	Waits until the other task is completed (including all
11873	sub-operations) and forward all changes from the other progress to
11874	this progress. This means sub-operation number, description, percent
11875	and so on.
11876
11877	You have to take care on setting up at least the same count on
11878	sub-operations in this progress object like there are in the other
11879	progress object.
11880
11881	If the other progress object supports cancel and this object gets any
11882	cancel request (when here enabled as well), it will be forwarded to
11883	the other progress object.
11884
11885	If there is an error in the other progress, this error isn't
11886	automatically transfered to this progress object. So you have to
11887	check any operation error within the other progress object, after
11888	this method returns.
11889	</desc>
11890
11891	<param name="pProgressAsync" type="IProgress" dir="in">
11892	<desc>
11893	The progress object of the asynchrony process.
11894	</desc>
11895	</param>
11896	</method>
11897
11898	<method name="cancel">
11899	<desc>
11900	Cancels the task.
11901	<note>
11902	If <link to="#cancelable"/> is @c false, then this method will fail.
11903	</note>
11904
11905	<result name="VBOX_E_INVALID_OBJECT_STATE">
11906	Operation cannot be canceled.
11907	</result>
11908
11909	</desc>
11910	</method>
11911
11912	</interface>
11913
11914	<!--
11915	// ISnapshot
11916	/////////////////////////////////////////////////////////////////////////
11917	-->
11918
11919	<interface
11920	name="ISnapshot" extends="$unknown"
11921	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
11922	wsmap="managed"
11923	>
11924	<desc>
11925	The ISnapshot interface represents a snapshot of the virtual
11926	machine.
11927
11928	Together with the differencing media that are created
11929	when a snapshot is taken, a machine can be brought back to
11930	the exact state it was in when the snapshot was taken.
11931
11932	The ISnapshot interface has no methods, only attributes; snapshots
11933	are controlled through methods of the <link to="IConsole" /> interface
11934	which also manage the media associated with the snapshot.
11935	The following operations exist:
11936
11937	<ul>
11938	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
11939	by creating new, empty differencing images for the machine's
11940	media and saving the VM settings and (if the VM is running)
11941	the current VM state in the snapshot.
11942
11943	The differencing images will then receive all data written to
11944	the machine's media, while their parent (base) images
11945	remain unmodified after the snapshot has been taken (see
11946	<link to="IMedium" /> for details about differencing images).
11947	This simplifies restoring a machine to the state of a snapshot:
11948	only the differencing images need to be deleted.
11949
11950	The current machine state is not changed by taking a snapshot
11951	except that <link to="IMachine::currentSnapshot" /> is set to
11952	the newly created snapshot, which is also added to the machine's
11953	snapshots tree.
11954	</li>
11955
11956	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
11957	the state of a previous snapshot by deleting the differencing
11958	image of each of the machine's media and setting the machine's
11959	settings and state to the state that was saved in the snapshot (if any).
11960
11961	This destroys the machine's current state. After calling this,
11962	<link to="IMachine::currentSnapshot" /> points to the snapshot
11963	that was restored.
11964	</li>
11965
11966	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
11967	without affecting the current machine state.
11968
11969	This does not change the current machine state, but instead frees the
11970	resources allocated when the snapshot was taken: the settings and machine
11971	state file are deleted (if any), and the snapshot's differencing image for
11972	each of the machine's media gets merged with its parent image.
11973
11974	Neither the current machine state nor other snapshots are affected
11975	by this operation, except that parent media will be modified
11976	to contain the disk data associated with the snapshot being deleted.
11977
11978	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
11979	attribute is set to the current snapshot's parent or @c null if it
11980	has no parent. Otherwise the attribute is unchanged.
11981	</li>
11982	</ul>
11983
11984	Each snapshot contains a copy of virtual machine's settings (hardware
11985	configuration etc.). This copy is contained in an immutable (read-only)
11986	instance of <link to="IMachine" /> which is available from the snapshot's
11987	<link to="#machine" /> attribute. When restoring the snapshot, these
11988	settings are copied back to the original machine.
11989
11990	In addition, if the machine was running when the
11991	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
11992	the current VM state is saved in the snapshot (similarly to what happens
11993	when a VM's state is saved). The snapshot is then said to be <i>online</i>
11994	because when restoring it, the VM will be running.
11995
11996	If the machine was in <link to="MachineState_Saved">saved</link> saved,
11997	the snapshot receives a copy of the execution state file
11998	(<link to="IMachine::stateFilePath"/>).
11999
12000	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
12001	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
12002	it then contains a so-called "zero execution state", representing a
12003	machine that is powered off.
12004	</desc>
12005
12006	<attribute name="id" type="uuid" mod="string" readonly="yes">
12007	<desc>UUID of the snapshot.</desc>
12008	</attribute>
12009
12010	<attribute name="name" type="wstring">
12011	<desc>Short name of the snapshot.
12012	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
12013	be called implicitly.</note>
12014	</desc>
12015	</attribute>
12016
12017	<attribute name="description" type="wstring">
12018	<desc>Optional description of the snapshot.
12019	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
12020	be called implicitly.</note>
12021	</desc>
12022	</attribute>
12023
12024	<attribute name="timeStamp" type="long long" readonly="yes">
12025	<desc>
12026	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
12027	</desc>
12028	</attribute>
12029
12030	<attribute name="online" type="boolean" readonly="yes">
12031	<desc>
12032	@c true if this snapshot is an online snapshot and @c false otherwise.
12033
12034	When this attribute is @c true, the
12035	<link to="IMachine::stateFilePath"/> attribute of the
12036	<link to="#machine"/> object associated with this snapshot
12037	will point to the saved state file. Otherwise, it will be
12038	an empty string.
12039	</desc>
12040	</attribute>
12041
12042	<attribute name="machine" type="IMachine" readonly="yes">
12043	<desc>
12044	Virtual machine this snapshot is taken on. This object
12045	stores all settings the machine had when taking this snapshot.
12046	<note>
12047	The returned machine object is immutable, i.e. no
12048	any settings can be changed.
12049	</note>
12050	</desc>
12051	</attribute>
12052
12053	<attribute name="parent" type="ISnapshot" readonly="yes">
12054	<desc>
12055	Parent snapshot (a snapshot this one is based on), or
12056	@c null if the snapshot has no parent (i.e. is the first snapshot).
12057	</desc>
12058	</attribute>
12059
12060	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
12061	<desc>
12062	Child snapshots (all snapshots having this one as a parent).
12063	By inspecting this attribute starting with a machine's root snapshot
12064	(which can be obtained by calling <link to="IMachine::findSnapshot" />
12065	with a @c null UUID), a machine's snapshots tree can be iterated over.
12066	</desc>
12067	</attribute>
12068
12069	<method name="getChildrenCount" const="yes">
12070	<desc>
12071	Returns the number of direct childrens of this snapshot.
12072	</desc>
12073	<param name="childrenCount" type="unsigned long" dir="return">
12074	<desc>
12075	</desc>
12076	</param>
12077	</method>
12078
12079	</interface>
12080
12081
12082	<!--
12083	// IMedium
12084	/////////////////////////////////////////////////////////////////////////
12085	-->
12086
12087	<enum
12088	name="MediumState"
12089	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
12090	>
12091	<desc>
12092	Virtual medium state.
12093	<see><link to="IMedium"/></see>
12094	</desc>
12095
12096	<const name="NotCreated" value="0">
12097	<desc>
12098	Associated medium storage does not exist (either was not created yet or
12099	was deleted).
12100	</desc>
12101	</const>
12102	<const name="Created" value="1">
12103	<desc>
12104	Associated storage exists and accessible; this gets set if the
12105	accessibility check performed by <link to="IMedium::refreshState" />
12106	was successful.
12107	</desc>
12108	</const>
12109	<const name="LockedRead" value="2">
12110	<desc>
12111	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
12112	no data modification is possible.
12113	</desc>
12114	</const>
12115	<const name="LockedWrite" value="3">
12116	<desc>
12117	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
12118	no concurrent data reading or modification is possible.
12119	</desc>
12120	</const>
12121	<const name="Inaccessible" value="4">
12122	<desc>
12123	Medium accessibility check (see <link to="IMedium::refreshState" />) has
12124	not yet been performed, or else, associated medium storage is not
12125	accessible. In the first case, <link to="IMedium::lastAccessError"/>
12126	is empty, in the second case, it describes the error that occurred.
12127	</desc>
12128	</const>
12129	<const name="Creating" value="5">
12130	<desc>
12131	Associated medium storage is being created.
12132	</desc>
12133	</const>
12134	<const name="Deleting" value="6">
12135	<desc>
12136	Associated medium storage is being deleted.
12137	</desc>
12138	</const>
12139	</enum>
12140
12141	<enum
12142	name="MediumType"
12143	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
12144	>
12145	<desc>
12146	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
12147	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
12148	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
12149	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
12150	</desc>
12151
12152	<const name="Normal" value="0">
12153	<desc>
12154	Normal medium (attached directly or indirectly, preserved
12155	when taking snapshots).
12156	</desc>
12157	</const>
12158	<const name="Immutable" value="1">
12159	<desc>
12160	Immutable medium (attached indirectly, changes are wiped out
12161	the next time the virtual machine is started).
12162	</desc>
12163	</const>
12164	<const name="Writethrough" value="2">
12165	<desc>
12166	Write through medium (attached directly, ignored when
12167	taking snapshots).
12168	</desc>
12169	</const>
12170	<const name="Shareable" value="3">
12171	<desc>
12172	Allow using this medium concurrently by several machines.
12173	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
12174	</desc>
12175	</const>
12176	<const name="Readonly" value="4">
12177	<desc>
12178	A readonly medium, which can of course be used by several machines.
12179	<note>Present and accepted since VirtualBox 4.0.</note>
12180	</desc>
12181	</const>
12182	<const name="MultiAttach" value="5">
12183	<desc>
12184	A medium which is indirectly attached, so that one base medium can
12185	be used for several VMs which have their own differencing medium to
12186	store their modifications. In some sense a variant of Immutable
12187	with unset AutoReset flag in each differencing medium.
12188	<note>Present and accepted since VirtualBox 4.0.</note>
12189	</desc>
12190	</const>
12191	</enum>
12192
12193	<enum
12194	name="MediumVariant"
12195	uuid="80685b6b-e42f-497d-8271-e77bf3c61ada"
12196	>
12197	<desc>
12198	Virtual medium image variant. More than one flag may be set.
12199	<see><link to="IMedium"/></see>
12200	</desc>
12201
12202	<const name="Standard" value="0">
12203	<desc>
12204	No particular variant requested, results in using the backend default.
12205	</desc>
12206	</const>
12207	<const name="VmdkSplit2G" value="0x01">
12208	<desc>
12209	VMDK image split in chunks of less than 2GByte.
12210	</desc>
12211	</const>
12212	<const name="VmdkRawDisk" value="0x02">
12213	<desc>
12214	VMDK image representing a raw disk.
12215	</desc>
12216	</const>
12217	<const name="VmdkStreamOptimized" value="0x04">
12218	<desc>
12219	VMDK streamOptimized image. Special import/export format which is
12220	read-only/append-only.
12221	</desc>
12222	</const>
12223	<const name="VmdkESX" value="0x08">
12224	<desc>
12225	VMDK format variant used on ESX products.
12226	</desc>
12227	</const>
12228	<const name="Fixed" value="0x10000">
12229	<desc>
12230	Fixed image. Only allowed for base images.
12231	</desc>
12232	</const>
12233	<const name="Diff" value="0x20000">
12234	<desc>
12235	Differencing image. Only allowed for child images.
12236	</desc>
12237	</const>
12238	<const name="NoCreateDir" value="0x40000000">
12239	<desc>
12240	Special flag which suppresses automatic creation of the subdirectory.
12241	Only used when passing the medium variant as an input parameter.
12242	</desc>
12243	</const>
12244	</enum>
12245
12246	<interface
12247	name="IMediumAttachment" extends="$unknown"
12248	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
12249	wsmap="struct"
12250	>
12251	<desc>
12252	The IMediumAttachment interface links storage media to virtual machines.
12253	For each medium (<link to="IMedium"/>) which has been attached to a
12254	storage controller (<link to="IStorageController"/>) of a machine
12255	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
12256	method, one instance of IMediumAttachment is added to the machine's
12257	<link to="IMachine::mediumAttachments"/> array attribute.
12258
12259	Each medium attachment specifies the storage controller as well as a
12260	port and device number and the IMedium instance representing a virtual
12261	hard disk or floppy or DVD image.
12262
12263	For removable media (DVDs or floppies), there are two additional
12264	options. For one, the IMedium instance can be @c null to represent
12265	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
12266	secondly, the medium can be one of the pseudo-media for host drives
12267	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
12268
12269	<h3>Attaching Hard Disks</h3>
12270
12271	Hard disks are attached to virtual machines using the
12272	<link to="IMachine::attachDevice"/> method and detached using the
12273	<link to="IMachine::detachDevice"/> method. Depending on a medium's
12274	type (see <link to="IMedium::type" />), hard disks are attached either
12275	<i>directly</i> or <i>indirectly</i>.
12276
12277	When a hard disk is being attached directly, it is associated with the
12278	virtual machine and used for hard disk operations when the machine is
12279	running. When a hard disk is being attached indirectly, a new differencing
12280	hard disk linked to it is implicitly created and this differencing hard
12281	disk is associated with the machine and used for hard disk operations.
12282	This also means that if <link to="IMachine::attachDevice"/> performs
12283	a direct attachment then the same hard disk will be returned in response
12284	to the subsequent <link to="IMachine::getMedium"/> call; however if
12285	an indirect attachment is performed then
12286	<link to="IMachine::getMedium"/> will return the implicitly created
12287	differencing hard disk, not the original one passed to <link
12288	to="IMachine::attachDevice"/>. In detail:
12289
12290	<ul>
12291	<li><b>Normal base</b> hard disks that do not have children (i.e.
12292	differencing hard disks linked to them) and that are not already
12293	attached to virtual machines in snapshots are attached <b>directly</b>.
12294	Otherwise, they are attached <b>indirectly</b> because having
12295	dependent children or being part of the snapshot makes it impossible
12296	to modify hard disk contents without breaking the integrity of the
12297	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
12298	quickly determine the kind of the attachment for the given hard
12299	disk. Note that if a normal base hard disk is to be indirectly
12300	attached to a virtual machine with snapshots then a special
12301	procedure called <i>smart attachment</i> is performed (see below).</li>
12302	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
12303	they are attached <b>directly</b> if they do not have children and are
12304	not attached to virtual machines in snapshots, and <b>indirectly</b>
12305	otherwise. Note that the smart attachment procedure is never performed
12306	for differencing hard disks.</li>
12307	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
12308	they are designed to be non-writable. If an immutable hard disk is
12309	attached to a virtual machine with snapshots then a special
12310	procedure called smart attachment is performed (see below).</li>
12311	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
12312	also as designed. This also means that writethrough hard disks cannot
12313	have other hard disks linked to them at all.</li>
12314	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
12315	also as designed. This also means that shareable hard disks cannot
12316	have other hard disks linked to them at all. They behave almost
12317	like writethrough hard disks, except that shareable hard disks can
12318	be attached to several virtual machines which are running, allowing
12319	concurrent accesses. You need special cluster software running in
12320	the virtual machines to make use of such disks.</li>
12321	</ul>
12322
12323	Note that the same hard disk, regardless of its type, may be attached to
12324	more than one virtual machine at a time. In this case, the machine that is
12325	started first gains exclusive access to the hard disk and attempts to
12326	start other machines having this hard disk attached will fail until the
12327	first machine is powered down.
12328
12329	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
12330	that the given hard disk remains associated with the given machine after a
12331	successful <link to="IMachine::detachDevice"/> call until
12332	<link to="IMachine::saveSettings"/> is called to save all changes to
12333	machine settings to disk. This deferring is necessary to guarantee that
12334	the hard disk configuration may be restored at any time by a call to
12335	<link to="IMachine::discardSettings"/> before the settings
12336	are saved (committed).
12337
12338	Note that if <link to="IMachine::discardSettings"/> is called after
12339	indirectly attaching some hard disks to the machine but before a call to
12340	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
12341	all differencing hard disks implicitly created by
12342	<link to="IMachine::attachDevice"/> for these indirect attachments.
12343	Such implicitly created hard disks will also be immediately deleted when
12344	detached explicitly using the <link to="IMachine::detachDevice"/>
12345	call if it is made before <link to="IMachine::saveSettings"/>. This
12346	implicit deletion is safe because newly created differencing hard
12347	disks do not contain any user data.
12348
12349	However, keep in mind that detaching differencing hard disks that were
12350	implicitly created by <link to="IMachine::attachDevice"/>
12351	before the last <link to="IMachine::saveSettings"/> call will
12352	<b>not</b> implicitly delete them as they may already contain some data
12353	(for example, as a result of virtual machine execution). If these hard
12354	disks are no more necessary, the caller can always delete them explicitly
12355	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
12356	from this machine by the <link to="IMachine::saveSettings"/> call.
12357
12358	<h3>Smart Attachment</h3>
12359
12360	When normal base or immutable hard disks are indirectly attached to a
12361	virtual machine then some additional steps are performed to make sure the
12362	virtual machine will have the most recent "view" of the hard disk being
12363	attached. These steps include walking through the machine's snapshots
12364	starting from the current one and going through ancestors up to the first
12365	snapshot. Hard disks attached to the virtual machine in all
12366	of the encountered snapshots are checked whether they are descendants of
12367	the given normal base or immutable hard disk. The first found child (which
12368	is the differencing hard disk) will be used instead of the normal base or
12369	immutable hard disk as a parent for creating a new differencing hard disk
12370	that will be actually attached to the machine. And only if no descendants
12371	are found or if the virtual machine does not have any snapshots then the
12372	normal base or immutable hard disk will be used itself as a parent for
12373	this differencing hard disk.
12374
12375	It is easier to explain what smart attachment does using the
12376	following example:
12377	<pre>
12378	BEFORE attaching B.vdi: AFTER attaching B.vdi:
12379
12380	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
12381	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
12382	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
12383	Snapshot 4 (none) Snapshot 4 (none)
12384	CurState (none) CurState (D3->D2.vdi)
12385
12386	NOT
12387	...
12388	CurState (D3->B.vdi)
12389	</pre>
12390	The first column is the virtual machine configuration before the base hard
12391	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
12392	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
12393	mean that the hard disk that is actually attached to the machine is a
12394	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
12395	another hard disk, <tt>B.vdi</tt>.
12396
12397	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
12398	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
12399	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
12400	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
12401	it cannot be attached directly and needs an indirect attachment (i.e.
12402	implicit creation of a new differencing hard disk). Due to the smart
12403	attachment procedure, the new differencing hard disk
12404	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
12405	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
12406	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
12407	machine.
12408
12409	Note that if there is more than one descendant hard disk of the given base
12410	hard disk found in a snapshot, and there is an exact device, channel and
12411	bus match, then this exact match will be used. Otherwise, the youngest
12412	descendant will be picked up.
12413
12414	There is one more important aspect of the smart attachment procedure which
12415	is not related to snapshots at all. Before walking through the snapshots
12416	as described above, the backup copy of the current list of hard disk
12417	attachment is searched for descendants. This backup copy is created when
12418	the hard disk configuration is changed for the first time after the last
12419	<link to="IMachine::saveSettings"/> call and used by
12420	<link to="IMachine::discardSettings"/> to undo the recent hard disk
12421	changes. When such a descendant is found in this backup copy, it will be
12422	simply re-attached back, without creating a new differencing hard disk for
12423	it. This optimization is necessary to make it possible to re-attach the
12424	base or immutable hard disk to a different bus, channel or device slot
12425	without losing the contents of the differencing hard disk actually
12426	attached to the machine in place of it.
12427
12428	</desc>
12429
12430	<attribute name="medium" type="IMedium" readonly="yes">
12431	<desc>Medium object associated with this attachment; it
12432	can be @c null for removable devices.</desc>
12433	</attribute>
12434
12435	<attribute name="controller" type="wstring" readonly="yes">
12436	<desc>Name of the storage controller of this attachment; this
12437	refers to one of the controllers in <link to="IMachine::storageControllers" />
12438	by name.</desc>
12439	</attribute>
12440
12441	<attribute name="port" type="long" readonly="yes">
12442	<desc>Port 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="device" type="long" readonly="yes">
12448	<desc>Device slot number of this attachment.
12449	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12450	</desc>
12451	</attribute>
12452
12453	<attribute name="type" type="DeviceType" readonly="yes">
12454	<desc>Device type of this attachment.</desc>
12455	</attribute>
12456
12457	<attribute name="passthrough" type="boolean" readonly="yes">
12458	<desc>Pass I/O requests through to a device on the host.</desc>
12459	</attribute>
12460
12461	<attribute name="temporaryEject" type="boolean" readonly="yes">
12462	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
12463	</attribute>
12464
12465	<attribute name="isEjected" type="boolean" readonly="yes">
12466	<desc>Signals that the removable medium has been ejected. This is not
12467	necessarily equivalent to having a @c null medium association.</desc>
12468	</attribute>
12469
12470	<attribute name="nonRotational" type="boolean" readonly="yes">
12471	<desc>Whether the associated medium is non-rotational.</desc>
12472	</attribute>
12473
12474	<attribute name="discard" type="boolean" readonly="yes">
12475	<desc>Whether the associated medium supports discarding unused blocks.</desc>
12476	</attribute>
12477
12478	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
12479	<desc>The bandwidth group this medium attachment is assigned to.</desc>
12480	</attribute>
12481
12482	</interface>
12483
12484	<interface
12485	name="IMedium" extends="$unknown"
12486	uuid="86fd6208-4c8c-40c2-a4e3-f6b47ac6ef07"
12487	wsmap="managed"
12488	>
12489	<desc>
12490	The IMedium interface represents virtual storage for a machine's
12491	hard disks, CD/DVD or floppy drives. It will typically represent
12492	a disk image on the host, for example a VDI or VMDK file representing
12493	a virtual hard disk, or an ISO or RAW file representing virtual
12494	removable media, but can also point to a network location (e.g.
12495	for iSCSI targets).
12496
12497	Instances of IMedium are connected to virtual machines by way of medium
12498	attachments, which link the storage medium to a particular device slot
12499	of a storage controller of the virtual machine.
12500	In the VirtualBox API, virtual storage is therefore always represented
12501	by the following chain of object links:
12502
12503	<ul>
12504	<li><link to="IMachine::storageControllers"/> contains an array of
12505	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
12506	these are instances of <link to="IStorageController"/>).</li>
12507	<li><link to="IMachine::mediumAttachments"/> contains an array of
12508	medium attachments (instances of <link to="IMediumAttachment"/>
12509	created by <link to="IMachine::attachDevice" />),
12510	each containing a storage controller from the above array, a
12511	port/device specification, and an instance of IMedium representing
12512	the medium storage (image file).
12513
12514	For removable media, the storage medium is optional; a medium
12515	attachment with no medium represents a CD/DVD or floppy drive
12516	with no medium inserted. By contrast, hard disk attachments
12517	will always have an IMedium object attached.</li>
12518	<li>Each IMedium in turn points to a storage unit (such as a file
12519	on the host computer or a network resource) that holds actual
12520	data. This location is represented by the <link to="#location"/>
12521	attribute.</li>
12522	</ul>
12523
12524	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
12525	new hard disk media can be created with the VirtualBox API using the
12526	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
12527	disks (see below) are usually implicitly created by VirtualBox as
12528	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
12529	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
12530	should be created with external tools and then opened from within VirtualBox.
12531
12532	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
12533	drive. In that case the <link to="#id" /> attribute contains the UUID of
12534	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
12535
12536	<h3>Media registries</h3>
12537
12538	When a medium has been opened or created using one of the aforementioned
12539	APIs, it becomes "known" to VirtualBox. Known media can be attached
12540	to virtual machines and re-found through <link to="IVirtualBox::openMedium"/>.
12541	They also appear in the global
12542	<link to="IVirtualBox::hardDisks" />,
12543	<link to="IVirtualBox::DVDImages" /> and
12544	<link to="IVirtualBox::floppyImages" /> arrays.
12545
12546	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
12547	in the VirtualBox.xml file, which was shared between all machines and made
12548	transporting machines and their media from one host to another difficult.
12549
12550	Starting with VirtualBox 4.0, media are only added to a registry when they are
12551	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
12552	backwards compatibility, which registry a medium is added to depends on which
12553	VirtualBox version created a machine:
12554
12555	<ul>
12556	<li>If the medium has first been attached to a machine which was created by
12557	VirtualBox 4.0 or later, it is added to that machine's media registry in
12558	the machine XML settings file. This way all information about a machine's
12559	media attachments is contained in a single file and can be transported
12560	easily.</li>
12561	<li>For older media attachments (i.e. if the medium was first attached to a
12562	machine which was created with a VirtualBox version before 4.0), media
12563	continue to be registered in the global VirtualBox settings file, for
12564	backwards compatibility.</li>
12565	</ul>
12566
12567	See <link to="IVirtualBox::openMedium" /> for more information.
12568
12569	Media are removed from media registries by the <link to="IMedium::close"/>,
12570	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
12571
12572	<h3>Accessibility checks</h3>
12573
12574	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
12575	method is called explicitly on a medium. This is done to make the VirtualBox object
12576	ready for serving requests as fast as possible and let the end-user
12577	application decide if it needs to check media accessibility right away or not.
12578
12579	As a result, when VirtualBox starts up (e.g. the VirtualBox
12580	object gets created for the first time), all known media are in the
12581	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
12582	attribute is an empty string because no actual accessibility check has
12583	been made yet.
12584
12585	After calling <link to="#refreshState" />, a medium is considered
12586	<i>accessible</i> if its storage unit can be read. In that case, the
12587	<link to="#state"/> attribute has a value of "Created". If the storage
12588	unit cannot be read (for example, because it is located on a disconnected
12589	network resource, or was accidentally deleted outside VirtualBox),
12590	the medium is considered <i>inaccessible</i>, which is indicated by the
12591	"Inaccessible" state. The exact reason why the medium is inaccessible can be
12592	obtained by reading the <link to="#lastAccessError"/> attribute.
12593
12594	<h3>Medium types</h3>
12595
12596	There are five types of medium behavior which are stored in the
12597	<link to="#type"/> attribute (see <link to="MediumType" />) and
12598	which define the medium's behavior with attachments and snapshots.
12599
12600	All media can be also divided in two groups: <i>base</i> media and
12601	<i>differencing</i> media. A base medium contains all sectors of the
12602	medium data in its own storage and therefore can be used independently.
12603	In contrast, a differencing medium is a "delta" to some other medium and
12604	contains only those sectors which differ from that other medium, which is
12605	then called a <i>parent</i>. The differencing medium is said to be
12606	<i>linked to</i> that parent. The parent may be itself a differencing
12607	medium, thus forming a chain of linked media. The last element in that
12608	chain must always be a base medium. Note that several differencing
12609	media may be linked to the same parent medium.
12610
12611	Differencing media can be distinguished from base media by querying the
12612	<link to="#parent"/> attribute: base media do not have parents they would
12613	depend on, so the value of this attribute is always @c null for them.
12614	Using this attribute, it is possible to walk up the medium tree (from the
12615	child medium to its parent). It is also possible to walk down the tree
12616	using the <link to="#children"/> attribute.
12617
12618	Note that the type of all differencing media is "normal"; all other
12619	values are meaningless for them. Base media may be of any type.
12620
12621	<h3>Automatic composition of the file name part</h3>
12622
12623	Another extension to the <link to="IMedium::location"/> attribute is that
12624	there is a possibility to cause VirtualBox to compose a unique value for
12625	the file name part of the location using the UUID of the hard disk. This
12626	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
12627	e.g. before the storage unit is created, and works as follows. You set the
12628	value of the <link to="IMedium::location"/> attribute to a location
12629	specification which only contains the path specification but not the file
12630	name part and ends with either a forward slash or a backslash character.
12631	In response, VirtualBox will generate a new UUID for the hard disk and
12632	compose the file name using the following pattern:
12633	<pre>
12634	<path>/{<uuid>}.<ext>
12635	</pre>
12636	where <tt><path></tt> is the supplied path specification,
12637	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
12638	is the default extension for the storage format of this hard disk. After
12639	that, you may call any of the methods that create a new hard disk storage
12640	unit and they will use the generated UUID and file name.
12641	</desc>
12642
12643	<attribute name="id" type="uuid" mod="string" readonly="yes">
12644	<desc>
12645	UUID of the medium. For a newly created medium, this value is a randomly
12646	generated UUID.
12647
12648	<note>
12649	For media in one of MediumState_NotCreated, MediumState_Creating or
12650	MediumState_Deleting states, the value of this property is undefined
12651	and will most likely be an empty UUID.
12652	</note>
12653	</desc>
12654	</attribute>
12655
12656	<attribute name="description" type="wstring">
12657	<desc>
12658	Optional description of the medium. For a newly created medium the value
12659	of this attribute is an empty string.
12660
12661	Medium types that don't support this attribute will return E_NOTIMPL in
12662	attempt to get or set this attribute's value.
12663
12664	<note>
12665	For some storage types, reading this attribute may return an outdated
12666	(last known) value when <link to="#state"/> is <link
12667	to="MediumState_Inaccessible"/> or <link
12668	to="MediumState_LockedWrite"/> because the value of this attribute is
12669	stored within the storage unit itself. Also note that changing the
12670	attribute value is not possible in such case, as well as when the
12671	medium is the <link to="MediumState_LockedRead"/> state.
12672	</note>
12673	</desc>
12674	</attribute>
12675
12676	<attribute name="state" type="MediumState" readonly="yes">
12677	<desc>
12678	Returns the current medium state, which is the last state set by
12679	the accessibility check performed by <link to="#refreshState"/>.
12680	If that method has not yet been called on the medium, the state
12681	is "Inaccessible"; as opposed to truly inaccessible media, the
12682	value of <link to="#lastAccessError"/> will be an empty string in
12683	that case.
12684
12685	<note>As of version 3.1, this no longer performs an accessibility check
12686	automatically; call <link to="#refreshState"/> for that.
12687	</note>
12688	</desc>
12689	</attribute>
12690
12691	<attribute name="variant" type="MediumVariant" safearray="yes" readonly="yes">
12692	<desc>
12693	Returns the storage format variant information for this medium
12694	as an aaray of the flags described at <link to="MediumVariant" />.
12695	Before <link to="#refreshState"/> is called this method returns
12696	an undefined value.
12697	</desc>
12698	</attribute>
12699
12700	<attribute name="location" type="wstring">
12701	<desc>
12702	Location of the storage unit holding medium data.
12703
12704	The format of the location string is medium type specific. For medium
12705	types using regular files in a host's file system, the location
12706	string is the full file name.
12707
12708	Some medium types may support changing the storage unit location by
12709	simply changing the value of this property. If this operation is not
12710	supported, the implementation will return E_NOTIMPL in attempt to set
12711	this attribute's value.
12712
12713	When setting a value of the location attribute which is a regular file
12714	in the host's file system, the given file name may be either relative to
12715	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
12716	absolute. Note that if the given location specification does not contain
12717	the file extension part then a proper default extension will be
12718	automatically appended by the implementation depending on the medium type.
12719	</desc>
12720	</attribute>
12721
12722	<attribute name="name" type="wstring" readonly="yes">
12723	<desc>
12724	Name of the storage unit holding medium data.
12725
12726	The returned string is a short version of the <link to="#location"/>
12727	attribute that is suitable for representing the medium in situations
12728	where the full location specification is too long (such as lists
12729	and comboboxes in GUI frontends). This string is also used by frontends
12730	to sort the media list alphabetically when needed.
12731
12732	For example, for locations that are regular files in the host's file
12733	system, the value of this attribute is just the file name (+ extension),
12734	without the path specification.
12735
12736	Note that as opposed to the <link to="#location"/> attribute, the name
12737	attribute will not necessary be unique for a list of media of the
12738	given type and format.
12739	</desc>
12740	</attribute>
12741
12742	<attribute name="deviceType" type="DeviceType" readonly="yes">
12743	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
12744	medium.</desc>
12745	</attribute>
12746
12747	<attribute name="hostDrive" type="boolean" readonly="yes">
12748	<desc>True if this corresponds to a drive on the host.</desc>
12749	</attribute>
12750
12751	<attribute name="size" type="long long" readonly="yes">
12752	<desc>
12753	Physical size of the storage unit used to hold medium data (in bytes).
12754
12755	<note>
12756	For media whose <link to="#state"/> is <link
12757	to="MediumState_Inaccessible"/>, the value of this property is the
12758	last known size. For <link to="MediumState_NotCreated"/> media,
12759	the returned value is zero.
12760	</note>
12761	</desc>
12762	</attribute>
12763
12764	<attribute name="format" type="wstring" readonly="yes">
12765	<desc>
12766	Storage format of this medium.
12767
12768	The value of this attribute is a string that specifies a backend used
12769	to store medium data. The storage format is defined when you create a
12770	new medium or automatically detected when you open an existing medium,
12771	and cannot be changed later.
12772
12773	The list of all storage formats supported by this VirtualBox
12774	installation can be obtained using
12775	<link to="ISystemProperties::mediumFormats"/>.
12776	</desc>
12777	</attribute>
12778
12779	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
12780	<desc>
12781	Storage medium format object corresponding to this medium.
12782
12783	The value of this attribute is a reference to the medium format object
12784	that specifies the backend properties used to store medium data. The
12785	storage format is defined when you create a new medium or automatically
12786	detected when you open an existing medium, and cannot be changed later.
12787
12788	<note>@c null is returned if there is no associated medium format
12789	object. This can e.g. happen for medium objects representing host
12790	drives and other special medium objects.</note>
12791	</desc>
12792	</attribute>
12793
12794	<attribute name="type" type="MediumType">
12795	<desc>
12796	Type (role) of this medium.
12797
12798	The following constraints apply when changing the value of this
12799	attribute:
12800	<ul>
12801	<li>If a medium is attached to a virtual machine (either in the
12802	current state or in one of the snapshots), its type cannot be
12803	changed.
12804	</li>
12805	<li>As long as the medium has children, its type cannot be set
12806	to <link to="MediumType_Writethrough"/>.
12807	</li>
12808	<li>The type of all differencing media is
12809	<link to="MediumType_Normal"/> and cannot be changed.
12810	</li>
12811	</ul>
12812
12813	The type of a newly created or opened medium is set to
12814	<link to="MediumType_Normal"/>, except for DVD and floppy media,
12815	which have a type of <link to="MediumType_Writethrough"/>.
12816	</desc>
12817	</attribute>
12818
12819	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
12820	<desc>
12821	Returns which medium types can selected for this medium.
12822
12823	<result name="E_NOTIMPL">
12824	This attribute is not implemented at the moment.
12825	</result>
12826	</desc>
12827	</attribute>
12828
12829	<attribute name="parent" type="IMedium" readonly="yes">
12830	<desc>
12831	Parent of this medium (the medium this medium is directly based
12832	on).
12833
12834	Only differencing media have parents. For base (non-differencing)
12835	media, @c null is returned.
12836	</desc>
12837	</attribute>
12838
12839	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
12840	<desc>
12841	Children of this medium (all differencing media directly based
12842	on this medium). A @c null array is returned if this medium
12843	does not have any children.
12844	</desc>
12845	</attribute>
12846
12847	<attribute name="base" type="IMedium" readonly="yes">
12848	<desc>
12849	Base medium of this medium.
12850
12851	If this is a differencing medium, its base medium is the medium
12852	the given medium branch starts from. For all other types of media, this
12853	property returns the medium object itself (i.e. the same object this
12854	property is read on).
12855	</desc>
12856	</attribute>
12857
12858	<attribute name="readOnly" type="boolean" readonly="yes">
12859	<desc>
12860	Returns @c true if this medium is read-only and @c false otherwise.
12861
12862	A medium is considered to be read-only when its contents cannot be
12863	modified without breaking the integrity of other parties that depend on
12864	this medium such as its child media or snapshots of virtual machines
12865	where this medium is attached to these machines. If there are no
12866	children and no such snapshots then there is no dependency and the
12867	medium is not read-only.
12868
12869	The value of this attribute can be used to determine the kind of the
12870	attachment that will take place when attaching this medium to a
12871	virtual machine. If the value is @c false then the medium will
12872	be attached directly. If the value is @c true then the medium
12873	will be attached indirectly by creating a new differencing child
12874	medium for that. See the interface description for more information.
12875
12876	Note that all <link to="MediumType_Immutable">Immutable</link> media
12877	are always read-only while all
12878	<link to="MediumType_Writethrough">Writethrough</link> media are
12879	always not.
12880
12881	<note>
12882	The read-only condition represented by this attribute is related to
12883	the medium type and usage, not to the current
12884	<link to="IMedium::state">medium state</link> and not to the read-only
12885	state of the storage unit.
12886	</note>
12887	</desc>
12888	</attribute>
12889
12890	<attribute name="logicalSize" type="long long" readonly="yes">
12891	<desc>
12892	Logical size of this medium (in bytes), as reported to the
12893	guest OS running inside the virtual machine this medium is
12894	attached to. The logical size is defined when the medium is created
12895	and cannot be changed later.
12896
12897	<note>
12898	For media whose state is <link to="#state"/> is <link
12899	to="MediumState_Inaccessible"/>, the value of this property is the
12900	last known logical size. For <link to="MediumState_NotCreated"/>
12901	media, the returned value is zero.
12902	</note>
12903	</desc>
12904	</attribute>
12905
12906	<attribute name="autoReset" type="boolean">
12907	<desc>
12908	Whether this differencing medium will be automatically reset each
12909	time a virtual machine it is attached to is powered up. This
12910	attribute is automatically set to @c true for the last
12911	differencing image of an "immutable" medium (see
12912	<link to="MediumType" />).
12913
12914	See <link to="#reset"/> for more information about resetting
12915	differencing media.
12916
12917	<note>
12918	Reading this property on a base (non-differencing) medium will
12919	always @c false. Changing the value of this property in this
12920	case is not supported.
12921	</note>
12922
12923	<result name="VBOX_E_NOT_SUPPORTED">
12924	This is not a differencing medium (when changing the attribute
12925	value).
12926	</result>
12927	</desc>
12928	</attribute>
12929
12930	<attribute name="lastAccessError" type="wstring" readonly="yes">
12931	<desc>
12932	Text message that represents the result of the last accessibility
12933	check performed by <link to="#refreshState"/>.
12934
12935	An empty string is returned if the last accessibility check
12936	was successful or has not yet been called. As a result, if
12937	<link to="#state" /> is "Inaccessible" and this attribute is empty,
12938	then <link to="#refreshState"/> has yet to be called; this is the
12939	default value of media after VirtualBox initialization.
12940	A non-empty string indicates a failure and should normally describe
12941	a reason of the failure (for example, a file read error).
12942	</desc>
12943	</attribute>
12944
12945	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
12946	<desc>
12947	Array of UUIDs of all machines this medium is attached to.
12948
12949	A @c null array is returned if this medium is not attached to any
12950	machine or to any machine's snapshot.
12951
12952	<note>
12953	The returned array will include a machine even if this medium is not
12954	attached to that machine in the current state but attached to it in
12955	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
12956	details.
12957	</note>
12958	</desc>
12959	</attribute>
12960
12961	<method name="setIds">
12962	<desc>
12963	Changes the UUID and parent UUID for a hard disk medium.
12964	</desc>
12965	<param name="setImageId" type="boolean" dir="in">
12966	<desc>
12967	Select whether a new image UUID is set or not.
12968	</desc>
12969	</param>
12970	<param name="imageId" type="uuid" mod="string" dir="in">
12971	<desc>
12972	New UUID for the image. If an empty string is passed, then a new
12973	UUID is automatically created, provided that @a setImageId is @c true.
12974	Specifying a zero UUID is not allowed.
12975	</desc>
12976	</param>
12977	<param name="setParentId" type="boolean" dir="in">
12978	<desc>
12979	Select whether a new parent UUID is set or not.
12980	</desc>
12981	</param>
12982	<param name="parentId" type="uuid" mod="string" dir="in">
12983	<desc>
12984	New parent UUID for the image. If an empty string is passed, then a
12985	new UUID is automatically created, provided @a setParentId is
12986	@c true. A zero UUID is valid.
12987	</desc>
12988	</param>
12989	<result name="E_INVALIDARG">
12990	Invalid parameter combination.
12991	</result>
12992	<result name="VBOX_E_NOT_SUPPORTED">
12993	Medium is not a hard disk medium.
12994	</result>
12995	</method>
12996
12997	<method name="refreshState">
12998	<desc>
12999	If the current medium state (see <link to="MediumState"/>) is one of
13000	"Created", "Inaccessible" or "LockedRead", then this performs an
13001	accessibility check on the medium and sets the value of the <link to="#state"/>
13002	attribute accordingly; that value is also returned for convenience.
13003
13004	For all other state values, this does not perform a refresh but returns
13005	the state only.
13006
13007	The refresh, if performed, may take a long time (several seconds or even
13008	minutes, depending on the storage unit location and format) because it performs an
13009	accessibility check of the storage unit. This check may cause a significant
13010	delay if the storage unit of the given medium is, for example, a file located
13011	on a network share which is not currently accessible due to connectivity
13012	problems. In that case, the call will not return until a timeout
13013	interval defined by the host OS for this operation expires. For this reason,
13014	it is recommended to never read this attribute on the main UI thread to avoid
13015	making the UI unresponsive.
13016
13017	If the last known state of the medium is "Created" and the accessibility
13018	check fails, then the state would be set to "Inaccessible", and
13019	<link to="#lastAccessError"/> may be used to get more details about the
13020	failure. If the state of the medium is "LockedRead", then it remains the
13021	same, and a non-empty value of <link to="#lastAccessError"/> will
13022	indicate a failed accessibility check in this case.
13023
13024	Note that not all medium states are applicable to all medium types.
13025	</desc>
13026	<param name="state" type="MediumState" dir="return">
13027	<desc>
13028	New medium state.
13029	</desc>
13030	</param>
13031	</method>
13032
13033	<method name="getSnapshotIds">
13034	<desc>
13035	Returns an array of UUIDs of all snapshots of the given machine where
13036	this medium is attached to.
13037
13038	If the medium is attached to the machine in the current state, then the
13039	first element in the array will always be the ID of the queried machine
13040	(i.e. the value equal to the @c machineId argument), followed by
13041	snapshot IDs (if any).
13042
13043	If the medium is not attached to the machine in the current state, then
13044	the array will contain only snapshot IDs.
13045
13046	The returned array may be @c null if this medium is not attached
13047	to the given machine at all, neither in the current state nor in one of
13048	the snapshots.
13049	</desc>
13050	<param name="machineId" type="uuid" mod="string" dir="in">
13051	<desc>
13052	UUID of the machine to query.
13053	</desc>
13054	</param>
13055	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
13056	<desc>
13057	Array of snapshot UUIDs of the given machine using this medium.
13058	</desc>
13059	</param>
13060	</method>
13061
13062	<method name="lockRead">
13063	<desc>
13064	Locks this medium for reading.
13065
13066	A read lock is shared: many clients can simultaneously lock the
13067	same medium for reading unless it is already locked for writing (see
13068	<link to="#lockWrite"/>) in which case an error is returned.
13069
13070	When the medium is locked for reading, it cannot be modified
13071	from within VirtualBox. This means that any method that changes
13072	the properties of this medium or contents of the storage unit
13073	will return an error (unless explicitly stated otherwise). That
13074	includes an attempt to start a virtual machine that wants to
13075	write to the the medium.
13076
13077	When the virtual machine is started up, it locks for reading all
13078	media it uses in read-only mode. If some medium cannot be locked
13079	for reading, the startup procedure will fail.
13080	A medium is typically locked for reading while it is used by a running
13081	virtual machine but has a depending differencing image that receives
13082	the actual write operations. This way one base medium can have
13083	multiple child differencing images which can be written to
13084	simultaneously. Read-only media such as DVD and floppy images are
13085	also locked for reading only (so they can be in use by multiple
13086	machines simultaneously).
13087
13088	A medium is also locked for reading when it is the source of a
13089	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
13090
13091	The medium locked for reading must be unlocked using the <link
13092	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
13093	can be nested and must be followed by the same number of paired
13094	<link to="#unlockRead"/> calls.
13095
13096	This method sets the medium state (see <link to="#state"/>) to
13097	"LockedRead" on success. The medium's previous state must be
13098	one of "Created", "Inaccessible" or "LockedRead".
13099
13100	Locking an inaccessible medium is not an error; this method performs
13101	a logical lock that prevents modifications of this medium through
13102	the VirtualBox API, not a physical file-system lock of the underlying
13103	storage unit.
13104
13105	This method returns the current state of the medium
13106	<i>before</i> the operation.
13107
13108	<result name="VBOX_E_INVALID_OBJECT_STATE">
13109	Invalid medium state (e.g. not created, locked, inaccessible,
13110	creating, deleting).
13111	</result>
13112
13113	</desc>
13114	<param name="state" type="MediumState" dir="return">
13115	<desc>
13116	State of the medium after the operation.
13117	</desc>
13118	</param>
13119	</method>
13120
13121	<method name="unlockRead">
13122	<desc>
13123	Cancels the read lock previously set by <link to="#lockRead"/>.
13124
13125	For both success and failure, this method returns the current state
13126	of the medium <i>after</i> the operation.
13127
13128	See <link to="#lockRead"/> for more details.
13129
13130	<result name="VBOX_E_INVALID_OBJECT_STATE">
13131	Medium not locked for reading.
13132	</result>
13133
13134	</desc>
13135	<param name="state" type="MediumState" dir="return">
13136	<desc>
13137	State of the medium after the operation.
13138	</desc>
13139	</param>
13140	</method>
13141
13142	<method name="lockWrite">
13143	<desc>
13144	Locks this medium for writing.
13145
13146	A write lock, as opposed to <link to="#lockRead"/>, is
13147	exclusive: there may be only one client holding a write lock,
13148	and there may be no read locks while the write lock is held.
13149	As a result, read-locking fails if a write lock is held, and
13150	write-locking fails if either a read or another write lock is held.
13151
13152	When a medium is locked for writing, it cannot be modified
13153	from within VirtualBox, and it is not guaranteed that the values
13154	of its properties are up-to-date. Any method that changes the
13155	properties of this medium or contents of the storage unit will
13156	return an error (unless explicitly stated otherwise).
13157
13158	When a virtual machine is started up, it locks for writing all
13159	media it uses to write data to. If any medium could not be locked
13160	for writing, the startup procedure will fail. If a medium has
13161	differencing images, then while the machine is running, only
13162	the last ("leaf") differencing image is locked for writing,
13163	whereas its parents are locked for reading only.
13164
13165	A medium is also locked for writing when it is the target of a
13166	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
13167
13168	The medium locked for writing must be unlocked using the <link
13169	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
13170
13171	This method sets the medium state (see <link to="#state"/>) to
13172	"LockedWrite" on success. The medium's previous state must be
13173	either "Created" or "Inaccessible".
13174
13175	Locking an inaccessible medium is not an error; this method performs
13176	a logical lock that prevents modifications of this medium through
13177	the VirtualBox API, not a physical file-system lock of the underlying
13178	storage unit.
13179
13180	For both, success and failure, this method returns the current
13181	state of the medium <i>before</i> the operation.
13182
13183	<result name="VBOX_E_INVALID_OBJECT_STATE">
13184	Invalid medium state (e.g. not created, locked, inaccessible,
13185	creating, deleting).
13186	</result>
13187
13188	</desc>
13189	<param name="state" type="MediumState" dir="return">
13190	<desc>
13191	State of the medium after the operation.
13192	</desc>
13193	</param>
13194	</method>
13195
13196	<method name="unlockWrite">
13197	<desc>
13198	Cancels the write lock previously set by <link to="#lockWrite"/>.
13199
13200	For both success and failure, this method returns the current
13201	state of the medium <i>after</i> the operation.
13202
13203	See <link to="#lockWrite"/> for more details.
13204
13205	<result name="VBOX_E_INVALID_OBJECT_STATE">
13206	Medium not locked for writing.
13207	</result>
13208
13209	</desc>
13210	<param name="state" type="MediumState" dir="return">
13211	<desc>
13212	State of the medium after the operation.
13213	</desc>
13214	</param>
13215	</method>
13216
13217	<method name="close">
13218	<desc>
13219	Closes this medium.
13220
13221	The medium must not be attached to any known virtual machine
13222	and must not have any known child media, otherwise the
13223	operation will fail.
13224
13225	When the medium is successfully closed, it is removed from
13226	the list of registered media, but its storage unit is not
13227	deleted. In particular, this means that this medium can
13228	later be opened again using the <link to="IVirtualBox::openMedium"/>
13229	call.
13230
13231	Note that after this method successfully returns, the given medium
13232	object becomes uninitialized. This means that any attempt
13233	to call any of its methods or attributes will fail with the
13234	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
13235
13236	<result name="VBOX_E_INVALID_OBJECT_STATE">
13237	Invalid medium state (other than not created, created or
13238	inaccessible).
13239	</result>
13240	<result name="VBOX_E_OBJECT_IN_USE">
13241	Medium attached to virtual machine.
13242	</result>
13243	<result name="VBOX_E_FILE_ERROR">
13244	Settings file not accessible.
13245	</result>
13246	<result name="VBOX_E_XML_ERROR">
13247	Could not parse the settings file.
13248	</result>
13249
13250	</desc>
13251	</method>
13252
13253	<!-- property methods -->
13254
13255	<method name="getProperty" const="yes">
13256	<desc>
13257	Returns the value of the custom medium property with the given name.
13258
13259	The list of all properties supported by the given medium format can
13260	be obtained with <link to="IMediumFormat::describeProperties"/>.
13261
13262	<note>If this method returns an empty string in @a value, the requested
13263	property is supported but currently not assigned any value.</note>
13264
13265	<result name="VBOX_E_OBJECT_NOT_FOUND">
13266	Requested property does not exist (not supported by the format).
13267	</result>
13268	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13269	</desc>
13270	<param name="name" type="wstring" dir="in">
13271	<desc>Name of the property to get.</desc>
13272	</param>
13273	<param name="value" type="wstring" dir="return">
13274	<desc>Current property value.</desc>
13275	</param>
13276	</method>
13277
13278	<method name="setProperty">
13279	<desc>
13280	Sets the value of the custom medium property with the given name.
13281
13282	The list of all properties supported by the given medium format can
13283	be obtained with <link to="IMediumFormat::describeProperties"/>.
13284
13285	<note>Setting the property value to @c null or an empty string is
13286	equivalent to deleting the existing value. A default value (if it is
13287	defined for this property) will be used by the format backend in this
13288	case.</note>
13289
13290	<result name="VBOX_E_OBJECT_NOT_FOUND">
13291	Requested property does not exist (not supported by the format).
13292	</result>
13293	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13294	</desc>
13295	<param name="name" type="wstring" dir="in">
13296	<desc>Name of the property to set.</desc>
13297	</param>
13298	<param name="value" type="wstring" dir="in">
13299	<desc>Property value to set.</desc>
13300	</param>
13301	</method>
13302
13303	<method name="getProperties" const="yes">
13304	<desc>
13305	Returns values for a group of properties in one call.
13306
13307	The names of the properties to get are specified using the @a names
13308	argument which is a list of comma-separated property names or
13309	an empty string if all properties are to be returned.
13310	<note>Currently the value of this argument is ignored and the method
13311	always returns all existing properties.</note>
13312
13313	The list of all properties supported by the given medium format can
13314	be obtained with <link to="IMediumFormat::describeProperties"/>.
13315
13316	The method returns two arrays, the array of property names corresponding
13317	to the @a names argument and the current values of these properties.
13318	Both arrays have the same number of elements with each element at the
13319	given index in the first array corresponds to an element at the same
13320	index in the second array.
13321
13322	For properties that do not have assigned values, an empty string is
13323	returned at the appropriate index in the @a returnValues array.
13324
13325	</desc>
13326	<param name="names" type="wstring" dir="in">
13327	<desc>
13328	Names of properties to get.
13329	</desc>
13330	</param>
13331	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13332	<desc>Names of returned properties.</desc>
13333	</param>
13334	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13335	<desc>Values of returned properties.</desc>
13336	</param>
13337	</method>
13338
13339	<method name="setProperties">
13340	<desc>
13341	Sets values for a group of properties in one call.
13342
13343	The names of the properties to set are passed in the @a names
13344	array along with the new values for them in the @a values array. Both
13345	arrays have the same number of elements with each element at the given
13346	index in the first array corresponding to an element at the same index
13347	in the second array.
13348
13349	If there is at least one property name in @a names that is not valid,
13350	the method will fail before changing the values of any other properties
13351	from the @a names array.
13352
13353	Using this method over <link to="#setProperty"/> is preferred if you
13354	need to set several properties at once since it is more efficient.
13355
13356	The list of all properties supported by the given medium format can
13357	be obtained with <link to="IMediumFormat::describeProperties"/>.
13358
13359	Setting the property value to @c null or an empty string is equivalent
13360	to deleting the existing value. A default value (if it is defined for
13361	this property) will be used by the format backend in this case.
13362	</desc>
13363	<param name="names" type="wstring" safearray="yes" dir="in">
13364	<desc>Names of properties to set.</desc>
13365	</param>
13366	<param name="values" type="wstring" safearray="yes" dir="in">
13367	<desc>Values of properties to set.</desc>
13368	</param>
13369	</method>
13370
13371	<!-- storage methods -->
13372
13373	<method name="createBaseStorage">
13374	<desc>
13375	Starts creating a hard disk storage unit (fixed/dynamic, according
13376	to the variant flags) in in the background. The previous storage unit
13377	created for this object, if any, must first be deleted using
13378	<link to="#deleteStorage"/>, otherwise the operation will fail.
13379
13380	Before the operation starts, the medium is placed in
13381	<link to="MediumState_Creating"/> state. If the create operation
13382	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
13383	state.
13384
13385	After the returned progress object reports that the operation has
13386	successfully completed, the medium state will be set to <link
13387	to="MediumState_Created"/>, the medium will be remembered by this
13388	VirtualBox installation and may be attached to virtual machines.
13389
13390	<result name="VBOX_E_NOT_SUPPORTED">
13391	The variant of storage creation operation is not supported. See <link
13392	to="IMediumFormat::capabilities"/>.
13393	</result>
13394	</desc>
13395	<param name="logicalSize" type="long long" dir="in">
13396	<desc>Maximum logical size of the medium in bytes.</desc>
13397	</param>
13398	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13399	<desc>Exact image variant which should be created (as a combination of
13400	<link to="MediumVariant" /> flags).</desc>
13401	</param>
13402	<param name="progress" type="IProgress" dir="return">
13403	<desc>Progress object to track the operation completion.</desc>
13404	</param>
13405	</method>
13406
13407	<method name="deleteStorage">
13408	<desc>
13409	Starts deleting the storage unit of this medium.
13410
13411	The medium must not be attached to any known virtual machine and must
13412	not have any known child media, otherwise the operation will fail.
13413	It will also fail if there is no storage unit to delete or if deletion
13414	is already in progress, or if the medium is being in use (locked for
13415	read or for write) or inaccessible. Therefore, the only valid state for
13416	this operation to succeed is <link to="MediumState_Created"/>.
13417
13418	Before the operation starts, the medium is placed in
13419	<link to="MediumState_Deleting"/> state and gets removed from the list
13420	of remembered hard disks (media registry). If the delete operation
13421	fails, the medium will be remembered again and placed back to
13422	<link to="MediumState_Created"/> state.
13423
13424	After the returned progress object reports that the operation is
13425	complete, the medium state will be set to
13426	<link to="MediumState_NotCreated"/> and you will be able to use one of
13427	the storage creation methods to create it again.
13428
13429	<see><link to="#close"/></see>
13430
13431	<result name="VBOX_E_OBJECT_IN_USE">
13432	Medium is attached to a virtual machine.
13433	</result>
13434	<result name="VBOX_E_NOT_SUPPORTED">
13435	Storage deletion is not allowed because neither of storage creation
13436	operations are supported. See
13437	<link to="IMediumFormat::capabilities"/>.
13438	</result>
13439
13440	<note>
13441	If the deletion operation fails, it is not guaranteed that the storage
13442	unit still exists. You may check the <link to="IMedium::state"/> value
13443	to answer this question.
13444	</note>
13445	</desc>
13446	<param name="progress" type="IProgress" dir="return">
13447	<desc>Progress object to track the operation completion.</desc>
13448	</param>
13449	</method>
13450
13451	<!-- diff methods -->
13452
13453	<method name="createDiffStorage">
13454	<desc>
13455	Starts creating an empty differencing storage unit based on this
13456	medium in the format and at the location defined by the @a target
13457	argument.
13458
13459	The target medium must be in <link to="MediumState_NotCreated"/>
13460	state (i.e. must not have an existing storage unit). Upon successful
13461	completion, this operation will set the type of the target medium to
13462	<link to="MediumType_Normal"/> and create a storage unit necessary to
13463	represent the differencing medium data in the given format (according
13464	to the storage format of the target object).
13465
13466	After the returned progress object reports that the operation is
13467	successfully complete, the target medium gets remembered by this
13468	VirtualBox installation and may be attached to virtual machines.
13469
13470	<note>
13471	The medium will be set to <link to="MediumState_LockedRead"/>
13472	state for the duration of this operation.
13473	</note>
13474	<result name="VBOX_E_OBJECT_IN_USE">
13475	Medium not in @c NotCreated state.
13476	</result>
13477	</desc>
13478	<param name="target" type="IMedium" dir="in">
13479	<desc>Target medium.</desc>
13480	</param>
13481	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13482	<desc>Exact image variant which should be created (as a combination of
13483	<link to="MediumVariant" /> flags).</desc>
13484	</param>
13485	<param name="progress" type="IProgress" dir="return">
13486	<desc>Progress object to track the operation completion.</desc>
13487	</param>
13488	</method>
13489
13490	<method name="mergeTo">
13491	<desc>
13492	Starts merging the contents of this medium and all intermediate
13493	differencing media in the chain to the given target medium.
13494
13495	The target medium must be either a descendant of this medium or
13496	its ancestor (otherwise this method will immediately return a failure).
13497	It follows that there are two logical directions of the merge operation:
13498	from ancestor to descendant (<i>forward merge</i>) and from descendant to
13499	ancestor (<i>backward merge</i>). Let us consider the following medium
13500	chain:
13501
13502	<pre>Base <- Diff_1 <- Diff_2</pre>
13503
13504	Here, calling this method on the <tt>Base</tt> medium object with
13505	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
13506	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
13507	merge. Note that in both cases the contents of the resulting medium
13508	will be the same, the only difference is the medium object that takes
13509	the result of the merge operation. In case of the forward merge in the
13510	above example, the result will be written to <tt>Diff_2</tt>; in case of
13511	the backward merge, the result will be written to <tt>Base</tt>. In
13512	other words, the result of the operation is always stored in the target
13513	medium.
13514
13515	Upon successful operation completion, the storage units of all media in
13516	the chain between this (source) medium and the target medium, including
13517	the source medium itself, will be automatically deleted and the
13518	relevant medium objects (including this medium) will become
13519	uninitialized. This means that any attempt to call any of
13520	their methods or attributes will fail with the
13521	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
13522	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
13523	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
13524	Note that <tt>Diff_2</tt> in this case will become a base medium
13525	itself since it will no longer be based on any other medium.
13526
13527	Considering the above, all of the following conditions must be met in
13528	order for the merge operation to succeed:
13529	<ul>
13530	<li>
13531	Neither this (source) medium nor any intermediate
13532	differencing medium in the chain between it and the target
13533	medium is attached to any virtual machine.
13534	</li>
13535	<li>
13536	Neither the source medium nor the target medium is an
13537	<link to="MediumType_Immutable"/> medium.
13538	</li>
13539	<li>
13540	The part of the medium tree from the source medium to the
13541	target medium is a linear chain, i.e. all medium in this
13542	chain have exactly one child which is the next medium in this
13543	chain. The only exception from this rule is the target medium in
13544	the forward merge operation; it is allowed to have any number of
13545	child media because the merge operation will not change its
13546	logical contents (as it is seen by the guest OS or by children).
13547	</li>
13548	<li>
13549	None of the involved media are in
13550	<link to="MediumState_LockedRead"/> or
13551	<link to="MediumState_LockedWrite"/> state.
13552	</li>
13553	</ul>
13554
13555	<note>
13556	This (source) medium and all intermediates will be placed to <link
13557	to="MediumState_Deleting"/> state and the target medium will be
13558	placed to <link to="MediumState_LockedWrite"/> state and for the
13559	duration of this operation.
13560	</note>
13561	</desc>
13562	<param name="target" type="IMedium" dir="in">
13563	<desc>Target medium.</desc>
13564	</param>
13565	<param name="progress" type="IProgress" dir="return">
13566	<desc>Progress object to track the operation completion.</desc>
13567	</param>
13568	</method>
13569
13570	<!-- clone method -->
13571
13572	<method name="cloneTo">
13573	<desc>
13574	Starts creating a clone of this medium in the format and at the
13575	location defined by the @a target argument.
13576
13577	The target medium must be either in <link to="MediumState_NotCreated"/>
13578	state (i.e. must not have an existing storage unit) or in
13579	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13580	big enough to hold the data or else the copy will be partial). Upon
13581	successful completion, the cloned medium will contain exactly the
13582	same sector data as the medium being cloned, except that in the
13583	first case a new UUID for the clone will be randomly generated, and in
13584	the second case the UUID will remain unchanged.
13585
13586	The @a parent argument defines which medium will be the parent
13587	of the clone. Passing a @c null reference indicates that the clone will
13588	be a base image, i.e. completely independent. It is possible to specify
13589	an arbitrary medium for this parameter, including the parent of the
13590	medium which is being cloned. Even cloning to a child of the source
13591	medium is possible. Note that when cloning to an existing image, the
13592	@a parent argument is ignored.
13593
13594	After the returned progress object reports that the operation is
13595	successfully complete, the target medium gets remembered by this
13596	VirtualBox installation and may be attached to virtual machines.
13597
13598	<note>
13599	This medium will be placed to <link to="MediumState_LockedRead"/>
13600	state for the duration of this operation.
13601	</note>
13602	<result name="E_NOTIMPL">
13603	The specified cloning variant is not supported at the moment.
13604	</result>
13605	</desc>
13606	<param name="target" type="IMedium" dir="in">
13607	<desc>Target medium.</desc>
13608	</param>
13609	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13610	<desc>Exact image variant which should be created (as a combination of
13611	<link to="MediumVariant" /> flags).</desc>
13612	</param>
13613	<param name="parent" type="IMedium" dir="in">
13614	<desc>Parent of the cloned medium.</desc>
13615	</param>
13616	<param name="progress" type="IProgress" dir="return">
13617	<desc>Progress object to track the operation completion.</desc>
13618	</param>
13619	</method>
13620
13621	<method name="cloneToBase">
13622	<desc>
13623	Starts creating a clone of this medium in the format and at the
13624	location defined by the @a target argument.
13625
13626	The target medium must be either in <link to="MediumState_NotCreated"/>
13627	state (i.e. must not have an existing storage unit) or in
13628	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13629	big enough to hold the data or else the copy will be partial). Upon
13630	successful completion, the cloned medium will contain exactly the
13631	same sector data as the medium being cloned, except that in the
13632	first case a new UUID for the clone will be randomly generated, and in
13633	the second case the UUID will remain unchanged.
13634
13635	The @a parent argument defines which medium will be the parent
13636	of the clone. In this case the clone will be a base image, i.e.
13637	completely independent. It is possible to specify an arbitrary
13638	medium for this parameter, including the parent of the
13639	medium which is being cloned. Even cloning to a child of the source
13640	medium is possible. Note that when cloning to an existing image, the
13641	@a parent argument is ignored.
13642
13643	After the returned progress object reports that the operation is
13644	successfully complete, the target medium gets remembered by this
13645	VirtualBox installation and may be attached to virtual machines.
13646
13647	<note>
13648	This medium will be placed to <link to="MediumState_LockedRead"/>
13649	state for the duration of this operation.
13650	</note>
13651	<result name="E_NOTIMPL">
13652	The specified cloning variant is not supported at the moment.
13653	</result>
13654	</desc>
13655	<param name="target" type="IMedium" dir="in">
13656	<desc>Target medium.</desc>
13657	</param>
13658	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13659	<desc><link to="MediumVariant" /> flags).</desc>
13660	</param>
13661	<param name="progress" type="IProgress" dir="return">
13662	<desc>Progress object to track the operation completion.</desc>
13663	</param>
13664	</method>
13665
13666	<!-- other methods -->
13667
13668	<method name="compact">
13669	<desc>
13670	Starts compacting of this medium. This means that the medium is
13671	transformed into a possibly more compact storage representation.
13672	This potentially creates temporary images, which can require a
13673	substantial amount of additional disk space.
13674
13675	This medium will be placed to <link to="MediumState_LockedWrite"/>
13676	state and all its parent media (if any) will be placed to
13677	<link to="MediumState_LockedRead"/> state for the duration of this
13678	operation.
13679
13680	Please note that the results can be either returned straight away,
13681	or later as the result of the background operation via the object
13682	returned via the @a progress parameter.
13683
13684	<result name="VBOX_E_NOT_SUPPORTED">
13685	Medium format does not support compacting (but potentially
13686	needs it).
13687	</result>
13688	</desc>
13689	<param name="progress" type="IProgress" dir="return">
13690	<desc>Progress object to track the operation completion.</desc>
13691	</param>
13692	</method>
13693
13694	<method name="resize">
13695	<desc>
13696	Starts resizing this medium. This means that the nominal size of the
13697	medium is set to the new value. Both increasing and decreasing the
13698	size is possible, and there are no safety checks, since VirtualBox
13699	does not make any assumptions about the medium contents.
13700
13701	Resizing usually needs additional disk space, and possibly also
13702	some temporary disk space. Note that resize does not create a full
13703	temporary copy of the medium, so the additional disk space requirement
13704	is usually much lower than using the clone operation.
13705
13706	This medium will be placed to <link to="MediumState_LockedWrite"/>
13707	state for the duration of this operation.
13708
13709	Please note that the results can be either returned straight away,
13710	or later as the result of the background operation via the object
13711	returned via the @a progress parameter.
13712
13713	<result name="VBOX_E_NOT_SUPPORTED">
13714	Medium format does not support resizing.
13715	</result>
13716	</desc>
13717	<param name="logicalSize" type="long long" dir="in">
13718	<desc>New nominal capacity of the medium in bytes.</desc>
13719	</param>
13720	<param name="progress" type="IProgress" dir="return">
13721	<desc>Progress object to track the operation completion.</desc>
13722	</param>
13723	</method>
13724
13725	<method name="reset">
13726	<desc>
13727	Starts erasing the contents of this differencing medium.
13728
13729	This operation will reset the differencing medium to its initial
13730	state when it does not contain any sector data and any read operation is
13731	redirected to its parent medium. This automatically gets called
13732	during VM power-up for every medium whose <link to="#autoReset" />
13733	attribute is @c true.
13734
13735	The medium will be write-locked for the duration of this operation (see
13736	<link to="#lockWrite" />).
13737
13738	<result name="VBOX_E_NOT_SUPPORTED">
13739	This is not a differencing medium.
13740	</result>
13741	<result name="VBOX_E_INVALID_OBJECT_STATE">
13742	Medium is not in <link to="MediumState_Created"/> or
13743	<link to="MediumState_Inaccessible"/> state.
13744	</result>
13745	</desc>
13746	<param name="progress" type="IProgress" dir="return">
13747	<desc>Progress object to track the operation completion.</desc>
13748	</param>
13749	</method>
13750
13751	</interface>
13752
13753
13754	<!--
13755	// IMediumFormat
13756	/////////////////////////////////////////////////////////////////////////
13757	-->
13758
13759	<enum
13760	name="DataType"
13761	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
13762	>
13763	<const name="Int32" value="0"/>
13764	<const name="Int8" value="1"/>
13765	<const name="String" value="2"/>
13766	</enum>
13767
13768	<enum
13769	name="DataFlags"
13770	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
13771	>
13772	<const name="None" value="0x00"/>
13773	<const name="Mandatory" value="0x01"/>
13774	<const name="Expert" value="0x02"/>
13775	<const name="Array" value="0x04"/>
13776	<const name="FlagMask" value="0x07"/>
13777	</enum>
13778
13779	<enum
13780	name="MediumFormatCapabilities"
13781	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
13782	>
13783	<desc>
13784	Medium format capability flags.
13785	</desc>
13786
13787	<const name="Uuid" value="0x01">
13788	<desc>
13789	Supports UUIDs as expected by VirtualBox code.
13790	</desc>
13791	</const>
13792
13793	<const name="CreateFixed" value="0x02">
13794	<desc>
13795	Supports creating fixed size images, allocating all space instantly.
13796	</desc>
13797	</const>
13798
13799	<const name="CreateDynamic" value="0x04">
13800	<desc>
13801	Supports creating dynamically growing images, allocating space on
13802	demand.
13803	</desc>
13804	</const>
13805
13806	<const name="CreateSplit2G" value="0x08">
13807	<desc>
13808	Supports creating images split in chunks of a bit less than 2 GBytes.
13809	</desc>
13810	</const>
13811
13812	<const name="Differencing" value="0x10">
13813	<desc>
13814	Supports being used as a format for differencing media (see <link
13815	to="IMedium::createDiffStorage"/>).
13816	</desc>
13817	</const>
13818
13819	<const name="Asynchronous" value="0x20">
13820	<desc>
13821	Supports asynchronous I/O operations for at least some configurations.
13822	</desc>
13823	</const>
13824
13825	<const name="File" value="0x40">
13826	<desc>
13827	The format backend operates on files (the <link to="IMedium::location"/>
13828	attribute of the medium specifies a file used to store medium
13829	data; for a list of supported file extensions see
13830	<link to="IMediumFormat::describeFileExtensions"/>).
13831	</desc>
13832	</const>
13833
13834	<const name="Properties" value="0x80">
13835	<desc>
13836	The format backend uses the property interface to configure the storage
13837	location and properties (the <link to="IMediumFormat::describeProperties"/>
13838	method is used to get access to properties supported by the given medium format).
13839	</desc>
13840	</const>
13841
13842	<const name="TcpNetworking" value="0x100">
13843	<desc>
13844	The format backend uses the TCP networking interface for network access.
13845	</desc>
13846	</const>
13847
13848	<const name="VFS" value="0x200">
13849	<desc>
13850	The format backend supports virtual filesystem functionality.
13851	</desc>
13852	</const>
13853
13854	<const name="CapabilityMask" value="0x3FF"/>
13855	</enum>
13856
13857	<interface
13858	name="IMediumFormat" extends="$unknown"
13859	uuid="6238e1cf-a17d-4ec1-8172-418bfb22b93a"
13860	wsmap="managed"
13861	>
13862	<desc>
13863	The IMediumFormat interface represents a medium format.
13864
13865	Each medium format has an associated backend which is used to handle
13866	media stored in this format. This interface provides information
13867	about the properties of the associated backend.
13868
13869	Each medium format is identified by a string represented by the
13870	<link to="#id"/> attribute. This string is used in calls like
13871	<link to="IVirtualBox::createHardDisk"/> to specify the desired
13872	format.
13873
13874	The list of all supported medium formats can be obtained using
13875	<link to="ISystemProperties::mediumFormats"/>.
13876
13877	<see><link to="IMedium"/></see>
13878	</desc>
13879
13880	<attribute name="id" type="wstring" readonly="yes">
13881	<desc>
13882	Identifier of this format.
13883
13884	The format identifier is a non-@c null non-empty ASCII string. Note that
13885	this string is case-insensitive. This means that, for example, all of
13886	the following strings:
13887	<pre>
13888	"VDI"
13889	"vdi"
13890	"VdI"</pre>
13891	refer to the same medium format.
13892
13893	This string is used in methods of other interfaces where it is necessary
13894	to specify a medium format, such as
13895	<link to="IVirtualBox::createHardDisk"/>.
13896	</desc>
13897	</attribute>
13898
13899	<attribute name="name" type="wstring" readonly="yes">
13900	<desc>
13901	Human readable description of this format.
13902
13903	Mainly for use in file open dialogs.
13904	</desc>
13905	</attribute>
13906
13907	<attribute name="capabilities" type="MediumFormatCapabilities" safearray="yes" readonly="yes">
13908	<desc>
13909	Capabilities of the format as an array of the flags.
13910
13911	For the meaning of individual capability flags see
13912	<link to="MediumFormatCapabilities"/>.
13913	</desc>
13914	</attribute>
13915
13916	<method name="describeFileExtensions">
13917	<desc>
13918	Returns two arrays describing the supported file extensions.
13919
13920	The first array contains the supported extensions and the seconds one
13921	the type each extension supports. Both have the same size.
13922
13923	Note that some backends do not work on files, so this array may be
13924	empty.
13925
13926	<see><link to="IMediumFormat::capabilities"/></see>
13927	</desc>
13928	<param name="extensions" type="wstring" safearray="yes" dir="out">
13929	<desc>The array of supported extensions.</desc>
13930	</param>
13931	<param name="types" type="DeviceType" safearray="yes" dir="out">
13932	<desc>The array which indicates the device type for every given extension.</desc>
13933	</param>
13934	</method>
13935
13936	<method name="describeProperties" const="yes">
13937	<desc>
13938	Returns several arrays describing the properties supported by this
13939	format.
13940
13941	An element with the given index in each array describes one
13942	property. Thus, the number of elements in each returned array is the
13943	same and corresponds to the number of supported properties.
13944
13945	The returned arrays are filled in only if the
13946	<link to="MediumFormatCapabilities_Properties"/> flag is set.
13947	All arguments must be non-@c null.
13948
13949	<see><link to="DataType"/>, <link to="DataFlags"/></see>
13950	</desc>
13951
13952	<param name="names" type="wstring" safearray="yes" dir="out">
13953	<desc>Array of property names.</desc>
13954	</param>
13955	<param name="descriptions" type="wstring" safearray="yes" dir="out">
13956	<desc>Array of property descriptions.</desc>
13957	</param>
13958	<param name="types" type="DataType" safearray="yes" dir="out">
13959	<desc>Array of property types.</desc>
13960	</param>
13961	<param name="flags" type="unsigned long" safearray="yes" dir="out">
13962	<desc>Array of property flags.</desc>
13963	</param>
13964	<param name="defaults" type="wstring" safearray="yes" dir="out">
13965	<desc>Array of default property values.</desc>
13966	</param>
13967	</method>
13968
13969	</interface>
13970
13971
13972	<!--
13973	// IKeyboard
13974	/////////////////////////////////////////////////////////////////////////
13975	-->
13976
13977	<interface
13978	name="IKeyboard" extends="$unknown"
13979	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
13980	wsmap="managed"
13981	>
13982	<desc>
13983	The IKeyboard interface represents the virtual machine's keyboard. Used
13984	in <link to="IConsole::keyboard"/>.
13985
13986	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
13987	to the virtual machine.
13988
13989	</desc>
13990	<method name="putScancode">
13991	<desc>Sends a scancode to the keyboard.
13992
13993	<result name="VBOX_E_IPRT_ERROR">
13994	Could not send scan code to virtual keyboard.
13995	</result>
13996
13997	</desc>
13998	<param name="scancode" type="long" dir="in"/>
13999	</method>
14000
14001	<method name="putScancodes">
14002	<desc>Sends an array of scancodes to the keyboard.
14003
14004	<result name="VBOX_E_IPRT_ERROR">
14005	Could not send all scan codes to virtual keyboard.
14006	</result>
14007
14008	</desc>
14009	<param name="scancodes" type="long" dir="in" safearray="yes"/>
14010	<param name="codesStored" type="unsigned long" dir="return"/>
14011	</method>
14012
14013	<method name="putCAD">
14014	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
14015	function is nothing special, it is just a convenience function
14016	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
14017
14018	<result name="VBOX_E_IPRT_ERROR">
14019	Could not send all scan codes to virtual keyboard.
14020	</result>
14021
14022	</desc>
14023	</method>
14024
14025	<attribute name="eventSource" type="IEventSource" readonly="yes">
14026	<desc>
14027	Event source for keyboard events.
14028	</desc>
14029	</attribute>
14030
14031	</interface>
14032
14033
14034	<!--
14035	// IMouse
14036	/////////////////////////////////////////////////////////////////////////
14037	-->
14038
14039	<enum
14040	name="MouseButtonState"
14041	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
14042	>
14043	<desc>
14044	Mouse button state.
14045	</desc>
14046
14047	<const name="LeftButton" value="0x01"/>
14048	<const name="RightButton" value="0x02"/>
14049	<const name="MiddleButton" value="0x04"/>
14050	<const name="WheelUp" value="0x08"/>
14051	<const name="WheelDown" value="0x10"/>
14052	<const name="XButton1" value="0x20"/>
14053	<const name="XButton2" value="0x40"/>
14054	<const name="MouseStateMask" value="0x7F"/>
14055	</enum>
14056
14057	<interface
14058	name="IMouse" extends="$unknown"
14059	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
14060	wsmap="managed"
14061	>
14062	<desc>
14063	The IMouse interface represents the virtual machine's mouse. Used in
14064	<link to="IConsole::mouse"/>.
14065
14066	Through this interface, the virtual machine's virtual mouse can be
14067	controlled.
14068	</desc>
14069
14070	<attribute name="absoluteSupported" type="boolean" readonly="yes">
14071	<desc>
14072	Whether the guest OS supports absolute mouse pointer positioning
14073	or not.
14074	<note>
14075	You can use the <link to="IMouseCapabilityChangedEvent"/>
14076	event to be instantly informed about changes of this attribute
14077	during virtual machine execution.
14078	</note>
14079	<see><link to="#putMouseEventAbsolute"/></see>
14080	</desc>
14081	</attribute>
14082
14083	<attribute name="relativeSupported" type="boolean" readonly="yes">
14084	<desc>
14085	Whether the guest OS supports relative mouse pointer positioning
14086	or not.
14087	<note>
14088	You can use the <link to="IMouseCapabilityChangedEvent"/>
14089	event to be instantly informed about changes of this attribute
14090	during virtual machine execution.
14091	</note>
14092	<see><link to="#putMouseEvent"/></see>
14093	</desc>
14094	</attribute>
14095
14096	<attribute name="needsHostCursor" type="boolean" readonly="yes">
14097	<desc>
14098	Whether the guest OS can currently switch to drawing it's own mouse
14099	cursor on demand.
14100	<note>
14101	You can use the <link to="IMouseCapabilityChangedEvent"/>
14102	event to be instantly informed about changes of this attribute
14103	during virtual machine execution.
14104	</note>
14105	<see><link to="#putMouseEvent"/></see>
14106	</desc>
14107	</attribute>
14108
14109	<method name="putMouseEvent">
14110	<desc>
14111	Initiates a mouse event using relative pointer movements
14112	along x and y axis.
14113
14114	<result name="E_ACCESSDENIED">
14115	Console not powered up.
14116	</result>
14117	<result name="VBOX_E_IPRT_ERROR">
14118	Could not send mouse event to virtual mouse.
14119	</result>
14120
14121	</desc>
14122
14123	<param name="dx" type="long" dir="in">
14124	<desc>
14125	Amount of pixels the mouse should move to the right.
14126	Negative values move the mouse to the left.
14127	</desc>
14128	</param>
14129	<param name="dy" type="long" dir="in">
14130	<desc>
14131	Amount of pixels the mouse should move downwards.
14132	Negative values move the mouse upwards.
14133	</desc>
14134	</param>
14135	<param name="dz" type="long" dir="in">
14136	<desc>
14137	Amount of mouse wheel moves.
14138	Positive values describe clockwise wheel rotations,
14139	negative values describe counterclockwise rotations.
14140	</desc>
14141	</param>
14142	<param name="dw" type="long" dir="in">
14143	<desc>
14144	Amount of horizontal mouse wheel moves.
14145	Positive values describe a movement to the left,
14146	negative values describe a movement to the right.
14147	</desc>
14148	</param>
14149	<param name="buttonState" type="long" dir="in">
14150	<desc>
14151	The current state of mouse buttons. Every bit represents
14152	a mouse button as follows:
14153	<table>
14154	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14155	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14156	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14157	</table>
14158	A value of <tt>1</tt> means the corresponding button is pressed.
14159	otherwise it is released.
14160	</desc>
14161	</param>
14162	</method>
14163
14164	<method name="putMouseEventAbsolute">
14165	<desc>
14166	Positions the mouse pointer using absolute x and y coordinates.
14167	These coordinates are expressed in pixels and
14168	start from <tt>[1,1]</tt> which corresponds to the top left
14169	corner of the virtual display.
14170
14171	<result name="E_ACCESSDENIED">
14172	Console not powered up.
14173	</result>
14174	<result name="VBOX_E_IPRT_ERROR">
14175	Could not send mouse event to virtual mouse.
14176	</result>
14177
14178	<note>
14179	This method will have effect only if absolute mouse
14180	positioning is supported by the guest OS.
14181	</note>
14182
14183	<see><link to="#absoluteSupported"/></see>
14184	</desc>
14185
14186	<param name="x" type="long" dir="in">
14187	<desc>
14188	X coordinate of the pointer in pixels, starting from @c 1.
14189	</desc>
14190	</param>
14191	<param name="y" type="long" dir="in">
14192	<desc>
14193	Y coordinate of the pointer in pixels, starting from @c 1.
14194	</desc>
14195	</param>
14196	<param name="dz" type="long" dir="in">
14197	<desc>
14198	Amount of mouse wheel moves.
14199	Positive values describe clockwise wheel rotations,
14200	negative values describe counterclockwise rotations.
14201	</desc>
14202	</param>
14203	<param name="dw" type="long" dir="in">
14204	<desc>
14205	Amount of horizontal mouse wheel moves.
14206	Positive values describe a movement to the left,
14207	negative values describe a movement to the right.
14208	</desc>
14209	</param>
14210	<param name="buttonState" type="long" dir="in">
14211	<desc>
14212	The current state of mouse buttons. Every bit represents
14213	a mouse button as follows:
14214	<table>
14215	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14216	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14217	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14218	</table>
14219	A value of @c 1 means the corresponding button is pressed.
14220	otherwise it is released.
14221	</desc>
14222	</param>
14223	</method>
14224
14225	<attribute name="eventSource" type="IEventSource" readonly="yes">
14226	<desc>
14227	Event source for mouse events.
14228	</desc>
14229	</attribute>
14230
14231	</interface>
14232
14233	<!--
14234	// IDisplay
14235	/////////////////////////////////////////////////////////////////////////
14236	-->
14237
14238	<enum
14239	name="FramebufferPixelFormat"
14240	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
14241	>
14242	<desc>
14243	Format of the video memory buffer. Constants represented by this enum can
14244	be used to test for particular values of <link
14245	to="IFramebuffer::pixelFormat"/>. See also <link
14246	to="IFramebuffer::requestResize"/>.
14247
14248	See also www.fourcc.org for more information about FOURCC pixel formats.
14249	</desc>
14250
14251	<const name="Opaque" value="0">
14252	<desc>
14253	Unknown buffer format (the user may not assume any particular format of
14254	the buffer).
14255	</desc>
14256	</const>
14257	<const name="FOURCC_RGB" value="0x32424752">
14258	<desc>
14259	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
14260	bit layout).
14261	</desc>
14262	</const>
14263	</enum>
14264
14265	<interface
14266	name="IFramebuffer" extends="$unknown"
14267	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
14268	wsmap="suppress"
14269	>
14270	<attribute name="address" type="octet" mod="ptr" readonly="yes">
14271	<desc>Address of the start byte of the frame buffer.</desc>
14272	</attribute>
14273
14274	<attribute name="width" type="unsigned long" readonly="yes">
14275	<desc>Frame buffer width, in pixels.</desc>
14276	</attribute>
14277
14278	<attribute name="height" type="unsigned long" readonly="yes">
14279	<desc>Frame buffer height, in pixels.</desc>
14280	</attribute>
14281
14282	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
14283	<desc>
14284	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
14285	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
14286	are: 8, 15, 16, 24 and 32.
14287	</desc>
14288	</attribute>
14289
14290	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
14291	<desc>
14292	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
14293	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
14294	size of the scan line must be aligned to 32 bits.
14295	</desc>
14296	</attribute>
14297
14298	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
14299	<desc>
14300	Frame buffer pixel format. It's either one of the values defined by <link
14301	to="FramebufferPixelFormat"/> or a raw FOURCC code.
14302	<note>
14303	This attribute must never return <link
14304	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
14305	<link to="#address"/> points to must be always known.
14306	</note>
14307	</desc>
14308	</attribute>
14309
14310	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
14311	<desc>
14312	Defines whether this frame buffer uses the virtual video card's memory
14313	buffer (guest VRAM) directly or not. See <link
14314	to="IFramebuffer::requestResize"/> for more information.
14315	</desc>
14316	</attribute>
14317
14318	<attribute name="heightReduction" type="unsigned long" readonly="yes">
14319	<desc>
14320	Hint from the frame buffer about how much of the standard
14321	screen height it wants to use for itself. This information is
14322	exposed to the guest through the VESA BIOS and VMMDev interface
14323	so that it can use it for determining its video mode table. It
14324	is not guaranteed that the guest respects the value.
14325	</desc>
14326	</attribute>
14327
14328	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
14329	<desc>
14330	An alpha-blended overlay which is superposed over the frame buffer.
14331	The initial purpose is to allow the display of icons providing
14332	information about the VM state, including disk activity, in front
14333	ends which do not have other means of doing that. The overlay is
14334	designed to controlled exclusively by IDisplay. It has no locking
14335	of its own, and any changes made to it are not guaranteed to be
14336	visible until the affected portion of IFramebuffer is updated. The
14337	overlay can be created lazily the first time it is requested. This
14338	attribute can also return @c null to signal that the overlay is not
14339	implemented.
14340	</desc>
14341	</attribute>
14342
14343	<attribute name="winId" type="long long" readonly="yes">
14344	<desc>
14345	Platform-dependent identifier of the window where context of this
14346	frame buffer is drawn, or zero if there's no such window.
14347	</desc>
14348	</attribute>
14349
14350	<method name="lock">
14351	<desc>
14352	Locks the frame buffer.
14353	Gets called by the IDisplay object where this frame buffer is
14354	bound to.
14355	</desc>
14356	</method>
14357
14358	<method name="unlock">
14359	<desc>
14360	Unlocks the frame buffer.
14361	Gets called by the IDisplay object where this frame buffer is
14362	bound to.
14363	</desc>
14364	</method>
14365
14366	<method name="notifyUpdate">
14367	<desc>
14368	Informs about an update.
14369	Gets called by the display object where this buffer is
14370	registered.
14371	</desc>
14372	<param name="x" type="unsigned long" dir="in"/>
14373	<param name="y" type="unsigned long" dir="in"/>
14374	<param name="width" type="unsigned long" dir="in"/>
14375	<param name="height" type="unsigned long" dir="in"/>
14376	</method>
14377
14378	<method name="requestResize">
14379	<desc>
14380	Requests a size and pixel format change.
14381
14382	There are two modes of working with the video buffer of the virtual
14383	machine. The <i>indirect</i> mode implies that the IFramebuffer
14384	implementation allocates a memory buffer for the requested display mode
14385	and provides it to the virtual machine. In <i>direct</i> mode, the
14386	IFramebuffer implementation uses the memory buffer allocated and owned
14387	by the virtual machine. This buffer represents the video memory of the
14388	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
14389	usually faster because the implementation gets a raw pointer to the
14390	guest VRAM buffer which it can directly use for visualizing the contents
14391	of the virtual display, as opposed to the indirect mode where the
14392	contents of guest VRAM are copied to the memory buffer provided by
14393	the implementation every time a display update occurs.
14394
14395	It is important to note that the direct mode is really fast only when
14396	the implementation uses the given guest VRAM buffer directly, for
14397	example, by blitting it to the window representing the virtual machine's
14398	display, which saves at least one copy operation comparing to the
14399	indirect mode. However, using the guest VRAM buffer directly is not
14400	always possible: the format and the color depth of this buffer may be
14401	not supported by the target window, or it may be unknown (opaque) as in
14402	case of text or non-linear multi-plane VGA video modes. In this case,
14403	the indirect mode (that is always available) should be used as a
14404	fallback: when the guest VRAM contents are copied to the
14405	implementation-provided memory buffer, color and format conversion is
14406	done automatically by the underlying code.
14407
14408	The @a pixelFormat parameter defines whether the direct mode is
14409	available or not. If @a pixelFormat is <link
14410	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
14411	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
14412	@a bytesPerLine parameters must be ignored and the implementation must use
14413	the indirect mode (where it provides its own buffer in one of the
14414	supported formats). In all other cases, @a pixelFormat together with
14415	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
14416	buffer pointed to by the @a VRAM parameter and the implementation is
14417	free to choose which mode to use. To indicate that this frame buffer uses
14418	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
14419	attribute must return @c true and <link to="#address"/> must
14420	return exactly the same address that is passed in the @a VRAM parameter
14421	of this method; otherwise it is assumed that the indirect strategy is
14422	chosen.
14423
14424	The @a width and @a height parameters represent the size of the
14425	requested display mode in both modes. In case of indirect mode, the
14426	provided memory buffer should be big enough to store data of the given
14427	display mode. In case of direct mode, it is guaranteed that the given
14428	@a VRAM buffer contains enough space to represent the display mode of the
14429	given size. Note that this frame buffer's <link to="#width"/> and <link
14430	to="#height"/> attributes must return exactly the same values as
14431	passed to this method after the resize is completed (see below).
14432
14433	The @a finished output parameter determines if the implementation has
14434	finished resizing the frame buffer or not. If, for some reason, the
14435	resize cannot be finished immediately during this call, @a finished
14436	must be set to @c false, and the implementation must call
14437	<link to="IDisplay::resizeCompleted"/> after it has returned from
14438	this method as soon as possible. If @a finished is @c false, the
14439	machine will not call any frame buffer methods until
14440	<link to="IDisplay::resizeCompleted"/> is called.
14441
14442	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
14443	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
14444	this frame buffer must return exactly the same values as specified in the
14445	parameters of this method, after the resize is completed. If the
14446	indirect mode is chosen, these attributes must return values describing
14447	the format of the implementation's own memory buffer <link
14448	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
14449	value must always correlate with <link to="#pixelFormat"/>. Note that
14450	the <link to="#pixelFormat"/> attribute must never return <link
14451	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
14452
14453	<note>
14454	This method is called by the IDisplay object under the
14455	<link to="#lock"/> provided by this IFramebuffer
14456	implementation. If this method returns @c false in @a finished, then
14457	this lock is not released until
14458	<link to="IDisplay::resizeCompleted"/> is called.
14459	</note>
14460	</desc>
14461	<param name="screenId" type="unsigned long" dir="in">
14462	<desc>
14463	Logical screen number. Must be used in the corresponding call to
14464	<link to="IDisplay::resizeCompleted"/> if this call is made.
14465	</desc>
14466	</param>
14467	<param name="pixelFormat" type="unsigned long" dir="in">
14468	<desc>
14469	Pixel format of the memory buffer pointed to by @a VRAM.
14470	See also <link to="FramebufferPixelFormat"/>.
14471	</desc>
14472	</param>
14473	<param name="VRAM" type="octet" mod="ptr" dir="in">
14474	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
14475	</param>
14476	<param name="bitsPerPixel" type="unsigned long" dir="in">
14477	<desc>Color depth, bits per pixel.</desc>
14478	</param>
14479	<param name="bytesPerLine" type="unsigned long" dir="in">
14480	<desc>Size of one scan line, in bytes.</desc>
14481	</param>
14482	<param name="width" type="unsigned long" dir="in">
14483	<desc>Width of the guest display, in pixels.</desc>
14484	</param>
14485	<param name="height" type="unsigned long" dir="in">
14486	<desc>Height of the guest display, in pixels.</desc>
14487	</param>
14488	<param name="finished" type="boolean" dir="return">
14489	<desc>
14490	Can the VM start using the new frame buffer immediately
14491	after this method returns or it should wait for
14492	<link to="IDisplay::resizeCompleted"/>.
14493	</desc>
14494	</param>
14495	</method>
14496
14497	<method name="videoModeSupported">
14498	<desc>
14499	Returns whether the frame buffer implementation is willing to
14500	support a given video mode. In case it is not able to render
14501	the video mode (or for some reason not willing), it should
14502	return @c false. Usually this method is called when the guest
14503	asks the VMM device whether a given video mode is supported
14504	so the information returned is directly exposed to the guest.
14505	It is important that this method returns very quickly.
14506	</desc>
14507	<param name="width" type="unsigned long" dir="in"/>
14508	<param name="height" type="unsigned long" dir="in"/>
14509	<param name="bpp" type="unsigned long" dir="in"/>
14510	<param name="supported" type="boolean" dir="return"/>
14511	</method>
14512
14513	<method name="getVisibleRegion">
14514	<desc>
14515	Returns the visible region of this frame buffer.
14516
14517	If the @a rectangles parameter is @c null then the value of the
14518	@a count parameter is ignored and the number of elements necessary to
14519	describe the current visible region is returned in @a countCopied.
14520
14521	If @a rectangles is not @c null but @a count is less
14522	than the required number of elements to store region data, the method
14523	will report a failure. If @a count is equal or greater than the
14524	required number of elements, then the actual number of elements copied
14525	to the provided array will be returned in @a countCopied.
14526
14527	<note>
14528	The address of the provided array must be in the process space of
14529	this IFramebuffer object.
14530	</note>
14531	<note>
14532	Method not yet implemented.
14533	</note>
14534	</desc>
14535	<param name="rectangles" type="octet" mod="ptr" dir="in">
14536	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
14537	</param>
14538	<param name="count" type="unsigned long" dir="in">
14539	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14540	</param>
14541	<param name="countCopied" type="unsigned long" dir="return">
14542	<desc>Number of elements copied to the @a rectangles array.</desc>
14543	</param>
14544	</method>
14545
14546	<method name="setVisibleRegion">
14547	<desc>
14548	Suggests a new visible region to this frame buffer. This region
14549	represents the area of the VM display which is a union of regions of
14550	all top-level windows of the guest operating system running inside the
14551	VM (if the Guest Additions for this system support this
14552	functionality). This information may be used by the frontends to
14553	implement the seamless desktop integration feature.
14554
14555	<note>
14556	The address of the provided array must be in the process space of
14557	this IFramebuffer object.
14558	</note>
14559	<note>
14560	The IFramebuffer implementation must make a copy of the provided
14561	array of rectangles.
14562	</note>
14563	<note>
14564	Method not yet implemented.
14565	</note>
14566	</desc>
14567	<param name="rectangles" type="octet" mod="ptr" dir="in">
14568	<desc>Pointer to the @c RTRECT array.</desc>
14569	</param>
14570	<param name="count" type="unsigned long" dir="in">
14571	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14572	</param>
14573	</method>
14574
14575	<method name="processVHWACommand">
14576	<desc>
14577	Posts a Video HW Acceleration Command to the frame buffer for processing.
14578	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
14579	are posted from quest to the host to be processed by the host hardware.
14580
14581	<note>
14582	The address of the provided command must be in the process space of
14583	this IFramebuffer object.
14584	</note>
14585	</desc>
14586
14587	<param name="command" type="octet" mod="ptr" dir="in">
14588	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
14589	</param>
14590	</method>
14591
14592	</interface>
14593
14594	<interface
14595	name="IFramebufferOverlay" extends="IFramebuffer"
14596	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
14597	wsmap="suppress"
14598	>
14599	<desc>
14600	The IFramebufferOverlay interface represents an alpha blended overlay
14601	for displaying status icons above an IFramebuffer. It is always created
14602	not visible, so that it must be explicitly shown. It only covers a
14603	portion of the IFramebuffer, determined by its width, height and
14604	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
14605	that order) format, and may be written to directly. Do re-read the
14606	width though, after setting it, as it may be adjusted (increased) to
14607	make it more suitable for the front end.
14608	</desc>
14609	<attribute name="x" type="unsigned long" readonly="yes">
14610	<desc>X position of the overlay, relative to the frame buffer.</desc>
14611	</attribute>
14612
14613	<attribute name="y" type="unsigned long" readonly="yes">
14614	<desc>Y position of the overlay, relative to the frame buffer.</desc>
14615	</attribute>
14616
14617	<attribute name="visible" type="boolean">
14618	<desc>
14619	Whether the overlay is currently visible.
14620	</desc>
14621	</attribute>
14622
14623	<attribute name="alpha" type="unsigned long">
14624	<desc>
14625	The global alpha value for the overlay. This may or may not be
14626	supported by a given front end.
14627	</desc>
14628	</attribute>
14629
14630	<method name="move">
14631	<desc>
14632	Changes the overlay's position relative to the IFramebuffer.
14633	</desc>
14634	<param name="x" type="unsigned long" dir="in"/>
14635	<param name="y" type="unsigned long" dir="in"/>
14636	</method>
14637
14638	</interface>
14639
14640	<interface
14641	name="IDisplay" extends="$unknown"
14642	uuid="b83ee395-8679-40ca-8d60-1a0cbe724930"
14643	wsmap="managed"
14644	>
14645	<desc>
14646	The IDisplay interface represents the virtual machine's display.
14647
14648	The object implementing this interface is contained in each
14649	<link to="IConsole::display"/> attribute and represents the visual
14650	output of the virtual machine.
14651
14652	The virtual display supports pluggable output targets represented by the
14653	IFramebuffer interface. Examples of the output target are a window on
14654	the host computer or an RDP session's display on a remote computer.
14655	</desc>
14656	<method name="getScreenResolution">
14657	<desc>Queries display width, height and color depth for given screen.</desc>
14658	<param name="screenId" type="unsigned long" dir="in"/>
14659	<param name="width" type="unsigned long" dir="out"/>
14660	<param name="height" type="unsigned long" dir="out"/>
14661	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
14662	</method>
14663
14664	<method name="setFramebuffer">
14665	<desc>
14666	Sets the framebuffer for given screen.
14667	</desc>
14668	<param name="screenId" type="unsigned long" dir="in"/>
14669	<param name="framebuffer" type="IFramebuffer" dir="in"/>
14670	</method>
14671
14672	<method name="getFramebuffer">
14673	<desc>
14674	Queries the framebuffer for given screen.
14675	</desc>
14676	<param name="screenId" type="unsigned long" dir="in"/>
14677	<param name="framebuffer" type="IFramebuffer" dir="out"/>
14678	<param name="xOrigin" type="long" dir="out"/>
14679	<param name="yOrigin" type="long" dir="out"/>
14680	</method>
14681
14682	<method name="setVideoModeHint">
14683	<desc>
14684	Asks VirtualBox to request the given video mode from
14685	the guest. This is just a hint and it cannot be guaranteed
14686	that the requested resolution will be used. Guest Additions
14687	are required for the request to be seen by guests. The caller
14688	should issue the request and wait for a resolution change and
14689	after a timeout retry.
14690
14691	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
14692	parameters means that the corresponding values should be taken from the
14693	current video mode (i.e. left unchanged).
14694
14695	If the guest OS supports multi-monitor configuration then the @a display
14696	parameter specifies the number of the guest display to send the hint to:
14697	@c 0 is the primary display, @c 1 is the first secondary and
14698	so on. If the multi-monitor configuration is not supported, @a display
14699	must be @c 0.
14700
14701	<result name="E_INVALIDARG">
14702	The @a display is not associated with any monitor.
14703	</result>
14704
14705	</desc>
14706	<param name="display" type="unsigned long" dir="in">
14707	<desc>
14708	The number of the guest display to send the hint to.
14709	</desc>
14710	</param>
14711	<param name="enabled" type="boolean" dir="in">
14712	<desc>
14713	@c True, if this guest screen is enabled,
14714	@c False otherwise.
14715	</desc>
14716	</param>
14717	<param name="changeOrigin" type="boolean" dir="in">
14718	<desc>
14719	@c True, if the origin of the guest screen should be changed,
14720	@c False otherwise.
14721	</desc>
14722	</param>
14723	<param name="originX" type="long" dir="in">
14724	<desc>
14725	The X origin of the guest screen.
14726	</desc>
14727	</param>
14728	<param name="originY" type="long" dir="in">
14729	<desc>
14730	The Y origin of the guest screen.
14731	</desc>
14732	</param>
14733	<param name="width" type="unsigned long" dir="in"/>
14734	<param name="height" type="unsigned long" dir="in"/>
14735	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
14736	</method>
14737
14738	<method name="setSeamlessMode">
14739	<desc>
14740	Enables or disables seamless guest display rendering (seamless desktop
14741	integration) mode.
14742	<note>
14743	Calling this method has no effect if <link
14744	to="IGuest::getFacilityStatus"/> with facility @c Seamless
14745	does not return @c Active.
14746	</note>
14747	</desc>
14748	<param name="enabled" type="boolean" dir="in"/>
14749	</method>
14750
14751	<method name="takeScreenShot">
14752	<desc>
14753	Takes a screen shot of the requested size and copies it to the
14754	32-bpp buffer allocated by the caller and pointed to by @a address.
14755	A pixel consists of 4 bytes in order: B, G, R, 0.
14756
14757	<note>This API can be used only locally by a VM process through the
14758	COM/XPCOM C++ API as it requires pointer support. It is not
14759	available for scripting langages, Java or any webservice clients.
14760	Unless you are writing a new VM frontend use
14761	<link to="#takeScreenShotToArray" />.
14762	</note>
14763
14764	<result name="E_NOTIMPL">
14765	Feature not implemented.
14766	</result>
14767	<result name="VBOX_E_IPRT_ERROR">
14768	Could not take a screenshot.
14769	</result>
14770
14771	</desc>
14772	<param name="screenId" type="unsigned long" dir="in"/>
14773	<param name="address" type="octet" mod="ptr" dir="in"/>
14774	<param name="width" type="unsigned long" dir="in"/>
14775	<param name="height" type="unsigned long" dir="in"/>
14776	</method>
14777
14778	<method name="takeScreenShotToArray">
14779	<desc>
14780	Takes a guest screen shot of the requested size and returns it as
14781	an array of bytes in uncompressed 32-bit RGBA format.
14782	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
14783
14784	This API is slow, but could be the only option to get guest screenshot
14785	for scriptable languages not allowed to manipulate with addresses
14786	directly.
14787
14788	<result name="E_NOTIMPL">
14789	Feature not implemented.
14790	</result>
14791	<result name="VBOX_E_IPRT_ERROR">
14792	Could not take a screenshot.
14793	</result>
14794	</desc>
14795	<param name="screenId" type="unsigned long" dir="in">
14796	<desc>
14797	Monitor to take screenshot from.
14798	</desc>
14799	</param>
14800	<param name="width" type="unsigned long" dir="in">
14801	<desc>
14802	Desired image width.
14803	</desc>
14804	</param>
14805	<param name="height" type="unsigned long" dir="in">
14806	<desc>
14807	Desired image height.
14808	</desc>
14809	</param>
14810	<param name="screenData" type="octet" dir="return" safearray="yes">
14811	<desc>
14812	Array with resulting screen data.
14813	</desc>
14814	</param>
14815	</method>
14816
14817	<method name="takeScreenShotPNGToArray">
14818	<desc>
14819	Takes a guest screen shot of the requested size and returns it as
14820	PNG image in array.
14821
14822	<result name="E_NOTIMPL">
14823	Feature not implemented.
14824	</result>
14825	<result name="VBOX_E_IPRT_ERROR">
14826	Could not take a screenshot.
14827	</result>
14828	</desc>
14829	<param name="screenId" type="unsigned long" dir="in">
14830	<desc>
14831	Monitor to take the screenshot from.
14832	</desc>
14833	</param>
14834	<param name="width" type="unsigned long" dir="in">
14835	<desc>
14836	Desired image width.
14837	</desc>
14838	</param>
14839	<param name="height" type="unsigned long" dir="in">
14840	<desc>
14841	Desired image height.
14842	</desc>
14843	</param>
14844	<param name="screenData" type="octet" dir="return" safearray="yes">
14845	<desc>
14846	Array with resulting screen data.
14847	</desc>
14848	</param>
14849	</method>
14850
14851	<method name="drawToScreen">
14852	<desc>
14853	Draws a 32-bpp image of the specified size from the given buffer
14854	to the given point on the VM display.
14855
14856	<result name="E_NOTIMPL">
14857	Feature not implemented.
14858	</result>
14859	<result name="VBOX_E_IPRT_ERROR">
14860	Could not draw to screen.
14861	</result>
14862
14863	</desc>
14864	<param name="screenId" type="unsigned long" dir="in">
14865	<desc>
14866	Monitor to take the screenshot from.
14867	</desc>
14868	</param>
14869	<param name="address" type="octet" mod="ptr" dir="in">
14870	<desc>
14871	Address to store the screenshot to
14872	</desc>
14873	</param>
14874	<param name="x" type="unsigned long" dir="in">
14875	<desc>
14876	Relative to the screen top left corner.
14877	</desc>
14878	</param>
14879	<param name="y" type="unsigned long" dir="in">
14880	<desc>
14881	Relative to the screen top left corner.
14882	</desc>
14883	</param>
14884	<param name="width" type="unsigned long" dir="in">
14885	<desc>
14886	Desired image width.
14887	</desc>
14888	</param>
14889	<param name="height" type="unsigned long" dir="in">
14890	<desc>
14891	Desired image height.
14892	</desc>
14893	</param>
14894	</method>
14895
14896	<method name="invalidateAndUpdate">
14897	<desc>
14898	Does a full invalidation of the VM display and instructs the VM
14899	to update it.
14900
14901	<result name="VBOX_E_IPRT_ERROR">
14902	Could not invalidate and update screen.
14903	</result>
14904
14905	</desc>
14906	</method>
14907
14908	<method name="resizeCompleted">
14909	<desc>
14910	Signals that a framebuffer has completed the resize operation.
14911
14912	<result name="VBOX_E_NOT_SUPPORTED">
14913	Operation only valid for external frame buffers.
14914	</result>
14915
14916	</desc>
14917	<param name="screenId" type="unsigned long" dir="in"/>
14918	</method>
14919
14920	<method name="completeVHWACommand">
14921	<desc>
14922	Signals that the Video HW Acceleration command has completed.
14923	</desc>
14924
14925	<param name="command" type="octet" mod="ptr" dir="in">
14926	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
14927	</param>
14928	</method>
14929
14930	<method name="viewportChanged">
14931	<desc>
14932	Signals that framebuffer window viewport has changed.
14933
14934	<result name="E_INVALIDARG">
14935	The specified viewport data is invalid.
14936	</result>
14937
14938	</desc>
14939
14940	<param name="screenId" type="unsigned long" dir="in">
14941	<desc>
14942	Monitor to take the screenshot from.
14943	</desc>
14944	</param>
14945	<param name="x" type="unsigned long" dir="in">
14946	<desc>
14947	Framebuffer x offset.
14948	</desc>
14949	</param>
14950	<param name="y" type="unsigned long" dir="in">
14951	<desc>
14952	Framebuffer y offset.
14953	</desc>
14954	</param>
14955	<param name="width" type="unsigned long" dir="in">
14956	<desc>
14957	Viewport width.
14958	</desc>
14959	</param>
14960	<param name="height" type="unsigned long" dir="in">
14961	<desc>
14962	Viewport height.
14963	</desc>
14964	</param>
14965	</method>
14966	</interface>
14967
14968	<!--
14969	// INetworkAdapter
14970	/////////////////////////////////////////////////////////////////////////
14971	-->
14972
14973	<enum
14974	name="NetworkAttachmentType"
14975	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
14976	>
14977	<desc>
14978	Network attachment type.
14979	</desc>
14980
14981	<const name="Null" value="0">
14982	<desc>Null value, also means "not attached".</desc>
14983	</const>
14984	<const name="NAT" value="1"/>
14985	<const name="Bridged" value="2"/>
14986	<const name="Internal" value="3"/>
14987	<const name="HostOnly" value="4"/>
14988	<const name="Generic" value="5"/>
14989	</enum>
14990
14991	<enum
14992	name="NetworkAdapterType"
14993	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
14994	>
14995	<desc>
14996	Network adapter type.
14997	</desc>
14998
14999	<const name="Null" value="0">
15000	<desc>Null value (never used by the API).</desc>
15001	</const>
15002	<const name="Am79C970A" value="1">
15003	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
15004	</const>
15005	<const name="Am79C973" value="2">
15006	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
15007	</const>
15008	<const name="I82540EM" value="3">
15009	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
15010	</const>
15011	<const name="I82543GC" value="4">
15012	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
15013	</const>
15014	<const name="I82545EM" value="5">
15015	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
15016	</const>
15017	<const name="Virtio" value="6">
15018	<desc>Virtio network device.</desc>
15019	</const>
15020	</enum>
15021
15022	<enum
15023	name="NetworkAdapterPromiscModePolicy"
15024	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
15025	>
15026	<desc>
15027	The promiscuous mode policy of an interface.
15028	</desc>
15029
15030	<const name="Deny" value="1">
15031	<desc>Deny promiscuous mode requests.</desc>
15032	</const>
15033	<const name="AllowNetwork" value="2">
15034	<desc>
15035	Allow promicuous mode, but restrict the scope it to the internal
15036	network so that it only applies to other VMs.
15037	</desc>
15038	</const>
15039	<const name="AllowAll" value="3">
15040	<desc>
15041	Allow promicuous mode, include unrelated traffic going over the wire
15042	and internally on the host.
15043	</desc>
15044	</const>
15045	</enum>
15046
15047	<interface
15048	name="INetworkAdapter" extends="$unknown"
15049	uuid="efa0f965-63c7-4c60-afdf-b1cc9943b9c0"
15050	wsmap="managed"
15051	>
15052	<desc>
15053	Represents a virtual network adapter that is attached to a virtual machine.
15054	Each virtual machine has a fixed number of network adapter slots with one
15055	instance of this attached to each of them. Call
15056	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
15057	is attached to a given slot in a given machine.
15058
15059	Each network adapter can be in one of five attachment modes, which are
15060	represented by the <link to="NetworkAttachmentType" /> enumeration;
15061	see the <link to="#attachmentType" /> attribute.
15062	</desc>
15063
15064	<attribute name="adapterType" type="NetworkAdapterType">
15065	<desc>
15066	Type of the virtual network adapter. Depending on this value,
15067	VirtualBox will provide a different virtual network hardware
15068	to the guest.
15069	</desc>
15070	</attribute>
15071
15072	<attribute name="slot" type="unsigned long" readonly="yes">
15073	<desc>
15074	Slot number this adapter is plugged into. Corresponds to
15075	the value you pass to <link to="IMachine::getNetworkAdapter"/>
15076	to obtain this instance.
15077	</desc>
15078	</attribute>
15079
15080	<attribute name="enabled" type="boolean">
15081	<desc>
15082	Flag whether the network adapter is present in the
15083	guest system. If disabled, the virtual guest hardware will
15084	not contain this network adapter. Can only be changed when
15085	the VM is not running.
15086	</desc>
15087	</attribute>
15088
15089	<attribute name="MACAddress" type="wstring">
15090	<desc>
15091	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
15092	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
15093	</desc>
15094	</attribute>
15095
15096	<attribute name="attachmentType" type="NetworkAttachmentType">
15097	<desc>
15098	Sets/Gets network attachment type of this network adapter.
15099	</desc>
15100	</attribute>
15101
15102	<attribute name="bridgedInterface" type="wstring">
15103	<desc>
15104	Name of the network interface the VM should be bridged to.
15105	</desc>
15106	</attribute>
15107
15108	<attribute name="hostOnlyInterface" type="wstring">
15109	<desc>
15110	Name of the host only network interface the VM is attached to.
15111	</desc>
15112	</attribute>
15113
15114	<attribute name="internalNetwork" type="wstring">
15115	<desc>
15116	Name of the internal network the VM is attached to.
15117	</desc>
15118	</attribute>
15119
15120	<attribute name="NATNetwork" type="wstring">
15121	<desc>
15122	Name of the NAT network the VM is attached to.
15123	</desc>
15124	</attribute>
15125
15126	<attribute name="genericDriver" type="wstring">
15127	<desc>
15128	Name of the driver to use for the "Generic" network attachment type.
15129	</desc>
15130	</attribute>
15131
15132	<attribute name="cableConnected" type="boolean">
15133	<desc>
15134	Flag whether the adapter reports the cable as connected or not.
15135	It can be used to report offline situations to a VM.
15136	</desc>
15137	</attribute>
15138
15139	<attribute name="lineSpeed" type="unsigned long">
15140	<desc>
15141	Line speed reported by custom drivers, in units of 1 kbps.
15142	</desc>
15143	</attribute>
15144
15145	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
15146	<desc>
15147	The promiscuous mode policy of the network adapter when attached to an
15148	internal network, host only network or a bridge.
15149	</desc>
15150	</attribute>
15151
15152	<attribute name="traceEnabled" type="boolean">
15153	<desc>
15154	Flag whether network traffic from/to the network card should be traced.
15155	Can only be toggled when the VM is turned off.
15156	</desc>
15157	</attribute>
15158
15159	<attribute name="traceFile" type="wstring">
15160	<desc>
15161	Filename where a network trace will be stored. If not set, VBox-pid.pcap
15162	will be used.
15163	</desc>
15164	</attribute>
15165
15166	<attribute name="NATEngine" type="INATEngine" readonly="yes">
15167	<desc>
15168	Points to the NAT engine which handles the network address translation
15169	for this interface. This is active only when the interface actually uses
15170	NAT.
15171	</desc>
15172	</attribute>
15173
15174	<attribute name="bootPriority" type="unsigned long">
15175	<desc>
15176	Network boot priority of the adapter. Priority 1 is highest. If not set,
15177	the priority is considered to be at the lowest possible setting.
15178	</desc>
15179	</attribute>
15180
15181	<attribute name="bandwidthGroup" type="IBandwidthGroup">
15182	<desc>The bandwidth group this network adapter is assigned to.</desc>
15183	</attribute>
15184
15185	<!-- property methods -->
15186
15187	<method name="getProperty" const="yes">
15188	<desc>
15189	Returns the value of the network attachment property with the given name.
15190
15191	If the requested data @a key does not exist, this function will
15192	succeed and return an empty string in the @a value argument.
15193
15194	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
15195	</desc>
15196	<param name="key" type="wstring" dir="in">
15197	<desc>Name of the property to get.</desc>
15198	</param>
15199	<param name="value" type="wstring" dir="return">
15200	<desc>Current property value.</desc>
15201	</param>
15202	</method>
15203
15204	<method name="setProperty">
15205	<desc>
15206	Sets the value of the network attachment property with the given name.
15207
15208	Setting the property value to @c null or an empty string is equivalent
15209	to deleting the existing value.
15210
15211	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
15212	</desc>
15213	<param name="key" type="wstring" dir="in">
15214	<desc>Name of the property to set.</desc>
15215	</param>
15216	<param name="value" type="wstring" dir="in">
15217	<desc>Property value to set.</desc>
15218	</param>
15219	</method>
15220
15221	<method name="getProperties" const="yes">
15222	<desc>
15223	Returns values for a group of properties in one call.
15224
15225	The names of the properties to get are specified using the @a names
15226	argument which is a list of comma-separated property names or
15227	an empty string if all properties are to be returned.
15228	<note>Currently the value of this argument is ignored and the method
15229	always returns all existing properties.</note>
15230
15231	The method returns two arrays, the array of property names corresponding
15232	to the @a names argument and the current values of these properties.
15233	Both arrays have the same number of elements with each element at the
15234	given index in the first array corresponds to an element at the same
15235	index in the second array.
15236	</desc>
15237	<param name="names" type="wstring" dir="in">
15238	<desc>
15239	Names of properties to get.
15240	</desc>
15241	</param>
15242	<param name="returnNames" type="wstring" safearray="yes" dir="out">
15243	<desc>Names of returned properties.</desc>
15244	</param>
15245	<param name="returnValues" type="wstring" safearray="yes" dir="return">
15246	<desc>Values of returned properties.</desc>
15247	</param>
15248	</method>
15249
15250	</interface>
15251
15252
15253	<!--
15254	// ISerialPort
15255	/////////////////////////////////////////////////////////////////////////
15256	-->
15257
15258	<enum
15259	name="PortMode"
15260	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
15261	>
15262	<desc>
15263	The PortMode enumeration represents possible communication modes for
15264	the virtual serial port device.
15265	</desc>
15266
15267	<const name="Disconnected" value="0">
15268	<desc>Virtual device is not attached to any real host device.</desc>
15269	</const>
15270	<const name="HostPipe" value="1">
15271	<desc>Virtual device is attached to a host pipe.</desc>
15272	</const>
15273	<const name="HostDevice" value="2">
15274	<desc>Virtual device is attached to a host device.</desc>
15275	</const>
15276	<const name="RawFile" value="3">
15277	<desc>Virtual device is attached to a raw file.</desc>
15278	</const>
15279	</enum>
15280
15281	<interface
15282	name="ISerialPort" extends="$unknown"
15283	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
15284	wsmap="managed"
15285	>
15286
15287	<desc>
15288	The ISerialPort interface represents the virtual serial port device.
15289
15290	The virtual serial port device acts like an ordinary serial port
15291	inside the virtual machine. This device communicates to the real
15292	serial port hardware in one of two modes: host pipe or host device.
15293
15294	In host pipe mode, the #path attribute specifies the path to the pipe on
15295	the host computer that represents a serial port. The #server attribute
15296	determines if this pipe is created by the virtual machine process at
15297	machine startup or it must already exist before starting machine
15298	execution.
15299
15300	In host device mode, the #path attribute specifies the name of the
15301	serial port device on the host computer.
15302
15303	There is also a third communication mode: the disconnected mode. In this
15304	mode, the guest OS running inside the virtual machine will be able to
15305	detect the serial port, but all port write operations will be discarded
15306	and all port read operations will return no data.
15307
15308	<see><link to="IMachine::getSerialPort"/></see>
15309	</desc>
15310
15311	<attribute name="slot" type="unsigned long" readonly="yes">
15312	<desc>
15313	Slot number this serial port is plugged into. Corresponds to
15314	the value you pass to <link to="IMachine::getSerialPort"/>
15315	to obtain this instance.
15316	</desc>
15317	</attribute>
15318
15319	<attribute name="enabled" type="boolean">
15320	<desc>
15321	Flag whether the serial port is enabled. If disabled,
15322	the serial port will not be reported to the guest OS.
15323	</desc>
15324	</attribute>
15325
15326	<attribute name="IOBase" type="unsigned long">
15327	<desc>Base I/O address of the serial port.</desc>
15328	</attribute>
15329
15330	<attribute name="IRQ" type="unsigned long">
15331	<desc>IRQ number of the serial port.</desc>
15332	</attribute>
15333
15334	<attribute name="hostMode" type="PortMode">
15335	<desc>
15336	How is this port connected to the host.
15337	<note>
15338	Changing this attribute may fail if the conditions for
15339	<link to="#path"/> are not met.
15340	</note>
15341	</desc>
15342	</attribute>
15343
15344	<attribute name="server" type="boolean">
15345	<desc>
15346	Flag whether this serial port acts as a server (creates a new pipe on
15347	the host) or as a client (uses the existing pipe). This attribute is
15348	used only when <link to="#hostMode"/> is PortMode_HostPipe.
15349	</desc>
15350	</attribute>
15351
15352	<attribute name="path" type="wstring">
15353	<desc>
15354	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
15355	PortMode_HostPipe, or the host serial device name when
15356	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
15357	cases, setting a @c null or empty string as the attribute's value
15358	is an error. Otherwise, the value of this property is ignored.
15359	</desc>
15360	</attribute>
15361
15362	</interface>
15363
15364	<!--
15365	// IParallelPort
15366	/////////////////////////////////////////////////////////////////////////
15367	-->
15368
15369	<interface
15370	name="IParallelPort" extends="$unknown"
15371	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
15372	wsmap="managed"
15373	>
15374
15375	<desc>
15376	The IParallelPort interface represents the virtual parallel port device.
15377
15378	The virtual parallel port device acts like an ordinary parallel port
15379	inside the virtual machine. This device communicates to the real
15380	parallel port hardware using the name of the parallel device on the host
15381	computer specified in the #path attribute.
15382
15383	Each virtual parallel port device is assigned a base I/O address and an
15384	IRQ number that will be reported to the guest operating system and used
15385	to operate the given parallel port from within the virtual machine.
15386
15387	<see><link to="IMachine::getParallelPort"/></see>
15388	</desc>
15389
15390	<attribute name="slot" type="unsigned long" readonly="yes">
15391	<desc>
15392	Slot number this parallel port is plugged into. Corresponds to
15393	the value you pass to <link to="IMachine::getParallelPort"/>
15394	to obtain this instance.
15395	</desc>
15396	</attribute>
15397
15398	<attribute name="enabled" type="boolean">
15399	<desc>
15400	Flag whether the parallel port is enabled. If disabled,
15401	the parallel port will not be reported to the guest OS.
15402	</desc>
15403	</attribute>
15404
15405	<attribute name="IOBase" type="unsigned long">
15406	<desc>Base I/O address of the parallel port.</desc>
15407	</attribute>
15408
15409	<attribute name="IRQ" type="unsigned long">
15410	<desc>IRQ number of the parallel port.</desc>
15411	</attribute>
15412
15413	<attribute name="path" type="wstring">
15414	<desc>
15415	Host parallel device name. If this parallel port is enabled, setting a
15416	@c null or an empty string as this attribute's value will result in
15417	an error.
15418	</desc>
15419	</attribute>
15420
15421	</interface>
15422
15423
15424	<!--
15425	// IMachineDebugger
15426	/////////////////////////////////////////////////////////////////////////
15427	-->
15428
15429	<interface
15430	name="IMachineDebugger" extends="$unknown"
15431	uuid="a80bb82c-37c5-4155-a524-9c1d0a1689ba"
15432	wsmap="managed"
15433	>
15434	<method name="dumpGuestCore">
15435	<desc>
15436	Takes a core dump of the guest.
15437
15438	See include/VBox/dbgfcorefmt.h for details on the file format.
15439	</desc>
15440	<param name="filename" type="wstring" dir="in">
15441	<desc>
15442	The name of the output file. The file must not exist.
15443	</desc>
15444	</param>
15445	<param name="compression" type="wstring" dir="in">
15446	<desc>
15447	Reserved for future compression method indicator.
15448	</desc>
15449	</param>
15450	</method>
15451
15452	<method name="dumpHostProcessCore">
15453	<desc>
15454	Takes a core dump of the VM process on the host.
15455
15456	This feature is not implemented in the 4.0.0 release but it may show up
15457	in a dot release.
15458	</desc>
15459	<param name="filename" type="wstring" dir="in">
15460	<desc>
15461	The name of the output file. The file must not exist.
15462	</desc>
15463	</param>
15464	<param name="compression" type="wstring" dir="in">
15465	<desc>
15466	Reserved for future compression method indicator.
15467	</desc>
15468	</param>
15469	</method>
15470
15471	<method name="info">
15472	<desc>
15473	Interfaces with the info dumpers (DBGFInfo).
15474
15475	This feature is not implemented in the 4.0.0 release but it may show up
15476	in a dot release.
15477	</desc>
15478	<param name="name" type="wstring" dir="in">
15479	<desc>
15480	The name of the info item.
15481	</desc>
15482	</param>
15483	<param name="args" type="wstring" dir="in">
15484	<desc>
15485	Arguments to the info dumper.
15486	</desc>
15487	</param>
15488	<param name="info" type="wstring" dir="return">
15489	<desc>
15490	The into string.
15491	</desc>
15492	</param>
15493	</method>
15494
15495	<method name="injectNMI">
15496	<desc>
15497	Inject an NMI into a running VT-x/AMD-V VM.
15498	</desc>
15499	</method>
15500
15501	<method name="modifyLogGroups">
15502	<desc>
15503	Modifies the group settings of the debug or release logger.
15504	</desc>
15505	<param name="settings" type="wstring" dir="in">
15506	<desc>
15507	The group settings string. See iprt/log.h for details. To target the
15508	release logger, prefix the string with "release:".
15509	</desc>
15510	</param>
15511	</method>
15512
15513	<method name="modifyLogFlags">
15514	<desc>
15515	Modifies the debug or release logger flags.
15516	</desc>
15517	<param name="settings" type="wstring" dir="in">
15518	<desc>
15519	The flags settings string. See iprt/log.h for details. To target the
15520	release logger, prefix the string with "release:".
15521	</desc>
15522	</param>
15523	</method>
15524
15525	<method name="modifyLogDestinations">
15526	<desc>
15527	Modifies the debug or release logger destinations.
15528	</desc>
15529	<param name="settings" type="wstring" dir="in">
15530	<desc>
15531	The destination settings string. See iprt/log.h for details. To target the
15532	release logger, prefix the string with "release:".
15533	</desc>
15534	</param>
15535	</method>
15536
15537	<method name="readPhysicalMemory">
15538	<desc>
15539	Reads guest physical memory, no side effects (MMIO++).
15540
15541	This feature is not implemented in the 4.0.0 release but may show up
15542	in a dot release.
15543	</desc>
15544	<param name="address" type="long long" dir="in">
15545	<desc>The guest physical address.</desc>
15546	</param>
15547	<param name="size" type="unsigned long" dir="in">
15548	<desc>The number of bytes to read.</desc>
15549	</param>
15550	<param name="bytes" type="octet" safearray="yes" dir="return">
15551	<desc>The bytes read.</desc>
15552	</param>
15553	</method>
15554
15555	<method name="writePhysicalMemory">
15556	<desc>
15557	Writes guest physical memory, access handles (MMIO++) are ignored.
15558
15559	This feature is not implemented in the 4.0.0 release but may show up
15560	in a dot release.
15561	</desc>
15562	<param name="address" type="long long" dir="in">
15563	<desc>The guest physical address.</desc>
15564	</param>
15565	<param name="size" type="unsigned long" dir="in">
15566	<desc>The number of bytes to read.</desc>
15567	</param>
15568	<param name="bytes" type="octet" safearray="yes" dir="in">
15569	<desc>The bytes to write.</desc>
15570	</param>
15571	</method>
15572
15573	<method name="readVirtualMemory">
15574	<desc>
15575	Reads guest virtual memory, no side effects (MMIO++).
15576
15577	This feature is not implemented in the 4.0.0 release but may show up
15578	in a dot release.
15579	</desc>
15580	<param name="cpuId" type="unsigned long" dir="in">
15581	<desc>The identifier of the Virtual CPU.</desc>
15582	</param>
15583	<param name="address" type="long long" dir="in">
15584	<desc>The guest virtual address.</desc>
15585	</param>
15586	<param name="size" type="unsigned long" dir="in">
15587	<desc>The number of bytes to read.</desc>
15588	</param>
15589	<param name="bytes" type="octet" safearray="yes" dir="return">
15590	<desc>The bytes read.</desc>
15591	</param>
15592	</method>
15593
15594	<method name="writeVirtualMemory">
15595	<desc>
15596	Writes guest virtual memory, access handles (MMIO++) are ignored.
15597
15598	This feature is not implemented in the 4.0.0 release but may show up
15599	in a dot release.
15600	</desc>
15601	<param name="cpuId" type="unsigned long" dir="in">
15602	<desc>The identifier of the Virtual CPU.</desc>
15603	</param>
15604	<param name="address" type="long long" dir="in">
15605	<desc>The guest virtual address.</desc>
15606	</param>
15607	<param name="size" type="unsigned long" dir="in">
15608	<desc>The number of bytes to read.</desc>
15609	</param>
15610	<param name="bytes" type="octet" safearray="yes" dir="in">
15611	<desc>The bytes to write.</desc>
15612	</param>
15613	</method>
15614
15615	<method name="detectOS">
15616	<desc>
15617	Tries to (re-)detect the guest OS kernel.
15618
15619	This feature is not implemented in the 4.0.0 release but may show up
15620	in a dot release.
15621	</desc>
15622	<param name="os" type="wstring" dir="return">
15623	<desc>
15624	The detected OS kernel on success.
15625	</desc>
15626	</param>
15627	</method>
15628
15629	<method name="getRegister">
15630	<desc>
15631	Gets one register.
15632
15633	This feature is not implemented in the 4.0.0 release but may show up
15634	in a dot release.
15635	</desc>
15636	<param name="cpuId" type="unsigned long" dir="in">
15637	<desc>The identifier of the Virtual CPU.</desc>
15638	</param>
15639	<param name="name" type="wstring" dir="in">
15640	<desc>The register name, case is ignored.</desc>
15641	</param>
15642	<param name="value" type="wstring" dir="return">
15643	<desc>
15644	The register value. This is usually a hex value (always 0x prefixed)
15645	but other format may be used for floating point registers (TBD).
15646	</desc>
15647	</param>
15648	</method>
15649
15650	<method name="getRegisters">
15651	<desc>
15652	Gets all the registers for the given CPU.
15653
15654	This feature is not implemented in the 4.0.0 release but may show up
15655	in a dot release.
15656	</desc>
15657	<param name="cpuId" type="unsigned long" dir="in">
15658	<desc>The identifier of the Virtual CPU.</desc>
15659	</param>
15660	<param name="names" type="wstring" dir="out" safearray="yes">
15661	<desc>Array containing the lowercase register names.</desc>
15662	</param>
15663	<param name="values" type="wstring" dir="out" safearray="yes">
15664	<desc>
15665	Array paralell to the names holding the register values as if the
15666	register was returned by <link to="IMachineDebugger::getRegister"/>.
15667	</desc>
15668	</param>
15669	</method>
15670
15671	<method name="setRegister">
15672	<desc>
15673	Gets one register.
15674
15675	This feature is not implemented in the 4.0.0 release but may show up
15676	in a dot release.
15677	</desc>
15678	<param name="cpuId" type="unsigned long" dir="in">
15679	<desc>The identifier of the Virtual CPU.</desc>
15680	</param>
15681	<param name="name" type="wstring" dir="in">
15682	<desc>The register name, case is ignored.</desc>
15683	</param>
15684	<param name="value" type="wstring" dir="in">
15685	<desc>
15686	The new register value. Hexadecimal, decimal and octal formattings
15687	are supported in addition to any special formattings returned by
15688	the getters.
15689	</desc>
15690	</param>
15691	</method>
15692
15693	<method name="setRegisters">
15694	<desc>
15695	Sets zero or more registers atomically.
15696
15697	This feature is not implemented in the 4.0.0 release but may show up
15698	in a dot release.
15699	</desc>
15700	<param name="cpuId" type="unsigned long" dir="in">
15701	<desc>The identifier of the Virtual CPU.</desc>
15702	</param>
15703	<param name="names" type="wstring" dir="in" safearray="yes">
15704	<desc>Array containing the register names, case ignored.</desc>
15705	</param>
15706	<param name="values" type="wstring" dir="in" safearray="yes">
15707	<desc>
15708	Array paralell to the names holding the register values. See
15709	<link to="IMachineDebugger::setRegister"/> for formatting
15710	guidelines.
15711	</desc>
15712	</param>
15713	</method>
15714
15715	<method name="dumpGuestStack">
15716	<desc>
15717	Produce a simple stack dump using the current guest state.
15718
15719	This feature is not implemented in the 4.0.0 release but may show up
15720	in a dot release.
15721	</desc>
15722	<param name="cpuId" type="unsigned long" dir="in">
15723	<desc>The identifier of the Virtual CPU.</desc>
15724	</param>
15725	<param name="stack" type="wstring" dir="return">
15726	<desc>String containing the formatted stack dump.</desc>
15727	</param>
15728	</method>
15729
15730	<method name="resetStats">
15731	<desc>
15732	Reset VM statistics.
15733	</desc>
15734	<param name="pattern" type="wstring" dir="in">
15735	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15736	</param>
15737	</method>
15738
15739	<method name="dumpStats">
15740	<desc>
15741	Dumps VM statistics.
15742	</desc>
15743	<param name="pattern" type="wstring" dir="in">
15744	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15745	</param>
15746	</method>
15747
15748	<method name="getStats">
15749	<desc>
15750	Get the VM statistics in a XMLish format.
15751	</desc>
15752	<param name="pattern" type="wstring" dir="in">
15753	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15754	</param>
15755	<param name="withDescriptions" type="boolean" dir="in">
15756	<desc>Whether to include the descriptions.</desc>
15757	</param>
15758	<param name="stats" type="wstring" dir="return">
15759	<desc>The XML document containing the statistics.</desc>
15760	</param>
15761	</method>
15762
15763	<attribute name="singleStep" type="boolean">
15764	<desc>Switch for enabling single-stepping.</desc>
15765	</attribute>
15766
15767	<attribute name="recompileUser" type="boolean">
15768	<desc>Switch for forcing code recompilation for user mode code.</desc>
15769	</attribute>
15770
15771	<attribute name="recompileSupervisor" type="boolean">
15772	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
15773	</attribute>
15774
15775	<attribute name="PATMEnabled" type="boolean">
15776	<desc>Switch for enabling and disabling the PATM component.</desc>
15777	</attribute>
15778
15779	<attribute name="CSAMEnabled" type="boolean">
15780	<desc>Switch for enabling and disabling the CSAM component.</desc>
15781	</attribute>
15782
15783	<attribute name="logEnabled" type="boolean">
15784	<desc>Switch for enabling and disabling the debug logger.</desc>
15785	</attribute>
15786
15787	<attribute name="logDbgFlags" type="wstring" readonly="yes">
15788	<desc>The debug logger flags.</desc>
15789	</attribute>
15790
15791	<attribute name="logDbgGroups" type="wstring" readonly="yes">
15792	<desc>The debug logger's group settings.</desc>
15793	</attribute>
15794
15795	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
15796	<desc>The debug logger's destination settings.</desc>
15797	</attribute>
15798
15799	<attribute name="logRelFlags" type="wstring" readonly="yes">
15800	<desc>The release logger flags.</desc>
15801	</attribute>
15802
15803	<attribute name="logRelGroups" type="wstring" readonly="yes">
15804	<desc>The release logger's group settings.</desc>
15805	</attribute>
15806
15807	<attribute name="logRelDestinations" type="wstring" readonly="yes">
15808	<desc>The relase logger's destination settings.</desc>
15809	</attribute>
15810
15811	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
15812	<desc>
15813	Flag indicating whether the VM is currently making use of CPU hardware
15814	virtualization extensions.
15815	</desc>
15816	</attribute>
15817
15818	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
15819	<desc>
15820	Flag indicating whether the VM is currently making use of the nested paging
15821	CPU hardware virtualization extension.
15822	</desc>
15823	</attribute>
15824
15825	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
15826	<desc>
15827	Flag indicating whether the VM is currently making use of the VPID
15828	VT-x extension.
15829	</desc>
15830	</attribute>
15831
15832	<attribute name="OSName" type="wstring" readonly="yes">
15833	<desc>
15834	Query the guest OS kernel name as detected by the DBGF.
15835
15836	This feature is not implemented in the 4.0.0 release but may show up
15837	in a dot release.
15838	</desc>
15839	</attribute>
15840
15841	<attribute name="OSVersion" type="wstring" readonly="yes">
15842	<desc>
15843	Query the guest OS kernel version string as detected by the DBGF.
15844
15845	This feature is not implemented in the 4.0.0 release but may show up
15846	in a dot release.
15847	</desc>
15848	</attribute>
15849
15850	<attribute name="PAEEnabled" type="boolean" readonly="yes">
15851	<desc>
15852	Flag indicating whether the VM is currently making use of the Physical
15853	Address Extension CPU feature.
15854	</desc>
15855	</attribute>
15856
15857	<attribute name="virtualTimeRate" type="unsigned long">
15858	<desc>
15859	The rate at which the virtual time runs expressed as a percentage.
15860	The accepted range is 2% to 20000%.
15861	</desc>
15862	</attribute>
15863
15864	<attribute name="VM" type="long long" readonly="yes" wsmap="suppress">
15865	<desc>
15866	Gets the user-mode VM handle, with a reference. Must be passed to
15867	VMR3ReleaseUVM when done. This is only for internal use while we carve
15868	the details of this interface.
15869	</desc>
15870	</attribute>
15871
15872	</interface>
15873
15874	<!--
15875	// IUSBController
15876	/////////////////////////////////////////////////////////////////////////
15877	-->
15878
15879	<interface
15880	name="IUSBController" extends="$unknown"
15881	uuid="01e6f13a-0580-452f-a40f-74e32a5e4921"
15882	wsmap="managed"
15883	>
15884	<attribute name="enabled" type="boolean">
15885	<desc>
15886	Flag whether the USB controller is present in the
15887	guest system. If disabled, the virtual guest hardware will
15888	not contain any USB controller. Can only be changed when
15889	the VM is powered off.
15890	</desc>
15891	</attribute>
15892
15893	<attribute name="enabledEHCI" type="boolean">
15894	<desc>
15895	Flag whether the USB EHCI controller is present in the
15896	guest system. If disabled, the virtual guest hardware will
15897	not contain a USB EHCI controller. Can only be changed when
15898	the VM is powered off.
15899	</desc>
15900	</attribute>
15901
15902	<attribute name="proxyAvailable" type="boolean" readonly="yes">
15903	<desc>
15904	Flag whether there is an USB proxy available.
15905	</desc>
15906	</attribute>
15907
15908	<attribute name="USBStandard" type="unsigned short" readonly="yes">
15909	<desc>
15910	USB standard version which the controller implements.
15911	This is a BCD which means that the major version is in the
15912	high byte and minor version is in the low byte.
15913	</desc>
15914	</attribute>
15915
15916	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
15917	<desc>
15918	List of USB device filters associated with the machine.
15919
15920	If the machine is currently running, these filters are activated
15921	every time a new (supported) USB device is attached to the host
15922	computer that was not ignored by global filters
15923	(<link to="IHost::USBDeviceFilters"/>).
15924
15925	These filters are also activated when the machine is powered up.
15926	They are run against a list of all currently available USB
15927	devices (in states
15928	<link to="USBDeviceState_Available"/>,
15929	<link to="USBDeviceState_Busy"/>,
15930	<link to="USBDeviceState_Held"/>) that were not previously
15931	ignored by global filters.
15932
15933	If at least one filter matches the USB device in question, this
15934	device is automatically captured (attached to) the virtual USB
15935	controller of this machine.
15936
15937	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
15938	</desc>
15939	</attribute>
15940
15941	<method name="createDeviceFilter">
15942	<desc>
15943	Creates a new USB device filter. All attributes except
15944	the filter name are set to empty (any match),
15945	<i>active</i> is @c false (the filter is not active).
15946
15947	The created filter can then be added to the list of filters using
15948	<link to="#insertDeviceFilter"/>.
15949
15950	<result name="VBOX_E_INVALID_VM_STATE">
15951	The virtual machine is not mutable.
15952	</result>
15953
15954	<see><link to="#deviceFilters"/></see>
15955	</desc>
15956	<param name="name" type="wstring" dir="in">
15957	<desc>
15958	Filter name. See <link to="IUSBDeviceFilter::name"/>
15959	for more info.
15960	</desc>
15961	</param>
15962	<param name="filter" type="IUSBDeviceFilter" dir="return">
15963	<desc>Created filter object.</desc>
15964	</param>
15965	</method>
15966
15967	<method name="insertDeviceFilter">
15968	<desc>
15969	Inserts the given USB device to the specified position
15970	in the list of filters.
15971
15972	Positions are numbered starting from <tt>0</tt>. If the specified
15973	position is equal to or greater than the number of elements in
15974	the list, the filter is added to the end of the collection.
15975
15976	<note>
15977	Duplicates are not allowed, so an attempt to insert a
15978	filter that is already in the collection, will return an
15979	error.
15980	</note>
15981
15982	<result name="VBOX_E_INVALID_VM_STATE">
15983	Virtual machine is not mutable.
15984	</result>
15985	<result name="E_INVALIDARG">
15986	USB device filter not created within this VirtualBox instance.
15987	</result>
15988	<result name="VBOX_E_INVALID_OBJECT_STATE">
15989	USB device filter already in list.
15990	</result>
15991
15992	<see><link to="#deviceFilters"/></see>
15993	</desc>
15994	<param name="position" type="unsigned long" dir="in">
15995	<desc>Position to insert the filter to.</desc>
15996	</param>
15997	<param name="filter" type="IUSBDeviceFilter" dir="in">
15998	<desc>USB device filter to insert.</desc>
15999	</param>
16000	</method>
16001
16002	<method name="removeDeviceFilter">
16003	<desc>
16004	Removes a USB device filter from the specified position in the
16005	list of filters.
16006
16007	Positions are numbered starting from <tt>0</tt>. Specifying a
16008	position equal to or greater than the number of elements in
16009	the list will produce an error.
16010
16011	<see><link to="#deviceFilters"/></see>
16012
16013	<result name="VBOX_E_INVALID_VM_STATE">
16014	Virtual machine is not mutable.
16015	</result>
16016	<result name="E_INVALIDARG">
16017	USB device filter list empty or invalid @a position.
16018	</result>
16019
16020	</desc>
16021	<param name="position" type="unsigned long" dir="in">
16022	<desc>Position to remove the filter from.</desc>
16023	</param>
16024	<param name="filter" type="IUSBDeviceFilter" dir="return">
16025	<desc>Removed USB device filter.</desc>
16026	</param>
16027	</method>
16028
16029	</interface>
16030
16031
16032	<!--
16033	// IUSBDevice
16034	/////////////////////////////////////////////////////////////////////////
16035	-->
16036
16037	<interface
16038	name="IUSBDevice" extends="$unknown"
16039	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
16040	wsmap="managed"
16041	>
16042	<desc>
16043	The IUSBDevice interface represents a virtual USB device attached to the
16044	virtual machine.
16045
16046	A collection of objects implementing this interface is stored in the
16047	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
16048	attached to a running virtual machine's USB controller.
16049	</desc>
16050
16051	<attribute name="id" type="uuid" mod="string" readonly="yes">
16052	<desc>
16053	Unique USB device ID. This ID is built from #vendorId,
16054	#productId, #revision and #serialNumber.
16055	</desc>
16056	</attribute>
16057
16058	<attribute name="vendorId" type="unsigned short" readonly="yes">
16059	<desc>Vendor ID.</desc>
16060	</attribute>
16061
16062	<attribute name="productId" type="unsigned short" readonly="yes">
16063	<desc>Product ID.</desc>
16064	</attribute>
16065
16066	<attribute name="revision" type="unsigned short" readonly="yes">
16067	<desc>
16068	Product revision number. This is a packed BCD represented as
16069	unsigned short. The high byte is the integer part and the low
16070	byte is the decimal.
16071	</desc>
16072	</attribute>
16073
16074	<attribute name="manufacturer" type="wstring" readonly="yes">
16075	<desc>Manufacturer string.</desc>
16076	</attribute>
16077
16078	<attribute name="product" type="wstring" readonly="yes">
16079	<desc>Product string.</desc>
16080	</attribute>
16081
16082	<attribute name="serialNumber" type="wstring" readonly="yes">
16083	<desc>Serial number string.</desc>
16084	</attribute>
16085
16086	<attribute name="address" type="wstring" readonly="yes">
16087	<desc>Host specific address of the device.</desc>
16088	</attribute>
16089
16090	<attribute name="port" type="unsigned short" readonly="yes">
16091	<desc>
16092	Host USB port number the device is physically
16093	connected to.
16094	</desc>
16095	</attribute>
16096
16097	<attribute name="version" type="unsigned short" readonly="yes">
16098	<desc>
16099	The major USB version of the device - 1 or 2.
16100	</desc>
16101	</attribute>
16102
16103	<attribute name="portVersion" type="unsigned short" readonly="yes">
16104	<desc>
16105	The major USB version of the host USB port the device is
16106	physically connected to - 1 or 2. For devices not connected to
16107	anything this will have the same value as the version attribute.
16108	</desc>
16109	</attribute>
16110
16111	<attribute name="remote" type="boolean" readonly="yes">
16112	<desc>
16113	Whether the device is physically connected to a remote VRDE
16114	client or to a local host machine.
16115	</desc>
16116	</attribute>
16117
16118	</interface>
16119
16120
16121	<!--
16122	// IUSBDeviceFilter
16123	/////////////////////////////////////////////////////////////////////////
16124	-->
16125
16126	<interface
16127	name="IUSBDeviceFilter" extends="$unknown"
16128	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
16129	wsmap="managed"
16130	>
16131	<desc>
16132	The IUSBDeviceFilter interface represents an USB device filter used
16133	to perform actions on a group of USB devices.
16134
16135	This type of filters is used by running virtual machines to
16136	automatically capture selected USB devices once they are physically
16137	attached to the host computer.
16138
16139	A USB device is matched to the given device filter if and only if all
16140	attributes of the device match the corresponding attributes of the
16141	filter (that is, attributes are joined together using the logical AND
16142	operation). On the other hand, all together, filters in the list of
16143	filters carry the semantics of the logical OR operation. So if it is
16144	desirable to create a match like "this vendor id OR this product id",
16145	one needs to create two filters and specify "any match" (see below)
16146	for unused attributes.
16147
16148	All filter attributes used for matching are strings. Each string
16149	is an expression representing a set of values of the corresponding
16150	device attribute, that will match the given filter. Currently, the
16151	following filtering expressions are supported:
16152
16153	<ul>
16154	<li><i>Interval filters</i>. Used to specify valid intervals for
16155	integer device attributes (Vendor ID, Product ID and Revision).
16156	The format of the string is:
16157
16158	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
16159
16160	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
16161	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
16162	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
16163	is omitted before a dash (<tt>-</tt>), the minimum possible integer
16164	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
16165	possible integer is assumed.
16166	</li>
16167	<li><i>Boolean filters</i>. Used to specify acceptable values for
16168	boolean device attributes. The format of the string is:
16169
16170	<tt>true\|false\|yes\|no\|0\|1</tt>
16171
16172	</li>
16173	<li><i>Exact match</i>. Used to specify a single value for the given
16174	device attribute. Any string that doesn't start with <tt>int:</tt>
16175	represents the exact match. String device attributes are compared to
16176	this string including case of symbols. Integer attributes are first
16177	converted to a string (see individual filter attributes) and then
16178	compared ignoring case.
16179
16180	</li>
16181	<li><i>Any match</i>. Any value of the corresponding device attribute
16182	will match the given filter. An empty or @c null string is
16183	used to construct this type of filtering expressions.
16184
16185	</li>
16186	</ul>
16187
16188	<note>
16189	On the Windows host platform, interval filters are not currently
16190	available. Also all string filter attributes
16191	(<link to="#manufacturer"/>, <link to="#product"/>,
16192	<link to="#serialNumber"/>) are ignored, so they behave as
16193	<i>any match</i> no matter what string expression is specified.
16194	</note>
16195
16196	<see><link to="IUSBController::deviceFilters"/>,
16197	<link to="IHostUSBDeviceFilter"/></see>
16198	</desc>
16199
16200	<attribute name="name" type="wstring">
16201	<desc>
16202	Visible name for this filter.
16203	This name is used to visually distinguish one filter from another,
16204	so it can neither be @c null nor an empty string.
16205	</desc>
16206	</attribute>
16207
16208	<attribute name="active" type="boolean">
16209	<desc>Whether this filter active or has been temporarily disabled.</desc>
16210	</attribute>
16211
16212	<attribute name="vendorId" type="wstring">
16213	<desc>
16214	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
16215	The string representation for the <i>exact matching</i>
16216	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16217	(including leading zeroes).
16218	</desc>
16219	</attribute>
16220
16221	<attribute name="productId" type="wstring">
16222	<desc>
16223	<link to="IUSBDevice::productId">Product ID</link> filter.
16224	The string representation for the <i>exact matching</i>
16225	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16226	(including leading zeroes).
16227	</desc>
16228	</attribute>
16229
16230	<attribute name="revision" type="wstring">
16231	<desc>
16232	<link to="IUSBDevice::productId">Product revision number</link>
16233	filter. The string representation for the <i>exact matching</i>
16234	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
16235	of the integer part of the revision, and <tt>F</tt> is the
16236	decimal digit of its fractional part (including leading and
16237	trailing zeros).
16238	Note that for interval filters, it's best to use the hexadecimal
16239	form, because the revision is stored as a 16 bit packed BCD value;
16240	so the expression <tt>int:0x0100-0x0199</tt> will match any
16241	revision from <tt>1.0</tt> to <tt>1.99</tt>.
16242	</desc>
16243	</attribute>
16244
16245	<attribute name="manufacturer" type="wstring">
16246	<desc>
16247	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
16248	</desc>
16249	</attribute>
16250
16251	<attribute name="product" type="wstring">
16252	<desc>
16253	<link to="IUSBDevice::product">Product</link> filter.
16254	</desc>
16255	</attribute>
16256
16257	<attribute name="serialNumber" type="wstring">
16258	<desc>
16259	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
16260	</desc>
16261	</attribute>
16262
16263	<attribute name="port" type="wstring">
16264	<desc>
16265	<link to="IUSBDevice::port">Host USB port</link> filter.
16266	</desc>
16267	</attribute>
16268
16269	<attribute name="remote" type="wstring">
16270	<desc>
16271	<link to="IUSBDevice::remote">Remote state</link> filter.
16272	<note>
16273	This filter makes sense only for machine USB filters,
16274	i.e. it is ignored by IHostUSBDeviceFilter objects.
16275	</note>
16276	</desc>
16277	</attribute>
16278
16279	<attribute name="maskedInterfaces" type="unsigned long">
16280	<desc>
16281	This is an advanced option for hiding one or more USB interfaces
16282	from the guest. The value is a bit mask where the bits that are set
16283	means the corresponding USB interface should be hidden, masked off
16284	if you like.
16285	This feature only works on Linux hosts.
16286	</desc>
16287	</attribute>
16288
16289	</interface>
16290
16291
16292	<!--
16293	// IHostUSBDevice
16294	/////////////////////////////////////////////////////////////////////////
16295	-->
16296
16297	<enum
16298	name="USBDeviceState"
16299	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
16300	>
16301	<desc>
16302	USB device state. This enumeration represents all possible states
16303	of the USB device physically attached to the host computer regarding
16304	its state on the host computer and availability to guest computers
16305	(all currently running virtual machines).
16306
16307	Once a supported USB device is attached to the host, global USB
16308	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
16309	either ignore the device, or put it to USBDeviceState_Held state, or do
16310	nothing. Unless the device is ignored by global filters, filters of all
16311	currently running guests (<link to="IUSBController::deviceFilters"/>) are
16312	activated that can put it to USBDeviceState_Captured state.
16313
16314	If the device was ignored by global filters, or didn't match
16315	any filters at all (including guest ones), it is handled by the host
16316	in a normal way. In this case, the device state is determined by
16317	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
16318	or USBDeviceState_Available, depending on the current device usage.
16319
16320	Besides auto-capturing based on filters, the device can be manually
16321	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
16322	state is USBDeviceState_Busy, USBDeviceState_Available or
16323	USBDeviceState_Held.
16324
16325	<note>
16326	Due to differences in USB stack implementations in Linux and Win32,
16327	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
16328	only to the Linux version of the product. This also means that (<link
16329	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
16330	device state is USBDeviceState_Held.
16331	</note>
16332
16333	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
16334	</desc>
16335
16336	<const name="NotSupported" value="0">
16337	<desc>
16338	Not supported by the VirtualBox server, not available to guests.
16339	</desc>
16340	</const>
16341	<const name="Unavailable" value="1">
16342	<desc>
16343	Being used by the host computer exclusively,
16344	not available to guests.
16345	</desc>
16346	</const>
16347	<const name="Busy" value="2">
16348	<desc>
16349	Being used by the host computer, potentially available to guests.
16350	</desc>
16351	</const>
16352	<const name="Available" value="3">
16353	<desc>
16354	Not used by the host computer, available to guests (the host computer
16355	can also start using the device at any time).
16356	</desc>
16357	</const>
16358	<const name="Held" value="4">
16359	<desc>
16360	Held by the VirtualBox server (ignored by the host computer),
16361	available to guests.
16362	</desc>
16363	</const>
16364	<const name="Captured" value="5">
16365	<desc>
16366	Captured by one of the guest computers, not available
16367	to anybody else.
16368	</desc>
16369	</const>
16370	</enum>
16371
16372	<interface
16373	name="IHostUSBDevice" extends="IUSBDevice"
16374	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
16375	wsmap="managed"
16376	>
16377	<desc>
16378	The IHostUSBDevice interface represents a physical USB device attached
16379	to the host computer.
16380
16381	Besides properties inherited from IUSBDevice, this interface adds the
16382	<link to="#state"/> property that holds the current state of the USB
16383	device.
16384
16385	<see><link to="IHost::USBDevices"/>,
16386	<link to="IHost::USBDeviceFilters"/></see>
16387	</desc>
16388
16389	<attribute name="state" type="USBDeviceState" readonly="yes">
16390	<desc>
16391	Current state of the device.
16392	</desc>
16393	</attribute>
16394
16395	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
16396
16397	</interface>
16398
16399
16400	<!--
16401	// IHostUSBDeviceFilter
16402	/////////////////////////////////////////////////////////////////////////
16403	-->
16404
16405	<enum
16406	name="USBDeviceFilterAction"
16407	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
16408	>
16409	<desc>
16410	Actions for host USB device filters.
16411	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
16412	</desc>
16413
16414	<const name="Null" value="0">
16415	<desc>Null value (never used by the API).</desc>
16416	</const>
16417	<const name="Ignore" value="1">
16418	<desc>Ignore the matched USB device.</desc>
16419	</const>
16420	<const name="Hold" value="2">
16421	<desc>Hold the matched USB device.</desc>
16422	</const>
16423	</enum>
16424
16425	<interface
16426	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
16427	uuid="4cc70246-d74a-400f-8222-3900489c0374"
16428	wsmap="managed"
16429	>
16430	<desc>
16431	The IHostUSBDeviceFilter interface represents a global filter for a
16432	physical USB device used by the host computer. Used indirectly in
16433	<link to="IHost::USBDeviceFilters"/>.
16434
16435	Using filters of this type, the host computer determines the initial
16436	state of the USB device after it is physically attached to the
16437	host's USB controller.
16438
16439	<note>
16440	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
16441	filters, because it makes sense only for
16442	<link to="IUSBController::deviceFilters">machine USB filters</link>.
16443	</note>
16444
16445	<see><link to="IHost::USBDeviceFilters"/></see>
16446	</desc>
16447
16448	<attribute name="action" type="USBDeviceFilterAction">
16449	<desc>
16450	Action performed by the host when an attached USB device
16451	matches this filter.
16452	</desc>
16453	</attribute>
16454
16455	</interface>
16456
16457	<!--
16458	// IAudioAdapter
16459	/////////////////////////////////////////////////////////////////////////
16460	-->
16461
16462	<enum
16463	name="AudioDriverType"
16464	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
16465	>
16466	<desc>
16467	Host audio driver type.
16468	</desc>
16469
16470	<const name="Null" value="0">
16471	<desc>Null value, also means "dummy audio driver".</desc>
16472	</const>
16473	<const name="WinMM" value="1">
16474	<desc>Windows multimedia (Windows hosts only).</desc>
16475	</const>
16476	<const name="OSS" value="2">
16477	<desc>Open Sound System (Linux hosts only).</desc>
16478	</const>
16479	<const name="ALSA" value="3">
16480	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
16481	</const>
16482	<const name="DirectSound" value="4">
16483	<desc>DirectSound (Windows hosts only).</desc>
16484	</const>
16485	<const name="CoreAudio" value="5">
16486	<desc>CoreAudio (Mac hosts only).</desc>
16487	</const>
16488	<const name="MMPM" value="6">
16489	<desc>Reserved for historical reasons.</desc>
16490	</const>
16491	<const name="Pulse" value="7">
16492	<desc>PulseAudio (Linux hosts only).</desc>
16493	</const>
16494	<const name="SolAudio" value="8">
16495	<desc>Solaris audio (Solaris hosts only).</desc>
16496	</const>
16497	</enum>
16498
16499	<enum
16500	name="AudioControllerType"
16501	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
16502	>
16503	<desc>
16504	Virtual audio controller type.
16505	</desc>
16506
16507	<const name="AC97" value="0"/>
16508	<const name="SB16" value="1"/>
16509	<const name="HDA" value="2"/>
16510	</enum>
16511
16512	<interface
16513	name="IAudioAdapter" extends="$unknown"
16514	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
16515	wsmap="managed"
16516	>
16517	<desc>
16518	The IAudioAdapter interface represents the virtual audio adapter of
16519	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
16520	</desc>
16521	<attribute name="enabled" type="boolean">
16522	<desc>
16523	Flag whether the audio adapter is present in the
16524	guest system. If disabled, the virtual guest hardware will
16525	not contain any audio adapter. Can only be changed when
16526	the VM is not running.
16527	</desc>
16528	</attribute>
16529	<attribute name="audioController" type="AudioControllerType">
16530	<desc>
16531	The audio hardware we emulate.
16532	</desc>
16533	</attribute>
16534	<attribute name="audioDriver" type="AudioDriverType">
16535	<desc>
16536	Audio driver the adapter is connected to. This setting
16537	can only be changed when the VM is not running.
16538	</desc>
16539	</attribute>
16540	</interface>
16541
16542	<enum
16543	name="AuthType"
16544	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
16545	>
16546	<desc>
16547	VirtualBox authentication type.
16548	</desc>
16549
16550	<const name="Null" value="0">
16551	<desc>Null value, also means "no authentication".</desc>
16552	</const>
16553	<const name="External" value="1"/>
16554	<const name="Guest" value="2"/>
16555	</enum>
16556
16557	<!--
16558	// IVRDEServer
16559	/////////////////////////////////////////////////////////////////////////
16560	-->
16561
16562	<interface
16563	name="IVRDEServer" extends="$unknown"
16564	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
16565	wsmap="managed"
16566	>
16567
16568	<attribute name="enabled" type="boolean">
16569	<desc>Flag if VRDE server is enabled.</desc>
16570	</attribute>
16571
16572	<attribute name="authType" type="AuthType">
16573	<desc>VRDE authentication method.</desc>
16574	</attribute>
16575
16576	<attribute name="authTimeout" type="unsigned long">
16577	<desc>Timeout for guest authentication. Milliseconds.</desc>
16578	</attribute>
16579
16580	<attribute name="allowMultiConnection" type="boolean">
16581	<desc>
16582	Flag whether multiple simultaneous connections to the VM are permitted.
16583	Note that this will be replaced by a more powerful mechanism in the future.
16584	</desc>
16585	</attribute>
16586
16587	<attribute name="reuseSingleConnection" type="boolean">
16588	<desc>
16589	Flag whether the existing connection must be dropped and a new connection
16590	must be established by the VRDE server, when a new client connects in single
16591	connection mode.
16592	</desc>
16593	</attribute>
16594
16595	<attribute name="VRDEExtPack" type="wstring">
16596	<desc>
16597	The name of Extension Pack providing VRDE for this VM. Overrides
16598	<link to="ISystemProperties::defaultVRDEExtPack"/>.
16599	</desc>
16600	</attribute>
16601
16602	<attribute name="authLibrary" type="wstring">
16603	<desc>
16604	Library used for authentication of RDP clients by this VM. Overrides
16605	<link to="ISystemProperties::VRDEAuthLibrary"/>.
16606	</desc>
16607	</attribute>
16608
16609	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
16610	<desc>
16611	Array of names of properties, which are supported by this VRDE server.
16612	</desc>
16613	</attribute>
16614
16615	<method name="setVRDEProperty">
16616	<desc>
16617	Sets a VRDE specific property string.
16618
16619	If you pass @c null or empty string as a key @a value, the given @a key
16620	will be deleted.
16621
16622	</desc>
16623	<param name="key" type="wstring" dir="in">
16624	<desc>Name of the key to set.</desc>
16625	</param>
16626	<param name="value" type="wstring" dir="in">
16627	<desc>Value to assign to the key.</desc>
16628	</param>
16629	</method>
16630
16631	<method name="getVRDEProperty" const="yes">
16632	<desc>
16633	Returns a VRDE specific property string.
16634
16635	If the requested data @a key does not exist, this function will
16636	succeed and return an empty string in the @a value argument.
16637
16638	</desc>
16639	<param name="key" type="wstring" dir="in">
16640	<desc>Name of the key to get.</desc>
16641	</param>
16642	<param name="value" type="wstring" dir="return">
16643	<desc>Value of the requested key.</desc>
16644	</param>
16645	</method>
16646
16647	</interface>
16648
16649
16650	<!--
16651	// ISharedFolder
16652	/////////////////////////////////////////////////////////////////////////
16653	-->
16654
16655	<interface
16656	name="ISharedFolder" extends="$unknown"
16657	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
16658	wsmap="struct"
16659	>
16660	<desc>
16661	The ISharedFolder interface represents a folder in the host computer's
16662	file system accessible from the guest OS running inside a virtual
16663	machine using an associated logical name.
16664
16665	There are three types of shared folders:
16666	<ul>
16667	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
16668	folders available to all virtual machines.</li>
16669	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
16670	VM-specific shared folders available to the given virtual machine at
16671	startup.</li>
16672	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
16673	VM-specific shared folders created in the session context (for
16674	example, when the virtual machine is running) and automatically
16675	discarded when the session is closed (the VM is powered off).</li>
16676	</ul>
16677
16678	Logical names of shared folders must be unique within the given scope
16679	(global, permanent or transient). However, they do not need to be unique
16680	across scopes. In this case, the definition of the shared folder in a
16681	more specific scope takes precedence over definitions in all other
16682	scopes. The order of precedence is (more specific to more general):
16683	<ol>
16684	<li>Transient definitions</li>
16685	<li>Permanent definitions</li>
16686	<li>Global definitions</li>
16687	</ol>
16688
16689	For example, if MyMachine has a shared folder named
16690	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
16691	transient shared folder named <tt>C_DRIVE</tt> (that points
16692	to <tt>C:\\\\WINDOWS</tt>) will change the definition
16693	of <tt>C_DRIVE</tt> in the guest OS so
16694	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
16695	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
16696	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
16697	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
16698	to <tt>C:\\</tt> if it still exists.
16699
16700	Note that permanent and transient shared folders of different machines
16701	are in different name spaces, so they don't overlap and don't need to
16702	have unique logical names.
16703
16704	<note>
16705	Global shared folders are not implemented in the current version of the
16706	product.
16707	</note>
16708	</desc>
16709
16710	<attribute name="name" type="wstring" readonly="yes">
16711	<desc>Logical name of the shared folder.</desc>
16712	</attribute>
16713
16714	<attribute name="hostPath" type="wstring" readonly="yes">
16715	<desc>Full path to the shared folder in the host file system.</desc>
16716	</attribute>
16717
16718	<attribute name="accessible" type="boolean" readonly="yes">
16719	<desc>
16720	Whether the folder defined by the host path is currently
16721	accessible or not.
16722	For example, the folder can be inaccessible if it is placed
16723	on the network share that is not available by the time
16724	this property is read.
16725	</desc>
16726	</attribute>
16727
16728	<attribute name="writable" type="boolean" readonly="yes">
16729	<desc>
16730	Whether the folder defined by the host path is writable or
16731	not.
16732	</desc>
16733	</attribute>
16734
16735	<attribute name="autoMount" type="boolean" readonly="yes">
16736	<desc>
16737	Whether the folder gets automatically mounted by the guest or not.
16738	</desc>
16739	</attribute>
16740
16741	<attribute name="lastAccessError" type="wstring" readonly="yes">
16742	<desc>
16743	Text message that represents the result of the last accessibility
16744	check.
16745
16746	Accessibility checks are performed each time the <link to="#accessible"/>
16747	attribute is read. An empty string is returned if the last
16748	accessibility check was successful. A non-empty string indicates a
16749	failure and should normally describe a reason of the failure (for
16750	example, a file read error).
16751	</desc>
16752	</attribute>
16753
16754	</interface>
16755
16756	<!--
16757	// ISession
16758	/////////////////////////////////////////////////////////////////////////
16759	-->
16760
16761	<interface
16762	name="IInternalSessionControl" extends="$unknown"
16763	uuid="0ba8d8b3-204b-448e-99c2-242eaa666ea8"
16764	internal="yes"
16765	wsmap="suppress"
16766	>
16767	<method name="getPID">
16768	<desc>PID of the process that has created this Session object.
16769	</desc>
16770	<param name="pid" type="unsigned long" dir="return"/>
16771	</method>
16772
16773	<method name="getRemoteConsole">
16774	<desc>
16775	Returns the console object suitable for remote control.
16776
16777	<result name="VBOX_E_INVALID_VM_STATE">
16778	Session state prevents operation.
16779	</result>
16780	<result name="VBOX_E_INVALID_OBJECT_STATE">
16781	Session type prevents operation.
16782	</result>
16783
16784	</desc>
16785	<param name="console" type="IConsole" dir="return"/>
16786	</method>
16787
16788	<method name="assignMachine">
16789	<desc>
16790	Assigns the machine object associated with this direct-type
16791	session or informs the session that it will be a remote one
16792	(if @a machine == @c null).
16793
16794	<result name="VBOX_E_INVALID_VM_STATE">
16795	Session state prevents operation.
16796	</result>
16797	<result name="VBOX_E_INVALID_OBJECT_STATE">
16798	Session type prevents operation.
16799	</result>
16800
16801	</desc>
16802	<param name="machine" type="IMachine" dir="in"/>
16803	<param name="lockType" type="LockType" dir="in"/>
16804	</method>
16805
16806	<method name="assignRemoteMachine">
16807	<desc>
16808	Assigns the machine and the (remote) console object associated with
16809	this remote-type session.
16810
16811	<result name="VBOX_E_INVALID_VM_STATE">
16812	Session state prevents operation.
16813	</result>
16814
16815	</desc>
16816	<param name="machine" type="IMachine" dir="in"/>
16817	<param name="console" type="IConsole" dir="in"/>
16818	</method>
16819
16820	<method name="updateMachineState">
16821	<desc>
16822	Updates the machine state in the VM process.
16823	Must be called only in certain cases
16824	(see the method implementation).
16825
16826	<result name="VBOX_E_INVALID_VM_STATE">
16827	Session state prevents operation.
16828	</result>
16829	<result name="VBOX_E_INVALID_OBJECT_STATE">
16830	Session type prevents operation.
16831	</result>
16832
16833	</desc>
16834	<param name="machineState" type="MachineState" dir="in"/>
16835	</method>
16836
16837	<method name="uninitialize">
16838	<desc>
16839	Uninitializes (closes) this session. Used by VirtualBox to close
16840	the corresponding remote session when the direct session dies
16841	or gets closed.
16842
16843	<result name="VBOX_E_INVALID_VM_STATE">
16844	Session state prevents operation.
16845	</result>
16846
16847	</desc>
16848	</method>
16849
16850	<method name="onNetworkAdapterChange">
16851	<desc>
16852	Triggered when settings of a network adapter of the
16853	associated virtual machine have changed.
16854
16855	<result name="VBOX_E_INVALID_VM_STATE">
16856	Session state prevents operation.
16857	</result>
16858	<result name="VBOX_E_INVALID_OBJECT_STATE">
16859	Session type prevents operation.
16860	</result>
16861
16862	</desc>
16863	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
16864	<param name="changeAdapter" type="boolean" dir="in"/>
16865	</method>
16866
16867	<method name="onSerialPortChange">
16868	<desc>
16869	Triggered when settings of a serial port of the
16870	associated virtual machine have changed.
16871
16872	<result name="VBOX_E_INVALID_VM_STATE">
16873	Session state prevents operation.
16874	</result>
16875	<result name="VBOX_E_INVALID_OBJECT_STATE">
16876	Session type prevents operation.
16877	</result>
16878
16879	</desc>
16880	<param name="serialPort" type="ISerialPort" dir="in"/>
16881	</method>
16882
16883	<method name="onParallelPortChange">
16884	<desc>
16885	Triggered when settings of a parallel port of the
16886	associated virtual machine have changed.
16887
16888	<result name="VBOX_E_INVALID_VM_STATE">
16889	Session state prevents operation.
16890	</result>
16891	<result name="VBOX_E_INVALID_OBJECT_STATE">
16892	Session type prevents operation.
16893	</result>
16894
16895	</desc>
16896	<param name="parallelPort" type="IParallelPort" dir="in"/>
16897	</method>
16898
16899	<method name="onStorageControllerChange">
16900	<desc>
16901	Triggered when settings of a storage controller of the
16902	associated virtual machine have changed.
16903
16904	<result name="VBOX_E_INVALID_VM_STATE">
16905	Session state prevents operation.
16906	</result>
16907	<result name="VBOX_E_INVALID_OBJECT_STATE">
16908	Session type prevents operation.
16909	</result>
16910
16911	</desc>
16912	</method>
16913
16914	<method name="onMediumChange">
16915	<desc>
16916	Triggered when attached media of the
16917	associated virtual machine have changed.
16918
16919	<result name="VBOX_E_INVALID_VM_STATE">
16920	Session state prevents operation.
16921	</result>
16922	<result name="VBOX_E_INVALID_OBJECT_STATE">
16923	Session type prevents operation.
16924	</result>
16925
16926	</desc>
16927
16928	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16929	<desc>The medium attachment which changed.</desc>
16930	</param>
16931	<param name="force" type="boolean" dir="in">
16932	<desc>If the medium change was forced.</desc>
16933	</param>
16934	</method>
16935
16936	<method name="onStorageDeviceChange">
16937	<desc>
16938	Triggered when attached storage devices of the
16939	associated virtual machine have changed.
16940
16941	<result name="VBOX_E_INVALID_VM_STATE">
16942	Session state prevents operation.
16943	</result>
16944	<result name="VBOX_E_INVALID_OBJECT_STATE">
16945	Session type prevents operation.
16946	</result>
16947
16948	</desc>
16949
16950	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16951	<desc>The medium attachment which changed.</desc>
16952	</param>
16953	<param name="remove" type="boolean" dir="in">
16954	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
16955	</param>
16956	<param name="silent" type="boolean" dir="in">
16957	<desc>TRUE if the device is is silently reconfigured without
16958	notifying the guest about it.</desc>
16959	</param>
16960	</method>
16961
16962	<method name="onClipboardModeChange">
16963	<desc>
16964	Notification when the shared clipboard mode changes.
16965	</desc>
16966	<param name="clipboardMode" type="ClipboardMode" dir="in">
16967	<desc>The new shared clipboard mode.</desc>
16968	</param>
16969	</method>
16970
16971	<method name="onDragAndDropModeChange">
16972	<desc>
16973	Notification when the drag'n'drop mode changes.
16974	</desc>
16975	<param name="dragAndDropMode" type="DragAndDropMode" dir="in">
16976	<desc>The new mode for drag'n'drop.</desc>
16977	</param>
16978	</method>
16979
16980	<method name="onCPUChange">
16981	<desc>
16982	Notification when a CPU changes.
16983	</desc>
16984	<param name="cpu" type="unsigned long" dir="in">
16985	<desc>The CPU which changed</desc>
16986	</param>
16987	<param name="add" type="boolean" dir="in">
16988	<desc>Flag whether the CPU was added or removed</desc>
16989	</param>
16990	</method>
16991
16992	<method name="onCPUExecutionCapChange">
16993	<desc>
16994	Notification when the CPU execution cap changes.
16995	</desc>
16996	<param name="executionCap" type="unsigned long" dir="in">
16997	<desc>The new CPU execution cap value. (1-100)</desc>
16998	</param>
16999	</method>
17000
17001	<method name="onVRDEServerChange">
17002	<desc>
17003	Triggered when settings of the VRDE server object of the
17004	associated virtual machine have changed.
17005
17006	<result name="VBOX_E_INVALID_VM_STATE">
17007	Session state prevents operation.
17008	</result>
17009	<result name="VBOX_E_INVALID_OBJECT_STATE">
17010	Session type prevents operation.
17011	</result>
17012
17013	</desc>
17014	<param name="restart" type="boolean" dir="in">
17015	<desc>Flag whether the server must be restarted</desc>
17016	</param>
17017	</method>
17018
17019	<method name="onUSBControllerChange">
17020	<desc>
17021	Triggered when settings of the USB controller object of the
17022	associated virtual machine have changed.
17023
17024	<result name="VBOX_E_INVALID_VM_STATE">
17025	Session state prevents operation.
17026	</result>
17027	<result name="VBOX_E_INVALID_OBJECT_STATE">
17028	Session type prevents operation.
17029	</result>
17030
17031	</desc>
17032	</method>
17033
17034	<method name="onSharedFolderChange">
17035	<desc>
17036	Triggered when a permanent (global or machine) shared folder has been
17037	created or removed.
17038	<note>
17039	We don't pass shared folder parameters in this notification because
17040	the order in which parallel notifications are delivered is not defined,
17041	therefore it could happen that these parameters were outdated by the
17042	time of processing this notification.
17043	</note>
17044
17045	<result name="VBOX_E_INVALID_VM_STATE">
17046	Session state prevents operation.
17047	</result>
17048	<result name="VBOX_E_INVALID_OBJECT_STATE">
17049	Session type prevents operation.
17050	</result>
17051
17052	</desc>
17053	<param name="global" type="boolean" dir="in"/>
17054	</method>
17055
17056	<method name="onUSBDeviceAttach">
17057	<desc>
17058	Triggered when a request to capture a USB device (as a result
17059	of matched USB filters or direct call to
17060	<link to="IConsole::attachUSBDevice"/>) has completed.
17061	A @c null @a error object means success, otherwise it
17062	describes a failure.
17063
17064	<result name="VBOX_E_INVALID_VM_STATE">
17065	Session state prevents operation.
17066	</result>
17067	<result name="VBOX_E_INVALID_OBJECT_STATE">
17068	Session type prevents operation.
17069	</result>
17070
17071	</desc>
17072	<param name="device" type="IUSBDevice" dir="in"/>
17073	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
17074	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
17075	</method>
17076
17077	<method name="onUSBDeviceDetach">
17078	<desc>
17079	Triggered when a request to release the USB device (as a result
17080	of machine termination or direct call to
17081	<link to="IConsole::detachUSBDevice"/>) has completed.
17082	A @c null @a error object means success, otherwise it
17083	describes a failure.
17084
17085	<result name="VBOX_E_INVALID_VM_STATE">
17086	Session state prevents operation.
17087	</result>
17088	<result name="VBOX_E_INVALID_OBJECT_STATE">
17089	Session type prevents operation.
17090	</result>
17091
17092	</desc>
17093	<param name="id" type="uuid" mod="string" dir="in"/>
17094	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
17095	</method>
17096
17097	<method name="onShowWindow">
17098	<desc>
17099	Called by <link to="IMachine::canShowConsoleWindow"/> and by
17100	<link to="IMachine::showConsoleWindow"/> in order to notify
17101	console listeners
17102	<link to="ICanShowWindowEvent"/>
17103	and <link to="IShowWindowEvent"/>.
17104
17105	<result name="VBOX_E_INVALID_OBJECT_STATE">
17106	Session type prevents operation.
17107	</result>
17108
17109	</desc>
17110	<param name="check" type="boolean" dir="in"/>
17111	<param name="canShow" type="boolean" dir="out"/>
17112	<param name="winId" type="long long" dir="out"/>
17113	</method>
17114
17115	<method name="onBandwidthGroupChange">
17116	<desc>
17117	Notification when one of the bandwidth groups change.
17118	</desc>
17119	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
17120	<desc>The bandwidth group which changed.</desc>
17121	</param>
17122	</method>
17123
17124	<method name="accessGuestProperty">
17125	<desc>
17126	Called by <link to="IMachine::getGuestProperty"/> and by
17127	<link to="IMachine::setGuestProperty"/> in order to read and
17128	modify guest properties.
17129
17130	<result name="VBOX_E_INVALID_VM_STATE">
17131	Machine session is not open.
17132	</result>
17133	<result name="VBOX_E_INVALID_OBJECT_STATE">
17134	Session type is not direct.
17135	</result>
17136
17137	</desc>
17138	<param name="name" type="wstring" dir="in"/>
17139	<param name="value" type="wstring" dir="in"/>
17140	<param name="flags" type="wstring" dir="in"/>
17141	<param name="isSetter" type="boolean" dir="in"/>
17142	<param name="retValue" type="wstring" dir="out"/>
17143	<param name="retTimestamp" type="long long" dir="out"/>
17144	<param name="retFlags" type="wstring" dir="out"/>
17145	</method>
17146
17147	<method name="enumerateGuestProperties" const="yes">
17148	<desc>
17149	Return a list of the guest properties matching a set of patterns along
17150	with their values, time stamps and flags.
17151
17152	<result name="VBOX_E_INVALID_VM_STATE">
17153	Machine session is not open.
17154	</result>
17155	<result name="VBOX_E_INVALID_OBJECT_STATE">
17156	Session type is not direct.
17157	</result>
17158
17159	</desc>
17160	<param name="patterns" type="wstring" dir="in">
17161	<desc>
17162	The patterns to match the properties against as a comma-separated
17163	string. If this is empty, all properties currently set will be
17164	returned.
17165	</desc>
17166	</param>
17167	<param name="keys" type="wstring" dir="out" safearray="yes">
17168	<desc>
17169	The key names of the properties returned.
17170	</desc>
17171	</param>
17172	<param name="values" type="wstring" dir="out" safearray="yes">
17173	<desc>
17174	The values of the properties returned. The array entries match the
17175	corresponding entries in the @a key array.
17176	</desc>
17177	</param>
17178	<param name="timestamps" type="long long" dir="out" safearray="yes">
17179	<desc>
17180	The time stamps of the properties returned. The array entries match
17181	the corresponding entries in the @a key array.
17182	</desc>
17183	</param>
17184	<param name="flags" type="wstring" dir="out" safearray="yes">
17185	<desc>
17186	The flags of the properties returned. The array entries match the
17187	corresponding entries in the @a key array.
17188	</desc>
17189	</param>
17190	</method>
17191
17192	<method name="onlineMergeMedium">
17193	<desc>
17194	Triggers online merging of a hard disk. Used internally when deleting
17195	a snapshot while a VM referring to the same hard disk chain is running.
17196
17197	<result name="VBOX_E_INVALID_VM_STATE">
17198	Machine session is not open.
17199	</result>
17200	<result name="VBOX_E_INVALID_OBJECT_STATE">
17201	Session type is not direct.
17202	</result>
17203
17204	</desc>
17205	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
17206	<desc>The medium attachment to identify the medium chain.</desc>
17207	</param>
17208	<param name="sourceIdx" type="unsigned long" dir="in">
17209	<desc>The index of the source image in the chain.
17210	Redundant, but drastically reduces IPC.</desc>
17211	</param>
17212	<param name="targetIdx" type="unsigned long" dir="in">
17213	<desc>The index of the target image in the chain.
17214	Redundant, but drastically reduces IPC.</desc>
17215	</param>
17216	<param name="source" type="IMedium" dir="in">
17217	<desc>Merge source medium.</desc>
17218	</param>
17219	<param name="target" type="IMedium" dir="in">
17220	<desc>Merge target medium.</desc>
17221	</param>
17222	<param name="mergeForward" type="boolean" dir="in">
17223	<desc>Merge direction.</desc>
17224	</param>
17225	<param name="parentForTarget" type="IMedium" dir="in">
17226	<desc>For forward merges: new parent for target medium.</desc>
17227	</param>
17228	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
17229	<desc>For backward merges: list of media which need their parent UUID
17230	updated.</desc>
17231	</param>
17232	<param name="progress" type="IProgress" dir="in">
17233	<desc>
17234	Progress object for this operation.
17235	</desc>
17236	</param>
17237	</method>
17238
17239	<method name="enableVMMStatistics">
17240	<desc>
17241	Enables or disables collection of VMM RAM statistics.
17242
17243	<result name="VBOX_E_INVALID_VM_STATE">
17244	Machine session is not open.
17245	</result>
17246	<result name="VBOX_E_INVALID_OBJECT_STATE">
17247	Session type is not direct.
17248	</result>
17249
17250	</desc>
17251	<param name="enable" type="boolean" dir="in">
17252	<desc>True enables statistics collection.</desc>
17253	</param>
17254	</method>
17255
17256	</interface>
17257
17258	<interface
17259	name="ISession" extends="$unknown"
17260	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
17261	wsmap="managed"
17262	>
17263	<desc>
17264	The ISession interface represents a client process and allows for locking
17265	virtual machines (represented by IMachine objects) to prevent conflicting
17266	changes to the machine.
17267
17268	Any caller wishing to manipulate a virtual machine needs to create a session
17269	object first, which lives in its own process space. Such session objects are
17270	then associated with <link to="IMachine" /> objects living in the VirtualBox
17271	server process to coordinate such changes.
17272
17273	There are two typical scenarios in which sessions are used:
17274
17275	<ul>
17276	<li>To alter machine settings or control a running virtual machine, one
17277	needs to lock a machine for a given session (client process) by calling
17278	<link to="IMachine::lockMachine"/>.
17279
17280	Whereas multiple sessions may control a running virtual machine, only
17281	one process can obtain a write lock on the machine to prevent conflicting
17282	changes. A write lock is also needed if a process wants to actually run a
17283	virtual machine in its own context, such as the VirtualBox GUI or
17284	VBoxHeadless front-ends. They must also lock a machine for their own
17285	sessions before they are allowed to power up the virtual machine.
17286
17287	As a result, no machine settings can be altered while another process is
17288	already using it, either because that process is modifying machine settings
17289	or because the machine is running.
17290	</li>
17291	<li>
17292	To start a VM using one of the existing VirtualBox front-ends (e.g. the
17293	VirtualBox GUI or VBoxHeadless), one would use
17294	<link to="IMachine::launchVMProcess"/>, which also takes a session object
17295	as its first parameter. This session then identifies the caller and lets the
17296	caller control the started machine (for example, pause machine execution or
17297	power it down) as well as be notified about machine execution state changes.
17298	</li>
17299	</ul>
17300
17301	How sessions objects are created in a client process depends on whether you use
17302	the Main API via COM or via the webservice:
17303
17304	<ul>
17305	<li>When using the COM API directly, an object of the Session class from the
17306	VirtualBox type library needs to be created. In regular COM C++ client code,
17307	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
17308	This object will then act as a local session object in further calls to open
17309	a session.
17310	</li>
17311
17312	<li>In the webservice, the session manager (IWebsessionManager) instead creates
17313	a session object automatically whenever <link to="IWebsessionManager::logon" />
17314	is called. A managed object reference to that session object can be retrieved by
17315	calling <link to="IWebsessionManager::getSessionObject" />.
17316	</li>
17317	</ul>
17318	</desc>
17319
17320	<attribute name="state" type="SessionState" readonly="yes">
17321	<desc>Current state of this session.</desc>
17322	</attribute>
17323
17324	<attribute name="type" type="SessionType" readonly="yes">
17325	<desc>
17326	Type of this session. The value of this attribute is valid only
17327	if the session currently has a machine locked (i.e. its
17328	<link to="#state" /> is Locked), otherwise an error will be returned.
17329	</desc>
17330	</attribute>
17331
17332	<attribute name="machine" type="IMachine" readonly="yes">
17333	<desc>Machine object associated with this session.</desc>
17334	</attribute>
17335
17336	<attribute name="console" type="IConsole" readonly="yes">
17337	<desc>Console object associated with this session.</desc>
17338	</attribute>
17339
17340	<method name="unlockMachine">
17341	<desc>
17342	Unlocks a machine that was previously locked for the current session.
17343
17344	Calling this method is required every time a machine has been locked
17345	for a particular session using the <link to="IMachine::launchVMProcess" />
17346	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
17347	the machine will be set to <link to="MachineState_Aborted" /> on the
17348	server, and changes made to the machine settings will be lost.
17349
17350	Generally, it is recommended to unlock all machines explicitly
17351	before terminating the application (regardless of the reason for
17352	the termination).
17353
17354	<note>
17355	Do not expect the session state (<link to="ISession::state" />
17356	to return to "Unlocked" immediately after you invoke this method,
17357	particularly if you have started a new VM process. The session
17358	state will automatically return to "Unlocked" once the VM is no
17359	longer executing, which can of course take a very long time.
17360	</note>
17361
17362	<result name="E_UNEXPECTED">
17363	Session is not locked.
17364	</result>
17365
17366	</desc>
17367	</method>
17368
17369	</interface>
17370
17371	<!--
17372	// IStorageController
17373	/////////////////////////////////////////////////////////////////////////
17374	-->
17375
17376	<enum
17377	name="StorageBus"
17378	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
17379	>
17380	<desc>
17381	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
17382	see <link to="IStorageController::bus" />.
17383	</desc>
17384	<const name="Null" value="0">
17385	<desc>@c null value. Never used by the API.</desc>
17386	</const>
17387	<const name="IDE" value="1"/>
17388	<const name="SATA" value="2"/>
17389	<const name="SCSI" value="3"/>
17390	<const name="Floppy" value="4"/>
17391	<const name="SAS" value="5"/>
17392	</enum>
17393
17394	<enum
17395	name="StorageControllerType"
17396	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
17397	>
17398	<desc>
17399	The exact variant of storage controller hardware presented
17400	to the guest; see <link to="IStorageController::controllerType" />.
17401	</desc>
17402
17403	<const name="Null" value="0">
17404	<desc>@c null value. Never used by the API.</desc>
17405	</const>
17406	<const name="LsiLogic" value="1">
17407	<desc>A SCSI controller of the LsiLogic variant.</desc>
17408	</const>
17409	<const name="BusLogic" value="2">
17410	<desc>A SCSI controller of the BusLogic variant.</desc>
17411	</const>
17412	<const name="IntelAhci" value="3">
17413	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
17414	</const>
17415	<const name="PIIX3" value="4">
17416	<desc>An IDE controller of the PIIX3 variant.</desc>
17417	</const>
17418	<const name="PIIX4" value="5">
17419	<desc>An IDE controller of the PIIX4 variant.</desc>
17420	</const>
17421	<const name="ICH6" value="6">
17422	<desc>An IDE controller of the ICH6 variant.</desc>
17423	</const>
17424	<const name="I82078" value="7">
17425	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
17426	</const>
17427	<const name="LsiLogicSas" value="8">
17428	<desc>A variant of the LsiLogic controller using SAS.</desc>
17429	</const>
17430	</enum>
17431
17432	<enum
17433	name="ChipsetType"
17434	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
17435	>
17436	<desc>
17437	Type of emulated chipset (mostly southbridge).
17438	</desc>
17439
17440	<const name="Null" value="0">
17441	<desc>@c null value. Never used by the API.</desc>
17442	</const>
17443	<const name="PIIX3" value="1">
17444	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
17445	</const>
17446	<const name="ICH9" value="2">
17447	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
17448	</const>
17449	</enum>
17450
17451	<interface
17452	name="IStorageController" extends="$unknown"
17453	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
17454	wsmap="managed"
17455	>
17456	<desc>
17457	Represents a storage controller that is attached to a virtual machine
17458	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
17459	attached to storage controllers in a real computer, virtual drives
17460	(represented by <link to="IMediumAttachment" />) are attached to virtual
17461	storage controllers, represented by this interface.
17462
17463	As opposed to physical hardware, VirtualBox has a very generic concept
17464	of a storage controller, and for purposes of the Main API, all virtual
17465	storage is attached to virtual machines via instances of this interface.
17466	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
17467	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
17468	is used, certain sub-types may be available and can be selected in
17469	<link to="#controllerType" />.
17470
17471	Depending on these settings, the guest operating system might see
17472	significantly different virtual hardware.
17473	</desc>
17474
17475	<attribute name="name" type="wstring" readonly="yes">
17476	<desc>
17477	Name of the storage controller, as originally specified with
17478	<link to="IMachine::addStorageController" />. This then uniquely
17479	identifies this controller with other method calls such as
17480	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
17481	</desc>
17482	</attribute>
17483
17484	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
17485	<desc>
17486	Maximum number of devices which can be attached to one port.
17487	</desc>
17488	</attribute>
17489
17490	<attribute name="minPortCount" type="unsigned long" readonly="yes">
17491	<desc>
17492	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
17493	</desc>
17494	</attribute>
17495
17496	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
17497	<desc>
17498	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
17499	</desc>
17500	</attribute>
17501
17502	<attribute name="instance" type="unsigned long">
17503	<desc>
17504	The instance number of the device in the running VM.
17505	</desc>
17506	</attribute>
17507
17508	<attribute name="portCount" type="unsigned long">
17509	<desc>
17510	The number of currently usable ports on the controller.
17511	The minimum and maximum number of ports for one controller are
17512	stored in <link to="IStorageController::minPortCount"/>
17513	and <link to="IStorageController::maxPortCount"/>.
17514	</desc>
17515	</attribute>
17516
17517	<attribute name="bus" type="StorageBus" readonly="yes">
17518	<desc>
17519	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
17520	</desc>
17521	</attribute>
17522
17523	<attribute name="controllerType" type="StorageControllerType">
17524	<desc>
17525	The exact variant of storage controller hardware presented
17526	to the guest.
17527	Depending on this value, VirtualBox will provide a different
17528	virtual storage controller hardware to the guest.
17529	For SATA, SAS and floppy controllers, only one variant is
17530	available, but for IDE and SCSI, there are several.
17531
17532	For SCSI controllers, the default type is LsiLogic.
17533	</desc>
17534	</attribute>
17535
17536	<attribute name="useHostIOCache" type="boolean">
17537	<desc>
17538	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
17539	caches and use synchronous file APIs on the host. This was the only option in the API before
17540	VirtualBox 3.2 and is still the default for IDE controllers.
17541
17542	If false, the host I/O cache will be disabled for image files attached to this storage controller.
17543	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
17544	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
17545	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
17546	virtual machines are running at the same time to prevent I/O cache related hangs.
17547	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
17548	</desc>
17549	</attribute>
17550
17551	<attribute name="bootable" type="boolean" readonly="yes">
17552	<desc>
17553	Returns whether it is possible to boot from disks attached to this controller.
17554	</desc>
17555	</attribute>
17556	</interface>
17557
17558	<if target="wsdl">
17559
17560	<!--
17561	// IManagedObjectRef
17562	/////////////////////////////////////////////////////////////////////////
17563	-->
17564
17565	<interface
17566	name="IManagedObjectRef" extends="$unknown"
17567	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
17568	internal="yes"
17569	wsmap="managed"
17570	wscpp="hardcoded"
17571	>
17572	<desc>
17573	Managed object reference.
17574
17575	Only within the webservice, a managed object reference (which is really
17576	an opaque number) allows a webservice client to address an object
17577	that lives in the address space of the webservice server.
17578
17579	Behind each managed object reference, there is a COM object that lives
17580	in the webservice server's address space. The COM object is not freed
17581	until the managed object reference is released, either by an explicit
17582	call to <link to="IManagedObjectRef::release" /> or by logging off from
17583	the webservice (<link to="IWebsessionManager::logoff" />), which releases
17584	all objects created during the webservice session.
17585
17586	Whenever a method call of the VirtualBox API returns a COM object, the
17587	webservice representation of that method will instead return a
17588	managed object reference, which can then be used to invoke methods
17589	on that object.
17590	</desc>
17591
17592	<method name="getInterfaceName">
17593	<desc>
17594	Returns the name of the interface that this managed object represents,
17595	for example, "IMachine", as a string.
17596	</desc>
17597	<param name="return" type="wstring" dir="return"/>
17598	</method>
17599
17600	<method name="release">
17601	<desc>
17602	Releases this managed object reference and frees the resources that
17603	were allocated for it in the webservice server process. After calling
17604	this method, the identifier of the reference can no longer be used.
17605	</desc>
17606	</method>
17607
17608	</interface>
17609
17610	<!--
17611	// IWebsessionManager
17612	/////////////////////////////////////////////////////////////////////////
17613	-->
17614
17615	<interface
17616	name="IWebsessionManager" extends="$unknown"
17617	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
17618	internal="yes"
17619	wsmap="global"
17620	wscpp="hardcoded"
17621	>
17622	<desc>
17623	Websession manager. This provides essential services
17624	to webservice clients.
17625	</desc>
17626	<method name="logon">
17627	<desc>
17628	Logs a new client onto the webservice and returns a managed object reference to
17629	the IVirtualBox instance, which the client can then use as a basis to further
17630	queries, since all calls to the VirtualBox API are based on the IVirtualBox
17631	interface, in one way or the other.
17632	</desc>
17633	<param name="username" type="wstring" dir="in"/>
17634	<param name="password" type="wstring" dir="in"/>
17635	<param name="return" type="IVirtualBox" dir="return"/>
17636	</method>
17637
17638	<method name="getSessionObject">
17639	<desc>
17640	Returns a managed object reference to the internal ISession object that was created
17641	for this web service session when the client logged on.
17642
17643	<see><link to="ISession"/></see>
17644	</desc>
17645	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17646	<param name="return" type="ISession" dir="return"/>
17647	</method>
17648
17649	<method name="logoff">
17650	<desc>
17651	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
17652	and destroys all resources associated with the session (most importantly, all
17653	managed objects created in the server while the session was active).
17654	</desc>
17655	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17656	</method>
17657
17658	</interface>
17659
17660	</if>
17661
17662	<!--
17663	// IPerformanceCollector & friends
17664	/////////////////////////////////////////////////////////////////////////
17665	-->
17666
17667	<interface
17668	name="IPerformanceMetric" extends="$unknown"
17669	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
17670	>
17671	<desc>
17672	The IPerformanceMetric interface represents parameters of the given
17673	performance metric.
17674	</desc>
17675
17676	<attribute name="metricName" type="wstring" readonly="yes">
17677	<desc>
17678	Name of the metric.
17679	</desc>
17680	</attribute>
17681
17682	<attribute name="object" type="$unknown" readonly="yes">
17683	<desc>
17684	Object this metric belongs to.
17685	</desc>
17686	</attribute>
17687
17688	<attribute name="description" type="wstring" readonly="yes">
17689	<desc>
17690	Textual description of the metric.
17691	</desc>
17692	</attribute>
17693
17694	<attribute name="period" type="unsigned long" readonly="yes">
17695	<desc>
17696	Time interval between samples, measured in seconds.
17697	</desc>
17698	</attribute>
17699
17700	<attribute name="count" type="unsigned long" readonly="yes">
17701	<desc>
17702	Number of recent samples retained by the performance collector for this
17703	metric.
17704
17705	When the collected sample count exceeds this number, older samples
17706	are discarded.
17707	</desc>
17708	</attribute>
17709
17710	<attribute name="unit" type="wstring" readonly="yes">
17711	<desc>
17712	Unit of measurement.
17713	</desc>
17714	</attribute>
17715
17716	<attribute name="minimumValue" type="long" readonly="yes">
17717	<desc>
17718	Minimum possible value of this metric.
17719	</desc>
17720	</attribute>
17721
17722	<attribute name="maximumValue" type="long" readonly="yes">
17723	<desc>
17724	Maximum possible value of this metric.
17725	</desc>
17726	</attribute>
17727	</interface>
17728
17729	<interface
17730	name="IPerformanceCollector" extends="$unknown"
17731	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
17732	wsmap="managed"
17733	>
17734	<desc>
17735	The IPerformanceCollector interface represents a service that collects
17736	and stores performance metrics data.
17737
17738	Performance metrics are associated with objects of interfaces like IHost
17739	and IMachine. Each object has a distinct set of performance metrics. The
17740	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
17741
17742	Metric data is collected at the specified intervals and is retained
17743	internally. The interval and the number of retained samples can be set
17744	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
17745	and collection settings are not persistent, they are discarded as soon as
17746	VBoxSVC process terminates. Moreover, metric settings and data associated
17747	with a particular VM only exist while VM is running. They disappear as
17748	soon as VM shuts down. It is not possible to set up metrics for machines
17749	that are powered off. One needs to start VM first, then set up metric
17750	collection parameters.
17751
17752	Metrics are organized hierarchically, with each level separated by a
17753	slash (/) character. Generally, the scheme for metric names is like this:
17754
17755	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
17756
17757	"Category/Metric" together form the base metric name. A base metric is
17758	the smallest unit for which a sampling interval and the number of
17759	retained samples can be set. Only base metrics can be enabled and
17760	disabled. All sub-metrics are collected when their base metric is
17761	collected. Collected values for any set of sub-metrics can be queried
17762	with <link to="IPerformanceCollector::queryMetricsData" />.
17763
17764	For example "CPU/Load/User:avg" metric name stands for the "CPU"
17765	category, "Load" metric, "User" submetric, "average" aggregate. An
17766	aggregate function is computed over all retained data. Valid aggregate
17767	functions are:
17768
17769	<ul>
17770	<li>avg -- average</li>
17771	<li>min -- minimum</li>
17772	<li>max -- maximum</li>
17773	</ul>
17774
17775	When setting up metric parameters, querying metric data, enabling or
17776	disabling metrics wildcards can be used in metric names to specify a
17777	subset of metrics. For example, to select all CPU-related metrics
17778	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
17779	so on. To query metric values without aggregates <tt>*:</tt> can be used.
17780
17781	The valid names for base metrics are:
17782
17783	<ul>
17784	<li>CPU/Load</li>
17785	<li>CPU/MHz</li>
17786	<li>RAM/Usage</li>
17787	<li>RAM/VMM</li>
17788	</ul>
17789
17790	The general sequence for collecting and retrieving the metrics is:
17791	<ul>
17792	<li>
17793	Obtain an instance of IPerformanceCollector with
17794	<link to="IVirtualBox::performanceCollector" />
17795	</li>
17796	<li>
17797	Allocate and populate an array with references to objects the metrics
17798	will be collected for. Use references to IHost and IMachine objects.
17799	</li>
17800	<li>
17801	Allocate and populate an array with base metric names the data will
17802	be collected for.
17803	</li>
17804	<li>
17805	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
17806	the metric data will be collected and stored.
17807	</li>
17808	<li>
17809	Wait for the data to get collected.
17810	</li>
17811	<li>
17812	Allocate and populate an array with references to objects the metric
17813	values will be queried for. You can re-use the object array used for
17814	setting base metrics.
17815	</li>
17816	<li>
17817	Allocate and populate an array with metric names the data will be
17818	collected for. Note that metric names differ from base metric names.
17819	</li>
17820	<li>
17821	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
17822	that have been collected so far are returned. Note that the values
17823	are still retained internally and data collection continues.
17824	</li>
17825	</ul>
17826
17827	For an example of usage refer to the following files in VirtualBox SDK:
17828	<ul>
17829	<li>
17830	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
17831	</li>
17832	<li>
17833	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
17834	</li>
17835	</ul>
17836	</desc>
17837
17838	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
17839	<desc>
17840	Array of unique names of metrics.
17841
17842	This array represents all metrics supported by the performance
17843	collector. Individual objects do not necessarily support all of them.
17844	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
17845	list of supported metrics for a particular object.
17846	</desc>
17847	</attribute>
17848
17849	<method name="getMetrics">
17850	<desc>
17851	Returns parameters of specified metrics for a set of objects.
17852	<note>
17853	@c Null metrics array means all metrics. @c Null object array means
17854	all existing objects.
17855	</note>
17856	</desc>
17857	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17858	<desc>
17859	Metric name filter. Currently, only a comma-separated list of metrics
17860	is supported.
17861	</desc>
17862	</param>
17863	<param name="objects" type="$unknown" dir="in" safearray="yes">
17864	<desc>
17865	Set of objects to return metric parameters for.
17866	</desc>
17867	</param>
17868	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
17869	<desc>
17870	Array of returned metric parameters.
17871	</desc>
17872	</param>
17873	</method>
17874
17875	<method name="setupMetrics">
17876	<desc>
17877	Sets parameters of specified base metrics for a set of objects. Returns
17878	an array of <link to="IPerformanceMetric" /> describing the metrics
17879	have been affected.
17880	<note>
17881	@c Null or empty metric name array means all metrics. @c Null or
17882	empty object array means all existing objects. If metric name array
17883	contains a single element and object array contains many, the single
17884	metric name array element is applied to each object array element to
17885	form metric/object pairs.
17886	</note>
17887	</desc>
17888	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17889	<desc>
17890	Metric name filter. Comma-separated list of metrics with wildcard
17891	support.
17892	</desc>
17893	</param>
17894	<param name="objects" type="$unknown" dir="in" safearray="yes">
17895	<desc>
17896	Set of objects to setup metric parameters for.
17897	</desc>
17898	</param>
17899	<param name="period" type="unsigned long" dir="in">
17900	<desc>
17901	Time interval in seconds between two consecutive samples of
17902	performance data.
17903	</desc>
17904	</param>
17905	<param name="count" type="unsigned long" dir="in">
17906	<desc>
17907	Number of samples to retain in performance data history. Older
17908	samples get discarded.
17909	</desc>
17910	</param>
17911	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17912	<desc>
17913	Array of metrics that have been modified by the call to this method.
17914	</desc>
17915	</param>
17916	</method>
17917
17918	<method name="enableMetrics">
17919	<desc>
17920	Turns on collecting specified base metrics. Returns an array of
17921	<link to="IPerformanceMetric" /> describing the metrics have been
17922	affected.
17923	<note>
17924	@c Null or empty metric name array means all metrics. @c Null or
17925	empty object array means all existing objects. If metric name array
17926	contains a single element and object array contains many, the single
17927	metric name array element is applied to each object array element to
17928	form metric/object pairs.
17929	</note>
17930	</desc>
17931	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17932	<desc>
17933	Metric name filter. Comma-separated list of metrics with wildcard
17934	support.
17935	</desc>
17936	</param>
17937	<param name="objects" type="$unknown" dir="in" safearray="yes">
17938	<desc>
17939	Set of objects to enable metrics for.
17940	</desc>
17941	</param>
17942	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17943	<desc>
17944	Array of metrics that have been modified by the call to this method.
17945	</desc>
17946	</param>
17947	</method>
17948
17949	<method name="disableMetrics">
17950	<desc>
17951	Turns off collecting specified base metrics. Returns an array of
17952	<link to="IPerformanceMetric" /> describing the metrics have been
17953	affected.
17954	<note>
17955	@c Null or empty metric name array means all metrics. @c Null or
17956	empty object array means all existing objects. If metric name array
17957	contains a single element and object array contains many, the single
17958	metric name array element is applied to each object array element to
17959	form metric/object pairs.
17960	</note>
17961	</desc>
17962	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17963	<desc>
17964	Metric name filter. Comma-separated list of metrics with wildcard
17965	support.
17966	</desc>
17967	</param>
17968	<param name="objects" type="$unknown" dir="in" safearray="yes">
17969	<desc>
17970	Set of objects to disable metrics for.
17971	</desc>
17972	</param>
17973	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17974	<desc>
17975	Array of metrics that have been modified by the call to this method.
17976	</desc>
17977	</param>
17978	</method>
17979
17980	<method name="queryMetricsData">
17981	<desc>
17982	Queries collected metrics data for a set of objects.
17983
17984	The data itself and related metric information are returned in seven
17985	parallel and one flattened array of arrays. Elements of
17986	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
17987	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
17988	the same index describe one set of values corresponding to a single
17989	metric.
17990
17991	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
17992	start and length of a sub-array is indicated by
17993	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
17994	value for metric <tt>metricNames[i]</tt> is at
17995	<tt>returnData[returnIndices[i]]</tt>.
17996
17997	<note>
17998	@c Null or empty metric name array means all metrics. @c Null or
17999	empty object array means all existing objects. If metric name array
18000	contains a single element and object array contains many, the single
18001	metric name array element is applied to each object array element to
18002	form metric/object pairs.
18003	</note>
18004	<note>
18005	Data collection continues behind the scenes after call to @c
18006	queryMetricsData. The return data can be seen as the snapshot of the
18007	current state at the time of @c queryMetricsData call. The internally
18008	kept metric values are not cleared by the call. This makes possible
18009	querying different subsets of metrics or aggregates with subsequent
18010	calls. If periodic querying is needed it is highly suggested to query
18011	the values with @c interval*count period to avoid confusion. This way
18012	a completely new set of data values will be provided by each query.
18013	</note>
18014	</desc>
18015	<param name="metricNames" type="wstring" dir="in" safearray="yes">
18016	<desc>
18017	Metric name filter. Comma-separated list of metrics with wildcard
18018	support.
18019	</desc>
18020	</param>
18021	<param name="objects" type="$unknown" dir="in" safearray="yes">
18022	<desc>
18023	Set of objects to query metrics for.
18024	</desc>
18025	</param>
18026	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
18027	<desc>
18028	Names of metrics returned in @c returnData.
18029	</desc>
18030	</param>
18031	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
18032	<desc>
18033	Objects associated with metrics returned in @c returnData.
18034	</desc>
18035	</param>
18036	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
18037	<desc>
18038	Units of measurement for each returned metric.
18039	</desc>
18040	</param>
18041	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
18042	<desc>
18043	Divisor that should be applied to return values in order to get
18044	floating point values. For example:
18045	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
18046	will retrieve the floating point value of i-th sample of the first
18047	metric.
18048	</desc>
18049	</param>
18050	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
18051	<desc>
18052	Sequence numbers of the first elements of value sequences of
18053	particular metrics returned in @c returnData. For aggregate metrics
18054	it is the sequence number of the sample the aggregate started
18055	calculation from.
18056	</desc>
18057	</param>
18058	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
18059	<desc>
18060	Indices of the first elements of value sequences of particular
18061	metrics returned in @c returnData.
18062	</desc>
18063	</param>
18064	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
18065	<desc>
18066	Lengths of value sequences of particular metrics.
18067	</desc>
18068	</param>
18069	<param name="returnData" type="long" dir="return" safearray="yes">
18070	<desc>
18071	Flattened array of all metric data containing sequences of values for
18072	each metric.
18073	</desc>
18074	</param>
18075	</method>
18076
18077	</interface>
18078
18079	<enum
18080	name="NATAliasMode"
18081	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
18082	>
18083	<desc></desc>
18084	<const name="AliasLog" value="0x1">
18085	<desc></desc>
18086	</const>
18087	<const name="AliasProxyOnly" value="0x02">
18088	<desc></desc>
18089	</const>
18090	<const name="AliasUseSamePorts" value="0x04">
18091	<desc></desc>
18092	</const>
18093	</enum>
18094
18095	<enum
18096	name="NATProtocol"
18097	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
18098	>
18099	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
18100	<const name="UDP" value="0">
18101	<desc>Port-forwarding uses UDP protocol.</desc>
18102	</const>
18103	<const name="TCP" value="1">
18104	<desc>Port-forwarding uses TCP protocol.</desc>
18105	</const>
18106	</enum>
18107
18108	<interface
18109	name="INATEngine" extends="$unknown"
18110	uuid="26451b99-3b2d-4dcb-8e4b-d63654218175"
18111	wsmap="managed"
18112	>
18113	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
18114	allows for changing NAT behavior such as port-forwarding rules. This interface is
18115	used in the <link to="INetworkAdapter::NATEngine" /> attribute.</desc>
18116	<attribute name="network" type="wstring">
18117	<desc>The network attribute of the NAT engine (the same value is used with built-in
18118	DHCP server to fill corresponding fields of DHCP leases).</desc>
18119	</attribute>
18120	<attribute name="hostIP" type="wstring">
18121	<desc>IP of host interface to bind all opened sockets to.
18122	<note>Changing this does not change binding of port forwarding.</note>
18123	</desc>
18124	</attribute>
18125	<attribute name="TFTPPrefix" type="wstring">
18126	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
18127	the corresponding fields of DHCP leases.</desc>
18128	</attribute>
18129	<attribute name="TFTPBootFile" type="wstring">
18130	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
18131	the corresponding fields of DHCP leases.</desc>
18132	</attribute>
18133	<attribute name="TFTPNextServer" type="wstring">
18134	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
18135	the corresponding fields of DHCP leases.
18136	<note>The preferred form is IPv4 addresses.</note>
18137	</desc>
18138	</attribute>
18139	<attribute name="aliasMode" type="unsigned long">
18140	<desc></desc>
18141	</attribute>
18142	<attribute name="DNSPassDomain" type="boolean">
18143	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
18144	</attribute>
18145	<attribute name="DNSProxy" type="boolean">
18146	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18147	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
18148	</attribute>
18149	<attribute name="DNSUseHostResolver" type="boolean">
18150	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18151	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
18152	</attribute>
18153	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
18154	<desc>Array of NAT port-forwarding rules in string representation, in the following
18155	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
18156	</attribute>
18157	<method name="setNetworkSettings">
18158	<desc>Sets network configuration of the NAT engine.</desc>
18159	<param name="mtu" type="unsigned long" dir="in">
18160	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
18161	</param>
18162	<param name="sockSnd" type="unsigned long" dir="in">
18163	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
18164	</param>
18165	<param name="sockRcv" type="unsigned long" dir="in">
18166	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
18167	</param>
18168	<param name="TcpWndSnd" type="unsigned long" dir="in">
18169	<desc>Initial size of the NAT engine's sending TCP window in bytes when
18170	establishing a new TCP connection.</desc>
18171	</param>
18172	<param name="TcpWndRcv" type="unsigned long" dir="in">
18173	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
18174	establishing a new TCP connection.</desc>
18175	</param>
18176	</method>
18177	<method name="getNetworkSettings">
18178	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
18179	for parameter descriptions.</desc>
18180	<param name="mtu" type="unsigned long" dir="out" />
18181	<param name="sockSnd" type="unsigned long" dir="out" />
18182	<param name="sockRcv" type="unsigned long" dir="out" />
18183	<param name="TcpWndSnd" type="unsigned long" dir="out" />
18184	<param name="TcpWndRcv" type="unsigned long" dir="out" />
18185	</method>
18186	<method name="addRedirect">
18187	<desc>Adds a new NAT port-forwarding rule.</desc>
18188	<param name="name" type="wstring" dir="in">
18189	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
18190	auto-generates one using the other parameters.</desc>
18191	</param>
18192	<param name="proto" type="NATProtocol" dir="in">
18193	<desc>Protocol handled with the rule.</desc>
18194	</param>
18195	<param name="hostIP" type="wstring" dir="in">
18196	<desc>IP of the host interface to which the rule should apply. An empty ip address is
18197	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
18198	</param>
18199	<param name="hostPort" type="unsigned short" dir="in">
18200	<desc>The port number to listen on.</desc>
18201	</param>
18202	<param name="guestIP" type="wstring" dir="in">
18203	<desc>The IP address of the guest which the NAT engine will forward matching packets
18204	to. An empty IP address is acceptable, in which case the NAT engine will forward
18205	packets to the first DHCP lease (x.x.x.15).</desc>
18206	</param>
18207	<param name="guestPort" type="unsigned short" dir="in">
18208	<desc>The port number to forward.</desc>
18209	</param>
18210	</method>
18211	<method name="removeRedirect">
18212	<desc>Removes a port-forwarding rule that was previously registered.</desc>
18213	<param name="name" type="wstring" dir="in">
18214	<desc>The name of the rule to delete.</desc>
18215	</param>
18216	</method>
18217	</interface>
18218
18219	<!--
18220	// IExtPackManager
18221	/////////////////////////////////////////////////////////////////////////
18222	-->
18223
18224	<interface
18225	name="IExtPackPlugIn" extends="$unknown"
18226	uuid="58000040-e718-4746-bbce-4b86d96da461"
18227	wsmap="suppress"
18228	>
18229	<desc>
18230	Interface for keeping information about a plug-in that ships with an
18231	extension pack.
18232	</desc>
18233	<attribute name="name" type="wstring" readonly="yes">
18234	<desc>The plug-in name.</desc>
18235	</attribute>
18236	<attribute name="description" type="wstring" readonly="yes">
18237	<desc>The plug-in description.</desc>
18238	</attribute>
18239	<attribute name="frontend" type="wstring" readonly="yes">
18240	<desc>
18241	The name of the frontend or component name this plug-in plugs into.
18242	</desc>
18243	</attribute>
18244	<attribute name="modulePath" type="wstring" readonly="yes">
18245	<desc> The module path. </desc>
18246	</attribute>
18247	</interface>
18248
18249	<interface
18250	name="IExtPackBase" extends="$unknown"
18251	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
18252	wsmap="suppress"
18253	>
18254	<desc>
18255	Interface for querying information about an extension pack as well as
18256	accessing COM objects within it.
18257	</desc>
18258	<attribute name="name" type="wstring" readonly="yes">
18259	<desc>The extension pack name. This is unique.</desc>
18260	</attribute>
18261	<attribute name="description" type="wstring" readonly="yes">
18262	<desc>The extension pack description.</desc>
18263	</attribute>
18264	<attribute name="version" type="wstring" readonly="yes">
18265	<desc>
18266	The extension pack version string. This is restricted to the dotted
18267	version number and optionally a build indicator. No tree revision or
18268	tag will be included in the string as those things are available as
18269	separate properties. An optional publisher tag may be present like for
18270	<link to="IVirtualBox::version"/>.
18271
18272	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
18273	</desc>
18274	</attribute>
18275	<attribute name="revision" type="unsigned long" readonly="yes">
18276	<desc>The extension pack internal revision number.</desc>
18277	</attribute>
18278	<attribute name="edition" type="wstring" readonly="yes">
18279	<desc>
18280	Edition indicator. This is usually empty.
18281
18282	Can for instance be used to help distinguishing between two editions
18283	of the same extension pack where only the license, service contract or
18284	something differs.
18285	</desc>
18286	</attribute>
18287	<attribute name="VRDEModule" type="wstring" readonly="yes">
18288	<desc>The name of the VRDE module if the extension pack sports one.</desc>
18289	</attribute>
18290	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
18291	<desc>Plug-ins provided by this extension pack.</desc>
18292	</attribute>
18293	<attribute name="usable" type="boolean" readonly="yes">
18294	<desc>
18295	Indicates whether the extension pack is usable or not.
18296
18297	There are a number of reasons why an extension pack might be unusable,
18298	typical examples would be broken installation/file or that it is
18299	incompatible with the current VirtualBox version.
18300	</desc>
18301	</attribute>
18302	<attribute name="whyUnusable" type="wstring" readonly="yes">
18303	<desc>
18304	String indicating why the extension pack is not usable. This is an
18305	empty string if usable and always a non-empty string if not usable.
18306	</desc>
18307	</attribute>
18308	<attribute name="showLicense" type="boolean" readonly="yes">
18309	<desc>Whether to show the license before installation</desc>
18310	</attribute>
18311	<attribute name="license" type="wstring" readonly="yes">
18312	<desc>
18313	The default HTML license text for the extension pack. Same as
18314	calling <link to="#queryLicense">queryLicense</link> with
18315	preferredLocale and preferredLanguage as empty strings and format set
18316	to html.
18317	</desc>
18318	</attribute>
18319
18320	<method name="queryLicense">
18321	<desc>
18322	Full feature version of the license attribute.
18323	</desc>
18324	<param name="preferredLocale" type="wstring" dir="in">
18325	<desc>
18326	The preferred license locale. Pass an empty string to get the default
18327	license.
18328	</desc>
18329	</param>
18330	<param name="preferredLanguage" type="wstring" dir="in">
18331	<desc>
18332	The preferred license language. Pass an empty string to get the
18333	default language for the locale.
18334	</desc>
18335	</param>
18336	<param name="format" type="wstring" dir="in">
18337	<desc>
18338	The license format: html, rtf or txt. If a license is present there
18339	will always be an HTML of it, the rich text format (RTF) and plain
18340	text (txt) versions are optional. If
18341	</desc>
18342	</param>
18343	<param name="licenseText" type="wstring" dir="return">
18344	<desc>The license text.</desc>
18345	</param>
18346	</method>
18347
18348	</interface>
18349
18350	<interface
18351	name="IExtPack" extends="IExtPackBase"
18352	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
18353	wsmap="suppress"
18354	>
18355	<desc>
18356	Interface for querying information about an extension pack as well as
18357	accessing COM objects within it.
18358	</desc>
18359	<method name="queryObject">
18360	<desc>
18361	Queries the IUnknown interface to an object in the extension pack
18362	main module. This allows plug-ins and others to talk directly to an
18363	extension pack.
18364	</desc>
18365	<param name="objUuid" type="wstring" dir="in">
18366	<desc>The object ID. What exactly this is </desc>
18367	</param>
18368	<param name="returnInterface" type="$unknown" dir="return">
18369	<desc>The queried interface.</desc>
18370	</param>
18371	</method>
18372	</interface>
18373
18374	<interface
18375	name="IExtPackFile" extends="IExtPackBase"
18376	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
18377	wsmap="suppress"
18378	>
18379	<desc>
18380	Extension pack file (aka tarball, .vbox-extpack) representation returned
18381	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
18382	extension pack information with the addition of the file name.
18383	</desc>
18384	<attribute name="filePath" type="wstring" readonly="yes">
18385	<desc>
18386	The path to the extension pack file.
18387	</desc>
18388	</attribute>
18389
18390	<method name="install">
18391	<desc>
18392	Install the extension pack.
18393	</desc>
18394	<param name="replace" type="boolean" dir="in">
18395	<desc>
18396	Set this to automatically uninstall any existing extension pack with
18397	the same name as the one being installed.
18398	</desc>
18399	</param>
18400	<param name="displayInfo" type="wstring" dir="in">
18401	<desc>
18402	Platform specific display information. Reserved for future hacks.
18403	</desc>
18404	</param>
18405	<param name="progess" type="IProgress" dir="return">
18406	<desc>
18407	Progress object for the operation.
18408	</desc>
18409	</param>
18410	</method>
18411	</interface>
18412
18413	<interface
18414	name="IExtPackManager" extends="$unknown"
18415	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
18416	wsmap="suppress"
18417	>
18418	<desc>
18419	Interface for managing VirtualBox Extension Packs.
18420
18421	TODO: Describe extension packs, how they are managed and how to create
18422	one.
18423	</desc>
18424
18425	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
18426	<desc>
18427	List of the installed extension packs.
18428	</desc>
18429	</attribute>
18430
18431	<method name="find">
18432	<desc>
18433	Returns the extension pack with the specified name if found.
18434
18435	<result name="VBOX_E_OBJECT_NOT_FOUND">
18436	No extension pack matching @a name was found.
18437	</result>
18438	</desc>
18439	<param name="name" type="wstring" dir="in">
18440	<desc>The name of the extension pack to locate.</desc>
18441	</param>
18442	<param name="returnData" type="IExtPack" dir="return">
18443	<desc>The extension pack if found.</desc>
18444	</param>
18445	</method>
18446
18447	<method name="openExtPackFile">
18448	<desc>
18449	Attempts to open an extension pack file in preparation for
18450	installation.
18451	</desc>
18452	<param name="path" type="wstring" dir="in">
18453	<desc>The path of the extension pack tarball. This can optionally be
18454	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
18455	</param>
18456	<param name="file" type="IExtPackFile" dir="return">
18457	<desc>The interface of the extension pack file object.</desc>
18458	</param>
18459	</method>
18460
18461	<method name="uninstall">
18462	<desc>Uninstalls an extension pack, removing all related files.</desc>
18463	<param name="name" type="wstring" dir="in">
18464	<desc>The name of the extension pack to uninstall.</desc>
18465	</param>
18466	<param name="forcedRemoval" type="boolean" dir="in">
18467	<desc>
18468	Forced removal of the extension pack. This means that the uninstall
18469	hook will not be called.
18470	</desc>
18471	</param>
18472	<param name="displayInfo" type="wstring" dir="in">
18473	<desc>
18474	Platform specific display information. Reserved for future hacks.
18475	</desc>
18476	</param>
18477	<param name="progess" type="IProgress" dir="return">
18478	<desc>
18479	Progress object for the operation.
18480	</desc>
18481	</param>
18482	</method>
18483
18484	<method name="cleanup">
18485	<desc>Cleans up failed installs and uninstalls</desc>
18486	</method>
18487
18488	<method name="queryAllPlugInsForFrontend">
18489	<desc>
18490	Gets the path to all the plug-in modules for a given frontend.
18491
18492	This is a convenience method that is intended to simplify the plug-in
18493	loading process for a frontend.
18494	</desc>
18495	<param name="frontendName" type="wstring" dir="in">
18496	<desc>The name of the frontend or component.</desc>
18497	</param>
18498	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
18499	<desc>Array containing the plug-in modules (full paths).</desc>
18500	</param>
18501	</method>
18502
18503	<method name="isExtPackUsable">
18504	<desc>Check if the given extension pack is loaded and usable.</desc>
18505	<param name="name" type="wstring" dir="in">
18506	<desc>The name of the extension pack to check for.</desc>
18507	</param>
18508	<param name="usable" type="boolean" dir="return">
18509	<desc>Is the given extension pack loaded and usable.</desc>
18510	</param>
18511	</method>
18512
18513	</interface>
18514
18515	<!--
18516	// BandwidthGroupType
18517	/////////////////////////////////////////////////////////////////////////
18518	-->
18519	<enum
18520	name="BandwidthGroupType"
18521	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
18522
18523	<desc>
18524	Type of a bandwidth control group.
18525	</desc>
18526
18527	<const name="Null" value="0">
18528	<desc>
18529	Null type, must be first.
18530	</desc>
18531	</const>
18532
18533	<const name="Disk" value="1">
18534	<desc>
18535	The bandwidth group controls disk I/O.
18536	</desc>
18537	</const>
18538
18539	<const name="Network" value="2">
18540	<desc>
18541	The bandwidth group controls network I/O.
18542	</desc>
18543	</const>
18544
18545	</enum>
18546
18547	<!--
18548	// IBandwidthGroup
18549	/////////////////////////////////////////////////////////////////////////
18550	-->
18551	<interface
18552	name="IBandwidthGroup" extends="$unknown"
18553	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
18554	wsmap="managed"
18555	>
18556	<desc>Represents one bandwidth group.</desc>
18557
18558	<attribute name="name" type="wstring" readonly="yes">
18559	<desc>Name of the group.</desc>
18560	</attribute>
18561
18562	<attribute name="type" type="BandwidthGroupType" readonly="yes">
18563	<desc>Type of the group.</desc>
18564	</attribute>
18565
18566	<attribute name="reference" type="unsigned long" readonly="yes">
18567	<desc>How many devices/medium attachements use this group.</desc>
18568	</attribute>
18569
18570	<attribute name="maxBytesPerSec" type="long long">
18571	<desc>The maximum number of bytes which can be transfered by all
18572	entities attached to this group during one second.</desc>
18573	</attribute>
18574
18575	</interface>
18576
18577	<!--
18578	// IBandwidthControl
18579	/////////////////////////////////////////////////////////////////////////
18580	-->
18581	<interface
18582	name="IBandwidthControl" extends="$unknown"
18583	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
18584	wsmap="managed"
18585	>
18586	<desc>
18587	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
18588	This includes network and disk I/O.
18589	</desc>
18590
18591	<attribute name="numGroups" type="unsigned long" readonly="yes">
18592	<desc>
18593	The current number of existing bandwidth groups managed.
18594	</desc>
18595	</attribute>
18596
18597	<method name="createBandwidthGroup">
18598	<desc>
18599	Creates a new bandwidth group.
18600	</desc>
18601
18602	<param name="name" type="wstring" dir="in">
18603	<desc>Name of the bandwidth group.</desc>
18604	</param>
18605	<param name="type" type="BandwidthGroupType" dir="in">
18606	<desc>The type of the bandwidth group (network or disk).</desc>
18607	</param>
18608	<param name="maxBytesPerSec" type="long long" dir="in">
18609	<desc>The maximum number of bytes which can be transfered by all
18610	entities attached to this group during one second.</desc>
18611	</param>
18612	</method>
18613
18614	<method name="deleteBandwidthGroup">
18615	<desc>
18616	Deletes a new bandwidth group.
18617	</desc>
18618
18619	<param name="name" type="wstring" dir="in">
18620	<desc>Name of the bandwidth group to delete.</desc>
18621	</param>
18622	</method>
18623
18624	<method name="getBandwidthGroup" const="yes">
18625	<desc>
18626	Get a bandwidth group by name.
18627	</desc>
18628
18629	<param name="name" type="wstring" dir="in">
18630	<desc>Name of the bandwidth group to get.</desc>
18631	</param>
18632	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
18633	<desc>Where to store the bandwidth group on success.</desc>
18634	</param>
18635	</method>
18636
18637	<method name="getAllBandwidthGroups" const="yes">
18638	<desc>
18639	Get all managed bandwidth groups.
18640	</desc>
18641
18642	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
18643	<desc>The array of managed bandwidth groups.</desc>
18644	</param>
18645	</method>
18646	</interface>
18647
18648	<!--
18649	// IVirtualBoxClient
18650	/////////////////////////////////////////////////////////////////////////
18651	-->
18652
18653	<interface
18654	name="IVirtualBoxClient" extends="$unknown"
18655	uuid="d191281f-b0cb-4d83-a8fa-0d9fd6ba234c"
18656	wsmap="suppress"
18657	>
18658	<desc>
18659	Convenience interface for client applications. Treat this as a
18660	singleton, i.e. never create more than one instance of this interface.
18661
18662	At the moment only available for clients of the local API (not usable
18663	via the webservice). Once the session logic is redesigned this might
18664	change.
18665	</desc>
18666
18667	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
18668	<desc>
18669	Reference to the server-side API root object.
18670	</desc>
18671	</attribute>
18672
18673	<attribute name="session" type="ISession" readonly="yes">
18674	<desc>
18675	Create a new session object and return the reference to it.
18676	</desc>
18677	</attribute>
18678
18679	<attribute name="eventSource" type="IEventSource" readonly="yes">
18680	<desc>
18681	Event source for VirtualBoxClient events.
18682	</desc>
18683	</attribute>
18684
18685	<method name="checkMachineError">
18686	<desc>
18687	Perform error checking before using an <link to="IMachine"/> object.
18688	Generally useful before starting a VM and all other uses. If anything
18689	is not as it should be then this method will return an appropriate
18690	error.
18691	</desc>
18692
18693	<param name="machine" type="IMachine" dir="in">
18694	<desc>The machine object to check.</desc>
18695	</param>
18696	</method>
18697	</interface>
18698
18699	<!--
18700	// Events
18701	/////////////////////////////////////////////////////////////////////////
18702	-->
18703	<enum
18704	name="VBoxEventType"
18705	uuid="c51645b3-7108-4dce-b5a3-bbf5e4f69ed2"
18706	>
18707
18708	<desc>
18709	Type of an event.
18710	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18711	</desc>
18712
18713	<const name="Invalid" value="0">
18714	<desc>
18715	Invalid event, must be first.
18716	</desc>
18717	</const>
18718
18719	<const name="Any" value="1">
18720	<desc>
18721	Wildcard for all events.
18722	Events of this type are never delivered, and only used in
18723	<link to="IEventSource::registerListener"/> call to simplify registration.
18724	</desc>
18725	</const>
18726
18727	<const name="Vetoable" value="2">
18728	<desc>
18729	Wildcard for all vetoable events. Events of this type are never delivered, and only
18730	used in <link to="IEventSource::registerListener"/> call to simplify registration.
18731	</desc>
18732	</const>
18733
18734	<const name="MachineEvent" value="3">
18735	<desc>
18736	Wildcard for all machine 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="SnapshotEvent" value="4">
18742	<desc>
18743	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
18744	<link to="IEventSource::registerListener"/> call to simplify registration.
18745	</desc>
18746	</const>
18747
18748	<const name="InputEvent" value="5">
18749	<desc>
18750	Wildcard for all input device (keyboard, mouse) events.
18751	Events of this type are never delivered, and only used in
18752	<link to="IEventSource::registerListener"/> call to simplify registration.
18753	</desc>
18754	</const>
18755
18756	<const name="LastWildcard" value="31">
18757	<desc>
18758	Last wildcard.
18759	</desc>
18760	</const>
18761
18762	<const name="OnMachineStateChanged" value="32">
18763	<desc>
18764	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
18765	</desc>
18766	</const>
18767	<const name="OnMachineDataChanged" value="33">
18768	<desc>
18769	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
18770	</desc>
18771	</const>
18772	<const name="OnExtraDataChanged" value="34">
18773	<desc>
18774	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
18775	</desc>
18776	</const>
18777	<const name="OnExtraDataCanChange" value="35">
18778	<desc>
18779	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
18780	</desc>
18781	</const>
18782	<const name="OnMediumRegistered" value="36">
18783	<desc>
18784	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
18785	</desc>
18786	</const>
18787	<const name="OnMachineRegistered" value="37">
18788	<desc>
18789	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
18790	</desc>
18791	</const>
18792	<const name="OnSessionStateChanged" value="38">
18793	<desc>
18794	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
18795	</desc>
18796	</const>
18797	<const name="OnSnapshotTaken" value="39">
18798	<desc>
18799	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
18800	</desc>
18801	</const>
18802	<const name="OnSnapshotDeleted" value="40">
18803	<desc>
18804	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
18805	</desc>
18806	</const>
18807	<const name="OnSnapshotChanged" value="41">
18808	<desc>
18809	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
18810	</desc>
18811	</const>
18812	<const name="OnGuestPropertyChanged" value="42">
18813	<desc>
18814	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
18815	</desc>
18816	</const>
18817	<!-- Console events -->
18818	<const name="OnMousePointerShapeChanged" value="43">
18819	<desc>
18820	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
18821	</desc>
18822	</const>
18823	<const name="OnMouseCapabilityChanged" value="44">
18824	<desc>
18825	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
18826	</desc>
18827	</const>
18828	<const name="OnKeyboardLedsChanged" value="45">
18829	<desc>
18830	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
18831	</desc>
18832	</const>
18833	<const name="OnStateChanged" value="46">
18834	<desc>
18835	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
18836	</desc>
18837	</const>
18838	<const name="OnAdditionsStateChanged" value="47">
18839	<desc>
18840	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
18841	</desc>
18842	</const>
18843	<const name="OnNetworkAdapterChanged" value="48">
18844	<desc>
18845	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
18846	</desc>
18847	</const>
18848	<const name="OnSerialPortChanged" value="49">
18849	<desc>
18850	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
18851	</desc>
18852	</const>
18853	<const name="OnParallelPortChanged" value="50">
18854	<desc>
18855	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
18856	</desc>
18857	</const>
18858	<const name="OnStorageControllerChanged" value="51">
18859	<desc>
18860	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
18861	</desc>
18862	</const>
18863	<const name="OnMediumChanged" value="52">
18864	<desc>
18865	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
18866	</desc>
18867	</const>
18868	<const name="OnVRDEServerChanged" value="53">
18869	<desc>
18870	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
18871	</desc>
18872	</const>
18873	<const name="OnUSBControllerChanged" value="54">
18874	<desc>
18875	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
18876	</desc>
18877	</const>
18878	<const name="OnUSBDeviceStateChanged" value="55">
18879	<desc>
18880	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
18881	</desc>
18882	</const>
18883	<const name="OnSharedFolderChanged" value="56">
18884	<desc>
18885	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
18886	</desc>
18887	</const>
18888	<const name="OnRuntimeError" value="57">
18889	<desc>
18890	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
18891	</desc>
18892	</const>
18893	<const name="OnCanShowWindow" value="58">
18894	<desc>
18895	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
18896	</desc>
18897	</const>
18898	<const name="OnShowWindow" value="59">
18899	<desc>
18900	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
18901	</desc>
18902	</const>
18903	<const name="OnCPUChanged" value="60">
18904	<desc>
18905	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
18906	</desc>
18907	</const>
18908	<const name="OnVRDEServerInfoChanged" value="61">
18909	<desc>
18910	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
18911	</desc>
18912	</const>
18913	<const name="OnEventSourceChanged" value="62">
18914	<desc>
18915	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
18916	</desc>
18917	</const>
18918	<const name="OnCPUExecutionCapChanged" value="63">
18919	<desc>
18920	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
18921	</desc>
18922	</const>
18923	<const name="OnGuestKeyboard" value="64">
18924	<desc>
18925	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
18926	</desc>
18927	</const>
18928	<const name="OnGuestMouse" value="65">
18929	<desc>
18930	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
18931	</desc>
18932	</const>
18933	<const name="OnNATRedirect" value="66">
18934	<desc>
18935	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
18936	</desc>
18937	</const>
18938	<const name="OnHostPCIDevicePlug" value="67">
18939	<desc>
18940	See <link to="IHostPCIDevicePlugEvent">IHostPCIDevicePlugEvent</link>.
18941	</desc>
18942	</const>
18943	<const name="OnVBoxSVCAvailabilityChanged" value="68">
18944	<desc>
18945	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
18946	</desc>
18947	</const>
18948	<const name="OnBandwidthGroupChanged" value="69">
18949	<desc>
18950	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
18951	</desc>
18952	</const>
18953	<const name="OnGuestMonitorChanged" value="70">
18954	<desc>
18955	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
18956	</desc>
18957	</const>
18958	<const name="OnStorageDeviceChanged" value="71">
18959	<desc>
18960	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
18961	</desc>
18962	</const>
18963	<const name="OnClipboardModeChanged" value="72">
18964	<desc>
18965	See <link to="IClipboardModeChangedEvent">IClipboardModeChangedEvent</link>.
18966	</desc>
18967	</const>
18968	<const name="OnDragAndDropModeChanged" value="73">
18969	<desc>
18970	See <link to="IDragAndDropModeChangedEvent">IDragAndDropModeChangedEvent</link>.
18971	</desc>
18972	</const>
18973	<const name="OnNATNetworkChanged" value="74">
18974	<desc>
18975	See <link to="INATNetworkChangedEvent">INATNetworkChangedEvent</link>.
18976	</desc>
18977	</const>
18978	<const name="OnNATNetworkStartStop" value="75">
18979	<desc>
18980	See <link to="INATNetworkStartStopEvent">INATNetworkStartStopEvent</link>.
18981	</desc>
18982	</const>
18983	<const name="OnNATNetworkAlter" value="76">
18984	<desc>
18985	See <link to="INATNetworkAlterEvent">INATNetworkAlterEvent</link>.
18986	</desc>
18987	</const>
18988	<const name="OnNATNetworkCreationDeletion" value="77">
18989	<desc>
18990	See <link to="INATNetworkCreationDeletionEvent">INATNetworkCreationDeletionEvent</link>.
18991	</desc>
18992	</const>
18993	<const name="OnNATNetworkSetting" value="78">
18994	<desc>
18995	See <link to="INATNetworkSettingEvent">INATNetworkSettingEvent</link>.
18996	</desc>
18997	</const>
18998	<const name="OnNATNetworkPortForward" value="79">
18999	<desc>
19000	See <link to="INATNetworkPortForwardEvent">INATNetworkPortForwardEvent</link>.
19001	</desc>
19002	</const>
19003	<const name="OnGuestSessionStateChanged" value="80">
19004	<desc>
19005	See <link to="IGuestSessionStateChangedEvent">IGuestSessionStateChangedEvent</link>.
19006	</desc>
19007	</const>
19008	<const name="OnGuestSessionRegistered" value="81">
19009	<desc>
19010	See <link to="IGuestSessionRegisteredEvent">IGuestSessionRegisteredEvent</link>.
19011	</desc>
19012	</const>
19013	<const name="OnGuestProcessRegistered" value="82">
19014	<desc>
19015	See <link to="IGuestProcessRegisteredEvent">IGuestProcessRegisteredEvent</link>.
19016	</desc>
19017	</const>
19018	<const name="OnGuestProcessStateChanged" value="83">
19019	<desc>
19020	See <link to="IGuestProcessStateChangedEvent">IGuestProcessStateChangedEvent</link>.
19021	</desc>
19022	</const>
19023	<const name="OnGuestProcessInputNotify" value="84">
19024	<desc>
19025	See <link to="IGuestProcessInputNotifyEvent">IGuestProcessInputNotifyEvent</link>.
19026	</desc>
19027	</const>
19028	<const name="OnGuestProcessOutput" value="85">
19029	<desc>
19030	See <link to="IGuestProcessOutputEvent">IGuestProcessOutputEvent</link>.
19031	</desc>
19032	</const>
19033	<const name="OnGuestFileRegistered" value="86">
19034	<desc>
19035	See <link to="IGuestFileRegisteredEvent">IGuestFileRegisteredEvent</link>.
19036	</desc>
19037	</const>
19038	<const name="OnGuestFileStateChanged" value="87">
19039	<desc>
19040	See <link to="IGuestFileStateChangedEvent">IGuestFileStateChangedEvent</link>.
19041	</desc>
19042	</const>
19043	<const name="OnGuestFileOffsetChanged" value="88">
19044	<desc>
19045	See <link to="IGuestFileOffsetChangedEvent">IGuestFileOffsetChangedEvent</link>.
19046	</desc>
19047	</const>
19048	<const name="OnGuestFileRead" value="89">
19049	<desc>
19050	See <link to="IGuestFileReadEvent">IGuestFileReadEvent</link>.
19051
19052	<note internal="yes">For performance reasons this is a separate event to
19053	not unnecessarily overflow the event queue.</note>
19054	</desc>
19055	</const>
19056	<const name="OnGuestFileWrite" value="90">
19057	<desc>
19058	See <link to="IGuestFileWriteEvent">IGuestFileWriteEvent</link>.
19059
19060	<note internal="yes">For performance reasons this is a separate event to
19061	not unnecessarily overflow the event queue.</note>
19062	</desc>
19063	</const>
19064	<!-- Last event marker -->
19065	<const name="Last" value="91">
19066	<desc>
19067	Must be last event, used for iterations and structures relying on numerical event values.
19068	</desc>
19069	</const>
19070
19071	</enum>
19072
19073	<interface
19074	name="IEventSource" extends="$unknown"
19075	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
19076	wsmap="managed"
19077	>
19078	<desc>
19079	Event source. Generally, any object which could generate events can be an event source,
19080	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
19081	an event source can work with listeners in either active or passive mode. In active mode it is up to
19082	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
19083	event source keeps track of pending events for each listener and returns available events on demand.
19084
19085	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
19086	</desc>
19087
19088	<method name="createListener">
19089	<desc>
19090	Creates a new listener object, useful for passive mode.
19091	</desc>
19092	<param name="listener" type="IEventListener" dir="return"/>
19093	</method>
19094
19095	<method name="createAggregator">
19096	<desc>
19097	Creates an aggregator event source, collecting events from multiple sources.
19098	This way a single listener can listen for events coming from multiple sources,
19099	using a single blocking <link to="#getEvent"/> on the returned aggregator.
19100	</desc>
19101	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
19102	<desc>
19103	Subordinate event source this one aggregatres.
19104	</desc>
19105	</param>
19106	<param name="result" type="IEventSource" dir="return">
19107	<desc>
19108	Event source aggregating passed sources.
19109	</desc>
19110	</param>
19111	</method>
19112
19113	<method name="registerListener">
19114	<desc>
19115	Register an event listener.
19116
19117	<note>
19118	To avoid system overload, the VirtualBox server process checks if passive event
19119	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
19120	current implementation, if more than 500 pending events are detected for a passive
19121	event listener, it is forcefully unregistered by the system, and further
19122	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
19123	</note>
19124	</desc>
19125	<param name="listener" type="IEventListener" dir="in">
19126	<desc>Listener to register.</desc>
19127	</param>
19128	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
19129	<desc>
19130	Event types listener is interested in. One can use wildcards like -
19131	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
19132	than one event.
19133	</desc>
19134	</param>
19135	<param name="active" type="boolean" dir="in">
19136	<desc>
19137	Which mode this listener is operating in.
19138	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
19139	In passive mode, an internal event queue is created for this this IEventListener.
19140	For each event coming in, it is added to queues for all interested registered passive
19141	listeners. It is then up to the external code to call the listener's
19142	<link to="IEventListener::handleEvent" /> method. When done with an event, the
19143	external code must call <link to="#eventProcessed" />.
19144	</desc>
19145	</param>
19146	</method>
19147
19148	<method name="unregisterListener">
19149	<desc>
19150	Unregister an event listener. If listener is passive, and some waitable events are still
19151	in queue they are marked as processed automatically.
19152	</desc>
19153	<param name="listener" type="IEventListener" dir="in">
19154	<desc>Listener to unregister.</desc>
19155	</param>
19156	</method>
19157
19158	<method name="fireEvent">
19159	<desc>
19160	Fire an event for this source.
19161	</desc>
19162	<param name="event" type="IEvent" dir="in">
19163	<desc>Event to deliver.</desc>
19164	</param>
19165	<param name="timeout" type="long" dir="in">
19166	<desc>
19167	Maximum time to wait for event processing (if event is waitable), in ms;
19168	0 = no wait, -1 = indefinite wait.
19169	</desc>
19170	</param>
19171	<param name="result" type="boolean" dir="return">
19172	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
19173	</param>
19174	</method>
19175
19176	<method name="getEvent">
19177	<desc>
19178	Get events from this peer's event queue (for passive mode). Calling this method
19179	regularly is required for passive event listeners to avoid system overload;
19180	see <link to="IEventSource::registerListener" /> for details.
19181
19182	<result name="VBOX_E_OBJECT_NOT_FOUND">
19183	Listener is not registered, or autounregistered.
19184	</result>
19185	</desc>
19186	<param name="listener" type="IEventListener" dir="in">
19187	<desc>Which listener to get data for.</desc>
19188	</param>
19189	<param name="timeout" type="long" dir="in">
19190	<desc>
19191	Maximum time to wait for events, in ms;
19192	0 = no wait, -1 = indefinite wait.
19193	</desc>
19194	</param>
19195	<param name="event" type="IEvent" dir="return">
19196	<desc>Event retrieved, or null if none available.</desc>
19197	</param>
19198	</method>
19199
19200	<method name="eventProcessed">
19201	<desc>
19202	Must be called for waitable events after a particular listener finished its
19203	event processing. When all listeners of a particular event have called this
19204	method, the system will then call <link to="IEvent::setProcessed" />.
19205	</desc>
19206	<param name="listener" type="IEventListener" dir="in">
19207	<desc>Which listener processed event.</desc>
19208	</param>
19209	<param name="event" type="IEvent" dir="in">
19210	<desc>Which event.</desc>
19211	</param>
19212	</method>
19213
19214	</interface>
19215
19216	<interface
19217	name="IEventListener" extends="$unknown"
19218	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
19219	wsmap="managed"
19220	>
19221	<desc>
19222	Event listener. An event listener can work in either active or passive mode, depending on the way
19223	it was registered.
19224	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
19225	</desc>
19226
19227	<method name="handleEvent">
19228	<desc>
19229	Handle event callback for active listeners. It is not called for
19230	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
19231	and having received acknowledgement from all passive listeners via
19232	<link to="IEventSource::eventProcessed"/>, the event is marked as
19233	processed and <link to="IEvent::waitProcessed"/> will return
19234	immediately.
19235	</desc>
19236	<param name="event" type="IEvent" dir="in">
19237	<desc>Event available.</desc>
19238	</param>
19239	</method>
19240
19241	</interface>
19242
19243	<interface
19244	name="IEvent" extends="$unknown"
19245	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
19246	wsmap="managed"
19247	>
19248	<desc>
19249	Abstract parent interface for VirtualBox events. Actual events will typically implement
19250	a more specific interface which derives from this (see below).
19251
19252	<b>Introduction to VirtualBox events</b>
19253
19254	Generally speaking, an event (represented by this interface) signals that something
19255	happened, while an event listener (see <link to="IEventListener" />) represents an
19256	entity that is interested in certain events. In order for this to work with
19257	unidirectional protocols (i.e. web services), the concepts of passive and active
19258	listener are used.
19259
19260	Event consumers can register themselves as listeners, providing an array of
19261	events they are interested in (see <link to="IEventSource::registerListener" />).
19262	When an event triggers, the listener is notified about the event. The exact
19263	mechanism of the notification depends on whether the listener was registered as
19264	an active or passive listener:
19265
19266	<ul>
19267	<li>An active listener is very similar to a callback: it is a function invoked
19268	by the API. As opposed to the callbacks that were used in the API before
19269	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
19270	</li>
19271
19272	<li>Passive listeners are somewhat trickier to implement, but do not require
19273	a client function to be callable, which is not an option with scripting
19274	languages or web service clients. Internally the <link to="IEventSource" />
19275	implementation maintains an event queue for each passive listener, and
19276	newly arrived events are put in this queue. When the listener calls
19277	<link to="IEventSource::getEvent"/>, first element from its internal event
19278	queue is returned. When the client completes processing of an event,
19279	the <link to="IEventSource::eventProcessed" /> function must be called,
19280	acknowledging that the event was processed. It supports implementing
19281	waitable events. On passive listener unregistration, all events from its
19282	queue are auto-acknowledged.
19283	</li>
19284	</ul>
19285
19286	Waitable events are useful in situations where the event generator wants to track
19287	delivery or a party wants to wait until all listeners have completed the event. A
19288	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
19289	listeners might veto a certain action, and thus the event producer has to make
19290	sure that all listeners have processed the event and not vetoed before taking
19291	the action.
19292
19293	A given event may have both passive and active listeners at the same time.
19294
19295	<b>Using events</b>
19296
19297	Any VirtualBox object capable of producing externally visible events provides an
19298	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
19299	This event source object is notified by VirtualBox once something has happened, so
19300	consumers may register event listeners with this event source. To register a listener,
19301	an object implementing the <link to="IEventListener" /> interface must be provided.
19302	For active listeners, such an object is typically created by the consumer, while for
19303	passive listeners <link to="IEventSource::createListener" /> should be used. Please
19304	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
19305
19306	Once created, the listener must be registered to listen for the desired events
19307	(see <link to="IEventSource::registerListener" />), providing an array of
19308	<link to="VBoxEventType" /> enums. Those elements can either be the individual
19309	event IDs or wildcards matching multiple event IDs.
19310
19311	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
19312	called automatically when the event is triggered, while passive listeners have to call
19313	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
19314	an event processing loop.
19315
19316	The IEvent interface is an abstract parent interface for all such VirtualBox events
19317	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
19318	or the event processing loop is to check the <link to="#type" /> attribute of the event and
19319	then cast to the appropriate specific interface using @c QueryInterface().
19320	</desc>
19321
19322	<attribute name="type" readonly="yes" type="VBoxEventType">
19323	<desc>
19324	Event type.
19325	</desc>
19326	</attribute>
19327
19328	<attribute name="source" readonly="yes" type="IEventSource">
19329	<desc>
19330	Source of this event.
19331	</desc>
19332	</attribute>
19333
19334	<attribute name="waitable" readonly="yes" type="boolean">
19335	<desc>
19336	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
19337	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
19338	as no additional overhead associated with waitability imposed.
19339	Waitable events are needed when one need to be able to wait for particular event processed,
19340	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
19341	until all consumers confirmed events.
19342	</desc>
19343	</attribute>
19344
19345	<method name="setProcessed">
19346	<desc>
19347	Internal method called by the system when all listeners of a particular event have called
19348	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
19349	</desc>
19350	</method>
19351
19352	<method name="waitProcessed">
19353	<desc>
19354	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
19355	described semantics, for non-waitable returns true immediately.
19356	</desc>
19357	<param name="timeout" type="long" dir="in">
19358	<desc>
19359	Maximum time to wait for event processeing, in ms;
19360	0 = no wait, -1 = indefinite wait.
19361	</desc>
19362	</param>
19363	<param name="result" type="boolean" dir="return">
19364	<desc>If this event was processed before timeout.</desc>
19365	</param>
19366	</method>
19367	</interface>
19368
19369
19370	<interface
19371	name="IReusableEvent" extends="IEvent"
19372	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
19373	wsmap="managed"
19374	>
19375	<desc>Base abstract interface for all reusable events.</desc>
19376
19377	<attribute name="generation" readonly="yes" type="unsigned long">
19378	<desc>Current generation of event, incremented on reuse.</desc>
19379	</attribute>
19380
19381	<method name="reuse">
19382	<desc>
19383	Marks an event as reused, increments 'generation', fields shall no
19384	longer be considered valid.
19385	</desc>
19386	</method>
19387	</interface>
19388
19389	<interface
19390	name="IMachineEvent" extends="IEvent"
19391	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
19392	wsmap="managed" id="MachineEvent"
19393	>
19394	<desc>Base abstract interface for all machine events.</desc>
19395
19396	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
19397	<desc>ID of the machine this event relates to.</desc>
19398	</attribute>
19399
19400	</interface>
19401
19402	<interface
19403	name="IMachineStateChangedEvent" extends="IMachineEvent"
19404	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
19405	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
19406	>
19407	<desc>Machine state change event.</desc>
19408
19409	<attribute name="state" readonly="yes" type="MachineState">
19410	<desc>New execution state.</desc>
19411	</attribute>
19412	</interface>
19413
19414	<interface
19415	name="IMachineDataChangedEvent" extends="IMachineEvent"
19416	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
19417	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
19418	>
19419	<desc>
19420	Any of the settings of the given machine has changed.
19421	</desc>
19422
19423	<attribute name="temporary" readonly="yes" type="boolean">
19424	<desc>@c true if the settings change is temporary. All permanent
19425	settings changes will trigger an event, and only temporary settings
19426	changes for running VMs will trigger an event. Note: sending events
19427	for temporary changes is NOT IMPLEMENTED.</desc>
19428	</attribute>
19429	</interface>
19430
19431	<interface
19432	name="IMediumRegisteredEvent" extends="IEvent"
19433	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
19434	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
19435	>
19436	<desc>
19437	The given medium was registered or unregistered
19438	within this VirtualBox installation.
19439	</desc>
19440
19441	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
19442	<desc>ID of the medium this event relates to.</desc>
19443	</attribute>
19444
19445	<attribute name="mediumType" readonly="yes" type="DeviceType">
19446	<desc>Type of the medium this event relates to.</desc>
19447	</attribute>
19448
19449	<attribute name="registered" type="boolean" readonly="yes">
19450	<desc>
19451	If @c true, the medium was registered, otherwise it was
19452	unregistered.
19453	</desc>
19454	</attribute>
19455	</interface>
19456
19457	<interface
19458	name="IMachineRegisteredEvent" extends="IMachineEvent"
19459	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
19460	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
19461	>
19462	<desc>
19463	The given machine was registered or unregistered
19464	within this VirtualBox installation.
19465	</desc>
19466
19467	<attribute name="registered" type="boolean" readonly="yes">
19468	<desc>
19469	If @c true, the machine was registered, otherwise it was
19470	unregistered.
19471	</desc>
19472	</attribute>
19473	</interface>
19474
19475	<interface
19476	name="ISessionStateChangedEvent" extends="IMachineEvent"
19477	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
19478	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
19479	>
19480	<desc>
19481	The state of the session for the given machine was changed.
19482	<see><link to="IMachine::sessionState"/></see>
19483	</desc>
19484
19485	<attribute name="state" type="SessionState" readonly="yes">
19486	<desc>
19487	New session state.
19488	</desc>
19489	</attribute>
19490	</interface>
19491
19492	<interface
19493	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
19494	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
19495	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
19496	>
19497	<desc>
19498	Notification when a guest property has changed.
19499	</desc>
19500
19501	<attribute name="name" readonly="yes" type="wstring">
19502	<desc>
19503	The name of the property that has changed.
19504	</desc>
19505	</attribute>
19506
19507	<attribute name="value" readonly="yes" type="wstring">
19508	<desc>
19509	The new property value.
19510	</desc>
19511	</attribute>
19512
19513	<attribute name="flags" readonly="yes" type="wstring">
19514	<desc>
19515	The new property flags.
19516	</desc>
19517	</attribute>
19518
19519	</interface>
19520
19521	<interface
19522	name="ISnapshotEvent" extends="IMachineEvent"
19523	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
19524	wsmap="managed" id="SnapshotEvent"
19525	>
19526	<desc>Base interface for all snapshot events.</desc>
19527
19528	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
19529	<desc>ID of the snapshot this event relates to.</desc>
19530	</attribute>
19531
19532	</interface>
19533
19534	<interface
19535	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
19536	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
19537	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
19538	>
19539	<desc>
19540	A new snapshot of the machine has been taken.
19541	<see><link to="ISnapshot"/></see>
19542	</desc>
19543	</interface>
19544
19545	<interface
19546	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
19547	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
19548	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
19549	>
19550	<desc>
19551	Snapshot of the given machine has been deleted.
19552
19553	<note>
19554	This notification is delivered <b>after</b> the snapshot
19555	object has been uninitialized on the server (so that any
19556	attempt to call its methods will return an error).
19557	</note>
19558
19559	<see><link to="ISnapshot"/></see>
19560	</desc>
19561	</interface>
19562
19563	<interface
19564	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
19565	uuid="07541941-8079-447a-a33e-47a69c7980db"
19566	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
19567	>
19568	<desc>
19569	Snapshot properties (name and/or description) have been changed.
19570	<see><link to="ISnapshot"/></see>
19571	</desc>
19572	</interface>
19573
19574	<interface
19575	name="IMousePointerShapeChangedEvent" extends="IEvent"
19576	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
19577	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
19578	>
19579	<desc>
19580	Notification when the guest mouse pointer shape has
19581	changed. The new shape data is given.
19582	</desc>
19583
19584	<attribute name="visible" type="boolean" readonly="yes">
19585	<desc>
19586	Flag whether the pointer is visible.
19587	</desc>
19588	</attribute>
19589	<attribute name="alpha" type="boolean" readonly="yes">
19590	<desc>
19591	Flag whether the pointer has an alpha channel.
19592	</desc>
19593	</attribute>
19594	<attribute name="xhot" type="unsigned long" readonly="yes">
19595	<desc>
19596	The pointer hot spot X coordinate.
19597	</desc>
19598	</attribute>
19599	<attribute name="yhot" type="unsigned long" readonly="yes">
19600	<desc>
19601	The pointer hot spot Y coordinate.
19602	</desc>
19603	</attribute>
19604	<attribute name="width" type="unsigned long" readonly="yes">
19605	<desc>
19606	Width of the pointer shape in pixels.
19607	</desc>
19608	</attribute>
19609	<attribute name="height" type="unsigned long" readonly="yes">
19610	<desc>
19611	Height of the pointer shape in pixels.
19612	</desc>
19613	</attribute>
19614	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
19615	<desc>
19616	Shape buffer arrays.
19617
19618	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
19619	followed by a 32-bpp XOR (color) mask.
19620
19621	For pointers without alpha channel the XOR mask pixels are 32
19622	bit values: (lsb)BGR0(msb). For pointers with alpha channel
19623	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
19624
19625	An AND mask is used for pointers with alpha channel, so if the
19626	callback does not support alpha, the pointer could be
19627	displayed as a normal color pointer.
19628
19629	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
19630	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
19631	height</tt>. The padding bits at the end of each scanline are
19632	undefined.
19633
19634	The XOR mask follows the AND mask on the next 4-byte aligned
19635	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
19636	Bytes in the gap between the AND and the XOR mask are undefined.
19637	The XOR mask scanlines have no gap between them and the size of
19638	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
19639
19640	<note>
19641	If @a shape is 0, only the pointer visibility is changed.
19642	</note>
19643	</desc>
19644	</attribute>
19645	</interface>
19646
19647	<interface
19648	name="IMouseCapabilityChangedEvent" extends="IEvent"
19649	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
19650	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
19651	>
19652	<desc>
19653	Notification when the mouse capabilities reported by the
19654	guest have changed. The new capabilities are passed.
19655	</desc>
19656	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
19657	<desc>
19658	Supports absolute coordinates.
19659	</desc>
19660	</attribute>
19661	<attribute name="supportsRelative" type="boolean" readonly="yes">
19662	<desc>
19663	Supports relative coordinates.
19664	</desc>
19665	</attribute>
19666	<attribute name="needsHostCursor" type="boolean" readonly="yes">
19667	<desc>
19668	If host cursor is needed.
19669	</desc>
19670	</attribute>
19671	</interface>
19672
19673	<interface
19674	name="IKeyboardLedsChangedEvent" extends="IEvent"
19675	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
19676	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
19677	>
19678	<desc>
19679	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
19680	to alter the state of the keyboard LEDs.
19681	</desc>
19682	<attribute name="numLock" type="boolean" readonly="yes">
19683	<desc>
19684	NumLock status.
19685	</desc>
19686	</attribute>
19687	<attribute name="capsLock" type="boolean" readonly="yes">
19688	<desc>
19689	CapsLock status.
19690	</desc>
19691	</attribute>
19692	<attribute name="scrollLock" type="boolean" readonly="yes">
19693	<desc>
19694	ScrollLock status.
19695	</desc>
19696	</attribute>
19697	</interface>
19698
19699	<interface
19700	name="IStateChangedEvent" extends="IEvent"
19701	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
19702	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
19703	>
19704	<desc>
19705	Notification when the execution state of the machine has changed.
19706	The new state is given.
19707	</desc>
19708	<attribute name="state" type="MachineState" readonly="yes">
19709	<desc>
19710	New machine state.
19711	</desc>
19712	</attribute>
19713	</interface>
19714
19715	<interface
19716	name="IAdditionsStateChangedEvent" extends="IEvent"
19717	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
19718	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
19719	>
19720	<desc>
19721	Notification when a Guest Additions property changes.
19722	Interested callees should query IGuest attributes to
19723	find out what has changed.
19724	</desc>
19725	</interface>
19726
19727	<interface
19728	name="INetworkAdapterChangedEvent" extends="IEvent"
19729	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
19730	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
19731	>
19732	<desc>
19733	Notification when a property of one of the
19734	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
19735	changes. Interested callees should use INetworkAdapter methods and
19736	attributes to find out what has changed.
19737	</desc>
19738	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
19739	<desc>
19740	Network adapter that is subject to change.
19741	</desc>
19742	</attribute>
19743	</interface>
19744
19745	<interface
19746	name="ISerialPortChangedEvent" extends="IEvent"
19747	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
19748	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
19749	>
19750	<desc>
19751	Notification when a property of one of the
19752	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
19753	Interested callees should use ISerialPort methods and attributes
19754	to find out what has changed.
19755	</desc>
19756	<attribute name="serialPort" type="ISerialPort" readonly="yes">
19757	<desc>
19758	Serial port that is subject to change.
19759	</desc>
19760	</attribute>
19761	</interface>
19762
19763	<interface
19764	name="IParallelPortChangedEvent" extends="IEvent"
19765	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
19766	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
19767	>
19768	<desc>
19769	Notification when a property of one of the
19770	virtual <link to="IMachine::getParallelPort">parallel ports</link>
19771	changes. Interested callees should use ISerialPort methods and
19772	attributes to find out what has changed.
19773	</desc>
19774	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
19775	<desc>
19776	Parallel port that is subject to change.
19777	</desc>
19778	</attribute>
19779	</interface>
19780
19781	<interface
19782	name="IStorageControllerChangedEvent" extends="IEvent"
19783	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
19784	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
19785	>
19786	<desc>
19787	Notification when a
19788	<link to="IMachine::mediumAttachments">medium attachment</link>
19789	changes.
19790	</desc>
19791	</interface>
19792
19793	<interface
19794	name="IMediumChangedEvent" extends="IEvent"
19795	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
19796	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
19797	>
19798	<desc>
19799	Notification when a
19800	<link to="IMachine::mediumAttachments">medium attachment</link>
19801	changes.
19802	</desc>
19803	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
19804	<desc>
19805	Medium attachment that is subject to change.
19806	</desc>
19807	</attribute>
19808	</interface>
19809
19810	<interface
19811	name="IClipboardModeChangedEvent" extends="IEvent"
19812	uuid="cac21692-7997-4595-a731-3a509db604e5"
19813	wsmap="managed" autogen="VBoxEvent" id="OnClipboardModeChanged"
19814	>
19815	<desc>
19816	Notification when the shared clipboard mode changes.
19817	</desc>
19818	<attribute name="clipboardMode" type="ClipboardMode" readonly="yes">
19819	<desc>
19820	The new clipboard mode.
19821	</desc>
19822	</attribute>
19823	</interface>
19824
19825	<interface
19826	name="IDragAndDropModeChangedEvent" extends="IEvent"
19827	uuid="e90b8850-ac8e-4dff-8059-4100ae2c3c3d"
19828	wsmap="managed" autogen="VBoxEvent" id="OnDragAndDropModeChanged"
19829	>
19830	<desc>
19831	Notification when the drag'n'drop mode changes.
19832	</desc>
19833	<attribute name="dragAndDropMode" type="DragAndDropMode" readonly="yes">
19834	<desc>
19835	The new drag'n'drop mode.
19836	</desc>
19837	</attribute>
19838	</interface>
19839
19840	<interface
19841	name="ICPUChangedEvent" extends="IEvent"
19842	uuid="4da2dec7-71b2-4817-9a64-4ed12c17388e"
19843	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
19844	>
19845	<desc>
19846	Notification when a CPU changes.
19847	</desc>
19848	<attribute name="CPU" type="unsigned long" readonly="yes">
19849	<desc>
19850	The CPU which changed.
19851	</desc>
19852	</attribute>
19853	<attribute name="add" type="boolean" readonly="yes">
19854	<desc>
19855	Flag whether the CPU was added or removed.
19856	</desc>
19857	</attribute>
19858	</interface>
19859
19860	<interface
19861	name="ICPUExecutionCapChangedEvent" extends="IEvent"
19862	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
19863	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
19864	>
19865	<desc>
19866	Notification when the CPU execution cap changes.
19867	</desc>
19868	<attribute name="executionCap" type="unsigned long" readonly="yes">
19869	<desc>
19870	The new CPU execution cap value. (1-100)
19871	</desc>
19872	</attribute>
19873	</interface>
19874
19875	<interface
19876	name="IGuestKeyboardEvent" extends="IEvent"
19877	uuid="88394258-7006-40d4-b339-472ee3801844"
19878	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
19879	>
19880	<desc>
19881	Notification when guest keyboard event happens.
19882	</desc>
19883	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
19884	<desc>
19885	Array of scancodes.
19886	</desc>
19887	</attribute>
19888	</interface>
19889
19890	<interface
19891	name="IGuestMouseEvent" extends="IReusableEvent"
19892	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
19893	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
19894	>
19895	<desc>
19896	Notification when guest mouse event happens.
19897	</desc>
19898
19899	<attribute name="absolute" type="boolean" readonly="yes">
19900	<desc>
19901	If this event is relative or absolute.
19902	</desc>
19903	</attribute>
19904
19905	<attribute name="x" type="long" readonly="yes">
19906	<desc>
19907	New X position, or X delta.
19908	</desc>
19909	</attribute>
19910
19911	<attribute name="y" type="long" readonly="yes">
19912	<desc>
19913	New Y position, or Y delta.
19914	</desc>
19915	</attribute>
19916
19917	<attribute name="z" type="long" readonly="yes">
19918	<desc>
19919	Z delta.
19920	</desc>
19921	</attribute>
19922
19923	<attribute name="w" type="long" readonly="yes">
19924	<desc>
19925	W delta.
19926	</desc>
19927	</attribute>
19928
19929	<attribute name="buttons" type="long" readonly="yes">
19930	<desc>
19931	Button state bitmask.
19932	</desc>
19933	</attribute>
19934
19935	</interface>
19936
19937	<interface
19938	name="IGuestSessionEvent" extends="IEvent"
19939	uuid="b9acd33f-647d-45ac-8fe9-f49b3183ba37"
19940	wsmap="managed"
19941	>
19942	<desc>Base abstract interface for all guest session events.</desc>
19943
19944	<attribute name="session" type="IGuestSession" readonly="yes">
19945	<desc>Guest session that is subject to change.</desc>
19946	</attribute>
19947
19948	</interface>
19949
19950	<interface
19951	name="IGuestSessionStateChangedEvent" extends="IGuestSessionEvent"
19952	uuid="327e3c00-ee61-462f-aed3-0dff6cbf9904"
19953	wsmap="managed" autogen="VBoxEvent" id="OnGuestSessionStateChanged"
19954	>
19955	<desc>
19956	Notification when a guest session changed its state.
19957	</desc>
19958
19959	<attribute name="id" type="unsigned long" readonly="yes">
19960	<desc>
19961	Session ID of guest session which was changed.
19962	</desc>
19963	</attribute>
19964	<attribute name="status" type="GuestSessionStatus" readonly="yes">
19965	<desc>
19966	New session status.
19967	</desc>
19968	</attribute>
19969	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
19970	<desc>
19971	Error information in case of new session status is indicating an error.
19972
19973	The attribute <link to="IVirtualBoxErrorInfo::resultDetail"/> will contain
19974	the runtime (IPRT) error code from the guest. See include/iprt/err.h and
19975	include/VBox/err.h for details.
19976	</desc>
19977	</attribute>
19978
19979	</interface>
19980
19981	<interface
19982	name="IGuestSessionRegisteredEvent" extends="IGuestSessionEvent"
19983	uuid="b79de686-eabd-4fa6-960a-f1756c99ea1c"
19984	wsmap="managed" autogen="VBoxEvent" id="OnGuestSessionRegistered"
19985	>
19986	<desc>
19987	Notification when a guest session was registered or unregistered.
19988	</desc>
19989
19990	<attribute name="registered" type="boolean" readonly="yes">
19991	<desc>
19992	If @c true, the guest session was registered, otherwise it was
19993	unregistered.
19994	</desc>
19995	</attribute>
19996
19997	</interface>
19998
19999	<interface
20000	name="IGuestProcessEvent" extends="IGuestSessionEvent"
20001	uuid="2405f0e5-6588-40a3-9b0a-68c05ba52c4b"
20002	wsmap="managed"
20003	>
20004	<desc>Base abstract interface for all guest process events.</desc>
20005
20006	<attribute name="process" type="IGuestProcess" readonly="yes">
20007	<desc>
20008	Guest process object which is related to this event.
20009	</desc>
20010	</attribute>
20011	<attribute name="pid" type="unsigned long" readonly="yes">
20012	<desc>
20013	Guest process ID (PID).
20014	</desc>
20015	</attribute>
20016
20017	</interface>
20018
20019	<interface
20020	name="IGuestProcessRegisteredEvent" extends="IGuestProcessEvent"
20021	uuid="1d89e2b3-c6ea-45b6-9d43-dc6f70cc9f02"
20022	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessRegistered"
20023	>
20024	<desc>
20025	Notification when a guest process was registered or unregistered.
20026	</desc>
20027
20028	<attribute name="registered" type="boolean" readonly="yes">
20029	<desc>
20030	If @c true, the guest process was registered, otherwise it was
20031	unregistered.
20032	</desc>
20033	</attribute>
20034
20035	</interface>
20036
20037	<interface
20038	name="IGuestProcessStateChangedEvent" extends="IGuestProcessEvent"
20039	uuid="c365fb7b-4430-499f-92c8-8bed814a567a"
20040	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessStateChanged"
20041	>
20042	<desc>
20043	Notification when a guest process changed its state.
20044	</desc>
20045
20046	<attribute name="status" type="ProcessStatus" readonly="yes">
20047	<desc>
20048	New guest process status.
20049	</desc>
20050	</attribute>
20051	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
20052	<desc>
20053	Error information in case of new session status is indicating an error.
20054
20055	The attribute <link to="IVirtualBoxErrorInfo::resultDetail"/> will contain
20056	the runtime (IPRT) error code from the guest. See include/iprt/err.h and
20057	include/VBox/err.h for details.
20058	</desc>
20059	</attribute>
20060
20061	</interface>
20062
20063	<interface
20064	name="IGuestProcessIOEvent" extends="IGuestProcessEvent"
20065	uuid="9ea9227c-e9bb-49b3-bfc7-c5171e93ef38"
20066	wsmap="managed"
20067	>
20068	<desc>
20069	Base abstract interface for all guest process input/output (IO) events.
20070	</desc>
20071
20072	<attribute name="handle" type="unsigned long" readonly="yes">
20073	<desc>
20074	Input/output (IO) handle involved in this event. Usually 0 is stdin,
20075	1 is stdout and 2 is stderr.
20076	</desc>
20077	</attribute>
20078
20079	<attribute name="processed" type="unsigned long" readonly="yes">
20080	<desc>
20081	Processed input or output (in bytes).
20082	</desc>
20083	</attribute>
20084
20085	</interface>
20086
20087	<interface
20088	name="IGuestProcessInputNotifyEvent" extends="IGuestProcessIOEvent"
20089	uuid="0de887f2-b7db-4616-aac6-cfb94d89ba78"
20090	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessInputNotify"
20091	>
20092	<desc>
20093	Notification when a guest process' stdin became available.
20094	<note>This event is right now not implemented!</note>
20095	</desc>
20096
20097	<attribute name="status" type="ProcessInputStatus" readonly="yes">
20098	<desc>
20099	Current process input status.
20100	</desc>
20101	</attribute>
20102
20103	</interface>
20104
20105	<interface
20106	name="IGuestProcessOutputEvent" extends="IGuestProcessIOEvent"
20107	uuid="d3d5f1ee-bcb2-4905-a7ab-cc85448a742b"
20108	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessOutput"
20109	>
20110	<desc>
20111	Notification when there is guest process output available for reading.
20112	</desc>
20113
20114	<attribute name="data" type="octet" safearray="yes" readonly="yes">
20115	<desc>
20116	Actual output data.
20117	</desc>
20118	</attribute>
20119
20120	</interface>
20121
20122	<interface
20123	name="IGuestFileEvent" extends="IGuestSessionEvent"
20124	uuid="c8adb7b0-057d-4391-b928-f14b06b710c5"
20125	wsmap="managed"
20126	>
20127	<desc>Base abstract interface for all guest file events.</desc>
20128
20129	<attribute name="file" type="IGuestFile" readonly="yes">
20130	<desc>
20131	Guest file object which is related to this event.
20132	</desc>
20133	</attribute>
20134
20135	</interface>
20136
20137	<interface
20138	name="IGuestFileRegisteredEvent" extends="IGuestFileEvent"
20139	uuid="d0d93830-70a2-487e-895e-d3fc9679f7b3"
20140	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileRegistered"
20141	>
20142	<desc>
20143	Notification when a guest file was registered or unregistered.
20144	</desc>
20145
20146	<attribute name="registered" type="boolean" readonly="yes">
20147	<desc>
20148	If @c true, the guest file was registered, otherwise it was
20149	unregistered.
20150	</desc>
20151	</attribute>
20152
20153	</interface>
20154
20155	<interface
20156	name="IGuestFileStateChangedEvent" extends="IGuestFileEvent"
20157	uuid="d37fe88f-0979-486c-baa1-3abb144dc82d"
20158	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileStateChanged"
20159	>
20160	<desc>
20161	Notification when a guest file changed its state.
20162	</desc>
20163
20164	<attribute name="status" type="FileStatus" readonly="yes">
20165	<desc>
20166	New guest file status.
20167	</desc>
20168	</attribute>
20169	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
20170	<desc>
20171	Error information in case of new session status is indicating an error.
20172
20173	The attribute <link to="IVirtualBoxErrorInfo::resultDetail"/> will contain
20174	the runtime (IPRT) error code from the guest. See include/iprt/err.h and
20175	include/VBox/err.h for details.
20176	</desc>
20177	</attribute>
20178	<!-- Note: No events for reads/writes for performance reasons.
20179	See dedidcated events IGuestFileReadEvent and
20180	IGuestFileWriteEvent. -->
20181
20182	</interface>
20183
20184	<interface
20185	name="IGuestFileIOEvent" extends="IGuestFileEvent"
20186	uuid="b5191a7c-9536-4ef8-820e-3b0e17e5bbc8"
20187	wsmap="managed"
20188	>
20189	<desc>
20190	Base abstract interface for all guest file input/output (IO) events.
20191	</desc>
20192
20193	<attribute name="offset" type="long long" readonly="yes">
20194	<desc>
20195	Current offset (in bytes).
20196	</desc>
20197	</attribute>
20198	<attribute name="processed" type="unsigned long" readonly="yes">
20199	<desc>
20200	Processed input or output (in bytes).
20201	</desc>
20202	</attribute>
20203
20204	</interface>
20205
20206	<interface
20207	name="IGuestFileOffsetChangedEvent" extends="IGuestFileIOEvent"
20208	uuid="e8f79a21-1207-4179-94cf-ca250036308f"
20209	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileOffsetChanged"
20210	>
20211	<desc>
20212	Notification when a guest file changed its current offset.
20213	</desc>
20214
20215	</interface>
20216
20217	<interface
20218	name="IGuestFileReadEvent" extends="IGuestFileIOEvent"
20219	uuid="4ee3cbcb-486f-40db-9150-deee3fd24189"
20220	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileRead"
20221	>
20222	<desc>
20223	Notification when data has been read from a guest file.
20224	</desc>
20225
20226	<attribute name="data" type="octet" safearray="yes" readonly="yes">
20227	<desc>
20228	Actual data read.
20229	</desc>
20230	</attribute>
20231
20232	</interface>
20233
20234	<interface
20235	name="IGuestFileWriteEvent" extends="IGuestFileIOEvent"
20236	uuid="e062a915-3cf5-4c0a-bc90-9b8d4cc94d89"
20237	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileWrite"
20238	>
20239	<desc>
20240	Notification when data has been written to a guest file.
20241	</desc>
20242
20243	</interface>
20244
20245	<interface
20246	name="IVRDEServerChangedEvent" extends="IEvent"
20247	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
20248	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
20249	>
20250	<desc>
20251	Notification when a property of the
20252	<link to="IMachine::VRDEServer">VRDE server</link> changes.
20253	Interested callees should use IVRDEServer methods and attributes to
20254	find out what has changed.
20255	</desc>
20256	</interface>
20257
20258	<interface
20259	name="IVRDEServerInfoChangedEvent" extends="IEvent"
20260	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
20261	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
20262	>
20263	<desc>
20264	Notification when the status of the VRDE server changes. Interested callees
20265	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
20266	attributes to find out what is the current status.
20267	</desc>
20268	</interface>
20269
20270	<interface
20271	name="IUSBControllerChangedEvent" extends="IEvent"
20272	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
20273	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
20274	>
20275	<desc>
20276	Notification when a property of the virtual
20277	<link to="IMachine::USBController">USB controller</link> changes.
20278	Interested callees should use IUSBController methods and attributes to
20279	find out what has changed.
20280	</desc>
20281	</interface>
20282
20283	<interface
20284	name="IUSBDeviceStateChangedEvent" extends="IEvent"
20285	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
20286	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
20287	>
20288	<desc>
20289	Notification when a USB device is attached to or detached from
20290	the virtual USB controller.
20291
20292	This notification is sent as a result of the indirect
20293	request to attach the device because it matches one of the
20294	machine USB filters, or as a result of the direct request
20295	issued by <link to="IConsole::attachUSBDevice"/> or
20296	<link to="IConsole::detachUSBDevice"/>.
20297
20298	This notification is sent in case of both a succeeded and a
20299	failed request completion. When the request succeeds, the
20300	@a error parameter is @c null, and the given device has been
20301	already added to (when @a attached is @c true) or removed from
20302	(when @a attached is @c false) the collection represented by
20303	<link to="IConsole::USBDevices"/>. On failure, the collection
20304	doesn't change and the @a error parameter represents the error
20305	message describing the failure.
20306	</desc>
20307	<attribute name="device" type="IUSBDevice" readonly="yes">
20308	<desc>
20309	Device that is subject to state change.
20310	</desc>
20311	</attribute>
20312	<attribute name="attached" type="boolean" readonly="yes">
20313	<desc>
20314	@c true if the device was attached and @c false otherwise.
20315	</desc>
20316	</attribute>
20317	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
20318	<desc>
20319	@c null on success or an error message object on failure.
20320	</desc>
20321	</attribute>
20322	</interface>
20323
20324	<interface
20325	name="ISharedFolderChangedEvent" extends="IEvent"
20326	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
20327	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
20328	>
20329	<desc>
20330	Notification when a shared folder is added or removed.
20331	The @a scope argument defines one of three scopes:
20332	<link to="IVirtualBox::sharedFolders">global shared folders</link>
20333	(<link to="Scope_Global">Global</link>),
20334	<link to="IMachine::sharedFolders">permanent shared folders</link> of
20335	the machine (<link to="Scope_Machine">Machine</link>) or <link
20336	to="IConsole::sharedFolders">transient shared folders</link> of the
20337	machine (<link to="Scope_Session">Session</link>). Interested callees
20338	should use query the corresponding collections to find out what has
20339	changed.
20340	</desc>
20341	<attribute name="scope" type="Scope" readonly="yes">
20342	<desc>
20343	Scope of the notification.
20344	</desc>
20345	</attribute>
20346	</interface>
20347
20348	<interface
20349	name="IRuntimeErrorEvent" extends="IEvent"
20350	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
20351	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
20352	>
20353	<desc>
20354	Notification when an error happens during the virtual
20355	machine execution.
20356
20357	There are three kinds of runtime errors:
20358	<ul>
20359	<li><i>fatal</i></li>
20360	<li><i>non-fatal with retry</i></li>
20361	<li><i>non-fatal warnings</i></li>
20362	</ul>
20363
20364	<b>Fatal</b> errors are indicated by the @a fatal parameter set
20365	to @c true. In case of fatal errors, the virtual machine
20366	execution is always paused before calling this notification, and
20367	the notification handler is supposed either to immediately save
20368	the virtual machine state using <link to="IConsole::saveState"/>
20369	or power it off using <link to="IConsole::powerDown"/>.
20370	Resuming the execution can lead to unpredictable results.
20371
20372	<b>Non-fatal</b> errors and warnings are indicated by the
20373	@a fatal parameter set to @c false. If the virtual machine
20374	is in the Paused state by the time the error notification is
20375	received, it means that the user can <i>try to resume</i> the machine
20376	execution after attempting to solve the problem that caused the
20377	error. In this case, the notification handler is supposed
20378	to show an appropriate message to the user (depending on the
20379	value of the @a id parameter) that offers several actions such
20380	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
20381	wants to retry, the notification handler should continue
20382	the machine execution using the <link to="IConsole::resume"/>
20383	call. If the machine execution is not Paused during this
20384	notification, then it means this notification is a <i>warning</i>
20385	(for example, about a fatal condition that can happen very soon);
20386	no immediate action is required from the user, the machine
20387	continues its normal execution.
20388
20389	Note that in either case the notification handler
20390	<b>must not</b> perform any action directly on a thread
20391	where this notification is called. Everything it is allowed to
20392	do is to post a message to another thread that will then talk
20393	to the user and take the corresponding action.
20394
20395	Currently, the following error identifiers are known:
20396	<ul>
20397	<li><tt>"HostMemoryLow"</tt></li>
20398	<li><tt>"HostAudioNotResponding"</tt></li>
20399	<li><tt>"VDIStorageFull"</tt></li>
20400	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
20401	</ul>
20402	</desc>
20403	<attribute name="fatal" type="boolean" readonly="yes">
20404	<desc>
20405	Whether the error is fatal or not.
20406	</desc>
20407	</attribute>
20408	<attribute name="id" type="wstring" readonly="yes">
20409	<desc>
20410	Error identifier.
20411	</desc>
20412	</attribute>
20413	<attribute name="message" type="wstring" readonly="yes">
20414	<desc>
20415	Optional error message.
20416	</desc>
20417	</attribute>
20418	</interface>
20419
20420
20421	<interface
20422	name="IEventSourceChangedEvent" extends="IEvent"
20423	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
20424	waitable="yes"
20425	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
20426	>
20427	<desc>
20428	Notification when an event source state changes (listener added or removed).
20429	</desc>
20430
20431	<attribute name="listener" type="IEventListener" readonly="yes">
20432	<desc>
20433	Event listener which has changed.
20434	</desc>
20435	</attribute>
20436
20437	<attribute name="add" type="boolean" readonly="yes">
20438	<desc>
20439	Flag whether listener was added or removed.
20440	</desc>
20441	</attribute>
20442	</interface>
20443
20444	<interface
20445	name="IExtraDataChangedEvent" extends="IEvent"
20446	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
20447	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
20448	>
20449	<desc>
20450	Notification when machine specific or global extra data
20451	has changed.
20452	</desc>
20453	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
20454	<desc>
20455	ID of the machine this event relates to.
20456	Null for global extra data changes.
20457	</desc>
20458	</attribute>
20459	<attribute name="key" type="wstring" readonly="yes">
20460	<desc>
20461	Extra data key that has changed.
20462	</desc>
20463	</attribute>
20464	<attribute name="value" type="wstring" readonly="yes">
20465	<desc>
20466	Extra data value for the given key.
20467	</desc>
20468	</attribute>
20469	</interface>
20470
20471	<interface
20472	name="IVetoEvent" extends="IEvent"
20473	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
20474	wsmap="managed"
20475	>
20476	<desc>Base abstract interface for veto events.</desc>
20477
20478	<method name="addVeto">
20479	<desc>
20480	Adds a veto on this event.
20481	</desc>
20482	<param name="reason" type="wstring" dir="in">
20483	<desc>
20484	Reason for veto, could be null or empty string.
20485	</desc>
20486	</param>
20487	</method>
20488
20489	<method name="isVetoed">
20490	<desc>
20491	If this event was vetoed.
20492	</desc>
20493	<param name="result" type="boolean" dir="return">
20494	<desc>
20495	Reason for veto.
20496	</desc>
20497	</param>
20498	</method>
20499
20500	<method name="getVetos">
20501	<desc>
20502	Current veto reason list, if size is 0 - no veto.
20503	</desc>
20504	<param name="result" type="wstring" dir="return" safearray="yes">
20505	<desc>
20506	Array of reasons for veto provided by different event handlers.
20507	</desc>
20508	</param>
20509	</method>
20510
20511	</interface>
20512
20513	<interface
20514	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
20515	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
20516	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
20517	waitable="true"
20518	>
20519	<desc>
20520	Notification when someone tries to change extra data for
20521	either the given machine or (if @c null) global extra data.
20522	This gives the chance to veto against changes.
20523	</desc>
20524	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
20525	<desc>
20526	ID of the machine this event relates to.
20527	Null for global extra data changes.
20528	</desc>
20529	</attribute>
20530	<attribute name="key" type="wstring" readonly="yes">
20531	<desc>
20532	Extra data key that has changed.
20533	</desc>
20534	</attribute>
20535	<attribute name="value" type="wstring" readonly="yes">
20536	<desc>
20537	Extra data value for the given key.
20538	</desc>
20539	</attribute>
20540	</interface>
20541
20542	<interface
20543	name="ICanShowWindowEvent" extends="IVetoEvent"
20544	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
20545	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
20546	waitable="true"
20547	>
20548	<desc>
20549	Notification when a call to
20550	<link to="IMachine::canShowConsoleWindow"/> is made by a
20551	front-end to check if a subsequent call to
20552	<link to="IMachine::showConsoleWindow"/> can succeed.
20553
20554	The callee should give an answer appropriate to the current
20555	machine state using event veto. This answer must
20556	remain valid at least until the next
20557	<link to="IConsole::state">machine state</link> change.
20558	</desc>
20559	</interface>
20560
20561	<interface
20562	name="IShowWindowEvent" extends="IEvent"
20563	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
20564	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
20565	waitable="true"
20566	>
20567	<desc>
20568	Notification when a call to
20569	<link to="IMachine::showConsoleWindow"/>
20570	requests the console window to be activated and brought to
20571	foreground on the desktop of the host PC.
20572
20573	This notification should cause the VM console process to
20574	perform the requested action as described above. If it is
20575	impossible to do it at a time of this notification, this
20576	method should return a failure.
20577
20578	Note that many modern window managers on many platforms
20579	implement some sort of focus stealing prevention logic, so
20580	that it may be impossible to activate a window without the
20581	help of the currently active application (which is supposedly
20582	an initiator of this notification). In this case, this method
20583	must return a non-zero identifier that represents the
20584	top-level window of the VM console process. The caller, if it
20585	represents a currently active process, is responsible to use
20586	this identifier (in a platform-dependent manner) to perform
20587	actual window activation.
20588
20589	This method must set @a winId to zero if it has performed all
20590	actions necessary to complete the request and the console
20591	window is now active and in foreground, to indicate that no
20592	further action is required on the caller's side.
20593	</desc>
20594	<attribute name="winId" type="long long">
20595	<desc>
20596	Platform-dependent identifier of the top-level VM console
20597	window, or zero if this method has performed all actions
20598	necessary to implement the <i>show window</i> semantics for
20599	the given platform and/or this VirtualBox front-end.
20600	</desc>
20601	</attribute>
20602	</interface>
20603
20604	<interface
20605	name="INATRedirectEvent" extends="IMachineEvent"
20606	uuid="24eef068-c380-4510-bc7c-19314a7352f1"
20607	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
20608	>
20609	<desc>
20610	Notification when NAT redirect rule added or removed.
20611	</desc>
20612	<attribute name="slot" type="unsigned long" readonly="yes">
20613	<desc>
20614	Adapter which NAT attached to.
20615	</desc>
20616	</attribute>
20617	<attribute name="remove" type="boolean" readonly="yes">
20618	<desc>
20619	Whether rule remove or add.
20620	</desc>
20621	</attribute>
20622	<attribute name="name" type="wstring" readonly="yes">
20623	<desc>
20624	Name of the rule.
20625	</desc>
20626	</attribute>
20627	<attribute name="proto" type="NATProtocol" readonly="yes">
20628	<desc>
20629	Protocol (TCP or UDP) of the redirect rule.
20630	</desc>
20631	</attribute>
20632	<attribute name="hostIP" type="wstring" readonly="yes">
20633	<desc>
20634	Host ip address to bind socket on.
20635	</desc>
20636	</attribute>
20637	<attribute name="hostPort" type="long" readonly="yes">
20638	<desc>
20639	Host port to bind socket on.
20640	</desc>
20641	</attribute>
20642	<attribute name="guestIP" type="wstring" readonly="yes">
20643	<desc>
20644	Guest ip address to redirect to.
20645	</desc>
20646	</attribute>
20647	<attribute name="guestPort" type="long" readonly="yes">
20648	<desc>
20649	Guest port to redirect to.
20650	</desc>
20651	</attribute>
20652	</interface>
20653
20654	<interface
20655	name="IHostPCIDevicePlugEvent" extends="IMachineEvent"
20656	waitable="yes"
20657	uuid="a0bad6df-d612-47d3-89d4-db3992533948"
20658	wsmap="managed" autogen="VBoxEvent" id="OnHostPCIDevicePlug"
20659	>
20660	<desc>
20661	Notification when host PCI device is plugged/unplugged. Plugging
20662	usually takes place on VM startup, unplug - when
20663	<link to="IMachine::detachHostPCIDevice"/> is called.
20664
20665	<see><link to="IMachine::detachHostPCIDevice"/></see>
20666
20667	</desc>
20668
20669	<attribute name="plugged" type="boolean" readonly="yes">
20670	<desc>
20671	If device successfully plugged or unplugged.
20672	</desc>
20673	</attribute>
20674
20675	<attribute name="success" type="boolean" readonly="yes">
20676	<desc>
20677	If operation was successful, if false - 'message' attribute
20678	may be of interest.
20679	</desc>
20680	</attribute>
20681
20682	<attribute name="attachment" type="IPCIDeviceAttachment" readonly="yes">
20683	<desc>
20684	Attachment info for this device.
20685	</desc>
20686	</attribute>
20687
20688	<attribute name="message" type="wstring" readonly="yes">
20689	<desc>
20690	Optional error message.
20691	</desc>
20692	</attribute>
20693
20694	</interface>
20695
20696	<interface
20697	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
20698	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
20699	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
20700	>
20701	<desc>
20702	Notification when VBoxSVC becomes unavailable (due to a crash or similar
20703	unexpected circumstances) or available again.
20704	</desc>
20705
20706	<attribute name="available" type="boolean" readonly="yes">
20707	<desc>
20708	Whether VBoxSVC is available now.
20709	</desc>
20710	</attribute>
20711	</interface>
20712
20713	<interface
20714	name="IBandwidthGroupChangedEvent" extends="IEvent"
20715	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
20716	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
20717	>
20718	<desc>
20719	Notification when one of the bandwidth groups changed
20720	</desc>
20721	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
20722	<desc>
20723	The changed bandwidth group.
20724	</desc>
20725	</attribute>
20726	</interface>
20727
20728	<enum
20729	name="GuestMonitorChangedEventType"
20730	uuid="ef172985-7e36-4297-95be-e46396968d66"
20731	>
20732
20733	<desc>
20734	How the guest monitor has been changed.
20735	</desc>
20736
20737	<const name="Enabled" value="0">
20738	<desc>
20739	The guest monitor has been enabled by the guest.
20740	</desc>
20741	</const>
20742
20743	<const name="Disabled" value="1">
20744	<desc>
20745	The guest monitor has been disabled by the guest.
20746	</desc>
20747	</const>
20748
20749	<const name="NewOrigin" value="2">
20750	<desc>
20751	The guest monitor origin has changed in the guest.
20752	</desc>
20753	</const>
20754	</enum>
20755
20756	<interface
20757	name="IGuestMonitorChangedEvent" extends="IEvent"
20758	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
20759	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
20760	>
20761	<desc>
20762	Notification when the guest enables one of its monitors.
20763	</desc>
20764
20765	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
20766	<desc>
20767	What was changed for this guest monitor.
20768	</desc>
20769	</attribute>
20770
20771	<attribute name="screenId" type="unsigned long" readonly="yes">
20772	<desc>
20773	The monitor which was changed.
20774	</desc>
20775	</attribute>
20776
20777	<attribute name="originX" type="unsigned long" readonly="yes">
20778	<desc>
20779	Physical X origin relative to the primary screen.
20780	Valid for Enabled and NewOrigin.
20781	</desc>
20782	</attribute>
20783
20784	<attribute name="originY" type="unsigned long" readonly="yes">
20785	<desc>
20786	Physical Y origin relative to the primary screen.
20787	Valid for Enabled and NewOrigin.
20788	</desc>
20789	</attribute>
20790
20791	<attribute name="width" type="unsigned long" readonly="yes">
20792	<desc>
20793	Width of the screen.
20794	Valid for Enabled.
20795	</desc>
20796	</attribute>
20797
20798	<attribute name="height" type="unsigned long" readonly="yes">
20799	<desc>
20800	Height of the screen.
20801	Valid for Enabled.
20802	</desc>
20803	</attribute>
20804
20805	</interface>
20806
20807	<interface
20808	name="IStorageDeviceChangedEvent" extends="IEvent"
20809	uuid="232e9151-ae84-4b8e-b0f3-5c20c35caac9"
20810	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
20811	>
20812	<desc>
20813	Notification when a
20814	<link to="IMachine::mediumAttachments">storage device</link>
20815	is attached or removed.
20816	</desc>
20817	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
20818	<desc>
20819	Storage device that is subject to change.
20820	</desc>
20821	</attribute>
20822	<attribute name="removed" type="boolean" readonly="yes">
20823	<desc>
20824	Flag whether the device was removed or added to the VM.
20825	</desc>
20826	</attribute>
20827	<attribute name="silent" type="boolean" readonly="yes">
20828	<desc>
20829	Flag whether the guest should be notified about the change.
20830	</desc>
20831	</attribute>
20832	</interface>
20833	<interface
20834	name="INATNetworkChangedEvent" extends="IEvent"
20835	uuid="101ae042-1a29-4a19-92cf-02285773f3b5"
20836	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkChanged"
20837	>
20838	<!-- network name is common setting for all event types -->
20839	<attribute name="NetworkName" type="wstring" readonly="yes"/>
20840	</interface>
20841	<!-- base class for start/stop events -->
20842	<interface name="INATNetworkStartStopEvent" extends="INATNetworkChangedEvent"
20843	uuid="269d8f6b-fa1e-4cee-91c7-6d8496bea3c1"
20844	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkStartStop">
20845	<attribute name="startEvent" type="boolean" readonly="yes">
20846	<desc>
20847	IsStartEvent is true when NAT network is started and false on stopping.
20848	</desc>
20849	</attribute>
20850	</interface>
20851
20852	<!-- base class for modification events -->
20853	<interface name="INATNetworkAlterEvent" extends="INATNetworkChangedEvent"
20854	uuid="3f5a0822-163a-43b1-ad16-8d58b0ef6e75"
20855	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkAlter"/>
20856
20857	<interface name="INATNetworkCreationDeletionEvent" extends="INATNetworkAlterEvent"
20858	uuid="8d984a7e-b855-40b8-ab0c-44d3515b4528"
20859	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkCreationDeletion">
20860	<attribute name="creationEvent" type="boolean" readonly="yes"/>
20861	</interface>
20862	<interface name="INATNetworkSettingEvent" extends="INATNetworkAlterEvent"
20863	uuid="9db3a9e6-7f29-4aae-a627-5a282c83092c"
20864	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkSetting">
20865	<attribute name="enabled" type="boolean" readonly="yes"/>
20866	<attribute name="network" type="wstring" readonly="yes"/>
20867	<attribute name="gateway" type="wstring" readonly="yes"/>
20868	<attribute name="advertiseDefaultIPv6RouteEnabled" type="boolean" readonly="yes"/>
20869	<attribute name="needDhcpServer" type="boolean" readonly="yes"/>
20870	</interface>
20871	<interface name="INATNetworkPortForwardEvent" extends="INATNetworkAlterEvent"
20872	uuid="2514881b-23d0-430a-a7ff-7ed7f05534bc"
20873	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkPortForward">
20874	<attribute name="create" type="boolean" readonly="yes"/>
20875	<attribute name="ipv6" type="boolean" readonly="yes"/>
20876	<attribute name="name" type="wstring" readonly="yes"/>
20877	<attribute name="proto" type="NATProtocol" readonly="yes"/>
20878	<attribute name="hostIp" type="wstring" readonly="yes"/>
20879	<attribute name="hostPort" type="long" readonly="yes"/>
20880	<attribute name="guestIp" type="wstring" readonly="yes"/>
20881	<attribute name="guestPort" type="long" readonly="yes"/>
20882	</interface>
20883
20884	<module name="VBoxSVC" context="LocalServer">
20885	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
20886	namespace="virtualbox.org">
20887	<interface name="IVirtualBox" default="yes"/>
20888	</class>
20889	</module>
20890
20891	<module name="VBoxC" context="InprocServer" threadingModel="Free">
20892	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
20893	namespace="virtualbox.org">
20894	<interface name="IVirtualBoxClient" default="yes"/>
20895	</class>
20896
20897	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
20898	namespace="virtualbox.org">
20899	<interface name="ISession" default="yes"/>
20900	</class>
20901	</module>
20902
20903	</library>
20904
20905	</idl>
20906
20907	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format